sys/dev/pwm/pwmbus.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2019 Ian Lepore <ian@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 #ifndef _PWMBUS_H_
  31 #define _PWMBUS_H_
  32
  33 struct pwmbus_ivars {
  34         u_int   pi_channel;
  35 };
  36
  37 enum {
  38         PWMBUS_IVAR_CHANNEL,    /* Channel used by child dev */
  39 };
  40
  41 #define PWMBUS_ACCESSOR(A, B, T)                                        \
  42 static inline int                                                       \
  43 pwmbus_get_ ## A(device_t dev, T *t)                                    \
  44 {                                                                       \
  45         return BUS_READ_IVAR(device_get_parent(dev), dev,               \
  46             PWMBUS_IVAR_ ## B, (uintptr_t *) t);                        \
  47 }                                                                       \
  48 static inline int                                                       \
  49 pwmbus_set_ ## A(device_t dev, T t)                                     \
  50 {                                                                       \
  51         return BUS_WRITE_IVAR(device_get_parent(dev), dev,              \
  52             PWMBUS_IVAR_ ## B, (uintptr_t) t);                          \
  53 }
  54
  55 PWMBUS_ACCESSOR(channel, CHANNEL, u_int)
  56
  57 extern driver_t   pwmbus_driver;
  58 extern devclass_t pwmbus_devclass;
  59 extern driver_t   ofw_pwmbus_driver;
  60 extern devclass_t ofw_pwmbus_devclass;
  61
  62 #endif /* _PWMBUS_H_ */