blob: 33a5992d493651383e00832b13b69f396d77bfff [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Jon Smirle9ca9eb2008-07-14 22:38:35 +020038extern struct bus_type i2c_bus_type;
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/* --- General options ------------------------------------------------ */
41
42struct i2c_msg;
43struct i2c_algorithm;
44struct i2c_adapter;
45struct i2c_client;
46struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020048struct i2c_board_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50/*
51 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010052 * on a bus (or read from them). Apart from two basic transfer functions to
53 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * transmit an arbitrary number of messages without interruption.
55 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020056extern int i2c_master_send(struct i2c_client *client, const char *buf,
57 int count);
58extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60/* Transfer num messages.
61 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020062extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
63 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/* This is the very generalized SMBus access routine. You probably do not
66 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +010067 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 Note that we use i2c_adapter here, because you do not need a specific
69 smbus adapter to call this function. */
Jean Delvare3ae70de2008-10-22 20:21:32 +020070extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
71 unsigned short flags, char read_write, u8 command,
72 int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +020075 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Jean Delvare3ae70de2008-10-22 20:21:32 +020077extern s32 i2c_smbus_read_byte(struct i2c_client *client);
78extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
79extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
80extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
81 u8 command, u8 value);
82extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
83extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
84 u8 command, u16 value);
Jean Delvareb86a1bc2007-05-01 23:26:34 +020085/* Returns the number of read bytes */
86extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
87 u8 command, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020088extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
89 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +020090/* Returns the number of read bytes */
Jean Delvare3ae70de2008-10-22 20:21:32 +020091extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +020092 u8 command, u8 length, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020093extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +110094 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +020095 const u8 *values);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Jean Delvare4735c982008-07-14 22:38:36 +020097/**
98 * struct i2c_driver - represent an I2C device driver
Jean Delvare96e21e42008-08-28 08:33:23 +020099 * @id: Unique driver ID (optional)
Jean Delvare4735c982008-07-14 22:38:36 +0200100 * @class: What kind of i2c device we instantiate (for detect)
Jean Delvare96e21e42008-08-28 08:33:23 +0200101 * @attach_adapter: Callback for bus addition (for legacy drivers)
102 * @detach_adapter: Callback for bus removal (for legacy drivers)
103 * @detach_client: Callback for device removal (for legacy drivers)
104 * @probe: Callback for device binding (new-style drivers)
105 * @remove: Callback for device unbinding (new-style drivers)
106 * @shutdown: Callback for device shutdown
107 * @suspend: Callback for device suspend
108 * @resume: Callback for device resume
109 * @command: Callback for bus-wide signaling (optional)
110 * @driver: Device driver model driver
111 * @id_table: List of I2C devices supported by this driver
Jean Delvare4735c982008-07-14 22:38:36 +0200112 * @detect: Callback for device detection
113 * @address_data: The I2C addresses to probe, ignore or force (for detect)
114 * @clients: List of detected clients we created (for i2c-core use only)
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100115 *
116 * The driver.owner field should be set to the module owner of this driver.
117 * The driver.name field should be set to the name of this driver.
Jean Delvare4735c982008-07-14 22:38:36 +0200118 *
119 * For automatic device detection, both @detect and @address_data must
120 * be defined. @class should also be set, otherwise only devices forced
121 * with module parameters will be created. The detect function must
122 * fill at least the name field of the i2c_board_info structure it is
123 * handed upon successful detection, and possibly also the flags field.
124 *
125 * If @detect is missing, the driver will still work fine for enumerated
126 * devices. Detected devices simply won't be supported. This is expected
127 * for the many I2C/SMBus devices which can't be detected reliably, and
128 * the ones which can always be enumerated in practice.
129 *
130 * The i2c_client structure which is handed to the @detect callback is
131 * not a real i2c_client. It is initialized just enough so that you can
132 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
133 * else with it. In particular, calling dev_dbg and friends on it is
134 * not allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 int id;
138 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140 /* Notifies the driver that a new bus has appeared. This routine
141 * can be used by the driver to test if the bus meets its conditions
David Brownell438d6c22006-12-10 21:21:31 +0100142 * & seek for the presence of the chip(s) it supports. If found, it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 * registers the client(s) that are on the bus to the i2c admin. via
David Brownell7b4fbc52007-05-01 23:26:30 +0200144 * i2c_attach_client. (LEGACY I2C DRIVERS ONLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
146 int (*attach_adapter)(struct i2c_adapter *);
147 int (*detach_adapter)(struct i2c_adapter *);
148
David Brownell438d6c22006-12-10 21:21:31 +0100149 /* tells the driver that a client is about to be deleted & gives it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * the chance to remove its private data. Also, if the client struct
151 * has been dynamically allocated by the driver in the function above,
David Brownell7b4fbc52007-05-01 23:26:30 +0200152 * it must be freed here. (LEGACY I2C DRIVERS ONLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 */
154 int (*detach_client)(struct i2c_client *);
David Brownellf37dd802007-02-13 22:09:00 +0100155
David Brownell7b4fbc52007-05-01 23:26:30 +0200156 /* Standard driver model interfaces, for "new style" i2c drivers.
157 * With the driver model, device enumeration is NEVER done by drivers;
158 * it's done by infrastructure. (NEW STYLE DRIVERS ONLY)
159 */
Jean Delvared2653e92008-04-29 23:11:39 +0200160 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200161 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200162
David Brownellf37dd802007-02-13 22:09:00 +0100163 /* driver model interfaces that don't relate to enumeration */
164 void (*shutdown)(struct i2c_client *);
165 int (*suspend)(struct i2c_client *, pm_message_t mesg);
166 int (*resume)(struct i2c_client *);
167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 /* a ioctl like command that can be used to perform specific functions
169 * with the device.
170 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200171 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200174 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200175
176 /* Device detection callback for automatic device creation */
177 int (*detect)(struct i2c_client *, int kind, struct i2c_board_info *);
178 const struct i2c_client_address_data *address_data;
179 struct list_head clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180};
181#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
182
David Brownell2096b952007-05-01 23:26:28 +0200183/**
184 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200185 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
186 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
David Brownell2096b952007-05-01 23:26:28 +0200187 * @addr: Address used on the I2C bus connected to the parent adapter.
188 * @name: Indicates the type of the device, usually a chip name that's
189 * generic enough to hide second-sourcing and compatible revisions.
David Brownelld64f73b2007-07-12 14:12:28 +0200190 * @adapter: manages the bus segment hosting this I2C device
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700191 * @driver: device's driver, hence pointer to access routines
David Brownell2096b952007-05-01 23:26:28 +0200192 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200193 * @irq: indicates the IRQ generated by this device (if any)
David Brownell9b766b82008-01-27 18:14:51 +0100194 * @list: list of active/busy clients (DEPRECATED)
Jean Delvare4735c982008-07-14 22:38:36 +0200195 * @detected: member of an i2c_driver.clients list
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700196 * @released: used to synchronize client releases & detaches and references
David Brownell2096b952007-05-01 23:26:28 +0200197 *
198 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200199 * i2c bus. The behaviour exposed to Linux is defined by the driver
200 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
202struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200203 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100204 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200206 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200207 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 struct i2c_adapter *adapter; /* the adapter we sit on */
209 struct i2c_driver *driver; /* and our access routines */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200211 int irq; /* irq issued by device */
David Brownell9b766b82008-01-27 18:14:51 +0100212 struct list_head list; /* DEPRECATED */
Jean Delvare4735c982008-07-14 22:38:36 +0200213 struct list_head detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 struct completion released;
215};
216#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
217
David Brownell9b766b82008-01-27 18:14:51 +0100218extern struct i2c_client *i2c_verify_client(struct device *dev);
219
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500220static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
221{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200222 struct device * const dev = container_of(kobj, struct device, kobj);
223 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500224}
225
Jean Delvare7d1d8992008-10-22 20:21:31 +0200226static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200228 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229}
230
Jean Delvare3ae70de2008-10-22 20:21:32 +0200231static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200233 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234}
235
David Brownell9c1600e2007-05-01 23:26:31 +0200236/**
237 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200238 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200239 * @flags: to initialize i2c_client.flags
240 * @addr: stored in i2c_client.addr
241 * @platform_data: stored in i2c_client.dev.platform_data
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200242 * @archdata: copied into i2c_client.dev.archdata
David Brownell9c1600e2007-05-01 23:26:31 +0200243 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200244 *
David Brownell9c1600e2007-05-01 23:26:31 +0200245 * I2C doesn't actually support hardware probing, although controllers and
246 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
247 * a device at a given address. Drivers commonly need more information than
248 * that, such as chip type, configuration, associated IRQ, and so on.
249 *
250 * i2c_board_info is used to build tables of information listing I2C devices
251 * that are present. This information is used to grow the driver model tree
252 * for "new style" I2C drivers. For mainboards this is done statically using
David Brownelld64f73b2007-07-12 14:12:28 +0200253 * i2c_register_board_info(); bus numbers identify adapters that aren't
David Brownell9c1600e2007-05-01 23:26:31 +0200254 * yet available. For add-on boards, i2c_new_device() does this dynamically
255 * with the adapter already known.
256 */
257struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200258 char type[I2C_NAME_SIZE];
259 unsigned short flags;
260 unsigned short addr;
261 void *platform_data;
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200262 struct dev_archdata *archdata;
David Brownell9c1600e2007-05-01 23:26:31 +0200263 int irq;
264};
265
266/**
Jean Delvare3760f732008-04-29 23:11:40 +0200267 * I2C_BOARD_INFO - macro used to list an i2c device and its address
268 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200269 * @dev_addr: the device's address on the bus.
270 *
271 * This macro initializes essential fields of a struct i2c_board_info,
272 * declaring what has been provided on a particular board. Optional
Jean Delvare3760f732008-04-29 23:11:40 +0200273 * fields (such as associated irq, or device-specific platform_data)
274 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200275 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200276#define I2C_BOARD_INFO(dev_type, dev_addr) \
Jean Delvare3760f732008-04-29 23:11:40 +0200277 .type = (dev_type), .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200278
279
280/* Add-on boards should register/unregister their devices; e.g. a board
281 * with integrated I2C, a config eeprom, sensors, and a codec that's
282 * used in conjunction with the primary hardware.
283 */
284extern struct i2c_client *
285i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
286
Jean Delvare12b5053a2007-05-01 23:26:31 +0200287/* If you don't know the exact address of an I2C device, use this variant
288 * instead, which can probe for device presence in a list of possible
289 * addresses.
290 */
291extern struct i2c_client *
292i2c_new_probed_device(struct i2c_adapter *adap,
293 struct i2c_board_info *info,
294 unsigned short const *addr_list);
295
David Brownelle9f13732008-01-27 18:14:52 +0100296/* For devices that use several addresses, use i2c_new_dummy() to make
297 * client handles for the extra addresses.
298 */
299extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200300i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100301
David Brownell9c1600e2007-05-01 23:26:31 +0200302extern void i2c_unregister_device(struct i2c_client *);
303
304/* Mainboard arch_initcall() code should register all its I2C devices.
305 * This is done at arch_initcall time, before declaring any i2c adapters.
306 * Modules for add-on boards must use other calls.
307 */
David Brownell26386762008-02-24 20:03:42 +0100308#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200309extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200310i2c_register_board_info(int busnum, struct i2c_board_info const *info,
311 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100312#else
313static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200314i2c_register_board_info(int busnum, struct i2c_board_info const *info,
315 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100316{
317 return 0;
318}
319#endif
David Brownell9c1600e2007-05-01 23:26:31 +0200320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321/*
322 * The following structs are for those who like to implement new bus drivers:
323 * i2c_algorithm is the interface to a class of hardware solutions which can
324 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
325 * to name two of the most common.
326 */
327struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100329 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 smbus_xfer. If set to NULL, the SMBus protocol is simulated
331 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200332 /* master_xfer should return the number of messages successfully
333 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200334 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
335 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100336 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200337 unsigned short flags, char read_write,
338 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 /* To determine what the adapter supports */
341 u32 (*functionality) (struct i2c_adapter *);
342};
343
344/*
345 * i2c_adapter is the structure used to identify a physical i2c bus along
346 * with the access algorithms necessary to access it.
347 */
348struct i2c_adapter {
349 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200350 unsigned int id;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200351 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200352 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 void *algo_data;
354
355 /* --- administration stuff. */
356 int (*client_register)(struct i2c_client *);
357 int (*client_unregister)(struct i2c_client *);
358
359 /* data fields that are valid for all devices */
Jiri Kosina6ea23032006-12-10 21:21:30 +0100360 u8 level; /* nesting level for lockdep */
Ingo Molnar5c085d32006-01-18 23:16:04 +0100361 struct mutex bus_lock;
362 struct mutex clist_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364 int timeout;
365 int retries;
366 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 int nr;
David Brownell9b766b82008-01-27 18:14:51 +0100369 struct list_head clients; /* DEPRECATED */
David Brownell2096b952007-05-01 23:26:28 +0200370 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 struct completion dev_released;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372};
David Brownellef2c83212007-05-01 23:26:28 +0200373#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Jean Delvare7d1d8992008-10-22 20:21:31 +0200375static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200377 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378}
379
Jean Delvare3ae70de2008-10-22 20:21:32 +0200380static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200382 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/*flags for the client struct: */
David Brownell3bbb8352007-10-13 23:56:29 +0200386#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
387#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
388 /* Must equal I2C_M_TEN below */
389#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391/* i2c adapter classes (bitmask) */
392#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
393#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
394#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
Jean Delvarec1b6b4f2008-07-14 22:38:28 +0200395#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
397#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
398#define I2C_CLASS_SOUND (1<<6) /* sound devices */
Jean Delvare3401b2f2008-07-14 22:38:29 +0200399#define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
401
402/* i2c_client_address_data is the struct for holding default client
403 * addresses for a driver and for the parameters supplied on the
404 * command line
405 */
406struct i2c_client_address_data {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100407 const unsigned short *normal_i2c;
408 const unsigned short *probe;
409 const unsigned short *ignore;
410 const unsigned short * const *forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411};
412
413/* Internal numbers to terminate lists */
414#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416/* The numbers to use to set I2C bus address */
417#define ANY_I2C_BUS 0xffff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419
420/* ----- functions exported by i2c.o */
421
422/* administration...
423 */
424extern int i2c_add_adapter(struct i2c_adapter *);
425extern int i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200426extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800428extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200429extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800431static inline int i2c_add_driver(struct i2c_driver *driver)
432{
433 return i2c_register_driver(THIS_MODULE, driver);
434}
435
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436extern int i2c_attach_client(struct i2c_client *);
437extern int i2c_detach_client(struct i2c_client *);
438
Jean Delvaree48d3312008-01-27 18:14:48 +0100439extern struct i2c_client *i2c_use_client(struct i2c_client *client);
440extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/* call the i2c_client->command() of all attached clients with
443 * the given arguments */
444extern void i2c_clients_command(struct i2c_adapter *adap,
445 unsigned int cmd, void *arg);
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/* Detect function. It iterates over all possible addresses itself.
448 * It will only call found_proc if some client is connected at the
449 * specific address (unless a 'force' matched);
450 */
David Brownell438d6c22006-12-10 21:21:31 +0100451extern int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100452 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 int (*found_proc) (struct i2c_adapter *, int, int));
454
Jean Delvare3ae70de2008-10-22 20:21:32 +0200455extern struct i2c_adapter *i2c_get_adapter(int id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456extern void i2c_put_adapter(struct i2c_adapter *adap);
457
458
459/* Return the functionality mask */
460static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
461{
462 return adap->algo->functionality(adap);
463}
464
465/* Return 1 if adapter supports everything we need, 0 if not. */
466static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
467{
468 return (func & i2c_get_functionality(adap)) == func;
469}
470
Jean Delvare3ae70de2008-10-22 20:21:32 +0200471/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200472static inline int i2c_adapter_id(struct i2c_adapter *adap)
473{
474 return adap->nr;
475}
David Woodhousea1b92982006-04-25 14:14:52 +0100476#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200477
David Brownella64ec072007-10-13 23:56:31 +0200478/**
479 * struct i2c_msg - an I2C transaction segment beginning with START
480 * @addr: Slave address, either seven or ten bits. When this is a ten
481 * bit address, I2C_M_TEN must be set in @flags and the adapter
482 * must support I2C_FUNC_10BIT_ADDR.
483 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
484 * provided unless the adapter exported the relevant I2C_FUNC_*
485 * flags through i2c_check_functionality().
486 * @len: Number of data bytes in @buf being read from or written to the
487 * I2C slave address. For read transactions where I2C_M_RECV_LEN
488 * is set, the caller guarantees that this buffer can hold up to
489 * 32 bytes in addition to the initial length byte sent by the
490 * slave (plus, if used, the SMBus PEC); and this value will be
491 * incremented by the number of block data bytes received.
492 * @buf: The buffer into which data is read, or from which it's written.
493 *
494 * An i2c_msg is the low level representation of one segment of an I2C
495 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
496 * to userspace from i2c-dev, and to I2C adapter drivers through the
497 * @i2c_adapter.@master_xfer() method.
498 *
499 * Except when I2C "protocol mangling" is used, all I2C adapters implement
500 * the standard rules for I2C transactions. Each transaction begins with a
501 * START. That is followed by the slave address, and a bit encoding read
502 * versus write. Then follow all the data bytes, possibly including a byte
503 * with SMBus PEC. The transfer terminates with a NAK, or when all those
504 * bytes have been transferred and ACKed. If this is the last message in a
505 * group, it is followed by a STOP. Otherwise it is followed by the next
506 * @i2c_msg transaction segment, beginning with a (repeated) START.
507 *
508 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
509 * passing certain @flags may have changed those standard protocol behaviors.
510 * Those flags are only for use with broken/nonconforming slaves, and with
511 * adapters which are known to support the specific mangling options they
512 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 */
514struct i2c_msg {
515 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100516 __u16 flags;
David Brownella64ec072007-10-13 23:56:31 +0200517#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
518#define I2C_M_RD 0x0001 /* read data, from slave to master */
519#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
520#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
521#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
522#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
523#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
David Brownell438d6c22006-12-10 21:21:31 +0100524 __u16 len; /* msg length */
525 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526};
527
528/* To determine what functionality is present */
529
530#define I2C_FUNC_I2C 0x00000001
531#define I2C_FUNC_10BIT_ADDR 0x00000002
Jean Delvare3ae70de2008-10-22 20:21:32 +0200532#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
David Brownell6662cbb2007-10-13 23:56:33 +0200533#define I2C_FUNC_SMBUS_PEC 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100535#define I2C_FUNC_SMBUS_QUICK 0x00010000
536#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
537#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
538#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
539#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
540#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
541#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
542#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
543#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
544#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
546#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Jean Delvare3ae70de2008-10-22 20:21:32 +0200548#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
549 I2C_FUNC_SMBUS_WRITE_BYTE)
550#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
551 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
552#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
553 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
554#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
555 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
556#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
557 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Jean Delvare3ae70de2008-10-22 20:21:32 +0200559#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
560 I2C_FUNC_SMBUS_BYTE | \
561 I2C_FUNC_SMBUS_BYTE_DATA | \
562 I2C_FUNC_SMBUS_WORD_DATA | \
563 I2C_FUNC_SMBUS_PROC_CALL | \
564 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
565 I2C_FUNC_SMBUS_I2C_BLOCK | \
566 I2C_FUNC_SMBUS_PEC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
David Brownell438d6c22006-12-10 21:21:31 +0100568/*
569 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 */
David Brownell438d6c22006-12-10 21:21:31 +0100571#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572union i2c_smbus_data {
573 __u8 byte;
574 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200575 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200576 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577};
578
Jean Delvareae7193f2008-07-14 22:38:24 +0200579/* i2c_smbus_xfer read or write markers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580#define I2C_SMBUS_READ 1
581#define I2C_SMBUS_WRITE 0
582
David Brownell438d6c22006-12-10 21:21:31 +0100583/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
585#define I2C_SMBUS_QUICK 0
586#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100587#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588#define I2C_SMBUS_WORD_DATA 3
589#define I2C_SMBUS_PROC_CALL 4
590#define I2C_SMBUS_BLOCK_DATA 5
Jean Delvare4b2643d2007-07-12 14:12:29 +0200591#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Jean Delvare4b2643d2007-07-12 14:12:29 +0200593#define I2C_SMBUS_I2C_BLOCK_DATA 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
595
David Woodhousea1b92982006-04-25 14:14:52 +0100596#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598/* These defines are used for probing i2c client addresses */
599/* The length of the option lists */
600#define I2C_CLIENT_MAX_OPTS 48
601
602/* Default fill of many variables */
603#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
Jean Delvare3ae70de2008-10-22 20:21:32 +0200604 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
605 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
606 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
607 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
608 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
609 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
610 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
611 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
612 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
613 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
614 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
615 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
616 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
617 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
618 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
621 module header */
622
623#define I2C_CLIENT_MODULE_PARM(var,desc) \
624 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
625 static unsigned int var##_num; \
626 module_param_array(var, short, &var##_num, 0); \
Jean Delvare3ae70de2008-10-22 20:21:32 +0200627 MODULE_PARM_DESC(var, desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Jean Delvaref4b50262005-07-31 21:49:03 +0200629#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
630I2C_CLIENT_MODULE_PARM(force_##name, \
631 "List of adapter,address pairs which are " \
632 "unquestionably assumed to contain a `" \
633 # name "' chip")
634
635
636#define I2C_CLIENT_INSMOD_COMMON \
637I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
638 "additionally"); \
639I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
640 "scan"); \
Tobias Klauser305183f2008-02-24 20:03:42 +0100641static const struct i2c_client_address_data addr_data = { \
Jean Delvaref4b50262005-07-31 21:49:03 +0200642 .normal_i2c = normal_i2c, \
643 .probe = probe, \
644 .ignore = ignore, \
645 .forces = forces, \
646}
647
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100648#define I2C_CLIENT_FORCE_TEXT \
649 "List of adapter,address pairs to boldly assume to be present"
650
Jean Delvaref4b50262005-07-31 21:49:03 +0200651/* These are the ones you want to use in your own drivers. Pick the one
652 which matches the number of devices the driver differenciates between. */
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100653#define I2C_CLIENT_INSMOD \
654I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
655static const unsigned short * const forces[] = { force, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200656I2C_CLIENT_INSMOD_COMMON
657
658#define I2C_CLIENT_INSMOD_1(chip1) \
659enum chips { any_chip, chip1 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100660I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200661I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100662static const unsigned short * const forces[] = { force, \
663 force_##chip1, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200664I2C_CLIENT_INSMOD_COMMON
665
666#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
667enum chips { any_chip, chip1, chip2 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100668I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200669I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
670I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100671static const unsigned short * const forces[] = { force, \
672 force_##chip1, force_##chip2, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200673I2C_CLIENT_INSMOD_COMMON
674
675#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
676enum chips { any_chip, chip1, chip2, chip3 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100677I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200678I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
679I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
680I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100681static const unsigned short * const forces[] = { force, \
682 force_##chip1, force_##chip2, force_##chip3, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200683I2C_CLIENT_INSMOD_COMMON
684
685#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
686enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100687I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200688I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
689I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
690I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
691I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100692static const unsigned short * const forces[] = { force, \
693 force_##chip1, force_##chip2, force_##chip3, \
694 force_##chip4, NULL}; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200695I2C_CLIENT_INSMOD_COMMON
696
697#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
698enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100699I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200700I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
701I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
702I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
703I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
704I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100705static const unsigned short * const forces[] = { force, \
706 force_##chip1, force_##chip2, force_##chip3, \
707 force_##chip4, force_##chip5, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200708I2C_CLIENT_INSMOD_COMMON
709
710#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
711enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100712I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200713I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
714I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
715I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
716I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
717I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
718I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100719static const unsigned short * const forces[] = { force, \
720 force_##chip1, force_##chip2, force_##chip3, \
721 force_##chip4, force_##chip5, force_##chip6, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200722I2C_CLIENT_INSMOD_COMMON
723
724#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
725enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
726 chip7 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100727I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200728I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
729I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
730I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
731I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
732I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
733I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
734I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100735static const unsigned short * const forces[] = { force, \
736 force_##chip1, force_##chip2, force_##chip3, \
737 force_##chip4, force_##chip5, force_##chip6, \
738 force_##chip7, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200739I2C_CLIENT_INSMOD_COMMON
740
741#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
742enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
743 chip7, chip8 }; \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100744I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200745I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
746I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
747I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
748I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
749I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
750I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
751I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
752I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100753static const unsigned short * const forces[] = { force, \
754 force_##chip1, force_##chip2, force_##chip3, \
755 force_##chip4, force_##chip5, force_##chip6, \
756 force_##chip7, force_##chip8, NULL }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200757I2C_CLIENT_INSMOD_COMMON
David Woodhousea1b92982006-04-25 14:14:52 +0100758#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759#endif /* _LINUX_I2C_H */