include/linux/i2c.h

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