Context Navigation

i2c.h @ 3486

Revision 3486, 20.4 KB (checked in by frodo, 13 years ago)

i2c_msg was not exported to userspace, so ioctl I2C_RDWR did not

compile.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

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

Note: See TracBrowser for help on using the browser.

Context Navigation

root/i2c/trunk/kernel/i2c.h @ 3486

Download in other formats: