Blame view

include/linux/i2c.h 22.6 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
  /* ------------------------------------------------------------------------- */
438d6c2c0   David Brownell   i2c: Whitespace c...
2
  /*									     */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
3
  /* i2c.h - definitions for the i2c-bus interface			     */
438d6c2c0   David Brownell   i2c: Whitespace c...
4
  /*									     */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  /* ------------------------------------------------------------------------- */
  /*   Copyright (C) 1995-2000 Simon G. Vogl
  
      This program is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published by
      the Free Software Foundation; either version 2 of the License, or
      (at your option) any later version.
  
      This program is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      GNU General Public License for more details.
  
      You should have received a copy of the GNU General Public License
      along with this program; if not, write to the Free Software
      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.		     */
  /* ------------------------------------------------------------------------- */
a1b9298e5   David Woodhouse   Sanitise linux/i2...
22
  /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
23
     Frodo Looijaard <frodol@dds.nl> */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
24
25
  #ifndef _LINUX_I2C_H
  #define _LINUX_I2C_H
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26
  #include <linux/types.h>
438d6c2c0   David Brownell   i2c: Whitespace c...
27
  #ifdef __KERNEL__
a1b9298e5   David Woodhouse   Sanitise linux/i2...
28
  #include <linux/module.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
29
  #include <linux/i2c-id.h>
a9d1b24d9   Greg Kroah-Hartman   [PATCH] I2C: add ...
30
  #include <linux/mod_devicetable.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
31
  #include <linux/device.h>	/* for struct device */
4e57b6817   Tim Schmielau   [PATCH] fix missi...
32
  #include <linux/sched.h>	/* for completion */
5c085d369   Ingo Molnar   [PATCH] i2c: Sema...
33
  #include <linux/mutex.h>
d12d42f74   Grant Likely   i2c/of: Allow dev...
34
  #include <linux/of.h>		/* for struct device_node */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
35

e9ca9eb9d   Jon Smirl   i2c: Export the i...
36
  extern struct bus_type i2c_bus_type;
0826374bf   Michael Lawnick   i2c: Multiplexed ...
37
  extern struct device_type i2c_adapter_type;
e9ca9eb9d   Jon Smirl   i2c: Export the i...
38

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
39
40
41
42
43
44
45
  /* --- General options ------------------------------------------------	*/
  
  struct i2c_msg;
  struct i2c_algorithm;
  struct i2c_adapter;
  struct i2c_client;
  struct i2c_driver;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
46
  union i2c_smbus_data;
4735c98f8   Jean Delvare   i2c: Add detectio...
47
  struct i2c_board_info;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
48

23af84005   Jean Delvare   i2c: Don't advert...
49
  #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
50
51
  /*
   * The master routines are the ones normally used to transmit data to devices
438d6c2c0   David Brownell   i2c: Whitespace c...
52
53
   * on a bus (or read from them). Apart from two basic transfer functions to
   * transmit one message at a time, a more complex version can be used to
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
54
   * transmit an arbitrary number of messages without interruption.
0c43ea544   Zhangfei Gao   i2c: Document the...
55
   * @count must be be less than 64k since msg.len is u16.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
56
   */
0cc43a180   Jean Delvare   i2c: Constify i2c...
57
58
59
  extern int i2c_master_send(const struct i2c_client *client, const char *buf,
  			   int count);
  extern int i2c_master_recv(const struct i2c_client *client, char *buf,
3ae70deef   Jean Delvare   i2c: Clean up <li...
60
  			   int count);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
62
63
  
  /* Transfer num messages.
   */
3ae70deef   Jean Delvare   i2c: Clean up <li...
64
65
  extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
  			int num);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
66
67
68
  
  /* This is the very generalized SMBus access routine. You probably do not
     want to use this, though; one of the functions below may be much easier,
438d6c2c0   David Brownell   i2c: Whitespace c...
69
     and probably just as fast.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
70
71
     Note that we use i2c_adapter here, because you do not need a specific
     smbus adapter to call this function. */
3ae70deef   Jean Delvare   i2c: Clean up <li...
72
73
74
  extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
  			  unsigned short flags, char read_write, u8 command,
  			  int size, union i2c_smbus_data *data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
75
76
  
  /* Now follow the 'nice' access routines. These also document the calling
ae7193f7f   Jean Delvare   i2c: Update stray...
77
     conventions of i2c_smbus_xfer. */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
78

0cc43a180   Jean Delvare   i2c: Constify i2c...
79
80
81
82
83
  extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
  extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
  extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
  				    u8 command);
  extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
3ae70deef   Jean Delvare   i2c: Clean up <li...
84
  				     u8 command, u8 value);
0cc43a180   Jean Delvare   i2c: Constify i2c...
85
86
87
  extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
  				    u8 command);
  extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
