arm64: dts: meson-axg: add missing reset-names property
Subsystems (4)
PATCH 1/2 arm64: dts: meson-axg: add missing reset-names property
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
---
This is essentially a preparation for YAML conversion to fix the warnings.
arch/arm64/boot/dts/amlogic/meson-axg.dtsi | 6 ++++++ 1 file changed, 6 insertions(+)
arch/arm64/boot/dts/amlogic/meson-axg.dtsi +6 -0
@@ -1333,6 +1333,7 @@ toddr_a: audio-controller@100 { interrupts = <GIC_SPI 84 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_A>; resets = <&arb AXG_ARB_TODDR_A>; + reset-names = "arb"; amlogic,fifo-depth = <512>; status = "disabled"; };
@@ -1345,6 +1346,7 @@ toddr_b: audio-controller@140 { interrupts = <GIC_SPI 85 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_B>; resets = <&arb AXG_ARB_TODDR_B>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };
@@ -1357,6 +1359,7 @@ toddr_c: audio-controller@180 { interrupts = <GIC_SPI 86 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_C>; resets = <&arb AXG_ARB_TODDR_C>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };
@@ -1369,6 +1372,7 @@ frddr_a: audio-controller@1c0 { interrupts = <GIC_SPI 88 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_A>; resets = <&arb AXG_ARB_FRDDR_A>; + reset-names = "arb"; amlogic,fifo-depth = <512>; status = "disabled"; };
@@ -1381,6 +1385,7 @@ frddr_b: audio-controller@200 { interrupts = <GIC_SPI 89 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_B>; resets = <&arb AXG_ARB_FRDDR_B>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };
@@ -1393,6 +1398,7 @@ frddr_c: audio-controller@240 { interrupts = <GIC_SPI 90 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_C>; resets = <&arb AXG_ARB_FRDDR_C>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };
Signature · 1 line
2.34.1
PATCH 2/2 ASoC: meson: axg-fifo: convert Amlogic FIFO controller to yaml
Convert Amlogic FIFO controller documentation to yaml format.
---
Things to note:
First of, Jerome, sorry for adding you as maintainer, but
1) it's mandatory
2) your are the (only) author of amlogic,axg-fifo.txt
Please add your Signed-off-by if that is okay with you.
License is mandated by checkpath, not my choice.
I'm not so sure about the compatible check. Essentially it is either
* 'amlogic,axg-frddr' OR
* 'amlogic,g12a-frddr' + 'amlogic,axg-frddr'
(or 'sm1' instead of 'g12a')
Same goes for *-toddr. Is this schema correct in that regard? At least I got no warnings on existing device trees.
.../bindings/sound/amlogic,axg-fifo.txt | 34 ------- .../bindings/sound/amlogic,axg-fifo.yaml | 97 +++++++++++++++++++ 2 files changed, 97 insertions(+), 34 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.txt create mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.yaml
Documentation/devicetree/bindings/sound/amlogic,axg-fifo.txt deleted +0 -34
@@ -1,34 +0,0 @@ -* Amlogic Audio FIFO controllers - -Required properties: -- compatible: 'amlogic,axg-toddr' or - 'amlogic,axg-toddr' or - 'amlogic,g12a-frddr' or - 'amlogic,g12a-toddr' or - 'amlogic,sm1-frddr' or - 'amlogic,sm1-toddr' -- reg: physical base address of the controller and length of memory - mapped region. -- interrupts: interrupt specifier for the fifo. -- clocks: phandle to the fifo peripheral clock provided by the audio - clock controller. -- resets: list of reset phandle, one for each entry reset-names. -- reset-names: should contain the following: - * "arb" : memory ARB line (required) - * "rst" : dedicated device reset line (optional) -- #sound-dai-cells: must be 0. -- amlogic,fifo-depth: The size of the controller's fifo in bytes. This - is useful for determining certain configuration such - as the flush threshold of the fifo - -Example of FRDDR A on the A113 SoC: - -frddr_a: audio-controller@1c0 { - compatible = "amlogic,axg-frddr"; - reg = <0x0 0x1c0 0x0 0x1c>; - #sound-dai-cells = <0>; - interrupts = <GIC_SPI 88 IRQ_TYPE_EDGE_RISING>; - clocks = <&clkc_audio AUD_CLKID_FRDDR_A>; - resets = <&arb AXG_ARB_FRDDR_A>; - fifo-depth = <512>; -};
Documentation/devicetree/bindings/sound/amlogic,axg-fifo.yaml new file +97 -0
97 lines not on this page · raw message
Signature · 1 line
2.34.1
Jerome Brunet
maintainerRe: [PATCH 2/2] ASoC: meson: axg-fifo: convert Amlogic FIFO controller to yaml
Quoted 13 lines · Alexander Stein
Convert Amlogic FIFO controller documentation to yaml format.
Signed-off-by Alexander Stein <[email protected]>---
Things to note:
First of, Jerome, sorry for adding you as maintainer, but
1) it's mandatory
2) your are the (only) author of amlogic,axg-fifo.txtPlease add your Signed-off-by if that is okay with you.
License is mandated by checkpath, not my choice.
Quoted 8 lines
I'm not so sure about the compatible check. Essentially it is either
* 'amlogic,axg-frddr' OR
* 'amlogic,g12a-frddr' + 'amlogic,axg-frddr'
(or 'sm1' instead of 'g12a')Same goes for *-toddr. Is this schema correct in that regard? At least I got no warnings on existing device trees.
There has already been a submission of this.
It should answer your questions. You've also missed some constraints regarding resets. Please check:
https://patchwork.kernel.org/project/linux-amlogic/list/?series=246453&state=%2A&archive=both
Quoted 149 lines
.../bindings/sound/amlogic,axg-fifo.txt | 34 ------- .../bindings/sound/amlogic,axg-fifo.yaml | 97 +++++++++++++++++++ 2 files changed, 97 insertions(+), 34 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.txt create mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.yamlDocumentation/devicetree/bindings/sound/amlogic,axg-fifo.txt deleted +0
-34@@ -1,34 +0,0 @@ -* Amlogic Audio FIFO controllers - -Required properties: -- compatible: 'amlogic,axg-toddr' or - 'amlogic,axg-toddr' or - 'amlogic,g12a-frddr' or - 'amlogic,g12a-toddr' or - 'amlogic,sm1-frddr' or - 'amlogic,sm1-toddr' -- reg: physical base address of the controller and length of memory - mapped region. -- interrupts: interrupt specifier for the fifo. -- clocks: phandle to the fifo peripheral clock provided by the audio - clock controller. -- resets: list of reset phandle, one for each entry reset-names. -- reset-names: should contain the following: - * "arb" : memory ARB line (required) - * "rst" : dedicated device reset line (optional) -- #sound-dai-cells: must be 0. -- amlogic,fifo-depth: The size of the controller's fifo in bytes. This - is useful for determining certain configuration such - as the flush threshold of the fifo - -Example of FRDDR A on the A113 SoC: - -frddr_a: audio-controller@1c0 { - compatible = "amlogic,axg-frddr"; - reg = <0x0 0x1c0 0x0 0x1c>; - #sound-dai-cells = <0>; - interrupts = <GIC_SPI 88 IRQ_TYPE_EDGE_RISING>; - clocks = <&clkc_audio AUD_CLKID_FRDDR_A>; - resets = <&arb AXG_ARB_FRDDR_A>; - fifo-depth = <512>; -};Documentation/devicetree/bindings/sound/amlogic,axg-fifo.yaml new file +97
-0@@ -0,0 +1,97 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/amlogic,axg-fifo.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Amlogic Audio FIFO controllers + +maintainers: + - Jerome Brunet <[email protected]> + +allOf: + - $ref: name-prefix.yaml# + +properties: + $nodename: + pattern: "^audio-controller@.*" + + "#sound-dai-cells": + const: 0 + + compatible: + oneOf: + - items: + - enum: + - amlogic,g12a-frddr + - amlogic,sm1-frddr + - const: amlogic,axg-frddr + - const: amlogic,axg-frddr + - items: + - enum: + - amlogic,g12a-toddr + - amlogic,sm1-toddr + - const: amlogic,axg-toddr + - const: amlogic,axg-toddr + + reg: + items: + - description: physical base address of the controller + + interrupts: + items: + - description: FIFO interrupt + + clocks: + items: + - description: FIFO peripheral clock provided by the audio clock controller + + resets: + minItems: 1 + items: + - description: memory ARB line + - description: optional device reset line + + reset-names: + minItems: 1 + items: + - const: arb + - const: rst + + amlogic,fifo-depth: + description: > + The size of the controller's fifo in bytes. This + is useful for determining certain configuration such + as the flush threshold of the fifo + $ref: /schemas/types.yaml#/definitions/uint32 + + sound-name-prefix: true + +required: + - compatible + - reg + - interrupts + - clocks + - resets + - reset-names + - '#sound-dai-cells' + - amlogic,fifo-depth + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/axg-audio-clkc.h> + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/reset/amlogic,meson-axg-audio-arb.h> + + frddr_a: audio-controller@1c0 { + compatible = "amlogic,axg-frddr"; + reg = <0x1c0 0x1c>; + #sound-dai-cells = <0>; + interrupts = <88 IRQ_TYPE_EDGE_RISING>; + clocks = <&clkc_audio AUD_CLKID_FRDDR_A>; + resets = <&arb AXG_ARB_FRDDR_A>; + reset-names = "arb"; + amlogic,fifo-depth = <512>; + };
Rob Herring
maintainerRe: [PATCH 2/2] ASoC: meson: axg-fifo: convert Amlogic FIFO controller to yaml
In reply to Alexander SteinQuoted 18 lines · Alexander Stein
Convert Amlogic FIFO controller documentation to yaml format.
Signed-off-by Alexander Stein <[email protected]>---
Things to note:
First of, Jerome, sorry for adding you as maintainer, but
1) it's mandatory
2) your are the (only) author of amlogic,axg-fifo.txtPlease add your Signed-off-by if that is okay with you.
License is mandated by checkpath, not my choice.
I'm not so sure about the compatible check. Essentially it is either
* 'amlogic,axg-frddr' OR
* 'amlogic,g12a-frddr' + 'amlogic,axg-frddr'
(or 'sm1' instead of 'g12a')
Quoted 9 lines
Same goes for *-toddr. Is this schema correct in that regard? At least I got no warnings on existing device trees.
.../bindings/sound/amlogic,axg-fifo.txt | 34 ------- .../bindings/sound/amlogic,axg-fifo.yaml | 97 +++++++++++++++++++ 2 files changed, 97 insertions(+), 34 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.txt create mode 100644 Documentation/devicetree/bindings/sound/amlogic,axg-fifo.yaml
Running 'make dtbs_check' with the schema in this patch gives the following warnings. Consider if they are expected or the schema is incorrect. These may not be new warnings.
Note that it is not yet a requirement to have 0 warnings for dtbs_check. This will change in the future.
Full log is available here: https://patchwork.ozlabs.org/patch/1580333
audio-controller@100: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
audio-controller@140: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
audio-controller@180: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
audio-controller@1c0: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
audio-controller@200: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
audio-controller@240: 'reset-names' is a required property
arch/arm64/boot/dts/amlogic/meson-axg-s400.dt.yaml
_______________________________________________
linux-amlogic mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-amlogic
Re: [PATCH 2/2] ASoC: meson: axg-fifo: convert Amlogic FIFO controller to yaml
In reply to Alexander SteinQuoted 11 lines · Alexander Stein
Convert Amlogic FIFO controller documentation to yaml format.
Signed-off-by Alexander Stein <[email protected]>---
Things to note:
First of, Jerome, sorry for adding you as maintainer, but
1) it's mandatory
2) your are the (only) author of amlogic,axg-fifo.txtPlease add your Signed-off-by if that is okay with you.
That's not how Signed-off-by works. 'Acked-by' would be correct. But as the only author, I don't think that's required here.
Quoted 2 lines
License is mandated by checkpath, not my choice.
checkpatch doesn't mandate anything. It is guidance. If you copy the existing binding, then you inherit the default license (GPL-2.0). But if Jerome is okay with relicensing, that would be nice.
Rob
Jerome Brunet
maintainerQuoted 2 lines · Alexander Stein
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
Binginds *mandates* ?? the bindings you are adding mandates that, not the previous doc, nor the driver.
Modifying drivers and DT to accomodate made-up bindings requirement is disturbing.
The bindings should not require that because the driver does not, as it stands. The driver requires the arb reset to be provided, not the name. Please fix the bindings.
Quoted 61 lines
Signed-off-by Alexander Stein <[email protected]>---
This is essentially a preparation for YAML conversion to fix the warnings.arch/arm64/boot/dts/amlogic/meson-axg.dtsi | 6 ++++++ 1 file changed, 6 insertions(+)arch/arm64/boot/dts/amlogic/meson-axg.dtsi +6
-0@@ -1333,6 +1333,7 @@ toddr_a: audio-controller@100 { interrupts = <GIC_SPI 84 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_A>; resets = <&arb AXG_ARB_TODDR_A>; + reset-names = "arb"; amlogic,fifo-depth = <512>; status = "disabled"; };@@ -1345,6 +1346,7 @@ toddr_b: audio-controller@140 { interrupts = <GIC_SPI 85 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_B>; resets = <&arb AXG_ARB_TODDR_B>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };@@ -1357,6 +1359,7 @@ toddr_c: audio-controller@180 { interrupts = <GIC_SPI 86 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_TODDR_C>; resets = <&arb AXG_ARB_TODDR_C>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };@@ -1369,6 +1372,7 @@ frddr_a: audio-controller@1c0 { interrupts = <GIC_SPI 88 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_A>; resets = <&arb AXG_ARB_FRDDR_A>; + reset-names = "arb"; amlogic,fifo-depth = <512>; status = "disabled"; };@@ -1381,6 +1385,7 @@ frddr_b: audio-controller@200 { interrupts = <GIC_SPI 89 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_B>; resets = <&arb AXG_ARB_FRDDR_B>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };@@ -1393,6 +1398,7 @@ frddr_c: audio-controller@240 { interrupts = <GIC_SPI 90 IRQ_TYPE_EDGE_RISING>; clocks = <&clkc_audio AUD_CLKID_FRDDR_C>; resets = <&arb AXG_ARB_FRDDR_C>; + reset-names = "arb"; amlogic,fifo-depth = <256>; status = "disabled"; };
Am Samstag, 15. Januar 2022, 16:04:10 CET schrieb Jerome Brunet:
Quoted 2 lines
On Sat 15 Jan 2022 at 10:35, Alexander Stein <[email protected]>
Quoted 6 lines · wrote:
Quoted 3 lines
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
Binginds *mandates* ?? the bindings you are adding mandates that, not the previous doc, nor the driver.
Well, under required properties 'reset-names' is listed as well as 'arb' is required, only 'rst' is optional.
So when creating the .yaml accordingly this leads to warnings this patch is about to fix.
Quoted 6 lines
Modifying drivers and DT to accomodate made-up bindings requirement is disturbing.
The bindings should not require that because the driver does not, as it stands. The driver requires the arb reset to be provided, not the name. Please fix the bindings.
Nothing is made up. When creating the .yaml file I took the .txt documentation for granted. How should I know the bindings documentation is apparently wrong?
When using your older bindings conversion [1] I'm fine with dropping this one.
Best regards,
Alexander
[1] https://patchwork.kernel.org/project/linux-amlogic/list/?
series=246453&state=%2A&archive=both
Jerome Brunet
maintainerQuoted 5 lines · Alexander Stein
Am Samstag, 15. Januar 2022, 16:04:10 CET schrieb Jerome Brunet:
Quoted 2 lines
On Sat 15 Jan 2022 at 10:35, Alexander Stein <[email protected]>
Quoted 1 line · wrote:
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
Binginds *mandates* ?? the bindings you are adding mandates that, not the previous doc, nor the driver.
Well, under required properties 'reset-names' is listed as well as 'arb' is required, only 'rst' is optional.
I think there is a misunderstanding then.
The arb reset is required, the "reset-names" is not - as long as there is single reset.
Quoted 20 lines
So when creating the .yaml accordingly this leads to warnings this patch is about to fix.
Quoted 6 lines
Modifying drivers and DT to accomodate made-up bindings requirement is disturbing.
The bindings should not require that because the driver does not, as it stands. The driver requires the arb reset to be provided, not the name. Please fix the bindings.
Nothing is made up. When creating the .yaml file I took the .txt documentation for granted. How should I know the bindings documentation is apparently wrong?
When using your older bindings conversion [1] I'm fine with dropping this one.
Best regards,
Alexander[1] https://patchwork.kernel.org/project/linux-amlogic/list/?
series=246453&state=%2A&archive=both
Hi,
Quoted 14 lines · Jerome Brunet
Quoted 11 lines · Alexander Stein
Am Samstag, 15. Januar 2022, 16:04:10 CET schrieb Jerome Brunet:
Quoted 2 lines
On Sat 15 Jan 2022 at 10:35, Alexander Stein <[email protected]>
Quoted 6 lines · wrote:
Quoted 3 lines
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
Binginds *mandates* ?? the bindings you are adding mandates that, not the previous doc, nor the driver.
Quoted 6 lines
Quoted 2 lines
Well, under required properties 'reset-names' is listed as well as 'arb' is required, only 'rst' is optional.
I think there is a misunderstanding then.
The arb reset is required, the "reset-names" is not - as long as there is single reset.
To be fair, it's not explicit in the .txt bindings at all:
-- reset-names: should contain the following:
- * "arb" : memory ARB line (required)
- * "rst" : dedicated device reset line (optional)
Anyway, this should be solved, it's pretty common to have reset-names mandatory even for a single reset if a second one is optional.
Quoted 22 lines
Quoted 21 lines
So when creating the .yaml accordingly this leads to warnings this patch is about to fix.
Quoted 6 lines
Modifying drivers and DT to accomodate made-up bindings requirement is disturbing.
The bindings should not require that because the driver does not, as it stands. The driver requires the arb reset to be provided, not the name. Please fix the bindings.
Nothing is made up. When creating the .yaml file I took the .txt documentation for granted. How should I know the bindings documentation is apparently wrong?
When using your older bindings conversion [1] I'm fine with dropping this one.
Best regards,
Alexander[1] https://patchwork.kernel.org/project/linux-amlogic/list/?
series=246453&state=%2A&archive=both
Jerome Brunet
maintainerQuoted 17 lines · Neil Armstrong
Hi,
Quoted 14 lines · Jerome Brunet
Quoted 11 lines · Alexander Stein
Am Samstag, 15. Januar 2022, 16:04:10 CET schrieb Jerome Brunet:
Quoted 2 lines
On Sat 15 Jan 2022 at 10:35, Alexander Stein <[email protected]>
Quoted 6 lines · wrote:
Quoted 3 lines
Bindings amlogic,axg-fifo.txt mandates that reset-names is a required property. Add it.
Binginds *mandates* ?? the bindings you are adding mandates that, not the previous doc, nor the driver.
Quoted 9 lines
Quoted 6 lines
Quoted 2 lines
Well, under required properties 'reset-names' is listed as well as 'arb' is required, only 'rst' is optional.
I think there is a misunderstanding then.
The arb reset is required, the "reset-names" is not - as long as there is single reset.To be fair, it's not explicit in the .txt bindings at all:
- resets: list of reset phandle, one for each entry reset-names.
Review
Quoted 3 lines
-- reset-names: should contain the following:
(quoted diff) +0
-2- * "arb" : memory ARB line (required) - * "rst" : dedicated device reset line (optional)
That was fairly usual way to describe clocks and reset with txt files but I agree it could have been interpreted the other way around
Quoted 3 lines
Anyway, this should be solved, it's pretty common to have reset-names mandatory even for a single reset if a second one is optional.
Binding should not decribe what's common but how the binding is supposed to be used. Fact is the usage was defined by the first and only user which is linux driver.
This driver does not care if the arb name is present or not. Mandating something which is unused makes no sense.
If we want to be precise, then it just cares it is the first reset is the arb one (and yes, this constraint is not described either).
The reason for that is simple, there was no 'rst' line on first version of the IP, and it was 'fairly usual' to not have 'reset-names' when there is a single reset.
If you think the 'arb' name should be made mandatory, that's fine by me but one should be able to rely on the name so the driver should be updated to use it.
Quoted 23 lines
Quoted 23 lines
Quoted 22 lines
So when creating the .yaml accordingly this leads to warnings this patch is about to fix.
Quoted 6 lines
Modifying drivers and DT to accomodate made-up bindings requirement is disturbing.
The bindings should not require that because the driver does not, as it stands. The driver requires the arb reset to be provided, not the name. Please fix the bindings.
Nothing is made up. When creating the .yaml file I took the .txt documentation for granted. How should I know the bindings documentation is apparently wrong?
When using your older bindings conversion [1] I'm fine with dropping this one.
Best regards,
Alexander[1] https://patchwork.kernel.org/project/linux-amlogic/list/?
series=246453&state=%2A&archive=both