i2c.h 24 KB

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