include/linux/i2c.h

   1 /* ------------------------------------------------------------------------- */
   2 /*                                                                           */
   3 /* i2c.h - definitions for the i2c-bus interface                             */
   4 /*                                                                           */
   5 /* ------------------------------------------------------------------------- */
   6 /*   Copyright (C) 1995-2000 Simon G. Vogl
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU General Public License as published by
  10     the Free Software Foundation; either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with this program; if not, write to the Free Software
  20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  21     MA 02110-1301 USA.                                                       */
  22 /* ------------------------------------------------------------------------- */
  23
  24 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
  25    Frodo Looijaard <frodol@dds.nl> */
  26 #ifndef _LINUX_I2C_H
  27 #define _LINUX_I2C_H
  28
  29 #include <linux/mod_devicetable.h>
  30 #include <linux/device.h>       /* for struct device */
  31 #include <linux/sched.h>        /* for completion */
  32 #include <linux/mutex.h>
  33 #include <linux/of.h>           /* for struct device_node */
  34 #include <linux/swab.h>         /* for swab16 */
  35 #include <uapi/linux/i2c.h>
  36
  37 extern struct bus_type i2c_bus_type;
  38 extern struct device_type i2c_adapter_type;
  39
  40 /* --- General options ------------------------------------------------ */
  41
  42 struct i2c_msg;
  43 struct i2c_algorithm;
  44 struct i2c_adapter;
  45 struct i2c_client;
  46 struct i2c_driver;
  47 union i2c_smbus_data;
  48 struct i2c_board_info;
  49 enum i2c_slave_event;
  50 typedef int (*i2c_slave_cb_t)(struct i2c_client *, enum i2c_slave_event, u8 *);
  51
  52 struct module;
  53
  54 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
  55 /*
  56  * The master routines are the ones normally used to transmit data to devices
  57  * on a bus (or read from them). Apart from two basic transfer functions to
  58  * transmit one message at a time, a more complex version can be used to
  59  * transmit an arbitrary number of messages without interruption.
  60  * @count must be be less than 64k since msg.len is u16.
  61  */
  62 extern int i2c_master_send(const struct i2c_client *client, const char *buf,
  63                            int count);
  64 extern int i2c_master_recv(const struct i2c_client *client, char *buf,
  65                            int count);
  66
  67 /* Transfer num messages.
  68  */
  69 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
  70                         int num);
  71 /* Unlocked flavor */
  72 extern int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
  73                           int num);
  74
  75 /* This is the very generalized SMBus access routine. You probably do not
  76    want to use this, though; one of the functions below may be much easier,
  77    and probably just as fast.
  78    Note that we use i2c_adapter here, because you do not need a specific
  79    smbus adapter to call this function. */
  80 extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
  81                           unsigned short flags, char read_write, u8 command,
  82                           int size, union i2c_smbus_data *data);
  83
  84 /* Now follow the 'nice' access routines. These also document the calling
  85    conventions of i2c_smbus_xfer. */
  86
  87 extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
  88 extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
  89 extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
  90                                     u8 command);
  91 extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
  92                                      u8 command, u8 value);
  93 extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
  94                                     u8 command);
  95 extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
  96                                      u8 command, u16 value);
  97
  98 static inline s32
  99 i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
 100 {
 101         s32 value = i2c_smbus_read_word_data(client, command);
 102
 103         return (value < 0) ? value : swab16(value);
 104 }
 105
 106 static inline s32
 107 i2c_smbus_write_word_swapped(const struct i2c_client *client,
 108                              u8 command, u16 value)
 109 {
 110         return i2c_smbus_write_word_data(client, command, swab16(value));
 111 }
 112
 113 /* Returns the number of read bytes */
 114 extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
 115                                      u8 command, u8 *values);
 116 extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
 117                                       u8 command, u8 length, const u8 *values);
 118 /* Returns the number of read bytes */
 119 extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
 120                                          u8 command, u8 length, u8 *values);
 121 extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
 122                                           u8 command, u8 length,
 123                                           const u8 *values);
 124 extern s32
 125 i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client,
 126                                           u8 command, u8 length, u8 *values);
 127 #endif /* I2C */
 128
 129 enum i2c_alert_protocol {
 130         I2C_PROTOCOL_SMBUS_ALERT,
 131         I2C_PROTOCOL_SMBUS_HOST_NOTIFY,
 132 };
 133
 134 /**
 135  * struct i2c_driver - represent an I2C device driver
 136  * @class: What kind of i2c device we instantiate (for detect)
 137  * @attach_adapter: Callback for bus addition (deprecated)
 138  * @probe: Callback for device binding
 139  * @remove: Callback for device unbinding
 140  * @shutdown: Callback for device shutdown
 141  * @alert: Alert callback, for example for the SMBus alert protocol
 142  * @command: Callback for bus-wide signaling (optional)
 143  * @driver: Device driver model driver
 144  * @id_table: List of I2C devices supported by this driver
 145  * @detect: Callback for device detection
 146  * @address_list: The I2C addresses to probe (for detect)
 147  * @clients: List of detected clients we created (for i2c-core use only)
 148  *
 149  * The driver.owner field should be set to the module owner of this driver.
 150  * The driver.name field should be set to the name of this driver.
 151  *
 152  * For automatic device detection, both @detect and @address_list must
 153  * be defined. @class should also be set, otherwise only devices forced
 154  * with module parameters will be created. The detect function must
 155  * fill at least the name field of the i2c_board_info structure it is
 156  * handed upon successful detection, and possibly also the flags field.
 157  *
 158  * If @detect is missing, the driver will still work fine for enumerated
 159  * devices. Detected devices simply won't be supported. This is expected
 160  * for the many I2C/SMBus devices which can't be detected reliably, and
 161  * the ones which can always be enumerated in practice.
 162  *
 163  * The i2c_client structure which is handed to the @detect callback is
 164  * not a real i2c_client. It is initialized just enough so that you can
 165  * call i2c_smbus_read_byte_data and friends on it. Don't do anything
 166  * else with it. In particular, calling dev_dbg and friends on it is
 167  * not allowed.
 168  */
 169 struct i2c_driver {
 170         unsigned int class;
 171
 172         /* Notifies the driver that a new bus has appeared. You should avoid
 173          * using this, it will be removed in a near future.
 174          */
 175         int (*attach_adapter)(struct i2c_adapter *) __deprecated;
 176
 177         /* Standard driver model interfaces */
 178         int (*probe)(struct i2c_client *, const struct i2c_device_id *);
 179         int (*remove)(struct i2c_client *);
 180
 181         /* driver model interfaces that don't relate to enumeration  */
 182         void (*shutdown)(struct i2c_client *);
 183
 184         /* Alert callback, for example for the SMBus alert protocol.
 185          * The format and meaning of the data value depends on the protocol.
 186          * For the SMBus alert protocol, there is a single bit of data passed
 187          * as the alert response's low bit ("event flag").
 188          * For the SMBus Host Notify protocol, the data corresponds to the
 189          * 16-bit payload data reported by the slave device acting as master.
 190          */
 191         void (*alert)(struct i2c_client *, enum i2c_alert_protocol protocol,
 192                       unsigned int data);
 193
 194         /* a ioctl like command that can be used to perform specific functions
 195          * with the device.
 196          */
 197         int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
 198
 199         struct device_driver driver;
 200         const struct i2c_device_id *id_table;
 201
 202         /* Device detection callback for automatic device creation */
 203         int (*detect)(struct i2c_client *, struct i2c_board_info *);
 204         const unsigned short *address_list;
 205         struct list_head clients;
 206 };
 207 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
 208
 209 /**
 210  * struct i2c_client - represent an I2C slave device
 211  * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
 212  *      I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
 213  * @addr: Address used on the I2C bus connected to the parent adapter.
 214  * @name: Indicates the type of the device, usually a chip name that's
 215  *      generic enough to hide second-sourcing and compatible revisions.
 216  * @adapter: manages the bus segment hosting this I2C device
 217  * @dev: Driver model device node for the slave.
 218  * @irq: indicates the IRQ generated by this device (if any)
 219  * @detected: member of an i2c_driver.clients list or i2c-core's
 220  *      userspace_devices list
 221  * @slave_cb: Callback when I2C slave mode of an adapter is used. The adapter
 222  *      calls it to pass on slave events to the slave driver.
 223  *
 224  * An i2c_client identifies a single device (i.e. chip) connected to an
 225  * i2c bus. The behaviour exposed to Linux is defined by the driver
 226  * managing the device.
 227  */
 228 struct i2c_client {
 229         unsigned short flags;           /* div., see below              */
 230         unsigned short addr;            /* chip address - NOTE: 7bit    */
 231                                         /* addresses are stored in the  */
 232                                         /* _LOWER_ 7 bits               */
 233         char name[I2C_NAME_SIZE];
 234         struct i2c_adapter *adapter;    /* the adapter we sit on        */
 235         struct device dev;              /* the device structure         */
 236         int irq;                        /* irq issued by device         */
 237         struct list_head detected;
 238 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 239         i2c_slave_cb_t slave_cb;        /* callback for slave mode      */
 240 #endif
 241 };
 242 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
 243
 244 extern struct i2c_client *i2c_verify_client(struct device *dev);
 245 extern struct i2c_adapter *i2c_verify_adapter(struct device *dev);
 246 extern const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
 247                                         const struct i2c_client *client);
 248
 249 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
 250 {
 251         struct device * const dev = container_of(kobj, struct device, kobj);
 252         return to_i2c_client(dev);
 253 }
 254
 255 static inline void *i2c_get_clientdata(const struct i2c_client *dev)
 256 {
 257         return dev_get_drvdata(&dev->dev);
 258 }
 259
 260 static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
 261 {
 262         dev_set_drvdata(&dev->dev, data);
 263 }
 264
 265 /* I2C slave support */
 266
 267 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 268 enum i2c_slave_event {
 269         I2C_SLAVE_READ_REQUESTED,
 270         I2C_SLAVE_WRITE_REQUESTED,
 271         I2C_SLAVE_READ_PROCESSED,
 272         I2C_SLAVE_WRITE_RECEIVED,
 273         I2C_SLAVE_STOP,
 274 };
 275
 276 extern int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb);
 277 extern int i2c_slave_unregister(struct i2c_client *client);
 278
 279 static inline int i2c_slave_event(struct i2c_client *client,
 280                                   enum i2c_slave_event event, u8 *val)
 281 {
 282         return client->slave_cb(client, event, val);
 283 }
 284 #endif
 285
 286 /**
 287  * struct i2c_board_info - template for device creation
 288  * @type: chip type, to initialize i2c_client.name
 289  * @flags: to initialize i2c_client.flags
 290  * @addr: stored in i2c_client.addr
 291  * @platform_data: stored in i2c_client.dev.platform_data
 292  * @archdata: copied into i2c_client.dev.archdata
 293  * @of_node: pointer to OpenFirmware device node
 294  * @fwnode: device node supplied by the platform firmware
 295  * @irq: stored in i2c_client.irq
 296  *
 297  * I2C doesn't actually support hardware probing, although controllers and
 298  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
 299  * a device at a given address.  Drivers commonly need more information than
 300  * that, such as chip type, configuration, associated IRQ, and so on.
 301  *
 302  * i2c_board_info is used to build tables of information listing I2C devices
 303  * that are present.  This information is used to grow the driver model tree.
 304  * For mainboards this is done statically using i2c_register_board_info();
 305  * bus numbers identify adapters that aren't yet available.  For add-on boards,
 306  * i2c_new_device() does this dynamically with the adapter already known.
 307  */
 308 struct i2c_board_info {
 309         char            type[I2C_NAME_SIZE];
 310         unsigned short  flags;
 311         unsigned short  addr;
 312         void            *platform_data;
 313         struct dev_archdata     *archdata;
 314         struct device_node *of_node;
 315         struct fwnode_handle *fwnode;
 316         int             irq;
 317 };
 318
 319 /**
 320  * I2C_BOARD_INFO - macro used to list an i2c device and its address
 321  * @dev_type: identifies the device type
 322  * @dev_addr: the device's address on the bus.
 323  *
 324  * This macro initializes essential fields of a struct i2c_board_info,
 325  * declaring what has been provided on a particular board.  Optional
 326  * fields (such as associated irq, or device-specific platform_data)
 327  * are provided using conventional syntax.
 328  */
 329 #define I2C_BOARD_INFO(dev_type, dev_addr) \
 330         .type = dev_type, .addr = (dev_addr)
 331
 332
 333 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 334 /* Add-on boards should register/unregister their devices; e.g. a board
 335  * with integrated I2C, a config eeprom, sensors, and a codec that's
 336  * used in conjunction with the primary hardware.
 337  */
 338 extern struct i2c_client *
 339 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
 340
 341 /* If you don't know the exact address of an I2C device, use this variant
 342  * instead, which can probe for device presence in a list of possible
 343  * addresses. The "probe" callback function is optional. If it is provided,
 344  * it must return 1 on successful probe, 0 otherwise. If it is not provided,
 345  * a default probing method is used.
 346  */
 347 extern struct i2c_client *
 348 i2c_new_probed_device(struct i2c_adapter *adap,
 349                       struct i2c_board_info *info,
 350                       unsigned short const *addr_list,
 351                       int (*probe)(struct i2c_adapter *, unsigned short addr));
 352
 353 /* Common custom probe functions */
 354 extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
 355
 356 /* For devices that use several addresses, use i2c_new_dummy() to make
 357  * client handles for the extra addresses.
 358  */
 359 extern struct i2c_client *
 360 i2c_new_dummy(struct i2c_adapter *adap, u16 address);
 361
 362 extern struct i2c_client *
 363 i2c_new_secondary_device(struct i2c_client *client,
 364                                 const char *name,
 365                                 u16 default_addr);
 366
 367 extern void i2c_unregister_device(struct i2c_client *);
 368 #endif /* I2C */
 369
 370 /* Mainboard arch_initcall() code should register all its I2C devices.
 371  * This is done at arch_initcall time, before declaring any i2c adapters.
 372  * Modules for add-on boards must use other calls.
 373  */
 374 #ifdef CONFIG_I2C_BOARDINFO
 375 extern int
 376 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
 377                         unsigned n);
 378 #else
 379 static inline int
 380 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
 381                         unsigned n)
 382 {
 383         return 0;
 384 }
 385 #endif /* I2C_BOARDINFO */
 386
 387 /**
 388  * struct i2c_algorithm - represent I2C transfer method
 389  * @master_xfer: Issue a set of i2c transactions to the given I2C adapter
 390  *   defined by the msgs array, with num messages available to transfer via
 391  *   the adapter specified by adap.
 392  * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this
 393  *   is not present, then the bus layer will try and convert the SMBus calls
 394  *   into I2C transfers instead.
 395  * @functionality: Return the flags that this algorithm/adapter pair supports
 396  *   from the I2C_FUNC_* flags.
 397  * @reg_slave: Register given client to I2C slave mode of this adapter
 398  * @unreg_slave: Unregister given client from I2C slave mode of this adapter
 399  *
 400  * The following structs are for those who like to implement new bus drivers:
 401  * i2c_algorithm is the interface to a class of hardware solutions which can
 402  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 403  * to name two of the most common.
 404  *
 405  * The return codes from the @master_xfer field should indicate the type of
 406  * error code that occurred during the transfer, as documented in the kernel
 407  * Documentation file Documentation/i2c/fault-codes.
 408  */
 409 struct i2c_algorithm {
 410         /* If an adapter algorithm can't do I2C-level access, set master_xfer
 411            to NULL. If an adapter algorithm can do SMBus access, set
 412            smbus_xfer. If set to NULL, the SMBus protocol is simulated
 413            using common I2C messages */
 414         /* master_xfer should return the number of messages successfully
 415            processed, or a negative value on error */
 416         int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
 417                            int num);
 418         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
 419                            unsigned short flags, char read_write,
 420                            u8 command, int size, union i2c_smbus_data *data);
 421
 422         /* To determine what the adapter supports */
 423         u32 (*functionality) (struct i2c_adapter *);
 424
 425 #if IS_ENABLED(CONFIG_I2C_SLAVE)
 426         int (*reg_slave)(struct i2c_client *client);
 427         int (*unreg_slave)(struct i2c_client *client);
 428 #endif
 429 };
 430
 431 /**
 432  * struct i2c_lock_operations - represent I2C locking operations
 433  * @lock_bus: Get exclusive access to an I2C bus segment
 434  * @trylock_bus: Try to get exclusive access to an I2C bus segment
 435  * @unlock_bus: Release exclusive access to an I2C bus segment
 436  *
 437  * The main operations are wrapped by i2c_lock_bus and i2c_unlock_bus.
 438  */
 439 struct i2c_lock_operations {
 440         void (*lock_bus)(struct i2c_adapter *, unsigned int flags);
 441         int (*trylock_bus)(struct i2c_adapter *, unsigned int flags);
 442         void (*unlock_bus)(struct i2c_adapter *, unsigned int flags);
 443 };
 444
 445 /**
 446  * struct i2c_timings - I2C timing information
 447  * @bus_freq_hz: the bus frequency in Hz
 448  * @scl_rise_ns: time SCL signal takes to rise in ns; t(r) in the I2C specification
 449  * @scl_fall_ns: time SCL signal takes to fall in ns; t(f) in the I2C specification
 450  * @scl_int_delay_ns: time IP core additionally needs to setup SCL in ns
 451  * @sda_fall_ns: time SDA signal takes to fall in ns; t(f) in the I2C specification
 452  */
 453 struct i2c_timings {
 454         u32 bus_freq_hz;
 455         u32 scl_rise_ns;
 456         u32 scl_fall_ns;
 457         u32 scl_int_delay_ns;
 458         u32 sda_fall_ns;
 459 };
 460
 461 /**
 462  * struct i2c_bus_recovery_info - I2C bus recovery information
 463  * @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or
 464  *      i2c_generic_scl_recovery() or i2c_generic_gpio_recovery().
 465  * @get_scl: This gets current value of SCL line. Mandatory for generic SCL
 466  *      recovery. Used internally for generic GPIO recovery.
 467  * @set_scl: This sets/clears SCL line. Mandatory for generic SCL recovery. Used
 468  *      internally for generic GPIO recovery.
 469  * @get_sda: This gets current value of SDA line. Optional for generic SCL
 470  *      recovery. Used internally, if sda_gpio is a valid GPIO, for generic GPIO
 471  *      recovery.
 472  * @prepare_recovery: This will be called before starting recovery. Platform may
 473  *      configure padmux here for SDA/SCL line or something else they want.
 474  * @unprepare_recovery: This will be called after completing recovery. Platform
 475  *      may configure padmux here for SDA/SCL line or something else they want.
 476  * @scl_gpio: gpio number of the SCL line. Only required for GPIO recovery.
 477  * @sda_gpio: gpio number of the SDA line. Only required for GPIO recovery.
 478  */
 479 struct i2c_bus_recovery_info {
 480         int (*recover_bus)(struct i2c_adapter *);
 481
 482         int (*get_scl)(struct i2c_adapter *);
 483         void (*set_scl)(struct i2c_adapter *, int val);
 484         int (*get_sda)(struct i2c_adapter *);
 485
 486         void (*prepare_recovery)(struct i2c_adapter *);
 487         void (*unprepare_recovery)(struct i2c_adapter *);
 488
 489         /* gpio recovery */
 490         int scl_gpio;
 491         int sda_gpio;
 492 };
 493
 494 int i2c_recover_bus(struct i2c_adapter *adap);
 495
 496 /* Generic recovery routines */
 497 int i2c_generic_gpio_recovery(struct i2c_adapter *adap);
 498 int i2c_generic_scl_recovery(struct i2c_adapter *adap);
 499
 500 /**
 501  * struct i2c_adapter_quirks - describe flaws of an i2c adapter
 502  * @flags: see I2C_AQ_* for possible flags and read below
 503  * @max_num_msgs: maximum number of messages per transfer
 504  * @max_write_len: maximum length of a write message
 505  * @max_read_len: maximum length of a read message
 506  * @max_comb_1st_msg_len: maximum length of the first msg in a combined message
 507  * @max_comb_2nd_msg_len: maximum length of the second msg in a combined message
 508  *
 509  * Note about combined messages: Some I2C controllers can only send one message
 510  * per transfer, plus something called combined message or write-then-read.
 511  * This is (usually) a small write message followed by a read message and
 512  * barely enough to access register based devices like EEPROMs. There is a flag
 513  * to support this mode. It implies max_num_msg = 2 and does the length checks
 514  * with max_comb_*_len because combined message mode usually has its own
 515  * limitations. Because of HW implementations, some controllers can actually do
 516  * write-then-anything or other variants. To support that, write-then-read has
 517  * been broken out into smaller bits like write-first and read-second which can
 518  * be combined as needed.
 519  */
 520
 521 struct i2c_adapter_quirks {
 522         u64 flags;
 523         int max_num_msgs;
 524         u16 max_write_len;
 525         u16 max_read_len;
 526         u16 max_comb_1st_msg_len;
 527         u16 max_comb_2nd_msg_len;
 528 };
 529
 530 /* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */
 531 #define I2C_AQ_COMB                     BIT(0)
 532 /* first combined message must be write */
 533 #define I2C_AQ_COMB_WRITE_FIRST         BIT(1)
 534 /* second combined message must be read */
 535 #define I2C_AQ_COMB_READ_SECOND         BIT(2)
 536 /* both combined messages must have the same target address */
 537 #define I2C_AQ_COMB_SAME_ADDR           BIT(3)
 538 /* convenience macro for typical write-then read case */
 539 #define I2C_AQ_COMB_WRITE_THEN_READ     (I2C_AQ_COMB | I2C_AQ_COMB_WRITE_FIRST | \
 540                                          I2C_AQ_COMB_READ_SECOND | I2C_AQ_COMB_SAME_ADDR)
 541 /* clock stretching is not supported */
 542 #define I2C_AQ_NO_CLK_STRETCH           BIT(4)
 543
 544 /*
 545  * i2c_adapter is the structure used to identify a physical i2c bus along
 546  * with the access algorithms necessary to access it.
 547  */
 548 struct i2c_adapter {
 549         struct module *owner;
 550         unsigned int class;               /* classes to allow probing for */
 551         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
 552         void *algo_data;
 553
 554         /* data fields that are valid for all devices   */
 555         const struct i2c_lock_operations *lock_ops;
 556         struct rt_mutex bus_lock;
 557         struct rt_mutex mux_lock;
 558
 559         int timeout;                    /* in jiffies */
 560         int retries;
 561         struct device dev;              /* the adapter device */
 562
 563         int nr;
 564         char name[48];
 565         struct completion dev_released;
 566
 567         struct mutex userspace_clients_lock;
 568         struct list_head userspace_clients;
 569
 570         struct i2c_bus_recovery_info *bus_recovery_info;
 571         const struct i2c_adapter_quirks *quirks;
 572 };
 573 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
 574
 575 static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
 576 {
 577         return dev_get_drvdata(&dev->dev);
 578 }
 579
 580 static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
 581 {
 582         dev_set_drvdata(&dev->dev, data);
 583 }
 584
 585 static inline struct i2c_adapter *
 586 i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
 587 {
 588 #if IS_ENABLED(CONFIG_I2C_MUX)
 589         struct device *parent = adapter->dev.parent;
 590
 591         if (parent != NULL && parent->type == &i2c_adapter_type)
 592                 return to_i2c_adapter(parent);
 593         else
 594 #endif
 595                 return NULL;
 596 }
 597
 598 int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));
 599
 600 /* Adapter locking functions, exported for shared pin cases */
 601 #define I2C_LOCK_ROOT_ADAPTER BIT(0)
 602 #define I2C_LOCK_SEGMENT      BIT(1)
 603
 604 /**
 605  * i2c_lock_bus - Get exclusive access to an I2C bus segment
 606  * @adapter: Target I2C bus segment
 607  * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
 608  *      locks only this branch in the adapter tree
 609  */
 610 static inline void
 611 i2c_lock_bus(struct i2c_adapter *adapter, unsigned int flags)
 612 {
 613         adapter->lock_ops->lock_bus(adapter, flags);
 614 }
 615
 616 /**
 617  * i2c_trylock_bus - Try to get exclusive access to an I2C bus segment
 618  * @adapter: Target I2C bus segment
 619  * @flags: I2C_LOCK_ROOT_ADAPTER tries to locks the root i2c adapter,
 620  *      I2C_LOCK_SEGMENT tries to lock only this branch in the adapter tree
 621  *
 622  * Return: true if the I2C bus segment is locked, false otherwise
 623  */
 624 static inline int
 625 i2c_trylock_bus(struct i2c_adapter *adapter, unsigned int flags)
 626 {
 627         return adapter->lock_ops->trylock_bus(adapter, flags);
 628 }
 629
 630 /**
 631  * i2c_unlock_bus - Release exclusive access to an I2C bus segment
 632  * @adapter: Target I2C bus segment
 633  * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
 634  *      unlocks only this branch in the adapter tree
 635  */
 636 static inline void
 637 i2c_unlock_bus(struct i2c_adapter *adapter, unsigned int flags)
 638 {
 639         adapter->lock_ops->unlock_bus(adapter, flags);
 640 }
 641
 642 static inline void
 643 i2c_lock_adapter(struct i2c_adapter *adapter)
 644 {
 645         i2c_lock_bus(adapter, I2C_LOCK_ROOT_ADAPTER);
 646 }
 647
 648 static inline void
 649 i2c_unlock_adapter(struct i2c_adapter *adapter)
 650 {
 651         i2c_unlock_bus(adapter, I2C_LOCK_ROOT_ADAPTER);
 652 }
 653
 654 /*flags for the client struct: */
 655 #define I2C_CLIENT_PEC          0x04    /* Use Packet Error Checking */
 656 #define I2C_CLIENT_TEN          0x10    /* we have a ten bit chip address */
 657                                         /* Must equal I2C_M_TEN below */
 658 #define I2C_CLIENT_SLAVE        0x20    /* we are the slave */
 659 #define I2C_CLIENT_WAKE         0x80    /* for board_info; true iff can wake */
 660 #define I2C_CLIENT_SCCB         0x9000  /* Use Omnivision SCCB protocol */
 661                                         /* Must match I2C_M_STOP|IGNORE_NAK */
 662
 663 /* i2c adapter classes (bitmask) */
 664 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
 665 #define I2C_CLASS_DDC           (1<<3)  /* DDC bus on graphics adapters */
 666 #define I2C_CLASS_SPD           (1<<7)  /* Memory modules */
 667 #define I2C_CLASS_DEPRECATED    (1<<8)  /* Warn users that adapter will stop using classes */
 668
 669 /* Internal numbers to terminate lists */
 670 #define I2C_CLIENT_END          0xfffeU
 671
 672 /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
 673 #define I2C_ADDRS(addr, addrs...) \
 674         ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
 675
 676
 677 /* ----- functions exported by i2c.o */
 678
 679 /* administration...
 680  */
 681 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 682 extern int i2c_add_adapter(struct i2c_adapter *);
 683 extern void i2c_del_adapter(struct i2c_adapter *);
 684 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
 685
 686 extern int i2c_register_driver(struct module *, struct i2c_driver *);
 687 extern void i2c_del_driver(struct i2c_driver *);
 688
 689 /* use a define to avoid include chaining to get THIS_MODULE */
 690 #define i2c_add_driver(driver) \
 691         i2c_register_driver(THIS_MODULE, driver)
 692
 693 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
 694 extern void i2c_release_client(struct i2c_client *client);
 695
 696 /* call the i2c_client->command() of all attached clients with
 697  * the given arguments */
 698 extern void i2c_clients_command(struct i2c_adapter *adap,
 699                                 unsigned int cmd, void *arg);
 700
 701 extern struct i2c_adapter *i2c_get_adapter(int nr);
 702 extern void i2c_put_adapter(struct i2c_adapter *adap);
 703 extern unsigned int i2c_adapter_depth(struct i2c_adapter *adapter);
 704
 705 void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults);
 706
 707 /* Return the functionality mask */
 708 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
 709 {
 710         return adap->algo->functionality(adap);
 711 }
 712
 713 /* Return 1 if adapter supports everything we need, 0 if not. */
 714 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
 715 {
 716         return (func & i2c_get_functionality(adap)) == func;
 717 }
 718
 719 /**
 720  * i2c_check_quirks() - Function for checking the quirk flags in an i2c adapter
 721  * @adap: i2c adapter
 722  * @quirks: quirk flags
 723  *
 724  * Return: true if the adapter has all the specified quirk flags, false if not
 725  */
 726 static inline bool i2c_check_quirks(struct i2c_adapter *adap, u64 quirks)
 727 {
 728         if (!adap->quirks)
 729                 return false;
 730         return (adap->quirks->flags & quirks) == quirks;
 731 }
 732
 733 /* Return the adapter number for a specific adapter */
 734 static inline int i2c_adapter_id(struct i2c_adapter *adap)
 735 {
 736         return adap->nr;
 737 }
 738
 739 static inline u8 i2c_8bit_addr_from_msg(const struct i2c_msg *msg)
 740 {
 741         return (msg->addr << 1) | (msg->flags & I2C_M_RD ? 1 : 0);
 742 }
 743
 744 /**
 745  * module_i2c_driver() - Helper macro for registering a modular I2C driver
 746  * @__i2c_driver: i2c_driver struct
 747  *
 748  * Helper macro for I2C drivers which do not do anything special in module
 749  * init/exit. This eliminates a lot of boilerplate. Each module may only
 750  * use this macro once, and calling it replaces module_init() and module_exit()
 751  */
 752 #define module_i2c_driver(__i2c_driver) \
 753         module_driver(__i2c_driver, i2c_add_driver, \
 754                         i2c_del_driver)
 755
 756 /**
 757  * builtin_i2c_driver() - Helper macro for registering a builtin I2C driver
 758  * @__i2c_driver: i2c_driver struct
 759  *
 760  * Helper macro for I2C drivers which do not do anything special in their
 761  * init. This eliminates a lot of boilerplate. Each driver may only
 762  * use this macro once, and calling it replaces device_initcall().
 763  */
 764 #define builtin_i2c_driver(__i2c_driver) \
 765         builtin_driver(__i2c_driver, i2c_add_driver)
 766
 767 #endif /* I2C */
 768
 769 #if IS_ENABLED(CONFIG_OF)
 770 /* must call put_device() when done with returned i2c_client device */
 771 extern struct i2c_client *of_find_i2c_device_by_node(struct device_node *node);
 772
 773 /* must call put_device() when done with returned i2c_adapter device */
 774 extern struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node);
 775
 776 /* must call i2c_put_adapter() when done with returned i2c_adapter device */
 777 struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node);
 778
 779 extern const struct of_device_id
 780 *i2c_of_match_device(const struct of_device_id *matches,
 781                      struct i2c_client *client);
 782
 783 #else
 784
 785 static inline struct i2c_client *of_find_i2c_device_by_node(struct device_node *node)
 786 {
 787         return NULL;
 788 }
 789
 790 static inline struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node)
 791 {
 792         return NULL;
 793 }
 794
 795 static inline struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node)
 796 {
 797         return NULL;
 798 }
 799
 800 static inline const struct of_device_id
 801 *i2c_of_match_device(const struct of_device_id *matches,
 802                      struct i2c_client *client)
 803 {
 804         return NULL;
 805 }
 806
 807 #endif /* CONFIG_OF */
 808
 809 #if IS_ENABLED(CONFIG_ACPI)
 810 u32 i2c_acpi_find_bus_speed(struct device *dev);
 811 #else
 812 static inline u32 i2c_acpi_find_bus_speed(struct device *dev)
 813 {
 814         return 0;
 815 }
 816 #endif /* CONFIG_ACPI */
 817
 818 #endif /* _LINUX_I2C_H */