diff mbox series

[v3,6/7] dt-bindings: firmware: arm,scmi: Add missing vendor string

Message ID 20241028120151.1301177-7-cristian.marussi@arm.com (mailing list archive)
State New
Headers show
Series Expose SCMI Transport properties | expand

Commit Message

Cristian Marussi Oct. 28, 2024, 12:01 p.m. UTC
Recently introduced max-rx-timeout-ms optionao property is missing a
vendor prefix.

Add the vendor prefix from the original committer.

Fixes: 3a5e6ab06eab ("dt-bindings: firmware: arm,scmi: Introduce property max-rx-timeout-ms")
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
---
Note that this fixes a commit that has been merged in v6.12-rc1...so it
should not present any backward compatibility issue.
---
Cc: Rob Herring <robh@kernel.org>
Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>
Cc: Conor Dooley <conor+dt@kernel.org>
Cc: devicetree@vger.kernel.org
Cc: Peng Fan <peng.fan@nxp.com>
---
 Documentation/devicetree/bindings/firmware/arm,scmi.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Sudeep Holla Oct. 28, 2024, 12:22 p.m. UTC | #1
On Mon, Oct 28, 2024 at 12:01:50PM +0000, Cristian Marussi wrote:
> Recently introduced max-rx-timeout-ms optionao property is missing a
> vendor prefix.
>
> Add the vendor prefix from the original committer.
>

It should be "arm," not "nxp," just because NXP happens to introduce that.
It just highlight that the property is X vendor specific and here it is
associated with SCMI and specifically Arm SCMI, so "arm,". If for some
reason nxp or any other vendor overrides this definition and need to add
additional property then they can add their own vendor name into that
property.

If there are no objections, I can fix it up when applying.

> Fixes: 3a5e6ab06eab ("dt-bindings: firmware: arm,scmi: Introduce property max-rx-timeout-ms")
> Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
> ---
> Note that this fixes a commit that has been merged in v6.12-rc1...so it
> should not present any backward compatibility issue.
> ---
> Cc: Rob Herring <robh@kernel.org>
> Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>
> Cc: Conor Dooley <conor+dt@kernel.org>
> Cc: devicetree@vger.kernel.org
> Cc: Peng Fan <peng.fan@nxp.com>
> ---
>  Documentation/devicetree/bindings/firmware/arm,scmi.yaml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
> index 9d6e1147f9e9..e331da4d606b 100644
> --- a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
> +++ b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
> @@ -124,7 +124,7 @@ properties:
>        atomic mode of operation, even if requested.
>      default: 0
>  
> -  max-rx-timeout-ms:
> +  nxp,max-rx-timeout-ms:
>      description:
>        An optional time value, expressed in milliseconds, representing the
>        transport maximum timeout value for the receive channel. The value should
> -- 
> 2.47.0
> 

--
Regards,
Sudeep
Cristian Marussi Oct. 28, 2024, 1:17 p.m. UTC | #2
On Mon, Oct 28, 2024 at 12:22:54PM +0000, Sudeep Holla wrote:
> On Mon, Oct 28, 2024 at 12:01:50PM +0000, Cristian Marussi wrote:
> > Recently introduced max-rx-timeout-ms optionao property is missing a
> > vendor prefix.
> >
> > Add the vendor prefix from the original committer.
> >
> 
> It should be "arm," not "nxp," just because NXP happens to introduce that.
> It just highlight that the property is X vendor specific and here it is
> associated with SCMI and specifically Arm SCMI, so "arm,". If for some
> reason nxp or any other vendor overrides this definition and need to add
> additional property then they can add their own vendor name into that
> property.
> 
> If there are no objections, I can fix it up when applying.

My bad. Sure go for it.

Thanks,
Cristian
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
index 9d6e1147f9e9..e331da4d606b 100644
--- a/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
+++ b/Documentation/devicetree/bindings/firmware/arm,scmi.yaml
@@ -124,7 +124,7 @@  properties:
       atomic mode of operation, even if requested.
     default: 0
 
-  max-rx-timeout-ms:
+  nxp,max-rx-timeout-ms:
     description:
       An optional time value, expressed in milliseconds, representing the
       transport maximum timeout value for the receive channel. The value should