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