xref: /freebsd/sys/dev/iicbus/iiconf.h (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1 /*-
2  * Copyright (c) 1998 Nicolas Souchu
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *	$Id: iiconf.h,v 1.1.1.10 1998/08/13 17:10:43 son Exp $
27  */
28 #ifndef __IICONF_H
29 #define __IICONF_H
30 
31 #include <sys/queue.h>
32 
33 #define IICPRI PZERO+8			/* XXX sleep/wakeup queue priority */
34 
35 #define n(flags) (~(flags) & (flags))
36 
37 #define LSB 0x1
38 
39 /*
40  * How tsleep() is called in iic_request_bus().
41  */
42 #define IIC_DONTWAIT	0
43 #define IIC_NOINTR	0
44 #define IIC_WAIT	0x1
45 #define IIC_INTR	0x2
46 
47 /*
48  * i2c modes
49  */
50 #define IIC_MASTER	0x1
51 #define IIC_SLAVE	0x2
52 #define IIC_POLLED	0x4
53 
54 /*
55  * i2c speed
56  */
57 #define IIC_UNKNOWN	0x0
58 #define IIC_SLOW	0x1
59 #define IIC_FAST	0x2
60 #define IIC_FASTEST	0x3
61 
62 /*
63  * interrupt events
64  */
65 #define INTR_GENERAL	0x1	/* general call received */
66 #define INTR_START	0x2	/* the I2C interface is addressed */
67 #define INTR_STOP	0x3	/* stop condition received */
68 #define INTR_RECEIVE	0x4	/* character received */
69 #define INTR_TRANSMIT	0x5	/* character to transmit */
70 #define INTR_ERROR	0x6	/* error */
71 #define INTR_NOACK	0x7	/* no ack from master receiver */
72 
73 /*
74  * adapter layer errors
75  */
76 #define IIC_NOERR	0x0	/* no error occured */
77 #define IIC_EBUSERR	0x1	/* bus error */
78 #define IIC_ENOACK	0x2	/* ack not received until timeout */
79 #define IIC_ETIMEOUT	0x3	/* timeout */
80 #define IIC_EBUSBSY	0x4	/* bus busy */
81 #define IIC_ESTATUS	0x5	/* status error */
82 #define IIC_EUNDERFLOW	0x6	/* slave ready for more data */
83 #define IIC_EOVERFLOW	0x7	/* too much data */
84 
85 /*
86  * ivars codes
87  */
88 #define IICBUS_IVAR_ADDR	0x1	/* I2C address of the device */
89 
90 extern int iicbus_request_bus(device_t, device_t, int);
91 extern int iicbus_release_bus(device_t, device_t);
92 extern device_t iicbus_alloc_bus(device_t);
93 
94 extern void iicbus_intr(device_t, int, char *);
95 
96 #define iicbus_repeated_start(bus,slave) \
97 	(IICBUS_REPEATED_START(device_get_parent(bus), slave))
98 #define iicbus_start(bus,slave) \
99 	(IICBUS_START(device_get_parent(bus), slave))
100 #define iicbus_stop(bus) \
101 	(IICBUS_STOP(device_get_parent(bus)))
102 #define iicbus_reset(bus,speed) \
103 	(IICBUS_RESET(device_get_parent(bus), speed))
104 #define iicbus_write(bus,buf,len,sent) \
105 	(IICBUS_WRITE(device_get_parent(bus), buf, len, sent))
106 #define iicbus_read(bus,buf,len,sent) \
107 	(IICBUS_READ(device_get_parent(bus), buf, len, sent))
108 
109 extern int iicbus_block_write(device_t, u_char, char *, int, int *);
110 extern int iicbus_block_read(device_t, u_char, char *, int, int *);
111 
112 extern u_char iicbus_get_addr(device_t);
113 extern u_char iicbus_get_own_address(device_t);
114 
115 #endif
116