Skip to content

Commit 385ac87

Browse files
author
Wolfram Sang
committed
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: Wolfram Sang <wsa+renesas@sang-engineering.com>
1 parent d83763e commit 385ac87

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

include/linux/i2c.h

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -511,16 +511,15 @@ i2c_register_board_info(int busnum, struct i2c_board_info const *info,
511511
#endif /* I2C_BOARDINFO */
512512

513513
/**
514-
* struct i2c_algorithm - represent I2C transfer method
515-
* @xfer: Issue a set of i2c transactions to the given I2C adapter
516-
* defined by the msgs array, with num messages available to transfer via
517-
* the adapter specified by adap.
518-
* @xfer_atomic: same as @xfer. Yet, only using atomic context
519-
* so e.g. PMICs can be accessed very late before shutdown. Optional.
520-
* @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this
514+
* struct i2c_algorithm - represent I2C transfer methods
515+
* @xfer: Transfer a given number of messages defined by the msgs array via
516+
* the specified adapter.
517+
* @xfer_atomic: Same as @xfer. Yet, only using atomic context so e.g. PMICs
518+
* can be accessed very late before shutdown. Optional.
519+
* @smbus_xfer: Issue SMBus transactions to the given I2C adapter. If this
521520
* is not present, then the bus layer will try and convert the SMBus calls
522521
* into I2C transfers instead.
523-
* @smbus_xfer_atomic: same as @smbus_xfer. Yet, only using atomic context
522+
* @smbus_xfer_atomic: Same as @smbus_xfer. Yet, only using atomic context
524523
* so e.g. PMICs can be accessed very late before shutdown. Optional.
525524
* @functionality: Return the flags that this algorithm/adapter pair supports
526525
* from the ``I2C_FUNC_*`` flags.

0 commit comments

Comments
 (0)