Skip to contentSkip to conversation

PM: runtime: Clarify documentation when callbacks are unassigned

PATCH Applied Ulf Hansson 3 participants 3 messages Jun 9, 2021 – Jun 11, 2021 Suspend to RAM

lore
Share & tools
lore
#0 lore raw

PATCH v4 3/3 PM: runtime: Clarify documentation when callbacks are unassigned

Recent changes to the PM core allows ->runtime_suspend|resume callbacks to be unassigned.

In the earlier behaviour the PM core would return -ENOSYS, when trying to runtime resume a device, for example. Let's update the documentation to clarify this.

---

Changes in v4:
- This time, really, fix spelling and further clarified the behaviour, according to comments from Alan.

---
 Documentation/power/runtime_pm.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/power/runtime_pm.rst +9 -0
index 18ae21bf7f92..8a0a43811e3a 100644
@@ -827,6 +827,15 @@ or driver about runtime power changes.  Instead, the driver for the device's
 parent must take responsibility for telling the device's driver when the
 parent's power state changes.
 
+Note that, in some cases it may not be desirable for subsystems/drivers to call
+pm_runtime_no_callbacks() for their devices. This could be because a subset of
+the runtime PM callbacks needs to be implemented, a platform dependent PM
+domain could get attached to the device or that the device is power managed
+through a supplier device link. For these reasons and to avoid boilerplate code
+in subsystems/drivers, the PM core allows runtime PM callbacks to be
+unassigned. More precisely, if a callback pointer is NULL, the PM core will act
+as though there was a callback and it returned 0.
+
 9. Autosuspend, or automatically-delayed suspends
 =================================================
 
Signature · 1 line
2.25.1
Acked-by on v4 3/3
#1 lore raw
Quoted 27 lines · Ulf Hansson

Recent changes to the PM core allows ->runtime_suspend|resume callbacks to be unassigned.

In the earlier behaviour the PM core would return -ENOSYS, when trying to runtime resume a device, for example. Let's update the documentation to clarify this.

---

Changes in v4:
- This time, really, fix spelling and further clarified the behaviour, according to comments from Alan.

---
 Documentation/power/runtime_pm.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/power/runtime_pm.rst +1 -0
index 18ae21bf7f92..8a0a43811e3a 100644
@@ -827,6 +827,15 @@ or driver about runtime power changes.  Instead, the driver for the device's
 parent must take responsibility for telling the device's driver when the
 parent's power state changes.
 
+Note that, in some cases it may not be desirable for subsystems/drivers to call

Documentation/power/runtime_pm.rst or driver about runtime power changes. Instead, the driver for the device's · line 840

Quoted 10 lines
Documentation/power/runtime_pm.rst +8 -0
+pm_runtime_no_callbacks() for their devices. This could be because a subset of
+the runtime PM callbacks needs to be implemented, a platform dependent PM
+domain could get attached to the device or that the device is power managed
+through a supplier device link. For these reasons and to avoid boilerplate code
+in subsystems/drivers, the PM core allows runtime PM callbacks to be
+unassigned. More precisely, if a callback pointer is NULL, the PM core will act
+as though there was a callback and it returned 0.
+
 9. Autosuspend, or automatically-delayed suspends
 =================================================

I don't know what happened before. Maybe the terminal window got resized without me noticing, so the lines looked too long when they actually weren't.

Alan Stern

maintainer Applied
#2 lore raw
Quoted 28 lines · Alan Stern
Quoted 26 lines · Ulf Hansson

Recent changes to the PM core allows ->runtime_suspend|resume callbacks to be unassigned.

In the earlier behaviour the PM core would return -ENOSYS, when trying to runtime resume a device, for example. Let's update the documentation to clarify this.

---

Changes in v4:
- This time, really, fix spelling and further clarified the behaviour,
according to comments from Alan.

---
 Documentation/power/runtime_pm.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/power/runtime_pm.rst +0 -0
index 18ae21bf7f92..8a0a43811e3a 100644
@@ -827,6 +827,15 @@ or driver about runtime power changes.  Instead, the driver for the device's
 parent must take responsibility for telling the device's driver when the
 parent's power state changes.
 
Quoted 13 lines

Documentation/power/runtime_pm.rst or driver about runtime power changes. Instead, the driver for the device's · line 840

Quoted 11 lines
Documentation/power/runtime_pm.rst +9 -0
+Note that, in some cases it may not be desirable for subsystems/drivers to call
+pm_runtime_no_callbacks() for their devices. This could be because a subset of
+the runtime PM callbacks needs to be implemented, a platform dependent PM
+domain could get attached to the device or that the device is power managed
+through a supplier device link. For these reasons and to avoid boilerplate code
+in subsystems/drivers, the PM core allows runtime PM callbacks to be
+unassigned. More precisely, if a callback pointer is NULL, the PM core will act
+as though there was a callback and it returned 0.
+
 9. Autosuspend, or automatically-delayed suspends
 =================================================

Applied as 5.14 material along with the [1-2/3] from this series.

Thanks!