xref: /freebsd/usr.sbin/pwm/pwm.8 (revision 4bc52338)
1.\" Copyright (c) 2018 Emmanuel Vadot <manu@freebsd.org>
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
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.
11.\"
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.
22.\"
23.\" $FreeBSD$
24.\"
25.Dd January 12, 2019
26.Dt PWM 8
27.Os
28.Sh NAME
29.Nm pwm
30.Nd configure pwm controller
31.Sh SYNOPSIS
32.Nm
33.Op Fl f Ar device
34.Fl c Ar channel
35.Fl E
36.Nm
37.Op Fl f Ar device
38.Fl c Ar channel
39.Fl D
40.Nm
41.Op Fl f Ar device
42.Fl c Ar channel
43.Fl C
44.Nm
45.Op Fl f Ar device
46.Fl c Ar channel
47.Fl p Ar period
48.Nm
49.Op Fl f Ar device
50.Fl c Ar channel
51.Fl d Ar duty
52.Sh DESCRIPTION
53The
54.Nm
55utility can be used to configure pwm controllers.
56.Pp
57The options are as follow:
58.Bl -tag -width "-c channel"
59.It Fl c Ar channel
60Channel number to operate on
61.It Fl f Ar device
62Device to operate on.
63If not specified,
64.Pa /dev/pwmc0
65is used.
66.It Fl E
67Enable the pwm channel
68.It Fl D
69Disable the pwm channel
70.It Fl C
71Show the configuration of the pwm channel
72.It Fl p Ar period
73Configure the period (in nanoseconds) of the pwm channel
74.It Fl d Ar duty
75Configure the duty (in nanoseconds or percentage) of the pwm channel
76.El
77.Sh EXAMPLES
78.Bl -bullet
79.It
80Show the configuration of the pwm channel:
81.Bd -literal
82pwm -f /dev/pwmc0 -C
83.Ed
84.It
85Configure a 50000 ns period and a 25000 duty cycle:
86.Bd -literal
87pwm -f /dev/pwmc0 -p 50000 -d 25000
88.Ed
89.It
90Configure a 50% duty cycle:
91.Bd -literal
92pwm -f /dev/pwmc0 -d 50%
93.Ed
94.El
95.Sh SEE ALSO
96.Xr pwm 9 ,
97.Xr pwmbus 9
98.Sh HISTORY
99The
100.Nm
101utility appeared in
102.Fx 13.0 .
103.Sh AUTHORS
104.An -nosplit
105The
106.Nm
107utility and this manual page were written by
108.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
109