Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt-bindings: power: Clarify wording for wakeup-source property

The wording in the current documentation is a little strong. The
intention was not to fix any particular interrupt as wakeup capable but
leave those details to the device. It wasn't intended to enforce any
rules as what can be or can't be a wakeup interrupt.

Soften the wording to not mandate that the 'wakeup-source' property be
used, and clarify what it means when an interrupt is marked (or not
marked) for wakeup.

Link: https://lore.kernel.org/all/ZYAjxxHcCOgDVMTQ@bogus/
Link: https://lore.kernel.org/all/CAL_Jsq+MYwOG40X26cYmO9EkZ9xqWrXDi03MaRfxnV-+VGkXWQ@mail.gmail.com/
Signed-off-by: Mark Hasemeyer <markhas@chromium.org>
Link: https://lore.kernel.org/r/20240102140734.v4.4.I1016a45ac9e8daf8a9ebc9854ab90ec3542e7c30@changeid
Signed-off-by: Rob Herring <robh@kernel.org>

authored by

Mark Hasemeyer and committed by
Rob Herring
5b202c25 4dde8356

+11 -7
+11 -7
Documentation/devicetree/bindings/power/wakeup-source.txt
··· 3 3 4 4 Any device nodes 5 5 ---------------- 6 - Nodes that describe devices which has wakeup capability must contain an 6 + Nodes that describe devices which have wakeup capability may contain a 7 7 "wakeup-source" boolean property. 8 8 9 - Also, if device is marked as a wakeup source, then all the primary 10 - interrupt(s) can be used as wakeup interrupt(s). 9 + If the device is marked as a wakeup-source, interrupt wake capability depends 10 + on the device specific "interrupt-names" property. If no interrupts are labeled 11 + as wake capable, then it is up to the device to determine which interrupts can 12 + wake the system. 11 13 12 - However if the devices have dedicated interrupt as the wakeup source 13 - then they need to specify/identify the same using device specific 14 - interrupt name. In such cases only that interrupt can be used as wakeup 15 - interrupt. 14 + However if a device has a dedicated interrupt as the wakeup source, then it 15 + needs to specify/identify it using a device specific interrupt name. In such 16 + cases only that interrupt can be used as a wakeup interrupt. 17 + 18 + While various legacy interrupt names exist, new devices should use "wakeup" as 19 + the canonical interrupt name. 16 20 17 21 List of legacy properties and respective binding document 18 22 ---------------------------------------------------------