Skip to content

Improve of_devlink to handle "proxy cycles"

Saravana Kannan linux-acpi linux-devicetree lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 15 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5driver core: Add device link support for SYNC_STATE_ONLY flagdrivers/base/core.c include/linux/device.h+43 -90 replies
2/5driver core: Allow a device to wait on optional suppliersdrivers/base/core.c include/linux/device.h+28 -34 replies
3/5driver core: Allow fwnode_operations.add_links to differentiate errorsdrivers/base/core.c include/linux/fwnode.h+17 -86 replies
4/5of: property: Make sure child dependencies don't block probing of parentdrivers/of/property.c+12 -52 replies
5/5of: property: Skip adding device links to suppliers that aren't devicesdrivers/of/property.c+3 -13 replies

Reviews trailers per patch

1 of 5 patches has a Reviewed-by or Acked-by.

PatchRob Herring
1/5
2/5
3/5
4/5R-b
5/5

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH v1 0/5] Improve of_devlink to handle "proxy cycles"

As described in [1], parent devices needed to create device links to suppliers of their child devices to make sure the suppliers of the child devices don't get a sync_state() before the child devices are added and probed.

In these illustrations, -> denotes DT references and indentation represents child status.

Example 1:
==========
Device node A

	Device node B -> C

Device node C

In this example, everything works as intended.
1. Device A is added
a. Device A is added to wait_for_suppliers list
2. Device C is added
a. Device link is created from A to C
b. Device A is removed from wait_for_suppliers list
3. Device C probes
4. During late_initcall_sync() Device C doesn't get sync_state() call because Device A hasn't probed yet
4. Device A's driver is loaded as a module
5. Device A probes
a. Device B is added
i. Device link is created from B to C
6. Device B probes
7. Device C get sync_state() call since A and B have probed

Example 2:
==========
Device node A

	Device node B -> C

Device node C

	Device node D -> A

In this example, none of the devices probe:
1. Device A is added
a. Device A is added to wait_for_suppliers list
2. Device C is added
a. Device link is created from A to C
b. Device A is removed from wait_for_suppliers list
c. Device link is attempted from C to A, but fails since it would
create a cycle.
d. Device C is added to wait_for_suppliers list
3. Device C doesn't probe because it's on wait_for_suppliers list
4. Device A's driver is loaded as a module
5. Device A doesn't probe because its supplier Device C hasn't probed

Cycles in device links aren't allowed because device links represent functional dependency and cause the devices to be reordered in the dpm_list to make sure the consumer suspends/goes idle before the supplier. If there's a cycle in the supplier/consumer dependencies, there's no logical way to sort them in the dpm_list.

This patch series addresses this problem.

Patch 1 adds a SYNC_STATE_ONLY device link flag that states that the device link should only affect the sync_state() call behavior and nothing else. Since a SYNC_STATE_ONLY device link doesn't affect dpm_list or probing, we can allow cycles within SYNC_STATE_ONLY device links. What this means is that, all the devices in the SYNC_STATE_ONLY device link cycle will get their sync_state() calls only after all of them have probed successfully.

Patch 2 improves wait_for_suppliers semantics by allowing a device on the list to state (device.links.need_for_probe) if the suppliers it's waiting on (to make a device link to) are needed for it to probe or not. If the device is not waiting on suppliers that are needed for probing, the device is no longer blocked from attempting to probe even if it's on the wait_for_suppliers list.

Patch 3 allows fwnode_operations.add_links() return error codes to differentiate between being unable to find mandatory suppliers (-ENODEV) vs optional suppliers (-EAGAIN). If add_links() is only unable to find optional suppliers, then the corresponding device is marked as waiting on suppliers that are not needed for probing.

Patch 4 changes device tree fwnode add_links() implementation so that all device links created from a device to the suppliers of its child devices use the SYNC_STATE_ONLY flag. It is also changed to return -ENODEV only for errors with the suppliers of the device and return -EAGAIN when the errors are limited to the suppliers of its child devices.

Patch 5 is an unrelated improvement that touches the same bit of code, so I'm grouping it with this series to avoid rebases. That commit should be self descriptive.

With these changes, Example 2 works as follows:
1. Device A is added
a. Device A is added to wait_for_suppliers list
b. Device A is marked as waiting for optional suppliers
2. Device C is added
a. SYNC_STATE_ONLY device link is created from A to C
b. Device A is removed from wait_for_suppliers list
c. SYNC_STATE_ONLY device link is created from C to A
3. Device C probes
a. Device D is added.
i. Device link is created from D to A
4. During late_initcall_sync() Device C doesn't get sync_state() call because Device A hasn't probed yet
5. Device A's driver is loaded as a module
6. Device A probes
a. Device B is added
i. Device link is created from B to C
7. Device A doesn't get sync_stat() call because Device D hasn't probed
8. Device D probes
9. Device A get sync_state() call since C and D have probed 10.Device B probes
11.Device C get sync_state() call since A and B have probed

Thanks,
Saravana

[1] - commit d4387cd117414ba80230f27a514be5ca4a09cfcc
("of: property: Create device links for all child-supplier depencencies") or https://lore.kernel.org/linux-acpi/[email protected]/

Saravana Kannan (5):
driver core: Add device link support for SYNC_STATE_ONLY flag driver core: Allow a device to wait on optional suppliers driver core: Allow fwnode_operations.add_links to differentiate errors
of: property: Make sure child dependencies don't block probing of
parent
of: property: Skip adding device links to suppliers that aren't
devices

 drivers/base/core.c    | 88 +++++++++++++++++++++++++++++++++++-------
 drivers/of/property.c  | 21 +++++++---
 include/linux/device.h |  5 +++
 include/linux/fwnode.h | 13 +++++--
 4 files changed, 102 insertions(+), 25 deletions(-)
Signature · 1 line
2.24.0.rc0.303.g954a862665-goog