sys/dev/extres/regulator/regnode_if.m

   1 #-
   2 # Copyright (c) 2016 Michal Meloun <mmel@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 INTERFACE regnode;
  30 HEADER {
  31         struct regnode;
  32 }
  33
  34 #
  35 # Initialize regulator
  36 # Returns 0 on success or a standard errno value.
  37 #
  38 METHOD int init {
  39         struct regnode  *regnode;
  40 };
  41
  42 #
  43 # Enable/disable regulator
  44 # Returns 0 on success or a standard errno value.
  45 #  - enable - input.
  46 #  - delay - output, delay needed to stabilize voltage (in us)
  47 #
  48 METHOD int enable {
  49         struct regnode  *regnode;
  50         bool            enable;
  51         int             *udelay;
  52 };
  53
  54 #
  55 # Get regulator status
  56 # Returns 0 on success or a standard errno value.
  57 #
  58 METHOD int status {
  59         struct regnode  *regnode;
  60         int             *status;        /* REGULATOR_STATUS_* */
  61 };
  62
  63 #
  64 # Set regulator voltage
  65 # Returns 0 on success or a standard errno value.
  66 #  - min_uvolt, max_uvolt - input, requested voltage range (in uV)
  67 #  - delay - output, delay needed to stabilize voltage (in us)
  68 METHOD int set_voltage {
  69         struct regnode  *regnode;
  70         int             min_uvolt;
  71         int             max_uvolt;
  72         int             *udelay;
  73 };
  74
  75 #
  76 # Get regulator voltage
  77 # Returns 0 on success or a standard errno value.
  78 #
  79 METHOD int get_voltage {
  80         struct regnode  *regnode;
  81         int             *uvolt;
  82 };