sys/bus/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: src/sys/dev/iicbus/iicbus_if.m,v 1.4 1999/08/28 00:41:59 peter Exp $
  27 # $DragonFly: src/sys/bus/iicbus/iicbus_if.m,v 1.2 2003/06/17 04:28:27 dillon Exp $
  28 #
  29
  30 INTERFACE iicbus;
  31
  32 #
  33 # Interpret interrupt
  34 #
  35 METHOD int intr {
  36         device_t dev;
  37         int event;
  38         char *buf;
  39 };
  40
  41 #
  42 # iicbus callback
  43 #
  44 METHOD int callback {
  45         device_t dev;
  46         int index;
  47         caddr_t data;
  48 };
  49
  50 #
  51 # Send REPEATED_START condition
  52 #
  53 METHOD int repeated_start {
  54         device_t dev;
  55         u_char slave;
  56         int timeout;
  57 };
  58
  59 #
  60 # Send START condition
  61 #
  62 METHOD int start {
  63         device_t dev;
  64         u_char slave;
  65         int timeout;
  66 };
  67
  68 #
  69 # Send STOP condition
  70 #
  71 METHOD int stop {
  72         device_t dev;
  73 };
  74
  75 #
  76 # Read from I2C bus
  77 #
  78 METHOD int read {
  79         device_t dev;
  80         char *buf;
  81         int len;
  82         int *bytes;
  83         int last;
  84         int delay;
  85 };
  86
  87 #
  88 # Write to the I2C bus
  89 #
  90 METHOD int write {
  91         device_t dev;
  92         char *buf;
  93         int len;
  94         int *bytes;
  95         int timeout;
  96 };
  97
  98 #
  99 # Reset I2C bus
 100 #
 101 METHOD int reset {
 102         device_t dev;
 103         u_char speed;
 104         u_char addr;
 105         u_char *oldaddr;
 106 };