ASoC: dt-bindings: nau8825: Convert to dtschema
Subsystems (2)
PATCH v3 1/1 ASoC: dt-bindings: nau8825: Convert to dtschema
Convert the NAU8825 audio CODEC bindings to DT schema.
Changes:
V2 -> V3:
- refine node name from "nau8825" to "codec" for generic purpose
V1 -> V2:
- add interrupts properties
- add maximum to nuvoton,jack-insert-debounce and nuvoton,jack-eject-debounce properites
- add a enum item for nuvoton,short-key-debounce properites
- add default value for most properites
- add maxItems to clocks properites and mclk entries to clock-names properites
- refine wrong indentation from clocks and clock-names
- refine dts example for interrupts and clocks
- remove headset label from dts example
--- .../devicetree/bindings/sound/nau8825.txt | 111 -------- .../bindings/sound/nuvoton,nau8825.yaml | 242 ++++++++++++++++++ 2 files changed, 242 insertions(+), 111 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/nau8825.txt create mode 100644 Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml
Documentation/devicetree/bindings/sound/nau8825.txt deleted +0 -111
@@ -1,111 +0,0 @@ -Nuvoton NAU8825 audio codec - -This device supports I2C only. - -Required properties: - - compatible : Must be "nuvoton,nau8825" - - - reg : the I2C address of the device. This is either 0x1a (CSB=0) or 0x1b (CSB=1). - -Optional properties: - - nuvoton,jkdet-enable: Enable jack detection via JKDET pin. - - nuvoton,jkdet-pull-enable: Enable JKDET pin pull. If set - pin pull enabled, - otherwise pin in high impedance state. - - nuvoton,jkdet-pull-up: Pull-up JKDET pin. If set then JKDET pin is pull up, otherwise pull down. - - nuvoton,jkdet-polarity: JKDET pin polarity. 0 - active high, 1 - active low. - - - nuvoton,vref-impedance: VREF Impedance selection - 0 - Open - 1 - 25 kOhm - 2 - 125 kOhm - 3 - 2.5 kOhm - - - nuvoton,micbias-voltage: Micbias voltage level. - 0 - VDDA - 1 - VDDA - 2 - VDDA * 1.1 - 3 - VDDA * 1.2 - 4 - VDDA * 1.3 - 5 - VDDA * 1.4 - 6 - VDDA * 1.53 - 7 - VDDA * 1.53 - - - nuvoton,sar-threshold-num: Number of buttons supported - - nuvoton,sar-threshold: Impedance threshold for each button. Array that contains up to 8 buttons configuration. SAR value is calculated as - SAR = 255 * MICBIAS / SAR_VOLTAGE * R / (2000 + R) - where MICBIAS is configured by 'nuvoton,micbias-voltage', SAR_VOLTAGE is configured by 'nuvoton,sar-voltage', R - button impedance. - Refer datasheet section 10.2 for more information about threshold calculation. - - - nuvoton,sar-hysteresis: Button impedance measurement hysteresis. - - - nuvoton,sar-voltage: Reference voltage for button impedance measurement. - 0 - VDDA - 1 - VDDA - 2 - VDDA * 1.1 - 3 - VDDA * 1.2 - 4 - VDDA * 1.3 - 5 - VDDA * 1.4 - 6 - VDDA * 1.53 - 7 - VDDA * 1.53 - - - nuvoton,sar-compare-time: SAR compare time - 0 - 500 ns - 1 - 1 us - 2 - 2 us - 3 - 4 us - - - nuvoton,sar-sampling-time: SAR sampling time - 0 - 2 us - 1 - 4 us - 2 - 8 us - 3 - 16 us - - - nuvoton,short-key-debounce: Button short key press debounce time. - 0 - 30 ms - 1 - 50 ms - 2 - 100 ms - 3 - 30 ms - - - nuvoton,jack-insert-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms - - nuvoton,jack-eject-debounce: number from 0 to 7 that sets debounce time to 2^(n+2) ms - - - nuvoton,crosstalk-enable: make crosstalk function enable if set. - - - nuvoton,adcout-drive-strong: make the drive strength of ADCOUT IO PIN strong if set. - Otherwise, the drive keeps normal strength. - - - nuvoton,adc-delay-ms: Delay (in ms) to make input path stable and avoid pop noise. The - default value is 125 and range between 125 to 500 ms. - - - clocks: list of phandle and clock specifier pairs according to common clock bindings for the - clocks described in clock-names - - clock-names: should include "mclk" for the MCLK master clock - -Example: - - headset: nau8825@1a { - compatible = "nuvoton,nau8825"; - reg = <0x1a>; - interrupt-parent = <&gpio>; - interrupts = <TEGRA_GPIO(E, 6) IRQ_TYPE_LEVEL_LOW>; - nuvoton,jkdet-enable; - nuvoton,jkdet-pull-enable; - nuvoton,jkdet-pull-up; - nuvoton,jkdet-polarity = <GPIO_ACTIVE_LOW>; - nuvoton,vref-impedance = <2>; - nuvoton,micbias-voltage = <6>; - // Setup 4 buttons impedance according to Android specification - nuvoton,sar-threshold-num = <4>; - nuvoton,sar-threshold = <0xc 0x1e 0x38 0x60>; - nuvoton,sar-hysteresis = <1>; - nuvoton,sar-voltage = <0>; - nuvoton,sar-compare-time = <0>; - nuvoton,sar-sampling-time = <0>; - nuvoton,short-key-debounce = <2>; - nuvoton,jack-insert-debounce = <7>; - nuvoton,jack-eject-debounce = <7>; - nuvoton,crosstalk-enable; - - clock-names = "mclk"; - clocks = <&tegra_pmc TEGRA_PMC_CLK_OUT_2>; - };
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +242 -0
242 lines not on this page · raw message
Signature · 1 line
2.25.1
Quoted 8 lines · David Lin
Convert the NAU8825 audio CODEC bindings to DT schema.
Signed-off-by David Lin <[email protected]>Changes:
V2 -> V3:
- refine node name from "nau8825" to "codec" for generic purpose
Quoted 9 lines
V1 -> V2:
- add interrupts properties
- add maximum to nuvoton,jack-insert-debounce and nuvoton,jack-eject-debounce properites
- add a enum item for nuvoton,short-key-debounce properites
- add default value for most properites
- add maxItems to clocks properites and mclk entries to clock-names properites
- refine wrong indentation from clocks and clock-names
- refine dts example for interrupts and clocks
- remove headset label from dts example
Thanks.
Still few nits.
...
Quoted 11 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +11
-0+ +title: NAU8825 audio CODEC + +maintainers: + - John Hsu <[email protected]> + +allOf: + - $ref: dai-common.yaml# + +properties: + compatible:
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 26
Quoted 10 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +10
-0+ enum: + - nuvoton,nau8825 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + description: + The CODEC's interrupt output.
Drop description.
Quoted 158 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +158
-0+ + nuvoton,jkdet-enable: + description: + Enable jack detection via JKDET pin. + type: boolean + + nuvoton,jkdet-pull-enable: + description: + Enable JKDET pin pull. + If set - pin pull enabled, otherwise pin in high impedance state. + type: boolean + + nuvoton,jkdet-pull-up: + description: + Pull-up JKDET pin. + If set then JKDET pin is pull up, otherwise pull down. + type: boolean + + nuvoton,jkdet-polarity: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + JKDET pin polarity. + enum: + - 0 # active high + - 1 # active low + default: 1 + + nuvoton,vref-impedance: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + VREF Impedance selection. + enum: + - 0 # Open + - 1 # 25 kOhm + - 2 # 125 kOhm + - 3 # 2.5 kOhm + default: 2 + + nuvoton,micbias-voltage: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Micbias voltage level. + enum: + - 0 # VDDA + - 1 # VDDA + - 2 # VDDA * 1.1 + - 3 # VDDA * 1.2 + - 4 # VDDA * 1.3 + - 5 # VDDA * 1.4 + - 6 # VDDA * 1.53 + - 7 # VDDA * 1.53 + default: 6 + + nuvoton,sar-threshold-num: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Number of buttons supported. + minimum: 1 + maximum: 4 + default: 4 + + nuvoton,sar-threshold: + $ref: /schemas/types.yaml#/definitions/uint32-array + description: + Impedance threshold for each button. Array that contains up to 8 buttons + configuration. SAR value is calculated as + SAR = 255 * MICBIAS / SAR_VOLTAGE * R / (2000 + R) where MICBIAS is + configured by 'nuvoton,micbias-voltage', SAR_VOLTAGE is configured by + 'nuvoton,sar-voltage', R - button impedance. + Refer datasheet section 10.2 for more information about threshold + calculation. + minItems: 1 + maxItems: 4 + items: + minimum: 0 + maximum: 255 + + nuvoton,sar-hysteresis: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Button impedance measurement hysteresis. + default: 0 + + nuvoton,sar-voltage: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Reference voltage for button impedance measurement. + enum: + - 0 # VDDA + - 1 # VDDA + - 2 # VDDA * 1.1 + - 3 # VDDA * 1.2 + - 4 # VDDA * 1.3 + - 5 # VDDA * 1.4 + - 6 # VDDA * 1.53 + - 7 # VDDA * 1.53 + default: 6 + + nuvoton,sar-compare-time: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + SAR compare time. + enum: + - 0 # 500 ns + - 1 # 1 us + - 2 # 2 us + - 3 # 4 us + default: 1 + + nuvoton,sar-sampling-time: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + SAR sampling time. + enum: + - 0 # 2 us + - 1 # 4 us + - 2 # 8 us + - 3 # 16 us + default: 1 + + nuvoton,short-key-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Button short key press debounce time. + enum: + - 0 # 30 ms + - 1 # 50 ms + - 2 # 100 ms + - 3 # 30 ms + default: 3 + + nuvoton,jack-insert-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + number from 0 to 7 that sets debounce time to 2^(n+2) ms. + maximum: 7 + default: 7 + + nuvoton,jack-eject-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + number from 0 to 7 that sets debounce time to 2^(n+2) ms + maximum: 7 + default: 0 + + nuvoton,crosstalk-enable: + description: + make crosstalk function enable if set. + type: boolean + + nuvoton,adcout-drive-strong: + description: + make the drive strength of ADCOUT IO PIN strong if set. + Otherwise, the drive keeps normal strength. + type: boolean + + nuvoton,adc-delay-ms: + description:
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 194
Quoted 10 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +10
-0+ Delay (in ms) to make input path stable and avoid pop noise. + The default value is 125 and range between 125 to 500 ms. + minimum: 125 + maximum: 500 + default: 125 + + clocks: + description: + list of phandle and clock specifier pairs according to common clock + bindings for the clocks described in clock-names.
Drop desription.
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 199
Quoted 5 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +5
-0+ maxItems: 1 + + clock-names: + description: + should include "mclk" for the MCLK master clock.
Drop description.
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 201
Quoted 2 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +2
-0+ items: + - const: mclk
You probably want also sound-dai-cells.
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 207
Quoted 6 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +6
-0+ +required: + - compatible + - reg + +unevaluatedProperties: false
Best regards,
Krzysztof
Quoted 39 lines · Krzysztof Kozlowski
Quoted 8 lines · David Lin
Convert the NAU8825 audio CODEC bindings to DT schema.
Signed-off-by David Lin <[email protected]>Changes:
V2 -> V3:
- refine node name from "nau8825" to "codec" for generic purposeQuoted 9 lines
V1 -> V2:
- add interrupts properties
- add maximum to nuvoton,jack-insert-debounce and nuvoton,jack-eject-debounce properites
- add a enum item for nuvoton,short-key-debounce properites
- add default value for most properites
- add maxItems to clocks properites and mclk entries to clock-names properites
- refine wrong indentation from clocks and clock-names
- refine dts example for interrupts and clocks
- remove headset label from dts exampleThanks.
Still few nits.
...
Quoted 14 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +14
-0+ +title: NAU8825 audio CODEC + +maintainers: + - John Hsu <[email protected]> + +allOf: + - $ref: dai-common.yaml# + +properties: + compatible: + enum: + - nuvoton,nau8825 +
Quoted 8 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 26
Quoted 7 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +7
-0+ reg: + maxItems: 1 + + interrupts: + maxItems: 1 + description: + The CODEC's interrupt output.Drop description.
OK.
Quoted 161 lines
Quoted 161 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +161
-0+ + nuvoton,jkdet-enable: + description: + Enable jack detection via JKDET pin. + type: boolean + + nuvoton,jkdet-pull-enable: + description: + Enable JKDET pin pull. + If set - pin pull enabled, otherwise pin in high impedance state. + type: boolean + + nuvoton,jkdet-pull-up: + description: + Pull-up JKDET pin. + If set then JKDET pin is pull up, otherwise pull down. + type: boolean + + nuvoton,jkdet-polarity: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + JKDET pin polarity. + enum: + - 0 # active high + - 1 # active low + default: 1 + + nuvoton,vref-impedance: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + VREF Impedance selection. + enum: + - 0 # Open + - 1 # 25 kOhm + - 2 # 125 kOhm + - 3 # 2.5 kOhm + default: 2 + + nuvoton,micbias-voltage: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Micbias voltage level. + enum: + - 0 # VDDA + - 1 # VDDA + - 2 # VDDA * 1.1 + - 3 # VDDA * 1.2 + - 4 # VDDA * 1.3 + - 5 # VDDA * 1.4 + - 6 # VDDA * 1.53 + - 7 # VDDA * 1.53 + default: 6 + + nuvoton,sar-threshold-num: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Number of buttons supported. + minimum: 1 + maximum: 4 + default: 4 + + nuvoton,sar-threshold: + $ref: /schemas/types.yaml#/definitions/uint32-array + description: + Impedance threshold for each button. Array that contains up to 8 buttons + configuration. SAR value is calculated as + SAR = 255 * MICBIAS / SAR_VOLTAGE * R / (2000 + R) where MICBIAS is + configured by 'nuvoton,micbias-voltage', SAR_VOLTAGE is configured by + 'nuvoton,sar-voltage', R - button impedance. + Refer datasheet section 10.2 for more information about threshold + calculation. + minItems: 1 + maxItems: 4 + items: + minimum: 0 + maximum: 255 + + nuvoton,sar-hysteresis: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Button impedance measurement hysteresis. + default: 0 + + nuvoton,sar-voltage: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Reference voltage for button impedance measurement. + enum: + - 0 # VDDA + - 1 # VDDA + - 2 # VDDA * 1.1 + - 3 # VDDA * 1.2 + - 4 # VDDA * 1.3 + - 5 # VDDA * 1.4 + - 6 # VDDA * 1.53 + - 7 # VDDA * 1.53 + default: 6 + + nuvoton,sar-compare-time: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + SAR compare time. + enum: + - 0 # 500 ns + - 1 # 1 us + - 2 # 2 us + - 3 # 4 us + default: 1 + + nuvoton,sar-sampling-time: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + SAR sampling time. + enum: + - 0 # 2 us + - 1 # 4 us + - 2 # 8 us + - 3 # 16 us + default: 1 + + nuvoton,short-key-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Button short key press debounce time. + enum: + - 0 # 30 ms + - 1 # 50 ms + - 2 # 100 ms + - 3 # 30 ms + default: 3 + + nuvoton,jack-insert-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + number from 0 to 7 that sets debounce time to 2^(n+2) ms. + maximum: 7 + default: 7 + + nuvoton,jack-eject-debounce: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + number from 0 to 7 that sets debounce time to 2^(n+2) ms + maximum: 7 + default: 0 + + nuvoton,crosstalk-enable: + description: + make crosstalk function enable if set. + type: boolean + + nuvoton,adcout-drive-strong: + description: + make the drive strength of ADCOUT IO PIN strong if set. + Otherwise, the drive keeps normal strength. + type: boolean + + nuvoton,adc-delay-ms: + description: + Delay (in ms) to make input path stable and avoid pop noise. + The default value is 125 and range between 125 to 500 ms. + minimum: 125
Quoted 8 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 194
Quoted 7 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +7
-0+ maximum: 500 + default: 125 + + clocks: + description: + list of phandle and clock specifier pairs according to common clock + bindings for the clocks described in clock-names.Drop desription.
OK.
Quoted 6 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 199
Quoted 5 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +5
-0+ maxItems: 1 + + clock-names: + description: + should include "mclk" for the MCLK master clock.Drop description.
OK.
Quoted 4 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 201
Quoted 3 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +2
-0+ items: + - const: mclkYou probably want also sound-dai-cells.
I will add '#sound-dai-cells' property and also update dts example.
Quoted 9 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml line 207
Quoted 6 lines
Documentation/devicetree/bindings/sound/nuvoton,nau8825.yaml new file +6
-0+ +required: + - compatible + - reg + +unevaluatedProperties: falseBest regards,
Krzysztof
________________________________
________________________________
The privileged confidential information contained in this email is intended for use only by the addressees as indicated by the original sender of this email. If you are not the addressee indicated in this email or are not responsible for delivery of the email to such a person, please kindly reply to the sender indicating this fact and delete all copies of it from your computer and network server immediately. Your cooperation is highly appreciated. It is advised that any unauthorized use of confidential information of Nuvoton is strictly prohibited; and any information in this email irrelevant to the official business of Nuvoton shall be deemed as neither given nor endorsed by Nuvoton.