platform: set of_node in platform_device_register_full()
PATCH v3 1/1 platform: set of_node in platform_device_register_full()
If the provided fwnode is an OF node, set dev.of_node as well.
Also add an of_node_reused flag to struct platform_device_info and copy this to the new device. This is needed to avoid pinctrl settings being requested twice. See 4e75e1d7dac9 ("driver core: add helper to reuse a device-tree node") for a longer explanation.
Some drivers are just shims that create extra "glue" devices with the DT device as parent and have the real driver bind to these. In these cases, the glue device needs to get a reference to the original DT node in order for the main driver to access properties and child nodes.
For example, the sunxi-musb driver creates such a glue device using platform_device_register_full(). Consequently, devices attached to this USB interface don't get associated with DT nodes, if present, the way they do with EHCI.
This change will allow sunxi-musb and similar drivers to easily propagate the DT node to child devices as required.
---
Changes in v3:
- handle of_node_reused
--- drivers/base/platform.c | 2 ++ include/linux/platform_device.h | 1 + 2 files changed, 3 insertions(+)
drivers/base/platform.c +2 -0
@@ -512,6 +512,8 @@ struct platform_device *platform_device_register_full( pdev->dev.parent = pdevinfo->parent; pdev->dev.fwnode = pdevinfo->fwnode; + pdev->dev.of_node =of_node_get (to_of_node (pdev->dev.fwnode)); + pdev->dev.of_node_reused = pdevinfo->of_node_reused;if (pdevinfo->dma_mask) {/*
include/linux/platform_device.h +1 -0
@@ -62,6 +62,7 @@ extern int platform_add_devices(struct platform_device **, int);struct platform_device_info {struct device *parent;struct fwnode_handle *fwnode; +bool of_node_reused;const char *name;int id;
Signature · 1 line
2.20.1
Quoted 18 lines · Mans Rullgard
If the provided fwnode is an OF node, set dev.of_node as well.
Also add an
of_node_reusedflag to structplatform_device_infoand copy this to the new device. This is needed to avoid pinctrl settings being requested twice. See4e75e1d7dac9("driver core: add helper to reuse a device-tree node") for a longer explanation.Some drivers are just shims that create extra "glue" devices with the DT device as parent and have the real driver bind to these. In these cases, the glue device needs to get a reference to the original DT node in order for the main driver to access properties and child nodes.
For example, the sunxi-musb driver creates such a glue device using
platform_device_register_full(). Consequently, devices attached to this USB interface don't get associated with DT nodes, if present, the way they do with EHCI.
Quoted 4 lines
This change will allow sunxi-musb and similar drivers to easily propagate the DT node to child devices as required.
Signed-off-by Mans Rullgard <[email protected]>
Generally
but I'm a bit concerned about the existing users of platform_device_register_full() who may pass a valid DT fwnode to it and not expect of_node to be set. Arguably, they should expect it to be set, but then there may be some fallout resulting from this change.
Quoted 36 lines
---
Changes in v3:
- handleof_node_reused--- drivers/base/platform.c | 2 ++ include/linux/platform_device.h | 1 + 2 files changed, 3 insertions(+)drivers/base/platform.c +2
-0@@ -512,6 +512,8 @@ struct platform_device *platform_device_register_full( pdev->dev.parent = pdevinfo->parent; pdev->dev.fwnode = pdevinfo->fwnode; + pdev->dev.of_node =of_node_get (to_of_node (pdev->dev.fwnode)); + pdev->dev.of_node_reused = pdevinfo->of_node_reused;if (pdevinfo->dma_mask) {/* include/linux/platform_device.h +1
-1@@ -62,6 +62,7 @@ extern int platform_add_devices(struct platform_device **, int);struct platform_device_info {struct device *parent;struct fwnode_handle *fwnode; +bool of_node_reused;const char *name;int id; --2.20.1
Quoted 24 lines · Rafael J. Wysocki
Quoted 18 lines · Mans Rullgard
If the provided fwnode is an OF node, set dev.of_node as well.
Also add an
of_node_reusedflag to structplatform_device_infoand copy this to the new device. This is needed to avoid pinctrl settings being requested twice. See4e75e1d7dac9("driver core: add helper to reuse a device-tree node") for a longer explanation.Some drivers are just shims that create extra "glue" devices with the DT device as parent and have the real driver bind to these. In these cases, the glue device needs to get a reference to the original DT node in order for the main driver to access properties and child nodes.
For example, the sunxi-musb driver creates such a glue device using
platform_device_register_full(). Consequently, devices attached to this USB interface don't get associated with DT nodes, if present, the way they do with EHCI.Quoted 4 lines
This change will allow sunxi-musb and similar drivers to easily propagate the DT node to child devices as required.
Signed-off-by Mans Rullgard <[email protected]>
Quoted 8 lines
Generally
Reviewed-by Rafael J. Wysocki <[email protected]>but I'm a bit concerned about the existing users of
platform_device_register_full()who may pass a valid DT fwnode to it and not expectof_nodeto be set. Arguably, they should expect it to be set, but then there may be some fallout resulting from this change.
I did a quick search, and found three drivers using platform_device_register_full() that pass an fwnode that isn't explicitly an ACPI handle.
The Cadence MACB and pxa2xx-spi drivers both set fwnode in their PCI glue. Near as I can tell, setting of_node as a result should be harmless. If someone has a devicetree describing the PCI topology, these drivers would start picking properties set there just as they do when using a platform bus. One could argue that this is the correct behaviour.
The third case is Qcom HIDMA management driver. It contains this code fragment:
for_each_available_child_of_node(np, child) {
struct platform_device *new_pdev;
/* irrelevant code */
memset(&pdevinfo, 0, sizeof(pdevinfo));
pdevinfo.fwnode = &child->fwnode;
pdevinfo.parent = pdev_parent ? &pdev_parent->dev : NULL;
pdevinfo.name = child->name;
pdevinfo.id = object_counter++;
pdevinfo.res = res;
pdevinfo.num_res = 3;
pdevinfo.data = NULL;
pdevinfo.size_data = 0;
pdevinfo.dma_mask = DMA_BIT_MASK(64);
new_pdev = platform_device_register_full(&pdevinfo);
if (IS_ERR(new_pdev)) {
ret = PTR_ERR(new_pdev);
goto out;
}
of_node_get(child);
new_pdev->dev.of_node = child;
of_dma_configure(&new_pdev->dev, child, true);
/*
* It is assumed that calling of_msi_configure is safe on
* platforms with or without MSI support.
*/
of_msi_configure(&new_pdev->dev, child);
of_node_put(child);
}This already looks rather weird. It manually sets of_node of the new device _after_ it has been added. The reason this works at all is that the matching driver hasn't been registered yet. This, to me, is slightly confusing, if not actually broken. Worse is that the of_node is copied without an of_node_get() to match the of_node_put() in platform_device_put(), should it ever be called. Moreover, these devices are not removed if the module is unloaded or if there is an error partway through the loop.
That said, it doesn't seem like setting of_node in platform_device_register_full() should cause any (new) problems here.
Signature · 1 line
Måns Rullgård