sys/dev/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$
  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 /* Order constants for smbus children. */
  38 #define SMBUS_ORDER_HINTED      20
  39 #define SMBUS_ORDER_PNP         40
  40
  41 /*
  42  * How tsleep() is called in smb_request_bus().
  43  */
  44 #define SMB_DONTWAIT    0
  45 #define SMB_NOINTR      0
  46 #define SMB_WAIT        0x1
  47 #define SMB_INTR        0x2
  48
  49 /*
  50  * callback index
  51  */
  52 #define SMB_REQUEST_BUS 0x1
  53 #define SMB_RELEASE_BUS 0x2
  54
  55 /*
  56  * SMB bus errors
  57  */
  58 #define SMB_ENOERR      0x0
  59 #define SMB_EBUSERR     0x1
  60 #define SMB_ENOTSUPP    0x2
  61 #define SMB_ENOACK      0x4
  62 #define SMB_ECOLLI      0x8
  63 #define SMB_EABORT      0x10
  64 #define SMB_ETIMEOUT    0x20
  65 #define SMB_EBUSY       0x40
  66 #define SMB_EINVAL      0x100
  67
  68 /*
  69  * How Quick command is executed
  70  */
  71 #define SMB_QWRITE      0x0
  72 #define SMB_QREAD       0x1
  73
  74 /*
  75  * ivars codes
  76  */
  77 enum smbus_ivars {
  78     SMBUS_IVAR_ADDR,    /* slave address of the device */
  79 };
  80
  81 int     smbus_request_bus(device_t, device_t, int);
  82 int     smbus_release_bus(device_t, device_t);
  83 device_t smbus_alloc_bus(device_t);
  84 int     smbus_error(int error);
  85
  86 void    smbus_intr(device_t, u_char, char low, char high, int error);
  87
  88 #define SMBUS_ACCESSOR(var, ivar, type)                                 \
  89         __BUS_ACCESSOR(smbus, var, SMBUS, ivar, type)
  90
  91 SMBUS_ACCESSOR(addr,            ADDR,           int)
  92
  93 #undef SMBUS_ACCESSOR
  94
  95 extern driver_t smbus_driver;
  96 extern devclass_t smbus_devclass;
  97
  98 #define smbus_quick(bus,slave,how) \
  99         (SMBUS_QUICK(device_get_parent(bus), slave, how))
 100 #define smbus_sendb(bus,slave,byte) \
 101         (SMBUS_SENDB(device_get_parent(bus), slave, byte))
 102 #define smbus_recvb(bus,slave,byte) \
 103         (SMBUS_RECVB(device_get_parent(bus), slave, byte))
 104 #define smbus_writeb(bus,slave,cmd,byte) \
 105         (SMBUS_WRITEB(device_get_parent(bus), slave, cmd, byte))
 106 #define smbus_writew(bus,slave,cmd,word) \
 107         (SMBUS_WRITEW(device_get_parent(bus), slave, cmd, word))
 108 #define smbus_readb(bus,slave,cmd,byte) \
 109         (SMBUS_READB(device_get_parent(bus), slave, cmd, byte))
 110 #define smbus_readw(bus,slave,cmd,word) \
 111         (SMBUS_READW(device_get_parent(bus), slave, cmd, word))
 112 #define smbus_pcall(bus,slave,cmd,sdata,rdata) \
 113         (SMBUS_PCALL(device_get_parent(bus), slave, cmd, sdata, rdata))
 114 #define smbus_bwrite(bus,slave,cmd,count,buf) \
 115         (SMBUS_BWRITE(device_get_parent(bus), slave, cmd, count, buf))
 116 #define smbus_bread(bus,slave,cmd,count,buf) \
 117         (SMBUS_BREAD(device_get_parent(bus), slave, cmd, count, buf))
 118
 119 #define SMBUS_MODVER    1
 120 #define SMBUS_MINVER    1
 121 #define SMBUS_MAXVER    1
 122 #define SMBUS_PREFVER   SMBUS_MODVER
 123
 124 #endif