sys/dev/gpio/gpiobus_if.m

   1 #-
   2 # Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
   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 <sys/gpio.h>
  31
  32 INTERFACE gpiobus;
  33
  34 #
  35 # Lock the gpio bus
  36 #
  37 METHOD void lock_bus {
  38         device_t busdev;
  39 };
  40
  41 #
  42 # Unlock the gpio bus
  43 #
  44 METHOD void unlock_bus {
  45         device_t busdev;
  46 };
  47
  48 #
  49 # Dedicate the gpio bus control for a child
  50 #
  51 METHOD void acquire_bus {
  52         device_t busdev;
  53         device_t dev;
  54 };
  55
  56 #
  57 # Release the bus
  58 #
  59 METHOD void release_bus {
  60         device_t busdev;
  61         device_t dev;
  62 };
  63
  64 #
  65 # Set value of pin specifed by pin_num
  66 #
  67 METHOD int pin_set {
  68         device_t dev;
  69         device_t child;
  70         uint32_t pin_num;
  71         uint32_t pin_value;
  72 };
  73
  74 #
  75 # Get value of pin specifed by pin_num
  76 #
  77 METHOD int pin_get {
  78         device_t dev;
  79         device_t child;
  80         uint32_t pin_num;
  81         uint32_t *pin_value;
  82 };
  83
  84 #
  85 # Toggle value of pin specifed by pin_num
  86 #
  87 METHOD int pin_toggle {
  88         device_t dev;
  89         device_t child;
  90         uint32_t pin_num;
  91 };
  92
  93 #
  94 # Get pin capabilities
  95 #
  96 METHOD int pin_getcaps {
  97         device_t dev;
  98         device_t child;
  99         uint32_t pin_num;
 100         uint32_t *caps;
 101 };
 102
 103 #
 104 # Get pin flags
 105 #
 106 METHOD int pin_getflags {
 107         device_t dev;
 108         device_t child;
 109         uint32_t pin_num;
 110         uint32_t *flags;
 111 };
 112
 113 #
 114 # Set current configuration and capabilities
 115 #
 116 METHOD int pin_setflags {
 117         device_t dev;
 118         device_t child;
 119         uint32_t pin_num;
 120         uint32_t flags;
 121 };