i2c.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  1. /* ------------------------------------------------------------------------- */
  2. /* */
  3. /* i2c.h - definitions for the i2c-bus interface */
  4. /* */
  5. /* ------------------------------------------------------------------------- */
  6. /* Copyright (C) 1995-2000 Simon G. Vogl
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11. This program is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. GNU General Public License for more details.
  15. You should have received a copy of the GNU General Public License
  16. along with this program; if not, write to the Free Software
  17. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
  18. /* ------------------------------------------------------------------------- */
  19. /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
  20. Frodo Looijaard <frodol@dds.nl> */
  21. #ifndef _LINUX_I2C_H
  22. #define _LINUX_I2C_H
  23. #include <linux/module.h>
  24. #include <linux/types.h>
  25. #include <linux/i2c-id.h>
  26. #include <linux/device.h> /* for struct device */
  27. #include <asm/semaphore.h>
  28. /* --- For i2c-isa ---------------------------------------------------- */
  29. extern void i2c_adapter_dev_release(struct device *dev);
  30. extern struct device_driver i2c_adapter_driver;
  31. extern struct class i2c_adapter_class;
  32. extern struct bus_type i2c_bus_type;
  33. /* --- General options ------------------------------------------------ */
  34. struct i2c_msg;
  35. struct i2c_algorithm;
  36. struct i2c_adapter;
  37. struct i2c_client;
  38. struct i2c_driver;
  39. union i2c_smbus_data;
  40. /*
  41. * The master routines are the ones normally used to transmit data to devices
  42. * on a bus (or read from them). Apart from two basic transfer functions to
  43. * transmit one message at a time, a more complex version can be used to
  44. * transmit an arbitrary number of messages without interruption.
  45. */
  46. extern int i2c_master_send(struct i2c_client *,const char* ,int);
  47. extern int i2c_master_recv(struct i2c_client *,char* ,int);
  48. /* Transfer num messages.
  49. */
  50. extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
  51. /*
  52. * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
  53. * This is not tested/implemented yet and will change in the future.
  54. */
  55. extern int i2c_slave_send(struct i2c_client *,char*,int);
  56. extern int i2c_slave_recv(struct i2c_client *,char*,int);
  57. /* This is the very generalized SMBus access routine. You probably do not
  58. want to use this, though; one of the functions below may be much easier,
  59. and probably just as fast.
  60. Note that we use i2c_adapter here, because you do not need a specific
  61. smbus adapter to call this function. */
  62. extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  63. unsigned short flags,
  64. char read_write, u8 command, int size,
  65. union i2c_smbus_data * data);
  66. /* Now follow the 'nice' access routines. These also document the calling
  67. conventions of smbus_access. */
  68. extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  69. extern s32 i2c_smbus_read_byte(struct i2c_client * client);
  70. extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
  71. extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
  72. extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
  73. u8 command, u8 value);
  74. extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
  75. extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
  76. u8 command, u16 value);
  77. extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  78. u8 command, u8 length,
  79. u8 *values);
  80. /* Returns the number of read bytes */
  81. extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
  82. u8 command, u8 *values);
  83. /*
  84. * A driver is capable of handling one or more physical devices present on
  85. * I2C adapters. This information is used to inform the driver of adapter
  86. * events.
  87. */
  88. struct i2c_driver {
  89. struct module *owner;
  90. char name[32];
  91. int id;
  92. unsigned int class;
  93. unsigned int flags; /* div., see below */
  94. /* Notifies the driver that a new bus has appeared. This routine
  95. * can be used by the driver to test if the bus meets its conditions
  96. * & seek for the presence of the chip(s) it supports. If found, it
  97. * registers the client(s) that are on the bus to the i2c admin. via
  98. * i2c_attach_client.
  99. */
  100. int (*attach_adapter)(struct i2c_adapter *);
  101. int (*detach_adapter)(struct i2c_adapter *);
  102. /* tells the driver that a client is about to be deleted & gives it
  103. * the chance to remove its private data. Also, if the client struct
  104. * has been dynamically allocated by the driver in the function above,
  105. * it must be freed here.
  106. */
  107. int (*detach_client)(struct i2c_client *);
  108. /* a ioctl like command that can be used to perform specific functions
  109. * with the device.
  110. */
  111. int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
  112. struct device_driver driver;
  113. struct list_head list;
  114. };
  115. #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
  116. #define I2C_NAME_SIZE 50
  117. /*
  118. * i2c_client identifies a single device (i.e. chip) that is connected to an
  119. * i2c bus. The behaviour is defined by the routines of the driver. This
  120. * function is mainly used for lookup & other admin. functions.
  121. */
  122. struct i2c_client {
  123. unsigned int flags; /* div., see below */
  124. unsigned short addr; /* chip address - NOTE: 7bit */
  125. /* addresses are stored in the */
  126. /* _LOWER_ 7 bits */
  127. struct i2c_adapter *adapter; /* the adapter we sit on */
  128. struct i2c_driver *driver; /* and our access routines */
  129. int usage_count; /* How many accesses currently */
  130. /* to the client */
  131. struct device dev; /* the device structure */
  132. struct list_head list;
  133. char name[I2C_NAME_SIZE];
  134. struct completion released;
  135. };
  136. #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
  137. static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
  138. {
  139. return to_i2c_client(container_of(kobj, struct device, kobj));
  140. }
  141. static inline void *i2c_get_clientdata (struct i2c_client *dev)
  142. {
  143. return dev_get_drvdata (&dev->dev);
  144. }
  145. static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
  146. {
  147. dev_set_drvdata (&dev->dev, data);
  148. }
  149. /*
  150. * The following structs are for those who like to implement new bus drivers:
  151. * i2c_algorithm is the interface to a class of hardware solutions which can
  152. * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
  153. * to name two of the most common.
  154. */
  155. struct i2c_algorithm {
  156. /* If an adapter algorithm can't do I2C-level access, set master_xfer
  157. to NULL. If an adapter algorithm can do SMBus access, set
  158. smbus_xfer. If set to NULL, the SMBus protocol is simulated
  159. using common I2C messages */
  160. int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
  161. int num);
  162. int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
  163. unsigned short flags, char read_write,
  164. u8 command, int size, union i2c_smbus_data * data);
  165. /* --- these optional/future use for some adapter types.*/
  166. int (*slave_send)(struct i2c_adapter *,char*,int);
  167. int (*slave_recv)(struct i2c_adapter *,char*,int);
  168. /* --- ioctl like call to set div. parameters. */
  169. int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
  170. /* To determine what the adapter supports */
  171. u32 (*functionality) (struct i2c_adapter *);
  172. };
  173. /*
  174. * i2c_adapter is the structure used to identify a physical i2c bus along
  175. * with the access algorithms necessary to access it.
  176. */
  177. struct i2c_adapter {
  178. struct module *owner;
  179. unsigned int id;
  180. unsigned int class;
  181. struct i2c_algorithm *algo;/* the algorithm to access the bus */
  182. void *algo_data;
  183. /* --- administration stuff. */
  184. int (*client_register)(struct i2c_client *);
  185. int (*client_unregister)(struct i2c_client *);
  186. /* data fields that are valid for all devices */
  187. struct semaphore bus_lock;
  188. struct semaphore clist_lock;
  189. int timeout;
  190. int retries;
  191. struct device dev; /* the adapter device */
  192. struct class_device class_dev; /* the class device */
  193. int nr;
  194. struct list_head clients;
  195. struct list_head list;
  196. char name[I2C_NAME_SIZE];
  197. struct completion dev_released;
  198. struct completion class_dev_released;
  199. };
  200. #define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
  201. #define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
  202. static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
  203. {
  204. return dev_get_drvdata (&dev->dev);
  205. }
  206. static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
  207. {
  208. dev_set_drvdata (&dev->dev, data);
  209. }
  210. /*flags for the driver struct: */
  211. #define I2C_DF_NOTIFY 0x01 /* notify on bus (de/a)ttaches */
  212. #if 0
  213. /* this flag is gone -- there is a (optional) driver->detach_adapter
  214. * callback now which can be used instead */
  215. # define I2C_DF_DUMMY 0x02
  216. #endif
  217. /*flags for the client struct: */
  218. #define I2C_CLIENT_ALLOW_USE 0x01 /* Client allows access */
  219. #define I2C_CLIENT_ALLOW_MULTIPLE_USE 0x02 /* Allow multiple access-locks */
  220. /* on an i2c_client */
  221. #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
  222. #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
  223. /* Must equal I2C_M_TEN below */
  224. /* i2c adapter classes (bitmask) */
  225. #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
  226. #define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
  227. #define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
  228. #define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
  229. #define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
  230. #define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
  231. #define I2C_CLASS_SOUND (1<<6) /* sound devices */
  232. #define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
  233. /* i2c_client_address_data is the struct for holding default client
  234. * addresses for a driver and for the parameters supplied on the
  235. * command line
  236. */
  237. struct i2c_client_address_data {
  238. unsigned short *normal_i2c;
  239. unsigned short *probe;
  240. unsigned short *ignore;
  241. unsigned short **forces;
  242. };
  243. /* Internal numbers to terminate lists */
  244. #define I2C_CLIENT_END 0xfffeU
  245. /* The numbers to use to set I2C bus address */
  246. #define ANY_I2C_BUS 0xffff
  247. #define ANY_I2C_ISA_BUS 9191
  248. /* ----- functions exported by i2c.o */
  249. /* administration...
  250. */
  251. extern int i2c_add_adapter(struct i2c_adapter *);
  252. extern int i2c_del_adapter(struct i2c_adapter *);
  253. extern int i2c_add_driver(struct i2c_driver *);
  254. extern int i2c_del_driver(struct i2c_driver *);
  255. extern int i2c_attach_client(struct i2c_client *);
  256. extern int i2c_detach_client(struct i2c_client *);
  257. /* New function: This is to get an i2c_client-struct for controlling the
  258. client either by using i2c_control-function or having the
  259. client-module export functions that can be used with the i2c_client
  260. -struct. */
  261. extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
  262. struct i2c_client *prev);
  263. /* Should be used with new function
  264. extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
  265. to make sure that client-struct is valid and that it is okay to access
  266. the i2c-client.
  267. returns -EACCES if client doesn't allow use (default)
  268. returns -EBUSY if client doesn't allow multiple use (default) and
  269. usage_count >0 */
  270. extern int i2c_use_client(struct i2c_client *);
  271. extern int i2c_release_client(struct i2c_client *);
  272. /* call the i2c_client->command() of all attached clients with
  273. * the given arguments */
  274. extern void i2c_clients_command(struct i2c_adapter *adap,
  275. unsigned int cmd, void *arg);
  276. /* returns -EBUSY if address has been taken, 0 if not. Note that the only
  277. other place at which this is called is within i2c_attach_client; so
  278. you can cheat by simply not registering. Not recommended, of course! */
  279. extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
  280. /* Detect function. It iterates over all possible addresses itself.
  281. * It will only call found_proc if some client is connected at the
  282. * specific address (unless a 'force' matched);
  283. */
  284. extern int i2c_probe(struct i2c_adapter *adapter,
  285. struct i2c_client_address_data *address_data,
  286. int (*found_proc) (struct i2c_adapter *, int, int));
  287. /* An ioctl like call to set div. parameters of the adapter.
  288. */
  289. extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
  290. extern struct i2c_adapter* i2c_get_adapter(int id);
  291. extern void i2c_put_adapter(struct i2c_adapter *adap);
  292. /* Return the functionality mask */
  293. static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
  294. {
  295. return adap->algo->functionality(adap);
  296. }
  297. /* Return 1 if adapter supports everything we need, 0 if not. */
  298. static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
  299. {
  300. return (func & i2c_get_functionality(adap)) == func;
  301. }
  302. /* Return id number for a specific adapter */
  303. static inline int i2c_adapter_id(struct i2c_adapter *adap)
  304. {
  305. return adap->nr;
  306. }
  307. /*
  308. * I2C Message - used for pure i2c transaction, also from /dev interface
  309. */
  310. struct i2c_msg {
  311. __u16 addr; /* slave address */
  312. __u16 flags;
  313. #define I2C_M_TEN 0x10 /* we have a ten bit chip address */
  314. #define I2C_M_RD 0x01
  315. #define I2C_M_NOSTART 0x4000
  316. #define I2C_M_REV_DIR_ADDR 0x2000
  317. #define I2C_M_IGNORE_NAK 0x1000
  318. #define I2C_M_NO_RD_ACK 0x0800
  319. __u16 len; /* msg length */
  320. __u8 *buf; /* pointer to msg data */
  321. };
  322. /* To determine what functionality is present */
  323. #define I2C_FUNC_I2C 0x00000001
  324. #define I2C_FUNC_10BIT_ADDR 0x00000002
  325. #define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
  326. #define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
  327. #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
  328. #define I2C_FUNC_SMBUS_QUICK 0x00010000
  329. #define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
  330. #define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
  331. #define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
  332. #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
  333. #define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
  334. #define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
  335. #define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
  336. #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
  337. #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
  338. #define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
  339. #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
  340. #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
  341. #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
  342. #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
  343. I2C_FUNC_SMBUS_WRITE_BYTE)
  344. #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
  345. I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
  346. #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
  347. I2C_FUNC_SMBUS_WRITE_WORD_DATA)
  348. #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
  349. I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
  350. #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
  351. I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
  352. #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
  353. I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
  354. #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
  355. I2C_FUNC_SMBUS_BYTE | \
  356. I2C_FUNC_SMBUS_BYTE_DATA | \
  357. I2C_FUNC_SMBUS_WORD_DATA | \
  358. I2C_FUNC_SMBUS_PROC_CALL | \
  359. I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
  360. I2C_FUNC_SMBUS_I2C_BLOCK)
  361. /*
  362. * Data for SMBus Messages
  363. */
  364. #define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
  365. union i2c_smbus_data {
  366. __u8 byte;
  367. __u16 word;
  368. __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
  369. /* and one more for PEC */
  370. };
  371. /* smbus_access read or write markers */
  372. #define I2C_SMBUS_READ 1
  373. #define I2C_SMBUS_WRITE 0
  374. /* SMBus transaction types (size parameter in the above functions)
  375. Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
  376. #define I2C_SMBUS_QUICK 0
  377. #define I2C_SMBUS_BYTE 1
  378. #define I2C_SMBUS_BYTE_DATA 2
  379. #define I2C_SMBUS_WORD_DATA 3
  380. #define I2C_SMBUS_PROC_CALL 4
  381. #define I2C_SMBUS_BLOCK_DATA 5
  382. #define I2C_SMBUS_I2C_BLOCK_DATA 6
  383. #define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
  384. #define I2C_SMBUS_BLOCK_DATA_PEC 8 /* SMBus 2.0 */
  385. #define I2C_SMBUS_PROC_CALL_PEC 9 /* SMBus 2.0 */
  386. #define I2C_SMBUS_BLOCK_PROC_CALL_PEC 10 /* SMBus 2.0 */
  387. #define I2C_SMBUS_WORD_DATA_PEC 11 /* SMBus 2.0 */
  388. /* ----- commands for the ioctl like i2c_command call:
  389. * note that additional calls are defined in the algorithm and hw
  390. * dependent layers - these can be listed here, or see the
  391. * corresponding header files.
  392. */
  393. /* -> bit-adapter specific ioctls */
  394. #define I2C_RETRIES 0x0701 /* number of times a device address */
  395. /* should be polled when not */
  396. /* acknowledging */
  397. #define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
  398. /* this is for i2c-dev.c */
  399. #define I2C_SLAVE 0x0703 /* Change slave address */
  400. /* Attn.: Slave address is 7 or 10 bits */
  401. #define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
  402. /* Attn.: Slave address is 7 or 10 bits */
  403. /* This changes the address, even if it */
  404. /* is already taken! */
  405. #define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
  406. #define I2C_FUNCS 0x0705 /* Get the adapter functionality */
  407. #define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
  408. #define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
  409. #define I2C_SMBUS 0x0720 /* SMBus-level access */
  410. /* ----- I2C-DEV: char device interface stuff ------------------------- */
  411. #define I2C_MAJOR 89 /* Device major number */
  412. /* These defines are used for probing i2c client addresses */
  413. /* The length of the option lists */
  414. #define I2C_CLIENT_MAX_OPTS 48
  415. /* Default fill of many variables */
  416. #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  417. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  418. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  419. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  420. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  421. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  422. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  423. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  424. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  425. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  426. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  427. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  428. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  429. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  430. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  431. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
  432. /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
  433. module header */
  434. #define I2C_CLIENT_MODULE_PARM(var,desc) \
  435. static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
  436. static unsigned int var##_num; \
  437. module_param_array(var, short, &var##_num, 0); \
  438. MODULE_PARM_DESC(var,desc)
  439. #define I2C_CLIENT_MODULE_PARM_FORCE(name) \
  440. I2C_CLIENT_MODULE_PARM(force_##name, \
  441. "List of adapter,address pairs which are " \
  442. "unquestionably assumed to contain a `" \
  443. # name "' chip")
  444. #define I2C_CLIENT_INSMOD_COMMON \
  445. I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
  446. "additionally"); \
  447. I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
  448. "scan"); \
  449. static struct i2c_client_address_data addr_data = { \
  450. .normal_i2c = normal_i2c, \
  451. .probe = probe, \
  452. .ignore = ignore, \
  453. .forces = forces, \
  454. }
  455. /* These are the ones you want to use in your own drivers. Pick the one
  456. which matches the number of devices the driver differenciates between. */
  457. #define I2C_CLIENT_INSMOD \
  458. I2C_CLIENT_MODULE_PARM(force, \
  459. "List of adapter,address pairs to boldly assume " \
  460. "to be present"); \
  461. static unsigned short *forces[] = { \
  462. force, \
  463. NULL \
  464. }; \
  465. I2C_CLIENT_INSMOD_COMMON
  466. #define I2C_CLIENT_INSMOD_1(chip1) \
  467. enum chips { any_chip, chip1 }; \
  468. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  469. "boldly assume to be present"); \
  470. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  471. static unsigned short *forces[] = { force, force_##chip1, NULL }; \
  472. I2C_CLIENT_INSMOD_COMMON
  473. #define I2C_CLIENT_INSMOD_2(chip1, chip2) \
  474. enum chips { any_chip, chip1, chip2 }; \
  475. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  476. "boldly assume to be present"); \
  477. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  478. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  479. static unsigned short *forces[] = { force, force_##chip1, \
  480. force_##chip2, NULL }; \
  481. I2C_CLIENT_INSMOD_COMMON
  482. #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
  483. enum chips { any_chip, chip1, chip2, chip3 }; \
  484. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  485. "boldly assume to be present"); \
  486. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  487. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  488. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  489. static unsigned short *forces[] = { force, force_##chip1, \
  490. force_##chip2, force_##chip3, \
  491. NULL }; \
  492. I2C_CLIENT_INSMOD_COMMON
  493. #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
  494. enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
  495. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  496. "boldly assume to be present"); \
  497. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  498. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  499. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  500. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  501. static unsigned short *forces[] = { force, force_##chip1, \
  502. force_##chip2, force_##chip3, \
  503. force_##chip4, NULL}; \
  504. I2C_CLIENT_INSMOD_COMMON
  505. #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
  506. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
  507. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  508. "boldly assume to be present"); \
  509. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  510. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  511. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  512. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  513. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  514. static unsigned short *forces[] = { force, force_##chip1, \
  515. force_##chip2, force_##chip3, \
  516. force_##chip4, force_##chip5, \
  517. NULL }; \
  518. I2C_CLIENT_INSMOD_COMMON
  519. #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
  520. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
  521. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  522. "boldly assume to be present"); \
  523. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  524. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  525. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  526. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  527. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  528. I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
  529. static unsigned short *forces[] = { force, force_##chip1, \
  530. force_##chip2, force_##chip3, \
  531. force_##chip4, force_##chip5, \
  532. force_##chip6, NULL }; \
  533. I2C_CLIENT_INSMOD_COMMON
  534. #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
  535. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
  536. chip7 }; \
  537. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  538. "boldly assume to be present"); \
  539. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  540. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  541. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  542. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  543. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  544. I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
  545. I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
  546. static unsigned short *forces[] = { force, force_##chip1, \
  547. force_##chip2, force_##chip3, \
  548. force_##chip4, force_##chip5, \
  549. force_##chip6, force_##chip7, \
  550. NULL }; \
  551. I2C_CLIENT_INSMOD_COMMON
  552. #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
  553. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
  554. chip7, chip8 }; \
  555. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  556. "boldly assume to be present"); \
  557. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  558. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  559. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  560. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  561. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  562. I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
  563. I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
  564. I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
  565. static unsigned short *forces[] = { force, force_##chip1, \
  566. force_##chip2, force_##chip3, \
  567. force_##chip4, force_##chip5, \
  568. force_##chip6, force_##chip7, \
  569. force_##chip8, NULL }; \
  570. I2C_CLIENT_INSMOD_COMMON
  571. #endif /* _LINUX_I2C_H */