blob: 65b4eaed1d965ca193407f9209a62310a51aafb1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------------------- */
David Brownell438d6c22006-12-10 21:21:31 +01002/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003/* i2c.h - definitions for the i2c-bus interface */
David Brownell438d6c22006-12-10 21:21:31 +01004/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005/* ------------------------------------------------------------------------- */
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
Jean Delvare5694f8a2012-03-26 21:47:19 +020020 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
21 MA 02110-1301 USA. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070022/* ------------------------------------------------------------------------- */
23
David Woodhousea1b92982006-04-25 14:14:52 +010024/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 Frodo Looijaard <frodol@dds.nl> */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020029#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080031#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010032#include <linux/mutex.h>
Ingo Molnar037741a2017-02-03 10:08:30 +010033#include <linux/rtmutex.h>
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +020034#include <linux/irqdomain.h> /* for Host Notify IRQ */
Grant Likelyd12d42f2010-04-13 16:12:28 -070035#include <linux/of.h> /* for struct device_node */
Jonathan Cameron06a67842011-10-30 13:47:25 +010036#include <linux/swab.h> /* for swab16 */
David Howells607ca462012-10-13 10:46:48 +010037#include <uapi/linux/i2c.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jon Smirle9ca9eb2008-07-14 22:38:35 +020039extern struct bus_type i2c_bus_type;
Michael Lawnick08263742010-08-11 18:21:02 +020040extern struct device_type i2c_adapter_type;
Dmitry Torokhov00a06c22017-03-04 11:29:34 -080041extern struct device_type i2c_client_type;
Jon Smirle9ca9eb2008-07-14 22:38:35 +020042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/* --- General options ------------------------------------------------ */
44
45struct i2c_msg;
46struct i2c_algorithm;
47struct i2c_adapter;
48struct i2c_client;
49struct i2c_driver;
Peter Rosindde67eb2018-01-22 08:32:01 +010050struct i2c_device_identity;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020052struct i2c_board_info;
Wolfram Sang4b1acc42014-11-18 17:04:53 +010053enum i2c_slave_event;
54typedef int (*i2c_slave_cb_t)(struct i2c_client *, enum i2c_slave_event, u8 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Paul Gortmakerde477252011-05-26 13:46:22 -040056struct module;
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -080057struct property_entry;
Paul Gortmakerde477252011-05-26 13:46:22 -040058
Stefan Lengfeld901a891f2017-11-01 21:06:41 +010059#if IS_ENABLED(CONFIG_I2C)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060/*
61 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010062 * on a bus (or read from them). Apart from two basic transfer functions to
63 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * transmit an arbitrary number of messages without interruption.
Zhangfei Gao0c43ea52010-03-02 12:23:49 +010065 * @count must be be less than 64k since msg.len is u16.
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 */
Wolfram Sang8a917322017-11-04 21:20:04 +010067extern int i2c_transfer_buffer_flags(const struct i2c_client *client,
68 char *buf, int count, u16 flags);
69
70/**
71 * i2c_master_recv - issue a single I2C message in master receive mode
72 * @client: Handle to slave device
73 * @buf: Where to store data read from slave
74 * @count: How many bytes to read, must be less than 64k since msg.len is u16
75 *
76 * Returns negative errno, or else the number of bytes read.
77 */
78static inline int i2c_master_recv(const struct i2c_client *client,
79 char *buf, int count)
80{
81 return i2c_transfer_buffer_flags(client, buf, count, I2C_M_RD);
82};
83
84/**
Wolfram Sangba986452017-11-04 21:20:05 +010085 * i2c_master_recv_dmasafe - issue a single I2C message in master receive mode
86 * using a DMA safe buffer
87 * @client: Handle to slave device
88 * @buf: Where to store data read from slave, must be safe to use with DMA
89 * @count: How many bytes to read, must be less than 64k since msg.len is u16
90 *
91 * Returns negative errno, or else the number of bytes read.
92 */
93static inline int i2c_master_recv_dmasafe(const struct i2c_client *client,
94 char *buf, int count)
95{
96 return i2c_transfer_buffer_flags(client, buf, count,
97 I2C_M_RD | I2C_M_DMA_SAFE);
98};
99
100/**
Wolfram Sang8a917322017-11-04 21:20:04 +0100101 * i2c_master_send - issue a single I2C message in master transmit mode
102 * @client: Handle to slave device
103 * @buf: Data that will be written to the slave
104 * @count: How many bytes to write, must be less than 64k since msg.len is u16
105 *
106 * Returns negative errno, or else the number of bytes written.
107 */
108static inline int i2c_master_send(const struct i2c_client *client,
109 const char *buf, int count)
110{
111 return i2c_transfer_buffer_flags(client, (char *)buf, count, 0);
112};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Wolfram Sangba986452017-11-04 21:20:05 +0100114/**
115 * i2c_master_send_dmasafe - issue a single I2C message in master transmit mode
116 * using a DMA safe buffer
117 * @client: Handle to slave device
118 * @buf: Data that will be written to the slave, must be safe to use with DMA
119 * @count: How many bytes to write, must be less than 64k since msg.len is u16
120 *
121 * Returns negative errno, or else the number of bytes written.
122 */
123static inline int i2c_master_send_dmasafe(const struct i2c_client *client,
124 const char *buf, int count)
125{
126 return i2c_transfer_buffer_flags(client, (char *)buf, count,
127 I2C_M_DMA_SAFE);
128};
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130/* Transfer num messages.
131 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200132extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
133 int num);
Jean Delvareb37d2a32012-06-29 07:47:19 -0300134/* Unlocked flavor */
135extern int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
136 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138/* This is the very generalized SMBus access routine. You probably do not
139 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +0100140 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 Note that we use i2c_adapter here, because you do not need a specific
142 smbus adapter to call this function. */
Peter Rosin63453b52018-06-20 10:51:53 +0200143s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
144 unsigned short flags, char read_write, u8 command,
145 int protocol, union i2c_smbus_data *data);
146
147/* Unlocked flavor */
148s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
149 unsigned short flags, char read_write, u8 command,
150 int protocol, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +0200153 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Jean Delvare0cc43a12011-01-10 22:11:23 +0100155extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
156extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
157extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
158 u8 command);
159extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200160 u8 command, u8 value);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100161extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
162 u8 command);
163extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200164 u8 command, u16 value);
Jonathan Cameron06a67842011-10-30 13:47:25 +0100165
166static inline s32
167i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
168{
169 s32 value = i2c_smbus_read_word_data(client, command);
170
171 return (value < 0) ? value : swab16(value);
172}
173
174static inline s32
175i2c_smbus_write_word_swapped(const struct i2c_client *client,
176 u8 command, u16 value)
177{
178 return i2c_smbus_write_word_data(client, command, swab16(value));
179}
180
Jean Delvareb86a1bc2007-05-01 23:26:34 +0200181/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +0100182extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
Jean Delvareb86a1bc2007-05-01 23:26:34 +0200183 u8 command, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100184extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200185 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +0200186/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +0100187extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +0200188 u8 command, u8 length, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100189extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +1100190 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +0200191 const u8 *values);
Irina Tirdea01eef962015-08-12 17:31:33 +0300192extern s32
193i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client,
194 u8 command, u8 length, u8 *values);
Peter Rosindde67eb2018-01-22 08:32:01 +0100195int i2c_get_device_id(const struct i2c_client *client,
196 struct i2c_device_identity *id);
Jean Delvare23af8402009-06-19 16:58:20 +0200197#endif /* I2C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Peter Rosindde67eb2018-01-22 08:32:01 +0100199/**
200 * struct i2c_device_identity - i2c client device identification
201 * @manufacturer_id: 0 - 4095, database maintained by NXP
202 * @part_id: 0 - 511, according to manufacturer
203 * @die_revision: 0 - 7, according to manufacturer
204 */
205struct i2c_device_identity {
206 u16 manufacturer_id;
207#define I2C_DEVICE_ID_NXP_SEMICONDUCTORS 0
208#define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_1 1
209#define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_2 2
210#define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_3 3
211#define I2C_DEVICE_ID_RAMTRON_INTERNATIONAL 4
212#define I2C_DEVICE_ID_ANALOG_DEVICES 5
213#define I2C_DEVICE_ID_STMICROELECTRONICS 6
214#define I2C_DEVICE_ID_ON_SEMICONDUCTOR 7
215#define I2C_DEVICE_ID_SPRINTEK_CORPORATION 8
216#define I2C_DEVICE_ID_ESPROS_PHOTONICS_AG 9
217#define I2C_DEVICE_ID_FUJITSU_SEMICONDUCTOR 10
218#define I2C_DEVICE_ID_FLIR 11
219#define I2C_DEVICE_ID_O2MICRO 12
220#define I2C_DEVICE_ID_ATMEL 13
221#define I2C_DEVICE_ID_NONE 0xffff
222 u16 part_id;
223 u8 die_revision;
224};
225
Benjamin Tissoiresb4f21052016-06-09 16:53:47 +0200226enum i2c_alert_protocol {
227 I2C_PROTOCOL_SMBUS_ALERT,
Benjamin Tissoirese456cd32016-06-09 16:53:48 +0200228 I2C_PROTOCOL_SMBUS_HOST_NOTIFY,
Benjamin Tissoiresb4f21052016-06-09 16:53:47 +0200229};
230
Jean Delvare4735c982008-07-14 22:38:36 +0200231/**
232 * struct i2c_driver - represent an I2C device driver
233 * @class: What kind of i2c device we instantiate (for detect)
Lee Jonesb8a1a4c2016-11-07 12:47:41 +0000234 * @probe: Callback for device binding - soon to be deprecated
235 * @probe_new: New callback for device binding
Jean Delvare729d6dd2009-06-19 16:58:18 +0200236 * @remove: Callback for device unbinding
Jean Delvare96e21e42008-08-28 08:33:23 +0200237 * @shutdown: Callback for device shutdown
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700238 * @alert: Alert callback, for example for the SMBus alert protocol
Jean Delvare96e21e42008-08-28 08:33:23 +0200239 * @command: Callback for bus-wide signaling (optional)
240 * @driver: Device driver model driver
241 * @id_table: List of I2C devices supported by this driver
Jean Delvare4735c982008-07-14 22:38:36 +0200242 * @detect: Callback for device detection
Jean Delvarec3813d62009-12-14 21:17:25 +0100243 * @address_list: The I2C addresses to probe (for detect)
Jean Delvare4735c982008-07-14 22:38:36 +0200244 * @clients: List of detected clients we created (for i2c-core use only)
Hans de Goeded1d84bb2017-04-05 00:03:34 +0200245 * @disable_i2c_core_irq_mapping: Tell the i2c-core to not do irq-mapping
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100246 *
247 * The driver.owner field should be set to the module owner of this driver.
248 * The driver.name field should be set to the name of this driver.
Jean Delvare4735c982008-07-14 22:38:36 +0200249 *
Vivien Didelot0ec13862012-10-05 22:23:54 +0200250 * For automatic device detection, both @detect and @address_list must
Jean Delvare4735c982008-07-14 22:38:36 +0200251 * be defined. @class should also be set, otherwise only devices forced
252 * with module parameters will be created. The detect function must
253 * fill at least the name field of the i2c_board_info structure it is
254 * handed upon successful detection, and possibly also the flags field.
255 *
256 * If @detect is missing, the driver will still work fine for enumerated
257 * devices. Detected devices simply won't be supported. This is expected
258 * for the many I2C/SMBus devices which can't be detected reliably, and
259 * the ones which can always be enumerated in practice.
260 *
261 * The i2c_client structure which is handed to the @detect callback is
262 * not a real i2c_client. It is initialized just enough so that you can
263 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
264 * else with it. In particular, calling dev_dbg and friends on it is
265 * not allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Jean Delvare729d6dd2009-06-19 16:58:18 +0200270 /* Standard driver model interfaces */
Jean Delvared2653e92008-04-29 23:11:39 +0200271 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200272 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200273
Lee Jonesb8a1a4c2016-11-07 12:47:41 +0000274 /* New driver model interface to aid the seamless removal of the
275 * current probe()'s, more commonly unused than used second parameter.
276 */
277 int (*probe_new)(struct i2c_client *);
278
David Brownellf37dd802007-02-13 22:09:00 +0100279 /* driver model interfaces that don't relate to enumeration */
280 void (*shutdown)(struct i2c_client *);
David Brownellf37dd802007-02-13 22:09:00 +0100281
Jean Delvareb5527a72010-03-02 12:23:42 +0100282 /* Alert callback, for example for the SMBus alert protocol.
283 * The format and meaning of the data value depends on the protocol.
284 * For the SMBus alert protocol, there is a single bit of data passed
285 * as the alert response's low bit ("event flag").
Benjamin Tissoirese456cd32016-06-09 16:53:48 +0200286 * For the SMBus Host Notify protocol, the data corresponds to the
287 * 16-bit payload data reported by the slave device acting as master.
Jean Delvareb5527a72010-03-02 12:23:42 +0100288 */
Benjamin Tissoiresb4f21052016-06-09 16:53:47 +0200289 void (*alert)(struct i2c_client *, enum i2c_alert_protocol protocol,
290 unsigned int data);
Jean Delvareb5527a72010-03-02 12:23:42 +0100291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 /* a ioctl like command that can be used to perform specific functions
293 * with the device.
294 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200295 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200298 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200299
300 /* Device detection callback for automatic device creation */
Jean Delvare310ec792009-12-14 21:17:23 +0100301 int (*detect)(struct i2c_client *, struct i2c_board_info *);
Jean Delvarec3813d62009-12-14 21:17:25 +0100302 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +0200303 struct list_head clients;
Hans de Goeded1d84bb2017-04-05 00:03:34 +0200304
305 bool disable_i2c_core_irq_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306};
307#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
308
David Brownell2096b952007-05-01 23:26:28 +0200309/**
310 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200311 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
312 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
David Brownell2096b952007-05-01 23:26:28 +0200313 * @addr: Address used on the I2C bus connected to the parent adapter.
314 * @name: Indicates the type of the device, usually a chip name that's
315 * generic enough to hide second-sourcing and compatible revisions.
David Brownelld64f73b2007-07-12 14:12:28 +0200316 * @adapter: manages the bus segment hosting this I2C device
David Brownell2096b952007-05-01 23:26:28 +0200317 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200318 * @irq: indicates the IRQ generated by this device (if any)
Jean Delvare99cd8e22009-06-19 16:58:20 +0200319 * @detected: member of an i2c_driver.clients list or i2c-core's
320 * userspace_devices list
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100321 * @slave_cb: Callback when I2C slave mode of an adapter is used. The adapter
322 * calls it to pass on slave events to the slave driver.
David Brownell2096b952007-05-01 23:26:28 +0200323 *
324 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200325 * i2c bus. The behaviour exposed to Linux is defined by the driver
326 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 */
328struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200329 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100330 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200332 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200333 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 struct i2c_adapter *adapter; /* the adapter we sit on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200336 int irq; /* irq issued by device */
Jean Delvare4735c982008-07-14 22:38:36 +0200337 struct list_head detected;
Jean Delvared5fd1202015-01-26 20:59:31 +0100338#if IS_ENABLED(CONFIG_I2C_SLAVE)
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100339 i2c_slave_cb_t slave_cb; /* callback for slave mode */
Jean Delvared5fd1202015-01-26 20:59:31 +0100340#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341};
342#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
343
David Brownell9b766b82008-01-27 18:14:51 +0100344extern struct i2c_client *i2c_verify_client(struct device *dev);
Stephen Warren643dd092012-04-17 12:43:33 -0600345extern struct i2c_adapter *i2c_verify_adapter(struct device *dev);
Lee Jones5f441fc2016-11-07 12:47:40 +0000346extern const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
347 const struct i2c_client *client);
David Brownell9b766b82008-01-27 18:14:51 +0100348
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500349static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
350{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200351 struct device * const dev = container_of(kobj, struct device, kobj);
352 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500353}
354
Jean Delvare7d1d8992008-10-22 20:21:31 +0200355static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200357 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358}
359
Jean Delvare3ae70de2008-10-22 20:21:32 +0200360static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200362 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363}
364
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100365/* I2C slave support */
366
Jean Delvared5fd1202015-01-26 20:59:31 +0100367#if IS_ENABLED(CONFIG_I2C_SLAVE)
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100368enum i2c_slave_event {
Wolfram Sang5b77d162015-03-23 09:26:36 +0100369 I2C_SLAVE_READ_REQUESTED,
370 I2C_SLAVE_WRITE_REQUESTED,
371 I2C_SLAVE_READ_PROCESSED,
372 I2C_SLAVE_WRITE_RECEIVED,
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100373 I2C_SLAVE_STOP,
374};
375
376extern int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb);
377extern int i2c_slave_unregister(struct i2c_client *client);
Luis Oliveiracefae802017-01-26 17:45:32 +0000378extern bool i2c_detect_slave_mode(struct device *dev);
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100379
380static inline int i2c_slave_event(struct i2c_client *client,
381 enum i2c_slave_event event, u8 *val)
382{
383 return client->slave_cb(client, event, val);
384}
Andy Shevchenko8f1a3572017-07-06 20:26:17 +0300385#else
386static inline bool i2c_detect_slave_mode(struct device *dev) { return false; }
Jean Delvared5fd1202015-01-26 20:59:31 +0100387#endif
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100388
David Brownell9c1600e2007-05-01 23:26:31 +0200389/**
390 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200391 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200392 * @flags: to initialize i2c_client.flags
393 * @addr: stored in i2c_client.addr
Hans de Goede728fe6c2017-10-11 11:41:19 +0200394 * @dev_name: Overrides the default <busnr>-<addr> dev_name if set
David Brownell9c1600e2007-05-01 23:26:31 +0200395 * @platform_data: stored in i2c_client.dev.platform_data
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700396 * @of_node: pointer to OpenFirmware device node
Rafael J. Wysockice793482015-03-16 23:49:03 +0100397 * @fwnode: device node supplied by the platform firmware
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800398 * @properties: additional device properties for the device
Dmitry Torokhov4124c4e2017-03-01 11:45:51 -0800399 * @resources: resources associated with the device
400 * @num_resources: number of resources in the @resources array
David Brownell9c1600e2007-05-01 23:26:31 +0200401 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200402 *
David Brownell9c1600e2007-05-01 23:26:31 +0200403 * I2C doesn't actually support hardware probing, although controllers and
404 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
405 * a device at a given address. Drivers commonly need more information than
406 * that, such as chip type, configuration, associated IRQ, and so on.
407 *
408 * i2c_board_info is used to build tables of information listing I2C devices
Jean Delvare729d6dd2009-06-19 16:58:18 +0200409 * that are present. This information is used to grow the driver model tree.
410 * For mainboards this is done statically using i2c_register_board_info();
411 * bus numbers identify adapters that aren't yet available. For add-on boards,
412 * i2c_new_device() does this dynamically with the adapter already known.
David Brownell9c1600e2007-05-01 23:26:31 +0200413 */
414struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200415 char type[I2C_NAME_SIZE];
416 unsigned short flags;
417 unsigned short addr;
Hans de Goede728fe6c2017-10-11 11:41:19 +0200418 const char *dev_name;
David Brownell9c1600e2007-05-01 23:26:31 +0200419 void *platform_data;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700420 struct device_node *of_node;
Rafael J. Wysockice793482015-03-16 23:49:03 +0100421 struct fwnode_handle *fwnode;
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800422 const struct property_entry *properties;
Dmitry Torokhov4124c4e2017-03-01 11:45:51 -0800423 const struct resource *resources;
424 unsigned int num_resources;
David Brownell9c1600e2007-05-01 23:26:31 +0200425 int irq;
426};
427
428/**
Jean Delvare3760f732008-04-29 23:11:40 +0200429 * I2C_BOARD_INFO - macro used to list an i2c device and its address
430 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200431 * @dev_addr: the device's address on the bus.
432 *
433 * This macro initializes essential fields of a struct i2c_board_info,
434 * declaring what has been provided on a particular board. Optional
Jean Delvare3760f732008-04-29 23:11:40 +0200435 * fields (such as associated irq, or device-specific platform_data)
436 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200437 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200438#define I2C_BOARD_INFO(dev_type, dev_addr) \
Ben Hutchingsc758e8c2009-04-13 17:02:14 +0200439 .type = dev_type, .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200440
441
Stefan Lengfeld901a891f2017-11-01 21:06:41 +0100442#if IS_ENABLED(CONFIG_I2C)
David Brownell9c1600e2007-05-01 23:26:31 +0200443/* Add-on boards should register/unregister their devices; e.g. a board
444 * with integrated I2C, a config eeprom, sensors, and a codec that's
445 * used in conjunction with the primary hardware.
446 */
447extern struct i2c_client *
448i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
449
Jean Delvare12b5053a2007-05-01 23:26:31 +0200450/* If you don't know the exact address of an I2C device, use this variant
451 * instead, which can probe for device presence in a list of possible
Jean Delvare9a942412010-08-11 18:20:56 +0200452 * addresses. The "probe" callback function is optional. If it is provided,
453 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
454 * a default probing method is used.
Jean Delvare12b5053a2007-05-01 23:26:31 +0200455 */
456extern struct i2c_client *
457i2c_new_probed_device(struct i2c_adapter *adap,
458 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +0200459 unsigned short const *addr_list,
460 int (*probe)(struct i2c_adapter *, unsigned short addr));
Jean Delvare12b5053a2007-05-01 23:26:31 +0200461
Jean Delvared44f19d2010-08-11 18:20:57 +0200462/* Common custom probe functions */
463extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
464
David Brownelle9f13732008-01-27 18:14:52 +0100465/* For devices that use several addresses, use i2c_new_dummy() to make
466 * client handles for the extra addresses.
467 */
468extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200469i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100470
Jean-Michel Hautbois0f614d82016-01-31 16:33:00 +0100471extern struct i2c_client *
472i2c_new_secondary_device(struct i2c_client *client,
473 const char *name,
474 u16 default_addr);
475
David Brownell9c1600e2007-05-01 23:26:31 +0200476extern void i2c_unregister_device(struct i2c_client *);
Jean Delvare23af8402009-06-19 16:58:20 +0200477#endif /* I2C */
David Brownell9c1600e2007-05-01 23:26:31 +0200478
479/* Mainboard arch_initcall() code should register all its I2C devices.
480 * This is done at arch_initcall time, before declaring any i2c adapters.
481 * Modules for add-on boards must use other calls.
482 */
David Brownell26386762008-02-24 20:03:42 +0100483#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200484extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200485i2c_register_board_info(int busnum, struct i2c_board_info const *info,
486 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100487#else
488static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200489i2c_register_board_info(int busnum, struct i2c_board_info const *info,
490 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100491{
492 return 0;
493}
Jean Delvare23af8402009-06-19 16:58:20 +0200494#endif /* I2C_BOARDINFO */
David Brownell9c1600e2007-05-01 23:26:31 +0200495
Ben Dooks25ee33f2014-01-26 16:05:36 +0000496/**
497 * struct i2c_algorithm - represent I2C transfer method
498 * @master_xfer: Issue a set of i2c transactions to the given I2C adapter
499 * defined by the msgs array, with num messages available to transfer via
500 * the adapter specified by adap.
501 * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this
502 * is not present, then the bus layer will try and convert the SMBus calls
503 * into I2C transfers instead.
504 * @functionality: Return the flags that this algorithm/adapter pair supports
505 * from the I2C_FUNC_* flags.
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100506 * @reg_slave: Register given client to I2C slave mode of this adapter
507 * @unreg_slave: Unregister given client from I2C slave mode of this adapter
Ben Dooks25ee33f2014-01-26 16:05:36 +0000508 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 * The following structs are for those who like to implement new bus drivers:
510 * i2c_algorithm is the interface to a class of hardware solutions which can
511 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
512 * to name two of the most common.
Ben Dooks25ee33f2014-01-26 16:05:36 +0000513 *
514 * The return codes from the @master_xfer field should indicate the type of
Masanari Iidaf353d712014-10-22 00:00:14 +0900515 * error code that occurred during the transfer, as documented in the kernel
Ben Dooks25ee33f2014-01-26 16:05:36 +0000516 * Documentation file Documentation/i2c/fault-codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 */
518struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100520 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 smbus_xfer. If set to NULL, the SMBus protocol is simulated
522 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200523 /* master_xfer should return the number of messages successfully
524 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200525 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
526 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100527 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200528 unsigned short flags, char read_write,
529 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 /* To determine what the adapter supports */
532 u32 (*functionality) (struct i2c_adapter *);
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100533
Jean Delvared5fd1202015-01-26 20:59:31 +0100534#if IS_ENABLED(CONFIG_I2C_SLAVE)
Wolfram Sang4b1acc42014-11-18 17:04:53 +0100535 int (*reg_slave)(struct i2c_client *client);
536 int (*unreg_slave)(struct i2c_client *client);
Jean Delvared5fd1202015-01-26 20:59:31 +0100537#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538};
539
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530540/**
Peter Rosind1ed7982016-08-25 23:07:01 +0200541 * struct i2c_lock_operations - represent I2C locking operations
542 * @lock_bus: Get exclusive access to an I2C bus segment
543 * @trylock_bus: Try to get exclusive access to an I2C bus segment
544 * @unlock_bus: Release exclusive access to an I2C bus segment
545 *
546 * The main operations are wrapped by i2c_lock_bus and i2c_unlock_bus.
547 */
548struct i2c_lock_operations {
549 void (*lock_bus)(struct i2c_adapter *, unsigned int flags);
550 int (*trylock_bus)(struct i2c_adapter *, unsigned int flags);
551 void (*unlock_bus)(struct i2c_adapter *, unsigned int flags);
552};
553
554/**
Wolfram Sange1dba012015-12-08 10:37:46 +0100555 * struct i2c_timings - I2C timing information
556 * @bus_freq_hz: the bus frequency in Hz
557 * @scl_rise_ns: time SCL signal takes to rise in ns; t(r) in the I2C specification
558 * @scl_fall_ns: time SCL signal takes to fall in ns; t(f) in the I2C specification
559 * @scl_int_delay_ns: time IP core additionally needs to setup SCL in ns
560 * @sda_fall_ns: time SDA signal takes to fall in ns; t(f) in the I2C specification
Andy Shevchenko4717be72018-07-25 17:39:25 +0300561 * @sda_hold_ns: time IP core additionally needs to hold SDA in ns
Wolfram Sange1dba012015-12-08 10:37:46 +0100562 */
563struct i2c_timings {
564 u32 bus_freq_hz;
565 u32 scl_rise_ns;
566 u32 scl_fall_ns;
567 u32 scl_int_delay_ns;
568 u32 sda_fall_ns;
Andy Shevchenko4717be72018-07-25 17:39:25 +0300569 u32 sda_hold_ns;
Wolfram Sange1dba012015-12-08 10:37:46 +0100570};
571
572/**
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530573 * struct i2c_bus_recovery_info - I2C bus recovery information
574 * @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or
Phil Reide1eb7d22017-11-02 10:40:30 +0800575 * i2c_generic_scl_recovery().
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530576 * @get_scl: This gets current value of SCL line. Mandatory for generic SCL
Wolfram Sang766a4f22018-01-09 14:58:54 +0100577 * recovery. Populated internally for generic GPIO recovery.
578 * @set_scl: This sets/clears the SCL line. Mandatory for generic SCL recovery.
579 * Populated internally for generic GPIO recovery.
Wolfram Sangffc59c42018-07-10 23:42:16 +0200580 * @get_sda: This gets current value of SDA line. This or set_sda() is mandatory
581 * for generic SCL recovery. Populated internally, if sda_gpio is a valid
582 * GPIO, for generic GPIO recovery.
583 * @set_sda: This sets/clears the SDA line. This or get_sda() is mandatory for
584 * generic SCL recovery. Populated internally, if sda_gpio is a valid GPIO,
585 * for generic GPIO recovery.
Wolfram Sang7ca5f6b2018-07-11 00:24:22 +0200586 * @get_bus_free: Returns the bus free state as seen from the IP core in case it
587 * has a more complex internal logic than just reading SDA. Optional.
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530588 * @prepare_recovery: This will be called before starting recovery. Platform may
589 * configure padmux here for SDA/SCL line or something else they want.
590 * @unprepare_recovery: This will be called after completing recovery. Platform
591 * may configure padmux here for SDA/SCL line or something else they want.
Phil Reid3991c5c2017-11-02 10:40:24 +0800592 * @scl_gpiod: gpiod of the SCL line. Only required for GPIO recovery.
593 * @sda_gpiod: gpiod of the SDA line. Only required for GPIO recovery.
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530594 */
595struct i2c_bus_recovery_info {
Wolfram Sang6c922042018-01-09 14:58:55 +0100596 int (*recover_bus)(struct i2c_adapter *adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530597
Wolfram Sang6c922042018-01-09 14:58:55 +0100598 int (*get_scl)(struct i2c_adapter *adap);
599 void (*set_scl)(struct i2c_adapter *adap, int val);
600 int (*get_sda)(struct i2c_adapter *adap);
Wolfram Sang80921782018-01-09 14:58:56 +0100601 void (*set_sda)(struct i2c_adapter *adap, int val);
Wolfram Sang7ca5f6b2018-07-11 00:24:22 +0200602 int (*get_bus_free)(struct i2c_adapter *adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530603
Wolfram Sang6c922042018-01-09 14:58:55 +0100604 void (*prepare_recovery)(struct i2c_adapter *adap);
605 void (*unprepare_recovery)(struct i2c_adapter *adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530606
607 /* gpio recovery */
Phil Reid3991c5c2017-11-02 10:40:24 +0800608 struct gpio_desc *scl_gpiod;
609 struct gpio_desc *sda_gpiod;
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530610};
611
612int i2c_recover_bus(struct i2c_adapter *adap);
613
614/* Generic recovery routines */
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530615int i2c_generic_scl_recovery(struct i2c_adapter *adap);
616
Wolfram Sang2187f032015-01-05 15:35:39 +0100617/**
618 * struct i2c_adapter_quirks - describe flaws of an i2c adapter
619 * @flags: see I2C_AQ_* for possible flags and read below
620 * @max_num_msgs: maximum number of messages per transfer
621 * @max_write_len: maximum length of a write message
622 * @max_read_len: maximum length of a read message
623 * @max_comb_1st_msg_len: maximum length of the first msg in a combined message
624 * @max_comb_2nd_msg_len: maximum length of the second msg in a combined message
625 *
626 * Note about combined messages: Some I2C controllers can only send one message
627 * per transfer, plus something called combined message or write-then-read.
628 * This is (usually) a small write message followed by a read message and
629 * barely enough to access register based devices like EEPROMs. There is a flag
630 * to support this mode. It implies max_num_msg = 2 and does the length checks
631 * with max_comb_*_len because combined message mode usually has its own
632 * limitations. Because of HW implementations, some controllers can actually do
633 * write-then-anything or other variants. To support that, write-then-read has
634 * been broken out into smaller bits like write-first and read-second which can
635 * be combined as needed.
636 */
637
638struct i2c_adapter_quirks {
639 u64 flags;
640 int max_num_msgs;
641 u16 max_write_len;
642 u16 max_read_len;
643 u16 max_comb_1st_msg_len;
644 u16 max_comb_2nd_msg_len;
645};
646
647/* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */
648#define I2C_AQ_COMB BIT(0)
649/* first combined message must be write */
650#define I2C_AQ_COMB_WRITE_FIRST BIT(1)
651/* second combined message must be read */
652#define I2C_AQ_COMB_READ_SECOND BIT(2)
653/* both combined messages must have the same target address */
654#define I2C_AQ_COMB_SAME_ADDR BIT(3)
655/* convenience macro for typical write-then read case */
656#define I2C_AQ_COMB_WRITE_THEN_READ (I2C_AQ_COMB | I2C_AQ_COMB_WRITE_FIRST | \
657 I2C_AQ_COMB_READ_SECOND | I2C_AQ_COMB_SAME_ADDR)
Nicola Corna749de3d2015-10-29 12:34:23 +0100658/* clock stretching is not supported */
659#define I2C_AQ_NO_CLK_STRETCH BIT(4)
Wolfram Sangd9cfe2c2018-07-23 22:26:05 +0200660/* message cannot have length of 0 */
661#define I2C_AQ_NO_ZERO_LEN_READ BIT(5)
662#define I2C_AQ_NO_ZERO_LEN_WRITE BIT(6)
663#define I2C_AQ_NO_ZERO_LEN (I2C_AQ_NO_ZERO_LEN_READ | I2C_AQ_NO_ZERO_LEN_WRITE)
Wolfram Sang2187f032015-01-05 15:35:39 +0100664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665/*
666 * i2c_adapter is the structure used to identify a physical i2c bus along
667 * with the access algorithms necessary to access it.
668 */
669struct i2c_adapter {
670 struct module *owner;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200671 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200672 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 void *algo_data;
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 /* data fields that are valid for all devices */
Peter Rosind1ed7982016-08-25 23:07:01 +0200676 const struct i2c_lock_operations *lock_ops;
Mika Kuoppala194684e2009-12-06 17:06:22 +0100677 struct rt_mutex bus_lock;
Peter Rosin6ef91fc2016-05-04 22:15:29 +0200678 struct rt_mutex mux_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Jean Delvarecd97f392009-02-24 19:19:49 +0100680 int timeout; /* in jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 int retries;
682 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 int nr;
David Brownell2096b952007-05-01 23:26:28 +0200685 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 struct completion dev_released;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200687
Jean Delvaredafc50d2010-08-11 18:21:01 +0200688 struct mutex userspace_clients_lock;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200689 struct list_head userspace_clients;
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530690
691 struct i2c_bus_recovery_info *bus_recovery_info;
Wolfram Sang2187f032015-01-05 15:35:39 +0100692 const struct i2c_adapter_quirks *quirks;
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200693
694 struct irq_domain *host_notify_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695};
David Brownellef2c83212007-05-01 23:26:28 +0200696#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Jean Delvare7d1d8992008-10-22 20:21:31 +0200698static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200700 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
Jean Delvare3ae70de2008-10-22 20:21:32 +0200703static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200705 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706}
707
Jean Delvare97cc4d42010-10-24 18:16:57 +0200708static inline struct i2c_adapter *
709i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
Michael Lawnick08263742010-08-11 18:21:02 +0200710{
Stephen Warren2fac2b82014-01-13 14:29:04 -0700711#if IS_ENABLED(CONFIG_I2C_MUX)
Jean Delvare97cc4d42010-10-24 18:16:57 +0200712 struct device *parent = adapter->dev.parent;
713
714 if (parent != NULL && parent->type == &i2c_adapter_type)
715 return to_i2c_adapter(parent);
716 else
Phil Carmody39231722013-06-26 10:56:35 +0300717#endif
Jean Delvare97cc4d42010-10-24 18:16:57 +0200718 return NULL;
Michael Lawnick08263742010-08-11 18:21:02 +0200719}
720
Jean Delvare7ae31482011-03-20 14:50:52 +0100721int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));
722
Jean Delvarefe61e072010-08-11 18:20:58 +0200723/* Adapter locking functions, exported for shared pin cases */
Peter Rosin8320f492016-05-04 22:15:27 +0200724#define I2C_LOCK_ROOT_ADAPTER BIT(0)
725#define I2C_LOCK_SEGMENT BIT(1)
726
727/**
728 * i2c_lock_bus - Get exclusive access to an I2C bus segment
729 * @adapter: Target I2C bus segment
730 * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
731 * locks only this branch in the adapter tree
732 */
733static inline void
734i2c_lock_bus(struct i2c_adapter *adapter, unsigned int flags)
735{
Peter Rosind1ed7982016-08-25 23:07:01 +0200736 adapter->lock_ops->lock_bus(adapter, flags);
Peter Rosin8320f492016-05-04 22:15:27 +0200737}
738
739/**
Peter Rosinfb79e092016-06-29 15:04:03 +0200740 * i2c_trylock_bus - Try to get exclusive access to an I2C bus segment
741 * @adapter: Target I2C bus segment
742 * @flags: I2C_LOCK_ROOT_ADAPTER tries to locks the root i2c adapter,
743 * I2C_LOCK_SEGMENT tries to lock only this branch in the adapter tree
744 *
745 * Return: true if the I2C bus segment is locked, false otherwise
746 */
747static inline int
748i2c_trylock_bus(struct i2c_adapter *adapter, unsigned int flags)
749{
Peter Rosind1ed7982016-08-25 23:07:01 +0200750 return adapter->lock_ops->trylock_bus(adapter, flags);
Peter Rosinfb79e092016-06-29 15:04:03 +0200751}
752
753/**
Peter Rosin8320f492016-05-04 22:15:27 +0200754 * i2c_unlock_bus - Release exclusive access to an I2C bus segment
755 * @adapter: Target I2C bus segment
756 * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
757 * unlocks only this branch in the adapter tree
758 */
759static inline void
760i2c_unlock_bus(struct i2c_adapter *adapter, unsigned int flags)
761{
Peter Rosind1ed7982016-08-25 23:07:01 +0200762 adapter->lock_ops->unlock_bus(adapter, flags);
Peter Rosin8320f492016-05-04 22:15:27 +0200763}
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/*flags for the client struct: */
Wolfram Sangc5ebb382015-05-19 17:44:31 +0200766#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
767#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
David Brownell3bbb8352007-10-13 23:56:29 +0200768 /* Must equal I2C_M_TEN below */
Wolfram Sangc5ebb382015-05-19 17:44:31 +0200769#define I2C_CLIENT_SLAVE 0x20 /* we are the slave */
Dmitry Torokhov331c3422017-01-04 20:57:22 -0800770#define I2C_CLIENT_HOST_NOTIFY 0x40 /* We want to use I2C host notify */
Wolfram Sangc5ebb382015-05-19 17:44:31 +0200771#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
772#define I2C_CLIENT_SCCB 0x9000 /* Use Omnivision SCCB protocol */
Laurent Pinchartd47726c2012-07-24 14:13:59 +0200773 /* Must match I2C_M_STOP|IGNORE_NAK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
775/* i2c adapter classes (bitmask) */
776#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
Jean Delvarec1b6b4f2008-07-14 22:38:28 +0200777#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Jean Delvare774466a2011-05-25 20:43:32 +0200778#define I2C_CLASS_SPD (1<<7) /* Memory modules */
Wolfram Sang9c800342017-07-29 14:11:43 +0200779/* Warn users that the adapter doesn't support classes anymore */
780#define I2C_CLASS_DEPRECATED (1<<8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782/* Internal numbers to terminate lists */
783#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Hans Verkuilc7036672009-06-19 16:58:21 +0200785/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
786#define I2C_ADDRS(addr, addrs...) \
787 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
790/* ----- functions exported by i2c.o */
791
792/* administration...
793 */
Stefan Lengfeld901a891f2017-11-01 21:06:41 +0100794#if IS_ENABLED(CONFIG_I2C)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795extern int i2c_add_adapter(struct i2c_adapter *);
Lars-Peter Clausen71546302013-03-09 08:16:47 +0000796extern void i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200797extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800799extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200800extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400802/* use a define to avoid include chaining to get THIS_MODULE */
803#define i2c_add_driver(driver) \
804 i2c_register_driver(THIS_MODULE, driver)
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800805
Jean Delvaree48d3312008-01-27 18:14:48 +0100806extern struct i2c_client *i2c_use_client(struct i2c_client *client);
807extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
809/* call the i2c_client->command() of all attached clients with
810 * the given arguments */
811extern void i2c_clients_command(struct i2c_adapter *adap,
812 unsigned int cmd, void *arg);
813
Jean Delvared735b342011-03-20 14:50:52 +0100814extern struct i2c_adapter *i2c_get_adapter(int nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815extern void i2c_put_adapter(struct i2c_adapter *adap);
Bartosz Golaszewski8dd1fe12016-09-16 18:02:42 +0200816extern unsigned int i2c_adapter_depth(struct i2c_adapter *adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Wolfram Sange1dba012015-12-08 10:37:46 +0100818void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820/* Return the functionality mask */
821static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
822{
823 return adap->algo->functionality(adap);
824}
825
826/* Return 1 if adapter supports everything we need, 0 if not. */
827static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
828{
829 return (func & i2c_get_functionality(adap)) == func;
830}
831
Nicola Cornacfa576d2015-10-29 12:34:26 +0100832/**
833 * i2c_check_quirks() - Function for checking the quirk flags in an i2c adapter
834 * @adap: i2c adapter
835 * @quirks: quirk flags
836 *
837 * Return: true if the adapter has all the specified quirk flags, false if not
838 */
839static inline bool i2c_check_quirks(struct i2c_adapter *adap, u64 quirks)
840{
841 if (!adap->quirks)
842 return false;
843 return (adap->quirks->flags & quirks) == quirks;
844}
845
Jean Delvare3ae70de2008-10-22 20:21:32 +0200846/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200847static inline int i2c_adapter_id(struct i2c_adapter *adap)
848{
849 return adap->nr;
850}
Lars-Peter Clausen7c927842011-11-16 10:13:36 +0100851
Wolfram Sanga16d6eb2016-04-03 20:44:45 +0200852static inline u8 i2c_8bit_addr_from_msg(const struct i2c_msg *msg)
853{
854 return (msg->addr << 1) | (msg->flags & I2C_M_RD ? 1 : 0);
855}
856
Wolfram Sange94bc5d2017-11-04 21:20:02 +0100857u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold);
Wolfram Sang82fe39a2018-08-24 16:52:44 +0200858void i2c_put_dma_safe_msg_buf(u8 *buf, struct i2c_msg *msg, bool xferred);
Wolfram Sange94bc5d2017-11-04 21:20:02 +0100859
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200860int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr);
Lars-Peter Clausen7c927842011-11-16 10:13:36 +0100861/**
Paul Gortmakerc698d632015-12-13 15:33:19 -0500862 * module_i2c_driver() - Helper macro for registering a modular I2C driver
Lars-Peter Clausen7c927842011-11-16 10:13:36 +0100863 * @__i2c_driver: i2c_driver struct
864 *
865 * Helper macro for I2C drivers which do not do anything special in module
866 * init/exit. This eliminates a lot of boilerplate. Each module may only
867 * use this macro once, and calling it replaces module_init() and module_exit()
868 */
869#define module_i2c_driver(__i2c_driver) \
870 module_driver(__i2c_driver, i2c_add_driver, \
871 i2c_del_driver)
872
Paul Gortmakerc698d632015-12-13 15:33:19 -0500873/**
874 * builtin_i2c_driver() - Helper macro for registering a builtin I2C driver
875 * @__i2c_driver: i2c_driver struct
876 *
877 * Helper macro for I2C drivers which do not do anything special in their
878 * init. This eliminates a lot of boilerplate. Each driver may only
879 * use this macro once, and calling it replaces device_initcall().
880 */
881#define builtin_i2c_driver(__i2c_driver) \
882 builtin_driver(__i2c_driver, i2c_add_driver)
883
Jean Delvare23af8402009-06-19 16:58:20 +0200884#endif /* I2C */
Mika Westerberg907ddf82012-11-23 12:23:40 +0100885
Wolfram Sang687b81d2013-07-11 12:56:15 +0100886#if IS_ENABLED(CONFIG_OF)
887/* must call put_device() when done with returned i2c_client device */
888extern struct i2c_client *of_find_i2c_device_by_node(struct device_node *node);
889
890/* must call put_device() when done with returned i2c_adapter device */
891extern struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node);
892
Vladimir Zapolskiy48e97432015-07-27 17:30:50 +0300893/* must call i2c_put_adapter() when done with returned i2c_adapter device */
894struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node);
Wolfram Sange1dba012015-12-08 10:37:46 +0100895
Lee Jones298d4de2016-11-07 12:47:38 +0000896extern const struct of_device_id
897*i2c_of_match_device(const struct of_device_id *matches,
898 struct i2c_client *client);
899
Boris Brezillonda0086d2018-03-25 14:49:03 +0200900int of_i2c_get_board_info(struct device *dev, struct device_node *node,
901 struct i2c_board_info *info);
902
Wolfram Sang687b81d2013-07-11 12:56:15 +0100903#else
904
905static inline struct i2c_client *of_find_i2c_device_by_node(struct device_node *node)
906{
907 return NULL;
908}
909
910static inline struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node)
911{
912 return NULL;
913}
Vladimir Zapolskiy48e97432015-07-27 17:30:50 +0300914
915static inline struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node)
916{
917 return NULL;
918}
Lee Jones298d4de2016-11-07 12:47:38 +0000919
920static inline const struct of_device_id
921*i2c_of_match_device(const struct of_device_id *matches,
922 struct i2c_client *client)
923{
924 return NULL;
925}
926
Boris Brezillonda0086d2018-03-25 14:49:03 +0200927static inline int of_i2c_get_board_info(struct device *dev,
928 struct device_node *node,
929 struct i2c_board_info *info)
930{
931 return -ENOTSUPP;
932}
933
Wolfram Sang687b81d2013-07-11 12:56:15 +0100934#endif /* CONFIG_OF */
935
Jarkko Nikula5853b222016-08-12 17:02:53 +0300936#if IS_ENABLED(CONFIG_ACPI)
937u32 i2c_acpi_find_bus_speed(struct device *dev);
Hans de Goede605f8fc2017-04-05 00:03:33 +0200938struct i2c_client *i2c_acpi_new_device(struct device *dev, int index,
939 struct i2c_board_info *info);
Jarkko Nikula5853b222016-08-12 17:02:53 +0300940#else
941static inline u32 i2c_acpi_find_bus_speed(struct device *dev)
942{
943 return 0;
944}
Hans de Goede605f8fc2017-04-05 00:03:33 +0200945static inline struct i2c_client *i2c_acpi_new_device(struct device *dev,
946 int index, struct i2c_board_info *info)
947{
948 return NULL;
949}
Jarkko Nikula5853b222016-08-12 17:02:53 +0300950#endif /* CONFIG_ACPI */
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952#endif /* _LINUX_I2C_H */