Skip to contentSkip to conversation

PM: sleep: wakeirq: Update outdated documentation comments

PATCH Applied Wang Jiayue 2 participants 2 messages Feb 6 – Feb 11

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 PM: sleep: wakeirq: Update outdated documentation comments

The comments claiming that dev_pm_*wake_irq*() helpers must be called with dev->power.lock held and only from rpm_suspend/resume paths are no longer correct, since pm_runtime_force_suspend/resume() call them lockless. Update the comments to reflect it.

Fixes c46a0d5ae4f9 ("PM: runtime: Extend support for wakeirq for force_suspend|resume")

---
v2:
* Rephrase the comments to also cover the pm_runtime_force_suspend/resume() case, as suggested by Rafael J. Wysocki
v1:
* Initial fix just remove outdated comments

---
 drivers/base/power/wakeirq.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
drivers/base/power/wakeirq.c +7 -4
index 8aa28c08b289..f5db37c4818e 100644
@@ -270,8 +270,10 @@ EXPORT_SYMBOL_GPL(dev_pm_set_dedicated_wake_irq_reverse);
  * otherwise try to disable already disabled wakeirq. The wake-up interrupt
  * starts disabled with IRQ_NOAUTOEN set.
  *
- * Should be only called from rpm_suspend() and rpm_resume() path.
- * Caller must hold &dev->power.lock to change wirq->status
+ * Should be called from rpm_suspend(), rpm_resume(),
+ * pm_runtime_force_suspend() or pm_runtime_force_resume().
+ * Caller must hold &dev->power.lock or disable runtime PM to change
+ * wirq->status.
  */
 void dev_pm_enable_wake_irq_check(struct device *dev,
 				  bool can_change_status)
@@ -303,7 +305,8 @@ void dev_pm_enable_wake_irq_check(struct device *dev,
  * @cond_disable: if set, also check WAKE_IRQ_DEDICATED_REVERSE
  *
  * Disables wake-up interrupt conditionally based on status.
- * Should be only called from rpm_suspend() and rpm_resume() path.
+ * Should be called from rpm_suspend(), rpm_resume(),
+ * pm_runtime_force_suspend() or pm_runtime_force_resume().
  */
 void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)
 {
@@ -329,7 +332,7 @@ void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)
  * enable wake IRQ after running ->runtime_suspend() which depends on
  * WAKE_IRQ_DEDICATED_REVERSE.
  *
- * Should be only called from rpm_suspend() path.
+ * Should be called from rpm_suspend() or pm_runtime_force_suspend().
  */
 void dev_pm_enable_wake_irq_complete(struct device *dev)
 {
Signature · 1 line
2.34.1
maintainer Applied
#1 lore raw
Quoted 48 lines · Wang Jiayue

The comments claiming that dev_pm_*wake_irq*() helpers must be called with dev->power.lock held and only from rpm_suspend/resume paths are no longer correct, since pm_runtime_force_suspend/resume() call them lockless. Update the comments to reflect it.

Fixes c46a0d5ae4f9 ("PM: runtime: Extend support for wakeirq for force_suspend|resume")

---
v2:
* Rephrase the comments to also cover the pm_runtime_force_suspend/resume() case, as suggested by Rafael J. Wysocki
v1:
* Initial fix just remove outdated comments

---
 drivers/base/power/wakeirq.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
drivers/base/power/wakeirq.c +6 -3
index 8aa28c08b289..f5db37c4818e 100644
@@ -270,8 +270,10 @@ EXPORT_SYMBOL_GPL(dev_pm_set_dedicated_wake_irq_reverse);
  * otherwise try to disable already disabled wakeirq. The wake-up interrupt
  * starts disabled with IRQ_NOAUTOEN set.
  *
- * Should be only called from rpm_suspend() and rpm_resume() path.
- * Caller must hold &dev->power.lock to change wirq->status
+ * Should be called from rpm_suspend(), rpm_resume(),
+ * pm_runtime_force_suspend() or pm_runtime_force_resume().
+ * Caller must hold &dev->power.lock or disable runtime PM to change
+ * wirq->status.
  */
 void dev_pm_enable_wake_irq_check(struct device *dev,
                                  bool can_change_status)
@@ -303,7 +305,8 @@ void dev_pm_enable_wake_irq_check(struct device *dev,
  * @cond_disable: if set, also check WAKE_IRQ_DEDICATED_REVERSE
  *
  * Disables wake-up interrupt conditionally based on status.
- * Should be only called from rpm_suspend() and rpm_resume() path.
+ * Should be called from rpm_suspend(), rpm_resume(),
+ * pm_runtime_force_suspend() or pm_runtime_force_resume().
  */
 void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)
 {

drivers/base/power/wakeirq.c void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)

Quoted 9 lines
drivers/base/power/wakeirq.c +1 -2
@@ -329,7 +332,7 @@ void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)
  * enable wake IRQ after running ->runtime_suspend() which depends on
  * WAKE_IRQ_DEDICATED_REVERSE.
  *
- * Should be only called from rpm_suspend() path.
+ * Should be called from rpm_suspend() or pm_runtime_force_suspend().
  */
 void dev_pm_enable_wake_irq_complete(struct device *dev)
 {
--

Applied as 7.0-rc material, thanks!