blob: 798bad8741e464a8cc89b2549be6d89695f4a38d [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
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
21/* ------------------------------------------------------------------------- */
22
David Woodhousea1b92982006-04-25 14:14:52 +010023/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 Frodo Looijaard <frodol@dds.nl> */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/types.h>
David Brownell438d6c22006-12-10 21:21:31 +010030#ifdef __KERNEL__
David Woodhousea1b92982006-04-25 14:14:52 +010031#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/i2c-id.h>
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020033#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080035#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010036#include <linux/mutex.h>
Grant Likelyd12d42f2010-04-13 16:12:28 -070037#include <linux/of.h> /* for struct device_node */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jon Smirle9ca9eb2008-07-14 22:38:35 +020039extern struct bus_type i2c_bus_type;
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041/* --- General options ------------------------------------------------ */
42
43struct i2c_msg;
44struct i2c_algorithm;
45struct i2c_adapter;
46struct i2c_client;
47struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020049struct i2c_board_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Jean Delvare23af8402009-06-19 16:58:20 +020051#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
53 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010054 * on a bus (or read from them). Apart from two basic transfer functions to
55 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * transmit an arbitrary number of messages without interruption.
Zhangfei Gao0c43ea52010-03-02 12:23:49 +010057 * @count must be be less than 64k since msg.len is u16.
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020059extern int i2c_master_send(struct i2c_client *client, const char *buf,
60 int count);
61extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/* Transfer num messages.
64 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020065extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
66 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68/* This is the very generalized SMBus access routine. You probably do not
69 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +010070 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 Note that we use i2c_adapter here, because you do not need a specific
72 smbus adapter to call this function. */
Jean Delvare3ae70de2008-10-22 20:21:32 +020073extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
74 unsigned short flags, char read_write, u8 command,
75 int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +020078 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Jean Delvare3ae70de2008-10-22 20:21:32 +020080extern s32 i2c_smbus_read_byte(struct i2c_client *client);
81extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
82extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
83extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
84 u8 command, u8 value);
85extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
86extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
87 u8 command, u16 value);
Jean Delvareb86a1bc2007-05-01 23:26:34 +020088/* Returns the number of read bytes */
89extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
90 u8 command, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020091extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
92 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +020093/* Returns the number of read bytes */
Jean Delvare3ae70de2008-10-22 20:21:32 +020094extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +020095 u8 command, u8 length, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020096extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +110097 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +020098 const u8 *values);
Jean Delvare23af8402009-06-19 16:58:20 +020099#endif /* I2C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Jean Delvare4735c982008-07-14 22:38:36 +0200101/**
102 * struct i2c_driver - represent an I2C device driver
103 * @class: What kind of i2c device we instantiate (for detect)
Jean Delvare96e21e42008-08-28 08:33:23 +0200104 * @attach_adapter: Callback for bus addition (for legacy drivers)
105 * @detach_adapter: Callback for bus removal (for legacy drivers)
Jean Delvare729d6dd2009-06-19 16:58:18 +0200106 * @probe: Callback for device binding
107 * @remove: Callback for device unbinding
Jean Delvare96e21e42008-08-28 08:33:23 +0200108 * @shutdown: Callback for device shutdown
109 * @suspend: Callback for device suspend
110 * @resume: Callback for device resume
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700111 * @alert: Alert callback, for example for the SMBus alert protocol
Jean Delvare96e21e42008-08-28 08:33:23 +0200112 * @command: Callback for bus-wide signaling (optional)
113 * @driver: Device driver model driver
114 * @id_table: List of I2C devices supported by this driver
Jean Delvare4735c982008-07-14 22:38:36 +0200115 * @detect: Callback for device detection
Jean Delvarec3813d62009-12-14 21:17:25 +0100116 * @address_list: The I2C addresses to probe (for detect)
Jean Delvare4735c982008-07-14 22:38:36 +0200117 * @clients: List of detected clients we created (for i2c-core use only)
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100118 *
119 * The driver.owner field should be set to the module owner of this driver.
120 * The driver.name field should be set to the name of this driver.
Jean Delvare4735c982008-07-14 22:38:36 +0200121 *
122 * For automatic device detection, both @detect and @address_data must
123 * be defined. @class should also be set, otherwise only devices forced
124 * with module parameters will be created. The detect function must
125 * fill at least the name field of the i2c_board_info structure it is
126 * handed upon successful detection, and possibly also the flags field.
127 *
128 * If @detect is missing, the driver will still work fine for enumerated
129 * devices. Detected devices simply won't be supported. This is expected
130 * for the many I2C/SMBus devices which can't be detected reliably, and
131 * the ones which can always be enumerated in practice.
132 *
133 * The i2c_client structure which is handed to the @detect callback is
134 * not a real i2c_client. It is initialized just enough so that you can
135 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
136 * else with it. In particular, calling dev_dbg and friends on it is
137 * not allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Jean Delvare729d6dd2009-06-19 16:58:18 +0200142 /* Notifies the driver that a new bus has appeared or is about to be
143 * removed. You should avoid using this if you can, it will probably
144 * be removed in a near future.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
146 int (*attach_adapter)(struct i2c_adapter *);
147 int (*detach_adapter)(struct i2c_adapter *);
148
Jean Delvare729d6dd2009-06-19 16:58:18 +0200149 /* Standard driver model interfaces */
Jean Delvared2653e92008-04-29 23:11:39 +0200150 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200151 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200152
David Brownellf37dd802007-02-13 22:09:00 +0100153 /* driver model interfaces that don't relate to enumeration */
154 void (*shutdown)(struct i2c_client *);
155 int (*suspend)(struct i2c_client *, pm_message_t mesg);
156 int (*resume)(struct i2c_client *);
157
Jean Delvareb5527a72010-03-02 12:23:42 +0100158 /* Alert callback, for example for the SMBus alert protocol.
159 * The format and meaning of the data value depends on the protocol.
160 * For the SMBus alert protocol, there is a single bit of data passed
161 * as the alert response's low bit ("event flag").
162 */
163 void (*alert)(struct i2c_client *, unsigned int data);
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 /* a ioctl like command that can be used to perform specific functions
166 * with the device.
167 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200168 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200171 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200172
173 /* Device detection callback for automatic device creation */
Jean Delvare310ec792009-12-14 21:17:23 +0100174 int (*detect)(struct i2c_client *, struct i2c_board_info *);
Jean Delvarec3813d62009-12-14 21:17:25 +0100175 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +0200176 struct list_head clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177};
178#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
179
David Brownell2096b952007-05-01 23:26:28 +0200180/**
181 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200182 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
183 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
David Brownell2096b952007-05-01 23:26:28 +0200184 * @addr: Address used on the I2C bus connected to the parent adapter.
185 * @name: Indicates the type of the device, usually a chip name that's
186 * generic enough to hide second-sourcing and compatible revisions.
David Brownelld64f73b2007-07-12 14:12:28 +0200187 * @adapter: manages the bus segment hosting this I2C device
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700188 * @driver: device's driver, hence pointer to access routines
David Brownell2096b952007-05-01 23:26:28 +0200189 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200190 * @irq: indicates the IRQ generated by this device (if any)
Jean Delvare99cd8e22009-06-19 16:58:20 +0200191 * @detected: member of an i2c_driver.clients list or i2c-core's
192 * userspace_devices list
David Brownell2096b952007-05-01 23:26:28 +0200193 *
194 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200195 * i2c bus. The behaviour exposed to Linux is defined by the driver
196 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
198struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200199 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100200 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200202 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200203 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 struct i2c_adapter *adapter; /* the adapter we sit on */
205 struct i2c_driver *driver; /* and our access routines */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200207 int irq; /* irq issued by device */
Jean Delvare4735c982008-07-14 22:38:36 +0200208 struct list_head detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
211
David Brownell9b766b82008-01-27 18:14:51 +0100212extern struct i2c_client *i2c_verify_client(struct device *dev);
213
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500214static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
215{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200216 struct device * const dev = container_of(kobj, struct device, kobj);
217 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500218}
219
Jean Delvare7d1d8992008-10-22 20:21:31 +0200220static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200222 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223}
224
Jean Delvare3ae70de2008-10-22 20:21:32 +0200225static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200227 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228}
229
David Brownell9c1600e2007-05-01 23:26:31 +0200230/**
231 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200232 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200233 * @flags: to initialize i2c_client.flags
234 * @addr: stored in i2c_client.addr
235 * @platform_data: stored in i2c_client.dev.platform_data
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200236 * @archdata: copied into i2c_client.dev.archdata
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700237 * @of_node: pointer to OpenFirmware device node
David Brownell9c1600e2007-05-01 23:26:31 +0200238 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200239 *
David Brownell9c1600e2007-05-01 23:26:31 +0200240 * I2C doesn't actually support hardware probing, although controllers and
241 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
242 * a device at a given address. Drivers commonly need more information than
243 * that, such as chip type, configuration, associated IRQ, and so on.
244 *
245 * i2c_board_info is used to build tables of information listing I2C devices
Jean Delvare729d6dd2009-06-19 16:58:18 +0200246 * that are present. This information is used to grow the driver model tree.
247 * For mainboards this is done statically using i2c_register_board_info();
248 * bus numbers identify adapters that aren't yet available. For add-on boards,
249 * i2c_new_device() does this dynamically with the adapter already known.
David Brownell9c1600e2007-05-01 23:26:31 +0200250 */
251struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200252 char type[I2C_NAME_SIZE];
253 unsigned short flags;
254 unsigned short addr;
255 void *platform_data;
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200256 struct dev_archdata *archdata;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700257#ifdef CONFIG_OF
258 struct device_node *of_node;
259#endif
David Brownell9c1600e2007-05-01 23:26:31 +0200260 int irq;
261};
262
263/**
Jean Delvare3760f732008-04-29 23:11:40 +0200264 * I2C_BOARD_INFO - macro used to list an i2c device and its address
265 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200266 * @dev_addr: the device's address on the bus.
267 *
268 * This macro initializes essential fields of a struct i2c_board_info,
269 * declaring what has been provided on a particular board. Optional
Jean Delvare3760f732008-04-29 23:11:40 +0200270 * fields (such as associated irq, or device-specific platform_data)
271 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200272 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200273#define I2C_BOARD_INFO(dev_type, dev_addr) \
Ben Hutchingsc758e8c2009-04-13 17:02:14 +0200274 .type = dev_type, .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200275
276
Jean Delvare23af8402009-06-19 16:58:20 +0200277#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
David Brownell9c1600e2007-05-01 23:26:31 +0200278/* Add-on boards should register/unregister their devices; e.g. a board
279 * with integrated I2C, a config eeprom, sensors, and a codec that's
280 * used in conjunction with the primary hardware.
281 */
282extern struct i2c_client *
283i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
284
Jean Delvare12b5053a2007-05-01 23:26:31 +0200285/* If you don't know the exact address of an I2C device, use this variant
286 * instead, which can probe for device presence in a list of possible
Jean Delvare9a942412010-08-11 18:20:56 +0200287 * addresses. The "probe" callback function is optional. If it is provided,
288 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
289 * a default probing method is used.
Jean Delvare12b5053a2007-05-01 23:26:31 +0200290 */
291extern struct i2c_client *
292i2c_new_probed_device(struct i2c_adapter *adap,
293 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +0200294 unsigned short const *addr_list,
295 int (*probe)(struct i2c_adapter *, unsigned short addr));
Jean Delvare12b5053a2007-05-01 23:26:31 +0200296
Jean Delvared44f19d2010-08-11 18:20:57 +0200297/* Common custom probe functions */
298extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
299
David Brownelle9f13732008-01-27 18:14:52 +0100300/* For devices that use several addresses, use i2c_new_dummy() to make
301 * client handles for the extra addresses.
302 */
303extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200304i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100305
David Brownell9c1600e2007-05-01 23:26:31 +0200306extern void i2c_unregister_device(struct i2c_client *);
Jean Delvare23af8402009-06-19 16:58:20 +0200307#endif /* I2C */
David Brownell9c1600e2007-05-01 23:26:31 +0200308
309/* Mainboard arch_initcall() code should register all its I2C devices.
310 * This is done at arch_initcall time, before declaring any i2c adapters.
311 * Modules for add-on boards must use other calls.
312 */
David Brownell26386762008-02-24 20:03:42 +0100313#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200314extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200315i2c_register_board_info(int busnum, struct i2c_board_info const *info,
316 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100317#else
318static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200319i2c_register_board_info(int busnum, struct i2c_board_info const *info,
320 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100321{
322 return 0;
323}
Jean Delvare23af8402009-06-19 16:58:20 +0200324#endif /* I2C_BOARDINFO */
David Brownell9c1600e2007-05-01 23:26:31 +0200325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326/*
327 * The following structs are for those who like to implement new bus drivers:
328 * i2c_algorithm is the interface to a class of hardware solutions which can
329 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
330 * to name two of the most common.
331 */
332struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100334 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 smbus_xfer. If set to NULL, the SMBus protocol is simulated
336 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200337 /* master_xfer should return the number of messages successfully
338 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200339 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
340 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100341 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200342 unsigned short flags, char read_write,
343 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 /* To determine what the adapter supports */
346 u32 (*functionality) (struct i2c_adapter *);
347};
348
349/*
350 * i2c_adapter is the structure used to identify a physical i2c bus along
351 * with the access algorithms necessary to access it.
352 */
353struct i2c_adapter {
354 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200355 unsigned int id;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200356 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200357 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 void *algo_data;
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 /* data fields that are valid for all devices */
Mika Kuoppala194684e2009-12-06 17:06:22 +0100361 struct rt_mutex bus_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Jean Delvarecd97f392009-02-24 19:19:49 +0100363 int timeout; /* in jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 int retries;
365 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 int nr;
David Brownell2096b952007-05-01 23:26:28 +0200368 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 struct completion dev_released;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200370
Jean Delvaredafc50d2010-08-11 18:21:01 +0200371 struct mutex userspace_clients_lock;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200372 struct list_head userspace_clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373};
David Brownellef2c83212007-05-01 23:26:28 +0200374#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Jean Delvare7d1d8992008-10-22 20:21:31 +0200376static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200378 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
380
Jean Delvare3ae70de2008-10-22 20:21:32 +0200381static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200383 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384}
385
Jean Delvarefe61e072010-08-11 18:20:58 +0200386/* Adapter locking functions, exported for shared pin cases */
387void i2c_lock_adapter(struct i2c_adapter *);
388void i2c_unlock_adapter(struct i2c_adapter *);
Jean Delvareafa08972009-11-07 13:10:46 +0100389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390/*flags for the client struct: */
David Brownell3bbb8352007-10-13 23:56:29 +0200391#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
392#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
393 /* Must equal I2C_M_TEN below */
394#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396/* i2c adapter classes (bitmask) */
397#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
398#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
399#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
Jean Delvarec1b6b4f2008-07-14 22:38:28 +0200400#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Jean Delvare3401b2f2008-07-14 22:38:29 +0200401#define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403/* Internal numbers to terminate lists */
404#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406/* The numbers to use to set I2C bus address */
407#define ANY_I2C_BUS 0xffff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Hans Verkuilc7036672009-06-19 16:58:21 +0200409/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
410#define I2C_ADDRS(addr, addrs...) \
411 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414/* ----- functions exported by i2c.o */
415
416/* administration...
417 */
Jean Delvare23af8402009-06-19 16:58:20 +0200418#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419extern int i2c_add_adapter(struct i2c_adapter *);
420extern int i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200421extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800423extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200424extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800426static inline int i2c_add_driver(struct i2c_driver *driver)
427{
428 return i2c_register_driver(THIS_MODULE, driver);
429}
430
Jean Delvaree48d3312008-01-27 18:14:48 +0100431extern struct i2c_client *i2c_use_client(struct i2c_client *client);
432extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434/* call the i2c_client->command() of all attached clients with
435 * the given arguments */
436extern void i2c_clients_command(struct i2c_adapter *adap,
437 unsigned int cmd, void *arg);
438
Jean Delvare3ae70de2008-10-22 20:21:32 +0200439extern struct i2c_adapter *i2c_get_adapter(int id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440extern void i2c_put_adapter(struct i2c_adapter *adap);
441
442
443/* Return the functionality mask */
444static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
445{
446 return adap->algo->functionality(adap);
447}
448
449/* Return 1 if adapter supports everything we need, 0 if not. */
450static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
451{
452 return (func & i2c_get_functionality(adap)) == func;
453}
454
Jean Delvare3ae70de2008-10-22 20:21:32 +0200455/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200456static inline int i2c_adapter_id(struct i2c_adapter *adap)
457{
458 return adap->nr;
459}
Jean Delvare23af8402009-06-19 16:58:20 +0200460#endif /* I2C */
David Woodhousea1b92982006-04-25 14:14:52 +0100461#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200462
David Brownella64ec072007-10-13 23:56:31 +0200463/**
464 * struct i2c_msg - an I2C transaction segment beginning with START
465 * @addr: Slave address, either seven or ten bits. When this is a ten
466 * bit address, I2C_M_TEN must be set in @flags and the adapter
467 * must support I2C_FUNC_10BIT_ADDR.
468 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
469 * provided unless the adapter exported the relevant I2C_FUNC_*
470 * flags through i2c_check_functionality().
471 * @len: Number of data bytes in @buf being read from or written to the
472 * I2C slave address. For read transactions where I2C_M_RECV_LEN
473 * is set, the caller guarantees that this buffer can hold up to
474 * 32 bytes in addition to the initial length byte sent by the
475 * slave (plus, if used, the SMBus PEC); and this value will be
476 * incremented by the number of block data bytes received.
477 * @buf: The buffer into which data is read, or from which it's written.
478 *
479 * An i2c_msg is the low level representation of one segment of an I2C
480 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
481 * to userspace from i2c-dev, and to I2C adapter drivers through the
482 * @i2c_adapter.@master_xfer() method.
483 *
484 * Except when I2C "protocol mangling" is used, all I2C adapters implement
485 * the standard rules for I2C transactions. Each transaction begins with a
486 * START. That is followed by the slave address, and a bit encoding read
487 * versus write. Then follow all the data bytes, possibly including a byte
488 * with SMBus PEC. The transfer terminates with a NAK, or when all those
489 * bytes have been transferred and ACKed. If this is the last message in a
490 * group, it is followed by a STOP. Otherwise it is followed by the next
491 * @i2c_msg transaction segment, beginning with a (repeated) START.
492 *
493 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
494 * passing certain @flags may have changed those standard protocol behaviors.
495 * Those flags are only for use with broken/nonconforming slaves, and with
496 * adapters which are known to support the specific mangling options they
497 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 */
499struct i2c_msg {
500 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100501 __u16 flags;
David Brownella64ec072007-10-13 23:56:31 +0200502#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
503#define I2C_M_RD 0x0001 /* read data, from slave to master */
504#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
505#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
506#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
507#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
508#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
David Brownell438d6c22006-12-10 21:21:31 +0100509 __u16 len; /* msg length */
510 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511};
512
513/* To determine what functionality is present */
514
515#define I2C_FUNC_I2C 0x00000001
516#define I2C_FUNC_10BIT_ADDR 0x00000002
Jean Delvare3ae70de2008-10-22 20:21:32 +0200517#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
David Brownell6662cbb2007-10-13 23:56:33 +0200518#define I2C_FUNC_SMBUS_PEC 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100520#define I2C_FUNC_SMBUS_QUICK 0x00010000
521#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
522#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
523#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
524#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
525#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
526#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
527#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
528#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
529#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
531#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Jean Delvare3ae70de2008-10-22 20:21:32 +0200533#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
534 I2C_FUNC_SMBUS_WRITE_BYTE)
535#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
536 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
537#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
538 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
539#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
540 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
541#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
542 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Jean Delvare3ae70de2008-10-22 20:21:32 +0200544#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
545 I2C_FUNC_SMBUS_BYTE | \
546 I2C_FUNC_SMBUS_BYTE_DATA | \
547 I2C_FUNC_SMBUS_WORD_DATA | \
548 I2C_FUNC_SMBUS_PROC_CALL | \
549 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
550 I2C_FUNC_SMBUS_I2C_BLOCK | \
551 I2C_FUNC_SMBUS_PEC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
David Brownell438d6c22006-12-10 21:21:31 +0100553/*
554 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
David Brownell438d6c22006-12-10 21:21:31 +0100556#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557union i2c_smbus_data {
558 __u8 byte;
559 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200560 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200561 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562};
563
Jean Delvareae7193f2008-07-14 22:38:24 +0200564/* i2c_smbus_xfer read or write markers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565#define I2C_SMBUS_READ 1
566#define I2C_SMBUS_WRITE 0
567
David Brownell438d6c22006-12-10 21:21:31 +0100568/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
570#define I2C_SMBUS_QUICK 0
571#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100572#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573#define I2C_SMBUS_WORD_DATA 3
574#define I2C_SMBUS_PROC_CALL 4
575#define I2C_SMBUS_BLOCK_DATA 5
Jean Delvare4b2643d2007-07-12 14:12:29 +0200576#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Jean Delvare4b2643d2007-07-12 14:12:29 +0200578#define I2C_SMBUS_I2C_BLOCK_DATA 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580#endif /* _LINUX_I2C_H */