sys/dev/iicbus/iicbus_if.m

   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
  29 #include <sys/bus.h>
  30 #include <dev/iicbus/iic.h>
  31
  32 INTERFACE iicbus;
  33
  34 CODE {
  35         static u_int
  36         iicbus_default_frequency(device_t bus, u_char speed)
  37         {
  38
  39                 return (100000);
  40         }
  41 };
  42
  43 #
  44 # Interpret interrupt
  45 #
  46 METHOD int intr {
  47         device_t dev;
  48         int event;
  49         char *buf;
  50 };
  51
  52 #
  53 # iicbus callback
  54 #
  55 METHOD int callback {
  56         device_t dev;
  57         int index;
  58         caddr_t data;
  59 };
  60
  61 #
  62 # Send REPEATED_START condition
  63 #
  64 METHOD int repeated_start {
  65         device_t dev;
  66         u_char slave;
  67         int timeout;
  68 };
  69
  70 #
  71 # Send START condition
  72 #
  73 METHOD int start {
  74         device_t dev;
  75         u_char slave;
  76         int timeout;
  77 };
  78
  79 #
  80 # Send STOP condition
  81 #
  82 METHOD int stop {
  83         device_t dev;
  84 };
  85
  86 #
  87 # Read from I2C bus
  88 #
  89 METHOD int read {
  90         device_t dev;
  91         char *buf;
  92         int len;
  93         int *bytes;
  94         int last;
  95         int delay;
  96 };
  97
  98 #
  99 # Write to the I2C bus
 100 #
 101 METHOD int write {
 102         device_t dev;
 103         const char *buf;
 104         int len;
 105         int *bytes;
 106         int timeout;
 107 };
 108
 109 #
 110 # Reset I2C bus
 111 #
 112 METHOD int reset {
 113         device_t dev;
 114         u_char speed;
 115         u_char addr;
 116         u_char *oldaddr;
 117 };
 118
 119 #
 120 # Generalized Read/Write interface
 121 #
 122 METHOD int transfer {
 123         device_t dev;
 124         struct iic_msg *msgs;
 125         uint32_t nmsgs;
 126 };
 127
 128 #
 129 # Return the frequency in Hz for the bus running at the given
 130 # symbolic speed.  Only the IIC_SLOW speed has meaning, it is always
 131 # 100KHz.  The UNKNOWN, FAST, and FASTEST rates all map to the
 132 # configured bus frequency, or 100KHz when not otherwise configured.
 133 #
 134 METHOD u_int get_frequency {
 135         device_t dev;
 136         u_char speed;
 137 } DEFAULT iicbus_default_frequency;