home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / lxapi32.zip / Include / Linux / i2c.h < prev    next >
C/C++ Source or Header  |  2002-04-26  |  23KB  |  577 lines
  1. /* $Id: i2c.h,v 1.2 2002/04/26 23:09:05 smilcke Exp $ */
  2.  
  3. /* ------------------------------------------------------------------------- */
  4. /*                                          */
  5. /* i2c.h - definitions for the i2c-bus interface                 */
  6. /*                                          */
  7. /* ------------------------------------------------------------------------- */
  8. /*   Copyright (C) 1995-2000 Simon G. Vogl
  9.  
  10.     This program is free software; you can redistribute it and/or modify
  11.     it under the terms of the GNU General Public License as published by
  12.     the Free Software Foundation; either version 2 of the License, or
  13.     (at your option) any later version.
  14.  
  15.     This program is distributed in the hope that it will be useful,
  16.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.     GNU General Public License for more details.
  19.  
  20.     You should have received a copy of the GNU General Public License
  21.     along with this program; if not, write to the Free Software
  22.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.             */
  23. /* ------------------------------------------------------------------------- */
  24.  
  25. /* With some changes from Ky÷sti MΣlkki <kmalkki@cc.hut.fi> and
  26.    Frodo Looijaard <frodol@dds.nl> */
  27.  
  28. /* $Id: i2c.h,v 1.2 2002/04/26 23:09:05 smilcke Exp $ */
  29.  
  30. #ifndef I2C_H
  31. #define I2C_H
  32.  
  33. #include <linux/i2c-id.h>    /* id values of adapters et. al.     */
  34. #include <linux/types.h>
  35.  
  36.  
  37. struct i2c_msg;
  38.  
  39. #ifdef __KERNEL__
  40.  
  41. /* --- Includes and compatibility declarations ------------------------ */
  42.  
  43. #include <linux/version.h>
  44. #ifndef KERNEL_VERSION
  45. #define KERNEL_VERSION(a,b,c) (((a) << 16) | ((b) << 8) | (c))
  46. #endif
  47.  
  48. #include <asm/page.h>            /* for 2.2.xx             */
  49. #if LINUX_VERSION_CODE < KERNEL_VERSION(2,0,25)
  50. #include <linux/sched.h>
  51. #else
  52. #include <asm/semaphor.h>
  53. #endif
  54. #include <linux/config.h>
  55.  
  56. /* --- General options ------------------------------------------------    */
  57.  
  58. #define I2C_ALGO_MAX    4        /* control memory consumption    */
  59. #define I2C_ADAP_MAX    16
  60. #define I2C_DRIVER_MAX    16
  61. #define I2C_CLIENT_MAX    32
  62. #define I2C_DUMMY_MAX 4
  63.  
  64. struct i2c_algorithm;
  65. struct i2c_adapter;
  66. struct i2c_client;
  67. struct i2c_driver;
  68. struct i2c_client_address_data;
  69. union i2c_smbus_data;
  70.  
  71.  
  72. /*
  73.  * The master routines are the ones normally used to transmit data to devices
  74.  * on a bus (or read from them). Apart from two basic transfer functions to
  75.  * transmit one message at a time, a more complex version can be used to
  76.  * transmit an arbitrary number of messages without interruption.
  77.  */
  78. #if (defined(TARGET_OS2) && !defined(NOOS2LXAPI))
  79. extern int (*i2c_master_send)(struct i2c_client *,const char *,int);
  80. extern int (*i2c_master_recv)(struct i2c_client *,char *,int);
  81. #else
  82. extern int i2c_master_send(struct i2c_client *,const char* ,int);
  83. extern int i2c_master_recv(struct i2c_client *,char* ,int);
  84. #endif
  85.  
  86. /* Transfer num messages.
  87.  */
  88. #if (defined(TARGET_OS2) && !defined(NOOS2LXAPI))
  89. extern int (*i2c_transfer)(struct i2c_adapter *adap,struct i2c_msg *msg,int num);
  90. #else
  91. extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg msg[],int num);
  92. #endif
  93.  
  94. /*
  95.  * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
  96.  * This is not tested/implemented yet and will change in the future.
  97.  */
  98. extern int i2c_slave_send(struct i2c_client *,char*,int);
  99. extern int i2c_slave_recv(struct i2c_client *,char*,int);
  100.  
  101.  
  102.  
  103. /* This is the very generalized SMBus access routine. You probably do not
  104.    want to use this, though; one of the functions below may be much easier,
  105.    and probably just as fast.
  106.    Note that we use i2c_adapter here, because you do not need a specific
  107.    smbus adapter to call this function. */
  108. extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  109.                            unsigned short flags,
  110.                            char read_write, u8 command, int size,
  111.                            union i2c_smbus_data * data);
  112.  
  113. /* Now follow the 'nice' access routines. These also document the calling
  114.    conventions of smbus_access. */
  115.  
  116. extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  117. extern s32 i2c_smbus_read_byte(struct i2c_client * client);
  118. extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
  119. extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
  120. extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
  121.                                      u8 command, u8 value);
  122. extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
  123. extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
  124.                                      u8 command, u16 value);
  125. extern s32 i2c_smbus_process_call(struct i2c_client * client,
  126.                                   u8 command, u16 value);
  127. /* Returns the number of read bytes */
  128. extern s32 i2c_smbus_read_block_data(struct i2c_client * client,
  129.                                      u8 command, u8 *values);
  130. extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  131.                                       u8 command, u8 length,
  132.                                       u8 *values);
  133. extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
  134.                                           u8 command, u8 length,
  135.                                           u8 *values);
  136.  
  137.  
  138. /*
  139.  * A driver is capable of handling one or more physical devices present on
  140.  * I2C adapters. This information is used to inform the driver of adapter
  141.  * events.
  142.  */
  143.  
  144. struct i2c_driver {
  145.     char name[32];
  146.     int id;
  147.     unsigned int flags;        /* div., see below        */
  148.  
  149.     /* Notifies the driver that a new bus has appeared. This routine
  150.      * can be used by the driver to test if the bus meets its conditions
  151.      * & seek for the presence of the chip(s) it supports. If found, it
  152.      * registers the client(s) that are on the bus to the i2c admin. via
  153.      * i2c_attach_client.
  154.      */
  155.     int (*attach_adapter)(struct i2c_adapter *);
  156.  
  157.     /* tells the driver that a client is about to be deleted & gives it
  158.      * the chance to remove its private data. Also, if the client struct
  159.      * has been dynamically allocated by the driver in the function above,
  160.      * it must be freed here.
  161.      */
  162.     int (*detach_client)(struct i2c_client *);
  163.     
  164.     /* a ioctl like command that can be used to perform specific functions
  165.      * with the device.
  166.      */
  167.     int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
  168.     
  169.     /* These two are mainly used for bookkeeping & dynamic unloading of
  170.      * kernel modules. inc_use tells the driver that a client is being
  171.      * used by another module & that it should increase its ref. counter.
  172.      * dec_use is the inverse operation.
  173.      * NB: Make sure you have no circular dependencies, or else you get a
  174.      * deadlock when trying to unload the modules.
  175.     * You should use the i2c_{inc,dec}_use_client functions instead of
  176.     * calling this function directly.
  177.      */
  178.     void (*inc_use)(struct i2c_client *client);
  179.     void (*dec_use)(struct i2c_client *client);
  180. #ifdef TARGET_OS2
  181.    struct lxrm_device* rm_device;
  182. #endif
  183. };
  184.  
  185. /*
  186.  * i2c_client identifies a single device (i.e. chip) that is connected to an
  187.  * i2c bus. The behaviour is defined by the routines of the driver. This
  188.  * function is mainly used for lookup & other admin. functions.
  189.  */
  190. struct i2c_client {
  191.     char name[32];
  192.     int id;
  193.     unsigned int flags;        /* div., see below        */
  194.     unsigned int addr;        /* chip address - NOTE: 7bit     */
  195.                     /* addresses are stored in the    */
  196.                     /* _LOWER_ 7 bits of this char    */
  197.     /* addr: unsigned int to make lm_sensors i2c-isa adapter work
  198.       more cleanly. It does not take any more memory space, due to
  199.       alignment considerations */
  200.     struct i2c_adapter *adapter;    /* the adapter we sit on    */
  201.     struct i2c_driver *driver;    /* and our access routines    */
  202.     void *data;            /* for the clients        */
  203.     int usage_count;        /* How many accesses currently  */
  204.                     /* to the client        */
  205. };
  206.  
  207.  
  208. /*
  209.  * The following structs are for those who like to implement new bus drivers:
  210.  * i2c_algorithm is the interface to a class of hardware solutions which can
  211.  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
  212.  * to name two of the most common.
  213.  */
  214. struct i2c_algorithm {
  215.     char name[32];                /* textual description     */
  216.     unsigned int id;
  217.  
  218.     /* If a adapter algorithm can't to I2C-level access, set master_xfer
  219.        to NULL. If an adapter algorithm can do SMBus access, set
  220.        smbus_xfer. If set to NULL, the SMBus protocol is simulated
  221.        using common I2C messages */
  222.     int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg msgs[],
  223.                        int num);
  224.     int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
  225.                        unsigned short flags, char read_write,
  226.                        u8 command, int size, union i2c_smbus_data * data);
  227.  
  228.     /* --- these optional/future use for some adapter types.*/
  229.     int (*slave_send)(struct i2c_adapter *,char*,int);
  230.     int (*slave_recv)(struct i2c_adapter *,char*,int);
  231.  
  232.     /* --- ioctl like call to set div. parameters. */
  233.     int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
  234.  
  235.     /* To determine what the adapter supports */
  236.     u32 (*functionality) (struct i2c_adapter *);
  237. };
  238.  
  239. #if LINUX_VERSION_CODE < KERNEL_VERSION(2,1,29)
  240. struct proc_dir_entry;
  241. #endif
  242.  
  243. /*
  244.  * i2c_adapter is the structure used to identify a physical i2c bus along
  245.  * with the access algorithms necessary to access it.
  246.  */
  247. struct i2c_adapter {
  248.     char name[32];    /* some useful name to identify the adapter    */
  249.     unsigned int id;/* == is algo->id | hwdep.struct->id,         */
  250.             /* for registered values see below        */
  251.     struct i2c_algorithm *algo;/* the algorithm to access the bus    */
  252.     void *algo_data;
  253.  
  254.     /* --- These may be NULL, but should increase the module use count */
  255.     void (*inc_use)(struct i2c_adapter *);
  256.     void (*dec_use)(struct i2c_adapter *);
  257.  
  258.     /* --- administration stuff. */
  259.     int (*client_register)(struct i2c_client *);
  260.     int (*client_unregister)(struct i2c_client *);
  261.  
  262.     void *data;    /* private data for the adapter            */
  263.             /* some data fields that are used by all types    */
  264.             /* these data fields are readonly to the public    */
  265.             /* and can be set via the i2c_ioctl call    */
  266.  
  267.             /* data fields that are valid for all devices    */
  268.     struct semaphore lock;
  269.     unsigned int flags;/* flags specifying div. data        */
  270.  
  271.     struct i2c_client *clients[I2C_CLIENT_MAX];
  272.     int client_count;
  273.  
  274.     int timeout;
  275.     int retries;
  276.  
  277. #ifdef CONFIG_PROC_FS
  278.     /* No need to set this when you initialize the adapter          */
  279.     int inode;
  280. #if LINUX_VERSION_CODE < KERNEL_VERSION(2,1,29)
  281.     struct proc_dir_entry *proc_entry;
  282. #endif
  283. #endif /* def CONFIG_PROC_FS */
  284. };
  285.  
  286. /*flags for the driver struct: */
  287. #define I2C_DF_NOTIFY    0x01        /* notify on bus (de/a)ttaches     */
  288. #define I2C_DF_DUMMY    0x02        /* do not connect any clients */
  289.  
  290. /*flags for the client struct: */
  291. #define I2C_CLIENT_ALLOW_USE        0x01    /* Client allows access */
  292. #define I2C_CLIENT_ALLOW_MULTIPLE_USE     0x02      /* Allow multiple access-locks */
  293.                         /* on an i2c_client */
  294.  
  295. /* i2c_client_address_data is the struct for holding default client
  296.  * addresses for a driver and for the parameters supplied on the
  297.  * command line
  298.  */
  299. struct i2c_client_address_data {
  300.     unsigned short *normal_i2c;
  301.     unsigned short *normal_i2c_range;
  302.     unsigned short *probe;
  303.     unsigned short *probe_range;
  304.     unsigned short *ignore;
  305.     unsigned short *ignore_range;
  306.     unsigned short *force;
  307. };
  308.  
  309. /* Internal numbers to terminate lists */
  310. #define I2C_CLIENT_END 0xfffe
  311.  
  312. /* The numbers to use to set I2C bus address */
  313. #define ANY_I2C_BUS 0xffff
  314.  
  315. /* The length of the option lists */
  316. #define I2C_CLIENT_MAX_OPTS 48
  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. #if (defined(TARGET_OS2) && !defined(NOOS2LXAPI))
  327. extern int (*i2c_add_driver)(struct i2c_driver *);
  328. extern int (*i2c_del_driver)(struct i2c_driver *);
  329. extern int (*i2c_attach_client)(struct i2c_client *);
  330. extern int (*i2c_detach_client)(struct i2c_client *);
  331. #else
  332. extern int i2c_add_driver(struct i2c_driver *);
  333. extern int i2c_del_driver(struct i2c_driver *);
  334. extern int i2c_attach_client(struct i2c_client *);
  335. extern int i2c_detach_client(struct i2c_client *);
  336. #endif
  337.  
  338. /* Only call these if you grab a resource that makes unloading the
  339.    client and the adapter it is on completely impossible. Like when a
  340.    /proc directory is entered. */
  341. extern void i2c_inc_use_client(struct i2c_client *);
  342. extern void i2c_dec_use_client(struct i2c_client *);
  343.  
  344. /* New function: This is to get an i2c_client-struct for controlling the
  345.    client either by using i2c_control-function or having the
  346.    client-module export functions that can be used with the i2c_client
  347.    -struct. */
  348. extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
  349.                     struct i2c_client *prev);
  350.  
  351. /* Should be used with new function
  352.    extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
  353.    to make sure that client-struct is valid and that it is okay to access
  354.    the i2c-client.
  355.    returns -EACCES if client doesn't allow use (default)
  356.    returns -EBUSY if client doesn't allow multiple use (default) and
  357.    usage_count >0 */
  358. extern int i2c_use_client(struct i2c_client *);
  359. extern int i2c_release_client(struct i2c_client *);
  360.  
  361. /* returns -EBUSY if address has been taken, 0 if not. Note that the only
  362.    other place at which this is called is within i2c_attach_client; so
  363.    you can cheat by simply not registering. Not recommended, of course! */
  364. extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
  365.  
  366. /* Detect function. It itterates over all possible addresses itself.
  367.  * It will only call found_proc if some client is connected at the
  368.  * specific address (unless a 'force' matched);
  369.  */
  370. typedef int i2c_client_found_addr_proc (struct i2c_adapter *adapter,
  371.                                      int addr, unsigned short flags,int kind);
  372.  
  373. #if (defined(TARGET_OS2) && !defined(NOOS2LXAPI))
  374. extern int (*i2c_probe)(struct i2c_adapter *adapter,struct i2c_client_address_data *adress_data,i2c_client_found_addr_proc *found_proc);
  375. #else
  376. extern int i2c_probe(struct i2c_adapter *adapter,
  377.         struct i2c_client_address_data *address_data,
  378.         i2c_client_found_addr_proc *found_proc);
  379. #endif
  380.  
  381. /* An ioctl like call to set div. parameters of the adapter.
  382.  */
  383. extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
  384.  
  385. /* This call returns a unique low identifier for each registered adapter,
  386.  * or -1 if the adapter was not regisitered.
  387.  */
  388. extern int i2c_adapter_id(struct i2c_adapter *adap);
  389.  
  390.  
  391.  
  392. /* Return the functionality mask */
  393. extern u32 i2c_get_functionality (struct i2c_adapter *adap);
  394.  
  395. /* Return 1 if adapter supports everything we need, 0 if not. */
  396. extern int i2c_check_functionality (struct i2c_adapter *adap, u32 func);
  397.  
  398. #endif /* __KERNEL__ */
  399.  
  400. /*
  401.  * I2C Message - used for pure i2c transaction, also from /dev interface
  402.  */
  403. struct i2c_msg {
  404.     __u16 addr;    /* slave address            */
  405.     unsigned short flags;        
  406. #define I2C_M_TEN    0x10    /* we have a ten bit chip address    */
  407. #define I2C_M_RD    0x01
  408. #define I2C_M_NOSTART    0x4000
  409. #define I2C_M_REV_DIR_ADDR    0x2000
  410.     short len;        /* msg length                */
  411.     char *buf;        /* pointer to msg data            */
  412. };
  413.  
  414. /* To determine what functionality is present */
  415.  
  416. #define I2C_FUNC_I2C            0x00000001
  417. #define I2C_FUNC_10BIT_ADDR        0x00000002
  418. #define I2C_FUNC_PROTOCOL_MANGLING    0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART} */
  419. #define I2C_FUNC_SMBUS_QUICK        0x00010000
  420. #define I2C_FUNC_SMBUS_READ_BYTE    0x00020000
  421. #define I2C_FUNC_SMBUS_WRITE_BYTE    0x00040000
  422. #define I2C_FUNC_SMBUS_READ_BYTE_DATA    0x00080000
  423. #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA    0x00100000
  424. #define I2C_FUNC_SMBUS_READ_WORD_DATA    0x00200000
  425. #define I2C_FUNC_SMBUS_WRITE_WORD_DATA    0x00400000
  426. #define I2C_FUNC_SMBUS_PROC_CALL    0x00800000
  427. #define I2C_FUNC_SMBUS_READ_BLOCK_DATA    0x01000000
  428. #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
  429. #define I2C_FUNC_SMBUS_READ_I2C_BLOCK    0x04000000 /* New I2C-like block */
  430. #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK    0x08000000 /* transfer */
  431.  
  432. #define I2C_FUNC_SMBUS_BYTE I2C_FUNC_SMBUS_READ_BYTE | \
  433.                             I2C_FUNC_SMBUS_WRITE_BYTE
  434. #define I2C_FUNC_SMBUS_BYTE_DATA I2C_FUNC_SMBUS_READ_BYTE_DATA | \
  435.                                  I2C_FUNC_SMBUS_WRITE_BYTE_DATA
  436. #define I2C_FUNC_SMBUS_WORD_DATA I2C_FUNC_SMBUS_READ_WORD_DATA | \
  437.                                  I2C_FUNC_SMBUS_WRITE_WORD_DATA
  438. #define I2C_FUNC_SMBUS_BLOCK_DATA I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
  439.                                   I2C_FUNC_SMBUS_WRITE_BLOCK_DATA
  440. #define I2C_FUNC_SMBUS_I2C_BLOCK I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
  441.                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK
  442.  
  443. #define I2C_FUNC_SMBUS_EMUL I2C_FUNC_SMBUS_QUICK | \
  444.                             I2C_FUNC_SMBUS_BYTE | \
  445.                             I2C_FUNC_SMBUS_BYTE_DATA | \
  446.                             I2C_FUNC_SMBUS_WORD_DATA | \
  447.                             I2C_FUNC_SMBUS_PROC_CALL | \
  448.                             I2C_FUNC_SMBUS_WRITE_BLOCK_DATA
  449.  
  450. /*
  451.  * Data for SMBus Messages
  452.  */
  453. union i2c_smbus_data {
  454.     __u8 byte;
  455.     __u16 word;
  456.     __u8 block[33]; /* block[0] is used for length */
  457. };
  458.  
  459. /* smbus_access read or write markers */
  460. #define I2C_SMBUS_READ    1
  461. #define I2C_SMBUS_WRITE    0
  462.  
  463. /* SMBus transaction types (size parameter in the above functions)
  464.    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
  465. #define I2C_SMBUS_QUICK            0
  466. #define I2C_SMBUS_BYTE            1
  467. #define I2C_SMBUS_BYTE_DATA        2
  468. #define I2C_SMBUS_WORD_DATA        3
  469. #define I2C_SMBUS_PROC_CALL        4
  470. #define I2C_SMBUS_BLOCK_DATA        5
  471. #define I2C_SMBUS_I2C_BLOCK_DATA    6
  472.  
  473.  
  474. /* ----- commands for the ioctl like i2c_command call:
  475.  * note that additional calls are defined in the algorithm and hw
  476.  *    dependent layers - these can be listed here, or see the
  477.  *    corresponding header files.
  478.  */
  479.                 /* -> bit-adapter specific ioctls    */
  480. #define I2C_RETRIES    0x0701    /* number times a device address should    */
  481.                 /* be polled when not acknowledging     */
  482. #define I2C_TIMEOUT    0x0702    /* set timeout - call with int         */
  483.  
  484.  
  485. /* this is for i2c-dev.c    */
  486. #define I2C_SLAVE    0x0703    /* Change slave address            */
  487.                 /* Attn.: Slave address is 7 or 10 bits */
  488. #define I2C_SLAVE_FORCE    0x0706    /* Change slave address            */
  489.                 /* Attn.: Slave address is 7 or 10 bits */
  490.                 /* This changes the address, even if it */
  491.                 /* is already taken!            */
  492. #define I2C_TENBIT    0x0704    /* 0 for 7 bit addrs, != 0 for 10 bit    */
  493.  
  494. #define I2C_FUNCS    0x0705    /* Get the adapter functionality */
  495. #define I2C_RDWR    0x0707    /* Combined R/W transfer (one stop only)*/
  496. #if 0
  497. #define I2C_ACK_TEST    0x0710    /* See if a slave is at a specific address */
  498. #endif
  499.  
  500. #define I2C_SMBUS    0x0720    /* SMBus-level access */
  501.  
  502. /* ... algo-bit.c recognizes */
  503. #define I2C_UDELAY    0x0705    /* set delay in microsecs between each    */
  504.                 /* written byte (except address)    */
  505. #define I2C_MDELAY    0x0706    /* millisec delay between written bytes */
  506.  
  507. /* ----- I2C-DEV: char device interface stuff ------------------------- */
  508.  
  509. #define I2C_MAJOR    89        /* Device major number        */
  510.  
  511. #ifdef __KERNEL__
  512.  
  513. #  ifndef NULL
  514. #    define NULL ( (void *) 0 )
  515. #  endif
  516.  
  517. #  ifndef ENODEV
  518. #    include <asm/errno.h>
  519. #  endif
  520.  
  521. /* These defines are used for probing i2c client addresses */
  522. /* Default fill of many variables */
  523. #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  524.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  525.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  526.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  527.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  528.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  529.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  530.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  531.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  532.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  533.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  534.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  535.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  536.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  537.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
  538.                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
  539.  
  540. /* This is ugly. We need to evaluate I2C_CLIENT_MAX_OPTS before it is
  541.    stringified */
  542. #define I2C_CLIENT_MODPARM_AUX1(x) "1-" #x "h"
  543. #define I2C_CLIENT_MODPARM_AUX(x) I2C_CLIENT_MODPARM_AUX1(x)
  544. #define I2C_CLIENT_MODPARM I2C_CLIENT_MODPARM_AUX(I2C_CLIENT_MAX_OPTS)
  545.  
  546. /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
  547.    module header */
  548.  
  549. #define I2C_CLIENT_MODULE_PARM(var,desc) \
  550.   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
  551.   MODULE_PARM(var,I2C_CLIENT_MODPARM); \
  552.   MODULE_PARM_DESC(var,desc)
  553.  
  554. /* This is the one you want to use in your own modules */
  555. #define I2C_CLIENT_INSMOD \
  556.   I2C_CLIENT_MODULE_PARM(probe, \
  557.                       "List of adapter,address pairs to scan additionally"); \
  558.   I2C_CLIENT_MODULE_PARM(probe_range, \
  559.                       "List of adapter,start-addr,end-addr triples to scan " \
  560.                       "additionally"); \
  561.   I2C_CLIENT_MODULE_PARM(ignore, \
  562.                       "List of adapter,address pairs not to scan"); \
  563.   I2C_CLIENT_MODULE_PARM(ignore_range, \
  564.                       "List of adapter,start-addr,end-addr triples not to " \
  565.                       "scan"); \
  566.   I2C_CLIENT_MODULE_PARM(force, \
  567.                       "List of adapter,address pairs to boldly assume " \
  568.                       "to be present"); \
  569.   static struct i2c_client_address_data addr_data = \
  570.                                        {normal_i2c, normal_i2c_range, \
  571.                                         probe, probe_range, \
  572.                                         ignore, ignore_range, \
  573.                                         force}
  574.  
  575. #endif /* def __KERNEL__ */
  576. #endif /* I2C_H */
  577.