1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * linux/sound/wm8903.h -- Platform data for WM8903
4 *
5 * Copyright 2010 Wolfson Microelectronics. PLC.
6 */
7
8 #ifndef __LINUX_SND_WM8903_H
9 #define __LINUX_SND_WM8903_H
10
11 /*
12 * Used to enable configuration of a GPIO to all zeros; a gpio_cfg value of
13 * zero in platform data means "don't touch this pin".
14 */
15 #define WM8903_GPIO_CONFIG_ZERO 0x8000
16
17 /*
18 * R6 (0x06) - Mic Bias Control 0
19 */
20 #define WM8903_MICDET_THR_MASK 0x0030 /* MICDET_THR - [5:4] */
21 #define WM8903_MICDET_THR_SHIFT 4 /* MICDET_THR - [5:4] */
22 #define WM8903_MICDET_THR_WIDTH 2 /* MICDET_THR - [5:4] */
23 #define WM8903_MICSHORT_THR_MASK 0x000C /* MICSHORT_THR - [3:2] */
24 #define WM8903_MICSHORT_THR_SHIFT 2 /* MICSHORT_THR - [3:2] */
25 #define WM8903_MICSHORT_THR_WIDTH 2 /* MICSHORT_THR - [3:2] */
26 #define WM8903_MICDET_ENA 0x0002 /* MICDET_ENA */
27 #define WM8903_MICDET_ENA_MASK 0x0002 /* MICDET_ENA */
28 #define WM8903_MICDET_ENA_SHIFT 1 /* MICDET_ENA */
29 #define WM8903_MICDET_ENA_WIDTH 1 /* MICDET_ENA */
30 #define WM8903_MICBIAS_ENA 0x0001 /* MICBIAS_ENA */
31 #define WM8903_MICBIAS_ENA_MASK 0x0001 /* MICBIAS_ENA */
32 #define WM8903_MICBIAS_ENA_SHIFT 0 /* MICBIAS_ENA */
33 #define WM8903_MICBIAS_ENA_WIDTH 1 /* MICBIAS_ENA */
34
35 /*
36 * WM8903_GPn_FN values
37 *
38 * See datasheets for list of valid values per pin
39 */
40 #define WM8903_GPn_FN_GPIO_OUTPUT 0
41 #define WM8903_GPn_FN_BCLK 1
42 #define WM8903_GPn_FN_IRQ_OUTPT 2
43 #define WM8903_GPn_FN_GPIO_INPUT 3
44 #define WM8903_GPn_FN_MICBIAS_CURRENT_DETECT 4
45 #define WM8903_GPn_FN_MICBIAS_SHORT_DETECT 5
46 #define WM8903_GPn_FN_DMIC_LR_CLK_OUTPUT 6
47 #define WM8903_GPn_FN_FLL_LOCK_OUTPUT 8
48 #define WM8903_GPn_FN_FLL_CLOCK_OUTPUT 9
49
50 /*
51 * R116 (0x74) - GPIO Control 1
52 */
53 #define WM8903_GP1_FN_MASK 0x1F00 /* GP1_FN - [12:8] */
54 #define WM8903_GP1_FN_SHIFT 8 /* GP1_FN - [12:8] */
55 #define WM8903_GP1_FN_WIDTH 5 /* GP1_FN - [12:8] */
56 #define WM8903_GP1_DIR 0x0080 /* GP1_DIR */
57 #define WM8903_GP1_DIR_MASK 0x0080 /* GP1_DIR */
58 #define WM8903_GP1_DIR_SHIFT 7 /* GP1_DIR */
59 #define WM8903_GP1_DIR_WIDTH 1 /* GP1_DIR */
60 #define WM8903_GP1_OP_CFG 0x0040 /* GP1_OP_CFG */
61 #define WM8903_GP1_OP_CFG_MASK 0x0040 /* GP1_OP_CFG */
62 #define WM8903_GP1_OP_CFG_SHIFT 6 /* GP1_OP_CFG */
63 #define WM8903_GP1_OP_CFG_WIDTH 1 /* GP1_OP_CFG */
64 #define WM8903_GP1_IP_CFG 0x0020 /* GP1_IP_CFG */
65 #define WM8903_GP1_IP_CFG_MASK 0x0020 /* GP1_IP_CFG */
66 #define WM8903_GP1_IP_CFG_SHIFT 5 /* GP1_IP_CFG */
67 #define WM8903_GP1_IP_CFG_WIDTH 1 /* GP1_IP_CFG */
68 #define WM8903_GP1_LVL 0x0010 /* GP1_LVL */
69 #define WM8903_GP1_LVL_MASK 0x0010 /* GP1_LVL */
70 #define WM8903_GP1_LVL_SHIFT 4 /* GP1_LVL */
71 #define WM8903_GP1_LVL_WIDTH 1 /* GP1_LVL */
72 #define WM8903_GP1_PD 0x0008 /* GP1_PD */
73 #define WM8903_GP1_PD_MASK 0x0008 /* GP1_PD */
74 #define WM8903_GP1_PD_SHIFT 3 /* GP1_PD */
75 #define WM8903_GP1_PD_WIDTH 1 /* GP1_PD */
76 #define WM8903_GP1_PU 0x0004 /* GP1_PU */
77 #define WM8903_GP1_PU_MASK 0x0004 /* GP1_PU */
78 #define WM8903_GP1_PU_SHIFT 2 /* GP1_PU */
79 #define WM8903_GP1_PU_WIDTH 1 /* GP1_PU */
80 #define WM8903_GP1_INTMODE 0x0002 /* GP1_INTMODE */
81 #define WM8903_GP1_INTMODE_MASK 0x0002 /* GP1_INTMODE */
82 #define WM8903_GP1_INTMODE_SHIFT 1 /* GP1_INTMODE */
83 #define WM8903_GP1_INTMODE_WIDTH 1 /* GP1_INTMODE */
84 #define WM8903_GP1_DB 0x0001 /* GP1_DB */
85 #define WM8903_GP1_DB_MASK 0x0001 /* GP1_DB */
86 #define WM8903_GP1_DB_SHIFT 0 /* GP1_DB */
87 #define WM8903_GP1_DB_WIDTH 1 /* GP1_DB */
88
89 /*
90 * R117 (0x75) - GPIO Control 2
91 */
92 #define WM8903_GP2_FN_MASK 0x1F00 /* GP2_FN - [12:8] */
93 #define WM8903_GP2_FN_SHIFT 8 /* GP2_FN - [12:8] */
94 #define WM8903_GP2_FN_WIDTH 5 /* GP2_FN - [12:8] */
95 #define WM8903_GP2_DIR 0x0080 /* GP2_DIR */
96 #define WM8903_GP2_DIR_MASK 0x0080 /* GP2_DIR */
97 #define WM8903_GP2_DIR_SHIFT 7 /* GP2_DIR */
98 #define WM8903_GP2_DIR_WIDTH 1 /* GP2_DIR */
99 #define WM8903_GP2_OP_CFG 0x0040 /* GP2_OP_CFG */
100 #define WM8903_GP2_OP_CFG_MASK 0x0040 /* GP2_OP_CFG */
101 #define WM8903_GP2_OP_CFG_SHIFT 6 /* GP2_OP_CFG */
102 #define WM8903_GP2_OP_CFG_WIDTH 1 /* GP2_OP_CFG */
103 #define WM8903_GP2_IP_CFG 0x0020 /* GP2_IP_CFG */
104 #define WM8903_GP2_IP_CFG_MASK 0x0020 /* GP2_IP_CFG */
105 #define WM8903_GP2_IP_CFG_SHIFT 5 /* GP2_IP_CFG */
106 #define WM8903_GP2_IP_CFG_WIDTH 1 /* GP2_IP_CFG */
107 #define WM8903_GP2_LVL 0x0010 /* GP2_LVL */
108 #define WM8903_GP2_LVL_MASK 0x0010 /* GP2_LVL */
109 #define WM8903_GP2_LVL_SHIFT 4 /* GP2_LVL */
110 #define WM8903_GP2_LVL_WIDTH 1 /* GP2_LVL */
111 #define WM8903_GP2_PD 0x0008 /* GP2_PD */
112 #define WM8903_GP2_PD_MASK 0x0008 /* GP2_PD */
113 #define WM8903_GP2_PD_SHIFT 3 /* GP2_PD */
114 #define WM8903_GP2_PD_WIDTH 1 /* GP2_PD */
115 #define WM8903_GP2_PU 0x0004 /* GP2_PU */
116 #define WM8903_GP2_PU_MASK 0x0004 /* GP2_PU */
117 #define WM8903_GP2_PU_SHIFT 2 /* GP2_PU */
118 #define WM8903_GP2_PU_WIDTH 1 /* GP2_PU */
119 #define WM8903_GP2_INTMODE 0x0002 /* GP2_INTMODE */
120 #define WM8903_GP2_INTMODE_MASK 0x0002 /* GP2_INTMODE */
121 #define WM8903_GP2_INTMODE_SHIFT 1 /* GP2_INTMODE */
122 #define WM8903_GP2_INTMODE_WIDTH 1 /* GP2_INTMODE */
123 #define WM8903_GP2_DB 0x0001 /* GP2_DB */
124 #define WM8903_GP2_DB_MASK 0x0001 /* GP2_DB */
125 #define WM8903_GP2_DB_SHIFT 0 /* GP2_DB */
126 #define WM8903_GP2_DB_WIDTH 1 /* GP2_DB */
127
128 /*
129 * R118 (0x76) - GPIO Control 3
130 */
131 #define WM8903_GP3_FN_MASK 0x1F00 /* GP3_FN - [12:8] */
132 #define WM8903_GP3_FN_SHIFT 8 /* GP3_FN - [12:8] */
133 #define WM8903_GP3_FN_WIDTH 5 /* GP3_FN - [12:8] */
134 #define WM8903_GP3_DIR 0x0080 /* GP3_DIR */
135 #define WM8903_GP3_DIR_MASK 0x0080 /* GP3_DIR */
136 #define WM8903_GP3_DIR_SHIFT 7 /* GP3_DIR */
137 #define WM8903_GP3_DIR_WIDTH 1 /* GP3_DIR */
138 #define WM8903_GP3_OP_CFG 0x0040 /* GP3_OP_CFG */
139 #define WM8903_GP3_OP_CFG_MASK 0x0040 /* GP3_OP_CFG */
140 #define WM8903_GP3_OP_CFG_SHIFT 6 /* GP3_OP_CFG */
141 #define WM8903_GP3_OP_CFG_WIDTH 1 /* GP3_OP_CFG */
142 #define WM8903_GP3_IP_CFG 0x0020 /* GP3_IP_CFG */
143 #define WM8903_GP3_IP_CFG_MASK 0x0020 /* GP3_IP_CFG */
144 #define WM8903_GP3_IP_CFG_SHIFT 5 /* GP3_IP_CFG */
145 #define WM8903_GP3_IP_CFG_WIDTH 1 /* GP3_IP_CFG */
146 #define WM8903_GP3_LVL 0x0010 /* GP3_LVL */
147 #define WM8903_GP3_LVL_MASK 0x0010 /* GP3_LVL */
148 #define WM8903_GP3_LVL_SHIFT 4 /* GP3_LVL */
149 #define WM8903_GP3_LVL_WIDTH 1 /* GP3_LVL */
150 #define WM8903_GP3_PD 0x0008 /* GP3_PD */
151 #define WM8903_GP3_PD_MASK 0x0008 /* GP3_PD */
152 #define WM8903_GP3_PD_SHIFT 3 /* GP3_PD */
153 #define WM8903_GP3_PD_WIDTH 1 /* GP3_PD */
154 #define WM8903_GP3_PU 0x0004 /* GP3_PU */
155 #define WM8903_GP3_PU_MASK 0x0004 /* GP3_PU */
156 #define WM8903_GP3_PU_SHIFT 2 /* GP3_PU */
157 #define WM8903_GP3_PU_WIDTH 1 /* GP3_PU */
158 #define WM8903_GP3_INTMODE 0x0002 /* GP3_INTMODE */
159 #define WM8903_GP3_INTMODE_MASK 0x0002 /* GP3_INTMODE */
160 #define WM8903_GP3_INTMODE_SHIFT 1 /* GP3_INTMODE */
161 #define WM8903_GP3_INTMODE_WIDTH 1 /* GP3_INTMODE */
162 #define WM8903_GP3_DB 0x0001 /* GP3_DB */
163 #define WM8903_GP3_DB_MASK 0x0001 /* GP3_DB */
164 #define WM8903_GP3_DB_SHIFT 0 /* GP3_DB */
165 #define WM8903_GP3_DB_WIDTH 1 /* GP3_DB */
166
167 /*
168 * R119 (0x77) - GPIO Control 4
169 */
170 #define WM8903_GP4_FN_MASK 0x1F00 /* GP4_FN - [12:8] */
171 #define WM8903_GP4_FN_SHIFT 8 /* GP4_FN - [12:8] */
172 #define WM8903_GP4_FN_WIDTH 5 /* GP4_FN - [12:8] */
173 #define WM8903_GP4_DIR 0x0080 /* GP4_DIR */
174 #define WM8903_GP4_DIR_MASK 0x0080 /* GP4_DIR */
175 #define WM8903_GP4_DIR_SHIFT 7 /* GP4_DIR */
176 #define WM8903_GP4_DIR_WIDTH 1 /* GP4_DIR */
177 #define WM8903_GP4_OP_CFG 0x0040 /* GP4_OP_CFG */
178 #define WM8903_GP4_OP_CFG_MASK 0x0040 /* GP4_OP_CFG */
179 #define WM8903_GP4_OP_CFG_SHIFT 6 /* GP4_OP_CFG */
180 #define WM8903_GP4_OP_CFG_WIDTH 1 /* GP4_OP_CFG */
181 #define WM8903_GP4_IP_CFG 0x0020 /* GP4_IP_CFG */
182 #define WM8903_GP4_IP_CFG_MASK 0x0020 /* GP4_IP_CFG */
183 #define WM8903_GP4_IP_CFG_SHIFT 5 /* GP4_IP_CFG */
184 #define WM8903_GP4_IP_CFG_WIDTH 1 /* GP4_IP_CFG */
185 #define WM8903_GP4_LVL 0x0010 /* GP4_LVL */
186 #define WM8903_GP4_LVL_MASK 0x0010 /* GP4_LVL */
187 #define WM8903_GP4_LVL_SHIFT 4 /* GP4_LVL */
188 #define WM8903_GP4_LVL_WIDTH 1 /* GP4_LVL */
189 #define WM8903_GP4_PD 0x0008 /* GP4_PD */
190 #define WM8903_GP4_PD_MASK 0x0008 /* GP4_PD */
191 #define WM8903_GP4_PD_SHIFT 3 /* GP4_PD */
192 #define WM8903_GP4_PD_WIDTH 1 /* GP4_PD */
193 #define WM8903_GP4_PU 0x0004 /* GP4_PU */
194 #define WM8903_GP4_PU_MASK 0x0004 /* GP4_PU */
195 #define WM8903_GP4_PU_SHIFT 2 /* GP4_PU */
196 #define WM8903_GP4_PU_WIDTH 1 /* GP4_PU */
197 #define WM8903_GP4_INTMODE 0x0002 /* GP4_INTMODE */
198 #define WM8903_GP4_INTMODE_MASK 0x0002 /* GP4_INTMODE */
199 #define WM8903_GP4_INTMODE_SHIFT 1 /* GP4_INTMODE */
200 #define WM8903_GP4_INTMODE_WIDTH 1 /* GP4_INTMODE */
201 #define WM8903_GP4_DB 0x0001 /* GP4_DB */
202 #define WM8903_GP4_DB_MASK 0x0001 /* GP4_DB */
203 #define WM8903_GP4_DB_SHIFT 0 /* GP4_DB */
204 #define WM8903_GP4_DB_WIDTH 1 /* GP4_DB */
205
206 /*
207 * R120 (0x78) - GPIO Control 5
208 */
209 #define WM8903_GP5_FN_MASK 0x1F00 /* GP5_FN - [12:8] */
210 #define WM8903_GP5_FN_SHIFT 8 /* GP5_FN - [12:8] */
211 #define WM8903_GP5_FN_WIDTH 5 /* GP5_FN - [12:8] */
212 #define WM8903_GP5_DIR 0x0080 /* GP5_DIR */
213 #define WM8903_GP5_DIR_MASK 0x0080 /* GP5_DIR */
214 #define WM8903_GP5_DIR_SHIFT 7 /* GP5_DIR */
215 #define WM8903_GP5_DIR_WIDTH 1 /* GP5_DIR */
216 #define WM8903_GP5_OP_CFG 0x0040 /* GP5_OP_CFG */
217 #define WM8903_GP5_OP_CFG_MASK 0x0040 /* GP5_OP_CFG */
218 #define WM8903_GP5_OP_CFG_SHIFT 6 /* GP5_OP_CFG */
219 #define WM8903_GP5_OP_CFG_WIDTH 1 /* GP5_OP_CFG */
220 #define WM8903_GP5_IP_CFG 0x0020 /* GP5_IP_CFG */
221 #define WM8903_GP5_IP_CFG_MASK 0x0020 /* GP5_IP_CFG */
222 #define WM8903_GP5_IP_CFG_SHIFT 5 /* GP5_IP_CFG */
223 #define WM8903_GP5_IP_CFG_WIDTH 1 /* GP5_IP_CFG */
224 #define WM8903_GP5_LVL 0x0010 /* GP5_LVL */
225 #define WM8903_GP5_LVL_MASK 0x0010 /* GP5_LVL */
226 #define WM8903_GP5_LVL_SHIFT 4 /* GP5_LVL */
227 #define WM8903_GP5_LVL_WIDTH 1 /* GP5_LVL */
228 #define WM8903_GP5_PD 0x0008 /* GP5_PD */
229 #define WM8903_GP5_PD_MASK 0x0008 /* GP5_PD */
230 #define WM8903_GP5_PD_SHIFT 3 /* GP5_PD */
231 #define WM8903_GP5_PD_WIDTH 1 /* GP5_PD */
232 #define WM8903_GP5_PU 0x0004 /* GP5_PU */
233 #define WM8903_GP5_PU_MASK 0x0004 /* GP5_PU */
234 #define WM8903_GP5_PU_SHIFT 2 /* GP5_PU */
235 #define WM8903_GP5_PU_WIDTH 1 /* GP5_PU */
236 #define WM8903_GP5_INTMODE 0x0002 /* GP5_INTMODE */
237 #define WM8903_GP5_INTMODE_MASK 0x0002 /* GP5_INTMODE */
238 #define WM8903_GP5_INTMODE_SHIFT 1 /* GP5_INTMODE */
239 #define WM8903_GP5_INTMODE_WIDTH 1 /* GP5_INTMODE */
240 #define WM8903_GP5_DB 0x0001 /* GP5_DB */
241 #define WM8903_GP5_DB_MASK 0x0001 /* GP5_DB */
242 #define WM8903_GP5_DB_SHIFT 0 /* GP5_DB */
243 #define WM8903_GP5_DB_WIDTH 1 /* GP5_DB */
244
245 #define WM8903_NUM_GPIO 5
246
247 struct wm8903_platform_data {
248 bool irq_active_low; /* Set if IRQ active low, default high */
249
250 /* Default register value for R6 (Mic bias), used to configure
251 * microphone detection. In conjunction with gpio_cfg this
252 * can be used to route the microphone status signals out onto
253 * the GPIOs for use with snd_soc_jack_add_gpios().
254 */
255 u16 micdet_cfg;
256
257 int micdet_delay; /* Delay after microphone detection (ms) */
258
259 int gpio_base;
260 u32 gpio_cfg[WM8903_NUM_GPIO]; /* Default register values for GPIO pin mux */
261 };
262
263 #endif
264
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.