sys/dev/pwm/pwmbus.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
   5  * All rights reserved.
   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  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _PWMBUS_H_
  32
  33 #include <dev/ofw/openfirm.h>
  34
  35 struct pwm_channel {
  36         device_t        dev;
  37         u_int           channel;
  38         uint64_t        period;
  39         uint64_t        duty;
  40         uint32_t        flags;
  41         bool            enabled;
  42 };
  43 typedef struct pwm_channel *pwm_channel_t;
  44
  45 int pwm_get_by_ofw_propidx(device_t consumer, phandle_t node,
  46     const char *prop_name, int idx, pwm_channel_t *channel);
  47 int pwm_get_by_ofw_idx(device_t consumer, phandle_t node, int idx,
  48     pwm_channel_t *out_channel);
  49 int pwm_get_by_ofw_property(device_t consumer, phandle_t node,
  50     const char *prop_name, pwm_channel_t *out_channel);
  51 int pwm_get_by_ofw_name(device_t consumer, phandle_t node, const char *name,
  52     pwm_channel_t *out_channel);
  53
  54 #endif /* _PWMBUS_H_ */