[v2] ASoC: dt-bindings: img,spdif-in: Convert to dtschema

Message ID 20240227160952.615291-1-javier.garcia.ta@udima.es
State New
Headers
Series [v2] ASoC: dt-bindings: img,spdif-in: Convert to dtschema |

Commit Message

Javier García Feb. 27, 2024, 4:09 p.m. UTC
  Convert the Imagination Technologies SPDIF Input Controllerto DT schema.

Signed-off-by: Javier García <javier.garcia.ta@udima.es>
---
 .../bindings/sound/img,spdif-in.txt           | 41 ----------
 .../bindings/sound/img,spdif-in.yaml          | 78 +++++++++++++++++++
 2 files changed, 78 insertions(+), 41 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/img,spdif-in.txt
 create mode 100644 Documentation/devicetree/bindings/sound/img,spdif-in.yaml
  

Comments

Daniel Baluta Feb. 27, 2024, 4:27 p.m. UTC | #1
This looks much better than v1. Make sure you have addressed all
comments from the previous version
and add a short log under the scissor line explaining what you have changed.

Few comments inline:


On Tue, Feb 27, 2024 at 6:13 PM Javier García <javier.garcia.ta@udima.es> wrote:
>
> Convert the Imagination Technologies SPDIF Input Controllerto DT schema.
>
> Signed-off-by: Javier García <javier.garcia.ta@udima.es>
> ---
^ this is the scissor line. Here you add the change log.

Changes since v1:
- re-written the subject inline to include relevant prefix
- removed header file as it is not used
- ....etc


> +$id: http://devicetree.org/schemas/sound/img,spdif-in.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Imagination Technologies SPDIF Input Controller
> +
> +maintainers:
> +  - Liam Girdwood <lgirdwood@gmail.com>
> +  - Mark Brown <broonie@kernel.org>

Please do not blindly add people here. The most proper candidate for this
is the people who wrote the original file.

Using git log we can find Damien.Horsley <Damien.Horsley@imgtec.com>

Damien,

Is it OK to add you as a maintainer for this file as you wrote the
original driver?

Other than this looks good to me as far as i can tell.

thanks,
Daniel.
  
Daniel Baluta Feb. 27, 2024, 4:29 p.m. UTC | #2
On Tue, Feb 27, 2024 at 6:27 PM Daniel Baluta <daniel.baluta@gmail.com> wrote:
>
> This looks much better than v1. Make sure you have addressed all
> comments from the previous version
> and add a short log under the scissor line explaining what you have changed.
>
> Few comments inline:
>
>
> On Tue, Feb 27, 2024 at 6:13 PM Javier García <javier.garciata@udima.es> wrote:
> >
> > Convert the Imagination Technologies SPDIF Input Controllerto DT schema.
> >
> > Signed-off-by: Javier García <javier.garcia.ta@udima.es>
> > ---
> ^ this is the scissor line. Here you add the change log.
>
> Changes since v1:
> - re-written the subject inline to include relevant prefix
> - removed header file as it is not used
> - ....etc
>
>
> > +$id: http://devicetree.org/schemas/sound/img,spdif-in.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Imagination Technologies SPDIF Input Controller
> > +
> > +maintainers:
> > +  - Liam Girdwood <lgirdwood@gmail.com>
> > +  - Mark Brown <broonie@kernel.org>
>
> Please do not blindly add people here. The most proper candidate for this
> is the people who wrote the original file.
>
> Using git log we can find Damien.Horsley <Damien.Horsley@imgtec.com>

Looks like this address bounced back.

@Krzysztof Kozlowski @Mark Brown is it OK to add a mailing list as
maintainer for a yml file?
  
Krzysztof Kozlowski Feb. 28, 2024, 7:40 a.m. UTC | #3
On 27/02/2024 17:29, Daniel Baluta wrote:
> On Tue, Feb 27, 2024 at 6:27 PM Daniel Baluta <daniel.baluta@gmail.com> wrote:
>>
>> This looks much better than v1. Make sure you have addressed all
>> comments from the previous version
>> and add a short log under the scissor line explaining what you have changed.
>>
>> Few comments inline:
>>
>>
>> On Tue, Feb 27, 2024 at 6:13 PM Javier García <javier.garcia.ta@udima.es> wrote:
>>>
>>> Convert the Imagination Technologies SPDIF Input Controllerto DT schema.
>>>
>>> Signed-off-by: Javier García <javier.garcia.ta@udima.es>
>>> ---
>> ^ this is the scissor line. Here you add the change log.
>>
>> Changes since v1:
>> - re-written the subject inline to include relevant prefix
>> - removed header file as it is not used
>> - ....etc
>>
>>
>>> +$id: http://devicetree.org/schemas/sound/img,spdif-in.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: Imagination Technologies SPDIF Input Controller
>>> +
>>> +maintainers:
>>> +  - Liam Girdwood <lgirdwood@gmail.com>
>>> +  - Mark Brown <broonie@kernel.org>
>>
>> Please do not blindly add people here. The most proper candidate for this
>> is the people who wrote the original file.
>>
>> Using git log we can find Damien.Horsley <Damien.Horsley@imgtec.com>
> 
> Looks like this address bounced back.
> 
> @Krzysztof Kozlowski @Mark Brown is it OK to add a mailing list as
> maintainer for a yml file?

Yeah, works as a last resort, when we cannot find any responsible person.

Best regards,
Krzysztof
  

Patch

diff --git a/Documentation/devicetree/bindings/sound/img,spdif-in.txt b/Documentation/devicetree/bindings/sound/img,spdif-in.txt
deleted file mode 100644
index f7ea8c87bf34..000000000000
--- a/Documentation/devicetree/bindings/sound/img,spdif-in.txt
+++ /dev/null
@@ -1,41 +0,0 @@ 
-Imagination Technologies SPDIF Input Controller
-
-Required Properties:
-
-  - compatible : Compatible list, must contain "img,spdif-in"
-
-  - #sound-dai-cells : Must be equal to 0
-
-  - reg : Offset and length of the register set for the device
-
-  - dmas: Contains an entry for each entry in dma-names.
-
-  - dma-names: Must include the following entry:
-	"rx"
-
-  - clocks : Contains an entry for each entry in clock-names
-
-  - clock-names : Includes the following entries:
-	"sys"	The system clock
-
-Optional Properties:
-
-  - resets: Should contain a phandle to the spdif in reset signal, if any
-
-  - reset-names: Should contain the reset signal name "rst", if a
-	reset phandle is given
-
-  - interrupts : Contains the spdif in interrupt, if present
-
-Example:
-
-spdif_in: spdif-in@18100e00 {
-	compatible = "img,spdif-in";
-	reg = <0x18100E00 0x100>;
-	interrupts = <GIC_SHARED 20 IRQ_TYPE_LEVEL_HIGH>;
-	dmas = <&mdc 15 0xffffffff 0>;
-	dma-names = "rx";
-	clocks = <&cr_periph SYS_CLK_SPDIF_IN>;
-	clock-names = "sys";
-	#sound-dai-cells = <0>;
-};
diff --git a/Documentation/devicetree/bindings/sound/img,spdif-in.yaml b/Documentation/devicetree/bindings/sound/img,spdif-in.yaml
new file mode 100644
index 000000000000..1d2e318b349f
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/img,spdif-in.yaml
@@ -0,0 +1,78 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/img,spdif-in.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Imagination Technologies SPDIF Input Controller
+
+maintainers:
+  - Liam Girdwood <lgirdwood@gmail.com>
+  - Mark Brown <broonie@kernel.org>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    enum:
+      - img,spdif-in
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    items:
+      - const: rx
+
+  clocks:
+    items:
+      - description: The system clock
+
+  clock-names:
+    items:
+      - const: sys
+
+  '#sound-dai-cells':
+    const: 0
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    items:
+      - const: rst
+
+required:
+  - compatible
+  - reg
+  - dmas
+  - dma-names
+  - clocks
+  - clock-names
+  - '#sound-dai-cells'
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/pistachio-clk.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/interrupt-controller/mips-gic.h>
+    spdif_in: spdif@18100e00 {
+        compatible = "img,spdif-in";
+        reg = <0x18100e00 0x100>;
+        interrupts = <GIC_SHARED 20 IRQ_TYPE_LEVEL_HIGH>;
+        dmas = <&mdc 15 0xffffffff 0>;
+        dma-names = "rx";
+        clocks = <&cr_periph SYS_CLK_SPDIF_IN>;
+        clock-names = "sys";
+
+        #sound-dai-cells = <0>;
+    };