diff mbox series

[RESEND,v2,2/2] ASoC: dt-bindings: rt5682s: add bindings for rt5682s

Message ID 20210907120557.1593-2-derek.fang@realtek.com (mailing list archive)
State Accepted
Commit 50159fdb144b73984873bf2eeb9ff45d10a67f3a
Headers show
Series [RESEND,v2,1/2] ASoC: rt5682s: Add driver for ALC5682I-VS codec | expand

Commit Message

Derek [方德義] Sept. 7, 2021, 12:05 p.m. UTC
From: Derek Fang <derek.fang@realtek.com>

Realtek ALC5682I-VS codec is a ALC5682I-VD variant which supports I2C only.

Signed-off-by: Derek Fang <derek.fang@realtek.com>
---
 .../bindings/sound/realtek,rt5682s.yaml       | 100 ++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml

Comments

Krzysztof Kozlowski Sept. 20, 2021, 11:28 a.m. UTC | #1
On 07/09/2021 14:05, derek.fang@realtek.com wrote:
> From: Derek Fang <derek.fang@realtek.com>
> 
> Realtek ALC5682I-VS codec is a ALC5682I-VD variant which supports I2C only.
> 
> Signed-off-by: Derek Fang <derek.fang@realtek.com>
> ---
>  .../bindings/sound/realtek,rt5682s.yaml       | 100 ++++++++++++++++++
>  1 file changed, 100 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml b/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
> new file mode 100644
> index 000000000000..fbf23696f1a7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
> @@ -0,0 +1,100 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/realtek,rt5682s.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Realtek rt5682s codec devicetree bindings
> +
> +maintainers:
> +  - Derek Fang <derek.fang@realtek.com>
> +
> +description: |
> +  Rt5682s(ALC5682I-VS) is a rt5682i variant which supports I2C only.
> +
> +properties:
> +  compatible:
> +    const: realtek,rt5682s
> +
> +  reg:
> +    maxItems: 1
> +    description: I2C address of the device.
> +
> +  interrupts:
> +    description: The CODEC's interrupt output.
> +
> +  realtek,dmic1-data-pin:
> +    enum:
> +      - 0 # dmic1 data is not used
> +      - 1 # using GPIO2 pin as dmic1 data pin
> +      - 2 # using GPIO5 pin as dmic1 data pin
> +

+Cc devicetree and Rob,

Guys,

This is really poor. The patch was never sent to devicetree maintainers
and does not build at all!

There are several errors here. I fixed few of them:
https://lore.kernel.org/lkml/20210920112106.140918-1-krzysztof.kozlowski@canonical.com/

but still you need to fix missing description for vendor fields.

Derek,
Your duty is to use get_maintainers.pl script to Cc all relevant
maintainers and mailing lists. Second duty is to test it. This was not
tested.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml b/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
new file mode 100644
index 000000000000..fbf23696f1a7
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
@@ -0,0 +1,100 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/realtek,rt5682s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek rt5682s codec devicetree bindings
+
+maintainers:
+  - Derek Fang <derek.fang@realtek.com>
+
+description: |
+  Rt5682s(ALC5682I-VS) is a rt5682i variant which supports I2C only.
+
+properties:
+  compatible:
+    const: realtek,rt5682s
+
+  reg:
+    maxItems: 1
+    description: I2C address of the device.
+
+  interrupts:
+    description: The CODEC's interrupt output.
+
+  realtek,dmic1-data-pin:
+    enum:
+      - 0 # dmic1 data is not used
+      - 1 # using GPIO2 pin as dmic1 data pin
+      - 2 # using GPIO5 pin as dmic1 data pin
+
+  realtek,dmic1-clk-pin:
+    enum:
+      - 0 # dmic1 clk is not used
+      - 1 # using GPIO1 pin as dmic1 clock pin
+      - 2 # using GPIO3 pin as dmic1 clock pin
+
+  realtek,jd-src:
+    enum:
+      - 0 # No JD is used
+      - 1 # using JD1 as JD source
+
+  realtek,ldo1-en-gpios:
+    description: |
+      The GPIO that controls the CODEC's LDO1_EN pin.
+
+  realtek,dmic-clk-rate-hz:
+    description: |
+      Set the clock rate (hz) for the requirement of the particular DMIC.
+
+  realtek,dmic-delay-ms:
+    description: |
+      Set the delay time (ms) for the requirement of the particular DMIC.
+
+  realtek,dmic-clk-driving-high:
+    type: boolean
+    description: |
+      Set the high driving of the DMIC clock out.
+
+  clocks:
+    items:
+      - description: phandle and clock specifier for codec MCLK.
+
+  clock-names:
+    items:
+      const: mclk
+
+  "#clock-cells":
+    const: 1
+
+  clock-output-names:
+    items:
+      - description: Name given for DAI word clock output.
+      - description: Name given for DAI bit clock output.
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+
+example:
+  - |
+    rt5682s {
+        compatible = "realtek,rt5682s";
+        reg = <0x1a>;
+        interrupt-parent = <&gpio>;
+        interrupts = <TEGRA_GPIO(U, 6) IRQ_TYPE_LEVEL_HIGH>;
+        realtek,ldo1-en-gpios =
+            <&gpio TEGRA_GPIO(R, 2) GPIO_ACTIVE_HIGH>;
+        realtek,dmic1-data-pin = <1>;
+        realtek,dmic1-clk-pin = <1>;
+        realtek,jd-src = <1>;
+
+        #clock-cells = <1>;
+        clock-output-names = "rt5682-dai-wclk", "rt5682-dai-bclk";
+
+        clocks = <&osc>;
+        clock-names = "mclk";
+    };