sys/dev/pwm/pwm_if.m

   1 #-
   2 # SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 #
   4 # Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28 #
  29
  30 #include <sys/bus.h>
  31
  32 INTERFACE pwm;
  33
  34 #
  35 # Get the bus
  36 #
  37
  38 METHOD device_t get_bus {
  39         device_t dev;
  40 };
  41
  42 #
  43 # Config the period (Total number of cycle in ns) and
  44 # the duty (active number of cycle in ns)
  45 #
  46 METHOD int channel_config {
  47         device_t dev;
  48         int channel;
  49         unsigned int period;
  50         unsigned duty;
  51 };
  52
  53 #
  54 # Get the period (Total number of cycle in ns) and
  55 # the duty (active number of cycle in ns)
  56 #
  57 METHOD int channel_get_config {
  58         device_t dev;
  59         int channel;
  60         unsigned int *period;
  61         unsigned int *duty;
  62 };
  63
  64 #
  65 # Set the flags
  66 #
  67 METHOD int channel_set_flags {
  68         device_t dev;
  69         int channel;
  70         uint32_t flags;
  71 };
  72
  73 #
  74 # Get the flags
  75 #
  76 METHOD int channel_get_flags {
  77         device_t dev;
  78         int channel;
  79         uint32_t *flags;
  80 };
  81
  82 #
  83 # Enable the pwm output
  84 #
  85 METHOD int channel_enable {
  86         device_t dev;
  87         int channel;
  88         bool enable;
  89 };
  90
  91 #
  92 # Is the pwm output enabled
  93 #
  94 METHOD int channel_is_enabled {
  95         device_t dev;
  96         int channel;
  97         bool *enabled;
  98 };
  99
 100 #
 101 # Get the number of channels
 102 #
 103 METHOD int channel_max {
 104         device_t dev;
 105         int *nchannel;
 106 };