About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / devicetree / bindings / mfd / arizona.txt




Custom Search

Based on kernel version 4.9. Page generated on 2016-12-21 14:30 EST.

1	Cirrus Logic/Wolfson Microelectronics 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	Required properties:
7	
8	  - compatible : One of the following chip-specific strings:
9	        "cirrus,cs47l24"
10	        "wlf,wm5102"
11	        "wlf,wm5110"
12	        "wlf,wm8280"
13	        "wlf,wm8997"
14	        "wlf,wm8998"
15	        "wlf,wm1814"
16	        "wlf,wm1831"
17	
18	  - reg : I2C slave address when connected using I2C, chip select number when
19	    using SPI.
20	
21	  - interrupts : The interrupt line the /IRQ signal for the device is
22	    connected to.
23	  - interrupt-controller : Arizona class devices contain interrupt controllers
24	    and may provide interrupt services to other devices.
25	  - interrupt-parent : The parent interrupt controller.
26	  - #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
27	    The first cell is the IRQ number.
28	    The second cell is the flags, encoded as the trigger masks from
29	    Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
30	
31	  - gpio-controller : Indicates this device is a GPIO controller.
32	  - #gpio-cells : Must be 2. The first cell is the pin number and the
33	    second cell is used to specify optional parameters (currently unused).
34	
35	  - AVDD-supply, DBVDD1-supply, CPVDD-supply : Power supplies for the device,
36	    as covered in Documentation/devicetree/bindings/regulator/regulator.txt
37	
38	  - DBVDD2-supply, DBVDD3-supply : Additional databus power supplies (wm5102,
39	    wm5110, wm8280, wm8998, wm1814)
40	
41	  - SPKVDDL-supply, SPKVDDR-supply : Speaker driver power supplies (wm5102,
42	    wm5110, wm8280, wm8998, wm1814)
43	
44	  - SPKVDD-supply : Speaker driver power supply (wm8997)
45	
46	  - DCVDD-supply : Main power supply (cs47l24, wm1831)
47	
48	  - MICVDD-supply : Microphone power supply (cs47l24, wm1831)
49	
50	Optional properties:
51	
52	  - wlf,reset : GPIO specifier for the GPIO controlling /RESET
53	
54	  - clocks: Should reference the clocks supplied on MCLK1 and MCLK2
55	  - clock-names: Should contains two strings:
56	      "mclk1" for the clock supplied on MCLK1, recommended to be a high
57	      quality audio reference clock
58	      "mclk2" for the clock supplied on MCLK2, recommended to be an always on
59	      32k clock
60	
61	  - wlf,gpio-defaults : A list of GPIO configuration register values. Defines
62	    for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If
63	    absent, no configuration of these registers is performed. If any entry has
64	    a value that is out of range for a 16 bit register then the chip default
65	    will be used. If present exactly five values must be specified.
66	
67	  - wlf,inmode : A list of INn_MODE register values, where n is the number
68	    of input signals. Valid values are 0 (Differential), 1 (Single-ended) and
69	    2 (Digital Microphone). If absent, INn_MODE registers set to 0 by default.
70	    If present, values must be specified less than or equal to the number of
71	    input signals. If values less than the number of input signals, elements
72	    that have not been specified are set to 0 by default. Entries are:
73	    <IN1, IN2, IN3, IN4> (wm5102, wm5110, wm8280, wm8997)
74	    <IN1A, IN2A, IN1B, IN2B> (wm8998, wm1814)
75	  - wlf,out-mono : A list of boolean values indicating whether each output is
76	    mono or stereo. Position within the list indicates the output affected
77	    (eg. First entry in the list corresponds to output 1). A non-zero value
78	    indicates a mono output. If present, the number of values should be less
79	    than or equal to the number of outputs, if less values are supplied the
80	    additional outputs will be treated as stereo.
81	
82	  - wlf,dmic-ref : DMIC reference voltage source for each input, can be
83	    selected from either MICVDD or one of the MICBIAS's, defines
84	    (ARIZONA_DMIC_xxxx) are provided in <dt-bindings/mfd/arizona.txt>. If
85	    present, the number of values should be less than or equal to the
86	    number of inputs, unspecified inputs will use the chip default.
87	
88	  - wlf,max-channels-clocked : The maximum number of channels to be clocked on
89	    each AIF, useful for I2S systems with multiple data lines being mastered.
90	    Specify one cell for each AIF to be configured, specify zero for AIFs that
91	    should be handled normally.
92	    If present, number of cells must be less than or equal to the number of
93	    AIFs. If less than the number of AIFs, for cells that have not been
94	    specified the corresponding AIFs will be treated as default setting.
95	
96	  - wlf,spk-fmt : PDM speaker data format, must contain 2 cells (OUT5 and OUT6).
97	    See the datasheet for values.
98	    The second cell is ignored for codecs that do not have OUT6 (wm5102, wm8997,
99	      wm8998, wm1814)
100	
101	  - wlf,spk-mute : PDM speaker mute setting, must contain 2 cells (OUT5 and OUT6).
102	    See the datasheet for values.
103	    The second cell is ignored for codecs that do not have OUT6 (wm5102, wm8997,
104	    wm8998, wm1814)
105	
106	  - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if
107	    they are being externally supplied. As covered in
108	    Documentation/devicetree/bindings/regulator/regulator.txt
109	    (wm5102, wm5110, wm8280, wm8997, wm8998, wm1814)
110	
111	Also see child specific device properties:
112	  Regulator - ../regulator/arizona-regulator.txt
113	  Extcon    - ../extcon/extcon-arizona.txt
114	
115	Example:
116	
117	codec: wm5102@1a {
118		compatible = "wlf,wm5102";
119		reg = <0x1a>;
120		interrupts = <347>;
121		interrupt-controller;
122		#interrupt-cells = <2>;
123	        interrupt-parent = <&gic>;
124	
125		gpio-controller;
126		#gpio-cells = <2>;
127	
128		wlf,gpio-defaults = <
129			ARIZONA_GP_FN_TXLRCLK
130			ARIZONA_GP_DEFAULT
131			ARIZONA_GP_DEFAULT
132			ARIZONA_GP_DEFAULT
133			ARIZONA_GP_DEFAULT
134		>;
135	};
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.