]> git.baikalelectronics.ru Git - kernel.git/commit
i2c: Improve smbus-protocol documentation
authorDavid Brownell <david-b@pacbell.net>
Sun, 11 May 2008 18:37:05 +0000 (20:37 +0200)
committerJean Delvare <khali@hyperion.delvare>
Sun, 11 May 2008 18:37:05 +0000 (20:37 +0200)
commit0e7d567ee27dfb01672b6f6e9760cd1d723d7ef0
tree523f713eb76f7df82eed8d076d244225515eaa30
parent3b4429301fb83d4caf04482c2968fab0dd2110c5
i2c: Improve smbus-protocol documentation

Improve the smbus-protocol documentation file somewhat:

 - Use the names of the SMBus protocol operations (from the 2.0
   specification), not made-up-for-Linux names.

 - Add the name of the call used to execute each operation ... and
   point out that there are mismatches, where functions execute
   different protocol operations than their names specify.

The most confusing examples are that "Read Byte" isn't executed by
i2c_smbus_read_byte(), and that "Write Byte" isn't executed by
i2c_smbus_write_byte().  When coding, that's not as bad as it may
seem; but that case would seem to be worth fixing.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Jean Delvare <khali@linux-fr.org>
Documentation/i2c/smbus-protocol