i2c.h 25 KB

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