i2c.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644
  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/types.h>
  24. #ifdef __KERNEL__
  25. #include <linux/module.h>
  26. #include <linux/i2c-id.h>
  27. #include <linux/mod_devicetable.h>
  28. #include <linux/device.h> /* for struct device */
  29. #include <linux/sched.h> /* for completion */
  30. #include <linux/mutex.h>
  31. /* --- For i2c-isa ---------------------------------------------------- */
  32. extern void i2c_adapter_dev_release(struct device *dev);
  33. extern struct device_driver i2c_adapter_driver;
  34. extern struct class i2c_adapter_class;
  35. extern struct bus_type i2c_bus_type;
  36. /* --- General options ------------------------------------------------ */
  37. struct i2c_msg;
  38. struct i2c_algorithm;
  39. struct i2c_adapter;
  40. struct i2c_client;
  41. struct i2c_driver;
  42. union i2c_smbus_data;
  43. /*
  44. * The master routines are the ones normally used to transmit data to devices
  45. * on a bus (or read from them). Apart from two basic transfer functions to
  46. * transmit one message at a time, a more complex version can be used to
  47. * transmit an arbitrary number of messages without interruption.
  48. */
  49. extern int i2c_master_send(struct i2c_client *,const char* ,int);
  50. extern int i2c_master_recv(struct i2c_client *,char* ,int);
  51. /* Transfer num messages.
  52. */
  53. extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
  54. /* This is the very generalized SMBus access routine. You probably do not
  55. want to use this, though; one of the functions below may be much easier,
  56. and probably just as fast.
  57. Note that we use i2c_adapter here, because you do not need a specific
  58. smbus adapter to call this function. */
  59. extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  60. unsigned short flags,
  61. char read_write, u8 command, int size,
  62. union i2c_smbus_data * data);
  63. /* Now follow the 'nice' access routines. These also document the calling
  64. conventions of smbus_access. */
  65. extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  66. extern s32 i2c_smbus_read_byte(struct i2c_client * client);
  67. extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
  68. extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
  69. extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
  70. u8 command, u8 value);
  71. extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
  72. extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
  73. u8 command, u16 value);
  74. extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  75. u8 command, u8 length,
  76. const u8 *values);
  77. /* Returns the number of read bytes */
  78. extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
  79. u8 command, u8 *values);
  80. extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
  81. u8 command, u8 length,
  82. const 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. * The driver.owner field should be set to the module owner of this driver.
  89. * The driver.name field should be set to the name of this driver.
  90. */
  91. struct i2c_driver {
  92. int id;
  93. unsigned int class;
  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. /* master_xfer should return the number of messages successfully
  161. processed, or a negative value on error */
  162. int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
  163. int num);
  164. int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
  165. unsigned short flags, char read_write,
  166. u8 command, int size, union i2c_smbus_data * data);
  167. /* --- ioctl like call to set div. parameters. */
  168. int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
  169. /* To determine what the adapter supports */
  170. u32 (*functionality) (struct i2c_adapter *);
  171. };
  172. /*
  173. * i2c_adapter is the structure used to identify a physical i2c bus along
  174. * with the access algorithms necessary to access it.
  175. */
  176. struct i2c_adapter {
  177. struct module *owner;
  178. unsigned int id;
  179. unsigned int class;
  180. const struct i2c_algorithm *algo; /* the algorithm to access the bus */
  181. void *algo_data;
  182. /* --- administration stuff. */
  183. int (*client_register)(struct i2c_client *);
  184. int (*client_unregister)(struct i2c_client *);
  185. /* data fields that are valid for all devices */
  186. u8 level; /* nesting level for lockdep */
  187. struct mutex bus_lock;
  188. struct mutex 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 client struct: */
  211. #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
  212. #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
  213. /* Must equal I2C_M_TEN below */
  214. /* i2c adapter classes (bitmask) */
  215. #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
  216. #define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
  217. #define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
  218. #define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
  219. #define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
  220. #define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
  221. #define I2C_CLASS_SOUND (1<<6) /* sound devices */
  222. #define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
  223. /* i2c_client_address_data is the struct for holding default client
  224. * addresses for a driver and for the parameters supplied on the
  225. * command line
  226. */
  227. struct i2c_client_address_data {
  228. unsigned short *normal_i2c;
  229. unsigned short *probe;
  230. unsigned short *ignore;
  231. unsigned short **forces;
  232. };
  233. /* Internal numbers to terminate lists */
  234. #define I2C_CLIENT_END 0xfffeU
  235. /* The numbers to use to set I2C bus address */
  236. #define ANY_I2C_BUS 0xffff
  237. #define ANY_I2C_ISA_BUS 9191
  238. /* ----- functions exported by i2c.o */
  239. /* administration...
  240. */
  241. extern int i2c_add_adapter(struct i2c_adapter *);
  242. extern int i2c_del_adapter(struct i2c_adapter *);
  243. extern int i2c_register_driver(struct module *, struct i2c_driver *);
  244. extern int i2c_del_driver(struct i2c_driver *);
  245. static inline int i2c_add_driver(struct i2c_driver *driver)
  246. {
  247. return i2c_register_driver(THIS_MODULE, driver);
  248. }
  249. extern int i2c_attach_client(struct i2c_client *);
  250. extern int i2c_detach_client(struct i2c_client *);
  251. /* Should be used to make sure that client-struct is valid and that it
  252. is okay to access the i2c-client.
  253. returns -ENODEV if client has gone in the meantime */
  254. extern int i2c_use_client(struct i2c_client *);
  255. extern int i2c_release_client(struct i2c_client *);
  256. /* call the i2c_client->command() of all attached clients with
  257. * the given arguments */
  258. extern void i2c_clients_command(struct i2c_adapter *adap,
  259. unsigned int cmd, void *arg);
  260. /* returns -EBUSY if address has been taken, 0 if not. Note that the only
  261. other place at which this is called is within i2c_attach_client; so
  262. you can cheat by simply not registering. Not recommended, of course! */
  263. extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
  264. /* Detect function. It iterates over all possible addresses itself.
  265. * It will only call found_proc if some client is connected at the
  266. * specific address (unless a 'force' matched);
  267. */
  268. extern int i2c_probe(struct i2c_adapter *adapter,
  269. struct i2c_client_address_data *address_data,
  270. int (*found_proc) (struct i2c_adapter *, int, int));
  271. /* An ioctl like call to set div. parameters of the adapter.
  272. */
  273. extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
  274. extern struct i2c_adapter* i2c_get_adapter(int id);
  275. extern void i2c_put_adapter(struct i2c_adapter *adap);
  276. /* Return the functionality mask */
  277. static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
  278. {
  279. return adap->algo->functionality(adap);
  280. }
  281. /* Return 1 if adapter supports everything we need, 0 if not. */
  282. static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
  283. {
  284. return (func & i2c_get_functionality(adap)) == func;
  285. }
  286. /* Return id number for a specific adapter */
  287. static inline int i2c_adapter_id(struct i2c_adapter *adap)
  288. {
  289. return adap->nr;
  290. }
  291. #endif /* __KERNEL__ */
  292. /*
  293. * I2C Message - used for pure i2c transaction, also from /dev interface
  294. */
  295. struct i2c_msg {
  296. __u16 addr; /* slave address */
  297. __u16 flags;
  298. #define I2C_M_TEN 0x10 /* we have a ten bit chip address */
  299. #define I2C_M_RD 0x01
  300. #define I2C_M_NOSTART 0x4000
  301. #define I2C_M_REV_DIR_ADDR 0x2000
  302. #define I2C_M_IGNORE_NAK 0x1000
  303. #define I2C_M_NO_RD_ACK 0x0800
  304. __u16 len; /* msg length */
  305. __u8 *buf; /* pointer to msg data */
  306. };
  307. /* To determine what functionality is present */
  308. #define I2C_FUNC_I2C 0x00000001
  309. #define I2C_FUNC_10BIT_ADDR 0x00000002
  310. #define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
  311. #define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
  312. #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
  313. #define I2C_FUNC_SMBUS_QUICK 0x00010000
  314. #define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
  315. #define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
  316. #define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
  317. #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
  318. #define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
  319. #define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
  320. #define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
  321. #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
  322. #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
  323. #define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
  324. #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
  325. #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
  326. #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
  327. #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
  328. I2C_FUNC_SMBUS_WRITE_BYTE)
  329. #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
  330. I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
  331. #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
  332. I2C_FUNC_SMBUS_WRITE_WORD_DATA)
  333. #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
  334. I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
  335. #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
  336. I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
  337. #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
  338. I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
  339. #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
  340. I2C_FUNC_SMBUS_BYTE | \
  341. I2C_FUNC_SMBUS_BYTE_DATA | \
  342. I2C_FUNC_SMBUS_WORD_DATA | \
  343. I2C_FUNC_SMBUS_PROC_CALL | \
  344. I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
  345. I2C_FUNC_SMBUS_I2C_BLOCK)
  346. /*
  347. * Data for SMBus Messages
  348. */
  349. #define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
  350. union i2c_smbus_data {
  351. __u8 byte;
  352. __u16 word;
  353. __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
  354. /* and one more for user-space compatibility */
  355. };
  356. /* smbus_access read or write markers */
  357. #define I2C_SMBUS_READ 1
  358. #define I2C_SMBUS_WRITE 0
  359. /* SMBus transaction types (size parameter in the above functions)
  360. Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
  361. #define I2C_SMBUS_QUICK 0
  362. #define I2C_SMBUS_BYTE 1
  363. #define I2C_SMBUS_BYTE_DATA 2
  364. #define I2C_SMBUS_WORD_DATA 3
  365. #define I2C_SMBUS_PROC_CALL 4
  366. #define I2C_SMBUS_BLOCK_DATA 5
  367. #define I2C_SMBUS_I2C_BLOCK_DATA 6
  368. #define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
  369. /* ----- commands for the ioctl like i2c_command call:
  370. * note that additional calls are defined in the algorithm and hw
  371. * dependent layers - these can be listed here, or see the
  372. * corresponding header files.
  373. */
  374. /* -> bit-adapter specific ioctls */
  375. #define I2C_RETRIES 0x0701 /* number of times a device address */
  376. /* should be polled when not */
  377. /* acknowledging */
  378. #define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
  379. /* this is for i2c-dev.c */
  380. #define I2C_SLAVE 0x0703 /* Change slave address */
  381. /* Attn.: Slave address is 7 or 10 bits */
  382. #define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
  383. /* Attn.: Slave address is 7 or 10 bits */
  384. /* This changes the address, even if it */
  385. /* is already taken! */
  386. #define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
  387. #define I2C_FUNCS 0x0705 /* Get the adapter functionality */
  388. #define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
  389. #define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
  390. #define I2C_SMBUS 0x0720 /* SMBus-level access */
  391. /* ----- I2C-DEV: char device interface stuff ------------------------- */
  392. #ifdef __KERNEL__
  393. #define I2C_MAJOR 89 /* Device major number */
  394. /* These defines are used for probing i2c client addresses */
  395. /* The length of the option lists */
  396. #define I2C_CLIENT_MAX_OPTS 48
  397. /* Default fill of many variables */
  398. #define I2C_CLIENT_DEFAULTS {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_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  410. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  411. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  412. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  413. I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
  414. /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
  415. module header */
  416. #define I2C_CLIENT_MODULE_PARM(var,desc) \
  417. static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
  418. static unsigned int var##_num; \
  419. module_param_array(var, short, &var##_num, 0); \
  420. MODULE_PARM_DESC(var,desc)
  421. #define I2C_CLIENT_MODULE_PARM_FORCE(name) \
  422. I2C_CLIENT_MODULE_PARM(force_##name, \
  423. "List of adapter,address pairs which are " \
  424. "unquestionably assumed to contain a `" \
  425. # name "' chip")
  426. #define I2C_CLIENT_INSMOD_COMMON \
  427. I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
  428. "additionally"); \
  429. I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
  430. "scan"); \
  431. static struct i2c_client_address_data addr_data = { \
  432. .normal_i2c = normal_i2c, \
  433. .probe = probe, \
  434. .ignore = ignore, \
  435. .forces = forces, \
  436. }
  437. /* These are the ones you want to use in your own drivers. Pick the one
  438. which matches the number of devices the driver differenciates between. */
  439. #define I2C_CLIENT_INSMOD \
  440. I2C_CLIENT_MODULE_PARM(force, \
  441. "List of adapter,address pairs to boldly assume " \
  442. "to be present"); \
  443. static unsigned short *forces[] = { \
  444. force, \
  445. NULL \
  446. }; \
  447. I2C_CLIENT_INSMOD_COMMON
  448. #define I2C_CLIENT_INSMOD_1(chip1) \
  449. enum chips { any_chip, chip1 }; \
  450. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  451. "boldly assume to be present"); \
  452. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  453. static unsigned short *forces[] = { force, force_##chip1, NULL }; \
  454. I2C_CLIENT_INSMOD_COMMON
  455. #define I2C_CLIENT_INSMOD_2(chip1, chip2) \
  456. enum chips { any_chip, chip1, chip2 }; \
  457. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  458. "boldly assume to be present"); \
  459. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  460. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  461. static unsigned short *forces[] = { force, force_##chip1, \
  462. force_##chip2, NULL }; \
  463. I2C_CLIENT_INSMOD_COMMON
  464. #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
  465. enum chips { any_chip, chip1, chip2, chip3 }; \
  466. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  467. "boldly assume to be present"); \
  468. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  469. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  470. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  471. static unsigned short *forces[] = { force, force_##chip1, \
  472. force_##chip2, force_##chip3, \
  473. NULL }; \
  474. I2C_CLIENT_INSMOD_COMMON
  475. #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
  476. enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
  477. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  478. "boldly assume to be present"); \
  479. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  480. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  481. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  482. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  483. static unsigned short *forces[] = { force, force_##chip1, \
  484. force_##chip2, force_##chip3, \
  485. force_##chip4, NULL}; \
  486. I2C_CLIENT_INSMOD_COMMON
  487. #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
  488. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
  489. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  490. "boldly assume to be present"); \
  491. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  492. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  493. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  494. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  495. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  496. static unsigned short *forces[] = { force, force_##chip1, \
  497. force_##chip2, force_##chip3, \
  498. force_##chip4, force_##chip5, \
  499. NULL }; \
  500. I2C_CLIENT_INSMOD_COMMON
  501. #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
  502. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
  503. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  504. "boldly assume to be present"); \
  505. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  506. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  507. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  508. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  509. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  510. I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
  511. static unsigned short *forces[] = { force, force_##chip1, \
  512. force_##chip2, force_##chip3, \
  513. force_##chip4, force_##chip5, \
  514. force_##chip6, NULL }; \
  515. I2C_CLIENT_INSMOD_COMMON
  516. #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
  517. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
  518. chip7 }; \
  519. I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
  520. "boldly assume to be present"); \
  521. I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
  522. I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
  523. I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
  524. I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
  525. I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
  526. I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
  527. I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
  528. static unsigned short *forces[] = { force, force_##chip1, \
  529. force_##chip2, force_##chip3, \
  530. force_##chip4, force_##chip5, \
  531. force_##chip6, force_##chip7, \
  532. NULL }; \
  533. I2C_CLIENT_INSMOD_COMMON
  534. #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
  535. enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
  536. chip7, chip8 }; \
  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. I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
  547. static unsigned short *forces[] = { force, force_##chip1, \
  548. force_##chip2, force_##chip3, \
  549. force_##chip4, force_##chip5, \
  550. force_##chip6, force_##chip7, \
  551. force_##chip8, NULL }; \
  552. I2C_CLIENT_INSMOD_COMMON
  553. #endif /* __KERNEL__ */
  554. #endif /* _LINUX_I2C_H */