sys/bus/gpio/gpio_if.m

   1 #-
   2 # Copyright (c) 2016 The DragonFly Project.  All rights reserved.
   3 #
   4 # This code is derived from software contributed to The DragonFly Project
   5 # by Imre Vadász <imre@vdsz.com>
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 #
  11 # 1. Redistributions of source code must retain the above copyright
  12 #    notice, this list of conditions and the following disclaimer.
  13 # 2. Redistributions in binary form must reproduce the above copyright
  14 #    notice, this list of conditions and the following disclaimer in
  15 #    the documentation and/or other materials provided with the
  16 #    distribution.
  17 # 3. Neither the name of The DragonFly Project nor the names of its
  18 #    contributors may be used to endorse or promote products derived
  19 #    from this software without specific, prior written permission.
  20 #
  21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 # ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25 # COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 # INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 # SUCH DAMAGE.
  33 #
  34
  35 #include <sys/bus.h>
  36
  37 INTERFACE gpio;
  38
  39 #
  40 # Allocate GPIO interrupt.
  41 # XXX trigger, polarity and termination constants are currently used from
  42 #     sys/contrib/dev/acpica/source/include/acrestyp.h
  43 #
  44 METHOD int alloc_intr {
  45         device_t dev;
  46         u_int pin;
  47         int trigger;
  48         int polarity;
  49         int termination;
  50 };
  51
  52 #
  53 # Deallocate GPIO interrupt.
  54 #
  55 METHOD int free_intr {
  56         device_t dev;
  57         u_int pin;
  58 };
  59
  60 #
  61 # Setup GPIO interrupt.
  62 #
  63 METHOD int setup_intr {
  64         device_t dev;
  65         u_int pin;
  66         void *arg;
  67         driver_intr_t *handler;
  68 };
  69
  70 #
  71 # Disable GPIO interrupt.
  72 #
  73 METHOD int teardown_intr {
  74         device_t dev;
  75         u_int pin;
  76 };
  77
  78 #
  79 # XXX Add a method for allocating pins for read/write IO.
  80 #     Allocating a pin for IO should perform the necessary checks to
  81 #     make sure that read_/write_pin doesn't trigger an assertion.
  82 #
  83
  84 #
  85 # Read pin value, returns 0 or 1.
  86 #
  87 METHOD int read_pin {
  88         device_t dev;
  89         u_int pin;
  90 };
  91
  92 #
  93 # Write pin value, value can be either 0 or 1.
  94 #
  95 METHOD void write_pin {
  96         device_t dev;
  97         u_int pin;
  98         int value;
  99 };