sys/bus/iicbus/iiconf.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/iicbus/iiconf.h,v 1.7 2002/03/23 15:47:17 nsouch Exp $
  27  * $DragonFly: src/sys/bus/iicbus/iiconf.h,v 1.4 2003/11/14 21:46:17 daver Exp $
  28  */
  29 #ifndef __IICONF_H
  30 #define __IICONF_H
  31
  32 #include <sys/queue.h>
  33
  34 #define n(flags) (~(flags) & (flags))
  35
  36 #define LSB 0x1
  37
  38 /*
  39  * How tsleep() is called in iic_request_bus().
  40  */
  41 #define IIC_DONTWAIT    0
  42 #define IIC_NOINTR      0
  43 #define IIC_WAIT        0x1
  44 #define IIC_INTR        0x2
  45
  46 /*
  47  * i2c modes
  48  */
  49 #define IIC_MASTER      0x1
  50 #define IIC_SLAVE       0x2
  51 #define IIC_POLLED      0x4
  52
  53 /*
  54  * i2c speed
  55  */
  56 #define IIC_UNKNOWN     0x0
  57 #define IIC_SLOW        0x1
  58 #define IIC_FAST        0x2
  59 #define IIC_FASTEST     0x3
  60
  61 #define IIC_LAST_READ   0x1
  62
  63 /*
  64  * callback index
  65  */
  66 #define IIC_REQUEST_BUS 0x1
  67 #define IIC_RELEASE_BUS 0x2
  68
  69 /*
  70  * interrupt events
  71  */
  72 #define INTR_GENERAL    0x1     /* general call received */
  73 #define INTR_START      0x2     /* the I2C interface is addressed */
  74 #define INTR_STOP       0x3     /* stop condition received */
  75 #define INTR_RECEIVE    0x4     /* character received */
  76 #define INTR_TRANSMIT   0x5     /* character to transmit */
  77 #define INTR_ERROR      0x6     /* error */
  78 #define INTR_NOACK      0x7     /* no ack from master receiver */
  79
  80 /*
  81  * adapter layer errors
  82  */
  83 #define IIC_NOERR       0x0     /* no error occured */
  84 #define IIC_EBUSERR     0x1     /* bus error */
  85 #define IIC_ENOACK      0x2     /* ack not received until timeout */
  86 #define IIC_ETIMEOUT    0x3     /* timeout */
  87 #define IIC_EBUSBSY     0x4     /* bus busy */
  88 #define IIC_ESTATUS     0x5     /* status error */
  89 #define IIC_EUNDERFLOW  0x6     /* slave ready for more data */
  90 #define IIC_EOVERFLOW   0x7     /* too much data */
  91 #define IIC_ENOTSUPP    0x8     /* request not supported */
  92 #define IIC_ENOADDR     0x9     /* no address assigned to the interface */
  93
  94 /*
  95  * ivars codes
  96  */
  97 #define IICBUS_IVAR_ADDR        0x1     /* I2C address of the device */
  98
  99 extern int iicbus_request_bus(device_t, device_t, int);
 100 extern int iicbus_release_bus(device_t, device_t);
 101 extern device_t iicbus_alloc_bus(device_t);
 102
 103 extern void iicbus_intr(device_t, int, char *);
 104
 105 extern int iicbus_null_repeated_start(device_t, u_char);
 106 extern int iicbus_null_callback(device_t, int, caddr_t);
 107
 108 #define iicbus_reset(bus,speed,addr,oldaddr) \
 109         (IICBUS_RESET(device_get_parent(bus), speed, addr, oldaddr))
 110
 111 /* basic I2C operations */
 112 extern int iicbus_started(device_t);
 113 extern int iicbus_start(device_t, u_char, int);
 114 extern int iicbus_stop(device_t);
 115 extern int iicbus_repeated_start(device_t, u_char, int);
 116 extern int iicbus_write(device_t, char *, int, int *, int);
 117 extern int iicbus_read(device_t, char *, int, int *, int, int);
 118
 119 /* single byte read/write functions, start/stop not managed */
 120 extern int iicbus_write_byte(device_t, char, int);
 121 extern int iicbus_read_byte(device_t, char *, int);
 122
 123 /* Read/write operations with start/stop conditions managed */
 124 extern int iicbus_block_write(device_t, u_char, char *, int, int *);
 125 extern int iicbus_block_read(device_t, u_char, char *, int, int *);
 126
 127 extern u_char iicbus_get_addr(device_t);
 128
 129 #define IICBUS_MODVER  1
 130 #define IICBUS_MINVER  1
 131 #define IICBUS_MAXVER  1
 132 #define IICBUS_PREFVER IICBUS_MODVER
 133
 134 #define IICBB_MODVER   1
 135 #define IICBB_MINVER   1
 136 #define IICBB_MAXVER   1
 137 #define IICBB_PREFVER  IICBB_MODVER
 138
 139 #endif