| Message ID | 20250304014520.83292-3-zhangyi@everest-semi.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | ASoC: codecs: add support for ES8389 | expand |
On Tue, 04 Mar 2025 09:45:20 +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 | 78 +++++++++++++++++++ > 1 file changed, 78 insertions(+) > create mode 100644 Documentation/devicetree/bindings/sound/everest,es8389.yaml > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: dtschema/dtc warnings/errors: Documentation/devicetree/bindings/sound/everest,es8389.example.dts:20.11-24: Warning (reg_format): /example-0/es8389@10:reg: property has invalid length (4 bytes) (#address-cells == 1, #size-cells == 1) Documentation/devicetree/bindings/sound/everest,es8389.example.dtb: Warning (pci_device_reg): Failed prerequisite 'reg_format' Documentation/devicetree/bindings/sound/everest,es8389.example.dtb: Warning (pci_device_bus_num): Failed prerequisite 'reg_format' Documentation/devicetree/bindings/sound/everest,es8389.example.dtb: Warning (simple_bus_reg): Failed prerequisite 'reg_format' Documentation/devicetree/bindings/sound/everest,es8389.example.dtb: Warning (i2c_bus_reg): Failed prerequisite 'reg_format' Documentation/devicetree/bindings/sound/everest,es8389.example.dtb: Warning (spi_bus_reg): Failed prerequisite 'reg_format' doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250304014520.83292-3-zhangyi@everest-semi.com The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
diff --git a/Documentation/devicetree/bindings/sound/everest,es8389.yaml b/Documentation/devicetree/bindings/sound/everest,es8389.yaml new file mode 100644 index 000000000000..b0f3a243b42c --- /dev/null +++ b/Documentation/devicetree/bindings/sound/everest,es8389.yaml @@ -0,0 +1,78 @@ +# 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/uint8 + 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: 0x00 + maximum: 0x07 + default: 0x00 + + everest,dac-slot: + $ref: /schemas/types.yaml#/definitions/uint8 + 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: 0x00 + maximum: 0x07 + default: 0x00 + + prefix_name: + $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 + +required: + - compatible + - reg + - "#sound-dai-cells" + +additionalProperties: false + +examples: + - | + es8389: es8389@10 { + compatible = "everest,es8389"; + reg = <0x10>; + everest,adc-slot = [00]; + everest,dac-slot = [00]; + prefix_name = "es8389_0"; + #sound-dai-cells = <0>; + };
Add device tree binding documentation for Everest ES8389 Signed-off-by: Zhang Yi <zhangyi@everest-semi.com> --- .../bindings/sound/everest,es8389.yaml | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/everest,es8389.yaml