Devicetree
 help / color / mirror / Atom feed
From: Zhang Yi <zhangyi@everest-semi.com>
To: alsa-devel@alsa-project.org, broonie@kernel.org,
	devicetree@vger.kernel.org
Cc: tiwai@suse.com, amadeuszx.slawinski@linux.intel.com,
	robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
	conor+dt@kernel.org, Zhang Yi <zhangyi@everest-semi.com>
Subject: [PATCH v4 2/2] ASoC: dt-bindings: Add Everest ES8389 audio CODEC
Date: Tue,  4 Mar 2025 19:47:51 +0800	[thread overview]
Message-ID: <20250304114751.54635-3-zhangyi@everest-semi.com> (raw)
In-Reply-To: <20250304114751.54635-1-zhangyi@everest-semi.com>

Add device tree binding documentation for Everest ES8389 which
is different from ES8388

Signed-off-by: Zhang Yi <zhangyi@everest-semi.com>
---
 .../bindings/sound/everest,es8389.yaml        | 83 +++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/everest,es8389.yaml

diff --git a/Documentation/devicetree/bindings/sound/everest,es8389.yaml b/Documentation/devicetree/bindings/sound/everest,es8389.yaml
new file mode 100644
index 000000000000..0860adbc8654
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/everest,es8389.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/everest,es8389.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Everest ES8389 audio CODEC
+
+maintainers:
+  - Michael Zhang <zhangyi@everest-semi.com>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    const: everest,es8389
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: clock for master clock (MCLK)
+
+  clock-names:
+    items:
+      - const: mclk
+
+  "#sound-dai-cells":
+    const: 0
+
+  everest,adc-slot:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      This property is used to set the slots of recording data when multiple
+      codecs are connected in PTDM mode.
+      please set this property to default if you are setting STDM mode.
+    minimum: 0
+    maximum: 7
+    default: 0
+
+  everest,dac-slot:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      This property is used to set the slots of playing data when multiple
+      codecs are connected in TDM mode.
+      please do not set this property if you use single codec.
+    minimum: 0
+    maximum: 7
+    default: 0
+
+  prefix_name:
+    $ref: /schemas/types.yaml#/definitions/string
+    description:
+      When using multiple codecs, The prefix_name is used to distinguish the
+      dapm and kcontrol of each individual codec.
+
+  everest,dmic-enabled:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      ES8389 use DMIC as input
+
+required:
+  - compatible
+  - reg
+  - "#sound-dai-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      es8389: codec@10 {
+        compatible = "everest,es8389";
+        reg = <0x10>;
+        everest,adc-slot = <0>;
+        everest,dac-slot = <0>;
+        #sound-dai-cells = <0>;
+      };
+    };
-- 
2.17.1


  parent reply	other threads:[~2025-03-04 11:57 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-04 11:47 [PATCH v4 0/2] ASoC: codecs: add support for ES8389 Zhang Yi
2025-03-04 11:47 ` [PATCH v4 1/2] " Zhang Yi
2025-03-04 19:08   ` Mark Brown
2025-03-04 11:47 ` Zhang Yi [this message]
2025-03-05  6:59   ` [PATCH v4 2/2] ASoC: dt-bindings: Add Everest ES8389 audio CODEC Krzysztof Kozlowski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250304114751.54635-3-zhangyi@everest-semi.com \
    --to=zhangyi@everest-semi.com \
    --cc=alsa-devel@alsa-project.org \
    --cc=amadeuszx.slawinski@linux.intel.com \
    --cc=broonie@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=robh+dt@kernel.org \
    --cc=tiwai@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox