[PATCH] ASoC: dt-bindings: use "soundwire" as controller's node name in examples

[PATCH] ASoC: dt-bindings: use "soundwire" as controller's node name in examples

[Krzysztof Kozlowski]

Soundwire Devicetree bindings expect the Soundwire controller device
node to be named just "soundwire".  Correct examples, so the incorrect
code will not be re-used.

Reported-by: Neil Armstrong <neil.armstrong@linaro.org>
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 Documentation/devicetree/bindings/sound/adi,max98363.yaml | 2 +-
 Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml | 2 +-
 Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/adi,max98363.yaml b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
index a844b63f3930..c388cda56011 100644
--- a/Documentation/devicetree/bindings/sound/adi,max98363.yaml
+++ b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
@@ -39,7 +39,7 @@ unevaluatedProperties: false
 
 examples:
   - |
-    soundwire-controller@3250000 {
+    soundwire@3250000 {
         #address-cells = <2>;
         #size-cells = <0>;
         reg = <0x3250000 0x2000>;
diff --git a/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml b/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
index ba572a7f4f3c..8e462cdf0018 100644
--- a/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
+++ b/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
@@ -52,7 +52,7 @@ examples:
   - |
     #include <dt-bindings/gpio/gpio.h>
 
-    soundwire-controller@3250000 {
+    soundwire@3250000 {
         #address-cells = <2>;
         #size-cells = <0>;
         reg = <0x3250000 0x2000>;
diff --git a/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml b/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
index e6723c9e312a..d717017b0fdb 100644
--- a/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
+++ b/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
@@ -48,7 +48,7 @@ examples:
   - |
     #include <dt-bindings/gpio/gpio.h>
 
-    soundwire-controller {
+    soundwire {
         #address-cells = <2>;
         #size-cells = <0>;
 
-- 
2.34.1

Re: [PATCH] ASoC: dt-bindings: use "soundwire" as controller's node name in examples

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2497 bytes --]

On Tue, Nov 07, 2023 at 11:16:10AM +0100, Krzysztof Kozlowski wrote:
> Soundwire Devicetree bindings expect the Soundwire controller device
> node to be named just "soundwire".  Correct examples, so the incorrect
> code will not be re-used.
> 
> Reported-by: Neil Armstrong <neil.armstrong@linaro.org>
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Acked-by: Conor Dooley <conor.dooley@microchip.com>

FWIW, there are a few instances of "soundwire-controller" in qcom
devicetrees that you might also want to change.

> ---
>  Documentation/devicetree/bindings/sound/adi,max98363.yaml | 2 +-
>  Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml | 2 +-
>  Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/sound/adi,max98363.yaml b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> index a844b63f3930..c388cda56011 100644
> --- a/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> +++ b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> @@ -39,7 +39,7 @@ unevaluatedProperties: false
>  
>  examples:
>    - |
> -    soundwire-controller@3250000 {
> +    soundwire@3250000 {
>          #address-cells = <2>;
>          #size-cells = <0>;
>          reg = <0x3250000 0x2000>;
> diff --git a/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml b/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
> index ba572a7f4f3c..8e462cdf0018 100644
> --- a/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
> +++ b/Documentation/devicetree/bindings/sound/qcom,wsa883x.yaml
> @@ -52,7 +52,7 @@ examples:
>    - |
>      #include <dt-bindings/gpio/gpio.h>
>  
> -    soundwire-controller@3250000 {
> +    soundwire@3250000 {
>          #address-cells = <2>;
>          #size-cells = <0>;
>          reg = <0x3250000 0x2000>;
> diff --git a/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml b/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
> index e6723c9e312a..d717017b0fdb 100644
> --- a/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
> +++ b/Documentation/devicetree/bindings/sound/qcom,wsa8840.yaml
> @@ -48,7 +48,7 @@ examples:
>    - |
>      #include <dt-bindings/gpio/gpio.h>
>  
> -    soundwire-controller {
> +    soundwire {
>          #address-cells = <2>;
>          #size-cells = <0>;
>  
> -- 
> 2.34.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] ASoC: dt-bindings: use "soundwire" as controller's node name in examples

[Krzysztof Kozlowski]

On 08/11/2023 13:17, Conor Dooley wrote:
> On Tue, Nov 07, 2023 at 11:16:10AM +0100, Krzysztof Kozlowski wrote:
>> Soundwire Devicetree bindings expect the Soundwire controller device
>> node to be named just "soundwire".  Correct examples, so the incorrect
>> code will not be re-used.
>>
>> Reported-by: Neil Armstrong <neil.armstrong@linaro.org>
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> 
> Acked-by: Conor Dooley <conor.dooley@microchip.com>
> 
> FWIW, there are a few instances of "soundwire-controller" in qcom
> devicetrees that you might also want to change.

Yes, already sent.
https://lore.kernel.org/all/?q=s%3Aqcom+s%3Asoundwire+s%3Anode

Best regards,
Krzysztof

Re: [PATCH] ASoC: dt-bindings: use "soundwire" as controller's node name in examples

[Mark Brown]

On Tue, 07 Nov 2023 11:16:10 +0100, Krzysztof Kozlowski wrote:
> Soundwire Devicetree bindings expect the Soundwire controller device
> node to be named just "soundwire".  Correct examples, so the incorrect
> code will not be re-used.
> 
> 

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoC: dt-bindings: use "soundwire" as controller's node name in examples
      commit: dc29d3d253f1f3513a916f0b4271569223860c71

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark