diff mbox series

[v2] ASoC: codecs: dt bind. doc for the new TI SRC4392 codec

Message ID 20220810221232.1596488-1-flatmax@flatmax.com
State Superseded
Headers show
Series [v2] ASoC: codecs: dt bind. doc for the new TI SRC4392 codec | expand

Commit Message

Matt Flax Aug. 10, 2022, 10:12 p.m. UTC
Signed-off-by: Matt Flax <flatmax@flatmax.com>
---

Notes:
    v2:
    * Added myself as the maintainer

 .../devicetree/bindings/sound/src4xxx.yaml    | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/src4xxx.yaml

Comments

Rob Herring Aug. 14, 2022, 9:10 p.m. UTC | #1
On Thu, Aug 11, 2022 at 08:12:32AM +1000, Matt Flax wrote:
> Signed-off-by: Matt Flax <flatmax@flatmax.com>
> ---
> 
> Notes:
>     v2:
>     * Added myself as the maintainer
> 
>  .../devicetree/bindings/sound/src4xxx.yaml    | 50 +++++++++++++++++++

ti,src4xxx.yaml

>  1 file changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/src4xxx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/src4xxx.yaml b/Documentation/devicetree/bindings/sound/src4xxx.yaml
> new file mode 100644
> index 000000000000..368bb4ba1a77
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/src4xxx.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings. (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/src4xxx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments SRC4392 Device Tree Bindings
> +
> +description: |
> +  The SRC4392 is a digital audio codec that can be connected via
> +  I2C or SPI. Currently, only I2C bus is supported.
> +
> +maintainers:
> +  - Matt Flax <flatmax@flatmax.com>
> +
> +allOf:
> +  - $ref: name-prefix.yaml#
> +
> +properties:
> +  compatible:
> +    const: ti,src4392
> +
> +  "#sound-dai-cells":
> +    const: 0
> +
> +  reg:
> +    description:
> +      The I2C address of the device

No need for generic descriptions.

> +    maxItems: 1
> +
> +required:
> +  - "#sound-dai-cells"
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        src4392@70 {

audio-codec@70

> +            #sound-dai-cells = <0>;
> +            compatible = "ti,src4392";
> +            reg = <0x70>;
> +        };
> +    };
> +...
> -- 
> 2.34.1
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/src4xxx.yaml b/Documentation/devicetree/bindings/sound/src4xxx.yaml
new file mode 100644
index 000000000000..368bb4ba1a77
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/src4xxx.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/src4xxx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments SRC4392 Device Tree Bindings
+
+description: |
+  The SRC4392 is a digital audio codec that can be connected via
+  I2C or SPI. Currently, only I2C bus is supported.
+
+maintainers:
+  - Matt Flax <flatmax@flatmax.com>
+
+allOf:
+  - $ref: name-prefix.yaml#
+
+properties:
+  compatible:
+    const: ti,src4392
+
+  "#sound-dai-cells":
+    const: 0
+
+  reg:
+    description:
+      The I2C address of the device
+    maxItems: 1
+
+required:
+  - "#sound-dai-cells"
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        src4392@70 {
+            #sound-dai-cells = <0>;
+            compatible = "ti,src4392";
+            reg = <0x70>;
+        };
+    };
+...