Message ID | 20220724184628.2752-1-wsa+renesas@sang-engineering.com |
---|---|
State | Accepted |
Commit | a11821495fd4d9b5c97945db929e02c473b7a5d9 |
Headers | show |
Series | i2c: extend documentation about retvals of master_xfer functions | expand |
On Sun, Jul 24, 2022 at 08:46:28PM +0200, Wolfram Sang wrote: > It was stated how the error codes should be. It was not stated what the > regular case should return. Add this. > > Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Applied to for-next, thanks!
diff --git a/include/linux/i2c.h b/include/linux/i2c.h index fbda5ada2afc..8eab5017bff3 100644 --- a/include/linux/i2c.h +++ b/include/linux/i2c.h @@ -537,7 +537,8 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info, * * The return codes from the ``master_xfer{_atomic}`` fields should indicate the * type of error code that occurred during the transfer, as documented in the - * Kernel Documentation file Documentation/i2c/fault-codes.rst. + * Kernel Documentation file Documentation/i2c/fault-codes.rst. Otherwise, the + * number of messages executed should be returned. */ struct i2c_algorithm { /*
It was stated how the error codes should be. It was not stated what the regular case should return. Add this. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> --- include/linux/i2c.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)