3ae70deef   Jean Delvare   i2c: Clean up <li...
88
  				     u8 command, u16 value);
b86a1bc8e   Jean Delvare   i2c: Restore i2c_...
89
  /* Returns the number of read bytes */
0cc43a180   Jean Delvare   i2c: Constify i2c...
90
  extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
b86a1bc8e   Jean Delvare   i2c: Restore i2c_...
91
  				     u8 command, u8 *values);
0cc43a180   Jean Delvare   i2c: Constify i2c...
92
  extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
3ae70deef   Jean Delvare   i2c: Clean up <li...
93
  				      u8 command, u8 length, const u8 *values);
31ec5bc57   Jean Delvare   [PATCH] i2c: Fix ...
94
  /* Returns the number of read bytes */
0cc43a180   Jean Delvare   i2c: Constify i2c...
95
  extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
4b2643d7d   Jean Delvare   i2c: Fix the i2c_...
96
  					 u8 command, u8 length, u8 *values);
0cc43a180   Jean Delvare   i2c: Constify i2c...
97
  extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
21bbd6918   Jean Delvare   [PATCH] I2C: Resu...
98
  					  u8 command, u8 length,
46f5ed753   Krzysztof Halasa   [PATCH] i2c: Mark...
99
  					  const u8 *values);
23af84005   Jean Delvare   i2c: Don't advert...
100
  #endif /* I2C */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
101

4735c98f8   Jean Delvare   i2c: Add detectio...
102
103
104
  /**
   * struct i2c_driver - represent an I2C device driver
   * @class: What kind of i2c device we instantiate (for detect)
96e21e4fb   Jean Delvare   i2c: Add missing ...
105
106
   * @attach_adapter: Callback for bus addition (for legacy drivers)
   * @detach_adapter: Callback for bus removal (for legacy drivers)
729d6dd57   Jean Delvare   i2c: Get rid of t...
107
108
   * @probe: Callback for device binding
   * @remove: Callback for device unbinding
96e21e4fb   Jean Delvare   i2c: Add missing ...
109
110
111
   * @shutdown: Callback for device shutdown
   * @suspend: Callback for device suspend
   * @resume: Callback for device resume
72d2e9f9f   Randy Dunlap   i2c.h: fix kernel...
112
   * @alert: Alert callback, for example for the SMBus alert protocol
96e21e4fb   Jean Delvare   i2c: Add missing ...
113
114
115
   * @command: Callback for bus-wide signaling (optional)
   * @driver: Device driver model driver
   * @id_table: List of I2C devices supported by this driver
4735c98f8   Jean Delvare   i2c: Add detectio...
116
   * @detect: Callback for device detection
c3813d6af   Jean Delvare   i2c: Get rid of s...
117
   * @address_list: The I2C addresses to probe (for detect)
4735c98f8   Jean Delvare   i2c: Add detectio...
118
   * @clients: List of detected clients we created (for i2c-core use only)
35d8b2e6b   Laurent Riffard   [PATCH] i2c: Drop...
119
120
121
   *
   * The driver.owner field should be set to the module owner of this driver.
   * The driver.name field should be set to the name of this driver.
4735c98f8   Jean Delvare   i2c: Add detectio...
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
   *
   * For automatic device detection, both @detect and @address_data must
   * be defined. @class should also be set, otherwise only devices forced
   * with module parameters will be created. The detect function must
   * fill at least the name field of the i2c_board_info structure it is
   * handed upon successful detection, and possibly also the flags field.
   *
   * If @detect is missing, the driver will still work fine for enumerated
   * devices. Detected devices simply won't be supported. This is expected
   * for the many I2C/SMBus devices which can't be detected reliably, and
   * the ones which can always be enumerated in practice.
   *
   * The i2c_client structure which is handed to the @detect callback is
   * not a real i2c_client. It is initialized just enough so that you can
   * call i2c_smbus_read_byte_data and friends on it. Don't do anything
   * else with it. In particular, calling dev_dbg and friends on it is
   * not allowed.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
139
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
140
  struct i2c_driver {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
141
  	unsigned int class;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
142

729d6dd57   Jean Delvare   i2c: Get rid of t...
143
144
145
  	/* Notifies the driver that a new bus has appeared or is about to be
  	 * removed. You should avoid using this if you can, it will probably
  	 * be removed in a near future.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
146
147
148
  	 */
  	int (*attach_adapter)(struct i2c_adapter *);
  	int (*detach_adapter)(struct i2c_adapter *);
729d6dd57   Jean Delvare   i2c: Get rid of t...
149
  	/* Standard driver model interfaces */
d2653e927   Jean Delvare   i2c: Add support ...
150
  	int (*probe)(struct i2c_client *, const struct i2c_device_id *);
