Skip to content

Commit b817bf5

Browse files
author
Thierry Reding
committed
pwm: Improve Kconfig help text
The Kconfig help text should help the user understand what functionality is provided by an option. This is especially true for new subsystems. An improved help text is provided by this commit in the hopes of clarifying the usefulness of the PWM framework. Signed-off-by: Thierry Reding <[email protected]> Acked-by: Borislav Petkov <[email protected]>
1 parent e50d352 commit b817bf5

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

drivers/pwm/Kconfig

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
menuconfig PWM
2-
bool "PWM Support"
2+
bool "Pulse-Width Modulation (PWM) Support"
33
depends on !MACH_JZ4740 && !PUV3_PWM
44
help
5-
This enables PWM support through the generic PWM framework.
6-
You only need to enable this, if you also want to enable
7-
one or more of the PWM drivers below.
8-
9-
If unsure, say N.
5+
Generic Pulse-Width Modulation (PWM) support.
6+
7+
In Pulse-Width Modulation, a variation of the width of pulses
8+
in a rectangular pulse signal is used as a means to alter the
9+
average power of the signal. Applications include efficient
10+
power delivery and voltage regulation. In computer systems,
11+
PWMs are commonly used to control fans or the brightness of
12+
display backlights.
13+
14+
This framework provides a generic interface to PWM devices
15+
within the Linux kernel. On the driver side it provides an API
16+
to register and unregister a PWM chip, an abstraction of a PWM
17+
controller, that supports one or more PWM devices. Client
18+
drivers can request PWM devices and use the generic framework
19+
to configure as well as enable and disable them.
20+
21+
This generic framework replaces the legacy PWM framework which
22+
allows only a single driver implementing the required API. Not
23+
all legacy implementations have been ported to the framework
24+
yet. The framework provides an API that is backward compatible
25+
with the legacy framework so that existing client drivers
26+
continue to work as expected.
27+
28+
If unsure, say no.
1029

1130
if PWM
1231

0 commit comments

Comments
 (0)