Commit | Line | Data |
---|---|---|
3a66d387 MB |
1 | /* |
2 | * wm2000.c -- WM2000 ALSA Soc Audio driver | |
3 | * | |
656baaeb | 4 | * Copyright 2008-2011 Wolfson Microelectronics PLC. |
3a66d387 MB |
5 | * |
6 | * Author: Mark Brown <broonie@opensource.wolfsonmicro.com> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | * | |
12 | * The download image for the WM2000 will be requested as | |
13 | * 'wm2000_anc.bin' by default (overridable via platform data) at | |
14 | * runtime and is expected to be in flat binary format. This is | |
15 | * generated by Wolfson configuration tools and includes | |
16 | * system-specific callibration information. If supplied as a | |
17 | * sequence of ASCII-encoded hexidecimal bytes this can be converted | |
18 | * into a flat binary with a command such as this on the command line: | |
19 | * | |
20 | * perl -e 'while (<>) { s/[\r\n]+// ; printf("%c", hex($_)); }' | |
21 | * < file > wm2000_anc.bin | |
22 | */ | |
23 | ||
24 | #include <linux/module.h> | |
25 | #include <linux/moduleparam.h> | |
3a66d387 MB |
26 | #include <linux/kernel.h> |
27 | #include <linux/init.h> | |
28 | #include <linux/firmware.h> | |
514cfd6d | 29 | #include <linux/clk.h> |
3a66d387 MB |
30 | #include <linux/delay.h> |
31 | #include <linux/pm.h> | |
32 | #include <linux/i2c.h> | |
8aa1fe81 | 33 | #include <linux/regmap.h> |
3a66d387 | 34 | #include <linux/debugfs.h> |
a89be93c | 35 | #include <linux/regulator/consumer.h> |
5a0e3ad6 | 36 | #include <linux/slab.h> |
3a66d387 MB |
37 | #include <sound/core.h> |
38 | #include <sound/pcm.h> | |
39 | #include <sound/pcm_params.h> | |
40 | #include <sound/soc.h> | |
3a66d387 MB |
41 | #include <sound/initval.h> |
42 | #include <sound/tlv.h> | |
43 | ||
44 | #include <sound/wm2000.h> | |
45 | ||
46 | #include "wm2000.h" | |
47 | ||
a89be93c MB |
48 | #define WM2000_NUM_SUPPLIES 3 |
49 | ||
50 | static const char *wm2000_supplies[WM2000_NUM_SUPPLIES] = { | |
51 | "SPKVDD", | |
52 | "DBVDD", | |
53 | "DCVDD", | |
54 | }; | |
55 | ||
3a66d387 MB |
56 | enum wm2000_anc_mode { |
57 | ANC_ACTIVE = 0, | |
58 | ANC_BYPASS = 1, | |
59 | ANC_STANDBY = 2, | |
60 | ANC_OFF = 3, | |
61 | }; | |
62 | ||
63 | struct wm2000_priv { | |
64 | struct i2c_client *i2c; | |
8aa1fe81 | 65 | struct regmap *regmap; |
514cfd6d | 66 | struct clk *mclk; |
3a66d387 | 67 | |
a89be93c MB |
68 | struct regulator_bulk_data supplies[WM2000_NUM_SUPPLIES]; |
69 | ||
3a66d387 MB |
70 | enum wm2000_anc_mode anc_mode; |
71 | ||
72 | unsigned int anc_active:1; | |
73 | unsigned int anc_eng_ena:1; | |
74 | unsigned int spk_ena:1; | |
75 | ||
3a66d387 MB |
76 | unsigned int speech_clarity:1; |
77 | ||
78 | int anc_download_size; | |
79 | char *anc_download; | |
8e9bb423 MB |
80 | |
81 | struct mutex lock; | |
3a66d387 MB |
82 | }; |
83 | ||
3a66d387 MB |
84 | static int wm2000_write(struct i2c_client *i2c, unsigned int reg, |
85 | unsigned int value) | |
86 | { | |
8aa1fe81 MB |
87 | struct wm2000_priv *wm2000 = i2c_get_clientdata(i2c); |
88 | return regmap_write(wm2000->regmap, reg, value); | |
3a66d387 MB |
89 | } |
90 | ||
91 | static unsigned int wm2000_read(struct i2c_client *i2c, unsigned int r) | |
92 | { | |
8aa1fe81 MB |
93 | struct wm2000_priv *wm2000 = i2c_get_clientdata(i2c); |
94 | unsigned int val; | |
3a66d387 MB |
95 | int ret; |
96 | ||
8aa1fe81 MB |
97 | ret = regmap_read(wm2000->regmap, r, &val); |
98 | if (ret < 0) | |
99 | return -1; | |
3a66d387 | 100 | |
8aa1fe81 | 101 | return val; |
3a66d387 MB |
102 | } |
103 | ||
104 | static void wm2000_reset(struct wm2000_priv *wm2000) | |
105 | { | |
106 | struct i2c_client *i2c = wm2000->i2c; | |
107 | ||
108 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_ENG_CLR); | |
109 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_CLR); | |
110 | wm2000_write(i2c, WM2000_REG_ID1, 0); | |
111 | ||
112 | wm2000->anc_mode = ANC_OFF; | |
113 | } | |
114 | ||
115 | static int wm2000_poll_bit(struct i2c_client *i2c, | |
3ff1ec27 | 116 | unsigned int reg, u8 mask) |
3a66d387 | 117 | { |
3ff1ec27 | 118 | int timeout = 4000; |
3a66d387 MB |
119 | int val; |
120 | ||
121 | val = wm2000_read(i2c, reg); | |
122 | ||
123 | while (!(val & mask) && --timeout) { | |
124 | msleep(1); | |
125 | val = wm2000_read(i2c, reg); | |
126 | } | |
127 | ||
128 | if (timeout == 0) | |
129 | return 0; | |
130 | else | |
131 | return 1; | |
132 | } | |
133 | ||
134 | static int wm2000_power_up(struct i2c_client *i2c, int analogue) | |
135 | { | |
136 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
d61100bb | 137 | unsigned long rate; |
3ff1ec27 | 138 | int ret; |
3a66d387 | 139 | |
bf90e895 TI |
140 | if (WARN_ON(wm2000->anc_mode != ANC_OFF)) |
141 | return -EINVAL; | |
3a66d387 MB |
142 | |
143 | dev_dbg(&i2c->dev, "Beginning power up\n"); | |
144 | ||
a89be93c MB |
145 | ret = regulator_bulk_enable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
146 | if (ret != 0) { | |
147 | dev_err(&i2c->dev, "Failed to enable supplies: %d\n", ret); | |
148 | return ret; | |
149 | } | |
150 | ||
d61100bb MB |
151 | rate = clk_get_rate(wm2000->mclk); |
152 | if (rate <= 13500000) { | |
3a66d387 MB |
153 | dev_dbg(&i2c->dev, "Disabling MCLK divider\n"); |
154 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, | |
155 | WM2000_MCLK_DIV2_ENA_CLR); | |
156 | } else { | |
157 | dev_dbg(&i2c->dev, "Enabling MCLK divider\n"); | |
158 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, | |
159 | WM2000_MCLK_DIV2_ENA_SET); | |
160 | } | |
161 | ||
162 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_ENG_CLR); | |
163 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_ENG_SET); | |
164 | ||
165 | /* Wait for ANC engine to become ready */ | |
166 | if (!wm2000_poll_bit(i2c, WM2000_REG_ANC_STAT, | |
3ff1ec27 | 167 | WM2000_ANC_ENG_IDLE)) { |
3a66d387 | 168 | dev_err(&i2c->dev, "ANC engine failed to reset\n"); |
a89be93c | 169 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
3a66d387 MB |
170 | return -ETIMEDOUT; |
171 | } | |
172 | ||
173 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 | 174 | WM2000_STATUS_BOOT_COMPLETE)) { |
3a66d387 | 175 | dev_err(&i2c->dev, "ANC engine failed to initialise\n"); |
a89be93c | 176 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
3a66d387 MB |
177 | return -ETIMEDOUT; |
178 | } | |
179 | ||
180 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_SET); | |
181 | ||
182 | /* Open code download of the data since it is the only bulk | |
183 | * write we do. */ | |
184 | dev_dbg(&i2c->dev, "Downloading %d bytes\n", | |
185 | wm2000->anc_download_size - 2); | |
186 | ||
187 | ret = i2c_master_send(i2c, wm2000->anc_download, | |
188 | wm2000->anc_download_size); | |
189 | if (ret < 0) { | |
190 | dev_err(&i2c->dev, "i2c_transfer() failed: %d\n", ret); | |
a89be93c | 191 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
3a66d387 MB |
192 | return ret; |
193 | } | |
194 | if (ret != wm2000->anc_download_size) { | |
195 | dev_err(&i2c->dev, "i2c_transfer() failed, %d != %d\n", | |
196 | ret, wm2000->anc_download_size); | |
a89be93c | 197 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
3a66d387 MB |
198 | return -EIO; |
199 | } | |
200 | ||
201 | dev_dbg(&i2c->dev, "Download complete\n"); | |
202 | ||
203 | if (analogue) { | |
3ff1ec27 | 204 | wm2000_write(i2c, WM2000_REG_ANA_VMID_PU_TIME, 248 / 4); |
3a66d387 MB |
205 | |
206 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
207 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
208 | WM2000_MODE_MOUSE_ENABLE | | |
209 | WM2000_MODE_THERMAL_ENABLE); | |
210 | } else { | |
3a66d387 MB |
211 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, |
212 | WM2000_MODE_MOUSE_ENABLE | | |
213 | WM2000_MODE_THERMAL_ENABLE); | |
214 | } | |
215 | ||
216 | ret = wm2000_read(i2c, WM2000_REG_SPEECH_CLARITY); | |
217 | if (wm2000->speech_clarity) | |
3a66d387 | 218 | ret |= WM2000_SPEECH_CLARITY; |
267f8fa2 MB |
219 | else |
220 | ret &= ~WM2000_SPEECH_CLARITY; | |
3a66d387 MB |
221 | wm2000_write(i2c, WM2000_REG_SPEECH_CLARITY, ret); |
222 | ||
223 | wm2000_write(i2c, WM2000_REG_SYS_START0, 0x33); | |
224 | wm2000_write(i2c, WM2000_REG_SYS_START1, 0x02); | |
225 | ||
226 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_INT_N_CLR); | |
227 | ||
228 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 MB |
229 | WM2000_STATUS_MOUSE_ACTIVE)) { |
230 | dev_err(&i2c->dev, "Timed out waiting for device\n"); | |
a89be93c | 231 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
3a66d387 MB |
232 | return -ETIMEDOUT; |
233 | } | |
234 | ||
235 | dev_dbg(&i2c->dev, "ANC active\n"); | |
236 | if (analogue) | |
237 | dev_dbg(&i2c->dev, "Analogue active\n"); | |
238 | wm2000->anc_mode = ANC_ACTIVE; | |
239 | ||
240 | return 0; | |
241 | } | |
242 | ||
243 | static int wm2000_power_down(struct i2c_client *i2c, int analogue) | |
244 | { | |
245 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
3a66d387 MB |
246 | |
247 | if (analogue) { | |
3ff1ec27 | 248 | wm2000_write(i2c, WM2000_REG_ANA_VMID_PD_TIME, 248 / 4); |
3a66d387 MB |
249 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, |
250 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
251 | WM2000_MODE_POWER_DOWN); | |
252 | } else { | |
3a66d387 MB |
253 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, |
254 | WM2000_MODE_POWER_DOWN); | |
255 | } | |
256 | ||
257 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 | 258 | WM2000_STATUS_POWER_DOWN_COMPLETE)) { |
3a66d387 MB |
259 | dev_err(&i2c->dev, "Timeout waiting for ANC power down\n"); |
260 | return -ETIMEDOUT; | |
261 | } | |
262 | ||
263 | if (!wm2000_poll_bit(i2c, WM2000_REG_ANC_STAT, | |
3ff1ec27 | 264 | WM2000_ANC_ENG_IDLE)) { |
3a66d387 MB |
265 | dev_err(&i2c->dev, "Timeout waiting for ANC engine idle\n"); |
266 | return -ETIMEDOUT; | |
267 | } | |
268 | ||
a89be93c MB |
269 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); |
270 | ||
3a66d387 MB |
271 | dev_dbg(&i2c->dev, "powered off\n"); |
272 | wm2000->anc_mode = ANC_OFF; | |
273 | ||
274 | return 0; | |
275 | } | |
276 | ||
277 | static int wm2000_enter_bypass(struct i2c_client *i2c, int analogue) | |
278 | { | |
279 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
280 | ||
bf90e895 TI |
281 | if (WARN_ON(wm2000->anc_mode != ANC_ACTIVE)) |
282 | return -EINVAL; | |
3a66d387 MB |
283 | |
284 | if (analogue) { | |
285 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
286 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
287 | WM2000_MODE_THERMAL_ENABLE | | |
288 | WM2000_MODE_BYPASS_ENTRY); | |
289 | } else { | |
290 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
291 | WM2000_MODE_THERMAL_ENABLE | | |
292 | WM2000_MODE_BYPASS_ENTRY); | |
293 | } | |
294 | ||
295 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 | 296 | WM2000_STATUS_ANC_DISABLED)) { |
3a66d387 MB |
297 | dev_err(&i2c->dev, "Timeout waiting for ANC disable\n"); |
298 | return -ETIMEDOUT; | |
299 | } | |
300 | ||
301 | if (!wm2000_poll_bit(i2c, WM2000_REG_ANC_STAT, | |
3ff1ec27 | 302 | WM2000_ANC_ENG_IDLE)) { |
3a66d387 MB |
303 | dev_err(&i2c->dev, "Timeout waiting for ANC engine idle\n"); |
304 | return -ETIMEDOUT; | |
305 | } | |
306 | ||
307 | wm2000_write(i2c, WM2000_REG_SYS_CTL1, WM2000_SYS_STBY); | |
308 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_CLR); | |
309 | ||
310 | wm2000->anc_mode = ANC_BYPASS; | |
311 | dev_dbg(&i2c->dev, "bypass enabled\n"); | |
312 | ||
313 | return 0; | |
314 | } | |
315 | ||
316 | static int wm2000_exit_bypass(struct i2c_client *i2c, int analogue) | |
317 | { | |
318 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
319 | ||
bf90e895 TI |
320 | if (WARN_ON(wm2000->anc_mode != ANC_BYPASS)) |
321 | return -EINVAL; | |
3a66d387 MB |
322 | |
323 | wm2000_write(i2c, WM2000_REG_SYS_CTL1, 0); | |
324 | ||
325 | if (analogue) { | |
326 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
327 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
328 | WM2000_MODE_MOUSE_ENABLE | | |
329 | WM2000_MODE_THERMAL_ENABLE); | |
330 | } else { | |
331 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
332 | WM2000_MODE_MOUSE_ENABLE | | |
333 | WM2000_MODE_THERMAL_ENABLE); | |
334 | } | |
335 | ||
336 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_SET); | |
337 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_INT_N_CLR); | |
338 | ||
339 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 | 340 | WM2000_STATUS_MOUSE_ACTIVE)) { |
3a66d387 MB |
341 | dev_err(&i2c->dev, "Timed out waiting for MOUSE\n"); |
342 | return -ETIMEDOUT; | |
343 | } | |
344 | ||
345 | wm2000->anc_mode = ANC_ACTIVE; | |
346 | dev_dbg(&i2c->dev, "MOUSE active\n"); | |
347 | ||
348 | return 0; | |
349 | } | |
350 | ||
351 | static int wm2000_enter_standby(struct i2c_client *i2c, int analogue) | |
352 | { | |
353 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
3a66d387 | 354 | |
bf90e895 TI |
355 | if (WARN_ON(wm2000->anc_mode != ANC_ACTIVE)) |
356 | return -EINVAL; | |
3a66d387 MB |
357 | |
358 | if (analogue) { | |
3ff1ec27 | 359 | wm2000_write(i2c, WM2000_REG_ANA_VMID_PD_TIME, 248 / 4); |
3a66d387 MB |
360 | |
361 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
362 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
363 | WM2000_MODE_THERMAL_ENABLE | | |
364 | WM2000_MODE_STANDBY_ENTRY); | |
365 | } else { | |
3a66d387 MB |
366 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, |
367 | WM2000_MODE_THERMAL_ENABLE | | |
368 | WM2000_MODE_STANDBY_ENTRY); | |
369 | } | |
370 | ||
371 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 | 372 | WM2000_STATUS_ANC_DISABLED)) { |
3a66d387 MB |
373 | dev_err(&i2c->dev, |
374 | "Timed out waiting for ANC disable after 1ms\n"); | |
375 | return -ETIMEDOUT; | |
376 | } | |
377 | ||
3ff1ec27 | 378 | if (!wm2000_poll_bit(i2c, WM2000_REG_ANC_STAT, WM2000_ANC_ENG_IDLE)) { |
3a66d387 | 379 | dev_err(&i2c->dev, |
3ff1ec27 | 380 | "Timed out waiting for standby\n"); |
3a66d387 MB |
381 | return -ETIMEDOUT; |
382 | } | |
383 | ||
384 | wm2000_write(i2c, WM2000_REG_SYS_CTL1, WM2000_SYS_STBY); | |
385 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_CLR); | |
386 | ||
387 | wm2000->anc_mode = ANC_STANDBY; | |
388 | dev_dbg(&i2c->dev, "standby\n"); | |
389 | if (analogue) | |
390 | dev_dbg(&i2c->dev, "Analogue disabled\n"); | |
391 | ||
392 | return 0; | |
393 | } | |
394 | ||
395 | static int wm2000_exit_standby(struct i2c_client *i2c, int analogue) | |
396 | { | |
397 | struct wm2000_priv *wm2000 = dev_get_drvdata(&i2c->dev); | |
3a66d387 | 398 | |
bf90e895 TI |
399 | if (WARN_ON(wm2000->anc_mode != ANC_STANDBY)) |
400 | return -EINVAL; | |
3a66d387 MB |
401 | |
402 | wm2000_write(i2c, WM2000_REG_SYS_CTL1, 0); | |
403 | ||
404 | if (analogue) { | |
3ff1ec27 | 405 | wm2000_write(i2c, WM2000_REG_ANA_VMID_PU_TIME, 248 / 4); |
3a66d387 MB |
406 | |
407 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, | |
408 | WM2000_MODE_ANA_SEQ_INCLUDE | | |
409 | WM2000_MODE_THERMAL_ENABLE | | |
410 | WM2000_MODE_MOUSE_ENABLE); | |
411 | } else { | |
3a66d387 MB |
412 | wm2000_write(i2c, WM2000_REG_SYS_MODE_CNTRL, |
413 | WM2000_MODE_THERMAL_ENABLE | | |
414 | WM2000_MODE_MOUSE_ENABLE); | |
415 | } | |
416 | ||
417 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_RAM_SET); | |
418 | wm2000_write(i2c, WM2000_REG_SYS_CTL2, WM2000_ANC_INT_N_CLR); | |
419 | ||
420 | if (!wm2000_poll_bit(i2c, WM2000_REG_SYS_STATUS, | |
3ff1ec27 MB |
421 | WM2000_STATUS_MOUSE_ACTIVE)) { |
422 | dev_err(&i2c->dev, "Timed out waiting for MOUSE\n"); | |
3a66d387 MB |
423 | return -ETIMEDOUT; |
424 | } | |
425 | ||
426 | wm2000->anc_mode = ANC_ACTIVE; | |
427 | dev_dbg(&i2c->dev, "MOUSE active\n"); | |
428 | if (analogue) | |
429 | dev_dbg(&i2c->dev, "Analogue enabled\n"); | |
430 | ||
431 | return 0; | |
432 | } | |
433 | ||
434 | typedef int (*wm2000_mode_fn)(struct i2c_client *i2c, int analogue); | |
435 | ||
436 | static struct { | |
437 | enum wm2000_anc_mode source; | |
438 | enum wm2000_anc_mode dest; | |
439 | int analogue; | |
440 | wm2000_mode_fn step[2]; | |
441 | } anc_transitions[] = { | |
442 | { | |
443 | .source = ANC_OFF, | |
444 | .dest = ANC_ACTIVE, | |
445 | .analogue = 1, | |
446 | .step = { | |
447 | wm2000_power_up, | |
448 | }, | |
449 | }, | |
450 | { | |
451 | .source = ANC_OFF, | |
452 | .dest = ANC_STANDBY, | |
453 | .step = { | |
454 | wm2000_power_up, | |
455 | wm2000_enter_standby, | |
456 | }, | |
457 | }, | |
458 | { | |
459 | .source = ANC_OFF, | |
460 | .dest = ANC_BYPASS, | |
461 | .analogue = 1, | |
462 | .step = { | |
463 | wm2000_power_up, | |
464 | wm2000_enter_bypass, | |
465 | }, | |
466 | }, | |
467 | { | |
468 | .source = ANC_ACTIVE, | |
469 | .dest = ANC_BYPASS, | |
470 | .analogue = 1, | |
471 | .step = { | |
472 | wm2000_enter_bypass, | |
473 | }, | |
474 | }, | |
475 | { | |
476 | .source = ANC_ACTIVE, | |
477 | .dest = ANC_STANDBY, | |
478 | .analogue = 1, | |
479 | .step = { | |
480 | wm2000_enter_standby, | |
481 | }, | |
482 | }, | |
483 | { | |
484 | .source = ANC_ACTIVE, | |
485 | .dest = ANC_OFF, | |
486 | .analogue = 1, | |
487 | .step = { | |
488 | wm2000_power_down, | |
489 | }, | |
490 | }, | |
491 | { | |
492 | .source = ANC_BYPASS, | |
493 | .dest = ANC_ACTIVE, | |
494 | .analogue = 1, | |
495 | .step = { | |
496 | wm2000_exit_bypass, | |
497 | }, | |
498 | }, | |
499 | { | |
500 | .source = ANC_BYPASS, | |
501 | .dest = ANC_STANDBY, | |
502 | .analogue = 1, | |
503 | .step = { | |
504 | wm2000_exit_bypass, | |
505 | wm2000_enter_standby, | |
506 | }, | |
507 | }, | |
508 | { | |
509 | .source = ANC_BYPASS, | |
510 | .dest = ANC_OFF, | |
511 | .step = { | |
512 | wm2000_exit_bypass, | |
513 | wm2000_power_down, | |
514 | }, | |
515 | }, | |
516 | { | |
517 | .source = ANC_STANDBY, | |
518 | .dest = ANC_ACTIVE, | |
519 | .analogue = 1, | |
520 | .step = { | |
521 | wm2000_exit_standby, | |
522 | }, | |
523 | }, | |
524 | { | |
525 | .source = ANC_STANDBY, | |
526 | .dest = ANC_BYPASS, | |
527 | .analogue = 1, | |
528 | .step = { | |
529 | wm2000_exit_standby, | |
530 | wm2000_enter_bypass, | |
531 | }, | |
532 | }, | |
533 | { | |
534 | .source = ANC_STANDBY, | |
535 | .dest = ANC_OFF, | |
536 | .step = { | |
537 | wm2000_exit_standby, | |
538 | wm2000_power_down, | |
539 | }, | |
540 | }, | |
541 | }; | |
542 | ||
543 | static int wm2000_anc_transition(struct wm2000_priv *wm2000, | |
544 | enum wm2000_anc_mode mode) | |
545 | { | |
546 | struct i2c_client *i2c = wm2000->i2c; | |
547 | int i, j; | |
548 | int ret; | |
549 | ||
550 | if (wm2000->anc_mode == mode) | |
551 | return 0; | |
552 | ||
553 | for (i = 0; i < ARRAY_SIZE(anc_transitions); i++) | |
554 | if (anc_transitions[i].source == wm2000->anc_mode && | |
555 | anc_transitions[i].dest == mode) | |
556 | break; | |
557 | if (i == ARRAY_SIZE(anc_transitions)) { | |
558 | dev_err(&i2c->dev, "No transition for %d->%d\n", | |
559 | wm2000->anc_mode, mode); | |
560 | return -EINVAL; | |
561 | } | |
562 | ||
514cfd6d MB |
563 | /* Maintain clock while active */ |
564 | if (anc_transitions[i].source == ANC_OFF) { | |
565 | ret = clk_prepare_enable(wm2000->mclk); | |
566 | if (ret != 0) { | |
567 | dev_err(&i2c->dev, "Failed to enable MCLK: %d\n", ret); | |
568 | return ret; | |
569 | } | |
570 | } | |
571 | ||
3a66d387 MB |
572 | for (j = 0; j < ARRAY_SIZE(anc_transitions[j].step); j++) { |
573 | if (!anc_transitions[i].step[j]) | |
574 | break; | |
575 | ret = anc_transitions[i].step[j](i2c, | |
576 | anc_transitions[i].analogue); | |
577 | if (ret != 0) | |
578 | return ret; | |
579 | } | |
580 | ||
514cfd6d MB |
581 | if (anc_transitions[i].dest == ANC_OFF) |
582 | clk_disable_unprepare(wm2000->mclk); | |
583 | ||
584 | return ret; | |
3a66d387 MB |
585 | } |
586 | ||
587 | static int wm2000_anc_set_mode(struct wm2000_priv *wm2000) | |
588 | { | |
589 | struct i2c_client *i2c = wm2000->i2c; | |
590 | enum wm2000_anc_mode mode; | |
591 | ||
592 | if (wm2000->anc_eng_ena && wm2000->spk_ena) | |
593 | if (wm2000->anc_active) | |
594 | mode = ANC_ACTIVE; | |
595 | else | |
596 | mode = ANC_BYPASS; | |
597 | else | |
598 | mode = ANC_STANDBY; | |
599 | ||
600 | dev_dbg(&i2c->dev, "Set mode %d (enabled %d, mute %d, active %d)\n", | |
601 | mode, wm2000->anc_eng_ena, !wm2000->spk_ena, | |
602 | wm2000->anc_active); | |
603 | ||
604 | return wm2000_anc_transition(wm2000, mode); | |
605 | } | |
606 | ||
607 | static int wm2000_anc_mode_get(struct snd_kcontrol *kcontrol, | |
608 | struct snd_ctl_elem_value *ucontrol) | |
609 | { | |
4911ccdb MB |
610 | struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); |
611 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
3a66d387 MB |
612 | |
613 | ucontrol->value.enumerated.item[0] = wm2000->anc_active; | |
614 | ||
615 | return 0; | |
616 | } | |
617 | ||
618 | static int wm2000_anc_mode_put(struct snd_kcontrol *kcontrol, | |
619 | struct snd_ctl_elem_value *ucontrol) | |
620 | { | |
4911ccdb MB |
621 | struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); |
622 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
3a66d387 | 623 | int anc_active = ucontrol->value.enumerated.item[0]; |
8e9bb423 | 624 | int ret; |
3a66d387 MB |
625 | |
626 | if (anc_active > 1) | |
627 | return -EINVAL; | |
628 | ||
8e9bb423 MB |
629 | mutex_lock(&wm2000->lock); |
630 | ||
3a66d387 MB |
631 | wm2000->anc_active = anc_active; |
632 | ||
8e9bb423 MB |
633 | ret = wm2000_anc_set_mode(wm2000); |
634 | ||
635 | mutex_unlock(&wm2000->lock); | |
636 | ||
637 | return ret; | |
3a66d387 MB |
638 | } |
639 | ||
640 | static int wm2000_speaker_get(struct snd_kcontrol *kcontrol, | |
641 | struct snd_ctl_elem_value *ucontrol) | |
642 | { | |
4911ccdb MB |
643 | struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); |
644 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
3a66d387 MB |
645 | |
646 | ucontrol->value.enumerated.item[0] = wm2000->spk_ena; | |
647 | ||
648 | return 0; | |
649 | } | |
650 | ||
651 | static int wm2000_speaker_put(struct snd_kcontrol *kcontrol, | |
652 | struct snd_ctl_elem_value *ucontrol) | |
653 | { | |
4911ccdb MB |
654 | struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); |
655 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
3a66d387 | 656 | int val = ucontrol->value.enumerated.item[0]; |
8e9bb423 | 657 | int ret; |
3a66d387 MB |
658 | |
659 | if (val > 1) | |
660 | return -EINVAL; | |
661 | ||
8e9bb423 MB |
662 | mutex_lock(&wm2000->lock); |
663 | ||
3a66d387 MB |
664 | wm2000->spk_ena = val; |
665 | ||
8e9bb423 MB |
666 | ret = wm2000_anc_set_mode(wm2000); |
667 | ||
668 | mutex_unlock(&wm2000->lock); | |
669 | ||
670 | return ret; | |
3a66d387 MB |
671 | } |
672 | ||
673 | static const struct snd_kcontrol_new wm2000_controls[] = { | |
3f3af6ee | 674 | SOC_SINGLE("ANC Volume", WM2000_REG_ANC_GAIN_CTRL, 0, 255, 0), |
3a66d387 MB |
675 | SOC_SINGLE_BOOL_EXT("WM2000 ANC Switch", 0, |
676 | wm2000_anc_mode_get, | |
677 | wm2000_anc_mode_put), | |
678 | SOC_SINGLE_BOOL_EXT("WM2000 Switch", 0, | |
679 | wm2000_speaker_get, | |
680 | wm2000_speaker_put), | |
681 | }; | |
682 | ||
683 | static int wm2000_anc_power_event(struct snd_soc_dapm_widget *w, | |
684 | struct snd_kcontrol *kcontrol, int event) | |
685 | { | |
a5ccea22 | 686 | struct snd_soc_codec *codec = w->codec; |
4911ccdb | 687 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); |
8e9bb423 MB |
688 | int ret; |
689 | ||
690 | mutex_lock(&wm2000->lock); | |
3a66d387 MB |
691 | |
692 | if (SND_SOC_DAPM_EVENT_ON(event)) | |
693 | wm2000->anc_eng_ena = 1; | |
694 | ||
695 | if (SND_SOC_DAPM_EVENT_OFF(event)) | |
696 | wm2000->anc_eng_ena = 0; | |
697 | ||
8e9bb423 MB |
698 | ret = wm2000_anc_set_mode(wm2000); |
699 | ||
700 | mutex_unlock(&wm2000->lock); | |
701 | ||
702 | return ret; | |
3a66d387 MB |
703 | } |
704 | ||
705 | static const struct snd_soc_dapm_widget wm2000_dapm_widgets[] = { | |
706 | /* Externally visible pins */ | |
4911ccdb MB |
707 | SND_SOC_DAPM_OUTPUT("SPKN"), |
708 | SND_SOC_DAPM_OUTPUT("SPKP"), | |
3a66d387 | 709 | |
4911ccdb MB |
710 | SND_SOC_DAPM_INPUT("LINN"), |
711 | SND_SOC_DAPM_INPUT("LINP"), | |
3a66d387 MB |
712 | |
713 | SND_SOC_DAPM_PGA_E("ANC Engine", SND_SOC_NOPM, 0, 0, NULL, 0, | |
714 | wm2000_anc_power_event, | |
715 | SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD), | |
716 | }; | |
717 | ||
718 | /* Target, Path, Source */ | |
4911ccdb MB |
719 | static const struct snd_soc_dapm_route wm2000_audio_map[] = { |
720 | { "SPKN", NULL, "ANC Engine" }, | |
721 | { "SPKP", NULL, "ANC Engine" }, | |
722 | { "ANC Engine", NULL, "LINN" }, | |
723 | { "ANC Engine", NULL, "LINP" }, | |
3a66d387 MB |
724 | }; |
725 | ||
4911ccdb MB |
726 | #ifdef CONFIG_PM |
727 | static int wm2000_suspend(struct snd_soc_codec *codec) | |
3a66d387 | 728 | { |
4911ccdb | 729 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); |
3a66d387 | 730 | |
4911ccdb MB |
731 | return wm2000_anc_transition(wm2000, ANC_OFF); |
732 | } | |
3a66d387 | 733 | |
4911ccdb MB |
734 | static int wm2000_resume(struct snd_soc_codec *codec) |
735 | { | |
736 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
3a66d387 | 737 | |
4911ccdb | 738 | return wm2000_anc_set_mode(wm2000); |
3a66d387 | 739 | } |
4911ccdb MB |
740 | #else |
741 | #define wm2000_suspend NULL | |
742 | #define wm2000_resume NULL | |
743 | #endif | |
3a66d387 | 744 | |
51cc7ed3 MB |
745 | static bool wm2000_readable_reg(struct device *dev, unsigned int reg) |
746 | { | |
747 | switch (reg) { | |
748 | case WM2000_REG_SYS_START: | |
33e7546e MB |
749 | case WM2000_REG_ANC_GAIN_CTRL: |
750 | case WM2000_REG_MSE_TH1: | |
751 | case WM2000_REG_MSE_TH2: | |
51cc7ed3 MB |
752 | case WM2000_REG_SPEECH_CLARITY: |
753 | case WM2000_REG_SYS_WATCHDOG: | |
754 | case WM2000_REG_ANA_VMID_PD_TIME: | |
755 | case WM2000_REG_ANA_VMID_PU_TIME: | |
756 | case WM2000_REG_CAT_FLTR_INDX: | |
757 | case WM2000_REG_CAT_GAIN_0: | |
758 | case WM2000_REG_SYS_STATUS: | |
759 | case WM2000_REG_SYS_MODE_CNTRL: | |
760 | case WM2000_REG_SYS_START0: | |
761 | case WM2000_REG_SYS_START1: | |
762 | case WM2000_REG_ID1: | |
763 | case WM2000_REG_ID2: | |
764 | case WM2000_REG_REVISON: | |
765 | case WM2000_REG_SYS_CTL1: | |
766 | case WM2000_REG_SYS_CTL2: | |
767 | case WM2000_REG_ANC_STAT: | |
768 | case WM2000_REG_IF_CTL: | |
939dc51b MB |
769 | case WM2000_REG_ANA_MIC_CTL: |
770 | case WM2000_REG_SPK_CTL: | |
51cc7ed3 MB |
771 | return true; |
772 | default: | |
773 | return false; | |
774 | } | |
775 | } | |
776 | ||
8aa1fe81 | 777 | static const struct regmap_config wm2000_regmap = { |
d0e12f3f | 778 | .reg_bits = 16, |
8aa1fe81 | 779 | .val_bits = 8, |
51cc7ed3 | 780 | |
939dc51b | 781 | .max_register = WM2000_REG_SPK_CTL, |
51cc7ed3 | 782 | .readable_reg = wm2000_readable_reg, |
8aa1fe81 MB |
783 | }; |
784 | ||
4911ccdb MB |
785 | static int wm2000_probe(struct snd_soc_codec *codec) |
786 | { | |
787 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
788 | ||
789 | /* This will trigger a transition to standby mode by default */ | |
790 | wm2000_anc_set_mode(wm2000); | |
791 | ||
792 | return 0; | |
793 | } | |
794 | ||
795 | static int wm2000_remove(struct snd_soc_codec *codec) | |
796 | { | |
797 | struct wm2000_priv *wm2000 = dev_get_drvdata(codec->dev); | |
798 | ||
799 | return wm2000_anc_transition(wm2000, ANC_OFF); | |
800 | } | |
801 | ||
802 | static struct snd_soc_codec_driver soc_codec_dev_wm2000 = { | |
803 | .probe = wm2000_probe, | |
804 | .remove = wm2000_remove, | |
805 | .suspend = wm2000_suspend, | |
806 | .resume = wm2000_resume, | |
807 | ||
808 | .dapm_widgets = wm2000_dapm_widgets, | |
809 | .num_dapm_widgets = ARRAY_SIZE(wm2000_dapm_widgets), | |
810 | .dapm_routes = wm2000_audio_map, | |
811 | .num_dapm_routes = ARRAY_SIZE(wm2000_audio_map), | |
812 | .controls = wm2000_controls, | |
813 | .num_controls = ARRAY_SIZE(wm2000_controls), | |
814 | }; | |
815 | ||
7a79e94e BP |
816 | static int wm2000_i2c_probe(struct i2c_client *i2c, |
817 | const struct i2c_device_id *i2c_id) | |
3a66d387 MB |
818 | { |
819 | struct wm2000_priv *wm2000; | |
820 | struct wm2000_platform_data *pdata; | |
821 | const char *filename; | |
c83f1d7e | 822 | const struct firmware *fw = NULL; |
a89be93c | 823 | int ret, i; |
c83f1d7e | 824 | int reg; |
3a66d387 MB |
825 | u16 id; |
826 | ||
b03e96e4 MB |
827 | wm2000 = devm_kzalloc(&i2c->dev, sizeof(struct wm2000_priv), |
828 | GFP_KERNEL); | |
3a66d387 MB |
829 | if (wm2000 == NULL) { |
830 | dev_err(&i2c->dev, "Unable to allocate private data\n"); | |
831 | return -ENOMEM; | |
832 | } | |
833 | ||
8e9bb423 MB |
834 | mutex_init(&wm2000->lock); |
835 | ||
8aa1fe81 MB |
836 | dev_set_drvdata(&i2c->dev, wm2000); |
837 | ||
8fed54ae | 838 | wm2000->regmap = devm_regmap_init_i2c(i2c, &wm2000_regmap); |
8aa1fe81 MB |
839 | if (IS_ERR(wm2000->regmap)) { |
840 | ret = PTR_ERR(wm2000->regmap); | |
841 | dev_err(&i2c->dev, "Failed to allocate register map: %d\n", | |
842 | ret); | |
c83f1d7e | 843 | goto out; |
8aa1fe81 MB |
844 | } |
845 | ||
a89be93c MB |
846 | for (i = 0; i < WM2000_NUM_SUPPLIES; i++) |
847 | wm2000->supplies[i].supply = wm2000_supplies[i]; | |
848 | ||
849 | ret = devm_regulator_bulk_get(&i2c->dev, WM2000_NUM_SUPPLIES, | |
850 | wm2000->supplies); | |
851 | if (ret != 0) { | |
852 | dev_err(&i2c->dev, "Failed to get supplies: %d\n", ret); | |
853 | return ret; | |
854 | } | |
855 | ||
856 | ret = regulator_bulk_enable(WM2000_NUM_SUPPLIES, wm2000->supplies); | |
857 | if (ret != 0) { | |
858 | dev_err(&i2c->dev, "Failed to enable supplies: %d\n", ret); | |
859 | return ret; | |
860 | } | |
861 | ||
3a66d387 MB |
862 | /* Verify that this is a WM2000 */ |
863 | reg = wm2000_read(i2c, WM2000_REG_ID1); | |
864 | id = reg << 8; | |
865 | reg = wm2000_read(i2c, WM2000_REG_ID2); | |
866 | id |= reg & 0xff; | |
867 | ||
868 | if (id != 0x2000) { | |
869 | dev_err(&i2c->dev, "Device is not a WM2000 - ID %x\n", id); | |
870 | ret = -ENODEV; | |
a89be93c | 871 | goto err_supplies; |
3a66d387 MB |
872 | } |
873 | ||
874 | reg = wm2000_read(i2c, WM2000_REG_REVISON); | |
875 | dev_info(&i2c->dev, "revision %c\n", reg + 'A'); | |
876 | ||
514cfd6d MB |
877 | wm2000->mclk = devm_clk_get(&i2c->dev, "MCLK"); |
878 | if (IS_ERR(wm2000->mclk)) { | |
879 | ret = PTR_ERR(wm2000->mclk); | |
880 | dev_err(&i2c->dev, "Failed to get MCLK: %d\n", ret); | |
881 | goto err_supplies; | |
882 | } | |
883 | ||
3a66d387 MB |
884 | filename = "wm2000_anc.bin"; |
885 | pdata = dev_get_platdata(&i2c->dev); | |
886 | if (pdata) { | |
3a66d387 MB |
887 | wm2000->speech_clarity = !pdata->speech_enh_disable; |
888 | ||
889 | if (pdata->download_file) | |
890 | filename = pdata->download_file; | |
891 | } | |
892 | ||
893 | ret = request_firmware(&fw, filename, &i2c->dev); | |
894 | if (ret != 0) { | |
895 | dev_err(&i2c->dev, "Failed to acquire ANC data: %d\n", ret); | |
a89be93c | 896 | goto err_supplies; |
3a66d387 MB |
897 | } |
898 | ||
899 | /* Pre-cook the concatenation of the register address onto the image */ | |
900 | wm2000->anc_download_size = fw->size + 2; | |
b03e96e4 MB |
901 | wm2000->anc_download = devm_kzalloc(&i2c->dev, |
902 | wm2000->anc_download_size, | |
903 | GFP_KERNEL); | |
3a66d387 MB |
904 | if (wm2000->anc_download == NULL) { |
905 | dev_err(&i2c->dev, "Out of memory\n"); | |
906 | ret = -ENOMEM; | |
a89be93c | 907 | goto err_supplies; |
3a66d387 MB |
908 | } |
909 | ||
910 | wm2000->anc_download[0] = 0x80; | |
911 | wm2000->anc_download[1] = 0x00; | |
912 | memcpy(wm2000->anc_download + 2, fw->data, fw->size); | |
913 | ||
3a66d387 | 914 | wm2000->anc_eng_ena = 1; |
e71fa370 MB |
915 | wm2000->anc_active = 1; |
916 | wm2000->spk_ena = 1; | |
3a66d387 MB |
917 | wm2000->i2c = i2c; |
918 | ||
919 | wm2000_reset(wm2000); | |
920 | ||
c83f1d7e | 921 | ret = snd_soc_register_codec(&i2c->dev, &soc_codec_dev_wm2000, NULL, 0); |
3a66d387 | 922 | |
a89be93c MB |
923 | err_supplies: |
924 | regulator_bulk_disable(WM2000_NUM_SUPPLIES, wm2000->supplies); | |
3a66d387 | 925 | |
c83f1d7e JJ |
926 | out: |
927 | release_firmware(fw); | |
3a66d387 MB |
928 | return ret; |
929 | } | |
930 | ||
7a79e94e | 931 | static int wm2000_i2c_remove(struct i2c_client *i2c) |
3a66d387 | 932 | { |
4911ccdb | 933 | snd_soc_unregister_codec(&i2c->dev); |
8aa1fe81 | 934 | |
3a66d387 MB |
935 | return 0; |
936 | } | |
937 | ||
3a66d387 MB |
938 | static const struct i2c_device_id wm2000_i2c_id[] = { |
939 | { "wm2000", 0 }, | |
940 | { } | |
941 | }; | |
942 | MODULE_DEVICE_TABLE(i2c, wm2000_i2c_id); | |
943 | ||
944 | static struct i2c_driver wm2000_i2c_driver = { | |
945 | .driver = { | |
946 | .name = "wm2000", | |
947 | .owner = THIS_MODULE, | |
948 | }, | |
949 | .probe = wm2000_i2c_probe, | |
7a79e94e | 950 | .remove = wm2000_i2c_remove, |
3a66d387 MB |
951 | .id_table = wm2000_i2c_id, |
952 | }; | |
953 | ||
3a4bfd88 | 954 | module_i2c_driver(wm2000_i2c_driver); |
3a66d387 MB |
955 | |
956 | MODULE_DESCRIPTION("ASoC WM2000 driver"); | |
957 | MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfonmicro.com>"); | |
958 | MODULE_LICENSE("GPL"); |