Commit 385ac870 authored by Wolfram Sang's avatar Wolfram Sang
Browse files

i2c: header: improve kdoc for i2c_algorithm 



Reword the explanation of @xfer, the old one was confusing and mixing up
terminology. Other than that, capitalize some words correctly and use
full line length.

Signed-off-by: default avatarWolfram Sang <wsa+renesas@sang-engineering.com>
parent d83763e4

include/linux/i2c.h

+7 −8
Original line number Diff line number Diff line
@@ -511,16 +511,15 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info, 
#endif /* I2C_BOARDINFO */



/**

 * struct i2c_algorithm - represent I2C transfer method

 * @xfer: Issue a set of i2c transactions to the given I2C adapter

 *   defined by the msgs array, with num messages available to transfer via

 *   the adapter specified by adap.

 * @xfer_atomic: same as @xfer. Yet, only using atomic context

 *   so e.g. PMICs can be accessed very late before shutdown. Optional.

 * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this

 * struct i2c_algorithm - represent I2C transfer methods

 * @xfer: Transfer a given number of messages defined by the msgs array via

 *   the specified adapter.

 * @xfer_atomic: Same as @xfer. Yet, only using atomic context so e.g. PMICs

 *   can be accessed very late before shutdown. Optional.

 * @smbus_xfer: Issue SMBus transactions to the given I2C adapter. If this

 *   is not present, then the bus layer will try and convert the SMBus calls

 *   into I2C transfers instead.

 * @smbus_xfer_atomic: same as @smbus_xfer. Yet, only using atomic context

 * @smbus_xfer_atomic: Same as @smbus_xfer. Yet, only using atomic context

 *   so e.g. PMICs can be accessed very late before shutdown. Optional.

 * @functionality: Return the flags that this algorithm/adapter pair supports

 *   from the ``I2C_FUNC_*`` flags.