1 .\" Copyright (c) 2018 Emmanuel Vadot <manu@freebsd.org>
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
12 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
13 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
14 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
15 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
16 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
17 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
18 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
19 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
21 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .Nm pwmbus_attach_bus ,
32 .Nm PWMBUS_CHANNEL_CONFIG ,
33 .Nm PWMBUS_CHANNEL_GET_CONFIG ,
34 .Nm PWMBUS_CHANNEL_SET_FLAGS ,
35 .Nm PWMBUS_CHANNEL_GET_FLAGS ,
36 .Nm PWMBUS_CHANNEL_ENABLE ,
37 .Nm PWMBUS_CHANNEL_IS_ENABLED ,
38 .Nm PWMBUS_CHANNEL_MAX
44 .Fn pwmbus_attach_bus "device_t dev"
46 .Fn PWMBUS_CHANNEL_CONFIG "device_t bus" "int channel" "uint64_t period" "uint64_t duty"
48 .Fn PWMBUS_CHANNEL_GET_CONFIG "device_t bus" "int channel" "uint64_t *period" "uint64_t *duty"
50 .Fn PWMBUS_CHANNEL_SET_FLAGS "device_t bus" "int channel" "uint32_t flags"
52 .Fn PWMBUS_CHANNEL_GET_FLAGS "device_t bus" "int channel" "uint32_t *flags"
54 .Fn PWMBUS_CHANNEL_ENABLE "device_t bus" "int channel" "bool enable"
56 .Fn PWMBUS_CHANNEL_IS_ENABLED "device_t bus" "int channel" "bool *enabled"
58 .Fn PWMBUS_CHANNEL_MAX "device_t bus" "int channel" "int *nchannel"
60 The PWMBUS (Pulse-Width Modulation) interface allows the device driver to register to a global
61 bus so other devices in the kernel can use them in a generic way
63 .Bl -tag -width indent
64 .It Fn pwmbus_attach_bus "device_t dev"
68 .It Fn PWMBUS_CHANNEL_CONFIG "device_t bus" "int channel" "uint64_t period" "uint64_t duty"
69 Configure the period and duty (in nanoseconds) in the PWM controller on the bus for the specified channel.
70 Returns 0 on success or
72 is the values are not supported by the controller or
74 is the PWMBUS controller is in use and doesn't support changing the value on the fly.
75 .It Fn PWMBUS_CHANNEL_GET_CONFIG "device_t bus" "int channel" "uint64_t *period" "uint64_t *duty"
76 Get the current configuration of the period and duty for the specified channel.
77 .It Fn PWMBUS_CHANNEL_SET_FLAGS "device_t bus" "int channel" "uint32_t flags"
78 Set the flags of the channel (like inverted polarity), if the driver or controller
79 doesn't support this a default method is used.
80 .It Fn PWMBUS_CHANNEL_GET_FLAGS "device_t bus" "int channel" "uint32_t *flags"
81 Get the current flags for the channel, if the driver or controller
82 doesn't support this, a default method is used.
83 .It Fn PWMBUS_CHANNEL_ENABLE "device_t bus" "int channel" "bool enable"
84 Enable the PWM channel.
85 .It Fn PWMBUS_CHANNEL_ISENABLED "device_t bus" "int channel" "bool *enable"
86 Test if the PWM channel is enabled.
87 .It PWMBUS_CHANNEL_MAX "device_t bus" "int channel" "int *nchannel"
88 Get the maximum number of channel supported by the controller.
93 interface first appear in
97 interface and manual page was written by
98 .An Emmanuel Vadot Aq Mt manu@FreeBSD.org .