sys/dev/iicbus/iicbb_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
  31 INTERFACE iicbb;
  32
  33 #
  34 # Default implementation of optional methods
  35 #
  36 CODE {
  37         static int
  38         null_pre_xfer(device_t dev)
  39         {
  40                 return 0;
  41         }
  42
  43         static void
  44         null_post_xfer(device_t dev)
  45
  46         {
  47         }
  48
  49         static int
  50         null_callback(device_t dev, int index, caddr_t data)
  51         {
  52                 return 0;
  53         }
  54 };
  55
  56 #
  57 # iicbus callback
  58 #
  59 METHOD int callback {
  60         device_t dev;
  61         int index;
  62         caddr_t data;
  63 } DEFAULT null_callback;
  64
  65 #
  66 # Prepare device for I2C transfer
  67 #
  68 METHOD int pre_xfer {
  69         device_t dev;
  70 } DEFAULT null_pre_xfer;
  71
  72 #
  73 # Cleanup device after I2C transfer
  74 #
  75 METHOD void post_xfer {
  76         device_t dev;
  77 } DEFAULT null_post_xfer;
  78
  79 #
  80 # Set I2C bus data line
  81 #
  82 METHOD void setsda {
  83         device_t dev;
  84         int val;
  85 };
  86
  87 #
  88 # Set I2C bus clock line
  89 #
  90 METHOD void setscl {
  91         device_t dev;
  92         int val;
  93 };
  94
  95 #
  96 # Get I2C bus data line
  97 #
  98 #
  99 METHOD int getsda {
 100         device_t dev;
 101 };
 102
 103 #
 104 # Get I2C bus clock line
 105 #
 106 #
 107 METHOD int getscl {
 108         device_t dev;
 109 };
 110
 111 #
 112 # Reset interface
 113 #
 114 METHOD int reset {
 115         device_t dev;
 116         u_char speed;
 117         u_char addr;
 118         u_char *oldaddr;
 119 };