a1d9e6e49   David Brownell   i2c: i2c stack ca...
151
  	int (*remove)(struct i2c_client *);
7b4fbc50f   David Brownell   i2c: i2c stack ca...
152

f37dd80ac   David Brownell   i2c: Add driver s...
153
154
155
156
  	/* driver model interfaces that don't relate to enumeration  */
  	void (*shutdown)(struct i2c_client *);
  	int (*suspend)(struct i2c_client *, pm_message_t mesg);
  	int (*resume)(struct i2c_client *);
b5527a776   Jean Delvare   i2c: Add SMBus al...
157
158
159
160
161
162
  	/* Alert callback, for example for the SMBus alert protocol.
  	 * The format and meaning of the data value depends on the protocol.
  	 * For the SMBus alert protocol, there is a single bit of data passed
  	 * as the alert response's low bit ("event flag").
  	 */
  	void (*alert)(struct i2c_client *, unsigned int data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
163
164
165
  	/* a ioctl like command that can be used to perform specific functions
  	 * with the device.
  	 */
3ae70deef   Jean Delvare   i2c: Clean up <li...
166
  	int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
167
168
  
  	struct device_driver driver;
d2653e927   Jean Delvare   i2c: Add support ...
169
  	const struct i2c_device_id *id_table;
4735c98f8   Jean Delvare   i2c: Add detectio...
170
171
  
  	/* Device detection callback for automatic device creation */
310ec7921   Jean Delvare   i2c: Drop the kin...
172
  	int (*detect)(struct i2c_client *, struct i2c_board_info *);
c3813d6af   Jean Delvare   i2c: Get rid of s...
173
  	const unsigned short *address_list;
4735c98f8   Jean Delvare   i2c: Add detectio...
174
  	struct list_head clients;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
175
176
  };
  #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
2096b956d   David Brownell   i2c: Shrink struc...
177
178
  /**
   * struct i2c_client - represent an I2C slave device
d64f73be1   David Brownell   i2c: Add kernel d...
179
180
   * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
   *	I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
2096b956d   David Brownell   i2c: Shrink struc...
181
182
183
   * @addr: Address used on the I2C bus connected to the parent adapter.
   * @name: Indicates the type of the device, usually a chip name that's
   *	generic enough to hide second-sourcing and compatible revisions.
d64f73be1   David Brownell   i2c: Add kernel d...
184
   * @adapter: manages the bus segment hosting this I2C device
aa3481d5e   Randy Dunlap   i2c.h kernel-doc ...
185
   * @driver: device's driver, hence pointer to access routines
2096b956d   David Brownell   i2c: Shrink struc...
186
   * @dev: Driver model device node for the slave.
d64f73be1   David Brownell   i2c: Add kernel d...
187
   * @irq: indicates the IRQ generated by this device (if any)
99cd8e258   Jean Delvare   i2c: Add a sysfs ...
188
189
   * @detected: member of an i2c_driver.clients list or i2c-core's
   *	userspace_devices list
2096b956d   David Brownell   i2c: Shrink struc...
190
191
   *
   * An i2c_client identifies a single device (i.e. chip) connected to an
d64f73be1   David Brownell   i2c: Add kernel d...
192
193
   * i2c bus. The behaviour exposed to Linux is defined by the driver
   * managing the device.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
194
195
   */
  struct i2c_client {
2096b956d   David Brownell   i2c: Shrink struc...
196
  	unsigned short flags;		/* div., see below		*/
438d6c2c0   David Brownell   i2c: Whitespace c...
197
  	unsigned short addr;		/* chip address - NOTE: 7bit	*/
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
198
  					/* addresses are stored in the	*/
5071860ab   Jean Delvare   [PATCH] I2C: Sepa...
199
  					/* _LOWER_ 7 bits		*/
2096b956d   David Brownell   i2c: Shrink struc...
200
  	char name[I2C_NAME_SIZE];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
201
202
  	struct i2c_adapter *adapter;	/* the adapter we sit on	*/
  	struct i2c_driver *driver;	/* and our access routines	*/
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
203
  	struct device dev;		/* the device structure		*/
8e29da9ee   Wolfram Sang   i2c: Fix bad hint...
204
  	int irq;			/* irq issued by device		*/
4735c98f8   Jean Delvare   i2c: Add detectio...
205
  	struct list_head detected;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
206
207
  };
  #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
9b766b814   David Brownell   i2c: Stop using t...
208
  extern struct i2c_client *i2c_verify_client(struct device *dev);
a61fc683a   Ben Gardner   [PATCH] I2C: add ...
209
210
  static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
  {
d75d53cd5   Mark M. Hoffman   i2c: Fix sparse w...
211
212
  	struct device * const dev = container_of(kobj, struct device, kobj);
  	return to_i2c_client(dev);
a61fc683a   Ben Gardner   [PATCH] I2C: add ...
213
  }
