[PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Faiz Abbas]

The simple card driver has support for adding cpu, codec and platform
nodes with the simple-audio-card prefix. Add documentation for the plat
binding.

Signed-off-by: Faiz Abbas <faiz.abbas@arm.com>
---
 .../bindings/sound/simple-card.yaml           | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/Documentation/devicetree/bindings/sound/simple-card.yaml b/Documentation/devicetree/bindings/sound/simple-card.yaml
index ed19899bc94b..fa67c76d4dbb 100644
--- a/Documentation/devicetree/bindings/sound/simple-card.yaml
+++ b/Documentation/devicetree/bindings/sound/simple-card.yaml
@@ -205,6 +205,8 @@ patternProperties:
     $ref: "#/definitions/dai"
   "^simple-audio-card,codec(@[0-9a-f]+)?$":
     $ref: "#/definitions/dai"
+  "^simple-audio-card,plat(@[0-9a-f]+)?$":
+    $ref: "#/definitions/dai"
 
   "^simple-audio-card,dai-link(@[0-9a-f]+)?$":
     description: |
@@ -285,6 +287,27 @@ examples:
         };
     };
 
+#-------------------------------
+# single DAI link with platform
+#-------------------------------
+ - |
+   sound {
+        compatible = "simple-audio-card";
+        simple-audio-card,format = "i2s";
+        simple-audio-card,mclk-fs = <384>;
+        simple-audio-card,cpu {
+                sound-dai = <&iofpga_i2s>;
+        };
+
+        simple-audio-card,codec {
+                sound-dai = <&hdmi_tx>;
+        };
+
+        simple-audio-card,plat {
+                sound-dai = <&audio_formatter>;
+        };
+};
+
 #--------------------
 # Multi DAI links
 #--------------------
-- 
2.25.1

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Rob Herring]

On Thu, 05 Jan 2023 21:33:46 +0530, Faiz Abbas wrote:
> The simple card driver has support for adding cpu, codec and platform
> nodes with the simple-audio-card prefix. Add documentation for the plat
> binding.
> 
> Signed-off-by: Faiz Abbas <faiz.abbas@arm.com>
> ---
>  .../bindings/sound/simple-card.yaml           | 23 +++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/sound/simple-card.yaml:293:2: [error] syntax error: expected <block end>, but found '<block sequence start>' (syntax)

dtschema/dtc warnings/errors:
make[1]: *** Deleting file 'Documentation/devicetree/bindings/sound/simple-card.example.dts'
Documentation/devicetree/bindings/sound/simple-card.yaml:293:2: expected <block end>, but found '<block sequence start>'
make[1]: *** [Documentation/devicetree/bindings/Makefile:26: Documentation/devicetree/bindings/sound/simple-card.example.dts] Error 1
make[1]: *** Waiting for unfinished jobs....
Traceback (most recent call last):
  File "/usr/bin/yamllint", line 33, in <module>
    sys.exit(load_entry_point('yamllint==1.26.3', 'console_scripts', 'yamllint')())
  File "/usr/lib/python3/dist-packages/yamllint/cli.py", line 210, in run
    prob_level = show_problems(problems, file, args_format=args.format,
  File "/usr/lib/python3/dist-packages/yamllint/cli.py", line 106, in show_problems
    for problem in problems:
  File "/usr/lib/python3/dist-packages/yamllint/linter.py", line 203, in _run
    for problem in get_cosmetic_problems(buffer, conf, filepath):
  File "/usr/lib/python3/dist-packages/yamllint/linter.py", line 140, in get_cosmetic_problems
    for problem in rule.check(rule_conf,
  File "/usr/lib/python3/dist-packages/yamllint/rules/indentation.py", line 580, in check
    for problem in _check(conf, token, prev, next, nextnext, context):
  File "/usr/lib/python3/dist-packages/yamllint/rules/indentation.py", line 346, in _check
    'wrong indentation: expected %d but found %d' %
TypeError: %d format: a real number is required, not NoneType
./Documentation/devicetree/bindings/sound/simple-card.yaml:293:2: expected <block end>, but found '<block sequence start>'
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/simple-card.yaml: ignoring, error parsing file
make: *** [Makefile:1508: dt_binding_check] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230105160346.29018-1-faiz.abbas@arm.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Rob Herring]

On Thu, Jan 05, 2023 at 09:33:46PM +0530, Faiz Abbas wrote:
> The simple card driver has support for adding cpu, codec and platform
> nodes with the simple-audio-card prefix. Add documentation for the plat
> binding.

Another node, is it still 'simple card'?

> 
> Signed-off-by: Faiz Abbas <faiz.abbas@arm.com>
> ---
>  .../bindings/sound/simple-card.yaml           | 23 +++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/sound/simple-card.yaml b/Documentation/devicetree/bindings/sound/simple-card.yaml
> index ed19899bc94b..fa67c76d4dbb 100644
> --- a/Documentation/devicetree/bindings/sound/simple-card.yaml
> +++ b/Documentation/devicetree/bindings/sound/simple-card.yaml
> @@ -205,6 +205,8 @@ patternProperties:
>      $ref: "#/definitions/dai"
>    "^simple-audio-card,codec(@[0-9a-f]+)?$":
>      $ref: "#/definitions/dai"
> +  "^simple-audio-card,plat(@[0-9a-f]+)?$":

What does 'plat' mean?

Don't continue the 'simple-audio-card,' prefix.

> +    $ref: "#/definitions/dai"
>  
>    "^simple-audio-card,dai-link(@[0-9a-f]+)?$":
>      description: |
> @@ -285,6 +287,27 @@ examples:
>          };
>      };
>  
> +#-------------------------------
> +# single DAI link with platform
> +#-------------------------------

