2 * wm8350-core.c -- Device access for Wolfson WM8350
4 * Copyright 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood, Mark Brown
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.
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/bug.h>
19 #include <linux/device.h>
20 #include <linux/delay.h>
21 #include <linux/interrupt.h>
22 #include <linux/workqueue.h>
24 #include <linux/mfd/wm8350/core.h>
25 #include <linux/mfd/wm8350/audio.h>
26 #include <linux/mfd/wm8350/comparator.h>
27 #include <linux/mfd/wm8350/gpio.h>
28 #include <linux/mfd/wm8350/pmic.h>
29 #include <linux/mfd/wm8350/rtc.h>
30 #include <linux/mfd/wm8350/supply.h>
31 #include <linux/mfd/wm8350/wdt.h>
33 #define WM8350_UNLOCK_KEY 0x0013
34 #define WM8350_LOCK_KEY 0x0000
36 #define WM8350_CLOCK_CONTROL_1 0x28
37 #define WM8350_AIF_TEST 0x74
40 #define WM8350_BUS_DEBUG 0
42 #define dump(regs, src) do { \
46 for (i_ = 0; i_ < regs; i_++) \
47 printk(" 0x%4.4x", *src_++); \
51 #define dump(bytes, src)
54 #define WM8350_LOCK_DEBUG 0
56 #define ldbg(format, arg...) printk(format, ## arg)
58 #define ldbg(format, arg...)
64 static DEFINE_MUTEX(io_mutex);
65 static DEFINE_MUTEX(reg_lock_mutex);
67 /* Perform a physical read from the device.
69 static int wm8350_phys_read(struct wm8350 *wm8350, u8 reg, int num_regs,
73 int bytes = num_regs * 2;
75 dev_dbg(wm8350->dev, "volatile read\n");
76 ret = wm8350->read_dev(wm8350, reg, bytes, (char *)dest);
78 for (i = reg; i < reg + num_regs; i++) {
79 /* Cache is CPU endian */
80 dest[i - reg] = be16_to_cpu(dest[i - reg]);
82 /* Mask out non-readable bits */
83 dest[i - reg] &= wm8350_reg_io_map[i].readable;
91 static int wm8350_read(struct wm8350 *wm8350, u8 reg, int num_regs, u16 *dest)
94 int end = reg + num_regs;
96 int bytes = num_regs * 2;
98 if (wm8350->read_dev == NULL)
101 if ((reg + num_regs - 1) > WM8350_MAX_REGISTER) {
102 dev_err(wm8350->dev, "invalid reg %x\n",
108 "%s R%d(0x%2.2x) %d regs\n", __func__, reg, reg, num_regs);
111 /* we can _safely_ read any register, but warn if read not supported */
112 for (i = reg; i < end; i++) {
113 if (!wm8350_reg_io_map[i].readable)
114 dev_warn(wm8350->dev,
115 "reg R%d is not readable\n", i);
119 /* if any volatile registers are required, then read back all */
120 for (i = reg; i < end; i++)
121 if (wm8350_reg_io_map[i].vol)
122 return wm8350_phys_read(wm8350, reg, num_regs, dest);
124 /* no volatiles, then cache is good */
125 dev_dbg(wm8350->dev, "cache read\n");
126 memcpy(dest, &wm8350->reg_cache[reg], bytes);
127 dump(num_regs, dest);
131 static inline int is_reg_locked(struct wm8350 *wm8350, u8 reg)
133 if (reg == WM8350_SECURITY ||
134 wm8350->reg_cache[WM8350_SECURITY] == WM8350_UNLOCK_KEY)
137 if ((reg >= WM8350_GPIO_FUNCTION_SELECT_1 &&
138 reg <= WM8350_GPIO_FUNCTION_SELECT_4) ||
139 (reg >= WM8350_BATTERY_CHARGER_CONTROL_1 &&
140 reg <= WM8350_BATTERY_CHARGER_CONTROL_3))
145 static int wm8350_write(struct wm8350 *wm8350, u8 reg, int num_regs, u16 *src)
148 int end = reg + num_regs;
149 int bytes = num_regs * 2;
151 if (wm8350->write_dev == NULL)
154 if ((reg + num_regs - 1) > WM8350_MAX_REGISTER) {
155 dev_err(wm8350->dev, "invalid reg %x\n",
160 /* it's generally not a good idea to write to RO or locked registers */
161 for (i = reg; i < end; i++) {
162 if (!wm8350_reg_io_map[i].writable) {
164 "attempted write to read only reg R%d\n", i);
168 if (is_reg_locked(wm8350, i)) {
170 "attempted write to locked reg R%d\n", i);
174 src[i - reg] &= wm8350_reg_io_map[i].writable;
176 wm8350->reg_cache[i] =
177 (wm8350->reg_cache[i] & ~wm8350_reg_io_map[i].writable)
180 src[i - reg] = cpu_to_be16(src[i - reg]);
183 /* Actually write it out */
184 return wm8350->write_dev(wm8350, reg, bytes, (char *)src);
188 * Safe read, modify, write methods
190 int wm8350_clear_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
195 mutex_lock(&io_mutex);
196 err = wm8350_read(wm8350, reg, 1, &data);
198 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
203 err = wm8350_write(wm8350, reg, 1, &data);
205 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
207 mutex_unlock(&io_mutex);
210 EXPORT_SYMBOL_GPL(wm8350_clear_bits);
212 int wm8350_set_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
217 mutex_lock(&io_mutex);
218 err = wm8350_read(wm8350, reg, 1, &data);
220 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
225 err = wm8350_write(wm8350, reg, 1, &data);
227 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
229 mutex_unlock(&io_mutex);
232 EXPORT_SYMBOL_GPL(wm8350_set_bits);
234 u16 wm8350_reg_read(struct wm8350 *wm8350, int reg)
239 mutex_lock(&io_mutex);
240 err = wm8350_read(wm8350, reg, 1, &data);
242 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
244 mutex_unlock(&io_mutex);
247 EXPORT_SYMBOL_GPL(wm8350_reg_read);
249 int wm8350_reg_write(struct wm8350 *wm8350, int reg, u16 val)
254 mutex_lock(&io_mutex);
255 ret = wm8350_write(wm8350, reg, 1, &data);
257 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
258 mutex_unlock(&io_mutex);
261 EXPORT_SYMBOL_GPL(wm8350_reg_write);
263 int wm8350_block_read(struct wm8350 *wm8350, int start_reg, int regs,
268 mutex_lock(&io_mutex);
269 err = wm8350_read(wm8350, start_reg, regs, dest);
271 dev_err(wm8350->dev, "block read starting from R%d failed\n",
273 mutex_unlock(&io_mutex);
276 EXPORT_SYMBOL_GPL(wm8350_block_read);
278 int wm8350_block_write(struct wm8350 *wm8350, int start_reg, int regs,
283 mutex_lock(&io_mutex);
284 ret = wm8350_write(wm8350, start_reg, regs, src);
286 dev_err(wm8350->dev, "block write starting at R%d failed\n",
288 mutex_unlock(&io_mutex);
291 EXPORT_SYMBOL_GPL(wm8350_block_write);
296 * The WM8350 has a hardware lock which can be used to prevent writes to
297 * some registers (generally those which can cause particularly serious
298 * problems if misused). This function enables that lock.
300 int wm8350_reg_lock(struct wm8350 *wm8350)
302 u16 key = WM8350_LOCK_KEY;
306 mutex_lock(&io_mutex);
307 ret = wm8350_write(wm8350, WM8350_SECURITY, 1, &key);
309 dev_err(wm8350->dev, "lock failed\n");
310 mutex_unlock(&io_mutex);
313 EXPORT_SYMBOL_GPL(wm8350_reg_lock);
316 * wm8350_reg_unlock()
318 * The WM8350 has a hardware lock which can be used to prevent writes to
319 * some registers (generally those which can cause particularly serious
320 * problems if misused). This function disables that lock so updates
321 * can be performed. For maximum safety this should be done only when
324 int wm8350_reg_unlock(struct wm8350 *wm8350)
326 u16 key = WM8350_UNLOCK_KEY;
330 mutex_lock(&io_mutex);
331 ret = wm8350_write(wm8350, WM8350_SECURITY, 1, &key);
333 dev_err(wm8350->dev, "unlock failed\n");
334 mutex_unlock(&io_mutex);
337 EXPORT_SYMBOL_GPL(wm8350_reg_unlock);
339 int wm8350_read_auxadc(struct wm8350 *wm8350, int channel, int scale, int vref)
343 if (channel < WM8350_AUXADC_AUX1 || channel > WM8350_AUXADC_TEMP)
345 if (channel >= WM8350_AUXADC_USB && channel <= WM8350_AUXADC_TEMP
346 && (scale != 0 || vref != 0))
349 mutex_lock(&wm8350->auxadc_mutex);
351 /* Turn on the ADC */
352 reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
353 wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5, reg | WM8350_AUXADC_ENA);
358 wm8350_reg_write(wm8350, WM8350_AUX1_READBACK + channel, reg);
361 reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
362 reg |= 1 << channel | WM8350_AUXADC_POLL;
363 wm8350_reg_write(wm8350, WM8350_DIGITISER_CONTROL_1, reg);
365 /* We ignore the result of the completion and just check for a
366 * conversion result, allowing us to soldier on if the IRQ
367 * infrastructure is not set up for the chip. */
368 wait_for_completion_timeout(&wm8350->auxadc_done, msecs_to_jiffies(5));
370 reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
371 if (reg & WM8350_AUXADC_POLL)
372 dev_err(wm8350->dev, "adc chn %d read timeout\n", channel);
374 result = wm8350_reg_read(wm8350,
375 WM8350_AUX1_READBACK + channel);
377 /* Turn off the ADC */
378 reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
379 wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5,
380 reg & ~WM8350_AUXADC_ENA);
382 mutex_unlock(&wm8350->auxadc_mutex);
384 return result & WM8350_AUXADC_DATA1_MASK;
386 EXPORT_SYMBOL_GPL(wm8350_read_auxadc);
388 static irqreturn_t wm8350_auxadc_irq(int irq, void *irq_data)
390 struct wm8350 *wm8350 = irq_data;
392 complete(&wm8350->auxadc_done);
398 * Cache is always host endian.
400 static int wm8350_create_cache(struct wm8350 *wm8350, int type, int mode)
409 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_0
411 reg_map = wm8350_mode0_defaults;
414 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_1
416 reg_map = wm8350_mode1_defaults;
419 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_2
421 reg_map = wm8350_mode2_defaults;
424 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_3
426 reg_map = wm8350_mode3_defaults;
431 "WM8350 configuration mode %d not supported\n",
439 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_0
441 reg_map = wm8351_mode0_defaults;
444 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_1
446 reg_map = wm8351_mode1_defaults;
449 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_2
451 reg_map = wm8351_mode2_defaults;
454 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_3
456 reg_map = wm8351_mode3_defaults;
461 "WM8351 configuration mode %d not supported\n",
469 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_0
471 reg_map = wm8352_mode0_defaults;
474 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_1
476 reg_map = wm8352_mode1_defaults;
479 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_2
481 reg_map = wm8352_mode2_defaults;
484 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_3
486 reg_map = wm8352_mode3_defaults;
491 "WM8352 configuration mode %d not supported\n",
499 "WM835x configuration mode %d not supported\n",
505 kmalloc(sizeof(u16) * (WM8350_MAX_REGISTER + 1), GFP_KERNEL);
506 if (wm8350->reg_cache == NULL)
509 /* Read the initial cache state back from the device - this is
510 * a PMIC so the device many not be in a virgin state and we
511 * can't rely on the silicon values.
513 ret = wm8350->read_dev(wm8350, 0,
514 sizeof(u16) * (WM8350_MAX_REGISTER + 1),
518 "failed to read initial cache values\n");
522 /* Mask out uncacheable/unreadable bits and the audio. */
523 for (i = 0; i < WM8350_MAX_REGISTER; i++) {
524 if (wm8350_reg_io_map[i].readable &&
525 (i < WM8350_CLOCK_CONTROL_1 || i > WM8350_AIF_TEST)) {
526 value = be16_to_cpu(wm8350->reg_cache[i]);
527 value &= wm8350_reg_io_map[i].readable;
528 wm8350->reg_cache[i] = value;
530 wm8350->reg_cache[i] = reg_map[i];
538 * Register a client device. This is non-fatal since there is no need to
539 * fail the entire device init due to a single platform device failing.
541 static void wm8350_client_dev_register(struct wm8350 *wm8350,
543 struct platform_device **pdev)
547 *pdev = platform_device_alloc(name, -1);
549 dev_err(wm8350->dev, "Failed to allocate %s\n", name);
553 (*pdev)->dev.parent = wm8350->dev;
554 platform_set_drvdata(*pdev, wm8350);
555 ret = platform_device_add(*pdev);
557 dev_err(wm8350->dev, "Failed to register %s: %d\n", name, ret);
558 platform_device_put(*pdev);
563 int wm8350_device_init(struct wm8350 *wm8350, int irq,
564 struct wm8350_platform_data *pdata)
567 u16 id1, id2, mask_rev;
568 u16 cust_id, mode, chip_rev;
570 /* get WM8350 revision and config mode */
571 ret = wm8350->read_dev(wm8350, WM8350_RESET_ID, sizeof(id1), &id1);
573 dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
577 ret = wm8350->read_dev(wm8350, WM8350_ID, sizeof(id2), &id2);
579 dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
583 ret = wm8350->read_dev(wm8350, WM8350_REVISION, sizeof(mask_rev),
586 dev_err(wm8350->dev, "Failed to read revision: %d\n", ret);
590 id1 = be16_to_cpu(id1);
591 id2 = be16_to_cpu(id2);
592 mask_rev = be16_to_cpu(mask_rev);
596 "Device with ID %x is not a WM8350\n", id1);
601 mode = id2 & WM8350_CONF_STS_MASK >> 10;
602 cust_id = id2 & WM8350_CUST_ID_MASK;
603 chip_rev = (id2 & WM8350_CHIP_REV_MASK) >> 12;
604 dev_info(wm8350->dev,
605 "CONF_STS %d, CUST_ID %d, MASK_REV %d, CHIP_REV %d\n",
606 mode, cust_id, mask_rev, chip_rev);
609 dev_err(wm8350->dev, "Unsupported CUST_ID\n");
616 wm8350->pmic.max_dcdc = WM8350_DCDC_6;
617 wm8350->pmic.max_isink = WM8350_ISINK_B;
621 dev_info(wm8350->dev, "WM8350 Rev E\n");
624 dev_info(wm8350->dev, "WM8350 Rev F\n");
627 dev_info(wm8350->dev, "WM8350 Rev G\n");
628 wm8350->power.rev_g_coeff = 1;
631 dev_info(wm8350->dev, "WM8350 Rev H\n");
632 wm8350->power.rev_g_coeff = 1;
635 /* For safety we refuse to run on unknown hardware */
636 dev_err(wm8350->dev, "Unknown WM8350 CHIP_REV\n");
643 wm8350->pmic.max_dcdc = WM8350_DCDC_4;
644 wm8350->pmic.max_isink = WM8350_ISINK_A;
648 dev_info(wm8350->dev, "WM8351 Rev A\n");
649 wm8350->power.rev_g_coeff = 1;
653 dev_info(wm8350->dev, "WM8351 Rev B\n");
654 wm8350->power.rev_g_coeff = 1;
658 dev_err(wm8350->dev, "Unknown WM8351 CHIP_REV\n");
665 wm8350->pmic.max_dcdc = WM8350_DCDC_6;
666 wm8350->pmic.max_isink = WM8350_ISINK_B;
670 dev_info(wm8350->dev, "WM8352 Rev A\n");
671 wm8350->power.rev_g_coeff = 1;
675 dev_err(wm8350->dev, "Unknown WM8352 CHIP_REV\n");
682 dev_err(wm8350->dev, "Unknown MASK_REV\n");
687 ret = wm8350_create_cache(wm8350, mask_rev, mode);
689 dev_err(wm8350->dev, "Failed to create register cache\n");
693 mutex_init(&wm8350->auxadc_mutex);
694 init_completion(&wm8350->auxadc_done);
696 ret = wm8350_irq_init(wm8350, irq, pdata);
700 if (wm8350->irq_base) {
701 ret = request_threaded_irq(wm8350->irq_base +
702 WM8350_IRQ_AUXADC_DATARDY,
703 NULL, wm8350_auxadc_irq, 0,
706 dev_warn(wm8350->dev,
707 "Failed to request AUXADC IRQ: %d\n", ret);
710 if (pdata && pdata->init) {
711 ret = pdata->init(wm8350);
713 dev_err(wm8350->dev, "Platform init() failed: %d\n",
719 wm8350_reg_write(wm8350, WM8350_SYSTEM_INTERRUPTS_MASK, 0x0);
721 wm8350_client_dev_register(wm8350, "wm8350-codec",
722 &(wm8350->codec.pdev));
723 wm8350_client_dev_register(wm8350, "wm8350-gpio",
724 &(wm8350->gpio.pdev));
725 wm8350_client_dev_register(wm8350, "wm8350-hwmon",
726 &(wm8350->hwmon.pdev));
727 wm8350_client_dev_register(wm8350, "wm8350-power",
728 &(wm8350->power.pdev));
729 wm8350_client_dev_register(wm8350, "wm8350-rtc", &(wm8350->rtc.pdev));
730 wm8350_client_dev_register(wm8350, "wm8350-wdt", &(wm8350->wdt.pdev));
735 wm8350_irq_exit(wm8350);
737 kfree(wm8350->reg_cache);
740 EXPORT_SYMBOL_GPL(wm8350_device_init);
742 void wm8350_device_exit(struct wm8350 *wm8350)
746 for (i = 0; i < ARRAY_SIZE(wm8350->pmic.led); i++)
747 platform_device_unregister(wm8350->pmic.led[i].pdev);
749 for (i = 0; i < ARRAY_SIZE(wm8350->pmic.pdev); i++)
750 platform_device_unregister(wm8350->pmic.pdev[i]);
752 platform_device_unregister(wm8350->wdt.pdev);
753 platform_device_unregister(wm8350->rtc.pdev);
754 platform_device_unregister(wm8350->power.pdev);
755 platform_device_unregister(wm8350->hwmon.pdev);
756 platform_device_unregister(wm8350->gpio.pdev);
757 platform_device_unregister(wm8350->codec.pdev);
759 if (wm8350->irq_base)
760 free_irq(wm8350->irq_base + WM8350_IRQ_AUXADC_DATARDY, wm8350);
762 wm8350_irq_exit(wm8350);
764 kfree(wm8350->reg_cache);
766 EXPORT_SYMBOL_GPL(wm8350_device_exit);
768 MODULE_DESCRIPTION("WM8350 AudioPlus PMIC core driver");
769 MODULE_LICENSE("GPL");