]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/i2c.h
git://bbs.cooldavid.org / net-next-2.6.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
serial: MPSC: Fix coding style and whitespace issues
[net-next-2.6.git] / include / linux / i2c.h
CommitLineData
1da177e4 1/* ------------------------------------------------------------------------- */
438d6c2c 2/* */
1da177e4 3/* i2c.h - definitions for the i2c-bus interface */
438d6c2c 4/* */
1da177e4
LT		 5/* ------------------------------------------------------------------------- */
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
a1b9298e 23/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
1da177e4
LT		 24 Frodo Looijaard <frodol@dds.nl> */
25
1da177e4
LT		 26#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
1da177e4 29#include <linux/types.h>
438d6c2c 30#ifdef __KERNEL__
a1b9298e 31#include <linux/module.h>
1da177e4 32#include <linux/i2c-id.h>
a9d1b24d 33#include <linux/mod_devicetable.h>
1da177e4 34#include <linux/device.h> /* for struct device */
4e57b681 35#include <linux/sched.h> /* for completion */
5c085d36 36#include <linux/mutex.h>
1da177e4 37
efde723f
JD		 38extern struct bus_type i2c_bus_type;
39
1da177e4
LT		 40/* --- General options ------------------------------------------------ */
41
42struct i2c_msg;
43struct i2c_algorithm;
44struct i2c_adapter;
45struct i2c_client;
46struct i2c_driver;
1da177e4
LT		 47union i2c_smbus_data;
48
49/*
50 * The master routines are the ones normally used to transmit data to devices
438d6c2c
DB		 51 * on a bus (or read from them). Apart from two basic transfer functions to
52 * transmit one message at a time, a more complex version can be used to
1da177e4
LT		 53 * transmit an arbitrary number of messages without interruption.
54 */
55extern int i2c_master_send(struct i2c_client *,const char* ,int);
56extern int i2c_master_recv(struct i2c_client *,char* ,int);
57
58/* Transfer num messages.
59 */
60extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
61
1da177e4
LT		 62
63/* This is the very generalized SMBus access routine. You probably do not
64 want to use this, though; one of the functions below may be much easier,
438d6c2c 65 and probably just as fast.
1da177e4
LT		 66 Note that we use i2c_adapter here, because you do not need a specific
67 smbus adapter to call this function. */
438d6c2c 68extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
1da177e4
LT		 69 unsigned short flags,
70 char read_write, u8 command, int size,
71 union i2c_smbus_data * data);
72
73/* Now follow the 'nice' access routines. These also document the calling
74 conventions of smbus_access. */
75
76extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
77extern 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);
b86a1bc8
JD		 85/* Returns the number of read bytes */
86extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
87 u8 command, u8 *values);
1da177e4
LT		 88extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
89 u8 command, u8 length,
46f5ed75 90 const u8 *values);
31ec5bc5 91/* Returns the number of read bytes */
1da177e4 92extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
4b2643d7 93 u8 command, u8 length, u8 *values);
21bbd691
JD		 94extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
95 u8 command, u8 length,
46f5ed75 96 const u8 *values);
1da177e4
LT		 97
98/*
99 * A driver is capable of handling one or more physical devices present on
100 * I2C adapters. This information is used to inform the driver of adapter
101 * events.
35d8b2e6
LR		 102 *
103 * The driver.owner field should be set to the module owner of this driver.
104 * The driver.name field should be set to the name of this driver.
1da177e4
LT		 105 */
106
107struct i2c_driver {
1da177e4
LT		 108 int id;
109 unsigned int class;
1da177e4
LT		 110
111 /* Notifies the driver that a new bus has appeared. This routine
112 * can be used by the driver to test if the bus meets its conditions
438d6c2c 113 * & seek for the presence of the chip(s) it supports. If found, it
1da177e4 114 * registers the client(s) that are on the bus to the i2c admin. via
7b4fbc50 115 * i2c_attach_client. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT		 116 */
117 int (*attach_adapter)(struct i2c_adapter *);
118 int (*detach_adapter)(struct i2c_adapter *);
119
438d6c2c 120 /* tells the driver that a client is about to be deleted & gives it
1da177e4
LT		 121 * the chance to remove its private data. Also, if the client struct
122 * has been dynamically allocated by the driver in the function above,
7b4fbc50 123 * it must be freed here. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT		 124 */
125 int (*detach_client)(struct i2c_client *);
f37dd80a 126
7b4fbc50
DB		 127 /* Standard driver model interfaces, for "new style" i2c drivers.
128 * With the driver model, device enumeration is NEVER done by drivers;
129 * it's done by infrastructure. (NEW STYLE DRIVERS ONLY)
130 */
131 int (*probe)(struct i2c_client *);
a1d9e6e4 132 int (*remove)(struct i2c_client *);
7b4fbc50 133
f37dd80a
DB		 134 /* driver model interfaces that don't relate to enumeration */
135 void (*shutdown)(struct i2c_client *);
136 int (*suspend)(struct i2c_client *, pm_message_t mesg);
137 int (*resume)(struct i2c_client *);
138
1da177e4
LT		 139 /* a ioctl like command that can be used to perform specific functions
140 * with the device.
141 */
142 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
143
144 struct device_driver driver;
145 struct list_head list;
146};
147#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
148
2096b956
DB		 149#define I2C_NAME_SIZE 20
150
151/**
152 * struct i2c_client - represent an I2C slave device
d64f73be
DB		 153 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
154 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
2096b956
DB		 155 * @addr: Address used on the I2C bus connected to the parent adapter.
156 * @name: Indicates the type of the device, usually a chip name that's
157 * generic enough to hide second-sourcing and compatible revisions.
d64f73be 158 * @adapter: manages the bus segment hosting this I2C device
2096b956 159 * @dev: Driver model device node for the slave.
d64f73be 160 * @irq: indicates the IRQ generated by this device (if any)
7b4fbc50
DB		 161 * @driver_name: Identifies new-style driver used with this device; also
162 * used as the module name for hotplug/coldplug modprobe support.
2096b956
DB		 163 *
164 * An i2c_client identifies a single device (i.e. chip) connected to an
d64f73be
DB		 165 * i2c bus. The behaviour exposed to Linux is defined by the driver
166 * managing the device.
1da177e4
LT		 167 */
168struct i2c_client {
2096b956 169 unsigned short flags; /* div., see below */
438d6c2c 170 unsigned short addr; /* chip address - NOTE: 7bit */
1da177e4 171 /* addresses are stored in the */
5071860a 172 /* _LOWER_ 7 bits */
2096b956 173 char name[I2C_NAME_SIZE];
1da177e4
LT		 174 struct i2c_adapter *adapter; /* the adapter we sit on */
175 struct i2c_driver *driver; /* and our access routines */
176 int usage_count; /* How many accesses currently */
177 /* to the client */
178 struct device dev; /* the device structure */
9c1600ed 179 int irq; /* irq issued by device (or -1) */
7b4fbc50 180 char driver_name[KOBJ_NAME_LEN];
1da177e4 181 struct list_head list;
1da177e4
LT		 182 struct completion released;
183};
184#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
185
a61fc683
BG		 186static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
187{
d75d53cd
MH		 188 struct device * const dev = container_of(kobj, struct device, kobj);
189 return to_i2c_client(dev);
a61fc683
BG		 190}
191
1da177e4
LT		 192static inline void *i2c_get_clientdata (struct i2c_client *dev)
193{
194 return dev_get_drvdata (&dev->dev);
195}
196
197static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
198{
199 dev_set_drvdata (&dev->dev, data);
200}
201
9c1600ed
DB		 202/**
203 * struct i2c_board_info - template for device creation
204 * @driver_name: identifies the driver to be bound to the device
205 * @type: optional chip type information, to initialize i2c_client.name
206 * @flags: to initialize i2c_client.flags
207 * @addr: stored in i2c_client.addr
208 * @platform_data: stored in i2c_client.dev.platform_data
209 * @irq: stored in i2c_client.irq
d64f73be 210 *
9c1600ed
DB		 211 * I2C doesn't actually support hardware probing, although controllers and
212 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
213 * a device at a given address. Drivers commonly need more information than
214 * that, such as chip type, configuration, associated IRQ, and so on.
215 *
216 * i2c_board_info is used to build tables of information listing I2C devices
217 * that are present. This information is used to grow the driver model tree
218 * for "new style" I2C drivers. For mainboards this is done statically using
d64f73be 219 * i2c_register_board_info(); bus numbers identify adapters that aren't
9c1600ed
DB		 220 * yet available. For add-on boards, i2c_new_device() does this dynamically
221 * with the adapter already known.
222 */
223struct i2c_board_info {
224 char driver_name[KOBJ_NAME_LEN];
225 char type[I2C_NAME_SIZE];
226 unsigned short flags;
227 unsigned short addr;
228 void *platform_data;
229 int irq;
230};
231
232/**
233 * I2C_BOARD_INFO - macro used to list an i2c device and its driver
234 * @driver: identifies the driver to use with the device
235 * @dev_addr: the device's address on the bus.
236 *
237 * This macro initializes essential fields of a struct i2c_board_info,
238 * declaring what has been provided on a particular board. Optional
239 * fields (such as the chip type, its associated irq, or device-specific
240 * platform_data) are provided using conventional syntax.
241 */
242#define I2C_BOARD_INFO(driver,dev_addr) \
243 .driver_name = (driver), .addr = (dev_addr)
244
245
246/* Add-on boards should register/unregister their devices; e.g. a board
247 * with integrated I2C, a config eeprom, sensors, and a codec that's
248 * used in conjunction with the primary hardware.
249 */
250extern struct i2c_client *
251i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
252
12b5053a
JD		 253/* If you don't know the exact address of an I2C device, use this variant
254 * instead, which can probe for device presence in a list of possible
255 * addresses.
256 */
257extern struct i2c_client *
258i2c_new_probed_device(struct i2c_adapter *adap,
259 struct i2c_board_info *info,
260 unsigned short const *addr_list);
261
9c1600ed
DB		 262extern void i2c_unregister_device(struct i2c_client *);
263
264/* Mainboard arch_initcall() code should register all its I2C devices.
265 * This is done at arch_initcall time, before declaring any i2c adapters.
266 * Modules for add-on boards must use other calls.
267 */
268extern int
269i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
270
271
1da177e4
LT		 272/*
273 * The following structs are for those who like to implement new bus drivers:
274 * i2c_algorithm is the interface to a class of hardware solutions which can
275 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
276 * to name two of the most common.
277 */
278struct i2c_algorithm {
1da177e4 279 /* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c 280 to NULL. If an adapter algorithm can do SMBus access, set
1da177e4
LT		 281 smbus_xfer. If set to NULL, the SMBus protocol is simulated
282 using common I2C messages */
8ced8eee
JD		 283 /* master_xfer should return the number of messages successfully
284 processed, or a negative value on error */
438d6c2c 285 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
1da177e4 286 int num);
438d6c2c 287 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
1da177e4
LT		 288 unsigned short flags, char read_write,
289 u8 command, int size, union i2c_smbus_data * data);
290
1da177e4
LT		 291 /* --- ioctl like call to set div. parameters. */
292 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
293
294 /* To determine what the adapter supports */
295 u32 (*functionality) (struct i2c_adapter *);
296};
297
298/*
299 * i2c_adapter is the structure used to identify a physical i2c bus along
300 * with the access algorithms necessary to access it.
301 */
302struct i2c_adapter {
303 struct module *owner;
020789e9 304 unsigned int id;
1da177e4 305 unsigned int class;
af71ff69 306 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4
LT		 307 void *algo_data;
308
309 /* --- administration stuff. */
310 int (*client_register)(struct i2c_client *);
311 int (*client_unregister)(struct i2c_client *);
312
313 /* data fields that are valid for all devices */
6ea23039 314 u8 level; /* nesting level for lockdep */
5c085d36
IM		 315 struct mutex bus_lock;
316 struct mutex clist_lock;
1da177e4
LT		 317
318 int timeout;
319 int retries;
320 struct device dev; /* the adapter device */
1da177e4 321
1da177e4
LT		 322 int nr;
323 struct list_head clients;
324 struct list_head list;
2096b956 325 char name[48];
1da177e4 326 struct completion dev_released;
1da177e4 327};
ef2c8321 328#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4
LT		 329
330static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
331{
332 return dev_get_drvdata (&dev->dev);
333}
334
335static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
336{
337 dev_set_drvdata (&dev->dev, data);
338}
339
1da177e4 340/*flags for the client struct: */
1da177e4
LT		 341#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
342#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
343 /* Must equal I2C_M_TEN below */
344
345/* i2c adapter classes (bitmask) */
346#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
347#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
348#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
349#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
350#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
351#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
352#define I2C_CLASS_SOUND (1<<6) /* sound devices */
353#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
354
355/* i2c_client_address_data is the struct for holding default client
356 * addresses for a driver and for the parameters supplied on the
357 * command line
358 */
359struct i2c_client_address_data {
360 unsigned short *normal_i2c;
1da177e4 361 unsigned short *probe;
1da177e4 362 unsigned short *ignore;
9fc6adfa 363 unsigned short **forces;
1da177e4
LT		 364};
365
366/* Internal numbers to terminate lists */
367#define I2C_CLIENT_END 0xfffeU
1da177e4
LT		 368
369/* The numbers to use to set I2C bus address */
370#define ANY_I2C_BUS 0xffff
1da177e4
LT		 371
372
373/* ----- functions exported by i2c.o */
374
375/* administration...
376 */
377extern int i2c_add_adapter(struct i2c_adapter *);
378extern int i2c_del_adapter(struct i2c_adapter *);
6e13e641 379extern int i2c_add_numbered_adapter(struct i2c_adapter *);
1da177e4 380
de59cf9e 381extern int i2c_register_driver(struct module *, struct i2c_driver *);
b3e82096 382extern void i2c_del_driver(struct i2c_driver *);
1da177e4 383
de59cf9e
GKH		 384static inline int i2c_add_driver(struct i2c_driver *driver)
385{
386 return i2c_register_driver(THIS_MODULE, driver);
387}
388
1da177e4
LT		 389extern int i2c_attach_client(struct i2c_client *);
390extern int i2c_detach_client(struct i2c_client *);
391
482c788d
JD		 392/* Should be used to make sure that client-struct is valid and that it
393 is okay to access the i2c-client.
cf02df77 394 returns -ENODEV if client has gone in the meantime */
1da177e4
LT		 395extern int i2c_use_client(struct i2c_client *);
396extern int i2c_release_client(struct i2c_client *);
397
398/* call the i2c_client->command() of all attached clients with
399 * the given arguments */
400extern void i2c_clients_command(struct i2c_adapter *adap,
401 unsigned int cmd, void *arg);
402
403/* returns -EBUSY if address has been taken, 0 if not. Note that the only
404 other place at which this is called is within i2c_attach_client; so
405 you can cheat by simply not registering. Not recommended, of course! */
406extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
407
408/* Detect function. It iterates over all possible addresses itself.
409 * It will only call found_proc if some client is connected at the
410 * specific address (unless a 'force' matched);
411 */
438d6c2c 412extern int i2c_probe(struct i2c_adapter *adapter,
1da177e4
LT		 413 struct i2c_client_address_data *address_data,
414 int (*found_proc) (struct i2c_adapter *, int, int));
415
416/* An ioctl like call to set div. parameters of the adapter.
417 */
418extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
419
1da177e4
LT		 420extern struct i2c_adapter* i2c_get_adapter(int id);
421extern void i2c_put_adapter(struct i2c_adapter *adap);
422
423
424/* Return the functionality mask */
425static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
426{
427 return adap->algo->functionality(adap);
428}
429
430/* Return 1 if adapter supports everything we need, 0 if not. */
431static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
432{
433 return (func & i2c_get_functionality(adap)) == func;
434}
435
cdcb1921
JD		 436/* Return id number for a specific adapter */
437static inline int i2c_adapter_id(struct i2c_adapter *adap)
438{
439 return adap->nr;
440}
a1b9298e 441#endif /* __KERNEL__ */
cdcb1921 442
1da177e4
LT		 443/*
444 * I2C Message - used for pure i2c transaction, also from /dev interface
445 */
446struct i2c_msg {
447 __u16 addr; /* slave address */
438d6c2c 448 __u16 flags;
1da177e4
LT		 449#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
450#define I2C_M_RD 0x01
451#define I2C_M_NOSTART 0x4000
452#define I2C_M_REV_DIR_ADDR 0x2000
453#define I2C_M_IGNORE_NAK 0x1000
454#define I2C_M_NO_RD_ACK 0x0800
209d27c3 455#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
438d6c2c
DB		 456 __u16 len; /* msg length */
457 __u8 *buf; /* pointer to msg data */
1da177e4
LT		 458};
459
460/* To determine what functionality is present */
461
462#define I2C_FUNC_I2C 0x00000001
463#define I2C_FUNC_10BIT_ADDR 0x00000002
464#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
465#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
1da177e4 466#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
438d6c2c
DB		 467#define I2C_FUNC_SMBUS_QUICK 0x00010000
468#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
469#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
470#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
471#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
472#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
473#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
474#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
475#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
476#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4
LT		 477#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
478#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
479#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
480#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
1da177e4
LT		 481
482#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
483 I2C_FUNC_SMBUS_WRITE_BYTE)
484#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
485 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
486#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
487 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
488#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
489 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
490#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
491 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
492#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
493 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
1da177e4
LT		 494
495#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
496 I2C_FUNC_SMBUS_BYTE | \
497 I2C_FUNC_SMBUS_BYTE_DATA | \
498 I2C_FUNC_SMBUS_WORD_DATA | \
499 I2C_FUNC_SMBUS_PROC_CALL | \
500 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
1da177e4
LT		 501 I2C_FUNC_SMBUS_I2C_BLOCK)
502
438d6c2c
DB		 503/*
504 * Data for SMBus Messages
1da177e4 505 */
438d6c2c 506#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
1da177e4
LT		 507union i2c_smbus_data {
508 __u8 byte;
509 __u16 word;
332bf92b 510 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
421ef47b 511 /* and one more for user-space compatibility */
1da177e4
LT		 512};
513
514/* smbus_access read or write markers */
515#define I2C_SMBUS_READ 1
516#define I2C_SMBUS_WRITE 0
517
438d6c2c 518/* SMBus transaction types (size parameter in the above functions)
1da177e4
LT		 519 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
520#define I2C_SMBUS_QUICK 0
521#define I2C_SMBUS_BYTE 1
438d6c2c 522#define I2C_SMBUS_BYTE_DATA 2
1da177e4
LT		 523#define I2C_SMBUS_WORD_DATA 3
524#define I2C_SMBUS_PROC_CALL 4
525#define I2C_SMBUS_BLOCK_DATA 5
4b2643d7 526#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
1da177e4 527#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
4b2643d7 528#define I2C_SMBUS_I2C_BLOCK_DATA 8
1da177e4
LT		 529
530
531/* ----- commands for the ioctl like i2c_command call:
438d6c2c
DB		 532 * note that additional calls are defined in the algorithm and hw
533 * dependent layers - these can be listed here, or see the
1da177e4
LT		 534 * corresponding header files.
535 */
536 /* -> bit-adapter specific ioctls */
537#define I2C_RETRIES 0x0701 /* number of times a device address */
538 /* should be polled when not */
438d6c2c
DB		 539 /* acknowledging */
540#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
1da177e4
LT		 541
542
543/* this is for i2c-dev.c */
544#define I2C_SLAVE 0x0703 /* Change slave address */
545 /* Attn.: Slave address is 7 or 10 bits */
546#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
547 /* Attn.: Slave address is 7 or 10 bits */
548 /* This changes the address, even if it */
549 /* is already taken! */
550#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
551
552#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
553#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
554#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
1da177e4
LT		 555
556#define I2C_SMBUS 0x0720 /* SMBus-level access */
557
1da177e4 558/* ----- I2C-DEV: char device interface stuff ------------------------- */
a1b9298e 559#ifdef __KERNEL__
1da177e4
LT		 560
561#define I2C_MAJOR 89 /* Device major number */
562
563/* These defines are used for probing i2c client addresses */
564/* The length of the option lists */
565#define I2C_CLIENT_MAX_OPTS 48
566
567/* Default fill of many variables */
568#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
569 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
570 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
571 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
572 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
573 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
574 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
575 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
576 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
577 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
578 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
579 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
580 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
581 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
582 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
583 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
584
585/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
586 module header */
587
588#define I2C_CLIENT_MODULE_PARM(var,desc) \
589 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
590 static unsigned int var##_num; \
591 module_param_array(var, short, &var##_num, 0); \
592 MODULE_PARM_DESC(var,desc)
593
f4b50261
JD		 594#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
595I2C_CLIENT_MODULE_PARM(force_##name, \
596 "List of adapter,address pairs which are " \
597 "unquestionably assumed to contain a `" \
598 # name "' chip")
599
600
601#define I2C_CLIENT_INSMOD_COMMON \
602I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
603 "additionally"); \
604I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
605 "scan"); \
606static struct i2c_client_address_data addr_data = { \
607 .normal_i2c = normal_i2c, \
608 .probe = probe, \
609 .ignore = ignore, \
610 .forces = forces, \
611}
612
613/* These are the ones you want to use in your own drivers. Pick the one
614 which matches the number of devices the driver differenciates between. */
1da177e4 615#define I2C_CLIENT_INSMOD \
1da177e4
LT		 616 I2C_CLIENT_MODULE_PARM(force, \
617 "List of adapter,address pairs to boldly assume " \
618 "to be present"); \
f4b50261 619 static unsigned short *forces[] = { \
9fc6adfa
JD		 620 force, \
621 NULL \
622 }; \
f4b50261
JD		 623I2C_CLIENT_INSMOD_COMMON
624
625#define I2C_CLIENT_INSMOD_1(chip1) \
626enum chips { any_chip, chip1 }; \
627I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
628 "boldly assume to be present"); \
629I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
630static unsigned short *forces[] = { force, force_##chip1, NULL }; \
631I2C_CLIENT_INSMOD_COMMON
632
633#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
634enum chips { any_chip, chip1, chip2 }; \
635I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
636 "boldly assume to be present"); \
637I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
638I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
639static unsigned short *forces[] = { force, force_##chip1, \
640 force_##chip2, NULL }; \
641I2C_CLIENT_INSMOD_COMMON
642
643#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
644enum chips { any_chip, chip1, chip2, chip3 }; \
645I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
646 "boldly assume to be present"); \
647I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
648I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
649I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
650static unsigned short *forces[] = { force, force_##chip1, \
651 force_##chip2, force_##chip3, \
652 NULL }; \
653I2C_CLIENT_INSMOD_COMMON
654
655#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
656enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
657I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
658 "boldly assume to be present"); \
659I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
660I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
661I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
662I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
663static unsigned short *forces[] = { force, force_##chip1, \
664 force_##chip2, force_##chip3, \
665 force_##chip4, NULL}; \
666I2C_CLIENT_INSMOD_COMMON
667
668#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
669enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
670I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
671 "boldly assume to be present"); \
672I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
673I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
674I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
675I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
676I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
677static unsigned short *forces[] = { force, force_##chip1, \
678 force_##chip2, force_##chip3, \
679 force_##chip4, force_##chip5, \
680 NULL }; \
681I2C_CLIENT_INSMOD_COMMON
682
683#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
684enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
685I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
686 "boldly assume to be present"); \
687I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
688I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
689I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
690I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
691I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
692I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
693static unsigned short *forces[] = { force, force_##chip1, \
694 force_##chip2, force_##chip3, \
695 force_##chip4, force_##chip5, \
696 force_##chip6, NULL }; \
697I2C_CLIENT_INSMOD_COMMON
698
699#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
700enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
701 chip7 }; \
702I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
703 "boldly assume to be present"); \
704I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
705I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
706I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
707I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
708I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
709I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
710I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
711static unsigned short *forces[] = { force, force_##chip1, \
712 force_##chip2, force_##chip3, \
713 force_##chip4, force_##chip5, \
714 force_##chip6, force_##chip7, \
715 NULL }; \
716I2C_CLIENT_INSMOD_COMMON
717
718#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
719enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
720 chip7, chip8 }; \
721I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
722 "boldly assume to be present"); \
723I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
724I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
725I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
726I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
727I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
728I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
729I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
730I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
731static unsigned short *forces[] = { force, force_##chip1, \
732 force_##chip2, force_##chip3, \
733 force_##chip4, force_##chip5, \
734 force_##chip6, force_##chip7, \
735 force_##chip8, NULL }; \
736I2C_CLIENT_INSMOD_COMMON
a1b9298e 737#endif /* __KERNEL__ */
1da177e4 738#endif /* _LINUX_I2C_H */
Clone of davem's net-next-2.6 tree