Really need another example for 1 simple node?

> + - |
> +   sound {
> +        compatible = "simple-audio-card";
> +        simple-audio-card,format = "i2s";
> +        simple-audio-card,mclk-fs = <384>;
> +        simple-audio-card,cpu {
> +                sound-dai = <&iofpga_i2s>;
> +        };
> +
> +        simple-audio-card,codec {
> +                sound-dai = <&hdmi_tx>;
> +        };
> +
> +        simple-audio-card,plat {
> +                sound-dai = <&audio_formatter>;
> +        };
> +};
> +
>  #--------------------
>  # Multi DAI links
>  #--------------------
> -- 
> 2.25.1
> 
> 

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Mohammad Faiz Abbas Rizvi]

Hi Rob,

On 1/8/2023 10:07 PM, Rob Herring wrote:
> On Thu, Jan 05, 2023 at 09:33:46PM +0530, Faiz Abbas wrote:
>> The simple card driver has support for adding cpu, codec and platform
>> nodes with the simple-audio-card prefix. Add documentation for the plat
>> binding.
> Another node, is it still 'simple card'?

This behavior already exists in the driver. I am just documenting what already exists.

>> Signed-off-by: Faiz Abbas <faiz.abbas@arm.com>
>> ---
>>  .../bindings/sound/simple-card.yaml           | 23 +++++++++++++++++++
>>  1 file changed, 23 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/sound/simple-card.yaml b/Documentation/devicetree/bindings/sound/simple-card.yaml
>> index ed19899bc94b..fa67c76d4dbb 100644
>> --- a/Documentation/devicetree/bindings/sound/simple-card.yaml
>> +++ b/Documentation/devicetree/bindings/sound/simple-card.yaml
>> @@ -205,6 +205,8 @@ patternProperties:
>>      $ref: "#/definitions/dai"
>>    "^simple-audio-card,codec(@[0-9a-f]+)?$":
>>      $ref: "#/definitions/dai"
>> +  "^simple-audio-card,plat(@[0-9a-f]+)?$":
> What does 'plat' mean?

plat means platform. I'll make that clear in the patch description in v2.


> Don't continue the 'simple-audio-card,' prefix.

The implementation already exists. Its just not documented here.


>> +    $ref: "#/definitions/dai"
>>
>>    "^simple-audio-card,dai-link(@[0-9a-f]+)?$":
>>      description: |
>> @@ -285,6 +287,27 @@ examples:
>>          };
>>      };
>>
>> +#-------------------------------
>> +# single DAI link with platform
>> +#-------------------------------
> Really need another example for 1 simple node?

I'll remove the example if that makes it easier.

Thanks,

Faiz

IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Krzysztof Kozlowski]

On 10/01/2023 09:23, Mohammad Faiz Abbas Rizvi wrote:
> Hi Rob,

(...)

> 
> Thanks,
> 
> Faiz
> 
> IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

Please fix your mail setup. We cannot work in upstream/LKML with
confidential emails. Since I was not a intended recipient (I don't know
who is), then I should start removing your emails?

Best regards,
Krzysztof

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Mohammad Faiz Abbas Rizvi]

Hi Krysztof,

On 1/10/2023 2:15 PM, Krzysztof Kozlowski wrote:
> On 10/01/2023 09:23, Mohammad Faiz Abbas Rizvi wrote:
>> Hi Rob,
> (...)
>
>> Thanks,
>>
>> Faiz
>>
>> IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.
> Please fix your mail setup. We cannot work in upstream/LKML with
> confidential emails. Since I was not a intended recipient (I don't know
> who is), then I should start removing your emails?

Apologies for this. This was my first email that went outside. I have configured my email to not append this notice anymore.

Thanks,

Faiz

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Mark Brown]

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

On Tue, Jan 10, 2023 at 01:53:29PM +0530, Mohammad Faiz Abbas Rizvi wrote:
> On 1/8/2023 10:07 PM, Rob Herring wrote:

> > Another node, is it still 'simple card'?

> This behavior already exists in the driver. I am just documenting what already exists.

Right, I think the ship mostly sailed on the naming.  We could add a new
alias but given that we're trying to retire this binding and might
already have existing users who eventually get converted to YAML and
want to validate it seems worth at least documenting what the code has
being accepting.

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

Re: [PATCH] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat

[Mark Brown]

On Thu, 05 Jan 2023 21:33:46 +0530, Faiz Abbas wrote:
> The simple card driver has support for adding cpu, codec and platform
> nodes with the simple-audio-card prefix. Add documentation for the plat
> binding.
> 
> 

Applied to

   broonie/sound.git for-next

Thanks!

[1/1] ASoC: dt-bindings: simple-card: Document simple-audio-card,plat
      commit: e7e2b92e609f82cd164209509f852de941e1285b

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