Documentation/driver-api/pwm.rst

   1 ======================================
   2 Pulse Width Modulation (PWM) interface
   3 ======================================
   4
   5 This provides an overview about the Linux PWM interface
   6
   7 PWMs are commonly used for controlling LEDs, fans or vibrators in
   8 cell phones. PWMs with a fixed purpose have no need implementing
   9 the Linux PWM API (although they could). However, PWMs are often
  10 found as discrete devices on SoCs which have no fixed purpose. It's
  11 up to the board designer to connect them to LEDs or fans. To provide
  12 this kind of flexibility the generic PWM API exists.
  13
  14 Identifying PWMs
  15 ----------------
  16
  17 Users of the legacy PWM API use unique IDs to refer to PWM devices.
  18
  19 Instead of referring to a PWM device via its unique ID, board setup code
  20 should instead register a static mapping that can be used to match PWM
  21 consumers to providers, as given in the following example::
  22
  23         static struct pwm_lookup board_pwm_lookup[] = {
  24                 PWM_LOOKUP("tegra-pwm", 0, "pwm-backlight", NULL,
  25                            50000, PWM_POLARITY_NORMAL),
  26         };
  27
  28         static void __init board_init(void)
  29         {
  30                 ...
  31                 pwm_add_table(board_pwm_lookup, ARRAY_SIZE(board_pwm_lookup));
  32                 ...
  33         }
  34
  35 Using PWMs
  36 ----------
  37
  38 Legacy users can request a PWM device using pwm_request() and free it
  39 after usage with pwm_free().
  40
  41 New users should use the pwm_get() function and pass to it the consumer
  42 device or a consumer name. pwm_put() is used to free the PWM device. Managed
  43 variants of the getter, devm_pwm_get() and devm_fwnode_pwm_get(), also exist.
  44
  45 After being requested, a PWM has to be configured using::
  46
  47         int pwm_apply_state(struct pwm_device *pwm, struct pwm_state *state);
  48
  49 This API controls both the PWM period/duty_cycle config and the
  50 enable/disable state.
  51
  52 As a consumer, don't rely on the output's state for a disabled PWM. If it's
  53 easily possible, drivers are supposed to emit the inactive state, but some
  54 drivers cannot. If you rely on getting the inactive state, use .duty_cycle=0,
  55 .enabled=true.
  56
  57 There is also a usage_power setting: If set, the PWM driver is only required to
  58 maintain the power output but has more freedom regarding signal form.
  59 If supported by the driver, the signal can be optimized, for example to improve
  60 EMI by phase shifting the individual channels of a chip.
  61
  62 The pwm_config(), pwm_enable() and pwm_disable() functions are just wrappers
  63 around pwm_apply_state() and should not be used if the user wants to change
  64 several parameter at once. For example, if you see pwm_config() and
  65 pwm_{enable,disable}() calls in the same function, this probably means you
  66 should switch to pwm_apply_state().
  67
  68 The PWM user API also allows one to query the PWM state that was passed to the
  69 last invocation of pwm_apply_state() using pwm_get_state(). Note this is
  70 different to what the driver has actually implemented if the request cannot be
  71 satisfied exactly with the hardware in use. There is currently no way for
  72 consumers to get the actually implemented settings.
  73
  74 In addition to the PWM state, the PWM API also exposes PWM arguments, which
  75 are the reference PWM config one should use on this PWM.
  76 PWM arguments are usually platform-specific and allows the PWM user to only
  77 care about dutycycle relatively to the full period (like, duty = 50% of the
  78 period). struct pwm_args contains 2 fields (period and polarity) and should
  79 be used to set the initial PWM config (usually done in the probe function
  80 of the PWM user). PWM arguments are retrieved with pwm_get_args().
  81
  82 All consumers should really be reconfiguring the PWM upon resume as
  83 appropriate. This is the only way to ensure that everything is resumed in
  84 the proper order.
  85
  86 Using PWMs with the sysfs interface
  87 -----------------------------------
  88
  89 If CONFIG_SYSFS is enabled in your kernel configuration a simple sysfs
  90 interface is provided to use the PWMs from userspace. It is exposed at
  91 /sys/class/pwm/. Each probed PWM controller/chip will be exported as
  92 pwmchipN, where N is the base of the PWM chip. Inside the directory you
  93 will find:
  94
  95   npwm
  96     The number of PWM channels this chip supports (read-only).
  97
  98   export
  99     Exports a PWM channel for use with sysfs (write-only).
 100
 101   unexport
 102    Unexports a PWM channel from sysfs (write-only).
 103
 104 The PWM channels are numbered using a per-chip index from 0 to npwm-1.
 105
 106 When a PWM channel is exported a pwmX directory will be created in the
 107 pwmchipN directory it is associated with, where X is the number of the
 108 channel that was exported. The following properties will then be available:
 109
 110   period
 111     The total period of the PWM signal (read/write).
 112     Value is in nanoseconds and is the sum of the active and inactive
 113     time of the PWM.
 114
 115   duty_cycle
 116     The active time of the PWM signal (read/write).
 117     Value is in nanoseconds and must be less than the period.
 118
 119   polarity
 120     Changes the polarity of the PWM signal (read/write).
 121     Writes to this property only work if the PWM chip supports changing
 122     the polarity. The polarity can only be changed if the PWM is not
 123     enabled. Value is the string "normal" or "inversed".
 124
 125   enable
 126     Enable/disable the PWM signal (read/write).
 127
 128         - 0 - disabled
 129         - 1 - enabled
 130
 131 Implementing a PWM driver
 132 -------------------------
 133
 134 Currently there are two ways to implement pwm drivers. Traditionally
 135 there only has been the barebone API meaning that each driver has
 136 to implement the pwm_*() functions itself. This means that it's impossible
 137 to have multiple PWM drivers in the system. For this reason it's mandatory
 138 for new drivers to use the generic PWM framework.
 139
 140 A new PWM controller/chip can be added using pwmchip_add() and removed
 141 again with pwmchip_remove(). pwmchip_add() takes a filled in struct
 142 pwm_chip as argument which provides a description of the PWM chip, the
 143 number of PWM devices provided by the chip and the chip-specific
 144 implementation of the supported PWM operations to the framework.
 145
 146 When implementing polarity support in a PWM driver, make sure to respect the
 147 signal conventions in the PWM framework. By definition, normal polarity
 148 characterizes a signal starts high for the duration of the duty cycle and
 149 goes low for the remainder of the period. Conversely, a signal with inversed
 150 polarity starts low for the duration of the duty cycle and goes high for the
 151 remainder of the period.
 152
 153 Drivers are encouraged to implement ->apply() instead of the legacy
 154 ->enable(), ->disable() and ->config() methods. Doing that should provide
 155 atomicity in the PWM config workflow, which is required when the PWM controls
 156 a critical device (like a regulator).
 157
 158 The implementation of ->get_state() (a method used to retrieve initial PWM
 159 state) is also encouraged for the same reason: letting the PWM user know
 160 about the current PWM state would allow him to avoid glitches.
 161
 162 Drivers should not implement any power management. In other words,
 163 consumers should implement it as described in the "Using PWMs" section.
 164
 165 Locking
 166 -------
 167
 168 The PWM core list manipulations are protected by a mutex, so pwm_request()
 169 and pwm_free() may not be called from an atomic context. Currently the
 170 PWM core does not enforce any locking to pwm_enable(), pwm_disable() and
 171 pwm_config(), so the calling context is currently driver specific. This
 172 is an issue derived from the former barebone API and should be fixed soon.
 173
 174 Helpers
 175 -------
 176
 177 Currently a PWM can only be configured with period_ns and duty_ns. For several
 178 use cases freq_hz and duty_percent might be better. Instead of calculating
 179 this in your driver please consider adding appropriate helpers to the framework.