Merge tag 'for-v4.8' of git://git.kernel.org/pub/scm/linux/kernel/git/sre/linux-power...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / extcon / extcon-arizona.txt
1 Cirrus Logic Arizona class audio SoCs
2
3 These devices are audio SoCs with extensive digital capabilities and a range
4 of analogue I/O.
5
6 This document lists Extcon specific bindings, see the primary binding document:
7   ../mfd/arizona.txt
8
9 Optional properties:
10
11   - wlf,hpdet-channel : Headphone detection channel.
12     ARIZONA_ACCDET_MODE_HPL or 1 - Headphone detect mode is set to HPDETL
13     ARIZONA_ACCDET_MODE_HPR or 2 - Headphone detect mode is set to HPDETR
14     If this node is not mentioned or if the value is unknown, then
15     headphone detection mode is set to HPDETL.
16
17   - wlf,use-jd2 : Use the additional JD input along with JD1 for dual pin jack
18     detection.
19   - wlf,use-jd2-nopull : Internal pull on JD2 is disabled when used for
20     jack detection.
21   - wlf,jd-invert : Invert the polarity of the jack detection switch
22
23   - wlf,micd-software-compare : Use a software comparison to determine mic
24     presence
25   - wlf,micd-detect-debounce : Additional software microphone detection
26     debounce specified in milliseconds.
27   - wlf,micd-pol-gpio : GPIO specifier for the GPIO controlling the headset
28     polarity if one exists.
29   - wlf,micd-bias-start-time : Time allowed for MICBIAS to startup prior to
30     performing microphone detection, specified as per the ARIZONA_MICD_TIME_XXX
31     defines.
32   - wlf,micd-rate : Delay between successive microphone detection measurements,
33     specified as per the ARIZONA_MICD_TIME_XXX defines.
34   - wlf,micd-dbtime : Microphone detection hardware debounces specified as the
35     number of measurements to take, valid values being 2 and 4.
36   - wlf,micd-timeout-ms : Timeout for microphone detection, specified in
37     milliseconds.
38   - wlf,micd-force-micbias : Force MICBIAS continuously on during microphone
39     detection.
40   - wlf,micd-configs : Headset polarity configurations (generally used for
41     detection of CTIA / OMTP headsets), the field can be of variable length
42     but should always be a multiple of 3 cells long, each three cell group
43     represents one polarity configuration.
44     The first cell defines the accessory detection pin, zero will use MICDET1
45     and all other values will use MICDET2.
46     The second cell represents the MICBIAS to be used.
47     The third cell represents the value of the micd-pol-gpio pin.
48
49   - wlf,gpsw : Settings for the general purpose switch, set as one of the
50     ARIZONA_GPSW_XXX defines.
51
52 Example:
53
54 codec: wm8280@0 {
55         compatible = "wlf,wm8280";
56         reg = <0>;
57         ...
58
59         wlf,use-jd2;
60         wlf,use-jd2-nopull;
61         wlf,jd-invert;
62
63         wlf,micd-software-compare;
64         wlf,micd-detect-debounce = <0>;
65         wlf,micd-pol-gpio = <&codec 2 0>;
66         wlf,micd-rate = <ARIZONA_MICD_TIME_8MS>;
67         wlf,micd-dbtime = <4>;
68         wlf,micd-timeout-ms = <100>;
69         wlf,micd-force-micbias;
70         wlf,micd-configs = <
71                 0 1 0 /* MICDET1 MICBIAS1 GPIO=low */
72                 1 2 1 /* MICDET2 MICBIAS2 GPIO=high */
73         >;
74
75         wlf,gpsw = <0>;
76 };