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