aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/i2c/writing-clients
diff options
context:
space:
mode:
authorJean Delvare <khali@linux-fr.org>2005-10-07 18:00:31 -0400
committerGreg Kroah-Hartman <gregkh@suse.de>2005-10-28 17:02:09 -0400
commit7865e24935ec7e76fb482c749015a23052e51f76 (patch)
tree9a5fc835415cccc57ec2b7bf86365d4d6ac3f2ba /Documentation/i2c/writing-clients
parent47b8b103f7f50d56568eb8d6cff0e3a2373f0eb3 (diff)
[PATCH] i2c: Documentation fixes
i2c documentation fixes. >From Hideki Iwamoto: * i2c_smbus_read_i2c_block_data is not deleted in 2.6.10. It still exists. * The name which can be set to i2c_driver is up to 31 characters. >From Jean Delvare: * Reword the paragraph about i2c_driver.name, to reflect the "new" naming policy. * Delete the out-of-date note about now gone inc_use and dec_use fields. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'Documentation/i2c/writing-clients')
-rw-r--r--Documentation/i2c/writing-clients11
1 files changed, 4 insertions, 7 deletions
diff --git a/Documentation/i2c/writing-clients b/Documentation/i2c/writing-clients
index 077275722a7c..1882811c7f5d 100644
--- a/Documentation/i2c/writing-clients
+++ b/Documentation/i2c/writing-clients
@@ -33,8 +33,8 @@ static struct i2c_driver foo_driver = {
33 .command = &foo_command /* may be NULL */ 33 .command = &foo_command /* may be NULL */
34} 34}
35 35
36The name can be chosen freely, and may be upto 40 characters long. Please 36The name field must match the driver name, including the case. It must not
37use something descriptive here. 37contain spaces, and may be up to 31 characters long.
38 38
39Don't worry about the flags field; just put I2C_DF_NOTIFY into it. This 39Don't worry about the flags field; just put I2C_DF_NOTIFY into it. This
40means that your driver will be notified when new adapters are found. 40means that your driver will be notified when new adapters are found.
@@ -43,9 +43,6 @@ This is almost always what you want.
43All other fields are for call-back functions which will be explained 43All other fields are for call-back functions which will be explained
44below. 44below.
45 45
46There use to be two additional fields in this structure, inc_use et dec_use,
47for module usage count, but these fields were obsoleted and removed.
48
49 46
50Extra client data 47Extra client data
51================= 48=================
@@ -576,12 +573,12 @@ SMBus communication
576 extern s32 i2c_smbus_write_block_data(struct i2c_client * client, 573 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
577 u8 command, u8 length, 574 u8 command, u8 length,
578 u8 *values); 575 u8 *values);
576 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
577 u8 command, u8 *values);
579 578
580These ones were removed in Linux 2.6.10 because they had no users, but could 579These ones were removed in Linux 2.6.10 because they had no users, but could
581be added back later if needed: 580be added back later if needed:
582 581
583 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
584 u8 command, u8 *values);
585 extern s32 i2c_smbus_read_block_data(struct i2c_client * client, 582 extern s32 i2c_smbus_read_block_data(struct i2c_client * client,
586 u8 command, u8 *values); 583 u8 command, u8 *values);
587 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client, 584 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,