Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

i2c: update i2c_algorithm documentation

Add some kerneldoc style documentaton to the i2c_algorithm
structure, and point the master_xfer return codes at the
right place in Documentation/i2c/fault_codes

Signed-off-by: Ben Dooks <ben.dooks@codethink.co.uk>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>

authored by

Ben Dooks and committed by
Wolfram Sang
25ee33fb bc8120f1

+15 -1
+15 -1
include/linux/i2c.h
··· 342 342 } 343 343 #endif /* I2C_BOARDINFO */ 344 344 345 - /* 345 + /** 346 + * struct i2c_algorithm - represent I2C transfer method 347 + * @master_xfer: Issue a set of i2c transactions to the given I2C adapter 348 + * defined by the msgs array, with num messages available to transfer via 349 + * the adapter specified by adap. 350 + * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this 351 + * is not present, then the bus layer will try and convert the SMBus calls 352 + * into I2C transfers instead. 353 + * @functionality: Return the flags that this algorithm/adapter pair supports 354 + * from the I2C_FUNC_* flags. 355 + * 346 356 * The following structs are for those who like to implement new bus drivers: 347 357 * i2c_algorithm is the interface to a class of hardware solutions which can 348 358 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584 349 359 * to name two of the most common. 360 + * 361 + * The return codes from the @master_xfer field should indicate the type of 362 + * error code that occured during the transfer, as documented in the kernel 363 + * Documentation file Documentation/i2c/fault-codes. 350 364 */ 351 365 struct i2c_algorithm { 352 366 /* If an adapter algorithm can't do I2C-level access, set master_xfer