Re: [PATCH v2 5/7] of: overlay: Add export_symbols_name in of_overlay_fdt_apply() parameters

[Herve Codina]

Hi Ayush,

On Fri, 2 May 2025 20:10:41 +0530
Ayush Singh <ayush@xxxxxxxxxxxxxxx> wrote:

> On 4/30/25 18:21, Herve Codina wrote:
> 
> > In order to prepare the introduction of the export symbols node
> > handling, add a export_symbols_name parameter in of_overlay_fdt_apply().
> >
> > The export_symbols_name is the name of the export symbols subnode
> > available in the base node that will be used by the resolver to handle
> > export symbols resolution.
> >
> > Having the name of the subnode in parameters instead of the subnode
> > itself avoids the use of an export symbol node that is not directly
> > related to the base node.
> >
> > Signed-off-by: Herve Codina <herve.codina@xxxxxxxxxxx>
> > Tested-by: Ayush Singh <ayush@xxxxxxxxxxxxxxx>
> > ---
> >   drivers/misc/lan966x_pci.c    | 3 ++-
> >   drivers/of/of_kunit_helpers.c | 2 +-
> >   drivers/of/overlay.c          | 7 ++++++-
> >   drivers/of/unittest.c         | 4 ++--
> >   include/linux/of.h            | 6 ++++--
> >   5 files changed, 15 insertions(+), 7 deletions(-)
> >
> > diff --git a/drivers/misc/lan966x_pci.c b/drivers/misc/lan966x_pci.c
> > index 9c79b58137e5..f05cb040ec69 100644
> > --- a/drivers/misc/lan966x_pci.c
> > +++ b/drivers/misc/lan966x_pci.c
> > @@ -128,7 +128,8 @@ static int lan966x_pci_load_overlay(struct lan966x_pci *data)
> >   	u32 dtbo_size = __dtbo_lan966x_pci_end - __dtbo_lan966x_pci_begin;
> >   	void *dtbo_start = __dtbo_lan966x_pci_begin;
> >   
> > -	return of_overlay_fdt_apply(dtbo_start, dtbo_size, &data->ovcs_id, dev_of_node(data->dev));
> > +	return of_overlay_fdt_apply(dtbo_start, dtbo_size, &data->ovcs_id,
> > +				    dev_of_node(data->dev), NULL);
> >   }
> >   
> >   static void lan966x_pci_unload_overlay(struct lan966x_pci *data)
> > diff --git a/drivers/of/of_kunit_helpers.c b/drivers/of/of_kunit_helpers.c
> > index 7b3ed5a382aa..476b43474168 100644
> > --- a/drivers/of/of_kunit_helpers.c
> > +++ b/drivers/of/of_kunit_helpers.c
> > @@ -56,7 +56,7 @@ int of_overlay_fdt_apply_kunit(struct kunit *test, void *overlay_fdt,
> >   		return -ENOMEM;
> >   
> >   	ret = of_overlay_fdt_apply(overlay_fdt, overlay_fdt_size,
> > -				   ovcs_id, NULL);
> > +				   ovcs_id, NULL, NULL);
> >   	if (ret)
> >   		return ret;
> >   
> > diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
> > index aa1b97e634aa..73ff38c41de2 100644
> > --- a/drivers/of/overlay.c
> > +++ b/drivers/of/overlay.c
> > @@ -968,6 +968,10 @@ static int of_overlay_apply(struct overlay_changeset *ovcs,
> >    * @overlay_fdt_size:	number of bytes in @overlay_fdt
> >    * @ret_ovcs_id:	pointer for returning created changeset id
> >    * @base:		pointer for the target node to apply overlay
> > + * @export_symbols_name:
> > + *			Name of the export symbol subnode of the @base node to
> > + *			provide extra symbols. Those extra symbols are used in
> > + *			the overlay symbols resolution.
> >    *
> >    * Creates and applies an overlay changeset.
> >    *
> > @@ -983,7 +987,8 @@ static int of_overlay_apply(struct overlay_changeset *ovcs,
> >    */
> >   
> >   int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
> > -			 int *ret_ovcs_id, const struct device_node *base)
> > +			 int *ret_ovcs_id, const struct device_node *base,
> > +			 const char *export_symbols_name)  
> 
> Do we really need the export-symbols node name to be configurable?

Well, it depends on the export-symbols acceptance in device-tree spec or some
other global device-tree bindings.

If this export-symbols node is accepted globally, the name is not needed and
shouldn't be configurable.

If this node name can be changed from one node binding to an other, having it
configurable is interesting.

That said, according to your work done at higher level (device-tree spec), this
name tends to be global. If confirmed, I will remove the export_symbols_name
parameter in the next iteration and use 'export-symbols' for all cases.

Best regards,
Hervé