xref: /freebsd/sys/dev/iicbus/iiconf.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1 /*-
2  * Copyright (c) 1998, 2001 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  * $FreeBSD$
27  */
28 #ifndef __IICONF_H
29 #define __IICONF_H
30 
31 #include <sys/queue.h>
32 #include <dev/iicbus/iic.h>
33 
34 
35 #define IICPRI (PZERO+8)		/* XXX sleep/wakeup queue priority */
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 #define IIC_LAST_READ	0x1
63 
64 /*
65  * callback index
66  */
67 #define IIC_REQUEST_BUS	0x1
68 #define IIC_RELEASE_BUS	0x2
69 
70 /*
71  * interrupt events
72  */
73 #define INTR_GENERAL	0x1	/* general call received */
74 #define INTR_START	0x2	/* the I2C interface is addressed */
75 #define INTR_STOP	0x3	/* stop condition received */
76 #define INTR_RECEIVE	0x4	/* character received */
77 #define INTR_TRANSMIT	0x5	/* character to transmit */
78 #define INTR_ERROR	0x6	/* error */
79 #define INTR_NOACK	0x7	/* no ack from master receiver */
80 
81 /*
82  * adapter layer errors
83  */
84 #define IIC_NOERR	0x0	/* no error occured */
85 #define IIC_EBUSERR	0x1	/* bus error */
86 #define IIC_ENOACK	0x2	/* ack not received until timeout */
87 #define IIC_ETIMEOUT	0x3	/* timeout */
88 #define IIC_EBUSBSY	0x4	/* bus busy */
89 #define IIC_ESTATUS	0x5	/* status error */
90 #define IIC_EUNDERFLOW	0x6	/* slave ready for more data */
91 #define IIC_EOVERFLOW	0x7	/* too much data */
92 #define IIC_ENOTSUPP	0x8	/* request not supported */
93 #define IIC_ENOADDR	0x9	/* no address assigned to the interface */
94 
95 extern int iicbus_request_bus(device_t, device_t, int);
96 extern int iicbus_release_bus(device_t, device_t);
97 extern device_t iicbus_alloc_bus(device_t);
98 
99 extern void iicbus_intr(device_t, int, char *);
100 
101 extern int iicbus_null_repeated_start(device_t, u_char);
102 extern int iicbus_null_callback(device_t, int, caddr_t);
103 
104 #define iicbus_reset(bus,speed,addr,oldaddr) \
105 	(IICBUS_RESET(device_get_parent(bus), speed, addr, oldaddr))
106 
107 /* basic I2C operations */
108 extern int iicbus_started(device_t);
109 extern int iicbus_start(device_t, u_char, int);
110 extern int iicbus_stop(device_t);
111 extern int iicbus_repeated_start(device_t, u_char, int);
112 extern int iicbus_write(device_t, const char *, int, int *, int);
113 extern int iicbus_read(device_t, char *, int, int *, int, int);
114 
115 /* single byte read/write functions, start/stop not managed */
116 extern int iicbus_write_byte(device_t, char, int);
117 extern int iicbus_read_byte(device_t, char *, int);
118 
119 /* Read/write operations with start/stop conditions managed */
120 extern int iicbus_block_write(device_t, u_char, char *, int, int *);
121 extern int iicbus_block_read(device_t, u_char, char *, int, int *);
122 
123 /* vectors of iic operations to pass to bridge */
124 int iicbus_transfer(device_t bus, struct iic_msg *msgs, uint32_t nmsgs);
125 int iicbus_transfer_gen(device_t bus, struct iic_msg *msgs, uint32_t nmsgs);
126 
127 #define IICBUS_MODVER	1
128 #define IICBUS_MINVER	1
129 #define IICBUS_MAXVER	1
130 #define IICBUS_PREFVER	IICBUS_MODVER
131 
132 extern driver_t iicbb_driver;
133 extern devclass_t iicbb_devclass;
134 
135 #define IICBB_MODVER	1
136 #define IICBB_MINVER	1
137 #define IICBB_MAXVER	1
138 #define IICBB_PREFVER	IICBB_MODVER
139 
140 #endif
141