From owner-svn-src-all@freebsd.org Tue Jun 18 00:17:11 2019 Return-Path: Delivered-To: svn-src-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 0F6DE15C82D8; Tue, 18 Jun 2019 00:17:11 +0000 (UTC) (envelope-from ian@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id A229E888CE; Tue, 18 Jun 2019 00:17:10 +0000 (UTC) (envelope-from ian@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 76256556F; Tue, 18 Jun 2019 00:17:10 +0000 (UTC) (envelope-from ian@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x5I0HAu0032834; Tue, 18 Jun 2019 00:17:10 GMT (envelope-from ian@FreeBSD.org) Received: (from ian@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x5I0HAJa032833; Tue, 18 Jun 2019 00:17:10 GMT (envelope-from ian@FreeBSD.org) Message-Id: <201906180017.x5I0HAJa032833@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: ian set sender to ian@FreeBSD.org using -f From: Ian Lepore Date: Tue, 18 Jun 2019 00:17:10 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r349165 - head/usr.sbin/pwm X-SVN-Group: head X-SVN-Commit-Author: ian X-SVN-Commit-Paths: head/usr.sbin/pwm X-SVN-Commit-Revision: 349165 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: A229E888CE X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.98 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_SHORT(-0.98)[-0.985,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US]; NEURAL_HAM_LONG(-1.00)[-1.000,0] X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 18 Jun 2019 00:17:11 -0000 Author: ian Date: Tue Jun 18 00:17:10 2019 New Revision: 349165 URL: https://svnweb.freebsd.org/changeset/base/349165 Log: Explain the relationship between PWM hardware channels being controlled and pwmc(4) device filenames. Also, use uppercase PWM when the term is being used as an acronym, and expand the acronym where it's first used. Modified: head/usr.sbin/pwm/pwm.8 Modified: head/usr.sbin/pwm/pwm.8 ============================================================================== --- head/usr.sbin/pwm/pwm.8 Tue Jun 18 00:11:00 2019 (r349164) +++ head/usr.sbin/pwm/pwm.8 Tue Jun 18 00:17:10 2019 (r349165) @@ -27,7 +27,7 @@ .Os .Sh NAME .Nm pwm -.Nd configure pwm controller +.Nd configure PWM (Pulse Width Modulation) hardware .Sh SYNOPSIS .Nm .Op Fl f Ar device @@ -47,9 +47,26 @@ .Sh DESCRIPTION The .Nm -utility can be used to configure pwm controllers. +utility can be used to configure pwm hardware. +.Nm +uses a +.Xr pwmc 4 +device to communicate with the hardware. +Some PWM hardware supports multiple output channels within a single +controller block; each +.Xr pwmc 4 +instance controls a single PWM channel. .Pp -The options are as follow: +.Xr pwmc 4 +devices are named +.Pa /dev/pwm/pwmcX.Y , +where +.Va X +is the controller unit number and +.Va Y +is the channel number within that unit. +.Pp +The options are as follows: .Bl -tag -width "-f device" .It Fl f Ar device Device to operate on. @@ -60,15 +77,15 @@ If an unqualified name is provided, .Pa /dev/pwm is automatically prepended. .It Fl E -Enable the pwm channel. +Enable the PWM channel. .It Fl D -Disable the pwm channel. +Disable the PWM channel. .It Fl C -Show the configuration of the pwm channel. +Show the configuration of the PWM channel. .It Fl p Ar period -Configure the period (in nanoseconds) of the pwm channel +Configure the period (in nanoseconds) of the PWM channel .It Fl d Ar duty -Configure the duty (in nanoseconds or percentage) of the pwm channel. +Configure the duty (in nanoseconds or percentage) of the PWM channel. Duty is the portion of the .Ar period during which the signal is asserted. @@ -76,7 +93,7 @@ during which the signal is asserted. .Sh EXAMPLES .Bl -bullet .It -Show the configuration of the pwm channel: +Show the configuration of the PWM channel: .Bd -literal pwm -f /dev/pwm/pwmc0.1 -C .Ed