blob: 195d8b3d9cfbf9b9363367f5604aaec029c68e20 [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> */
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#ifndef _LINUX_I2C_H
28#define _LINUX_I2C_H
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/types.h>
David Brownell438d6c22006-12-10 21:21:31 +010031#ifdef __KERNEL__
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020032#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080034#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010035#include <linux/mutex.h>
Grant Likelyd12d42f2010-04-13 16:12:28 -070036#include <linux/of.h> /* for struct device_node */
Jonathan Cameron06a67842011-10-30 13:47:25 +010037#include <linux/swab.h> /* for swab16 */
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;
Jon Smirle9ca9eb2008-07-14 22:38:35 +020041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* --- General options ------------------------------------------------ */
43
44struct i2c_msg;
45struct i2c_algorithm;
46struct i2c_adapter;
47struct i2c_client;
48struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020050struct i2c_board_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Paul Gortmakerde477252011-05-26 13:46:22 -040052struct module;
53
Jean Delvare23af8402009-06-19 16:58:20 +020054#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
56 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010057 * on a bus (or read from them). Apart from two basic transfer functions to
58 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * transmit an arbitrary number of messages without interruption.
Zhangfei Gao0c43ea52010-03-02 12:23:49 +010060 * @count must be be less than 64k since msg.len is u16.
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 */
Jean Delvare0cc43a12011-01-10 22:11:23 +010062extern int i2c_master_send(const struct i2c_client *client, const char *buf,
Jean Delvare3ae70de2008-10-22 20:21:32 +020063 int count);
Jean Delvare0cc43a12011-01-10 22:11:23 +010064extern int i2c_master_recv(const struct i2c_client *client, char *buf,
65 int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67/* Transfer num messages.
68 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020069extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
70 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72/* This is the very generalized SMBus access routine. You probably do not
73 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +010074 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 Note that we use i2c_adapter here, because you do not need a specific
76 smbus adapter to call this function. */
Jean Delvare3ae70de2008-10-22 20:21:32 +020077extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
78 unsigned short flags, char read_write, u8 command,
79 int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +020082 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
Jean Delvare0cc43a12011-01-10 22:11:23 +010084extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
85extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
86extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
87 u8 command);
88extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +020089 u8 command, u8 value);
Jean Delvare0cc43a12011-01-10 22:11:23 +010090extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
91 u8 command);
92extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +020093 u8 command, u16 value);
Jonathan Cameron06a67842011-10-30 13:47:25 +010094
95static inline s32
96i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
97{
98 s32 value = i2c_smbus_read_word_data(client, command);
99
100 return (value < 0) ? value : swab16(value);
101}
102
103static inline s32
104i2c_smbus_write_word_swapped(const struct i2c_client *client,
105 u8 command, u16 value)
106{
107 return i2c_smbus_write_word_data(client, command, swab16(value));
108}
109
Jean Delvareb86a1bc2007-05-01 23:26:34 +0200110/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +0100111extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
Jean Delvareb86a1bc2007-05-01 23:26:34 +0200112 u8 command, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100113extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200114 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +0200115/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +0100116extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +0200117 u8 command, u8 length, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100118extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +1100119 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +0200120 const u8 *values);
Jean Delvare23af8402009-06-19 16:58:20 +0200121#endif /* I2C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Jean Delvare4735c982008-07-14 22:38:36 +0200123/**
124 * struct i2c_driver - represent an I2C device driver
125 * @class: What kind of i2c device we instantiate (for detect)
Jean Delvarefe6fc252011-03-20 14:50:53 +0100126 * @attach_adapter: Callback for bus addition (deprecated)
127 * @detach_adapter: Callback for bus removal (deprecated)
Jean Delvare729d6dd2009-06-19 16:58:18 +0200128 * @probe: Callback for device binding
129 * @remove: Callback for device unbinding
Jean Delvare96e21e42008-08-28 08:33:23 +0200130 * @shutdown: Callback for device shutdown
131 * @suspend: Callback for device suspend
132 * @resume: Callback for device resume
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700133 * @alert: Alert callback, for example for the SMBus alert protocol
Jean Delvare96e21e42008-08-28 08:33:23 +0200134 * @command: Callback for bus-wide signaling (optional)
135 * @driver: Device driver model driver
136 * @id_table: List of I2C devices supported by this driver
Jean Delvare4735c982008-07-14 22:38:36 +0200137 * @detect: Callback for device detection
Jean Delvarec3813d62009-12-14 21:17:25 +0100138 * @address_list: The I2C addresses to probe (for detect)
Jean Delvare4735c982008-07-14 22:38:36 +0200139 * @clients: List of detected clients we created (for i2c-core use only)
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100140 *
141 * The driver.owner field should be set to the module owner of this driver.
142 * The driver.name field should be set to the name of this driver.
Jean Delvare4735c982008-07-14 22:38:36 +0200143 *
144 * For automatic device detection, both @detect and @address_data must
145 * be defined. @class should also be set, otherwise only devices forced
146 * with module parameters will be created. The detect function must
147 * fill at least the name field of the i2c_board_info structure it is
148 * handed upon successful detection, and possibly also the flags field.
149 *
150 * If @detect is missing, the driver will still work fine for enumerated
151 * devices. Detected devices simply won't be supported. This is expected
152 * for the many I2C/SMBus devices which can't be detected reliably, and
153 * the ones which can always be enumerated in practice.
154 *
155 * The i2c_client structure which is handed to the @detect callback is
156 * not a real i2c_client. It is initialized just enough so that you can
157 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
158 * else with it. In particular, calling dev_dbg and friends on it is
159 * not allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Jean Delvare729d6dd2009-06-19 16:58:18 +0200164 /* Notifies the driver that a new bus has appeared or is about to be
Jean Delvarefe6fc252011-03-20 14:50:53 +0100165 * removed. You should avoid using this, it will be removed in a
166 * near future.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 */
Jean Delvarefe6fc252011-03-20 14:50:53 +0100168 int (*attach_adapter)(struct i2c_adapter *) __deprecated;
169 int (*detach_adapter)(struct i2c_adapter *) __deprecated;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Jean Delvare729d6dd2009-06-19 16:58:18 +0200171 /* Standard driver model interfaces */
Jean Delvared2653e92008-04-29 23:11:39 +0200172 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200173 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200174
David Brownellf37dd802007-02-13 22:09:00 +0100175 /* driver model interfaces that don't relate to enumeration */
176 void (*shutdown)(struct i2c_client *);
177 int (*suspend)(struct i2c_client *, pm_message_t mesg);
178 int (*resume)(struct i2c_client *);
179
Jean Delvareb5527a72010-03-02 12:23:42 +0100180 /* Alert callback, for example for the SMBus alert protocol.
181 * The format and meaning of the data value depends on the protocol.
182 * For the SMBus alert protocol, there is a single bit of data passed
183 * as the alert response's low bit ("event flag").
184 */
185 void (*alert)(struct i2c_client *, unsigned int data);
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 /* a ioctl like command that can be used to perform specific functions
188 * with the device.
189 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200190 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200193 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200194
195 /* Device detection callback for automatic device creation */
Jean Delvare310ec792009-12-14 21:17:23 +0100196 int (*detect)(struct i2c_client *, struct i2c_board_info *);
Jean Delvarec3813d62009-12-14 21:17:25 +0100197 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +0200198 struct list_head clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199};
200#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
201
David Brownell2096b952007-05-01 23:26:28 +0200202/**
203 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200204 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
205 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
David Brownell2096b952007-05-01 23:26:28 +0200206 * @addr: Address used on the I2C bus connected to the parent adapter.
207 * @name: Indicates the type of the device, usually a chip name that's
208 * generic enough to hide second-sourcing and compatible revisions.
David Brownelld64f73b2007-07-12 14:12:28 +0200209 * @adapter: manages the bus segment hosting this I2C device
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700210 * @driver: device's driver, hence pointer to access routines
David Brownell2096b952007-05-01 23:26:28 +0200211 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200212 * @irq: indicates the IRQ generated by this device (if any)
Jean Delvare99cd8e22009-06-19 16:58:20 +0200213 * @detected: member of an i2c_driver.clients list or i2c-core's
214 * userspace_devices list
David Brownell2096b952007-05-01 23:26:28 +0200215 *
216 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200217 * i2c bus. The behaviour exposed to Linux is defined by the driver
218 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 */
220struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200221 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100222 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200224 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200225 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 struct i2c_adapter *adapter; /* the adapter we sit on */
227 struct i2c_driver *driver; /* and our access routines */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200229 int irq; /* irq issued by device */
Jean Delvare4735c982008-07-14 22:38:36 +0200230 struct list_head detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231};
232#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
233
David Brownell9b766b82008-01-27 18:14:51 +0100234extern struct i2c_client *i2c_verify_client(struct device *dev);
235
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500236static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
237{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200238 struct device * const dev = container_of(kobj, struct device, kobj);
239 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500240}
241
Jean Delvare7d1d8992008-10-22 20:21:31 +0200242static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200244 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245}
246
Jean Delvare3ae70de2008-10-22 20:21:32 +0200247static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200249 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
David Brownell9c1600e2007-05-01 23:26:31 +0200252/**
253 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200254 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200255 * @flags: to initialize i2c_client.flags
256 * @addr: stored in i2c_client.addr
257 * @platform_data: stored in i2c_client.dev.platform_data
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200258 * @archdata: copied into i2c_client.dev.archdata
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700259 * @of_node: pointer to OpenFirmware device node
David Brownell9c1600e2007-05-01 23:26:31 +0200260 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200261 *
David Brownell9c1600e2007-05-01 23:26:31 +0200262 * I2C doesn't actually support hardware probing, although controllers and
263 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
264 * a device at a given address. Drivers commonly need more information than
265 * that, such as chip type, configuration, associated IRQ, and so on.
266 *
267 * i2c_board_info is used to build tables of information listing I2C devices
Jean Delvare729d6dd2009-06-19 16:58:18 +0200268 * that are present. This information is used to grow the driver model tree.
269 * For mainboards this is done statically using i2c_register_board_info();
270 * bus numbers identify adapters that aren't yet available. For add-on boards,
271 * i2c_new_device() does this dynamically with the adapter already known.
David Brownell9c1600e2007-05-01 23:26:31 +0200272 */
273struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200274 char type[I2C_NAME_SIZE];
275 unsigned short flags;
276 unsigned short addr;
277 void *platform_data;
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200278 struct dev_archdata *archdata;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700279 struct device_node *of_node;
David Brownell9c1600e2007-05-01 23:26:31 +0200280 int irq;
281};
282
283/**
Jean Delvare3760f732008-04-29 23:11:40 +0200284 * I2C_BOARD_INFO - macro used to list an i2c device and its address
285 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200286 * @dev_addr: the device's address on the bus.
287 *
288 * This macro initializes essential fields of a struct i2c_board_info,
289 * declaring what has been provided on a particular board. Optional
Jean Delvare3760f732008-04-29 23:11:40 +0200290 * fields (such as associated irq, or device-specific platform_data)
291 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200292 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200293#define I2C_BOARD_INFO(dev_type, dev_addr) \
Ben Hutchingsc758e8c2009-04-13 17:02:14 +0200294 .type = dev_type, .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200295
296
Jean Delvare23af8402009-06-19 16:58:20 +0200297#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
David Brownell9c1600e2007-05-01 23:26:31 +0200298/* Add-on boards should register/unregister their devices; e.g. a board
299 * with integrated I2C, a config eeprom, sensors, and a codec that's
300 * used in conjunction with the primary hardware.
301 */
302extern struct i2c_client *
303i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
304
Jean Delvare12b5053a2007-05-01 23:26:31 +0200305/* If you don't know the exact address of an I2C device, use this variant
306 * instead, which can probe for device presence in a list of possible
Jean Delvare9a942412010-08-11 18:20:56 +0200307 * addresses. The "probe" callback function is optional. If it is provided,
308 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
309 * a default probing method is used.
Jean Delvare12b5053a2007-05-01 23:26:31 +0200310 */
311extern struct i2c_client *
312i2c_new_probed_device(struct i2c_adapter *adap,
313 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +0200314 unsigned short const *addr_list,
315 int (*probe)(struct i2c_adapter *, unsigned short addr));
Jean Delvare12b5053a2007-05-01 23:26:31 +0200316
Jean Delvared44f19d2010-08-11 18:20:57 +0200317/* Common custom probe functions */
318extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
319
David Brownelle9f13732008-01-27 18:14:52 +0100320/* For devices that use several addresses, use i2c_new_dummy() to make
321 * client handles for the extra addresses.
322 */
323extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200324i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100325
David Brownell9c1600e2007-05-01 23:26:31 +0200326extern void i2c_unregister_device(struct i2c_client *);
Jean Delvare23af8402009-06-19 16:58:20 +0200327#endif /* I2C */
David Brownell9c1600e2007-05-01 23:26:31 +0200328
329/* Mainboard arch_initcall() code should register all its I2C devices.
330 * This is done at arch_initcall time, before declaring any i2c adapters.
331 * Modules for add-on boards must use other calls.
332 */
David Brownell26386762008-02-24 20:03:42 +0100333#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200334extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200335i2c_register_board_info(int busnum, struct i2c_board_info const *info,
336 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100337#else
338static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200339i2c_register_board_info(int busnum, struct i2c_board_info const *info,
340 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100341{
342 return 0;
343}
Jean Delvare23af8402009-06-19 16:58:20 +0200344#endif /* I2C_BOARDINFO */
David Brownell9c1600e2007-05-01 23:26:31 +0200345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346/*
347 * The following structs are for those who like to implement new bus drivers:
348 * i2c_algorithm is the interface to a class of hardware solutions which can
349 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
350 * to name two of the most common.
351 */
352struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100354 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 smbus_xfer. If set to NULL, the SMBus protocol is simulated
356 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200357 /* master_xfer should return the number of messages successfully
358 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200359 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
360 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100361 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200362 unsigned short flags, char read_write,
363 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 /* To determine what the adapter supports */
366 u32 (*functionality) (struct i2c_adapter *);
367};
368
369/*
370 * i2c_adapter is the structure used to identify a physical i2c bus along
371 * with the access algorithms necessary to access it.
372 */
373struct i2c_adapter {
374 struct module *owner;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200375 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200376 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 void *algo_data;
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 /* data fields that are valid for all devices */
Mika Kuoppala194684e2009-12-06 17:06:22 +0100380 struct rt_mutex bus_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Jean Delvarecd97f392009-02-24 19:19:49 +0100382 int timeout; /* in jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 int retries;
384 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 int nr;
David Brownell2096b952007-05-01 23:26:28 +0200387 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 struct completion dev_released;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200389
Jean Delvaredafc50d2010-08-11 18:21:01 +0200390 struct mutex userspace_clients_lock;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200391 struct list_head userspace_clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392};
David Brownellef2c83212007-05-01 23:26:28 +0200393#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Jean Delvare7d1d8992008-10-22 20:21:31 +0200395static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200397 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
399
Jean Delvare3ae70de2008-10-22 20:21:32 +0200400static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200402 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403}
404
Jean Delvare97cc4d42010-10-24 18:16:57 +0200405static inline struct i2c_adapter *
406i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
Michael Lawnick08263742010-08-11 18:21:02 +0200407{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200408 struct device *parent = adapter->dev.parent;
409
410 if (parent != NULL && parent->type == &i2c_adapter_type)
411 return to_i2c_adapter(parent);
412 else
413 return NULL;
Michael Lawnick08263742010-08-11 18:21:02 +0200414}
415
Jean Delvare7ae31482011-03-20 14:50:52 +0100416int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));
417
Jean Delvarefe61e072010-08-11 18:20:58 +0200418/* Adapter locking functions, exported for shared pin cases */
419void i2c_lock_adapter(struct i2c_adapter *);
420void i2c_unlock_adapter(struct i2c_adapter *);
Jean Delvareafa08972009-11-07 13:10:46 +0100421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/*flags for the client struct: */
David Brownell3bbb8352007-10-13 23:56:29 +0200423#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
424#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
425 /* Must equal I2C_M_TEN below */
426#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
428/* i2c adapter classes (bitmask) */
429#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
Jean Delvarec1b6b4f2008-07-14 22:38:28 +0200430#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Jean Delvare774466a2011-05-25 20:43:32 +0200431#define I2C_CLASS_SPD (1<<7) /* Memory modules */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433/* Internal numbers to terminate lists */
434#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Hans Verkuilc7036672009-06-19 16:58:21 +0200436/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
437#define I2C_ADDRS(addr, addrs...) \
438 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
441/* ----- functions exported by i2c.o */
442
443/* administration...
444 */
Jean Delvare23af8402009-06-19 16:58:20 +0200445#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446extern int i2c_add_adapter(struct i2c_adapter *);
447extern int i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200448extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800450extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200451extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400453/* use a define to avoid include chaining to get THIS_MODULE */
454#define i2c_add_driver(driver) \
455 i2c_register_driver(THIS_MODULE, driver)
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800456
Jean Delvaree48d3312008-01-27 18:14:48 +0100457extern struct i2c_client *i2c_use_client(struct i2c_client *client);
458extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460/* call the i2c_client->command() of all attached clients with
461 * the given arguments */
462extern void i2c_clients_command(struct i2c_adapter *adap,
463 unsigned int cmd, void *arg);
464
Jean Delvared735b342011-03-20 14:50:52 +0100465extern struct i2c_adapter *i2c_get_adapter(int nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466extern void i2c_put_adapter(struct i2c_adapter *adap);
467
468
469/* Return the functionality mask */
470static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
471{
472 return adap->algo->functionality(adap);
473}
474
475/* Return 1 if adapter supports everything we need, 0 if not. */
476static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
477{
478 return (func & i2c_get_functionality(adap)) == func;
479}
480
Jean Delvare3ae70de2008-10-22 20:21:32 +0200481/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200482static inline int i2c_adapter_id(struct i2c_adapter *adap)
483{
484 return adap->nr;
485}
Lars-Peter Clausen7c927842011-11-16 10:13:36 +0100486
487/**
488 * module_i2c_driver() - Helper macro for registering a I2C driver
489 * @__i2c_driver: i2c_driver struct
490 *
491 * Helper macro for I2C drivers which do not do anything special in module
492 * init/exit. This eliminates a lot of boilerplate. Each module may only
493 * use this macro once, and calling it replaces module_init() and module_exit()
494 */
495#define module_i2c_driver(__i2c_driver) \
496 module_driver(__i2c_driver, i2c_add_driver, \
497 i2c_del_driver)
498
Jean Delvare23af8402009-06-19 16:58:20 +0200499#endif /* I2C */
David Woodhousea1b92982006-04-25 14:14:52 +0100500#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200501
David Brownella64ec072007-10-13 23:56:31 +0200502/**
503 * struct i2c_msg - an I2C transaction segment beginning with START
504 * @addr: Slave address, either seven or ten bits. When this is a ten
505 * bit address, I2C_M_TEN must be set in @flags and the adapter
506 * must support I2C_FUNC_10BIT_ADDR.
507 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
508 * provided unless the adapter exported the relevant I2C_FUNC_*
509 * flags through i2c_check_functionality().
510 * @len: Number of data bytes in @buf being read from or written to the
511 * I2C slave address. For read transactions where I2C_M_RECV_LEN
512 * is set, the caller guarantees that this buffer can hold up to
513 * 32 bytes in addition to the initial length byte sent by the
514 * slave (plus, if used, the SMBus PEC); and this value will be
515 * incremented by the number of block data bytes received.
516 * @buf: The buffer into which data is read, or from which it's written.
517 *
518 * An i2c_msg is the low level representation of one segment of an I2C
519 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
520 * to userspace from i2c-dev, and to I2C adapter drivers through the
521 * @i2c_adapter.@master_xfer() method.
522 *
523 * Except when I2C "protocol mangling" is used, all I2C adapters implement
524 * the standard rules for I2C transactions. Each transaction begins with a
525 * START. That is followed by the slave address, and a bit encoding read
526 * versus write. Then follow all the data bytes, possibly including a byte
527 * with SMBus PEC. The transfer terminates with a NAK, or when all those
528 * bytes have been transferred and ACKed. If this is the last message in a
529 * group, it is followed by a STOP. Otherwise it is followed by the next
530 * @i2c_msg transaction segment, beginning with a (repeated) START.
531 *
532 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
533 * passing certain @flags may have changed those standard protocol behaviors.
534 * Those flags are only for use with broken/nonconforming slaves, and with
535 * adapters which are known to support the specific mangling options they
536 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
538struct i2c_msg {
539 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100540 __u16 flags;
David Brownella64ec072007-10-13 23:56:31 +0200541#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
542#define I2C_M_RD 0x0001 /* read data, from slave to master */
543#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
544#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
545#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
546#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
547#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
David Brownell438d6c22006-12-10 21:21:31 +0100548 __u16 len; /* msg length */
549 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550};
551
552/* To determine what functionality is present */
553
554#define I2C_FUNC_I2C 0x00000001
555#define I2C_FUNC_10BIT_ADDR 0x00000002
Jean Delvare3ae70de2008-10-22 20:21:32 +0200556#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
David Brownell6662cbb2007-10-13 23:56:33 +0200557#define I2C_FUNC_SMBUS_PEC 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100559#define I2C_FUNC_SMBUS_QUICK 0x00010000
560#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
561#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
562#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
563#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
564#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
565#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
566#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
567#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
568#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
570#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Jean Delvare3ae70de2008-10-22 20:21:32 +0200572#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
573 I2C_FUNC_SMBUS_WRITE_BYTE)
574#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
575 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
576#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
577 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
578#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
579 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
580#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
581 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Jean Delvare3ae70de2008-10-22 20:21:32 +0200583#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
584 I2C_FUNC_SMBUS_BYTE | \
585 I2C_FUNC_SMBUS_BYTE_DATA | \
586 I2C_FUNC_SMBUS_WORD_DATA | \
587 I2C_FUNC_SMBUS_PROC_CALL | \
588 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
589 I2C_FUNC_SMBUS_I2C_BLOCK | \
590 I2C_FUNC_SMBUS_PEC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
David Brownell438d6c22006-12-10 21:21:31 +0100592/*
593 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
David Brownell438d6c22006-12-10 21:21:31 +0100595#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596union i2c_smbus_data {
597 __u8 byte;
598 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200599 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200600 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601};
602
Jean Delvareae7193f2008-07-14 22:38:24 +0200603/* i2c_smbus_xfer read or write markers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604#define I2C_SMBUS_READ 1
605#define I2C_SMBUS_WRITE 0
606
David Brownell438d6c22006-12-10 21:21:31 +0100607/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
609#define I2C_SMBUS_QUICK 0
610#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100611#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612#define I2C_SMBUS_WORD_DATA 3
613#define I2C_SMBUS_PROC_CALL 4
614#define I2C_SMBUS_BLOCK_DATA 5
Jean Delvare4b2643d2007-07-12 14:12:29 +0200615#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Jean Delvare4b2643d2007-07-12 14:12:29 +0200617#define I2C_SMBUS_I2C_BLOCK_DATA 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619#endif /* _LINUX_I2C_H */