7d1d8999b   Jean Delvare   i2c: Constify i2c...
214
  static inline void *i2c_get_clientdata(const struct i2c_client *dev)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
215
  {
3ae70deef   Jean Delvare   i2c: Clean up <li...
216
  	return dev_get_drvdata(&dev->dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
217
  }
3ae70deef   Jean Delvare   i2c: Clean up <li...
218
  static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
219
  {
3ae70deef   Jean Delvare   i2c: Clean up <li...
220
  	dev_set_drvdata(&dev->dev, data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
221
  }
9c1600eda   David Brownell   i2c: Add i2c_boar...
222
223
  /**
   * struct i2c_board_info - template for device creation
eb8a79080   Jean Delvare   i2c: Kill the old...
224
   * @type: chip type, to initialize i2c_client.name
9c1600eda   David Brownell   i2c: Add i2c_boar...
225
226
227
   * @flags: to initialize i2c_client.flags
   * @addr: stored in i2c_client.addr
   * @platform_data: stored in i2c_client.dev.platform_data
11f1f2afd   Anton Vorontsov   i2c: Add info->ar...
228
   * @archdata: copied into i2c_client.dev.archdata
72d2e9f9f   Randy Dunlap   i2c.h: fix kernel...
229
   * @of_node: pointer to OpenFirmware device node
9c1600eda   David Brownell   i2c: Add i2c_boar...
230
   * @irq: stored in i2c_client.irq
d64f73be1   David Brownell   i2c: Add kernel d...
231
   *
9c1600eda   David Brownell   i2c: Add i2c_boar...
232
233
234
235
236
237
   * I2C doesn't actually support hardware probing, although controllers and
   * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
   * a device at a given address.  Drivers commonly need more information than
   * that, such as chip type, configuration, associated IRQ, and so on.
   *
   * i2c_board_info is used to build tables of information listing I2C devices
729d6dd57   Jean Delvare   i2c: Get rid of t...
238
239
240
241
   * that are present.  This information is used to grow the driver model tree.
   * For mainboards this is done statically using i2c_register_board_info();
   * bus numbers identify adapters that aren't yet available.  For add-on boards,
   * i2c_new_device() does this dynamically with the adapter already known.
9c1600eda   David Brownell   i2c: Add i2c_boar...
242
243
   */
  struct i2c_board_info {
9c1600eda   David Brownell   i2c: Add i2c_boar...
244
245
246
247
  	char		type[I2C_NAME_SIZE];
  	unsigned short	flags;
  	unsigned short	addr;
  	void		*platform_data;
11f1f2afd   Anton Vorontsov   i2c: Add info->ar...
248
  	struct dev_archdata	*archdata;
d12d42f74   Grant Likely   i2c/of: Allow dev...
249
250
251
  #ifdef CONFIG_OF
  	struct device_node *of_node;
  #endif
9c1600eda   David Brownell   i2c: Add i2c_boar...
252
253
254
255
  	int		irq;
  };
  
  /**
3760f7367   Jean Delvare   i2c: Convert most...
256
257
   * I2C_BOARD_INFO - macro used to list an i2c device and its address
   * @dev_type: identifies the device type
9c1600eda   David Brownell   i2c: Add i2c_boar...
258
259
260
261
   * @dev_addr: the device's address on the bus.
   *
   * This macro initializes essential fields of a struct i2c_board_info,
   * declaring what has been provided on a particular board.  Optional
3760f7367   Jean Delvare   i2c: Convert most...
262
263
   * fields (such as associated irq, or device-specific platform_data)
   * are provided using conventional syntax.
9c1600eda   David Brownell   i2c: Add i2c_boar...
264
   */
3ae70deef   Jean Delvare   i2c: Clean up <li...
265
  #define I2C_BOARD_INFO(dev_type, dev_addr) \
c758e8cff   Ben Hutchings   i2c: Fix sparse w...
266
  	.type = dev_type, .addr = (dev_addr)
9c1600eda   David Brownell   i2c: Add i2c_boar...
267

23af84005   Jean Delvare   i2c: Don't advert...
268
  #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
9c1600eda   David Brownell   i2c: Add i2c_boar...
269
270
271
272
273
274
  /* Add-on boards should register/unregister their devices; e.g. a board
   * with integrated I2C, a config eeprom, sensors, and a codec that's
   * used in conjunction with the primary hardware.
   */
  extern struct i2c_client *
  i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
12b5053ac   Jean Delvare   i2c: Add i2c_new_...
275
276
  /* If you don't know the exact address of an I2C device, use this variant
   * instead, which can probe for device presence in a list of possible
9a94241af   Jean Delvare   i2c: Add support ...
277
278
279
   * addresses. The "probe" callback function is optional. If it is provided,
   * it must return 1 on successful probe, 0 otherwise. If it is not provided,
   * a default probing method is used.
12b5053ac   Jean Delvare   i2c: Add i2c_new_...
280
281
282
283
   */
  extern struct i2c_client *
  i2c_new_probed_device(struct i2c_adapter *adap,
  		      struct i2c_board_info *info,
9a94241af   Jean Delvare   i2c: Add support ...
284
285
  		      unsigned short const *addr_list,
  		      int (*probe)(struct i2c_adapter *, unsigned short addr));
12b5053ac   Jean Delvare   i2c: Add i2c_new_...
286

d44f19d58   Jean Delvare   V4L/DVB: Use cust...
287
288
  /* Common custom probe functions */
  extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
e9f1373b6   David Brownell   i2c: Add i2c_new_...
289
290
291
292
  /* For devices that use several addresses, use i2c_new_dummy() to make
   * client handles for the extra addresses.
   */
  extern struct i2c_client *
60b129d7b   Jean Delvare   i2c: Match dummy ...
293
  i2c_new_dummy(struct i2c_adapter *adap, u16 address);
e9f1373b6   David Brownell   i2c: Add i2c_new_...
294

9c1600eda   David Brownell   i2c: Add i2c_boar...
295
  extern void i2c_unregister_device(struct i2c_client *);
23af84005   Jean Delvare   i2c: Don't advert...
296
  #endif /* I2C */
9c1600eda   David Brownell   i2c: Add i2c_boar...
297
298
299
300
301
  
  /* Mainboard arch_initcall() code should register all its I2C devices.
   * This is done at arch_initcall time, before declaring any i2c adapters.
   * Modules for add-on boards must use other calls.
   */
263867631   David Brownell   i2c: Make i2c_reg...
302
  #ifdef CONFIG_I2C_BOARDINFO
9c1600eda   David Brownell   i2c: Add i2c_boar...
303
  extern int
3ae70deef   Jean Delvare   i2c: Clean up <li...
304
305
  i2c_register_board_info(int busnum, struct i2c_board_info const *info,
  			unsigned n);
263867631   David Brownell   i2c: Make i2c_reg...
306
307
  #else
  static inline int
3ae70deef   Jean Delvare   i2c: Clean up <li...
308
309
  i2c_register_board_info(int busnum, struct i2c_board_info const *info,
  			unsigned n)
263867631   David Brownell   i2c: Make i2c_reg...
310
311
312
  {
  	return 0;
  }
23af84005   Jean Delvare   i2c: Don't advert...
313
  #endif /* I2C_BOARDINFO */
9c1600eda   David Brownell   i2c: Add i2c_boar...
314

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
315
316
317
318
319
320
321
  /*
   * The following structs are for those who like to implement new bus drivers:
   * i2c_algorithm is the interface to a class of hardware solutions which can
   * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
   * to name two of the most common.
   */
  struct i2c_algorithm {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
322
  	/* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c0   David Brownell   i2c: Whitespace c...
323
  	   to NULL. If an adapter algorithm can do SMBus access, set
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
324
325
  	   smbus_xfer. If set to NULL, the SMBus protocol is simulated
  	   using common I2C messages */
8ced8eee8   Jean Delvare   [PATCH] i2c-power...
326
327
  	/* master_xfer should return the number of messages successfully
  	   processed, or a negative value on error */
3ae70deef   Jean Delvare   i2c: Clean up <li...
328
329
  	int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
  			   int num);
438d6c2c0   David Brownell   i2c: Whitespace c...
330
  	int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
3ae70deef   Jean Delvare   i2c: Clean up <li...
331
332
  			   unsigned short flags, char read_write,
  			   u8 command, int size, union i2c_smbus_data *data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
333

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
334
335
336
337
338
339
340
341
342
343
  	/* To determine what the adapter supports */
  	u32 (*functionality) (struct i2c_adapter *);
  };
  
  /*
   * i2c_adapter is the structure used to identify a physical i2c bus along
   * with the access algorithms necessary to access it.
   */
  struct i2c_adapter {
  	struct module *owner;
e1e18ee1c   Jean Delvare   i2c: Mark i2c_ada...
344
  	unsigned int id __deprecated;
14f55f7a0   Wolfram Sang   i2c: Make clear w...
345
  	unsigned int class;		  /* classes to allow probing for */
af71ff690   David Brownell   i2c: Let drivers ...
346
  	const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
347
  	void *algo_data;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
348
  	/* data fields that are valid for all devices	*/
194684e59   Mika Kuoppala   i2c: Prevent prio...
349
  	struct rt_mutex bus_lock;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
350

cd97f39b7   Jean Delvare   i2c-dev: Clarify ...
351
  	int timeout;			/* in jiffies */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
352
353
  	int retries;
  	struct device dev;		/* the adapter device */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
354

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
355
  	int nr;
2096b956d   David Brownell   i2c: Shrink struc...
356
  	char name[48];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
357
  	struct completion dev_released;
6629dcff1   Jean Delvare   i2c-core: Use per...
358

dafc50d14   Jean Delvare   i2c: Use a separa...
359
  	struct mutex userspace_clients_lock;
6629dcff1   Jean Delvare   i2c-core: Use per...
360
  	struct list_head userspace_clients;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
361
  };
ef2c8321f   David Brownell   i2c: Rename dev_t...
362
  #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
363

7d1d8999b   Jean Delvare   i2c: Constify i2c...
364
  static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
365
  {
3ae70deef   Jean Delvare   i2c: Clean up <li...
366
  	return dev_get_drvdata(&dev->dev);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
367
  }
3ae70deef   Jean Delvare   i2c: Clean up <li...
368
  static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
369
  {
3ae70deef   Jean Delvare   i2c: Clean up <li...
370
  	dev_set_drvdata(&dev->dev, data);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
371
  }
97cc4d49c   Jean Delvare   i2c: Let i2c_pare...
372
373
  static inline struct i2c_adapter *
  i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
0826374bf   Michael Lawnick   i2c: Multiplexed ...
374
  {
97cc4d49c   Jean Delvare   i2c: Let i2c_pare...
375
376
377
378
379
380
  	struct device *parent = adapter->dev.parent;
  
  	if (parent != NULL && parent->type == &i2c_adapter_type)
  		return to_i2c_adapter(parent);
  	else
  		return NULL;
0826374bf   Michael Lawnick   i2c: Multiplexed ...
381
  }
fe61e07e9   Jean Delvare   i2c: Move adapter...
382
383
384
  /* Adapter locking functions, exported for shared pin cases */
  void i2c_lock_adapter(struct i2c_adapter *);
  void i2c_unlock_adapter(struct i2c_adapter *);
afa08974f   Jean Delvare   i2c: Add an inter...
385

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
386
  /*flags for the client struct: */
3bbb835d4   David Brownell   i2c: New-style de...
387
388
389
390
  #define I2C_CLIENT_PEC	0x04		/* Use Packet Error Checking */
  #define I2C_CLIENT_TEN	0x10		/* we have a ten bit chip address */
  					/* Must equal I2C_M_TEN below */
  #define I2C_CLIENT_WAKE	0x80		/* for board_info; true iff can wake */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
391
392
393
  
  /* i2c adapter classes (bitmask) */
  #define I2C_CLASS_HWMON		(1<<0)	/* lm_sensors, ... */
c1b6b4f23   Jean Delvare   i2c: Let framebuf...
394
  #define I2C_CLASS_DDC		(1<<3)	/* DDC bus on graphics adapters */
3401b2fff   Jean Delvare   i2c: Let bus driv...
395
  #define I2C_CLASS_SPD		(1<<7)	/* SPD EEPROMs and similar */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
396

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
397
398
  /* Internal numbers to terminate lists */
  #define I2C_CLIENT_END		0xfffeU
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
399
400
401
  
  /* The numbers to use to set I2C bus address */
  #define ANY_I2C_BUS		0xffff
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
402

c70366732   Hans Verkuil   i2c: New macro to...
403
404
405
  /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
  #define I2C_ADDRS(addr, addrs...) \
  	((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
406
407
408
409
410
  
  /* ----- functions exported by i2c.o */
  
  /* administration...
   */
23af84005   Jean Delvare   i2c: Don't advert...
411
  #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
412
413
  extern int i2c_add_adapter(struct i2c_adapter *);
  extern int i2c_del_adapter(struct i2c_adapter *);
6e13e6418   David Brownell   i2c: Add i2c_add_...
414
  extern int i2c_add_numbered_adapter(struct i2c_adapter *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
415

de59cf9ed   Greg Kroah-Hartman   [PATCH] I2C: Make...
416
  extern int i2c_register_driver(struct module *, struct i2c_driver *);
b3e820968   Jean Delvare   i2c: Make i2c_del...
417
  extern void i2c_del_driver(struct i2c_driver *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
418

de59cf9ed   Greg Kroah-Hartman   [PATCH] I2C: Make...
419
420
421
422
  static inline int i2c_add_driver(struct i2c_driver *driver)
  {
  	return i2c_register_driver(THIS_MODULE, driver);
  }
e48d33193   Jean Delvare   i2c: Change proto...
423
424
  extern struct i2c_client *i2c_use_client(struct i2c_client *client);
  extern void i2c_release_client(struct i2c_client *client);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
425
426
427
428
429
  
  /* call the i2c_client->command() of all attached clients with
   * the given arguments */
  extern void i2c_clients_command(struct i2c_adapter *adap,
  				unsigned int cmd, void *arg);
3ae70deef   Jean Delvare   i2c: Clean up <li...
430
  extern struct i2c_adapter *i2c_get_adapter(int id);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
431
432
433
434
435
436
437
438
439
440
441
442
443
444
  extern void i2c_put_adapter(struct i2c_adapter *adap);
  
  
  /* Return the functionality mask */
  static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
  {
  	return adap->algo->functionality(adap);
  }
  
  /* Return 1 if adapter supports everything we need, 0 if not. */
  static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
  {
  	return (func & i2c_get_functionality(adap)) == func;
  }
3ae70deef   Jean Delvare   i2c: Clean up <li...
445
  /* Return the adapter number for a specific adapter */
cdcb19219   Jean Delvare   [PATCH] I2C: inli...
446
447
448
449
  static inline int i2c_adapter_id(struct i2c_adapter *adap)
  {
  	return adap->nr;
  }
23af84005   Jean Delvare   i2c: Don't advert...
450
  #endif /* I2C */
a1b9298e5   David Woodhouse   Sanitise linux/i2...
451
  #endif /* __KERNEL__ */
cdcb19219   Jean Delvare   [PATCH] I2C: inli...
452

a64ec07d3   David Brownell   i2c: Document str...
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
  /**
   * struct i2c_msg - an I2C transaction segment beginning with START
   * @addr: Slave address, either seven or ten bits.  When this is a ten
   *	bit address, I2C_M_TEN must be set in @flags and the adapter
   *	must support I2C_FUNC_10BIT_ADDR.
   * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
   *	provided unless the adapter exported the relevant I2C_FUNC_*
   *	flags through i2c_check_functionality().
   * @len: Number of data bytes in @buf being read from or written to the
   *	I2C slave address.  For read transactions where I2C_M_RECV_LEN
   *	is set, the caller guarantees that this buffer can hold up to
   *	32 bytes in addition to the initial length byte sent by the
   *	slave (plus, if used, the SMBus PEC); and this value will be
   *	incremented by the number of block data bytes received.
   * @buf: The buffer into which data is read, or from which it's written.
   *
   * An i2c_msg is the low level representation of one segment of an I2C
   * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
   * to userspace from i2c-dev, and to I2C adapter drivers through the
   * @i2c_adapter.@master_xfer() method.
   *
   * Except when I2C "protocol mangling" is used, all I2C adapters implement
   * the standard rules for I2C transactions.  Each transaction begins with a
   * START.  That is followed by the slave address, and a bit encoding read
   * versus write.  Then follow all the data bytes, possibly including a byte
   * with SMBus PEC.  The transfer terminates with a NAK, or when all those
   * bytes have been transferred and ACKed.  If this is the last message in a
   * group, it is followed by a STOP.  Otherwise it is followed by the next
   * @i2c_msg transaction segment, beginning with a (repeated) START.
   *
   * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
   * passing certain @flags may have changed those standard protocol behaviors.
   * Those flags are only for use with broken/nonconforming slaves, and with
   * adapters which are known to support the specific mangling options they
   * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
488
489
490
   */
  struct i2c_msg {
  	__u16 addr;	/* slave address			*/
438d6c2c0   David Brownell   i2c: Whitespace c...
491
  	__u16 flags;
a64ec07d3   David Brownell   i2c: Document str...
492
493
494
495
496
497
498
  #define I2C_M_TEN		0x0010	/* this is a ten bit chip address */
  #define I2C_M_RD		0x0001	/* read data, from slave to master */
  #define I2C_M_NOSTART		0x4000	/* if I2C_FUNC_PROTOCOL_MANGLING */
  #define I2C_M_REV_DIR_ADDR	0x2000	/* if I2C_FUNC_PROTOCOL_MANGLING */
  #define I2C_M_IGNORE_NAK	0x1000	/* if I2C_FUNC_PROTOCOL_MANGLING */
  #define I2C_M_NO_RD_ACK		0x0800	/* if I2C_FUNC_PROTOCOL_MANGLING */
  #define I2C_M_RECV_LEN		0x0400	/* length will be first received byte */
438d6c2c0   David Brownell   i2c: Whitespace c...
499
500
  	__u16 len;		/* msg length				*/
  	__u8 *buf;		/* pointer to msg data			*/
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
501
502
503
504
505
506
  };
  
  /* To determine what functionality is present */
  
  #define I2C_FUNC_I2C			0x00000001
  #define I2C_FUNC_10BIT_ADDR		0x00000002
3ae70deef   Jean Delvare   i2c: Clean up <li...
507
  #define I2C_FUNC_PROTOCOL_MANGLING	0x00000004 /* I2C_M_NOSTART etc. */
6662cbb98   David Brownell   i2c: Rename the P...
508
  #define I2C_FUNC_SMBUS_PEC		0x00000008
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
509
  #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL	0x00008000 /* SMBus 2.0 */
438d6c2c0   David Brownell   i2c: Whitespace c...
510
511
512
513
514
515
516
517
518
519
  #define I2C_FUNC_SMBUS_QUICK		0x00010000
  #define I2C_FUNC_SMBUS_READ_BYTE	0x00020000
  #define I2C_FUNC_SMBUS_WRITE_BYTE	0x00040000
  #define I2C_FUNC_SMBUS_READ_BYTE_DATA	0x00080000
  #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA	0x00100000
  #define I2C_FUNC_SMBUS_READ_WORD_DATA	0x00200000
  #define I2C_FUNC_SMBUS_WRITE_WORD_DATA	0x00400000
  #define I2C_FUNC_SMBUS_PROC_CALL	0x00800000
  #define I2C_FUNC_SMBUS_READ_BLOCK_DATA	0x01000000
  #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
520
521
  #define I2C_FUNC_SMBUS_READ_I2C_BLOCK	0x04000000 /* I2C-like block xfer  */
  #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK	0x08000000 /* w/ 1-byte reg. addr. */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
522

3ae70deef   Jean Delvare   i2c: Clean up <li...
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
  #define I2C_FUNC_SMBUS_BYTE		(I2C_FUNC_SMBUS_READ_BYTE | \
  					 I2C_FUNC_SMBUS_WRITE_BYTE)
  #define I2C_FUNC_SMBUS_BYTE_DATA	(I2C_FUNC_SMBUS_READ_BYTE_DATA | \
  					 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
  #define I2C_FUNC_SMBUS_WORD_DATA	(I2C_FUNC_SMBUS_READ_WORD_DATA | \
  					 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
  #define I2C_FUNC_SMBUS_BLOCK_DATA	(I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
  					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
  #define I2C_FUNC_SMBUS_I2C_BLOCK	(I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
  					 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
  
  #define I2C_FUNC_SMBUS_EMUL		(I2C_FUNC_SMBUS_QUICK | \
  					 I2C_FUNC_SMBUS_BYTE | \
  					 I2C_FUNC_SMBUS_BYTE_DATA | \
  					 I2C_FUNC_SMBUS_WORD_DATA | \
  					 I2C_FUNC_SMBUS_PROC_CALL | \
  					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
  					 I2C_FUNC_SMBUS_I2C_BLOCK | \
  					 I2C_FUNC_SMBUS_PEC)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
542

438d6c2c0   David Brownell   i2c: Whitespace c...
543
544
  /*
   * Data for SMBus Messages
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
545
   */
438d6c2c0   David Brownell   i2c: Whitespace c...
546
  #define I2C_SMBUS_BLOCK_MAX	32	/* As specified in SMBus standard */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
547
548
549
  union i2c_smbus_data {
  	__u8 byte;
  	__u16 word;
332bf92b3   Hideki Iwamoto   [PATCH] i2c: Fix ...
550
  	__u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
3ae70deef   Jean Delvare   i2c: Clean up <li...
551
  			       /* and one more for user-space compatibility */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
552
  };
ae7193f7f   Jean Delvare   i2c: Update stray...
553
  /* i2c_smbus_xfer read or write markers */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
554
555
  #define I2C_SMBUS_READ	1
  #define I2C_SMBUS_WRITE	0
438d6c2c0   David Brownell   i2c: Whitespace c...
556
  /* SMBus transaction types (size parameter in the above functions)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
557
558
559
     Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
  #define I2C_SMBUS_QUICK		    0
  #define I2C_SMBUS_BYTE		    1
438d6c2c0   David Brownell   i2c: Whitespace c...
560
  #define I2C_SMBUS_BYTE_DATA	    2
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
561
562
563
  #define I2C_SMBUS_WORD_DATA	    3
  #define I2C_SMBUS_PROC_CALL	    4
  #define I2C_SMBUS_BLOCK_DATA	    5
4b2643d7d   Jean Delvare   i2c: Fix the i2c_...
564
  #define I2C_SMBUS_I2C_BLOCK_BROKEN  6
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
565
  #define I2C_SMBUS_BLOCK_PROC_CALL   7		/* SMBus 2.0 */
4b2643d7d   Jean Delvare   i2c: Fix the i2c_...
566
  #define I2C_SMBUS_I2C_BLOCK_DATA    8
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
567

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
568
  #endif /* _LINUX_I2C_H */