diff options
| author | Wolfram Sang <wsa+renesas@sang-engineering.com> | 2022-07-24 21:46:28 +0300 |
|---|---|---|
| committer | Wolfram Sang <wsa@kernel.org> | 2022-07-27 00:13:36 +0300 |
| commit | a11821495fd4d9b5c97945db929e02c473b7a5d9 (patch) | |
| tree | ae5f9e144e71de42641c6c914a4867d230cfbf59 /include/linux/i2c.h | |
| parent | 6435319c34704994e19b0767f6a4e6f37439867b (diff) | |
| download | linux-a11821495fd4d9b5c97945db929e02c473b7a5d9.tar.xz | |
i2c: extend documentation about retvals of master_xfer functions
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>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
Diffstat (limited to 'include/linux/i2c.h')
| -rw-r--r-- | include/linux/i2c.h | 3 |
1 files changed, 2 insertions, 1 deletions
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 { /* |