Subversion Repositories shark

Rev

Rev 1056 | Details | Compare with Previous | Last modification | View Log | RSS feed

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