Documentation/i2c/writing-clients.rst

19 it for non-exported symbols too. We will use the prefix ``foo_`` in this
28 routines, and should be zero-initialized except for fields with data you
29 provide.  A client structure holds device-specific information like the
66 All other fields are for call-back functions which will be explained
74 structure at all.  You should use this to keep device-specific data.
85 to NULL in remove() or if probe() failed anymore. The i2c-core does this
99 but many chips have some kind of register-value idea that can easily
107 	if (reg < 0x10)	/* byte-sized register */
109 	else		/* word-sized register */
115 	if (reg == 0x10)	/* Impossible to write - driver error! */
116 		return -EINVAL;
117 	else if (reg < 0x10)	/* byte-sized register */
119 	else			/* word-sized register */
143 ---------------------
145 System infrastructure, typically board-specific initialization code or
148 and linking them to board-specific configuration information about IRQs
173 ---------------
200 Device Detection
201 ----------------
211 identify supported devices (returning 0 for supported ones and -ENODEV
215 a driver for a hardware monitoring chip for which auto-detection is
220 auto-detection; explicit instantiation of devices is still possible.
224 (typically using device-specific, dedicated identification registers),
232 instantiation should always be preferred to auto-detection where
237 ---------------
286   /* a few non-GPL license types are also allowed */
294 power state -- like putting a transceiver into a low power mode, or
295 activating a system wakeup mechanism -- do that by implementing the
310 or reboots (including kexec) -- like turning something off -- use a
321 A generic ioctl-like function call back is supported. You will seldom
338 -----------------------
364 You can read the file ``i2c-protocol`` for more information about the
369 -------------------
400 These ones were removed from i2c-core because they had no users, but could
414 You can read the file ``smbus-protocol`` for more information about the