1 =============================== 1 ===============================
2 Implementing I2C device drivers 2 Implementing I2C device drivers
3 =============================== 3 ===============================
4 4
5 This is a small guide for those who want to wr 5 This is a small guide for those who want to write kernel drivers for I2C
6 or SMBus devices, using Linux as the protocol 6 or SMBus devices, using Linux as the protocol host/master (not slave).
7 7
8 To set up a driver, you need to do several thi 8 To set up a driver, you need to do several things. Some are optional, and
9 some things can be done slightly or completely 9 some things can be done slightly or completely different. Use this as a
10 guide, not as a rule book! 10 guide, not as a rule book!
11 11
12 12
13 General remarks 13 General remarks
14 =============== 14 ===============
15 15
16 Try to keep the kernel namespace as clean as p 16 Try to keep the kernel namespace as clean as possible. The best way to
17 do this is to use a unique prefix for all glob 17 do this is to use a unique prefix for all global symbols. This is
18 especially important for exported symbols, but 18 especially important for exported symbols, but it is a good idea to do
19 it for non-exported symbols too. We will use t 19 it for non-exported symbols too. We will use the prefix ``foo_`` in this
20 tutorial. 20 tutorial.
21 21
22 22
23 The driver structure 23 The driver structure
24 ==================== 24 ====================
25 25
26 Usually, you will implement a single driver st 26 Usually, you will implement a single driver structure, and instantiate
27 all clients from it. Remember, a driver struct 27 all clients from it. Remember, a driver structure contains general access
28 routines, and should be zero-initialized excep 28 routines, and should be zero-initialized except for fields with data you
29 provide. A client structure holds device-spec 29 provide. A client structure holds device-specific information like the
30 driver model device node, and its I2C address. 30 driver model device node, and its I2C address.
31 31
32 :: 32 ::
33 33
34 static struct i2c_device_id foo_idtable[] = 34 static struct i2c_device_id foo_idtable[] = {
35 { "foo", my_id_for_foo }, 35 { "foo", my_id_for_foo },
36 { "bar", my_id_for_bar }, 36 { "bar", my_id_for_bar },
37 { } 37 { }
38 }; 38 };
39 39
40 MODULE_DEVICE_TABLE(i2c, foo_idtable); 40 MODULE_DEVICE_TABLE(i2c, foo_idtable);
41 41
42 static struct i2c_driver foo_driver = { 42 static struct i2c_driver foo_driver = {
43 .driver = { 43 .driver = {
44 .name = "foo", 44 .name = "foo",
45 .pm = &foo_pm_ops, /* opt 45 .pm = &foo_pm_ops, /* optional */
46 }, 46 },
47 47
48 .id_table = foo_idtable, 48 .id_table = foo_idtable,
49 .probe = foo_probe, !! 49 .probe_new = foo_probe,
50 .remove = foo_remove, 50 .remove = foo_remove,
>> 51 /* if device autodetection is needed: */
>> 52 .class = I2C_CLASS_SOMETHING,
>> 53 .detect = foo_detect,
>> 54 .address_list = normal_i2c,
51 55
52 .shutdown = foo_shutdown, /* opt 56 .shutdown = foo_shutdown, /* optional */
53 .command = foo_command, /* opt 57 .command = foo_command, /* optional, deprecated */
54 } 58 }
55 59
56 The name field is the driver name, and must no 60 The name field is the driver name, and must not contain spaces. It
57 should match the module name (if the driver ca 61 should match the module name (if the driver can be compiled as a module),
58 although you can use MODULE_ALIAS (passing "fo 62 although you can use MODULE_ALIAS (passing "foo" in this example) to add
59 another name for the module. If the driver na 63 another name for the module. If the driver name doesn't match the module
60 name, the module won't be automatically loaded 64 name, the module won't be automatically loaded (hotplug/coldplug).
61 65
62 All other fields are for call-back functions w 66 All other fields are for call-back functions which will be explained
63 below. 67 below.
64 68
65 69
66 Extra client data 70 Extra client data
67 ================= 71 =================
68 72
69 Each client structure has a special ``data`` f 73 Each client structure has a special ``data`` field that can point to any
70 structure at all. You should use this to keep 74 structure at all. You should use this to keep device-specific data.
71 75
72 :: 76 ::
73 77
74 /* store the value */ 78 /* store the value */
75 void i2c_set_clientdata(struct i2c_cli 79 void i2c_set_clientdata(struct i2c_client *client, void *data);
76 80
77 /* retrieve the value */ 81 /* retrieve the value */
78 void *i2c_get_clientdata(const struct 82 void *i2c_get_clientdata(const struct i2c_client *client);
79 83
80 Note that starting with kernel 2.6.34, you don 84 Note that starting with kernel 2.6.34, you don't have to set the ``data`` field
81 to NULL in remove() or if probe() failed anymo 85 to NULL in remove() or if probe() failed anymore. The i2c-core does this
82 automatically on these occasions. Those are al 86 automatically on these occasions. Those are also the only times the core will
83 touch this field. 87 touch this field.
84 88
85 89
86 Accessing the client 90 Accessing the client
87 ==================== 91 ====================
88 92
89 Let's say we have a valid client structure. At 93 Let's say we have a valid client structure. At some time, we will need
90 to gather information from the client, or writ 94 to gather information from the client, or write new information to the
91 client. 95 client.
92 96
93 I have found it useful to define foo_read and 97 I have found it useful to define foo_read and foo_write functions for this.
94 For some cases, it will be easier to call the 98 For some cases, it will be easier to call the I2C functions directly,
95 but many chips have some kind of register-valu 99 but many chips have some kind of register-value idea that can easily
96 be encapsulated. 100 be encapsulated.
97 101
98 The below functions are simple examples, and s 102 The below functions are simple examples, and should not be copied
99 literally:: 103 literally::
100 104
101 int foo_read_value(struct i2c_client *client 105 int foo_read_value(struct i2c_client *client, u8 reg)
102 { 106 {
103 if (reg < 0x10) /* byte-sized register 107 if (reg < 0x10) /* byte-sized register */
104 return i2c_smbus_read_byte_dat 108 return i2c_smbus_read_byte_data(client, reg);
105 else /* word-sized register 109 else /* word-sized register */
106 return i2c_smbus_read_word_dat 110 return i2c_smbus_read_word_data(client, reg);
107 } 111 }
108 112
109 int foo_write_value(struct i2c_client *clien 113 int foo_write_value(struct i2c_client *client, u8 reg, u16 value)
110 { 114 {
111 if (reg == 0x10) /* Impossible 115 if (reg == 0x10) /* Impossible to write - driver error! */
112 return -EINVAL; 116 return -EINVAL;
113 else if (reg < 0x10) /* byte-sized 117 else if (reg < 0x10) /* byte-sized register */
114 return i2c_smbus_write_byte_da 118 return i2c_smbus_write_byte_data(client, reg, value);
115 else /* word-sized 119 else /* word-sized register */
116 return i2c_smbus_write_word_da 120 return i2c_smbus_write_word_data(client, reg, value);
117 } 121 }
118 122
119 123
120 Probing and attaching 124 Probing and attaching
121 ===================== 125 =====================
122 126
123 The Linux I2C stack was originally written to 127 The Linux I2C stack was originally written to support access to hardware
124 monitoring chips on PC motherboards, and thus 128 monitoring chips on PC motherboards, and thus used to embed some assumptions
125 that were more appropriate to SMBus (and PCs) 129 that were more appropriate to SMBus (and PCs) than to I2C. One of these
126 assumptions was that most adapters and devices 130 assumptions was that most adapters and devices drivers support the SMBUS_QUICK
127 protocol to probe device presence. Another wa 131 protocol to probe device presence. Another was that devices and their drivers
128 can be sufficiently configured using only such 132 can be sufficiently configured using only such probe primitives.
129 133
130 As Linux and its I2C stack became more widely 134 As Linux and its I2C stack became more widely used in embedded systems
131 and complex components such as DVB adapters, t 135 and complex components such as DVB adapters, those assumptions became more
132 problematic. Drivers for I2C devices that iss 136 problematic. Drivers for I2C devices that issue interrupts need more (and
133 different) configuration information, as do dr 137 different) configuration information, as do drivers handling chip variants
134 that can't be distinguished by protocol probin 138 that can't be distinguished by protocol probing, or which need some board
135 specific information to operate correctly. 139 specific information to operate correctly.
136 140
137 141
138 Device/Driver Binding 142 Device/Driver Binding
139 --------------------- 143 ---------------------
140 144
141 System infrastructure, typically board-specifi 145 System infrastructure, typically board-specific initialization code or
142 boot firmware, reports what I2C devices exist. 146 boot firmware, reports what I2C devices exist. For example, there may be
143 a table, in the kernel or from the boot loader 147 a table, in the kernel or from the boot loader, identifying I2C devices
144 and linking them to board-specific configurati 148 and linking them to board-specific configuration information about IRQs
145 and other wiring artifacts, chip type, and so 149 and other wiring artifacts, chip type, and so on. That could be used to
146 create i2c_client objects for each I2C device. 150 create i2c_client objects for each I2C device.
147 151
148 I2C device drivers using this binding model wo 152 I2C device drivers using this binding model work just like any other
149 kind of driver in Linux: they provide a probe 153 kind of driver in Linux: they provide a probe() method to bind to
150 those devices, and a remove() method to unbind 154 those devices, and a remove() method to unbind.
151 155
152 :: 156 ::
153 157
154 static int foo_probe(struct i2c_client 158 static int foo_probe(struct i2c_client *client);
155 static void foo_remove(struct i2c_clie !! 159 static int foo_remove(struct i2c_client *client);
156 160
157 Remember that the i2c_driver does not create t 161 Remember that the i2c_driver does not create those client handles. The
158 handle may be used during foo_probe(). If foo 162 handle may be used during foo_probe(). If foo_probe() reports success
159 (zero not a negative status code) it may save 163 (zero not a negative status code) it may save the handle and use it until
160 foo_remove() returns. That binding model is u 164 foo_remove() returns. That binding model is used by most Linux drivers.
161 165
162 The probe function is called when an entry in 166 The probe function is called when an entry in the id_table name field
163 matches the device's name. If the probe functi 167 matches the device's name. If the probe function needs that entry, it
164 can retrieve it using 168 can retrieve it using
165 169
166 :: 170 ::
167 171
168 const struct i2c_device_id *id = i2c_m 172 const struct i2c_device_id *id = i2c_match_id(foo_idtable, client);
169 173
170 174
171 Device Creation 175 Device Creation
172 --------------- 176 ---------------
173 177
174 If you know for a fact that an I2C device is c 178 If you know for a fact that an I2C device is connected to a given I2C bus,
175 you can instantiate that device by simply fill 179 you can instantiate that device by simply filling an i2c_board_info
176 structure with the device address and driver n 180 structure with the device address and driver name, and calling
177 i2c_new_client_device(). This will create the 181 i2c_new_client_device(). This will create the device, then the driver core
178 will take care of finding the right driver and 182 will take care of finding the right driver and will call its probe() method.
179 If a driver supports different device types, y 183 If a driver supports different device types, you can specify the type you
180 want using the type field. You can also speci 184 want using the type field. You can also specify an IRQ and platform data
181 if needed. 185 if needed.
182 186
183 Sometimes you know that a device is connected 187 Sometimes you know that a device is connected to a given I2C bus, but you
184 don't know the exact address it uses. This ha 188 don't know the exact address it uses. This happens on TV adapters for
185 example, where the same driver supports dozens 189 example, where the same driver supports dozens of slightly different
186 models, and I2C device addresses change from o 190 models, and I2C device addresses change from one model to the next. In
187 that case, you can use the i2c_new_scanned_dev 191 that case, you can use the i2c_new_scanned_device() variant, which is
188 similar to i2c_new_client_device(), except tha 192 similar to i2c_new_client_device(), except that it takes an additional list
189 of possible I2C addresses to probe. A device 193 of possible I2C addresses to probe. A device is created for the first
190 responsive address in the list. If you expect 194 responsive address in the list. If you expect more than one device to be
191 present in the address range, simply call i2c_ 195 present in the address range, simply call i2c_new_scanned_device() that
192 many times. 196 many times.
193 197
194 The call to i2c_new_client_device() or i2c_new 198 The call to i2c_new_client_device() or i2c_new_scanned_device() typically
195 happens in the I2C bus driver. You may want to 199 happens in the I2C bus driver. You may want to save the returned i2c_client
196 reference for later use. 200 reference for later use.
197 201
198 202
199 Device Detection 203 Device Detection
200 ---------------- 204 ----------------
201 205
202 The device detection mechanism comes with a nu !! 206 Sometimes you do not know in advance which I2C devices are connected to
203 You need some reliable way to identify the sup !! 207 a given I2C bus. This is for example the case of hardware monitoring
>> 208 devices on a PC's SMBus. In that case, you may want to let your driver
>> 209 detect supported devices automatically. This is how the legacy model
>> 210 was working, and is now available as an extension to the standard
>> 211 driver model.
>> 212
>> 213 You simply have to define a detect callback which will attempt to
>> 214 identify supported devices (returning 0 for supported ones and -ENODEV
>> 215 for unsupported ones), a list of addresses to probe, and a device type
>> 216 (or class) so that only I2C buses which may have that type of device
>> 217 connected (and not otherwise enumerated) will be probed. For example,
>> 218 a driver for a hardware monitoring chip for which auto-detection is
>> 219 needed would set its class to I2C_CLASS_HWMON, and only I2C adapters
>> 220 with a class including I2C_CLASS_HWMON would be probed by this driver.
>> 221 Note that the absence of matching classes does not prevent the use of
>> 222 a device of that type on the given I2C adapter. All it prevents is
>> 223 auto-detection; explicit instantiation of devices is still possible.
>> 224
>> 225 Note that this mechanism is purely optional and not suitable for all
>> 226 devices. You need some reliable way to identify the supported devices
204 (typically using device-specific, dedicated id 227 (typically using device-specific, dedicated identification registers),
205 otherwise misdetections are likely to occur an 228 otherwise misdetections are likely to occur and things can get wrong
206 quickly. Keep in mind that the I2C protocol d 229 quickly. Keep in mind that the I2C protocol doesn't include any
207 standard way to detect the presence of a chip 230 standard way to detect the presence of a chip at a given address, let
208 alone a standard way to identify devices. Eve 231 alone a standard way to identify devices. Even worse is the lack of
209 semantics associated to bus transfers, which m 232 semantics associated to bus transfers, which means that the same
210 transfer can be seen as a read operation by a 233 transfer can be seen as a read operation by a chip and as a write
211 operation by another chip. For these reasons, !! 234 operation by another chip. For these reasons, explicit device
212 considered a legacy mechanism and shouldn't be !! 235 instantiation should always be preferred to auto-detection where
>> 236 possible.
213 237
214 238
215 Device Deletion 239 Device Deletion
216 --------------- 240 ---------------
217 241
218 Each I2C device which has been created using i 242 Each I2C device which has been created using i2c_new_client_device()
219 or i2c_new_scanned_device() can be unregistere 243 or i2c_new_scanned_device() can be unregistered by calling
220 i2c_unregister_device(). If you don't call it 244 i2c_unregister_device(). If you don't call it explicitly, it will be
221 called automatically before the underlying I2C 245 called automatically before the underlying I2C bus itself is removed,
222 as a device can't survive its parent in the de 246 as a device can't survive its parent in the device driver model.
223 247
224 248
225 Initializing the driver 249 Initializing the driver
226 ======================= 250 =======================
227 251
228 When the kernel is booted, or when your foo dr 252 When the kernel is booted, or when your foo driver module is inserted,
229 you have to do some initializing. Fortunately, 253 you have to do some initializing. Fortunately, just registering the
230 driver module is usually enough. 254 driver module is usually enough.
231 255
232 :: 256 ::
233 257
234 static int __init foo_init(void) 258 static int __init foo_init(void)
235 { 259 {
236 return i2c_add_driver(&foo_driver); 260 return i2c_add_driver(&foo_driver);
237 } 261 }
238 module_init(foo_init); 262 module_init(foo_init);
239 263
240 static void __exit foo_cleanup(void) 264 static void __exit foo_cleanup(void)
241 { 265 {
242 i2c_del_driver(&foo_driver); 266 i2c_del_driver(&foo_driver);
243 } 267 }
244 module_exit(foo_cleanup); 268 module_exit(foo_cleanup);
245 269
246 The module_i2c_driver() macro can be used to 270 The module_i2c_driver() macro can be used to reduce above code.
247 271
248 module_i2c_driver(foo_driver); 272 module_i2c_driver(foo_driver);
249 273
250 Note that some functions are marked by ``__ini 274 Note that some functions are marked by ``__init``. These functions can
251 be removed after kernel booting (or module loa 275 be removed after kernel booting (or module loading) is completed.
252 Likewise, functions marked by ``__exit`` are d 276 Likewise, functions marked by ``__exit`` are dropped by the compiler when
253 the code is built into the kernel, as they wou 277 the code is built into the kernel, as they would never be called.
254 278
255 279
256 Driver Information 280 Driver Information
257 ================== 281 ==================
258 282
259 :: 283 ::
260 284
261 /* Substitute your own name and email addres 285 /* Substitute your own name and email address */
262 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl 286 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>"
263 MODULE_DESCRIPTION("Driver for Barf Inc. Foo 287 MODULE_DESCRIPTION("Driver for Barf Inc. Foo I2C devices");
264 288
265 /* a few non-GPL license types are also allo 289 /* a few non-GPL license types are also allowed */
266 MODULE_LICENSE("GPL"); 290 MODULE_LICENSE("GPL");
267 291
268 292
269 Power Management 293 Power Management
270 ================ 294 ================
271 295
272 If your I2C device needs special handling when 296 If your I2C device needs special handling when entering a system low
273 power state -- like putting a transceiver into 297 power state -- like putting a transceiver into a low power mode, or
274 activating a system wakeup mechanism -- do tha 298 activating a system wakeup mechanism -- do that by implementing the
275 appropriate callbacks for the dev_pm_ops of th 299 appropriate callbacks for the dev_pm_ops of the driver (like suspend
276 and resume). 300 and resume).
277 301
278 These are standard driver model calls, and the 302 These are standard driver model calls, and they work just like they
279 would for any other driver stack. The calls c 303 would for any other driver stack. The calls can sleep, and can use
280 I2C messaging to the device being suspended or 304 I2C messaging to the device being suspended or resumed (since their
281 parent I2C adapter is active when these calls 305 parent I2C adapter is active when these calls are issued, and IRQs
282 are still enabled). 306 are still enabled).
283 307
284 308
285 System Shutdown 309 System Shutdown
286 =============== 310 ===============
287 311
288 If your I2C device needs special handling when 312 If your I2C device needs special handling when the system shuts down
289 or reboots (including kexec) -- like turning s 313 or reboots (including kexec) -- like turning something off -- use a
290 shutdown() method. 314 shutdown() method.
291 315
292 Again, this is a standard driver model call, w 316 Again, this is a standard driver model call, working just like it
293 would for any other driver stack: the calls c 317 would for any other driver stack: the calls can sleep, and can use
294 I2C messaging. 318 I2C messaging.
295 319
296 320
297 Command function 321 Command function
298 ================ 322 ================
299 323
300 A generic ioctl-like function call back is sup 324 A generic ioctl-like function call back is supported. You will seldom
301 need this, and its use is deprecated anyway, s 325 need this, and its use is deprecated anyway, so newer design should not
302 use it. 326 use it.
303 327
304 328
305 Sending and receiving 329 Sending and receiving
306 ===================== 330 =====================
307 331
308 If you want to communicate with your device, t 332 If you want to communicate with your device, there are several functions
309 to do this. You can find all of them in <linux 333 to do this. You can find all of them in <linux/i2c.h>.
310 334
311 If you can choose between plain I2C communicat 335 If you can choose between plain I2C communication and SMBus level
312 communication, please use the latter. All adap 336 communication, please use the latter. All adapters understand SMBus level
313 commands, but only some of them understand pla 337 commands, but only some of them understand plain I2C!
314 338
315 339
316 Plain I2C communication 340 Plain I2C communication
317 ----------------------- 341 -----------------------
318 342
319 :: 343 ::
320 344
321 int i2c_master_send(struct i2c_client 345 int i2c_master_send(struct i2c_client *client, const char *buf,
322 int count); 346 int count);
323 int i2c_master_recv(struct i2c_client 347 int i2c_master_recv(struct i2c_client *client, char *buf, int count);
324 348
325 These routines read and write some bytes from/ 349 These routines read and write some bytes from/to a client. The client
326 contains the I2C address, so you do not have t 350 contains the I2C address, so you do not have to include it. The second
327 parameter contains the bytes to read/write, th 351 parameter contains the bytes to read/write, the third the number of bytes
328 to read/write (must be less than the length of 352 to read/write (must be less than the length of the buffer, also should be
329 less than 64k since msg.len is u16.) Returned 353 less than 64k since msg.len is u16.) Returned is the actual number of bytes
330 read/written. 354 read/written.
331 355
332 :: 356 ::
333 357
334 int i2c_transfer(struct i2c_adapter *a 358 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msg,
335 int num); 359 int num);
336 360
337 This sends a series of messages. Each message 361 This sends a series of messages. Each message can be a read or write,
338 and they can be mixed in any way. The transact 362 and they can be mixed in any way. The transactions are combined: no
339 stop condition is issued between transaction. 363 stop condition is issued between transaction. The i2c_msg structure
340 contains for each message the client address, 364 contains for each message the client address, the number of bytes of the
341 message and the message data itself. 365 message and the message data itself.
342 366
343 You can read the file i2c-protocol.rst for mor !! 367 You can read the file ``i2c-protocol`` for more information about the
344 actual I2C protocol. 368 actual I2C protocol.
345 369
346 370
347 SMBus communication 371 SMBus communication
348 ------------------- 372 -------------------
349 373
350 :: 374 ::
351 375
352 s32 i2c_smbus_xfer(struct i2c_adapter 376 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
353 unsigned short flag 377 unsigned short flags, char read_write, u8 command,
354 int size, union i2c 378 int size, union i2c_smbus_data *data);
355 379
356 This is the generic SMBus function. All functi 380 This is the generic SMBus function. All functions below are implemented
357 in terms of it. Never use this function direct 381 in terms of it. Never use this function directly!
358 382
359 :: 383 ::
360 384
361 s32 i2c_smbus_read_byte(struct i2c_cli 385 s32 i2c_smbus_read_byte(struct i2c_client *client);
362 s32 i2c_smbus_write_byte(struct i2c_cl 386 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
363 s32 i2c_smbus_read_byte_data(struct i2 387 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
364 s32 i2c_smbus_write_byte_data(struct i 388 s32 i2c_smbus_write_byte_data(struct i2c_client *client,
365 u8 comma 389 u8 command, u8 value);
366 s32 i2c_smbus_read_word_data(struct i2 390 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
367 s32 i2c_smbus_write_word_data(struct i 391 s32 i2c_smbus_write_word_data(struct i2c_client *client,
368 u8 comma 392 u8 command, u16 value);
369 s32 i2c_smbus_read_block_data(struct i 393 s32 i2c_smbus_read_block_data(struct i2c_client *client,
370 u8 comma 394 u8 command, u8 *values);
371 s32 i2c_smbus_write_block_data(struct 395 s32 i2c_smbus_write_block_data(struct i2c_client *client,
372 u8 comm 396 u8 command, u8 length, const u8 *values);
373 s32 i2c_smbus_read_i2c_block_data(stru 397 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
374 u8 c 398 u8 command, u8 length, u8 *values);
375 s32 i2c_smbus_write_i2c_block_data(str 399 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
376 u8 400 u8 command, u8 length,
377 con 401 const u8 *values);
378 402
379 These ones were removed from i2c-core because 403 These ones were removed from i2c-core because they had no users, but could
380 be added back later if needed:: 404 be added back later if needed::
381 405
382 s32 i2c_smbus_write_quick(struct i2c_c 406 s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value);
383 s32 i2c_smbus_process_call(struct i2c_ 407 s32 i2c_smbus_process_call(struct i2c_client *client,
384 u8 command, 408 u8 command, u16 value);
385 s32 i2c_smbus_block_process_call(struc 409 s32 i2c_smbus_block_process_call(struct i2c_client *client,
386 u8 co 410 u8 command, u8 length, u8 *values);
387 411
388 All these transactions return a negative errno 412 All these transactions return a negative errno value on failure. The 'write'
389 transactions return 0 on success; the 'read' t 413 transactions return 0 on success; the 'read' transactions return the read
390 value, except for block transactions, which re 414 value, except for block transactions, which return the number of values
391 read. The block buffers need not be longer tha 415 read. The block buffers need not be longer than 32 bytes.
392 416
393 You can read the file smbus-protocol.rst for m !! 417 You can read the file ``smbus-protocol`` for more information about the
394 actual SMBus protocol. 418 actual SMBus protocol.
395 419
396 420
397 General purpose routines 421 General purpose routines
398 ======================== 422 ========================
399 423
400 Below all general purpose routines are listed, 424 Below all general purpose routines are listed, that were not mentioned
401 before:: 425 before::
402 426
403 /* Return the adapter number for a spe 427 /* Return the adapter number for a specific adapter */
404 int i2c_adapter_id(struct i2c_adapter 428 int i2c_adapter_id(struct i2c_adapter *adap);
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.