€•Ùn      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ"/translations/zh_CN/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ"/translations/zh_TW/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ"/translations/it_IT/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ"/translations/ja_JP/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ"/translations/ko_KR/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ"/translations/sp_SP/driver-api/pwm”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ&Pulse Width Modulation (PWM) interface”h]”hŒ&Pulse Width Modulation (PWM) interface”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒ</var/lib/git/docbuild/linux/Documentation/driver-api/pwm.rst”h KubhŒ	paragraph”“”)”}”(hŒ7This provides an overview about the Linux PWM interface”h]”hŒ7This provides an overview about the Linux PWM interface”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¸)”}”(hX  PWMs are commonly used for controlling LEDs, fans or vibrators in
cell phones. PWMs with a fixed purpose have no need implementing
the Linux PWM API (although they could). However, PWMs are often
found as discrete devices on SoCs which have no fixed purpose. It's
up to the board designer to connect them to LEDs or fans. To provide
this kind of flexibility the generic PWM API exists.”h]”hXƒ  PWMs are commonly used for controlling LEDs, fans or vibrators in
cell phones. PWMs with a fixed purpose have no need implementing
the Linux PWM API (although they could). However, PWMs are often
found as discrete devices on SoCs which have no fixed purpose. Itâ€™s
up to the board designer to connect them to LEDs or fans. To provide
this kind of flexibility the generic PWM API exists.”…””}”(hhÇhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒIdentifying PWMs”h]”hŒIdentifying PWMs”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhÕhžhhŸh¶h Kubh¸)”}”(hŒCUsers of the legacy PWM API use unique IDs to refer to PWM devices.”h]”hŒCUsers of the legacy PWM API use unique IDs to refer to PWM devices.”…””}”(hhæhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÕhžhubh¸)”}”(hŒËInstead of referring to a PWM device via its unique ID, board setup code
should instead register a static mapping that can be used to match PWM
consumers to providers, as given in the following example::”h]”hŒÊInstead of referring to a PWM device via its unique ID, board setup code
should instead register a static mapping that can be used to match PWM
consumers to providers, as given in the following example:”…””}”(hhôhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÕhžhubhŒliteral_block”“”)”}”(hX$  static struct pwm_lookup board_pwm_lookup[] = {
        PWM_LOOKUP("tegra-pwm", 0, "pwm-backlight", NULL,
                   50000, PWM_POLARITY_NORMAL),
};

static void __init board_init(void)
{
        ...
        pwm_add_table(board_pwm_lookup, ARRAY_SIZE(board_pwm_lookup));
        ...
}”h]”hX$  static struct pwm_lookup board_pwm_lookup[] = {
        PWM_LOOKUP("tegra-pwm", 0, "pwm-backlight", NULL,
                   50000, PWM_POLARITY_NORMAL),
};

