[PATCH] I2C: add kobj_to_i2c_client
[safe/jmp/linux-2.6] / include / linux / i2c.h
1 /* ------------------------------------------------------------------------- */
2 /*                                                                           */
3 /* i2c.h - definitions for the i2c-bus interface                             */
4 /*                                                                           */
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
23 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
24    Frodo Looijaard <frodol@dds.nl> */
25
26 /* $Id: i2c.h,v 1.68 2003/01/21 08:08:16 kmalkki Exp $ */
27
28 #ifndef _LINUX_I2C_H
29 #define _LINUX_I2C_H
30
31 #include <linux/module.h>
32 #include <linux/types.h>
33 #include <linux/i2c-id.h>
34 #include <linux/device.h>       /* for struct device */
35 #include <asm/semaphore.h>
36
37 /* --- General options ------------------------------------------------ */
38
39 struct i2c_msg;
40 struct i2c_algorithm;
41 struct i2c_adapter;
42 struct i2c_client;
43 struct i2c_driver;
44 struct i2c_client_address_data;
45 union i2c_smbus_data;
46
47 /*
48  * The master routines are the ones normally used to transmit data to devices
49  * on a bus (or read from them). Apart from two basic transfer functions to 
50  * transmit one message at a time, a more complex version can be used to 
51  * transmit an arbitrary number of messages without interruption.
52  */
53 extern int i2c_master_send(struct i2c_client *,const char* ,int);
54 extern int i2c_master_recv(struct i2c_client *,char* ,int);
55
56 /* Transfer num messages.
57  */
58 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
59
60 /*
61  * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor. 
62  * This is not tested/implemented yet and will change in the future.
63  */
64 extern int i2c_slave_send(struct i2c_client *,char*,int);
65 extern int i2c_slave_recv(struct i2c_client *,char*,int);
66
67
68
69 /* This is the very generalized SMBus access routine. You probably do not
70    want to use this, though; one of the functions below may be much easier,
71    and probably just as fast. 
72    Note that we use i2c_adapter here, because you do not need a specific
73    smbus adapter to call this function. */
74 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr, 
75                            unsigned short flags,
76                            char read_write, u8 command, int size,
77                            union i2c_smbus_data * data);
78
79 /* Now follow the 'nice' access routines. These also document the calling
80    conventions of smbus_access. */
81
82 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
83 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
84 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
85 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
86 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
87                                      u8 command, u8 value);
88 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
89 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
90                                      u8 command, u16 value);
91 /* Returns the number of bytes transferred */
92 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
93                                       u8 command, u8 length,
94                                       u8 *values);
95 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
96                                          u8 command, u8 *values);
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.
102  */
103
104 struct i2c_driver {
105         struct module *owner;
106         char name[32];
107         int id;
108         unsigned int class;
109         unsigned int flags;             /* div., see below              */
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
113          * & seek for the presence of the chip(s) it supports. If found, it 
114          * registers the client(s) that are on the bus to the i2c admin. via
115          * i2c_attach_client.
116          */
117         int (*attach_adapter)(struct i2c_adapter *);
118         int (*detach_adapter)(struct i2c_adapter *);
119
120         /* tells the driver that a client is about to be deleted & gives it 
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,
123          * it must be freed here.
124          */
125         int (*detach_client)(struct i2c_client *);
126         
127         /* a ioctl like command that can be used to perform specific functions
128          * with the device.
129          */
130         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
131
132         struct device_driver driver;
133         struct list_head list;
134 };
135 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
136
137 #define I2C_NAME_SIZE   50
138
139 /*
140  * i2c_client identifies a single device (i.e. chip) that is connected to an 
141  * i2c bus. The behaviour is defined by the routines of the driver. This
142  * function is mainly used for lookup & other admin. functions.
143  */
144 struct i2c_client {
145         unsigned int flags;             /* div., see below              */
146         unsigned int addr;              /* chip address - NOTE: 7bit    */
147                                         /* addresses are stored in the  */
148                                         /* _LOWER_ 7 bits of this char  */
149         /* addr: unsigned int to make lm_sensors i2c-isa adapter work
150           more cleanly. It does not take any more memory space, due to
151           alignment considerations */
152         struct i2c_adapter *adapter;    /* the adapter we sit on        */
153         struct i2c_driver *driver;      /* and our access routines      */
154         int usage_count;                /* How many accesses currently  */
155                                         /* to the client                */
156         struct device dev;              /* the device structure         */
157         struct list_head list;
158         char name[I2C_NAME_SIZE];
159         struct completion released;
160 };
161 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
162
163 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
164 {
165         return to_i2c_client(container_of(kobj, struct device, kobj));
166 }
167
168 static inline void *i2c_get_clientdata (struct i2c_client *dev)
169 {
170         return dev_get_drvdata (&dev->dev);
171 }
172
173 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
174 {
175         dev_set_drvdata (&dev->dev, data);
176 }
177
178 #define I2C_DEVNAME(str)        .name = str
179
180 static inline char *i2c_clientname(struct i2c_client *c)
181 {
182         return &c->name[0];
183 }
184
185 /*
186  * The following structs are for those who like to implement new bus drivers:
187  * i2c_algorithm is the interface to a class of hardware solutions which can
188  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
189  * to name two of the most common.
190  */
191 struct i2c_algorithm {
192         char name[32];                          /* textual description  */
193         unsigned int id;
194
195         /* If an adapter algorithm can't do I2C-level access, set master_xfer
196            to NULL. If an adapter algorithm can do SMBus access, set 
197            smbus_xfer. If set to NULL, the SMBus protocol is simulated
198            using common I2C messages */
199         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs, 
200                            int num);
201         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr, 
202                            unsigned short flags, char read_write,
203                            u8 command, int size, union i2c_smbus_data * data);
204
205         /* --- these optional/future use for some adapter types.*/
206         int (*slave_send)(struct i2c_adapter *,char*,int);
207         int (*slave_recv)(struct i2c_adapter *,char*,int);
208
209         /* --- ioctl like call to set div. parameters. */
210         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
211
212         /* To determine what the adapter supports */
213         u32 (*functionality) (struct i2c_adapter *);
214 };
215
216 /*
217  * i2c_adapter is the structure used to identify a physical i2c bus along
218  * with the access algorithms necessary to access it.
219  */
220 struct i2c_adapter {
221         struct module *owner;
222         unsigned int id;/* == is algo->id | hwdep.struct->id,           */
223                         /* for registered values see below              */
224         unsigned int class;
225         struct i2c_algorithm *algo;/* the algorithm to access the bus   */
226         void *algo_data;
227
228         /* --- administration stuff. */
229         int (*client_register)(struct i2c_client *);
230         int (*client_unregister)(struct i2c_client *);
231
232         /* data fields that are valid for all devices   */
233         struct semaphore bus_lock;
234         struct semaphore clist_lock;
235
236         int timeout;
237         int retries;
238         struct device dev;              /* the adapter device */
239         struct class_device class_dev;  /* the class device */
240
241 #ifdef CONFIG_PROC_FS 
242         /* No need to set this when you initialize the adapter          */
243         int inode;
244 #endif /* def CONFIG_PROC_FS */
245
246         int nr;
247         struct list_head clients;
248         struct list_head list;
249         char name[I2C_NAME_SIZE];
250         struct completion dev_released;
251         struct completion class_dev_released;
252 };
253 #define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
254 #define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
255
256 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
257 {
258         return dev_get_drvdata (&dev->dev);
259 }
260
261 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
262 {
263         dev_set_drvdata (&dev->dev, data);
264 }
265
266 /*flags for the driver struct: */
267 #define I2C_DF_NOTIFY   0x01            /* notify on bus (de/a)ttaches  */
268 #if 0
269 /* this flag is gone -- there is a (optional) driver->detach_adapter
270  * callback now which can be used instead */
271 # define I2C_DF_DUMMY   0x02
272 #endif
273
274 /*flags for the client struct: */
275 #define I2C_CLIENT_ALLOW_USE            0x01    /* Client allows access */
276 #define I2C_CLIENT_ALLOW_MULTIPLE_USE   0x02    /* Allow multiple access-locks */
277                                                 /* on an i2c_client */
278 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
279 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
280                                                 /* Must equal I2C_M_TEN below */
281
282 /* i2c adapter classes (bitmask) */
283 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
284 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
285 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
286 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
287 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
288 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
289 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
290 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
291
292 /* i2c_client_address_data is the struct for holding default client
293  * addresses for a driver and for the parameters supplied on the
294  * command line
295  */
296 struct i2c_client_address_data {
297         unsigned short *normal_i2c;
298         unsigned short *probe;
299         unsigned short *ignore;
300         unsigned short *force;
301 };
302
303 /* Internal numbers to terminate lists */
304 #define I2C_CLIENT_END          0xfffeU
305 #define I2C_CLIENT_ISA_END      0xfffefffeU
306
307 /* The numbers to use to set I2C bus address */
308 #define ANY_I2C_BUS             0xffff
309 #define ANY_I2C_ISA_BUS         9191
310
311
312 /* ----- functions exported by i2c.o */
313
314 /* administration...
315  */
316 extern int i2c_add_adapter(struct i2c_adapter *);
317 extern int i2c_del_adapter(struct i2c_adapter *);
318
319 extern int i2c_add_driver(struct i2c_driver *);
320 extern int i2c_del_driver(struct i2c_driver *);
321
322 extern int i2c_attach_client(struct i2c_client *);
323 extern int i2c_detach_client(struct i2c_client *);
324
325 /* New function: This is to get an i2c_client-struct for controlling the 
326    client either by using i2c_control-function or having the 
327    client-module export functions that can be used with the i2c_client
328    -struct. */
329 extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id, 
330                                         struct i2c_client *prev);
331
332 /* Should be used with new function
333    extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
334    to make sure that client-struct is valid and that it is okay to access
335    the i2c-client. 
336    returns -EACCES if client doesn't allow use (default)
337    returns -EBUSY if client doesn't allow multiple use (default) and 
338    usage_count >0 */
339 extern int i2c_use_client(struct i2c_client *);
340 extern int i2c_release_client(struct i2c_client *);
341
342 /* call the i2c_client->command() of all attached clients with
343  * the given arguments */
344 extern void i2c_clients_command(struct i2c_adapter *adap,
345                                 unsigned int cmd, void *arg);
346
347 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
348    other place at which this is called is within i2c_attach_client; so
349    you can cheat by simply not registering. Not recommended, of course! */
350 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
351
352 /* Detect function. It iterates over all possible addresses itself.
353  * It will only call found_proc if some client is connected at the
354  * specific address (unless a 'force' matched);
355  */
356 extern int i2c_probe(struct i2c_adapter *adapter, 
357                 struct i2c_client_address_data *address_data,
358                 int (*found_proc) (struct i2c_adapter *, int, int));
359
360 /* An ioctl like call to set div. parameters of the adapter.
361  */
362 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
363
364 /* This call returns a unique low identifier for each registered adapter,
365  * or -1 if the adapter was not registered. 
366  */
367 extern int i2c_adapter_id(struct i2c_adapter *adap);
368 extern struct i2c_adapter* i2c_get_adapter(int id);
369 extern void i2c_put_adapter(struct i2c_adapter *adap);
370
371
372 /* Return the functionality mask */
373 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
374 {
375         return adap->algo->functionality(adap);
376 }
377
378 /* Return 1 if adapter supports everything we need, 0 if not. */
379 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
380 {
381         return (func & i2c_get_functionality(adap)) == func;
382 }
383
384 /*
385  * I2C Message - used for pure i2c transaction, also from /dev interface
386  */
387 struct i2c_msg {
388         __u16 addr;     /* slave address                        */
389         __u16 flags;            
390 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
391 #define I2C_M_RD        0x01
392 #define I2C_M_NOSTART   0x4000
393 #define I2C_M_REV_DIR_ADDR      0x2000
394 #define I2C_M_IGNORE_NAK        0x1000
395 #define I2C_M_NO_RD_ACK         0x0800
396         __u16 len;              /* msg length                           */
397         __u8 *buf;              /* pointer to msg data                  */
398 };
399
400 /* To determine what functionality is present */
401
402 #define I2C_FUNC_I2C                    0x00000001
403 #define I2C_FUNC_10BIT_ADDR             0x00000002
404 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
405 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
406 #define I2C_FUNC_SMBUS_READ_WORD_DATA_PEC  0x00000800 /* SMBus 2.0 */ 
407 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC 0x00001000 /* SMBus 2.0 */ 
408 #define I2C_FUNC_SMBUS_PROC_CALL_PEC    0x00002000 /* SMBus 2.0 */
409 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL_PEC 0x00004000 /* SMBus 2.0 */
410 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
411 #define I2C_FUNC_SMBUS_QUICK            0x00010000 
412 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000 
413 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000 
414 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000 
415 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000 
416 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000 
417 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000 
418 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000 
419 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000 
420 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000 
421 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
422 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
423 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
424 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
425 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC  0x40000000 /* SMBus 2.0 */
426 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC 0x80000000 /* SMBus 2.0 */
427
428 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
429                              I2C_FUNC_SMBUS_WRITE_BYTE)
430 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
431                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
432 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
433                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
434 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
435                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
436 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
437                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
438 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
439                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
440 #define I2C_FUNC_SMBUS_BLOCK_DATA_PEC (I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC | \
441                                        I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC)
442 #define I2C_FUNC_SMBUS_WORD_DATA_PEC  (I2C_FUNC_SMBUS_READ_WORD_DATA_PEC | \
443                                        I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC)
444
445 #define I2C_FUNC_SMBUS_READ_BYTE_PEC            I2C_FUNC_SMBUS_READ_BYTE_DATA
446 #define I2C_FUNC_SMBUS_WRITE_BYTE_PEC           I2C_FUNC_SMBUS_WRITE_BYTE_DATA
447 #define I2C_FUNC_SMBUS_READ_BYTE_DATA_PEC       I2C_FUNC_SMBUS_READ_WORD_DATA
448 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA_PEC      I2C_FUNC_SMBUS_WRITE_WORD_DATA
449 #define I2C_FUNC_SMBUS_BYTE_PEC                 I2C_FUNC_SMBUS_BYTE_DATA
450 #define I2C_FUNC_SMBUS_BYTE_DATA_PEC            I2C_FUNC_SMBUS_WORD_DATA
451
452 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
453                              I2C_FUNC_SMBUS_BYTE | \
454                              I2C_FUNC_SMBUS_BYTE_DATA | \
455                              I2C_FUNC_SMBUS_WORD_DATA | \
456                              I2C_FUNC_SMBUS_PROC_CALL | \
457                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
458                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC | \
459                              I2C_FUNC_SMBUS_I2C_BLOCK)
460
461 /* 
462  * Data for SMBus Messages 
463  */
464 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */    
465 #define I2C_SMBUS_I2C_BLOCK_MAX 32      /* Not specified but we use same structure */
466 union i2c_smbus_data {
467         __u8 byte;
468         __u16 word;
469         __u8 block[I2C_SMBUS_BLOCK_MAX + 3]; /* block[0] is used for length */
470                           /* one more for read length in block process call */
471                                                     /* and one more for PEC */
472 };
473
474 /* smbus_access read or write markers */
475 #define I2C_SMBUS_READ  1
476 #define I2C_SMBUS_WRITE 0
477
478 /* SMBus transaction types (size parameter in the above functions) 
479    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
480 #define I2C_SMBUS_QUICK             0
481 #define I2C_SMBUS_BYTE              1
482 #define I2C_SMBUS_BYTE_DATA         2 
483 #define I2C_SMBUS_WORD_DATA         3
484 #define I2C_SMBUS_PROC_CALL         4
485 #define I2C_SMBUS_BLOCK_DATA        5
486 #define I2C_SMBUS_I2C_BLOCK_DATA    6
487 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
488 #define I2C_SMBUS_BLOCK_DATA_PEC    8           /* SMBus 2.0 */
489 #define I2C_SMBUS_PROC_CALL_PEC     9           /* SMBus 2.0 */
490 #define I2C_SMBUS_BLOCK_PROC_CALL_PEC  10       /* SMBus 2.0 */
491 #define I2C_SMBUS_WORD_DATA_PEC    11           /* SMBus 2.0 */
492
493
494 /* ----- commands for the ioctl like i2c_command call:
495  * note that additional calls are defined in the algorithm and hw 
496  *      dependent layers - these can be listed here, or see the 
497  *      corresponding header files.
498  */
499                                 /* -> bit-adapter specific ioctls       */
500 #define I2C_RETRIES     0x0701  /* number of times a device address      */
501                                 /* should be polled when not            */
502                                 /* acknowledging                        */
503 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
504
505
506 /* this is for i2c-dev.c        */
507 #define I2C_SLAVE       0x0703  /* Change slave address                 */
508                                 /* Attn.: Slave address is 7 or 10 bits */
509 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
510                                 /* Attn.: Slave address is 7 or 10 bits */
511                                 /* This changes the address, even if it */
512                                 /* is already taken!                    */
513 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
514
515 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
516 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
517 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
518 #if 0
519 #define I2C_ACK_TEST    0x0710  /* See if a slave is at a specific address */
520 #endif
521
522 #define I2C_SMBUS       0x0720  /* SMBus-level access */
523
524 /* ... algo-bit.c recognizes */
525 #define I2C_UDELAY      0x0705  /* set delay in microsecs between each  */
526                                 /* written byte (except address)        */
527 #define I2C_MDELAY      0x0706  /* millisec delay between written bytes */
528
529 /* ----- I2C-DEV: char device interface stuff ------------------------- */
530
531 #define I2C_MAJOR       89              /* Device major number          */
532
533 /* These defines are used for probing i2c client addresses */
534 /* The length of the option lists */
535 #define I2C_CLIENT_MAX_OPTS 48
536
537 /* Default fill of many variables */
538 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
539                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
540                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
541                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
542                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
543                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
544                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
545                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
546                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
547                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
548                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
549                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
550                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
551                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
552                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
553                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
554
555 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
556    module header */
557
558 #define I2C_CLIENT_MODULE_PARM(var,desc) \
559   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
560   static unsigned int var##_num; \
561   module_param_array(var, short, &var##_num, 0); \
562   MODULE_PARM_DESC(var,desc)
563
564 /* This is the one you want to use in your own modules */
565 #define I2C_CLIENT_INSMOD \
566   I2C_CLIENT_MODULE_PARM(probe, \
567                       "List of adapter,address pairs to scan additionally"); \
568   I2C_CLIENT_MODULE_PARM(ignore, \
569                       "List of adapter,address pairs not to scan"); \
570   I2C_CLIENT_MODULE_PARM(force, \
571                       "List of adapter,address pairs to boldly assume " \
572                       "to be present"); \
573         static struct i2c_client_address_data addr_data = {             \
574                         .normal_i2c =           normal_i2c,             \
575                         .probe =                probe,                  \
576                         .ignore =               ignore,                 \
577                         .force =                force,                  \
578                 }
579
580 /* Detect whether we are on the isa bus. If this returns true, all i2c
581    access will fail! */
582 #define i2c_is_isa_client(clientptr) \
583         ((clientptr)->adapter->algo->id == I2C_ALGO_ISA)
584 #define i2c_is_isa_adapter(adapptr) \
585         ((adapptr)->algo->id == I2C_ALGO_ISA)
586
587 #endif /* _LINUX_I2C_H */