xref: /linux/drivers/mfd/wm8350-core.c (revision 037fc3368be46dc1a2a90f6e50c8cbce49d75fd6)
1 /*
2  * wm8350-core.c  --  Device access for Wolfson WM8350
3  *
4  * Copyright 2007, 2008 Wolfson Microelectronics PLC.
5  *
6  * Author: Liam Girdwood, Mark Brown
7  *
8  *  This program is free software; you can redistribute  it and/or modify it
9  *  under  the terms of  the GNU General  Public License as published by the
10  *  Free Software Foundation;  either version 2 of the  License, or (at your
11  *  option) any later version.
12  *
13  */
14 
15 #include <linux/kernel.h>
16 #include <linux/init.h>
17 #include <linux/export.h>
18 #include <linux/slab.h>
19 #include <linux/bug.h>
20 #include <linux/device.h>
21 #include <linux/delay.h>
22 #include <linux/interrupt.h>
23 #include <linux/regmap.h>
24 #include <linux/workqueue.h>
25 
26 #include <linux/mfd/wm8350/core.h>
27 #include <linux/mfd/wm8350/audio.h>
28 #include <linux/mfd/wm8350/comparator.h>
29 #include <linux/mfd/wm8350/gpio.h>
30 #include <linux/mfd/wm8350/pmic.h>
31 #include <linux/mfd/wm8350/rtc.h>
32 #include <linux/mfd/wm8350/supply.h>
33 #include <linux/mfd/wm8350/wdt.h>
34 
35 #define WM8350_CLOCK_CONTROL_1		0x28
36 #define WM8350_AIF_TEST			0x74
37 
38 /* debug */
39 #define WM8350_BUS_DEBUG 0
40 #if WM8350_BUS_DEBUG
41 #define dump(regs, src) do { \
42 	int i_; \
43 	u16 *src_ = src; \
44 	printk(KERN_DEBUG); \
45 	for (i_ = 0; i_ < regs; i_++) \
46 		printk(" 0x%4.4x", *src_++); \
47 	printk("\n"); \
48 } while (0);
49 #else
50 #define dump(bytes, src)
51 #endif
52 
53 #define WM8350_LOCK_DEBUG 0
54 #if WM8350_LOCK_DEBUG
55 #define ldbg(format, arg...) printk(format, ## arg)
56 #else
57 #define ldbg(format, arg...)
58 #endif
59 
60 /*
61  * WM8350 Device IO
62  */
63 static DEFINE_MUTEX(reg_lock_mutex);
64 
65 /*
66  * Safe read, modify, write methods
67  */
68 int wm8350_clear_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
69 {
70 	return regmap_update_bits(wm8350->regmap, reg, mask, 0);
71 }
72 EXPORT_SYMBOL_GPL(wm8350_clear_bits);
73 
74 int wm8350_set_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
75 {
76 	return regmap_update_bits(wm8350->regmap, reg, mask, mask);
77 }
78 EXPORT_SYMBOL_GPL(wm8350_set_bits);
79 
80 u16 wm8350_reg_read(struct wm8350 *wm8350, int reg)
81 {
82 	unsigned int data;
83 	int err;
84 
85 	err = regmap_read(wm8350->regmap, reg, &data);
86 	if (err)
87 		dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
88 
89 	return data;
90 }
91 EXPORT_SYMBOL_GPL(wm8350_reg_read);
92 
93 int wm8350_reg_write(struct wm8350 *wm8350, int reg, u16 val)
94 {
95 	int ret;
96 
97 	ret = regmap_write(wm8350->regmap, reg, val);
98 
99 	if (ret)
100 		dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
101 	return ret;
102 }
103 EXPORT_SYMBOL_GPL(wm8350_reg_write);
104 
105 int wm8350_block_read(struct wm8350 *wm8350, int start_reg, int regs,
106 		      u16 *dest)
107 {
108 	int err = 0;
109 
110 	err = regmap_bulk_read(wm8350->regmap, start_reg, dest, regs);
111 	if (err)
112 		dev_err(wm8350->dev, "block read starting from R%d failed\n",
113 			start_reg);
114 
115 	return err;
116 }
117 EXPORT_SYMBOL_GPL(wm8350_block_read);
118 
119 int wm8350_block_write(struct wm8350 *wm8350, int start_reg, int regs,
120 		       u16 *src)
121 {
122 	int ret = 0;
123 
124 	ret = regmap_bulk_write(wm8350->regmap, start_reg, src, regs);
125 	if (ret)
126 		dev_err(wm8350->dev, "block write starting at R%d failed\n",
127 			start_reg);
128 
129 	return ret;
130 }
131 EXPORT_SYMBOL_GPL(wm8350_block_write);
132 
133 /**
134  * wm8350_reg_lock()
135  *
136  * The WM8350 has a hardware lock which can be used to prevent writes to
137  * some registers (generally those which can cause particularly serious
138  * problems if misused).  This function enables that lock.
139  */
140 int wm8350_reg_lock(struct wm8350 *wm8350)
141 {
142 	int ret;
143 
144 	mutex_lock(&reg_lock_mutex);
145 
146 	ldbg(__func__);
147 
148 	ret = wm8350_reg_write(wm8350, WM8350_SECURITY, WM8350_LOCK_KEY);
149 	if (ret)
150 		dev_err(wm8350->dev, "lock failed\n");
151 
152 	wm8350->unlocked = false;
153 
154 	mutex_unlock(&reg_lock_mutex);
155 
156 	return ret;
157 }
158 EXPORT_SYMBOL_GPL(wm8350_reg_lock);
159 
160 /**
161  * wm8350_reg_unlock()
162  *
163  * The WM8350 has a hardware lock which can be used to prevent writes to
164  * some registers (generally those which can cause particularly serious
165  * problems if misused).  This function disables that lock so updates
166  * can be performed.  For maximum safety this should be done only when
167  * required.
168  */
169 int wm8350_reg_unlock(struct wm8350 *wm8350)
170 {
171 	int ret;
172 
173 	mutex_lock(&reg_lock_mutex);
174 
175 	ldbg(__func__);
176 
177 	ret = wm8350_reg_write(wm8350, WM8350_SECURITY, WM8350_UNLOCK_KEY);
178 	if (ret)
179 		dev_err(wm8350->dev, "unlock failed\n");
180 
181 	wm8350->unlocked = true;
182 
183 	mutex_unlock(&reg_lock_mutex);
184 
185 	return ret;
186 }
187 EXPORT_SYMBOL_GPL(wm8350_reg_unlock);
188 
189 int wm8350_read_auxadc(struct wm8350 *wm8350, int channel, int scale, int vref)
190 {
191 	u16 reg, result = 0;
192 
193 	if (channel < WM8350_AUXADC_AUX1 || channel > WM8350_AUXADC_TEMP)
194 		return -EINVAL;
195 	if (channel >= WM8350_AUXADC_USB && channel <= WM8350_AUXADC_TEMP
196 	    && (scale != 0 || vref != 0))
197 		return -EINVAL;
198 
199 	mutex_lock(&wm8350->auxadc_mutex);
200 
201 	/* Turn on the ADC */
202 	reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
203 	wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5, reg | WM8350_AUXADC_ENA);
204 
205 	if (scale || vref) {
206 		reg = scale << 13;
207 		reg |= vref << 12;
208 		wm8350_reg_write(wm8350, WM8350_AUX1_READBACK + channel, reg);
209 	}
210 
211 	reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
212 	reg |= 1 << channel | WM8350_AUXADC_POLL;
213 	wm8350_reg_write(wm8350, WM8350_DIGITISER_CONTROL_1, reg);
214 
215 	/* If a late IRQ left the completion signalled then consume
216 	 * the completion. */
217 	try_wait_for_completion(&wm8350->auxadc_done);
218 
219 	/* We ignore the result of the completion and just check for a
220 	 * conversion result, allowing us to soldier on if the IRQ
221 	 * infrastructure is not set up for the chip. */
222 	wait_for_completion_timeout(&wm8350->auxadc_done, msecs_to_jiffies(5));
223 
224 	reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
225 	if (reg & WM8350_AUXADC_POLL)
226 		dev_err(wm8350->dev, "adc chn %d read timeout\n", channel);
227 	else
228 		result = wm8350_reg_read(wm8350,
229 					 WM8350_AUX1_READBACK + channel);
230 
231 	/* Turn off the ADC */
232 	reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
233 	wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5,
234 			 reg & ~WM8350_AUXADC_ENA);
235 
236 	mutex_unlock(&wm8350->auxadc_mutex);
237 
238 	return result & WM8350_AUXADC_DATA1_MASK;
239 }
240 EXPORT_SYMBOL_GPL(wm8350_read_auxadc);
241 
242 static irqreturn_t wm8350_auxadc_irq(int irq, void *irq_data)
243 {
244 	struct wm8350 *wm8350 = irq_data;
245 
246 	complete(&wm8350->auxadc_done);
247 
248 	return IRQ_HANDLED;
249 }
250 
251 /*
252  * Register a client device.  This is non-fatal since there is no need to
253  * fail the entire device init due to a single platform device failing.
254  */
255 static void wm8350_client_dev_register(struct wm8350 *wm8350,
256 				       const char *name,
257 				       struct platform_device **pdev)
258 {
259 	int ret;
260 
261 	*pdev = platform_device_alloc(name, -1);
262 	if (*pdev == NULL) {
263 		dev_err(wm8350->dev, "Failed to allocate %s\n", name);
264 		return;
265 	}
266 
267 	(*pdev)->dev.parent = wm8350->dev;
268 	platform_set_drvdata(*pdev, wm8350);
269 	ret = platform_device_add(*pdev);
270 	if (ret != 0) {
271 		dev_err(wm8350->dev, "Failed to register %s: %d\n", name, ret);
272 		platform_device_put(*pdev);
273 		*pdev = NULL;
274 	}
275 }
276 
277 int wm8350_device_init(struct wm8350 *wm8350, int irq,
278 		       struct wm8350_platform_data *pdata)
279 {
280 	int ret;
281 	unsigned int id1, id2, mask_rev;
282 	unsigned int cust_id, mode, chip_rev;
283 
284 	dev_set_drvdata(wm8350->dev, wm8350);
285 
286 	/* get WM8350 revision and config mode */
287 	ret = regmap_read(wm8350->regmap, WM8350_RESET_ID, &id1);
288 	if (ret != 0) {
289 		dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
290 		goto err;
291 	}
292 
293 	ret = regmap_read(wm8350->regmap, WM8350_ID, &id2);
294 	if (ret != 0) {
295 		dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
296 		goto err;
297 	}
298 
299 	ret = regmap_read(wm8350->regmap, WM8350_REVISION, &mask_rev);
300 	if (ret != 0) {
301 		dev_err(wm8350->dev, "Failed to read revision: %d\n", ret);
302 		goto err;
303 	}
304 
305 	if (id1 != 0x6143) {
306 		dev_err(wm8350->dev,
307 			"Device with ID %x is not a WM8350\n", id1);
308 		ret = -ENODEV;
309 		goto err;
310 	}
311 
312 	mode = (id2 & WM8350_CONF_STS_MASK) >> 10;
313 	cust_id = id2 & WM8350_CUST_ID_MASK;
314 	chip_rev = (id2 & WM8350_CHIP_REV_MASK) >> 12;
315 	dev_info(wm8350->dev,
316 		 "CONF_STS %d, CUST_ID %d, MASK_REV %d, CHIP_REV %d\n",
317 		 mode, cust_id, mask_rev, chip_rev);
318 
319 	if (cust_id != 0) {
320 		dev_err(wm8350->dev, "Unsupported CUST_ID\n");
321 		ret = -ENODEV;
322 		goto err;
323 	}
324 
325 	switch (mask_rev) {
326 	case 0:
327 		wm8350->pmic.max_dcdc = WM8350_DCDC_6;
328 		wm8350->pmic.max_isink = WM8350_ISINK_B;
329 
330 		switch (chip_rev) {
331 		case WM8350_REV_E:
332 			dev_info(wm8350->dev, "WM8350 Rev E\n");
333 			break;
334 		case WM8350_REV_F:
335 			dev_info(wm8350->dev, "WM8350 Rev F\n");
336 			break;
337 		case WM8350_REV_G:
338 			dev_info(wm8350->dev, "WM8350 Rev G\n");
339 			wm8350->power.rev_g_coeff = 1;
340 			break;
341 		case WM8350_REV_H:
342 			dev_info(wm8350->dev, "WM8350 Rev H\n");
343 			wm8350->power.rev_g_coeff = 1;
344 			break;
345 		default:
346 			/* For safety we refuse to run on unknown hardware */
347 			dev_err(wm8350->dev, "Unknown WM8350 CHIP_REV\n");
348 			ret = -ENODEV;
349 			goto err;
350 		}
351 		break;
352 
353 	case 1:
354 		wm8350->pmic.max_dcdc = WM8350_DCDC_4;
355 		wm8350->pmic.max_isink = WM8350_ISINK_A;
356 
357 		switch (chip_rev) {
358 		case 0:
359 			dev_info(wm8350->dev, "WM8351 Rev A\n");
360 			wm8350->power.rev_g_coeff = 1;
361 			break;
362 
363 		case 1:
364 			dev_info(wm8350->dev, "WM8351 Rev B\n");
365 			wm8350->power.rev_g_coeff = 1;
366 			break;
367 
368 		default:
369 			dev_err(wm8350->dev, "Unknown WM8351 CHIP_REV\n");
370 			ret = -ENODEV;
371 			goto err;
372 		}
373 		break;
374 
375 	case 2:
376 		wm8350->pmic.max_dcdc = WM8350_DCDC_6;
377 		wm8350->pmic.max_isink = WM8350_ISINK_B;
378 
379 		switch (chip_rev) {
380 		case 0:
381 			dev_info(wm8350->dev, "WM8352 Rev A\n");
382 			wm8350->power.rev_g_coeff = 1;
383 			break;
384 
385 		default:
386 			dev_err(wm8350->dev, "Unknown WM8352 CHIP_REV\n");
387 			ret = -ENODEV;
388 			goto err;
389 		}
390 		break;
391 
392 	default:
393 		dev_err(wm8350->dev, "Unknown MASK_REV\n");
394 		ret = -ENODEV;
395 		goto err;
396 	}
397 
398 	mutex_init(&wm8350->auxadc_mutex);
399 	init_completion(&wm8350->auxadc_done);
400 
401 	ret = wm8350_irq_init(wm8350, irq, pdata);
402 	if (ret < 0)
403 		goto err;
404 
405 	if (wm8350->irq_base) {
406 		ret = request_threaded_irq(wm8350->irq_base +
407 					   WM8350_IRQ_AUXADC_DATARDY,
408 					   NULL, wm8350_auxadc_irq,
409 					   IRQF_ONESHOT,
410 					   "auxadc", wm8350);
411 		if (ret < 0)
412 			dev_warn(wm8350->dev,
413 				 "Failed to request AUXADC IRQ: %d\n", ret);
414 	}
415 
416 	if (pdata && pdata->init) {
417 		ret = pdata->init(wm8350);
418 		if (ret != 0) {
419 			dev_err(wm8350->dev, "Platform init() failed: %d\n",
420 				ret);
421 			goto err_irq;
422 		}
423 	}
424 
425 	wm8350_reg_write(wm8350, WM8350_SYSTEM_INTERRUPTS_MASK, 0x0);
426 
427 	wm8350_client_dev_register(wm8350, "wm8350-codec",
428 				   &(wm8350->codec.pdev));
429 	wm8350_client_dev_register(wm8350, "wm8350-gpio",
430 				   &(wm8350->gpio.pdev));
431 	wm8350_client_dev_register(wm8350, "wm8350-hwmon",
432 				   &(wm8350->hwmon.pdev));
433 	wm8350_client_dev_register(wm8350, "wm8350-power",
434 				   &(wm8350->power.pdev));
435 	wm8350_client_dev_register(wm8350, "wm8350-rtc", &(wm8350->rtc.pdev));
436 	wm8350_client_dev_register(wm8350, "wm8350-wdt", &(wm8350->wdt.pdev));
437 
438 	return 0;
439 
440 err_irq:
441 	wm8350_irq_exit(wm8350);
442 err:
443 	return ret;
444 }
445 EXPORT_SYMBOL_GPL(wm8350_device_init);
446