i2c.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  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., 51 Franklin Street, Fifth Floor, Boston,
  18. MA 02110-1301 USA. */
  19. /* ------------------------------------------------------------------------- */
  20. /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
  21. Frodo Looijaard <frodol@dds.nl> */
  22. #ifndef _LINUX_I2C_H
  23. #define _LINUX_I2C_H
  24. #include <linux/mod_devicetable.h>
  25. #include <linux/device.h> /* for struct device */
  26. #include <linux/sched.h> /* for completion */
  27. #include <linux/mutex.h>
  28. #include <linux/of.h> /* for struct device_node */
  29. #include <linux/swab.h> /* for swab16 */
  30. #include <uapi/linux/i2c.h>
  31. extern struct bus_type i2c_bus_type;
  32. extern struct device_type i2c_adapter_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. struct i2c_board_info;
  41. enum i2c_slave_event;
  42. typedef int (*i2c_slave_cb_t)(struct i2c_client *, enum i2c_slave_event, u8 *);
  43. struct module;
  44. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  45. /*
  46. * The master routines are the ones normally used to transmit data to devices
  47. * on a bus (or read from them). Apart from two basic transfer functions to
  48. * transmit one message at a time, a more complex version can be used to
  49. * transmit an arbitrary number of messages without interruption.
  50. * @count must be be less than 64k since msg.len is u16.
  51. */
  52. extern int i2c_master_send(const struct i2c_client *client, const char *buf,
  53. int count);
  54. extern int i2c_master_recv(const struct i2c_client *client, char *buf,
  55. int count);
  56. /* Transfer num messages.
  57. */
  58. extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
  59. int num);
  60. /* Unlocked flavor */
  61. extern int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
  62. int num);
  63. /* This is the very generalized SMBus access routine. You probably do not
  64. want to use this, though; one of the functions below may be much easier,
  65. and probably just as fast.
  66. Note that we use i2c_adapter here, because you do not need a specific
  67. smbus adapter to call this function. */
  68. extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
  69. unsigned short flags, char read_write, u8 command,
  70. int size, union i2c_smbus_data *data);
  71. /* Now follow the 'nice' access routines. These also document the calling
  72. conventions of i2c_smbus_xfer. */
  73. extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
  74. extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
  75. extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
  76. u8 command);
  77. extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
  78. u8 command, u8 value);
  79. extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
  80. u8 command);
  81. extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
  82. u8 command, u16 value);
  83. static inline s32
  84. i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
  85. {
  86. s32 value = i2c_smbus_read_word_data(client, command);
  87. return (value < 0) ? value : swab16(value);
  88. }
  89. static inline s32
  90. i2c_smbus_write_word_swapped(const struct i2c_client *client,
  91. u8 command, u16 value)
  92. {
  93. return i2c_smbus_write_word_data(client, command, swab16(value));
  94. }
  95. /* Returns the number of read bytes */
  96. extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
  97. u8 command, u8 *values);
  98. extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
  99. u8 command, u8 length, const u8 *values);
  100. /* Returns the number of read bytes */
  101. extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
  102. u8 command, u8 length, u8 *values);
  103. extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
  104. u8 command, u8 length,
  105. const u8 *values);
  106. #endif /* I2C */
  107. /**
  108. * struct i2c_driver - represent an I2C device driver
  109. * @class: What kind of i2c device we instantiate (for detect)
  110. * @attach_adapter: Callback for bus addition (deprecated)
  111. * @probe: Callback for device binding
  112. * @remove: Callback for device unbinding
  113. * @shutdown: Callback for device shutdown
  114. * @alert: Alert callback, for example for the SMBus alert protocol
  115. * @command: Callback for bus-wide signaling (optional)
  116. * @driver: Device driver model driver
  117. * @id_table: List of I2C devices supported by this driver
  118. * @detect: Callback for device detection
  119. * @address_list: The I2C addresses to probe (for detect)
  120. * @clients: List of detected clients we created (for i2c-core use only)
  121. *
  122. * The driver.owner field should be set to the module owner of this driver.
  123. * The driver.name field should be set to the name of this driver.
  124. *
  125. * For automatic device detection, both @detect and @address_list must
  126. * be defined. @class should also be set, otherwise only devices forced
  127. * with module parameters will be created. The detect function must
  128. * fill at least the name field of the i2c_board_info structure it is
  129. * handed upon successful detection, and possibly also the flags field.
  130. *
  131. * If @detect is missing, the driver will still work fine for enumerated
  132. * devices. Detected devices simply won't be supported. This is expected
  133. * for the many I2C/SMBus devices which can't be detected reliably, and
  134. * the ones which can always be enumerated in practice.
  135. *
  136. * The i2c_client structure which is handed to the @detect callback is
  137. * not a real i2c_client. It is initialized just enough so that you can
  138. * call i2c_smbus_read_byte_data and friends on it. Don't do anything
  139. * else with it. In particular, calling dev_dbg and friends on it is
  140. * not allowed.
  141. */
  142. struct i2c_driver {
  143. unsigned int class;
  144. /* Notifies the driver that a new bus has appeared. You should avoid
  145. * using this, it will be removed in a near future.
  146. */
  147. int (*attach_adapter)(struct i2c_adapter *) __deprecated;
  148. /* Standard driver model interfaces */
  149. int (*probe)(struct i2c_client *, const struct i2c_device_id *);
  150. int (*remove)(struct i2c_client *);
  151. /* driver model interfaces that don't relate to enumeration */
  152. void (*shutdown)(struct i2c_client *);
  153. /* Alert callback, for example for the SMBus alert protocol.
  154. * The format and meaning of the data value depends on the protocol.
  155. * For the SMBus alert protocol, there is a single bit of data passed
  156. * as the alert response's low bit ("event flag").
  157. */
  158. void (*alert)(struct i2c_client *, unsigned int data);
  159. /* a ioctl like command that can be used to perform specific functions
  160. * with the device.
  161. */
  162. int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
  163. struct device_driver driver;
  164. const struct i2c_device_id *id_table;
  165. /* Device detection callback for automatic device creation */
  166. int (*detect)(struct i2c_client *, struct i2c_board_info *);
  167. const unsigned short *address_list;
  168. struct list_head clients;
  169. };
  170. #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
  171. /**
  172. * struct i2c_client - represent an I2C slave device
  173. * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
  174. * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
  175. * @addr: Address used on the I2C bus connected to the parent adapter.
  176. * @name: Indicates the type of the device, usually a chip name that's
  177. * generic enough to hide second-sourcing and compatible revisions.
  178. * @adapter: manages the bus segment hosting this I2C device
  179. * @dev: Driver model device node for the slave.
  180. * @irq: indicates the IRQ generated by this device (if any)
  181. * @detected: member of an i2c_driver.clients list or i2c-core's
  182. * userspace_devices list
  183. * @slave_cb: Callback when I2C slave mode of an adapter is used. The adapter
  184. * calls it to pass on slave events to the slave driver.
  185. *
  186. * An i2c_client identifies a single device (i.e. chip) connected to an
  187. * i2c bus. The behaviour exposed to Linux is defined by the driver
  188. * managing the device.
  189. */
  190. struct i2c_client {
  191. unsigned short flags; /* div., see below */
  192. unsigned short addr; /* chip address - NOTE: 7bit */
  193. /* addresses are stored in the */
  194. /* _LOWER_ 7 bits */
  195. char name[I2C_NAME_SIZE];
  196. struct i2c_adapter *adapter; /* the adapter we sit on */
  197. struct device dev; /* the device structure */
  198. int irq; /* irq issued by device */
  199. struct list_head detected;
  200. #if IS_ENABLED(CONFIG_I2C_SLAVE)
  201. i2c_slave_cb_t slave_cb; /* callback for slave mode */
  202. #endif
  203. };
  204. #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
  205. extern struct i2c_client *i2c_verify_client(struct device *dev);
  206. extern struct i2c_adapter *i2c_verify_adapter(struct device *dev);
  207. static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
  208. {
  209. struct device * const dev = container_of(kobj, struct device, kobj);
  210. return to_i2c_client(dev);
  211. }
  212. static inline void *i2c_get_clientdata(const struct i2c_client *dev)
  213. {
  214. return dev_get_drvdata(&dev->dev);
  215. }
  216. static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
  217. {
  218. dev_set_drvdata(&dev->dev, data);
  219. }
  220. /* I2C slave support */
  221. #if IS_ENABLED(CONFIG_I2C_SLAVE)
  222. enum i2c_slave_event {
  223. I2C_SLAVE_READ_REQUESTED,
  224. I2C_SLAVE_WRITE_REQUESTED,
  225. I2C_SLAVE_READ_PROCESSED,
  226. I2C_SLAVE_WRITE_RECEIVED,
  227. I2C_SLAVE_STOP,
  228. };
  229. extern int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb);
  230. extern int i2c_slave_unregister(struct i2c_client *client);
  231. static inline int i2c_slave_event(struct i2c_client *client,
  232. enum i2c_slave_event event, u8 *val)
  233. {
  234. return client->slave_cb(client, event, val);
  235. }
  236. #endif
  237. /**
  238. * struct i2c_board_info - template for device creation
  239. * @type: chip type, to initialize i2c_client.name
  240. * @flags: to initialize i2c_client.flags
  241. * @addr: stored in i2c_client.addr
  242. * @platform_data: stored in i2c_client.dev.platform_data
  243. * @archdata: copied into i2c_client.dev.archdata
  244. * @of_node: pointer to OpenFirmware device node
  245. * @acpi_node: ACPI device node
  246. * @irq: stored in i2c_client.irq
  247. *
  248. * I2C doesn't actually support hardware probing, although controllers and
  249. * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
  250. * a device at a given address. Drivers commonly need more information than
  251. * that, such as chip type, configuration, associated IRQ, and so on.
  252. *
  253. * i2c_board_info is used to build tables of information listing I2C devices
  254. * that are present. This information is used to grow the driver model tree.
  255. * For mainboards this is done statically using i2c_register_board_info();
  256. * bus numbers identify adapters that aren't yet available. For add-on boards,
  257. * i2c_new_device() does this dynamically with the adapter already known.
  258. */
  259. struct i2c_board_info {
  260. char type[I2C_NAME_SIZE];
  261. unsigned short flags;
  262. unsigned short addr;
  263. void *platform_data;
  264. struct dev_archdata *archdata;
  265. struct device_node *of_node;
  266. struct acpi_dev_node acpi_node;
  267. int irq;
  268. };
  269. /**
  270. * I2C_BOARD_INFO - macro used to list an i2c device and its address
  271. * @dev_type: identifies the device type
  272. * @dev_addr: the device's address on the bus.
  273. *
  274. * This macro initializes essential fields of a struct i2c_board_info,
  275. * declaring what has been provided on a particular board. Optional
  276. * fields (such as associated irq, or device-specific platform_data)
  277. * are provided using conventional syntax.
  278. */
  279. #define I2C_BOARD_INFO(dev_type, dev_addr) \
  280. .type = dev_type, .addr = (dev_addr)
  281. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  282. /* Add-on boards should register/unregister their devices; e.g. a board
  283. * with integrated I2C, a config eeprom, sensors, and a codec that's
  284. * used in conjunction with the primary hardware.
  285. */
  286. extern struct i2c_client *
  287. i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
  288. /* If you don't know the exact address of an I2C device, use this variant
  289. * instead, which can probe for device presence in a list of possible
  290. * addresses. The "probe" callback function is optional. If it is provided,
  291. * it must return 1 on successful probe, 0 otherwise. If it is not provided,
  292. * a default probing method is used.
  293. */
  294. extern struct i2c_client *
  295. i2c_new_probed_device(struct i2c_adapter *adap,
  296. struct i2c_board_info *info,
  297. unsigned short const *addr_list,
  298. int (*probe)(struct i2c_adapter *, unsigned short addr));
  299. /* Common custom probe functions */
  300. extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
  301. /* For devices that use several addresses, use i2c_new_dummy() to make
  302. * client handles for the extra addresses.
  303. */
  304. extern struct i2c_client *
  305. i2c_new_dummy(struct i2c_adapter *adap, u16 address);
  306. extern void i2c_unregister_device(struct i2c_client *);
  307. #endif /* I2C */
  308. /* Mainboard arch_initcall() code should register all its I2C devices.
  309. * This is done at arch_initcall time, before declaring any i2c adapters.
  310. * Modules for add-on boards must use other calls.
  311. */
  312. #ifdef CONFIG_I2C_BOARDINFO
  313. extern int
  314. i2c_register_board_info(int busnum, struct i2c_board_info const *info,
  315. unsigned n);
  316. #else
  317. static inline int
  318. i2c_register_board_info(int busnum, struct i2c_board_info const *info,
  319. unsigned n)
  320. {
  321. return 0;
  322. }
  323. #endif /* I2C_BOARDINFO */
  324. /**
  325. * struct i2c_algorithm - represent I2C transfer method
  326. * @master_xfer: Issue a set of i2c transactions to the given I2C adapter
  327. * defined by the msgs array, with num messages available to transfer via
  328. * the adapter specified by adap.
  329. * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this
  330. * is not present, then the bus layer will try and convert the SMBus calls
  331. * into I2C transfers instead.
  332. * @functionality: Return the flags that this algorithm/adapter pair supports
  333. * from the I2C_FUNC_* flags.
  334. * @reg_slave: Register given client to I2C slave mode of this adapter
  335. * @unreg_slave: Unregister given client from I2C slave mode of this adapter
  336. *
  337. * The following structs are for those who like to implement new bus drivers:
  338. * i2c_algorithm is the interface to a class of hardware solutions which can
  339. * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
  340. * to name two of the most common.
  341. *
  342. * The return codes from the @master_xfer field should indicate the type of
  343. * error code that occurred during the transfer, as documented in the kernel
  344. * Documentation file Documentation/i2c/fault-codes.
  345. */
  346. struct i2c_algorithm {
  347. /* If an adapter algorithm can't do I2C-level access, set master_xfer
  348. to NULL. If an adapter algorithm can do SMBus access, set
  349. smbus_xfer. If set to NULL, the SMBus protocol is simulated
  350. using common I2C messages */
  351. /* master_xfer should return the number of messages successfully
  352. processed, or a negative value on error */
  353. int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
  354. int num);
  355. int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
  356. unsigned short flags, char read_write,
  357. u8 command, int size, union i2c_smbus_data *data);
  358. /* To determine what the adapter supports */
  359. u32 (*functionality) (struct i2c_adapter *);
  360. #if IS_ENABLED(CONFIG_I2C_SLAVE)
  361. int (*reg_slave)(struct i2c_client *client);
  362. int (*unreg_slave)(struct i2c_client *client);
  363. #endif
  364. };
  365. /**
  366. * struct i2c_bus_recovery_info - I2C bus recovery information
  367. * @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or
  368. * i2c_generic_scl_recovery() or i2c_generic_gpio_recovery().
  369. * @get_scl: This gets current value of SCL line. Mandatory for generic SCL
  370. * recovery. Used internally for generic GPIO recovery.
  371. * @set_scl: This sets/clears SCL line. Mandatory for generic SCL recovery. Used
  372. * internally for generic GPIO recovery.
  373. * @get_sda: This gets current value of SDA line. Optional for generic SCL
  374. * recovery. Used internally, if sda_gpio is a valid GPIO, for generic GPIO
  375. * recovery.
  376. * @prepare_recovery: This will be called before starting recovery. Platform may
  377. * configure padmux here for SDA/SCL line or something else they want.
  378. * @unprepare_recovery: This will be called after completing recovery. Platform
  379. * may configure padmux here for SDA/SCL line or something else they want.
  380. * @scl_gpio: gpio number of the SCL line. Only required for GPIO recovery.
  381. * @sda_gpio: gpio number of the SDA line. Only required for GPIO recovery.
  382. */
  383. struct i2c_bus_recovery_info {
  384. int (*recover_bus)(struct i2c_adapter *);
  385. int (*get_scl)(struct i2c_adapter *);
  386. void (*set_scl)(struct i2c_adapter *, int val);
  387. int (*get_sda)(struct i2c_adapter *);
  388. void (*prepare_recovery)(struct i2c_adapter *);
  389. void (*unprepare_recovery)(struct i2c_adapter *);
  390. /* gpio recovery */
  391. int scl_gpio;
  392. int sda_gpio;
  393. };
  394. int i2c_recover_bus(struct i2c_adapter *adap);
  395. /* Generic recovery routines */
  396. int i2c_generic_gpio_recovery(struct i2c_adapter *adap);
  397. int i2c_generic_scl_recovery(struct i2c_adapter *adap);
  398. /**
  399. * struct i2c_adapter_quirks - describe flaws of an i2c adapter
  400. * @flags: see I2C_AQ_* for possible flags and read below
  401. * @max_num_msgs: maximum number of messages per transfer
  402. * @max_write_len: maximum length of a write message
  403. * @max_read_len: maximum length of a read message
  404. * @max_comb_1st_msg_len: maximum length of the first msg in a combined message
  405. * @max_comb_2nd_msg_len: maximum length of the second msg in a combined message
  406. *
  407. * Note about combined messages: Some I2C controllers can only send one message
  408. * per transfer, plus something called combined message or write-then-read.
  409. * This is (usually) a small write message followed by a read message and
  410. * barely enough to access register based devices like EEPROMs. There is a flag
  411. * to support this mode. It implies max_num_msg = 2 and does the length checks
  412. * with max_comb_*_len because combined message mode usually has its own
  413. * limitations. Because of HW implementations, some controllers can actually do
  414. * write-then-anything or other variants. To support that, write-then-read has
  415. * been broken out into smaller bits like write-first and read-second which can
  416. * be combined as needed.
  417. */
  418. struct i2c_adapter_quirks {
  419. u64 flags;
  420. int max_num_msgs;
  421. u16 max_write_len;
  422. u16 max_read_len;
  423. u16 max_comb_1st_msg_len;
  424. u16 max_comb_2nd_msg_len;
  425. };
  426. /* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */
  427. #define I2C_AQ_COMB BIT(0)
  428. /* first combined message must be write */
  429. #define I2C_AQ_COMB_WRITE_FIRST BIT(1)
  430. /* second combined message must be read */
  431. #define I2C_AQ_COMB_READ_SECOND BIT(2)
  432. /* both combined messages must have the same target address */
  433. #define I2C_AQ_COMB_SAME_ADDR BIT(3)
  434. /* convenience macro for typical write-then read case */
  435. #define I2C_AQ_COMB_WRITE_THEN_READ (I2C_AQ_COMB | I2C_AQ_COMB_WRITE_FIRST | \
  436. I2C_AQ_COMB_READ_SECOND | I2C_AQ_COMB_SAME_ADDR)
  437. /*
  438. * i2c_adapter is the structure used to identify a physical i2c bus along
  439. * with the access algorithms necessary to access it.
  440. */
  441. struct i2c_adapter {
  442. struct module *owner;
  443. unsigned int class; /* classes to allow probing for */
  444. const struct i2c_algorithm *algo; /* the algorithm to access the bus */
  445. void *algo_data;
  446. /* data fields that are valid for all devices */
  447. struct rt_mutex bus_lock;
  448. int timeout; /* in jiffies */
  449. int retries;
  450. struct device dev; /* the adapter device */
  451. int nr;
  452. char name[48];
  453. struct completion dev_released;
  454. struct mutex userspace_clients_lock;
  455. struct list_head userspace_clients;
  456. struct i2c_bus_recovery_info *bus_recovery_info;
  457. const struct i2c_adapter_quirks *quirks;
  458. };
  459. #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
  460. static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
  461. {
  462. return dev_get_drvdata(&dev->dev);
  463. }
  464. static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
  465. {
  466. dev_set_drvdata(&dev->dev, data);
  467. }
  468. static inline struct i2c_adapter *
  469. i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
  470. {
  471. #if IS_ENABLED(CONFIG_I2C_MUX)
  472. struct device *parent = adapter->dev.parent;
  473. if (parent != NULL && parent->type == &i2c_adapter_type)
  474. return to_i2c_adapter(parent);
  475. else
  476. #endif
  477. return NULL;
  478. }
  479. int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));
  480. /* Adapter locking functions, exported for shared pin cases */
  481. void i2c_lock_adapter(struct i2c_adapter *);
  482. void i2c_unlock_adapter(struct i2c_adapter *);
  483. /*flags for the client struct: */
  484. #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
  485. #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
  486. /* Must equal I2C_M_TEN below */
  487. #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
  488. #define I2C_CLIENT_SCCB 0x9000 /* Use Omnivision SCCB protocol */
  489. /* Must match I2C_M_STOP|IGNORE_NAK */
  490. /* i2c adapter classes (bitmask) */
  491. #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
  492. #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
  493. #define I2C_CLASS_SPD (1<<7) /* Memory modules */
  494. #define I2C_CLASS_DEPRECATED (1<<8) /* Warn users that adapter will stop using classes */
  495. /* Internal numbers to terminate lists */
  496. #define I2C_CLIENT_END 0xfffeU
  497. /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
  498. #define I2C_ADDRS(addr, addrs...) \
  499. ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
  500. /* ----- functions exported by i2c.o */
  501. /* administration...
  502. */
  503. #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  504. extern int i2c_add_adapter(struct i2c_adapter *);
  505. extern void i2c_del_adapter(struct i2c_adapter *);
  506. extern int i2c_add_numbered_adapter(struct i2c_adapter *);
  507. extern int i2c_register_driver(struct module *, struct i2c_driver *);
  508. extern void i2c_del_driver(struct i2c_driver *);
  509. /* use a define to avoid include chaining to get THIS_MODULE */
  510. #define i2c_add_driver(driver) \
  511. i2c_register_driver(THIS_MODULE, driver)
  512. extern struct i2c_client *i2c_use_client(struct i2c_client *client);
  513. extern void i2c_release_client(struct i2c_client *client);
  514. /* call the i2c_client->command() of all attached clients with
  515. * the given arguments */
  516. extern void i2c_clients_command(struct i2c_adapter *adap,
  517. unsigned int cmd, void *arg);
  518. extern struct i2c_adapter *i2c_get_adapter(int nr);
  519. extern void i2c_put_adapter(struct i2c_adapter *adap);
  520. /* Return the functionality mask */
  521. static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
  522. {
  523. return adap->algo->functionality(adap);
  524. }
  525. /* Return 1 if adapter supports everything we need, 0 if not. */
  526. static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
  527. {
  528. return (func & i2c_get_functionality(adap)) == func;
  529. }
  530. /* Return the adapter number for a specific adapter */
  531. static inline int i2c_adapter_id(struct i2c_adapter *adap)
  532. {
  533. return adap->nr;
  534. }
  535. /**
  536. * module_i2c_driver() - Helper macro for registering a I2C driver
  537. * @__i2c_driver: i2c_driver struct
  538. *
  539. * Helper macro for I2C drivers which do not do anything special in module
  540. * init/exit. This eliminates a lot of boilerplate. Each module may only
  541. * use this macro once, and calling it replaces module_init() and module_exit()
  542. */
  543. #define module_i2c_driver(__i2c_driver) \
  544. module_driver(__i2c_driver, i2c_add_driver, \
  545. i2c_del_driver)
  546. #endif /* I2C */
  547. #if IS_ENABLED(CONFIG_OF)
  548. /* must call put_device() when done with returned i2c_client device */
  549. extern struct i2c_client *of_find_i2c_device_by_node(struct device_node *node);
  550. /* must call put_device() when done with returned i2c_adapter device */
  551. extern struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node);
  552. #else
  553. static inline struct i2c_client *of_find_i2c_device_by_node(struct device_node *node)
  554. {
  555. return NULL;
  556. }
  557. static inline struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node)
  558. {
  559. return NULL;
  560. }
  561. #endif /* CONFIG_OF */
  562. #endif /* _LINUX_I2C_H */