| Message ID | 20220726131747.127992-2-zhuning0077@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v3,1/2] ASoC: codecs: add support for ES8326 | expand |
On Tue, Jul 26, 2022 at 09:17:47PM +0800, Zhu Ning wrote: > Add device tree binding documentation for Everest ES8326 > > Signed-off-by: David Yang <yangxiaohua@everest-semi.com> > Signed-off-by: Zhu Ning <zhuning@everest-semi.com> > --- > .../bindings/sound/everest,es8326.yaml | 84 +++++++++++++++++++ > 1 file changed, 84 insertions(+) > create mode 100755 Documentation/devicetree/bindings/sound/everest,es8326.yaml > > diff --git a/Documentation/devicetree/bindings/sound/everest,es8326.yaml b/Documentation/devicetree/bindings/sound/everest,es8326.yaml > new file mode 100755 > index 000000000000..f6aa3c03d456 > --- /dev/null > +++ b/Documentation/devicetree/bindings/sound/everest,es8326.yaml > @@ -0,0 +1,84 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/sound/everest,es8326.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Everest ES8326 audio CODEC > + > +maintainers: > + - David Yang <yangxiaohua@everest-semi.com> > + > +properties: > + compatible: > + const: everest,es8326 > + > + reg: > + maxItems: 1 > + > + clocks: > + items: > + - description: clock for master clock (MCLK) > + > + clock-names: > + items: > + - const: mclk > + > + "#sound-dai-cells": > + const: 0 > + > + everest,jack-pol: > + description: > + just the value of reg 57. Bit(3) decides whether the jack polarity is inverted. > + Bit(2) decides whether the bottom on the headset is inverted. s/bottom/button/? > + Bit(1)/(0) decides the mic properity to be OMTP/CTIA or auto. > + $ref: /schemas/types.yaml#/definitions/uint8-array Array or... > + minimum: 0 > + maximum: 0x0f > + default: 0x0f Scalar? > + > + everest,mic1-src: > + description: > + the value of reg 2A when headset plugged. > + $ref: /schemas/types.yaml#/definitions/uint8-array > + minimum: 0x00 > + maximum: 0x77 > + default: 0x22 > + > + everest,mic2-src: > + description: > + the value of reg 2A when headset unplugged. > + $ref: /schemas/types.yaml#/definitions/uint8-array > + minimum: 0x00 > + maximum: 0x77 > + default: 0x44 > + > + everest,jack-detect-inverted: > + description: > + Defined to invert the jack detection. What's the difference with this and bit 3 of everest,jack-pol? We already have numerous vendor properties for jack detect. Can we come up with something common? The problem with 'inverted' is it assumes you know the non-inverted state. Better to just state high or low. > + $ref: /schemas/types.yaml#/definitions/flag > + > +required: > + - compatible > + - reg > + - "#sound-dai-cells" > + > + Extra blank line. > +additionalProperties: false > + > +examples: > + - | > + i2c0 { i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + es8326: codec@19 { > + compatible = "everest,es8326"; > + reg = <0x19>; > + clocks = <&clks 10>; > + clock-names = "mclk"; > + #sound-dai-cells = <0>; > + everest,mic1-src = [22]; > + everest,mic2-src = [44]; > + everest,jack-pol = [0e]; > + }; > + }; > -- > 2.36.1 > >
>> + everest,jack-detect-inverted: >> + description: >> + Defined to invert the jack detection. > >What's the difference with this and bit 3 of everest,jack-pol? > >We already have numerous vendor properties for jack detect. Can we come >up with something common? > >The problem with 'inverted' is it assumes you know the non-inverted >state. Better to just state high or low. This property is in compatible with the property in es8316.c and sof_essx8336.c. (which is not documented in es8316.yaml, another problem) There is a quirk in sof_essx8336.c so that when the user find they're having a wrong jack insert configuration, they can set the quirk to invert it.
diff --git a/Documentation/devicetree/bindings/sound/everest,es8326.yaml b/Documentation/devicetree/bindings/sound/everest,es8326.yaml new file mode 100755 index 000000000000..f6aa3c03d456 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/everest,es8326.yaml @@ -0,0 +1,84 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/everest,es8326.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Everest ES8326 audio CODEC + +maintainers: + - David Yang <yangxiaohua@everest-semi.com> + +properties: + compatible: + const: everest,es8326 + + reg: + maxItems: 1 + + clocks: + items: + - description: clock for master clock (MCLK) + + clock-names: + items: + - const: mclk + + "#sound-dai-cells": + const: 0 + + everest,jack-pol: + description: + just the value of reg 57. Bit(3) decides whether the jack polarity is inverted. + Bit(2) decides whether the bottom on the headset is inverted. + Bit(1)/(0) decides the mic properity to be OMTP/CTIA or auto. + $ref: /schemas/types.yaml#/definitions/uint8-array + minimum: 0 + maximum: 0x0f + default: 0x0f + + everest,mic1-src: + description: + the value of reg 2A when headset plugged. + $ref: /schemas/types.yaml#/definitions/uint8-array + minimum: 0x00 + maximum: 0x77 + default: 0x22 + + everest,mic2-src: + description: + the value of reg 2A when headset unplugged. + $ref: /schemas/types.yaml#/definitions/uint8-array + minimum: 0x00 + maximum: 0x77 + default: 0x44 + + everest,jack-detect-inverted: + description: + Defined to invert the jack detection. + $ref: /schemas/types.yaml#/definitions/flag + +required: + - compatible + - reg + - "#sound-dai-cells" + + +additionalProperties: false + +examples: + - | + i2c0 { + #address-cells = <1>; + #size-cells = <0>; + es8326: codec@19 { + compatible = "everest,es8326"; + reg = <0x19>; + clocks = <&clks 10>; + clock-names = "mclk"; + #sound-dai-cells = <0>; + everest,mic1-src = [22]; + everest,mic2-src = [44]; + everest,jack-pol = [0e]; + }; + };