xref: /freebsd/sys/dev/smbus/smbconf.h (revision 276da39af92f48350aa01091a2b8b3e735217eea)
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  * $FreeBSD$
27  */
28 #ifndef __SMBONF_H
29 #define __SMBONF_H
30 
31 #include <sys/queue.h>
32 
33 #define SMBPRI (PZERO+8)		/* XXX sleep/wakeup queue priority */
34 
35 #define n(flags) (~(flags) & (flags))
36 
37 /*
38  * How tsleep() is called in smb_request_bus().
39  */
40 #define SMB_DONTWAIT	0
41 #define SMB_NOINTR	0
42 #define SMB_WAIT	0x1
43 #define SMB_INTR	0x2
44 
45 /*
46  * callback index
47  */
48 #define SMB_REQUEST_BUS	0x1
49 #define SMB_RELEASE_BUS	0x2
50 
51 /*
52  * SMB bus errors
53  */
54 #define SMB_ENOERR	0x0
55 #define SMB_EBUSERR	0x1
56 #define SMB_ENOTSUPP	0x2
57 #define SMB_ENOACK	0x4
58 #define SMB_ECOLLI	0x8
59 #define SMB_EABORT	0x10
60 #define SMB_ETIMEOUT	0x20
61 #define SMB_EBUSY	0x40
62 #define	SMB_EINVAL	0x100
63 
64 /*
65  * How Quick command is executed
66  */
67 #define SMB_QWRITE	0x0
68 #define SMB_QREAD	0x1
69 
70 /*
71  * smbus transction op with pass-thru capabilities
72  *
73  * This smbus function is capable of doing a smbus command transaction
74  * (read or write), and can be flagged to not issue the 'cmd' and/or
75  * issue or expect a count field as well as flagged for chaining (no STOP),
76  * which gives it an i2c pass-through capability.
77  *
78  * NOSTOP- Caller chaining transactions, do not issue STOP
79  * NOCMD-  Do not transmit the command field
80  * NOCNT-  Do not transmit (wr) or expect (rd) the count field
81  */
82 #define SMB_TRANS_NOSTOP  0x0001  /* do not send STOP at end */
83 #define SMB_TRANS_NOCMD   0x0002  /* ignore cmd field (do not tx) */
84 #define SMB_TRANS_NOCNT   0x0004  /* do not tx or rx count field */
85 #define SMB_TRANS_7BIT    0x0008  /* change address mode to 7-bit */
86 #define SMB_TRANS_10BIT   0x0010  /* change address mode to 10-bit */
87 #define SMB_TRANS_NOREPORT  0x0020  /* do not report errors */
88 
89 /*
90  * ivars codes
91  */
92 enum smbus_ivars {
93     SMBUS_IVAR_ADDR,	/* slave address of the device */
94 };
95 
96 int	smbus_request_bus(device_t, device_t, int);
97 int	smbus_release_bus(device_t, device_t);
98 device_t smbus_alloc_bus(device_t);
99 int	smbus_error(int error);
100 
101 void	smbus_intr(device_t, u_char, char low, char high, int error);
102 
103 #define SMBUS_ACCESSOR(var, ivar, type)					\
104 	__BUS_ACCESSOR(smbus, var, SMBUS, ivar, type)
105 
106 SMBUS_ACCESSOR(addr,		ADDR,		int)
107 
108 #undef SMBUS_ACCESSOR
109 
110 extern driver_t smbus_driver;
111 extern devclass_t smbus_devclass;
112 
113 #define smbus_quick(bus,slave,how) \
114 	(SMBUS_QUICK(device_get_parent(bus), slave, how))
115 #define smbus_sendb(bus,slave,byte) \
116 	(SMBUS_SENDB(device_get_parent(bus), slave, byte))
117 #define smbus_recvb(bus,slave,byte) \
118 	(SMBUS_RECVB(device_get_parent(bus), slave, byte))
119 #define smbus_writeb(bus,slave,cmd,byte) \
120 	(SMBUS_WRITEB(device_get_parent(bus), slave, cmd, byte))
121 #define smbus_writew(bus,slave,cmd,word) \
122 	(SMBUS_WRITEW(device_get_parent(bus), slave, cmd, word))
123 #define smbus_readb(bus,slave,cmd,byte) \
124 	(SMBUS_READB(device_get_parent(bus), slave, cmd, byte))
125 #define smbus_readw(bus,slave,cmd,word) \
126 	(SMBUS_READW(device_get_parent(bus), slave, cmd, word))
127 #define smbus_pcall(bus,slave,cmd,sdata,rdata) \
128 	(SMBUS_PCALL(device_get_parent(bus), slave, cmd, sdata, rdata))
129 #define smbus_bwrite(bus,slave,cmd,count,buf) \
130 	(SMBUS_BWRITE(device_get_parent(bus), slave, cmd, count, buf))
131 #define smbus_bread(bus,slave,cmd,count,buf) \
132 	(SMBUS_BREAD(device_get_parent(bus), slave, cmd, count, buf))
133 #define smbus_trans(bus,slave,cmd,op,wbuf,wcount,rbuf,rcount,actualp) \
134 	(SMBUS_TRANS(device_get_parent(bus), slave, cmd, op, \
135 	wbuf, wcount, rbuf, rcount, actualp))
136 
137 #define SMBUS_MODVER	1
138 #define SMBUS_MINVER	1
139 #define SMBUS_MAXVER	1
140 #define SMBUS_PREFVER	SMBUS_MODVER
141 
142 #endif
143