static void __init board_init(void)
{
        ...
        pwm_add_table(board_pwm_lookup, ARRAY_SIZE(board_pwm_lookup));
        ...
}”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j  hŸh¶h KhhÕhžhubeh}”(h]”Œidentifying-pwms”ah ]”h"]”Œidentifying pwms”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒ
Using PWMs”h]”hŒ
Using PWMs”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h K$ubh¸)”}”(hŒÛConsumers use the pwm_get() function and pass to it the consumer device or a
consumer name. pwm_put() is used to free the PWM device. Managed variants of
the getter, devm_pwm_get() and devm_fwnode_pwm_get(), also exist.”h]”hŒÛConsumers use the pwm_get() function and pass to it the consumer device or a
consumer name. pwm_put() is used to free the PWM device. Managed variants of
the getter, devm_pwm_get() and devm_fwnode_pwm_get(), also exist.”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K&hj  hžhubh¸)”}”(hŒ9After being requested, a PWM has to be configured using::”h]”hŒ8After being requested, a PWM has to be configured using:”…””}”(hj;  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K*hj  hžhubj  )”}”(hŒKint pwm_apply_might_sleep(struct pwm_device *pwm, struct pwm_state *state);”h]”hŒKint pwm_apply_might_sleep(struct pwm_device *pwm, struct pwm_state *state);”…””}”hjI  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K,hj  hžhubh¸)”}”(hŒUThis API controls both the PWM period/duty_cycle config and the
enable/disable state.”h]”hŒUThis API controls both the PWM period/duty_cycle config and the
enable/disable state.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K.hj  hžhubh¸)”}”(hŒmPWM devices can be used from atomic context, if the PWM does not sleep. You
can check if this the case with::”h]”hŒlPWM devices can be used from atomic context, if the PWM does not sleep. You
can check if this the case with:”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K1hj  hžhubj  )”}”(hŒ-bool pwm_might_sleep(struct pwm_device *pwm);”h]”hŒ-bool pwm_might_sleep(struct pwm_device *pwm);”…””}”hjs  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K4hj  hžhubh¸)”}”(hŒCIf false, the PWM can also be configured from atomic context with::”h]”hŒBIf false, the PWM can also be configured from atomic context with:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K6hj  hžhubj  )”}”(hŒFint pwm_apply_atomic(struct pwm_device *pwm, struct pwm_state *state);”h]”hŒFint pwm_apply_atomic(struct pwm_device *pwm, struct pwm_state *state);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j  hŸh¶h K8hj  hžhubh¸)”}”(hŒóAs a consumer, don't rely on the output's state for a disabled PWM. If it's
easily possible, drivers are supposed to emit the inactive state, but some
drivers cannot. If you rely on getting the inactive state, use .duty_cycle=0,
.enabled=true.”h]”hŒùAs a consumer, donâ€™t rely on the outputâ€™s state for a disabled PWM. If itâ€™s
easily possible, drivers are supposed to emit the inactive state, but some
drivers cannot. If you rely on getting the inactive state, use .duty_cycle=0,
.enabled=true.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K:hj  hžhubh¸)”}”(hX  There is also a usage_power setting: If set, the PWM driver is only required to
maintain the power output but has more freedom regarding signal form.
If supported by the driver, the signal can be optimized, for example to improve
EMI by phase shifting the individual channels of a chip.”h]”hX  There is also a usage_power setting: If set, the PWM driver is only required to
maintain the power output but has more freedom regarding signal form.
If supported by the driver, the signal can be optimized, for example to improve
EMI by phase shifting the individual channels of a chip.”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K?hj  hžhubh¸)”}”(hXW  The pwm_config(), pwm_enable() and pwm_disable() functions are just wrappers
around pwm_apply_might_sleep() and should not be used if the user wants to change
several parameter at once. For example, if you see pwm_config() and
pwm_{enable,disable}() calls in the same function, this probably means you
should switch to pwm_apply_might_sleep().”h]”hXW  The pwm_config(), pwm_enable() and pwm_disable() functions are just wrappers
around pwm_apply_might_sleep() and should not be used if the user wants to change
several parameter at once. For example, if you see pwm_config() and
pwm_{enable,disable}() calls in the same function, this probably means you
should switch to pwm_apply_might_sleep().”…””}”(hj¹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KDhj  hžhubh¸)”}”(hXj  The PWM user API also allows one to query the PWM state that was passed to the
last invocation of pwm_apply_might_sleep() using pwm_get_state(). Note this is
different to what the driver has actually implemented if the request cannot be
satisfied exactly with the hardware in use. There is currently no way for
consumers to get the actually implemented settings.”h]”hXj  The PWM user API also allows one to query the PWM state that was passed to the
last invocation of pwm_apply_might_sleep() using pwm_get_state(). Note this is
different to what the driver has actually implemented if the request cannot be
satisfied exactly with the hardware in use. There is currently no way for
consumers to get the actually implemented settings.”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KJhj  hžhubh¸)”}”(hXõ  In addition to the PWM state, the PWM API also exposes PWM arguments, which
are the reference PWM config one should use on this PWM.
PWM arguments are usually platform-specific and allows the PWM user to only
care about dutycycle relatively to the full period (like, duty = 50% of the
period). struct pwm_args contains 2 fields (period and polarity) and should
be used to set the initial PWM config (usually done in the probe function
of the PWM user). PWM arguments are retrieved with pwm_get_args().”h]”hXõ  In addition to the PWM state, the PWM API also exposes PWM arguments, which
are the reference PWM config one should use on this PWM.
PWM arguments are usually platform-specific and allows the PWM user to only
care about dutycycle relatively to the full period (like, duty = 50% of the
period). struct pwm_args contains 2 fields (period and polarity) and should
be used to set the initial PWM config (usually done in the probe function
of the PWM user). PWM arguments are retrieved with pwm_get_args().”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KPhj  hžhubh¸)”}”(hŒŸAll consumers should really be reconfiguring the PWM upon resume as
appropriate. This is the only way to ensure that everything is resumed in
the proper order.”h]”hŒŸAll consumers should really be reconfiguring the PWM upon resume as
appropriate. This is the only way to ensure that everything is resumed in
the proper order.”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KXhj  hžhubeh}”(h]”Œ
using-pwms”ah ]”h"]”Œ
using pwms”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K$ubh¢)”}”(hhh]”(h§)”}”(hŒ#Using PWMs with the sysfs interface”h]”hŒ#Using PWMs with the sysfs interface”…””}”(hjü  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjù  hžhhŸh¶h K]ubh¸)”}”(hX%  If CONFIG_SYSFS is enabled in your kernel configuration a simple sysfs
interface is provided to use the PWMs from userspace. It is exposed at
/sys/class/pwm/. Each probed PWM controller/chip will be exported as
pwmchipN, where N is the base of the PWM chip. Inside the directory you
will find:”h]”hX%  If CONFIG_SYSFS is enabled in your kernel configuration a simple sysfs
interface is provided to use the PWMs from userspace. It is exposed at
/sys/class/pwm/. Each probed PWM controller/chip will be exported as
pwmchipN, where N is the base of the PWM chip. Inside the directory you
will find:”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K_hjù  hžhubhŒblock_quote”“”)”}”(hŒ¿npwm
  The number of PWM channels this chip supports (read-only).

export
  Exports a PWM channel for use with sysfs (write-only).

unexport
 Unexports a PWM channel from sysfs (write-only).
”h]”hŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hŒ@npwm
The number of PWM channels this chip supports (read-only).
”h]”(hŒterm”“”)”}”(hŒnpwm”h]”hŒnpwm”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h Kfhj%  ubhŒ
definition”“”)”}”(hhh]”h¸)”}”(hŒ:The number of PWM channels this chip supports (read-only).”h]”hŒ:The number of PWM channels this chip supports (read-only).”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kfhj;  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hj%  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h Kfhj   ubj$  )”}”(hŒ>export
Exports a PWM channel for use with sysfs (write-only).
”h]”(j*  )”}”(hŒexport”h]”hŒexport”…””}”(hj\  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h KihjX  ubj:  )”}”(hhh]”h¸)”}”(hŒ6Exports a PWM channel for use with sysfs (write-only).”h]”hŒ6Exports a PWM channel for use with sysfs (write-only).”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kihjj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hjX  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h Kihj   ubj$  )”}”(hŒ:unexport
Unexports a PWM channel from sysfs (write-only).
”h]”(j*  )”}”(hŒunexport”h]”hŒunexport”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h Klhj‡  ubj:  )”}”(hhh]”h¸)”}”(hŒ0Unexports a PWM channel from sysfs (write-only).”h]”hŒ0Unexports a PWM channel from sysfs (write-only).”…””}”(hjœ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Klhj™  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hj‡  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h Klhj   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh¶h Kehjù  hžhubh¸)”}”(hŒFThe PWM channels are numbered using a per-chip index from 0 to npwm-1.”h]”hŒFThe PWM channels are numbered using a per-chip index from 0 to npwm-1.”…””}”(hjÂ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Knhjù  hžhubh¸)”}”(hŒÙWhen a PWM channel is exported a pwmX directory will be created in the
pwmchipN directory it is associated with, where X is the number of the
channel that was exported. The following properties will then be available:”h]”hŒÙWhen a PWM channel is exported a pwmX directory will be created in the
pwmchipN directory it is associated with, where X is the number of the
channel that was exported. The following properties will then be available:”…””}”(hjÐ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kphjù  hžhubj  )”}”(hX<  period
  The total period of the PWM signal (read/write).
  Value is in nanoseconds and is the sum of the active and inactive
  time of the PWM.

duty_cycle
  The active time of the PWM signal (read/write).
  Value is in nanoseconds and must be less than or equal to the period.

polarity
  Changes the polarity of the PWM signal (read/write).
  Writes to this property only work if the PWM chip supports changing
  the polarity.
  Value is the string "normal" or "inversed".

enable
  Enable/disable the PWM signal (read/write).

      - 0 - disabled
      - 1 - enabled
”h]”j  )”}”(hhh]”(j$  )”}”(hŒ‹period
The total period of the PWM signal (read/write).
Value is in nanoseconds and is the sum of the active and inactive
time of the PWM.
”h]”(j*  )”}”(hŒperiod”h]”hŒperiod”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h Kwhjå  ubj:  )”}”(hhh]”h¸)”}”(hŒƒThe total period of the PWM signal (read/write).
Value is in nanoseconds and is the sum of the active and inactive
time of the PWM.”h]”hŒƒThe total period of the PWM signal (read/write).
Value is in nanoseconds and is the sum of the active and inactive
time of the PWM.”…””}”(hjú  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kuhj÷  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hjå  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h Kwhjâ  ubj$  )”}”(hŒduty_cycle
The active time of the PWM signal (read/write).
Value is in nanoseconds and must be less than or equal to the period.
”h]”(j*  )”}”(hŒ
duty_cycle”h]”hŒ
duty_cycle”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h K{hj  ubj:  )”}”(hhh]”h¸)”}”(hŒuThe active time of the PWM signal (read/write).
Value is in nanoseconds and must be less than or equal to the period.”h]”hŒuThe active time of the PWM signal (read/write).
Value is in nanoseconds and must be less than or equal to the period.”…””}”(hj)  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kzhj&  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h K{hjâ  ubj$  )”}”(hŒ¼polarity
Changes the polarity of the PWM signal (read/write).
Writes to this property only work if the PWM chip supports changing
the polarity.
Value is the string "normal" or "inversed".
”h]”(j*  )”}”(hŒpolarity”h]”hŒpolarity”…””}”(hjG  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h KhjC  ubj:  )”}”(hhh]”h¸)”}”(hŒ²Changes the polarity of the PWM signal (read/write).
Writes to this property only work if the PWM chip supports changing
the polarity.
Value is the string "normal" or "inversed".”h]”hŒºChanges the polarity of the PWM signal (read/write).
Writes to this property only work if the PWM chip supports changing
the polarity.
Value is the string â€œnormalâ€ or â€œinversedâ€.”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K~hjU  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j9  hjC  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h Khjâ  ubj$  )”}”(hŒYenable
Enable/disable the PWM signal (read/write).

    - 0 - disabled
    - 1 - enabled
”h]”(j*  )”}”(hŒenable”h]”hŒenable”…””}”(hjv  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j)  hŸh¶h K‡hjr  ubj:  )”}”(hhh]”(h¸)”}”(hŒ+Enable/disable the PWM signal (read/write).”h]”hŒ+Enable/disable the PWM signal (read/write).”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K„hj„  ubj  )”}”(hŒ- 0 - disabled
- 1 - enabled
”h]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ0 - disabled”h]”h¸)”}”(hj¢  h]”hŒ0 - disabled”…””}”(hj¤  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K†hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jž  hj›  ubjŸ  )”}”(hŒ1 - enabled
”h]”h¸)”}”(hŒ1 - enabled”h]”hŒ1 - enabled”…””}”(hj»  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K‡hj·  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jž  hj›  ubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j™  hŸh¶h K†hj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh¶h K†hj„  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j9  hjr  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hŸh¶h K‡hjâ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  hjÞ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  hŸh¶h Kthjù  hžhubeh}”(h]”Œ#using-pwms-with-the-sysfs-interface”ah ]”h"]”Œ#using pwms with the sysfs interface”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K]ubh¢)”}”(hhh]”(h§)”}”(hŒImplementing a PWM driver”h]”hŒImplementing a PWM driver”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjý  hžhhŸh¶h KŠubh¸)”}”(hXN  Currently there are two ways to implement pwm drivers. Traditionally
there only has been the barebone API meaning that each driver has
to implement the pwm_*() functions itself. This means that it's impossible
to have multiple PWM drivers in the system. For this reason it's mandatory
for new drivers to use the generic PWM framework.”h]”hXR  Currently there are two ways to implement pwm drivers. Traditionally
there only has been the barebone API meaning that each driver has
to implement the pwm_*() functions itself. This means that itâ€™s impossible
to have multiple PWM drivers in the system. For this reason itâ€™s mandatory
for new drivers to use the generic PWM framework.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŒhjý  hžhubh¸)”}”(hX©  A new PWM controller/chip can be allocated using pwmchip_alloc(), then
registered using pwmchip_add() and removed again with pwmchip_remove(). To undo
pwmchip_alloc() use pwmchip_put(). pwmchip_add() takes a filled in struct
pwm_chip as argument which provides a description of the PWM chip, the number
of PWM devices provided by the chip and the chip-specific implementation of the
supported PWM operations to the framework.”h]”hX©  A new PWM controller/chip can be allocated using pwmchip_alloc(), then
registered using pwmchip_add() and removed again with pwmchip_remove(). To undo
pwmchip_alloc() use pwmchip_put(). pwmchip_add() takes a filled in struct
pwm_chip as argument which provides a description of the PWM chip, the number
of PWM devices provided by the chip and the chip-specific implementation of the
supported PWM operations to the framework.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K’hjý  hžhubh¸)”}”(hX‘  When implementing polarity support in a PWM driver, make sure to respect the
signal conventions in the PWM framework. By definition, normal polarity
characterizes a signal starts high for the duration of the duty cycle and
goes low for the remainder of the period. Conversely, a signal with inversed
polarity starts low for the duration of the duty cycle and goes high for the
remainder of the period.”h]”hX‘  When implementing polarity support in a PWM driver, make sure to respect the
signal conventions in the PWM framework. By definition, normal polarity
characterizes a signal starts high for the duration of the duty cycle and
goes low for the remainder of the period. Conversely, a signal with inversed
polarity starts low for the duration of the duty cycle and goes high for the
remainder of the period.”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K™hjý  hžhubh¸)”}”(hX  Drivers are encouraged to implement ->apply() instead of the legacy
->enable(), ->disable() and ->config() methods. Doing that should provide
atomicity in the PWM config workflow, which is required when the PWM controls
a critical device (like a regulator).”h]”hX  Drivers are encouraged to implement ->apply() instead of the legacy
->enable(), ->disable() and ->config() methods. Doing that should provide
atomicity in the PWM config workflow, which is required when the PWM controls
a critical device (like a regulator).”…””}”(hj8  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K hjý  hžhubh¸)”}”(hŒÒThe implementation of ->get_state() (a method used to retrieve initial PWM
state) is also encouraged for the same reason: letting the PWM user know
about the current PWM state would allow him to avoid glitches.”h]”hŒÒThe implementation of ->get_state() (a method used to retrieve initial PWM
state) is also encouraged for the same reason: letting the PWM user know
about the current PWM state would allow him to avoid glitches.”…””}”(hjF  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¥hjý  hžhubh¸)”}”(hŒŠDrivers should not implement any power management. In other words,
consumers should implement it as described in the "Using PWMs" section.”h]”hŒŽDrivers should not implement any power management. In other words,
consumers should implement it as described in the â€œUsing PWMsâ€ section.”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K©hjý  hžhubeh}”(h]”Œimplementing-a-pwm-driver”ah ]”h"]”Œimplementing a pwm driver”ah$]”h&]”uh1h¡hh£hžhhŸh¶h KŠubh¢)”}”(hhh]”(h§)”}”(hŒLocking”h]”hŒLocking”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjj  hžhhŸh¶h K­ubh¸)”}”(hXõ  The PWM core list manipulations are protected by a mutex, so pwm_get()
and pwm_put() may not be called from an atomic context.
Most functions in the PWM consumer API might sleep and so must not be called
from atomic context. The notable exception is pwm_apply_atomic() which has the
same semantics as pwm_apply_might_sleep() but can be called from atomic context.
(The price for that is that it doesn't work for all PWM devices, use
pwm_might_sleep() to check if a given PWM supports atomic operation.”h]”hX÷  The PWM core list manipulations are protected by a mutex, so pwm_get()
and pwm_put() may not be called from an atomic context.
Most functions in the PWM consumer API might sleep and so must not be called
from atomic context. The notable exception is pwm_apply_atomic() which has the
same semantics as pwm_apply_might_sleep() but can be called from atomic context.
(The price for that is that it doesnâ€™t work for all PWM devices, use
pwm_might_sleep() to check if a given PWM supports atomic operation.”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¯hjj  hžhubh¸)”}”(hŒWLocking in the PWM core ensures that callbacks related to a single chip are
serialized.”h]”hŒWLocking in the PWM core ensures that callbacks related to a single chip are
serialized.”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K·hjj  hžhubeh}”(h]”Œlocking”ah ]”h"]”Œlocking”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K­ubh¢)”}”(hhh]”(h§)”}”(hŒHelpers”h]”hŒHelpers”…””}”(hj¢  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjŸ  hžhhŸh¶h K»ubh¸)”}”(hŒêCurrently a PWM can only be configured with period_ns and duty_ns. For several
use cases freq_hz and duty_percent might be better. Instead of calculating
this in your driver please consider adding appropriate helpers to the framework.”h]”hŒêCurrently a PWM can only be configured with period_ns and duty_ns. For several
use cases freq_hz and duty_percent might be better. Instead of calculating
this in your driver please consider adding appropriate helpers to the framework.”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K½hjŸ  hžhubeh}”(h]”Œhelpers”ah ]”h"]”Œhelpers”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K»ubeh}”(h]”Œ$pulse-width-modulation-pwm-interface”ah ]”h"]”Œ&pulse width modulation (pwm) interface”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jñ  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jË  jÈ  j  j  jö  jó  jú  j÷  jg  jd  jœ  j™  jÃ  jÀ  uŒ	nametypes”}”(jË  ‰j  ‰jö  ‰jú  ‰jg  ‰jœ  ‰jÃ  ‰uh}”(jÈ  h£j  hÕjó  j  j÷  jù  jd  jý  j™  jj  jÀ  jŸ  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.