blob: 953e71fb07b4e71fe7f3ed8eda32954db2ec3ef7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------------------- */
David Brownell438d6c22006-12-10 21:21:31 +01002/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003/* i2c.h - definitions for the i2c-bus interface */
David Brownell438d6c22006-12-10 21:21:31 +01004/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005/* ------------------------------------------------------------------------- */
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
David Woodhousea1b92982006-04-25 14:14:52 +010023/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 Frodo Looijaard <frodol@dds.nl> */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/types.h>
David Brownell438d6c22006-12-10 21:21:31 +010030#ifdef __KERNEL__
David Woodhousea1b92982006-04-25 14:14:52 +010031#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/i2c-id.h>
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020033#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080035#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010036#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Jean Delvareefde7232005-07-20 23:03:50 +020038/* --- For i2c-isa ---------------------------------------------------- */
39
40extern void i2c_adapter_dev_release(struct device *dev);
Jean Delvareefde7232005-07-20 23:03:50 +020041extern struct class i2c_adapter_class;
42extern struct bus_type i2c_bus_type;
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* --- General options ------------------------------------------------ */
45
46struct i2c_msg;
47struct i2c_algorithm;
48struct i2c_adapter;
49struct i2c_client;
50struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051union i2c_smbus_data;
52
53/*
54 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010055 * on a bus (or read from them). Apart from two basic transfer functions to
56 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * transmit an arbitrary number of messages without interruption.
58 */
59extern int i2c_master_send(struct i2c_client *,const char* ,int);
60extern int i2c_master_recv(struct i2c_client *,char* ,int);
61
62/* Transfer num messages.
63 */
64extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67/* This is the very generalized SMBus access routine. You probably do not
68 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +010069 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 Note that we use i2c_adapter here, because you do not need a specific
71 smbus adapter to call this function. */
David Brownell438d6c22006-12-10 21:21:31 +010072extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 unsigned short flags,
74 char read_write, u8 command, int size,
75 union i2c_smbus_data * data);
76
77/* Now follow the 'nice' access routines. These also document the calling
78 conventions of smbus_access. */
79
80extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
81extern s32 i2c_smbus_read_byte(struct i2c_client * client);
82extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
83extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
84extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
85 u8 command, u8 value);
86extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
87extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
88 u8 command, u16 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
90 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +020091 const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +020092/* Returns the number of read bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
94 u8 command, u8 *values);
Jean Delvare21bbd692006-01-09 15:19:18 +110095extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
96 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +020097 const u8 *values);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/*
100 * A driver is capable of handling one or more physical devices present on
101 * I2C adapters. This information is used to inform the driver of adapter
102 * events.
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100103 *
104 * The driver.owner field should be set to the module owner of this driver.
105 * The driver.name field should be set to the name of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 */
107
108struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 int id;
110 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112 /* Notifies the driver that a new bus has appeared. This routine
113 * can be used by the driver to test if the bus meets its conditions
David Brownell438d6c22006-12-10 21:21:31 +0100114 * & seek for the presence of the chip(s) it supports. If found, it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * registers the client(s) that are on the bus to the i2c admin. via
116 * i2c_attach_client.
117 */
118 int (*attach_adapter)(struct i2c_adapter *);
119 int (*detach_adapter)(struct i2c_adapter *);
120
David Brownell438d6c22006-12-10 21:21:31 +0100121 /* tells the driver that a client is about to be deleted & gives it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 * the chance to remove its private data. Also, if the client struct
123 * has been dynamically allocated by the driver in the function above,
124 * it must be freed here.
125 */
126 int (*detach_client)(struct i2c_client *);
David Brownellf37dd802007-02-13 22:09:00 +0100127
128 /* driver model interfaces that don't relate to enumeration */
129 void (*shutdown)(struct i2c_client *);
130 int (*suspend)(struct i2c_client *, pm_message_t mesg);
131 int (*resume)(struct i2c_client *);
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 /* a ioctl like command that can be used to perform specific functions
134 * with the device.
135 */
136 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
137
138 struct device_driver driver;
139 struct list_head list;
140};
141#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
142
David Brownell2096b952007-05-01 23:26:28 +0200143#define I2C_NAME_SIZE 20
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
David Brownell2096b952007-05-01 23:26:28 +0200145/**
146 * struct i2c_client - represent an I2C slave device
147 * @addr: Address used on the I2C bus connected to the parent adapter.
148 * @name: Indicates the type of the device, usually a chip name that's
149 * generic enough to hide second-sourcing and compatible revisions.
150 * @dev: Driver model device node for the slave.
151 *
152 * An i2c_client identifies a single device (i.e. chip) connected to an
153 * i2c bus. The behaviour is defined by the routines of the driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 */
155struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200156 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100157 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200159 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200160 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 struct i2c_adapter *adapter; /* the adapter we sit on */
162 struct i2c_driver *driver; /* and our access routines */
163 int usage_count; /* How many accesses currently */
164 /* to the client */
165 struct device dev; /* the device structure */
166 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 struct completion released;
168};
169#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
170
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500171static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
172{
173 return to_i2c_client(container_of(kobj, struct device, kobj));
174}
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176static inline void *i2c_get_clientdata (struct i2c_client *dev)
177{
178 return dev_get_drvdata (&dev->dev);
179}
180
181static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
182{
183 dev_set_drvdata (&dev->dev, data);
184}
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/*
187 * The following structs are for those who like to implement new bus drivers:
188 * i2c_algorithm is the interface to a class of hardware solutions which can
189 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
190 * to name two of the most common.
191 */
192struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100194 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 smbus_xfer. If set to NULL, the SMBus protocol is simulated
196 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200197 /* master_xfer should return the number of messages successfully
198 processed, or a negative value on error */
David Brownell438d6c22006-12-10 21:21:31 +0100199 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100201 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 unsigned short flags, char read_write,
203 u8 command, int size, union i2c_smbus_data * data);
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 /* --- ioctl like call to set div. parameters. */
206 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
207
208 /* To determine what the adapter supports */
209 u32 (*functionality) (struct i2c_adapter *);
210};
211
212/*
213 * i2c_adapter is the structure used to identify a physical i2c bus along
214 * with the access algorithms necessary to access it.
215 */
216struct i2c_adapter {
217 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200218 unsigned int id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 unsigned int class;
David Brownellaf71ff62006-09-03 22:37:11 +0200220 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 void *algo_data;
222
223 /* --- administration stuff. */
224 int (*client_register)(struct i2c_client *);
225 int (*client_unregister)(struct i2c_client *);
226
227 /* data fields that are valid for all devices */
Jiri Kosina6ea23032006-12-10 21:21:30 +0100228 u8 level; /* nesting level for lockdep */
Ingo Molnar5c085d32006-01-18 23:16:04 +0100229 struct mutex bus_lock;
230 struct mutex clist_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 int timeout;
233 int retries;
234 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 int nr;
237 struct list_head clients;
238 struct list_head list;
David Brownell2096b952007-05-01 23:26:28 +0200239 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 struct completion dev_released;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241};
242#define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
245{
246 return dev_get_drvdata (&dev->dev);
247}
248
249static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
250{
251 dev_set_drvdata (&dev->dev, data);
252}
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254/*flags for the client struct: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
256#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
257 /* Must equal I2C_M_TEN below */
258
259/* i2c adapter classes (bitmask) */
260#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
261#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
262#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
263#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
264#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
265#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
266#define I2C_CLASS_SOUND (1<<6) /* sound devices */
267#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
268
269/* i2c_client_address_data is the struct for holding default client
270 * addresses for a driver and for the parameters supplied on the
271 * command line
272 */
273struct i2c_client_address_data {
274 unsigned short *normal_i2c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 unsigned short *probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 unsigned short *ignore;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200277 unsigned short **forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278};
279
280/* Internal numbers to terminate lists */
281#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/* The numbers to use to set I2C bus address */
284#define ANY_I2C_BUS 0xffff
285#define ANY_I2C_ISA_BUS 9191
286
287
288/* ----- functions exported by i2c.o */
289
290/* administration...
291 */
292extern int i2c_add_adapter(struct i2c_adapter *);
293extern int i2c_del_adapter(struct i2c_adapter *);
294
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800295extern int i2c_register_driver(struct module *, struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296extern int i2c_del_driver(struct i2c_driver *);
297
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800298static inline int i2c_add_driver(struct i2c_driver *driver)
299{
300 return i2c_register_driver(THIS_MODULE, driver);
301}
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303extern int i2c_attach_client(struct i2c_client *);
304extern int i2c_detach_client(struct i2c_client *);
305
Jean Delvare482c7882005-11-26 21:06:08 +0100306/* Should be used to make sure that client-struct is valid and that it
307 is okay to access the i2c-client.
Jean Delvarecf02df72005-11-26 21:03:41 +0100308 returns -ENODEV if client has gone in the meantime */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309extern int i2c_use_client(struct i2c_client *);
310extern int i2c_release_client(struct i2c_client *);
311
312/* call the i2c_client->command() of all attached clients with
313 * the given arguments */
314extern void i2c_clients_command(struct i2c_adapter *adap,
315 unsigned int cmd, void *arg);
316
317/* returns -EBUSY if address has been taken, 0 if not. Note that the only
318 other place at which this is called is within i2c_attach_client; so
319 you can cheat by simply not registering. Not recommended, of course! */
320extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
321
322/* Detect function. It iterates over all possible addresses itself.
323 * It will only call found_proc if some client is connected at the
324 * specific address (unless a 'force' matched);
325 */
David Brownell438d6c22006-12-10 21:21:31 +0100326extern int i2c_probe(struct i2c_adapter *adapter,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 struct i2c_client_address_data *address_data,
328 int (*found_proc) (struct i2c_adapter *, int, int));
329
330/* An ioctl like call to set div. parameters of the adapter.
331 */
332extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334extern struct i2c_adapter* i2c_get_adapter(int id);
335extern void i2c_put_adapter(struct i2c_adapter *adap);
336
337
338/* Return the functionality mask */
339static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
340{
341 return adap->algo->functionality(adap);
342}
343
344/* Return 1 if adapter supports everything we need, 0 if not. */
345static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
346{
347 return (func & i2c_get_functionality(adap)) == func;
348}
349
Jean Delvarecdcb1922005-07-28 23:09:40 +0200350/* Return id number for a specific adapter */
351static inline int i2c_adapter_id(struct i2c_adapter *adap)
352{
353 return adap->nr;
354}
David Woodhousea1b92982006-04-25 14:14:52 +0100355#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/*
358 * I2C Message - used for pure i2c transaction, also from /dev interface
359 */
360struct i2c_msg {
361 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100362 __u16 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
364#define I2C_M_RD 0x01
365#define I2C_M_NOSTART 0x4000
366#define I2C_M_REV_DIR_ADDR 0x2000
367#define I2C_M_IGNORE_NAK 0x1000
368#define I2C_M_NO_RD_ACK 0x0800
David Brownell438d6c22006-12-10 21:21:31 +0100369 __u16 len; /* msg length */
370 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371};
372
373/* To determine what functionality is present */
374
375#define I2C_FUNC_I2C 0x00000001
376#define I2C_FUNC_10BIT_ADDR 0x00000002
377#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
378#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100380#define I2C_FUNC_SMBUS_QUICK 0x00010000
381#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
382#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
383#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
384#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
385#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
386#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
387#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
388#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
389#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
391#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
392#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
393#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
396 I2C_FUNC_SMBUS_WRITE_BYTE)
397#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
398 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
399#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
400 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
401#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
402 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
403#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
404 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
405#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
406 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
409 I2C_FUNC_SMBUS_BYTE | \
410 I2C_FUNC_SMBUS_BYTE_DATA | \
411 I2C_FUNC_SMBUS_WORD_DATA | \
412 I2C_FUNC_SMBUS_PROC_CALL | \
413 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 I2C_FUNC_SMBUS_I2C_BLOCK)
415
David Brownell438d6c22006-12-10 21:21:31 +0100416/*
417 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 */
David Brownell438d6c22006-12-10 21:21:31 +0100419#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420union i2c_smbus_data {
421 __u8 byte;
422 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200423 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare421ef472005-10-26 21:28:55 +0200424 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426
427/* smbus_access read or write markers */
428#define I2C_SMBUS_READ 1
429#define I2C_SMBUS_WRITE 0
430
David Brownell438d6c22006-12-10 21:21:31 +0100431/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
433#define I2C_SMBUS_QUICK 0
434#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100435#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436#define I2C_SMBUS_WORD_DATA 3
437#define I2C_SMBUS_PROC_CALL 4
438#define I2C_SMBUS_BLOCK_DATA 5
439#define I2C_SMBUS_I2C_BLOCK_DATA 6
440#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442
443/* ----- commands for the ioctl like i2c_command call:
David Brownell438d6c22006-12-10 21:21:31 +0100444 * note that additional calls are defined in the algorithm and hw
445 * dependent layers - these can be listed here, or see the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 * corresponding header files.
447 */
448 /* -> bit-adapter specific ioctls */
449#define I2C_RETRIES 0x0701 /* number of times a device address */
450 /* should be polled when not */
David Brownell438d6c22006-12-10 21:21:31 +0100451 /* acknowledging */
452#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454
455/* this is for i2c-dev.c */
456#define I2C_SLAVE 0x0703 /* Change slave address */
457 /* Attn.: Slave address is 7 or 10 bits */
458#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
459 /* Attn.: Slave address is 7 or 10 bits */
460 /* This changes the address, even if it */
461 /* is already taken! */
462#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
463
464#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
465#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
466#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468#define I2C_SMBUS 0x0720 /* SMBus-level access */
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470/* ----- I2C-DEV: char device interface stuff ------------------------- */
David Woodhousea1b92982006-04-25 14:14:52 +0100471#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473#define I2C_MAJOR 89 /* Device major number */
474
475/* These defines are used for probing i2c client addresses */
476/* The length of the option lists */
477#define I2C_CLIENT_MAX_OPTS 48
478
479/* Default fill of many variables */
480#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
481 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
482 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
483 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
484 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
485 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
486 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
487 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
488 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
489 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
490 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
491 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
492 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
493 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
494 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
495 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
496
497/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
498 module header */
499
500#define I2C_CLIENT_MODULE_PARM(var,desc) \
501 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
502 static unsigned int var##_num; \
503 module_param_array(var, short, &var##_num, 0); \
504 MODULE_PARM_DESC(var,desc)
505
Jean Delvaref4b50262005-07-31 21:49:03 +0200506#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
507I2C_CLIENT_MODULE_PARM(force_##name, \
508 "List of adapter,address pairs which are " \
509 "unquestionably assumed to contain a `" \
510 # name "' chip")
511
512
513#define I2C_CLIENT_INSMOD_COMMON \
514I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
515 "additionally"); \
516I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
517 "scan"); \
518static struct i2c_client_address_data addr_data = { \
519 .normal_i2c = normal_i2c, \
520 .probe = probe, \
521 .ignore = ignore, \
522 .forces = forces, \
523}
524
525/* These are the ones you want to use in your own drivers. Pick the one
526 which matches the number of devices the driver differenciates between. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527#define I2C_CLIENT_INSMOD \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 I2C_CLIENT_MODULE_PARM(force, \
529 "List of adapter,address pairs to boldly assume " \
530 "to be present"); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200531 static unsigned short *forces[] = { \
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200532 force, \
533 NULL \
534 }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200535I2C_CLIENT_INSMOD_COMMON
536
537#define I2C_CLIENT_INSMOD_1(chip1) \
538enum chips { any_chip, chip1 }; \
539I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
540 "boldly assume to be present"); \
541I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
542static unsigned short *forces[] = { force, force_##chip1, NULL }; \
543I2C_CLIENT_INSMOD_COMMON
544
545#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
546enum chips { any_chip, chip1, chip2 }; \
547I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
548 "boldly assume to be present"); \
549I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
550I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
551static unsigned short *forces[] = { force, force_##chip1, \
552 force_##chip2, NULL }; \
553I2C_CLIENT_INSMOD_COMMON
554
555#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
556enum chips { any_chip, chip1, chip2, chip3 }; \
557I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
558 "boldly assume to be present"); \
559I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
560I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
561I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
562static unsigned short *forces[] = { force, force_##chip1, \
563 force_##chip2, force_##chip3, \
564 NULL }; \
565I2C_CLIENT_INSMOD_COMMON
566
567#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
568enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
569I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
570 "boldly assume to be present"); \
571I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
572I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
573I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
574I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
575static unsigned short *forces[] = { force, force_##chip1, \
576 force_##chip2, force_##chip3, \
577 force_##chip4, NULL}; \
578I2C_CLIENT_INSMOD_COMMON
579
580#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
581enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
582I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
583 "boldly assume to be present"); \
584I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
585I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
586I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
587I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
588I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
589static unsigned short *forces[] = { force, force_##chip1, \
590 force_##chip2, force_##chip3, \
591 force_##chip4, force_##chip5, \
592 NULL }; \
593I2C_CLIENT_INSMOD_COMMON
594
595#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
596enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
597I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
598 "boldly assume to be present"); \
599I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
600I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
601I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
602I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
603I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
604I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
605static unsigned short *forces[] = { force, force_##chip1, \
606 force_##chip2, force_##chip3, \
607 force_##chip4, force_##chip5, \
608 force_##chip6, NULL }; \
609I2C_CLIENT_INSMOD_COMMON
610
611#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
612enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
613 chip7 }; \
614I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
615 "boldly assume to be present"); \
616I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
617I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
618I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
619I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
620I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
621I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
622I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
623static unsigned short *forces[] = { force, force_##chip1, \
624 force_##chip2, force_##chip3, \
625 force_##chip4, force_##chip5, \
626 force_##chip6, force_##chip7, \
627 NULL }; \
628I2C_CLIENT_INSMOD_COMMON
629
630#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
631enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
632 chip7, chip8 }; \
633I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
634 "boldly assume to be present"); \
635I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
636I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
637I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
638I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
639I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
640I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
641I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
642I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
643static unsigned short *forces[] = { force, force_##chip1, \
644 force_##chip2, force_##chip3, \
645 force_##chip4, force_##chip5, \
646 force_##chip6, force_##chip7, \
647 force_##chip8, NULL }; \
648I2C_CLIENT_INSMOD_COMMON
David Woodhousea1b92982006-04-25 14:14:52 +0100649#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650#endif /* _LINUX_I2C_H */