https://github.com/torvalds/linux
Revision 1a31a88f4f1a14f0b28ec3c5c179b93a10b24a18 authored by David Brownell on 11 May 2008, 18:37:05 UTC, committed by Jean Delvare on 11 May 2008, 18:37:05 UTC
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>
1 parent c2fc54f
History
Tip revision: 1a31a88f4f1a14f0b28ec3c5c179b93a10b24a18 authored by David Brownell on 11 May 2008, 18:37:05 UTC
i2c: Improve smbus-protocol documentation
Tip revision: 1a31a88
File Mode Size
Documentation
arch
block
crypto
drivers
fs
include
init
ipc
kernel
lib
mm
net
samples
scripts
security
sound
usr
virt
.gitignore -rw-r--r-- 682 bytes
.mailmap -rw-r--r-- 3.6 KB
COPYING -rw-r--r-- 18.3 KB
CREDITS -rw-r--r-- 90.5 KB
Kbuild -rw-r--r-- 2.4 KB
MAINTAINERS -rw-r--r-- 97.0 KB
Makefile -rw-r--r-- 53.7 KB
README -rw-r--r-- 16.5 KB
REPORTING-BUGS -rw-r--r-- 3.1 KB

README

back to top