diff mbox series

[1/2] ASoC: dt-bindings: cirrus,cs530x: Add initial DT binding

Message ID 20240607202708.335752-2-paulha@opensource.cirrus.com (mailing list archive)
State New, archived
Headers show
Series Cirrus Logic family of ADCs | expand

Commit Message

Paul Handrigan June 7, 2024, 8:27 p.m. UTC 
Add the YAML DT bindings for the cs530x high performance
audio ADCs.

Signed-off-by: Paul Handrigan <paulha@opensource.cirrus.com>
---
 .../bindings/sound/cirrus,cs530x.yaml         | 83 +++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml

Comments

Krzysztof Kozlowski June 10, 2024, 8:48 a.m. UTC | #1 
On 07/06/2024 22:27, Paul Handrigan wrote:
> Add the YAML DT bindings for the cs530x high performance
> audio ADCs.
> 
> Signed-off-by: Paul Handrigan <paulha@opensource.cirrus.com>
> ---
>  .../bindings/sound/cirrus,cs530x.yaml         | 83 +++++++++++++++++++
>  1 file changed, 83 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml
> new file mode 100644
> index 000000000000..a4e2493ff03e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml
> @@ -0,0 +1,83 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/cirrus,cs530x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Cirrus Logic cs530x family of audio ADCs
> +
> +maintainers:
> +  - paulha@opensource.cirrus.com

Please provide full name here.

> +  - patches@opensource.cirrus.com
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> +  The CS530X devices are a family of high performance audio ADCs.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - cirrus,cs5302
> +      - cirrus,cs5304
> +      - cirrus,cs5308

Blank line

> +  reg:
> +    maxItems: 1
> +
> +  '#sound-dai-cells':
> +    description:
> +      The first cell indicating the audio interface.

Drop description, it's obvious.

> +    const: 1
> +
> +  reset-gpios:
> +    maxItems: 1
> +
> +  vdd-a-supply:
> +    description: voltage regulator phandle for the vdd-a supply

Drop redundant parts "voltage regulator phandle" and say what supply is
it. Do not describe DT syntax but hardware.

> +
> +  vdd-io-supply:
> +    description: voltage regulator phandle for the vdd-io supply
> +
> +  cirrus,in_hiz_pin12:

No underscores in node names.

> +    description:
> +      Sets input channels one and two to high impedence.

Typo

> +    type: boolean
> +
> +  cirrus,in_hiz_pin34:
> +    description:
> +      Sets input channels three and four to high impedence.
> +    type: boolean
> +
> +  cirrus,in_hiz_pin56:
> +    description:
> +      Sets input channels five and six to high impedence.
> +    type: boolean
> +
> +  cirrus,in_hiz_pin78:
> +    description:
> +      Sets input channels seven and eight to high impedence.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +  - "#sound-dai-cells"
> +

Missing ref to dai-common


> +additionalProperties: false
This should be unevaluatedProperties instead

> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        cs5304: adc@48 {
> +            #sound-dai-cells = <1>;
> +            compatible = "cirrus,cs5304";
> +            reg = <0x48>;

compatible is *always* the first property. reg is the second.




Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml
new file mode 100644
index 000000000000..a4e2493ff03e
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/cirrus,cs530x.yaml
@@ -0,0 +1,83 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/cirrus,cs530x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cirrus Logic cs530x family of audio ADCs
+
+maintainers:
+  - paulha@opensource.cirrus.com
+  - patches@opensource.cirrus.com
+
+description: |
+  The CS530X devices are a family of high performance audio ADCs.
+
+properties:
+  compatible:
+    enum:
+      - cirrus,cs5302
+      - cirrus,cs5304
+      - cirrus,cs5308
+  reg:
+    maxItems: 1
+
+  '#sound-dai-cells':
+    description:
+      The first cell indicating the audio interface.
+    const: 1
+
+  reset-gpios:
+    maxItems: 1
+
+  vdd-a-supply:
+    description: voltage regulator phandle for the vdd-a supply
+
+  vdd-io-supply:
+    description: voltage regulator phandle for the vdd-io supply
+
+  cirrus,in_hiz_pin12:
+    description:
+      Sets input channels one and two to high impedence.
+    type: boolean
+
+  cirrus,in_hiz_pin34:
+    description:
+      Sets input channels three and four to high impedence.
+    type: boolean
+
+  cirrus,in_hiz_pin56:
+    description:
+      Sets input channels five and six to high impedence.
+    type: boolean
+
+  cirrus,in_hiz_pin78:
+    description:
+      Sets input channels seven and eight to high impedence.
+    type: boolean
+
+required:
+  - compatible
+  - reg
+  - "#sound-dai-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        cs5304: adc@48 {
+            #sound-dai-cells = <1>;
+            compatible = "cirrus,cs5304";
+            reg = <0x48>;
+            vdd-a-supply = <&vreg>;
+            vdd-io-supply = <&vreg>;
+            reset-gpios = <&gpio 110 GPIO_ACTIVE_HIGH>;
+            cirrus,in_hiz_pin34;
+        };
+    };