Skip to contentSkip to conversation

dt-binding: sound: Convert atmel pdmic to json-schema

PATCH In review [email protected] 4 participants 4 messages Jul 5, 2022 – Jul 7, 2022

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-binding: sound: Convert atmel pdmic to json-schema

From: Ryan Wanner <[email protected]>

Convert Atmel PDMIC devicetree binding to json-schema. Change file naming to match json-schema naming.

---
 .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
 .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------
 2 files changed, 104 insertions(+), 55 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +104 -0
new file mode 100644
index 000000000000..cb34c0fc4fc8
@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/atmel,sama5d2-pdmic.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel PDMIC driver under ALSA SoC architecture
+
+maintainers:
+  - Claudiu Beznea <[email protected]>
+
+description:
+  Atmel Pulse Density Modulation Interface Controller
+  (PDMIC) peripheral is a mono PDM decoder module
+  that decodes an incoming PDM sample stream.
+
+properties:
+  compatible:
+    items:
+      - const: atmel,sama5d2-pdmic
+
+  reg:
+    description: Should contain PDMIC registers location and length.
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    description:
+      Must contain an entry for each required entry in clock-names.
+      Please refer to clock-bindings.txt.
+
+    items:
+      - description: peripheral clock.
+      - description: generated clock.
+
+  clock-names:
+    items:
+      - const: pclk
+      - const: gclk
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    const: rx
+
+  atmel,mic-min-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The minimal frequency that the microphone supports.
+
+  atmel,mic-max-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The maximal frequency that the microphone supports.
+
+  atmel,model:
+    description: The user-visible name of this sound card.
+    $ref: /schemas/types.yaml#/definitions/string
+    default: PDMIC
+
+  atmel,mic-offset:
+    $ref: /schemas/types.yaml#/definitions/int32
+    description: The offset that should be added.
+    default: 0
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+  - clock-names
+  - clocks
+  - atmel,mic-min-freq
+  - atmel,mic-max-freq
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/dma/at91.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    pdmic: sound@f8018000 {
+              compatible = "atmel,sama5d2-pdmic";
+              reg = <0xf8018000 0x124>;
+              interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
+              dmas = <&dma0
+                      (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
+                      | AT91_XDMAC_DT_PERID(50))>;
+              dma-names = "rx";
+              clocks = <&pdmic_clk>, <&pdmic_gclk>;
+              clock-names = "pclk", "gclk";
+              pinctrl-names = "default";
+              pinctrl-0 = <&pinctrl_pdmic_default>;
+              atmel,model = "PDMIC@sama5d2_xplained";
+              atmel,mic-min-freq = <1000000>;
+              atmel,mic-max-freq = <3246000>;
+              atmel,mic-offset = <0x0>;
+    };
Documentation/devicetree/bindings/sound/atmel-pdmic.txt deleted +0 -55

55 lines not on this page · raw message

Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 4 lines · On Tue, Jul 05, 2022 at 09:21:42AM -0700, [email protected] wrote:

From: Ryan Wanner <[email protected]>

Convert Atmel PDMIC devicetree binding to json-schema. Change file naming to match json-schema naming.

As documented in submitting-patches.rst please send patches to the maintainers for the code you would like to change. The normal kernel workflow is that people apply patches from their inboxes, if they aren't copied they are likely to not see the patch at all and it is much more difficult to apply patches.

Please submit patches using subject lines reflecting the style for the subsystem, this makes it easier for people to identify relevant patches. Look at what existing commits in the area you're changing are doing and make sure your subject lines visually resemble what they're doing. There's no need to resubmit to fix this alone.

#2 lore raw
In reply to [email protected]
Quoted 9 lines · On 05/07/2022 18:21, [email protected] wrote:

From: Ryan Wanner <[email protected]>

Convert Atmel PDMIC devicetree binding to json-schema. Change file naming to match json-schema naming.

---
 .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
 .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------

You need to send the patches to proper folks with proper subject prefix. Use get_maintainers.pl for the first and git log --oneline -- for the second.

Quoted 10 lines
 2 files changed, 104 insertions(+), 55 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +0 -0
new file mode 100644
index 000000000000..cb34c0fc4fc8

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 8

Quoted 8 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +8 -0
@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/atmel,sama5d2-pdmic.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel PDMIC driver under ALSA SoC architecture

"driver" and ALSA are Linux specific, so this could be corrected during conversion to name the hardware.

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 20

Quoted 12 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +12 -0
+
+maintainers:
+  - Claudiu Beznea <[email protected]>
+
+description:
+  Atmel Pulse Density Modulation Interface Controller
+  (PDMIC) peripheral is a mono PDM decoder module
+  that decodes an incoming PDM sample stream.
+
+properties:
+  compatible:
+    items:

One item, so no need for items.

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 24

Quoted 4 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +4 -0
+      - const: atmel,sama5d2-pdmic
+
+  reg:
+    description: Should contain PDMIC registers location and length.

Skip description, it's obvious.

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 33

Quoted 9 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +9 -0
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    description:
+      Must contain an entry for each required entry in clock-names.
+      Please refer to clock-bindings.txt.

Skip description.

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 37

Quoted 4 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +4 -0
+
+    items:
+      - description: peripheral clock.
+      - description: generated clock.

Skip trailing dots, since you do not start with capital letter.

Quoted 42 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +42 -0
+
+  clock-names:
+    items:
+      - const: pclk
+      - const: gclk
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    const: rx
+
+  atmel,mic-min-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The minimal frequency that the microphone supports.
+
+  atmel,mic-max-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The maximal frequency that the microphone supports.
+
+  atmel,model:
+    description: The user-visible name of this sound card.
+    $ref: /schemas/types.yaml#/definitions/string
+    default: PDMIC
+
+  atmel,mic-offset:
+    $ref: /schemas/types.yaml#/definitions/int32
+    description: The offset that should be added.
+    default: 0
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+  - clock-names
+  - clocks
+  - atmel,mic-min-freq
+  - atmel,mic-max-freq

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 89

Quoted 10 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +10 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/dma/at91.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    pdmic: sound@f8018000 {
+              compatible = "atmel,sama5d2-pdmic";

Use four space for DTS indentation.

Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml line 92

Quoted 3 lines
Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml new file +3 -0
+              reg = <0xf8018000 0x124>;
+              interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
+              dmas = <&dma0

Best regards,
Krzysztof

maintainer
#3 lore raw

Krzysztof, Mark,

Quoted 6 lines · Krzysztof Kozlowski
Quoted 5 lines · On 05/07/2022 18:21, [email protected] wrote:

From: Ryan Wanner <[email protected]>

Convert Atmel PDMIC devicetree binding to json-schema. Change file naming to match json-schema naming.

Quoted 8 lines
Quoted 4 lines
---
  .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
  .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------

You need to send the patches to proper folks with proper subject prefix. Use get_maintainers.pl for the first and git log --oneline -- for the second.

Just to let you know that Codrin who was in charge of audio is not with Microchip anymore. We'll change the MAINTAINERS file soon so that it's clearer for everyone. Anyway, we'll make sure to add Mark and Liam to the list.

Best regards,
Nicolas

Quoted 3 lines
Quoted 3 lines
  2 files changed, 104 insertions(+), 55 deletions(-)

create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt

[..]

Signature · 6 lines
Nicolas Ferre

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel