Merge branch 'vendor/FILE'
[dragonfly.git] / sys / bus / smbus / smbconf.h
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: src/sys/dev/smbus/smbconf.h,v 1.7.14.1 2006/09/22 19:19:16 jhb Exp $
27  * $DragonFly: src/sys/bus/smbus/smbconf.h,v 1.4 2003/11/14 21:46:18 daver Exp $
28  */
29 #ifndef __SMBONF_H
30 #define __SMBONF_H
31
32 #include <sys/queue.h>
33
34 #define SMBPRI (PZERO+8)                /* XXX sleep/wakeup queue priority */
35
36 #define n(flags) (~(flags) & (flags))
37
38 /*
39  * How tsleep() is called in smb_request_bus().
40  */
41 #define SMB_DONTWAIT    0
42 #define SMB_NOINTR      0
43 #define SMB_WAIT        0x1
44 #define SMB_INTR        0x2
45
46 /*
47  * callback index
48  */
49 #define SMB_REQUEST_BUS 0x1
50 #define SMB_RELEASE_BUS 0x2
51
52 /*
53  * SMB bus errors
54  */
55 #define SMB_ENOERR      0x0
56 #define SMB_EBUSERR     0x1
57 #define SMB_ENOTSUPP    0x2
58 #define SMB_ENOACK      0x4
59 #define SMB_ECOLLI      0x8
60 #define SMB_EABORT      0x10
61 #define SMB_ETIMEOUT    0x20
62 #define SMB_EBUSY       0x40
63 #define SMB_EINVAL      0x100
64
65 /*
66  * How Quick command is executed
67  */
68 #define SMB_QWRITE      0x0
69 #define SMB_QREAD       0x1
70
71 /*
72  * ivars codes
73  */
74 #define SMBUS_IVAR_ADDR 0x1     /* slave address of the device */
75
76 int     smbus_request_bus(device_t, device_t, int);
77 int     smbus_release_bus(device_t, device_t);
78 int     smbus_error(int error);
79
80 void    smbus_intr(device_t, u_char, char low, char high, int error);
81
82 u_char  smbus_get_addr(device_t);
83
84 extern driver_t smbus_driver;
85 extern devclass_t smbus_devclass;
86
87 #define smbus_quick(bus,slave,how) \
88         (SMBUS_QUICK(device_get_parent(bus), slave, how))
89 #define smbus_sendb(bus,slave,byte) \
90         (SMBUS_SENDB(device_get_parent(bus), slave, byte))
91 #define smbus_recvb(bus,slave,byte) \
92         (SMBUS_RECVB(device_get_parent(bus), slave, byte))
93 #define smbus_writeb(bus,slave,cmd,byte) \
94         (SMBUS_WRITEB(device_get_parent(bus), slave, cmd, byte))
95 #define smbus_writew(bus,slave,cmd,word) \
96         (SMBUS_WRITEW(device_get_parent(bus), slave, cmd, word))
97 #define smbus_readb(bus,slave,cmd,byte) \
98         (SMBUS_READB(device_get_parent(bus), slave, cmd, byte))
99 #define smbus_readw(bus,slave,cmd,word) \
100         (SMBUS_READW(device_get_parent(bus), slave, cmd, word))
101 #define smbus_pcall(bus,slave,cmd,sdata,rdata) \
102         (SMBUS_PCALL(device_get_parent(bus), slave, cmd, sdata, rdata))
103 #define smbus_bwrite(bus,slave,cmd,count,buf) \
104         (SMBUS_BWRITE(device_get_parent(bus), slave, cmd, count, buf))
105 #define smbus_bread(bus,slave,cmd,count,buf) \
106         (SMBUS_BREAD(device_get_parent(bus), slave, cmd, count, buf))
107
108 #define SMBUS_MODVER    1
109 #define SMBUS_MINVER    1
110 #define SMBUS_MAXVER    1
111 #define SMBUS_PREFVER   SMBUS_MODVER
112
113 #endif