path: root/Documentation/i2c
diff options
authorJean Delvare <khali@linux-fr.org>2005-06-25 11:37:40 +0200
committerGreg Kroah-Hartman <gregkh@suse.de>2005-07-11 14:10:37 -0700
commit1d772e2587da3c8b0fb8610fcc1c91fd82f87e52 (patch)
tree816702c0b2b1a37f772b8884ce2177b88af4ab73 /Documentation/i2c
parenta68e2f4895070f3a449bfe5ae1174b73cc900642 (diff)
[PATCH] I2C: Clarify the usage of i2c-dev.h
Upon suggestion by Nils Roeder, here is an update to the i2c documentation to clarify which header files user-space applications relying on the i2c-dev interface should include. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'Documentation/i2c')
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
index a78ea62506ee..b849ad636583 100644
--- a/Documentation/i2c/dev-interface
+++ b/Documentation/i2c/dev-interface
@@ -14,9 +14,12 @@ C example
So let's say you want to access an i2c adapter from a C program. The
-first thing to do is `#include <linux/i2c.h>" and "#include <linux/i2c-dev.h>.
-Yes, I know, you should never include kernel header files, but until glibc
-knows about i2c, there is not much choice.
+first thing to do is "#include <linux/i2c-dev.h>". Please note that
+there are two files named "i2c-dev.h" out there, one is distributed
+with the Linux kernel and is meant to be included from kernel
+driver code, the other one is distributed with lm_sensors and is
+meant to be included from user-space programs. You obviously want
+the second one here.
Now, you have to decide which adapter you want to access. You should
inspect /sys/class/i2c-dev/ to decide this. Adapter numbers are assigned
@@ -78,7 +81,7 @@ Full interface description
The following IOCTLs are defined and fully supported
-(see also i2c-dev.h and i2c.h):
+(see also i2c-dev.h):
ioctl(file,I2C_SLAVE,long addr)
Change slave address. The address is passed in the 7 lower bits of the