bindings/sound/cirrus%2Ccs42l42.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
10   - patches@opensource.cirrus.com
13   The CS42L42 is a low-power audio codec designed for portable applications.
14   It provides a high-dynamic range, stereo DAC for audio playback and a mono
15   high-dynamic-range ADC for audio capture. There is an integrated headset
21       - cirrus,cs42l42
22       - cirrus,cs42l83
29   VP-supply:
33   VCP-supply:
37   VD_FILT-supply:
41   VL-supply:
45   VA-supply:
49   reset-gpios:
60   cirrus,ts-inv:
64       0 - (Default) Shorted to tip when unplugged, open when plugged.
67       1 - Open when unplugged, shorted to tip when plugged.
68       This is "normal tip sense (TS)" in the datasheet.
75   cirrus,ts-dbnc-rise:
80       0 - 0ms
81       1 - 125ms
82       2 - 250ms
83       3 - 500ms
84       4 - 750ms
85       5 - 1s (Default)
86       6 - 1.25s
87       7 - 1.5s
94   cirrus,ts-dbnc-fall:
99       0 - 0ms
100       1 - 125ms
101       2 - 250ms
102       3 - 500ms
103       4 - 750ms
104       5 - 1s (Default)
105       6 - 1.25s
106       7 - 1.5s
113   cirrus,btn-det-init-dbnce:
121       0ms - 200ms,
127   cirrus,btn-det-event-dbnce:
134       0ms - 20ms,
140   cirrus,bias-lvls:
142       For a level-detect headset button scheme, each button will bias
150       Array of 4 values, each 0-63
153     $ref: /schemas/types.yaml#/definitions/uint32-array
160   cirrus,hs-bias-ramp-rate:
162       If present this sets the rate that the HS bias should rise and fall.
163       The actual rise and fall times depend on external hardware (the
164       datasheet gives several rise and fall time examples).
166       0 - Fast rise time; slow, load-dependent fall time
167       1 - Fast
168       2 - Slow (default)
169       3 - Slowest
176   cirrus,hs-bias-sense-disable:
179       current sense through the external 2.21-k resistor. HSBIAS_SENSE
188   - compatible
189   - reg
190   - VP-supply
191   - VCP-supply
192   - VD_FILT-supply
193   - VL-supply
194   - VA-supply
199   - |
200     #include <dt-bindings/sound/cs42l42.h>
202       #address-cells = <1>;
203       #size-cells = <0>;
208           VA-supply = <&dummy_vreg>;
209           VP-supply = <&dummy_vreg>;
210           VCP-supply = <&dummy_vreg>;
211           VD_FILT-supply = <&dummy_vreg>;
212           VL-supply = <&dummy_vreg>;
214           reset-gpios = <&axi_gpio_0 1 0>;
215           interrupt-parent = <&gpio0>;
218           cirrus,ts-inv = <CS42L42_TS_INV_DIS>;
219           cirrus,ts-dbnc-rise = <CS42L42_TS_DBNCE_1000>;
220           cirrus,ts-dbnc-fall = <CS42L42_TS_DBNCE_0>;
221           cirrus,btn-det-init-dbnce = <100>;
222           cirrus,btn-det-event-dbnce = <10>;
223           cirrus,bias-lvls = <0x0F 0x08 0x04 0x01>;
224           cirrus,hs-bias-ramp-rate = <CS42L42_HSBIAS_RAMP_SLOW>;