diff options
| author | David Brownell <david-b@pacbell.net> | 2008-05-11 20:37:05 +0200 |
|---|---|---|
| committer | Jean Delvare <khali@hyperion.delvare> | 2008-05-11 20:37:05 +0200 |
| commit | 1a31a88f4f1a14f0b28ec3c5c179b93a10b24a18 (patch) | |
| tree | 523f713eb76f7df82eed8d076d244225515eaa30 /drivers/clocksource | |
| parent | c2fc54fcd340cbee47510aa84c346aab3440ba09 (diff) | |
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>
Diffstat (limited to 'drivers/clocksource')
0 files changed, 0 insertions, 0 deletions