nvmem: specify ->reg_read/reg_write() expected return values
authorThéo Lebrun <theo.lebrun@bootlin.com>
Mon, 30 Dec 2024 14:30:27 +0000 (14:30 +0000)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 30 Dec 2024 14:35:59 +0000 (15:35 +0100)
commit6fdbc7b9aa20b1db47d13a5f2a4d31fb2f8f3822
tree89ea57c912743cd99fcae272afbb26ed78ea66b0
parent62b467c65a7edbd4caac2214ec12da99e19e445e
nvmem: specify ->reg_read/reg_write() expected return values

Both ->reg_read() and ->reg_write() return values are not easy to
deduce. Explicit that they should return zero on success (and negative
values otherwise).

Such callbacks, in some alternative world, could return the number of
bytes in the success case. That would be translated to errors in the
nvmem core because of checks like:

ret = nvmem->reg_write(nvmem->priv, offset, val, bytes);
if (ret) {
// error case
}

This mistake is not just theoretical, see commit
28b008751aa2 ("nvmem: rmem: Fix return value of rmem_read()").

Signed-off-by: Théo Lebrun <theo.lebrun@bootlin.com>
Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Link: https://lore.kernel.org/r/20241230143035.265518-4-srinivas.kandagatla@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/nvmem-provider.h