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