sys/dev/fdt/fdt_pinctrl_if.m

   1 #-
   2 # Copyright (c) 2014 Ian Lepore
   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/types.h>
  30 #include <sys/bus.h>
  31 #include <dev/ofw/openfirm.h>
  32
  33 #
  34 # This is the interface that fdt_pinctrl drivers provide to other drivers.
  35 #
  36
  37 INTERFACE fdt_pinctrl;
  38
  39 CODE {
  40         static int
  41         fdt_pinctrl_default_is_gpio(device_t pinctrl, device_t gpio, bool *is_gpio)
  42         {
  43
  44                 return (EOPNOTSUPP);
  45         }
  46
  47         static int
  48         fdt_pinctrl_default_set_flags(device_t pinctrl, device_t gpio, uint32_t pin,
  49             uint32_t flags)
  50         {
  51
  52                 return (EOPNOTSUPP);
  53         }
  54
  55         static int
  56         fdt_pinctrl_default_get_flags(device_t pinctrl, device_t gpio, uint32_t pin,
  57             uint32_t *flags)
  58         {
  59
  60                 return (EOPNOTSUPP);
  61         }
  62 };
  63
  64 # Needed for timestamping device probe/attach calls
  65 HEADER {
  66         #include <sys/tslog.h>
  67 }
  68
  69 #
  70 # Set pins to the specified configuration.  The cfgxref arg is an xref phandle
  71 # to a descendent node (child, grandchild, ...) of the pinctrl device node.
  72 # Returns 0 on success or a standard errno value.
  73 #
  74 PROLOG {
  75         TSENTER2(device_get_name(pinctrl));
  76 }
  77 EPILOG {
  78         TSEXIT2(device_get_name(pinctrl));
  79 }
  80 METHOD int configure {
  81         device_t        pinctrl;
  82         phandle_t       cfgxref;
  83 };
  84
  85
  86 #
  87 # Test if the pin is in gpio mode
  88 # Called from a gpio device
  89 #
  90 METHOD int is_gpio {
  91         device_t pinctrl;
  92         device_t gpio;
  93         uint32_t pin;
  94         bool *is_gpio;
  95 } DEFAULT fdt_pinctrl_default_is_gpio;
  96
  97 #
  98 # Set the flags of a pin
  99 # Called from a gpio device
 100 #
 101 METHOD int set_flags {
 102         device_t pinctrl;
 103         device_t gpio;
 104         uint32_t pin;
 105         uint32_t flags;
 106 } DEFAULT fdt_pinctrl_default_set_flags;
 107
 108 #
 109 # Get the flags of a pin
 110 # Called from a gpio device
 111 #
 112 METHOD int get_flags {
 113         device_t pinctrl;
 114         device_t gpio;
 115         uint32_t pin;
 116         uint32_t *flags;
 117 } DEFAULT fdt_pinctrl_default_get_flags;