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_CONFIGURATION_I_O) ||
138 (reg >= WM8350_GPIO_FUNCTION_SELECT_1 &&
139 reg <= WM8350_GPIO_FUNCTION_SELECT_4) ||
140 (reg >= WM8350_BATTERY_CHARGER_CONTROL_1 &&
141 reg <= WM8350_BATTERY_CHARGER_CONTROL_3))
146 static int wm8350_write(struct wm8350 *wm8350, u8 reg, int num_regs, u16 *src)
149 int end = reg + num_regs;
150 int bytes = num_regs * 2;
152 if (wm8350->write_dev == NULL)
155 if ((reg + num_regs - 1) > WM8350_MAX_REGISTER) {
156 dev_err(wm8350->dev, "invalid reg %x\n",
161 /* it's generally not a good idea to write to RO or locked registers */
162 for (i = reg; i < end; i++) {
163 if (!wm8350_reg_io_map[i].writable) {
165 "attempted write to read only reg R%d\n", i);
169 if (is_reg_locked(wm8350, i)) {
171 "attempted write to locked reg R%d\n", i);
175 src[i - reg] &= wm8350_reg_io_map[i].writable;
177 wm8350->reg_cache[i] =
178 (wm8350->reg_cache[i] & ~wm8350_reg_io_map[i].writable)
181 src[i - reg] = cpu_to_be16(src[i - reg]);
184 /* Actually write it out */
185 return wm8350->write_dev(wm8350, reg, bytes, (char *)src);
189 * Safe read, modify, write methods
191 int wm8350_clear_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
196 mutex_lock(&io_mutex);
197 err = wm8350_read(wm8350, reg, 1, &data);
199 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
204 err = wm8350_write(wm8350, reg, 1, &data);
206 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
208 mutex_unlock(&io_mutex);
211 EXPORT_SYMBOL_GPL(wm8350_clear_bits);
213 int wm8350_set_bits(struct wm8350 *wm8350, u16 reg, u16 mask)
218 mutex_lock(&io_mutex);
219 err = wm8350_read(wm8350, reg, 1, &data);
221 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
226 err = wm8350_write(wm8350, reg, 1, &data);
228 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
230 mutex_unlock(&io_mutex);
233 EXPORT_SYMBOL_GPL(wm8350_set_bits);
235 u16 wm8350_reg_read(struct wm8350 *wm8350, int reg)
240 mutex_lock(&io_mutex);
241 err = wm8350_read(wm8350, reg, 1, &data);
243 dev_err(wm8350->dev, "read from reg R%d failed\n", reg);
245 mutex_unlock(&io_mutex);
248 EXPORT_SYMBOL_GPL(wm8350_reg_read);
250 int wm8350_reg_write(struct wm8350 *wm8350, int reg, u16 val)
255 mutex_lock(&io_mutex);
256 ret = wm8350_write(wm8350, reg, 1, &data);
258 dev_err(wm8350->dev, "write to reg R%d failed\n", reg);
259 mutex_unlock(&io_mutex);
262 EXPORT_SYMBOL_GPL(wm8350_reg_write);
264 int wm8350_block_read(struct wm8350 *wm8350, int start_reg, int regs,
269 mutex_lock(&io_mutex);
270 err = wm8350_read(wm8350, start_reg, regs, dest);
272 dev_err(wm8350->dev, "block read starting from R%d failed\n",
274 mutex_unlock(&io_mutex);
277 EXPORT_SYMBOL_GPL(wm8350_block_read);
279 int wm8350_block_write(struct wm8350 *wm8350, int start_reg, int regs,
284 mutex_lock(&io_mutex);
285 ret = wm8350_write(wm8350, start_reg, regs, src);
287 dev_err(wm8350->dev, "block write starting at R%d failed\n",
289 mutex_unlock(&io_mutex);
292 EXPORT_SYMBOL_GPL(wm8350_block_write);
297 * The WM8350 has a hardware lock which can be used to prevent writes to
298 * some registers (generally those which can cause particularly serious
299 * problems if misused). This function enables that lock.
301 int wm8350_reg_lock(struct wm8350 *wm8350)
303 u16 key = WM8350_LOCK_KEY;
307 mutex_lock(&io_mutex);
308 ret = wm8350_write(wm8350, WM8350_SECURITY, 1, &key);
310 dev_err(wm8350->dev, "lock failed\n");
311 mutex_unlock(&io_mutex);
314 EXPORT_SYMBOL_GPL(wm8350_reg_lock);
317 * wm8350_reg_unlock()
319 * The WM8350 has a hardware lock which can be used to prevent writes to
320 * some registers (generally those which can cause particularly serious
321 * problems if misused). This function disables that lock so updates
322 * can be performed. For maximum safety this should be done only when
325 int wm8350_reg_unlock(struct wm8350 *wm8350)
327 u16 key = WM8350_UNLOCK_KEY;
331 mutex_lock(&io_mutex);
332 ret = wm8350_write(wm8350, WM8350_SECURITY, 1, &key);
334 dev_err(wm8350->dev, "unlock failed\n");
335 mutex_unlock(&io_mutex);
338 EXPORT_SYMBOL_GPL(wm8350_reg_unlock);
340 int wm8350_read_auxadc(struct wm8350 *wm8350, int channel, int scale, int vref)
345 if (channel < WM8350_AUXADC_AUX1 || channel > WM8350_AUXADC_TEMP)
347 if (channel >= WM8350_AUXADC_USB && channel <= WM8350_AUXADC_TEMP
348 && (scale != 0 || vref != 0))
351 mutex_lock(&wm8350->auxadc_mutex);
353 /* Turn on the ADC */
354 reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
355 wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5, reg | WM8350_AUXADC_ENA);
360 wm8350_reg_write(wm8350, WM8350_AUX1_READBACK + channel, reg);
363 reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
364 reg |= 1 << channel | WM8350_AUXADC_POLL;
365 wm8350_reg_write(wm8350, WM8350_DIGITISER_CONTROL_1, reg);
368 schedule_timeout_interruptible(1);
369 reg = wm8350_reg_read(wm8350, WM8350_DIGITISER_CONTROL_1);
370 } while ((reg & WM8350_AUXADC_POLL) && --tries);
373 dev_err(wm8350->dev, "adc chn %d read timeout\n", channel);
375 result = wm8350_reg_read(wm8350,
376 WM8350_AUX1_READBACK + channel);
378 /* Turn off the ADC */
379 reg = wm8350_reg_read(wm8350, WM8350_POWER_MGMT_5);
380 wm8350_reg_write(wm8350, WM8350_POWER_MGMT_5,
381 reg & ~WM8350_AUXADC_ENA);
383 mutex_unlock(&wm8350->auxadc_mutex);
385 return result & WM8350_AUXADC_DATA1_MASK;
387 EXPORT_SYMBOL_GPL(wm8350_read_auxadc);
390 * Cache is always host endian.
392 static int wm8350_create_cache(struct wm8350 *wm8350, int type, int mode)
401 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_0
403 reg_map = wm8350_mode0_defaults;
406 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_1
408 reg_map = wm8350_mode1_defaults;
411 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_2
413 reg_map = wm8350_mode2_defaults;
416 #ifdef CONFIG_MFD_WM8350_CONFIG_MODE_3
418 reg_map = wm8350_mode3_defaults;
423 "WM8350 configuration mode %d not supported\n",
431 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_0
433 reg_map = wm8351_mode0_defaults;
436 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_1
438 reg_map = wm8351_mode1_defaults;
441 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_2
443 reg_map = wm8351_mode2_defaults;
446 #ifdef CONFIG_MFD_WM8351_CONFIG_MODE_3
448 reg_map = wm8351_mode3_defaults;
453 "WM8351 configuration mode %d not supported\n",
461 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_0
463 reg_map = wm8352_mode0_defaults;
466 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_1
468 reg_map = wm8352_mode1_defaults;
471 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_2
473 reg_map = wm8352_mode2_defaults;
476 #ifdef CONFIG_MFD_WM8352_CONFIG_MODE_3
478 reg_map = wm8352_mode3_defaults;
483 "WM8352 configuration mode %d not supported\n",
491 "WM835x configuration mode %d not supported\n",
497 kmalloc(sizeof(u16) * (WM8350_MAX_REGISTER + 1), GFP_KERNEL);
498 if (wm8350->reg_cache == NULL)
501 /* Read the initial cache state back from the device - this is
502 * a PMIC so the device many not be in a virgin state and we
503 * can't rely on the silicon values.
505 ret = wm8350->read_dev(wm8350, 0,
506 sizeof(u16) * (WM8350_MAX_REGISTER + 1),
510 "failed to read initial cache values\n");
514 /* Mask out uncacheable/unreadable bits and the audio. */
515 for (i = 0; i < WM8350_MAX_REGISTER; i++) {
516 if (wm8350_reg_io_map[i].readable &&
517 (i < WM8350_CLOCK_CONTROL_1 || i > WM8350_AIF_TEST)) {
518 value = be16_to_cpu(wm8350->reg_cache[i]);
519 value &= wm8350_reg_io_map[i].readable;
520 wm8350->reg_cache[i] = value;
522 wm8350->reg_cache[i] = reg_map[i];
530 * Register a client device. This is non-fatal since there is no need to
531 * fail the entire device init due to a single platform device failing.
533 static void wm8350_client_dev_register(struct wm8350 *wm8350,
535 struct platform_device **pdev)
539 *pdev = platform_device_alloc(name, -1);
541 dev_err(wm8350->dev, "Failed to allocate %s\n", name);
545 (*pdev)->dev.parent = wm8350->dev;
546 platform_set_drvdata(*pdev, wm8350);
547 ret = platform_device_add(*pdev);
549 dev_err(wm8350->dev, "Failed to register %s: %d\n", name, ret);
550 platform_device_put(*pdev);
555 int wm8350_device_init(struct wm8350 *wm8350, int irq,
556 struct wm8350_platform_data *pdata)
559 u16 id1, id2, mask_rev;
560 u16 cust_id, mode, chip_rev;
562 /* get WM8350 revision and config mode */
563 ret = wm8350->read_dev(wm8350, WM8350_RESET_ID, sizeof(id1), &id1);
565 dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
569 ret = wm8350->read_dev(wm8350, WM8350_ID, sizeof(id2), &id2);
571 dev_err(wm8350->dev, "Failed to read ID: %d\n", ret);
575 ret = wm8350->read_dev(wm8350, WM8350_REVISION, sizeof(mask_rev),
578 dev_err(wm8350->dev, "Failed to read revision: %d\n", ret);
582 id1 = be16_to_cpu(id1);
583 id2 = be16_to_cpu(id2);
584 mask_rev = be16_to_cpu(mask_rev);
588 "Device with ID %x is not a WM8350\n", id1);
593 mode = id2 & WM8350_CONF_STS_MASK >> 10;
594 cust_id = id2 & WM8350_CUST_ID_MASK;
595 chip_rev = (id2 & WM8350_CHIP_REV_MASK) >> 12;
596 dev_info(wm8350->dev,
597 "CONF_STS %d, CUST_ID %d, MASK_REV %d, CHIP_REV %d\n",
598 mode, cust_id, mask_rev, chip_rev);
601 dev_err(wm8350->dev, "Unsupported CUST_ID\n");
608 wm8350->pmic.max_dcdc = WM8350_DCDC_6;
609 wm8350->pmic.max_isink = WM8350_ISINK_B;
613 dev_info(wm8350->dev, "WM8350 Rev E\n");
616 dev_info(wm8350->dev, "WM8350 Rev F\n");
619 dev_info(wm8350->dev, "WM8350 Rev G\n");
620 wm8350->power.rev_g_coeff = 1;
623 dev_info(wm8350->dev, "WM8350 Rev H\n");
624 wm8350->power.rev_g_coeff = 1;
627 /* For safety we refuse to run on unknown hardware */
628 dev_err(wm8350->dev, "Unknown WM8350 CHIP_REV\n");
635 wm8350->pmic.max_dcdc = WM8350_DCDC_4;
636 wm8350->pmic.max_isink = WM8350_ISINK_A;
640 dev_info(wm8350->dev, "WM8351 Rev A\n");
641 wm8350->power.rev_g_coeff = 1;
645 dev_info(wm8350->dev, "WM8351 Rev B\n");
646 wm8350->power.rev_g_coeff = 1;
650 dev_err(wm8350->dev, "Unknown WM8351 CHIP_REV\n");
657 wm8350->pmic.max_dcdc = WM8350_DCDC_6;
658 wm8350->pmic.max_isink = WM8350_ISINK_B;
662 dev_info(wm8350->dev, "WM8352 Rev A\n");
663 wm8350->power.rev_g_coeff = 1;
667 dev_err(wm8350->dev, "Unknown WM8352 CHIP_REV\n");
674 dev_err(wm8350->dev, "Unknown MASK_REV\n");
679 ret = wm8350_create_cache(wm8350, mask_rev, mode);
681 dev_err(wm8350->dev, "Failed to create register cache\n");
685 mutex_init(&wm8350->auxadc_mutex);
687 ret = wm8350_irq_init(wm8350, irq, pdata);
691 if (pdata && pdata->init) {
692 ret = pdata->init(wm8350);
694 dev_err(wm8350->dev, "Platform init() failed: %d\n",
700 wm8350_reg_write(wm8350, WM8350_SYSTEM_INTERRUPTS_MASK, 0x0);
702 wm8350_client_dev_register(wm8350, "wm8350-codec",
703 &(wm8350->codec.pdev));
704 wm8350_client_dev_register(wm8350, "wm8350-gpio",
705 &(wm8350->gpio.pdev));
706 wm8350_client_dev_register(wm8350, "wm8350-hwmon",
707 &(wm8350->hwmon.pdev));
708 wm8350_client_dev_register(wm8350, "wm8350-power",
709 &(wm8350->power.pdev));
710 wm8350_client_dev_register(wm8350, "wm8350-rtc", &(wm8350->rtc.pdev));
711 wm8350_client_dev_register(wm8350, "wm8350-wdt", &(wm8350->wdt.pdev));
716 wm8350_irq_exit(wm8350);
718 kfree(wm8350->reg_cache);
721 EXPORT_SYMBOL_GPL(wm8350_device_init);
723 void wm8350_device_exit(struct wm8350 *wm8350)
727 for (i = 0; i < ARRAY_SIZE(wm8350->pmic.led); i++)
728 platform_device_unregister(wm8350->pmic.led[i].pdev);
730 for (i = 0; i < ARRAY_SIZE(wm8350->pmic.pdev); i++)
731 platform_device_unregister(wm8350->pmic.pdev[i]);
733 platform_device_unregister(wm8350->wdt.pdev);
734 platform_device_unregister(wm8350->rtc.pdev);
735 platform_device_unregister(wm8350->power.pdev);
736 platform_device_unregister(wm8350->hwmon.pdev);
737 platform_device_unregister(wm8350->gpio.pdev);
738 platform_device_unregister(wm8350->codec.pdev);
740 wm8350_irq_exit(wm8350);
742 kfree(wm8350->reg_cache);
744 EXPORT_SYMBOL_GPL(wm8350_device_exit);
746 MODULE_DESCRIPTION("WM8350 AudioPlus PMIC core driver");
747 MODULE_LICENSE("GPL");