[PATCH] Documentation: dt-bindings: ocotp: deprecate barebox,provide-mac-address

[Marco Felsch]

On 23-09-11, Ahmad Fatoum wrote:
> On 11.09.23 14:29, Marco Felsch wrote:
> > On 23-09-11, Ahmad Fatoum wrote:
> >> While we'll continue to support barebox,provide-mac-address, new boards
> >> should prefer using the upstream NVMEM binding for describing the MAC address.
> >>
> >> Add an example to the documentation.
> >>
> >> Signed-off-by: Ahmad Fatoum <a.fatoum at pengutronix.de>
> >> ---
> >>  .../bindings/misc/fsl,imx-ocotp.rst           | 25 ++++++++++++++++---
> >>  1 file changed, 22 insertions(+), 3 deletions(-)
> >>
> >> diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
> >> index 202bb3aa07ef..1c45267b1b58 100644
> >> --- a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
> >> +++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
> >> @@ -6,13 +6,14 @@ Required properties:
> >>  * ``compatible``: ``fsl,imx6q-ocotp``
> >>  * ``reg``: physical register base and size
> >>  
> >> -Optional properties:
> >> +Deprecated properties:
> >>  
> >>  * ``barebox,provide-mac-address``: Provide MAC addresses for Ethernet devices. This
> >>    can be multiple entries in the form <&phandle regofs> to assign a MAC
> >> -  address to an Ethernet device.
> >> +  address to an Ethernet device. This has been deprecated in favor or the upstream
> >> +  nvmem cell binding.
> >>  
> >> -Example:
> >> +Legacy example:
> > 
> > Do we still need to list it as example? Seems a bit odd for deprecated
> > bindings.
> 
> It's useful to illustrate the difference to the NVMEM binding. Also deprecation
> might be a bit harsh. We will likely never remove support, but we'll try
> to curtail proliferation.

IMHO listing deprecated examples isn't a good way to curtail
proliferation. Anyway the change is correct and therefore feel free to
add my:

Reviewed-by: Marco Felsch <m.felsch at pengutronix.de>

> Cheers,
> Ahmad
> 
> > 
> > Regards,
> >   Marco
> > 
> >>  .. code-block:: none
> >>  
> >> @@ -21,3 +22,21 @@ Example:
> >>    	reg = <0x021bc000 0x4000>;
> >>    	barebox,provide-mac-address = <&fec 0x620>;
> >>    };
> >> +
> >> +Upstream alternative:
> >> +
> >> +.. code-block:: none
> >> +
> >> +  &ocotp1 {
> >> +  	#address-cells = <1>;
> >> +  	#size-cells = <1>;
> >> +
> >> +  	fec_mac_addr: mac-addr at 88 {
> >> +  		reg = <0x88 6>;
> >> +  	};
> >> +  };
> >> +
> >> +  &fec {
> >> +  	nvmem-cells = <&fec_mac_addr>;
> >> +  	nvmem-cell-names = "mac-address";
> >> +  };
> >> -- 
> >> 2.39.2
> >>
> >>
> >>
> > 
> 
> -- 
> Pengutronix e.K.                           |                             |
> Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
> 31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
> Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |
> 
>