usr.sbin/pwm/pwm.8

   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 June 17, 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
  53 The
  54 .Nm
  55 utility can be used to configure pwm controllers.
  56 .Pp
  57 The options are as follow:
  58 .Bl -tag -width "-c channel"
  59 .It Fl c Ar channel
  60 Channel number to operate on.
  61 .It Fl f Ar device
  62 Device to operate on.
  63 If not specified,
  64 .Pa /dev/pwm/pwmc0.0
  65 is used.
  66 If an unqualified name is provided,
  67 .Pa /dev/pwm
  68 is automatically prepended.
  69 .It Fl E
  70 Enable the pwm channel.
  71 .It Fl D
  72 Disable the pwm channel.
  73 .It Fl C
  74 Show the configuration of the pwm channel.
  75 .It Fl p Ar period
  76 Configure the period (in nanoseconds) of the pwm channel
  77 .It Fl d Ar duty
  78 Configure the duty (in nanoseconds or percentage) of the pwm channel.
  79 Duty is the portion of the
  80 .Ar period
  81 during which the signal is asserted.
  82 .El
  83 .Sh EXAMPLES
  84 .Bl -bullet
  85 .It
  86 Show the configuration of the pwm channel:
  87 .Bd -literal
  88 pwm -f /dev/pwm/pwmc0.1 -C
  89 .Ed
  90 .It
  91 Configure a 50000 ns period and a 25000 ns duty cycle:
  92 .Bd -literal
  93 pwm -f pwmc1.1 -p 50000 -d 25000
  94 .Ed
  95 .It
  96 Configure a 50% duty cycle on the device and channel which
  97 were configured in
  98 .Xr pwmc 4
  99 to have the label
 100 .Pa backlight :
 101 .Bd -literal
 102 pwm -f backlight -d 50%
 103 .Ed
 104 .El
 105 .Sh SEE ALSO
 106 .Xr pwm 9 ,
 107 .Xr pwmbus 9
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 utility appeared in
 112 .Fx 13.0 .
 113 .Sh AUTHORS
 114 .An -nosplit
 115 The
 116 .Nm
 117 utility and this manual page were written by
 118 .An Emmanuel Vadot Aq Mt manu@FreeBSD.org .