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

source code of linux/drivers/mfd/wm8350-core.c