On Tue, Mar 04, 2025 at 02:27:37PM +0800, Zhang Yi wrote:
Add device tree binding documentation for Everest ES8389
Signed-off-by: Zhang Yi zhangyi@everest-semi.com
.../bindings/sound/everest,es8389.yaml | 82 +++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/everest,es8389.yaml
<form letter> Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC (and consider --no-git-fallback argument, so you will not CC people just because they made one commit years ago). It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.
Tools like b4 or scripts/get_maintainer.pl provide you proper list of people, so fix your workflow. Tools might also fail if you work on some ancient tree (don't, instead use mainline) or work on fork of kernel (don't, instead use mainline). Just use b4 and everything should be fine, although remember about 'b4 prep --auto-to-cc' if you added new patches to the patchset. </form letter>
diff --git a/Documentation/devicetree/bindings/sound/everest,es8389.yaml b/Documentation/devicetree/bindings/sound/everest,es8389.yaml new file mode 100644 index 000000000000..2c522826bae4 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/everest,es8389.yaml @@ -0,0 +1,82 @@ +# 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
Device is really different than es8388?
- 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/uint8
- description: |
This property is used to set the slots of recording data when multiplecodecs are connected in PTDM mode.please set this property to default if you are setting STDM mode.- minimum: 0x00
Drop, unsigned does not allow -1.
- maximum: 0x07
- default: 0x00
All of these should be rather decimal.
- everest,dac-slot:
- $ref: /schemas/types.yaml#/definitions/uint8
- description: |
This property is used to set the slots of playing data when multiplecodecs are connected in TDM mode.please do not set this property if you use single codec.- minimum: 0x00
- maximum: 0x07
- default: 0x00
- prefix_name:
No underscores in node names, missing vendor prefix... but more important: I don't understand the need for this property. Description copies property name so it is not useful.
Drop. You maybe wanted dai prefix, but this is already in dai-common.
- $ref: /schemas/types.yaml#/definitions/string
- description: device name prefix
- everest,dmic-enabled:
- $ref: /schemas/types.yaml#/definitions/flag
- description:
The property is a choice between PDM and AMIC
No supplies?
+required:
- compatible
- reg
- "#sound-dai-cells"
+additionalProperties: false
+examples:
- |
- i2c{
Missing space.
#address-cells = <1>;#size-cells = <0>;es8389: es8389@10 {
Node names should be generic. See also an explanation and list of examples (not exhaustive) in DT specification: https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetre...
compatible = "everest,es8389";reg = <0x10>;everest,adc-slot = [00];
Please open other bindings or DTS and take a look how single number is encoded. In general, please rather base your work on latest bindings and DTS accepted by reviewers and use them as learning/template to avoid common mistakes. At least two comments in this review could be avoided if you did this.
everest,dac-slot = [00];prefix_name = "es8389_0";
Drop
#sound-dai-cells = <0>;};- };
-- 2.17.1