1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright 2009-2010 Pengutronix
4 * Uwe Kleine-Koenig <u.kleine-koenig@pengutronix.de>
5 *
6 * loosely based on an earlier driver that has
7 * Copyright 2009 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
8 */
9
10#include <linux/bitfield.h>
11#include <linux/module.h>
12#include <linux/of.h>
13#include <linux/of_device.h>
14#include <linux/platform_device.h>
15#include <linux/mfd/core.h>
16
17#include "mc13xxx.h"
18
19#define MC13XXX_IRQSTAT0 0
20#define MC13XXX_IRQMASK0 1
21#define MC13XXX_IRQSTAT1 3
22#define MC13XXX_IRQMASK1 4
23
24#define MC13XXX_REVISION 7
25#define MC13XXX_REVISION_REVMETAL (0x07 << 0)
26#define MC13XXX_REVISION_REVFULL (0x03 << 3)
27#define MC13XXX_REVISION_ICID (0x07 << 6)
28#define MC13XXX_REVISION_FIN (0x03 << 9)
29#define MC13XXX_REVISION_FAB (0x03 << 11)
30#define MC13XXX_REVISION_ICIDCODE (0x3f << 13)
31
32#define MC34708_REVISION_REVMETAL (0x07 << 0)
33#define MC34708_REVISION_REVFULL (0x07 << 3)
34#define MC34708_REVISION_FIN (0x07 << 6)
35#define MC34708_REVISION_FAB (0x07 << 9)
36
37#define MC13XXX_PWRCTRL 15
38#define MC13XXX_PWRCTRL_WDIRESET (1 << 12)
39
40#define MC13XXX_ADC1 44
41#define MC13XXX_ADC1_ADEN (1 << 0)
42#define MC13XXX_ADC1_RAND (1 << 1)
43#define MC13XXX_ADC1_ADSEL (1 << 3)
44#define MC13XXX_ADC1_ASC (1 << 20)
45#define MC13XXX_ADC1_ADTRIGIGN (1 << 21)
46
47#define MC13XXX_ADC2 45
48
49void mc13xxx_lock(struct mc13xxx *mc13xxx)
50{
51 if (!mutex_trylock(lock: &mc13xxx->lock)) {
52 dev_dbg(mc13xxx->dev, "wait for %s from %ps\n",
53 __func__, __builtin_return_address(0));
54
55 mutex_lock(&mc13xxx->lock);
56 }
57 dev_dbg(mc13xxx->dev, "%s from %ps\n",
58 __func__, __builtin_return_address(0));
59}
60EXPORT_SYMBOL(mc13xxx_lock);
61
62void mc13xxx_unlock(struct mc13xxx *mc13xxx)
63{
64 dev_dbg(mc13xxx->dev, "%s from %ps\n",
65 __func__, __builtin_return_address(0));
66 mutex_unlock(lock: &mc13xxx->lock);
67}
68EXPORT_SYMBOL(mc13xxx_unlock);
69
70int mc13xxx_reg_read(struct mc13xxx *mc13xxx, unsigned int offset, u32 *val)
71{
72 int ret;
73
74 ret = regmap_read(map: mc13xxx->regmap, reg: offset, val);
75 dev_vdbg(mc13xxx->dev, "[0x%02x] -> 0x%06x\n", offset, *val);
76
77 return ret;
78}
79EXPORT_SYMBOL(mc13xxx_reg_read);
80
81int mc13xxx_reg_write(struct mc13xxx *mc13xxx, unsigned int offset, u32 val)
82{
83 dev_vdbg(mc13xxx->dev, "[0x%02x] <- 0x%06x\n", offset, val);
84
85 if (val >= BIT(24))
86 return -EINVAL;
87
88 return regmap_write(map: mc13xxx->regmap, reg: offset, val);
89}
90EXPORT_SYMBOL(mc13xxx_reg_write);
91
92int mc13xxx_reg_rmw(struct mc13xxx *mc13xxx, unsigned int offset,
93 u32 mask, u32 val)
94{
95 BUG_ON(val & ~mask);
96 dev_vdbg(mc13xxx->dev, "[0x%02x] <- 0x%06x (mask: 0x%06x)\n",
97 offset, val, mask);
98
99 return regmap_update_bits(map: mc13xxx->regmap, reg: offset, mask, val);
100}
101EXPORT_SYMBOL(mc13xxx_reg_rmw);
102
103int mc13xxx_irq_mask(struct mc13xxx *mc13xxx, int irq)
104{
105 int virq = regmap_irq_get_virq(data: mc13xxx->irq_data, irq);
106
107 disable_irq_nosync(irq: virq);
108
109 return 0;
110}
111EXPORT_SYMBOL(mc13xxx_irq_mask);
112
113int mc13xxx_irq_unmask(struct mc13xxx *mc13xxx, int irq)
114{
115 int virq = regmap_irq_get_virq(data: mc13xxx->irq_data, irq);
116
117 enable_irq(irq: virq);
118
119 return 0;
120}
121EXPORT_SYMBOL(mc13xxx_irq_unmask);
122
123int mc13xxx_irq_status(struct mc13xxx *mc13xxx, int irq,
124 int *enabled, int *pending)
125{
126 int ret;
127 unsigned int offmask = irq < 24 ? MC13XXX_IRQMASK0 : MC13XXX_IRQMASK1;
128 unsigned int offstat = irq < 24 ? MC13XXX_IRQSTAT0 : MC13XXX_IRQSTAT1;
129 u32 irqbit = 1 << (irq < 24 ? irq : irq - 24);
130
131 if (irq < 0 || irq >= ARRAY_SIZE(mc13xxx->irqs))
132 return -EINVAL;
133
134 if (enabled) {
135 u32 mask;
136
137 ret = mc13xxx_reg_read(mc13xxx, offmask, &mask);
138 if (ret)
139 return ret;
140
141 *enabled = mask & irqbit;
142 }
143
144 if (pending) {
145 u32 stat;
146
147 ret = mc13xxx_reg_read(mc13xxx, offstat, &stat);
148 if (ret)
149 return ret;
150
151 *pending = stat & irqbit;
152 }
153
154 return 0;
155}
156EXPORT_SYMBOL(mc13xxx_irq_status);
157
158int mc13xxx_irq_request(struct mc13xxx *mc13xxx, int irq,
159 irq_handler_t handler, const char *name, void *dev)
160{
161 int virq = regmap_irq_get_virq(data: mc13xxx->irq_data, irq);
162
163 return devm_request_threaded_irq(dev: mc13xxx->dev, irq: virq, NULL, thread_fn: handler,
164 IRQF_ONESHOT, devname: name, dev_id: dev);
165}
166EXPORT_SYMBOL(mc13xxx_irq_request);
167
168int mc13xxx_irq_free(struct mc13xxx *mc13xxx, int irq, void *dev)
169{
170 int virq = regmap_irq_get_virq(data: mc13xxx->irq_data, irq);
171
172 devm_free_irq(dev: mc13xxx->dev, irq: virq, dev_id: dev);
173
174 return 0;
175}
176EXPORT_SYMBOL(mc13xxx_irq_free);
177
178static void mc13xxx_print_revision(struct mc13xxx *mc13xxx, u32 revision)
179{
180 dev_info(mc13xxx->dev, "%s: rev: %d.%d, "
181 "fin: %d, fab: %d, icid: %d/%d\n",
182 mc13xxx->variant->name,
183 FIELD_GET(MC13XXX_REVISION_REVFULL, revision),
184 FIELD_GET(MC13XXX_REVISION_REVMETAL, revision),
185 FIELD_GET(MC13XXX_REVISION_FIN, revision),
186 FIELD_GET(MC13XXX_REVISION_FAB, revision),
187 FIELD_GET(MC13XXX_REVISION_ICID, revision),
188 FIELD_GET(MC13XXX_REVISION_ICIDCODE, revision));
189}
190
191static void mc34708_print_revision(struct mc13xxx *mc13xxx, u32 revision)
192{
193 dev_info(mc13xxx->dev, "%s: rev %d.%d, fin: %d, fab: %d\n",
194 mc13xxx->variant->name,
195 FIELD_GET(MC34708_REVISION_REVFULL, revision),
196 FIELD_GET(MC34708_REVISION_REVMETAL, revision),
197 FIELD_GET(MC34708_REVISION_FIN, revision),
198 FIELD_GET(MC34708_REVISION_FAB, revision));
199}
200
201/* These are only exported for mc13xxx-i2c and mc13xxx-spi */
202struct mc13xxx_variant mc13xxx_variant_mc13783 = {
203 .name = "mc13783",
204 .print_revision = mc13xxx_print_revision,
205};
206EXPORT_SYMBOL_GPL(mc13xxx_variant_mc13783);
207
208struct mc13xxx_variant mc13xxx_variant_mc13892 = {
209 .name = "mc13892",
210 .print_revision = mc13xxx_print_revision,
211};
212EXPORT_SYMBOL_GPL(mc13xxx_variant_mc13892);
213
214struct mc13xxx_variant mc13xxx_variant_mc34708 = {
215 .name = "mc34708",
216 .print_revision = mc34708_print_revision,
217};
218EXPORT_SYMBOL_GPL(mc13xxx_variant_mc34708);
219
220static const char *mc13xxx_get_chipname(struct mc13xxx *mc13xxx)
221{
222 return mc13xxx->variant->name;
223}
224
225int mc13xxx_get_flags(struct mc13xxx *mc13xxx)
226{
227 return mc13xxx->flags;
228}
229EXPORT_SYMBOL(mc13xxx_get_flags);
230
231#define MC13XXX_ADC1_CHAN0_SHIFT 5
232#define MC13XXX_ADC1_CHAN1_SHIFT 8
233#define MC13783_ADC1_ATO_SHIFT 11
234#define MC13783_ADC1_ATOX (1 << 19)
235
236struct mc13xxx_adcdone_data {
237 struct mc13xxx *mc13xxx;
238 struct completion done;
239};
240
241static irqreturn_t mc13xxx_handler_adcdone(int irq, void *data)
242{
243 struct mc13xxx_adcdone_data *adcdone_data = data;
244
245 complete_all(&adcdone_data->done);
246
247 return IRQ_HANDLED;
248}
249
250#define MC13XXX_ADC_WORKING (1 << 0)
251
252int mc13xxx_adc_do_conversion(struct mc13xxx *mc13xxx, unsigned int mode,
253 unsigned int channel, u8 ato, bool atox,
254 unsigned int *sample)
255{
256 u32 adc0, adc1, old_adc0;
257 int i, ret;
258 struct mc13xxx_adcdone_data adcdone_data = {
259 .mc13xxx = mc13xxx,
260 };
261 init_completion(x: &adcdone_data.done);
262
263 dev_dbg(mc13xxx->dev, "%s\n", __func__);
264
265 mc13xxx_lock(mc13xxx);
266
267 if (mc13xxx->adcflags & MC13XXX_ADC_WORKING) {
268 ret = -EBUSY;
269 goto out;
270 }
271
272 mc13xxx->adcflags |= MC13XXX_ADC_WORKING;
273
274 ret = mc13xxx_reg_read(mc13xxx, MC13XXX_ADC0, &old_adc0);
275 if (ret)
276 goto out;
277
278 adc0 = MC13XXX_ADC0_ADINC1 | MC13XXX_ADC0_ADINC2 |
279 MC13XXX_ADC0_CHRGRAWDIV;
280 adc1 = MC13XXX_ADC1_ADEN | MC13XXX_ADC1_ADTRIGIGN | MC13XXX_ADC1_ASC;
281
282 /*
283 * Channels mapped through ADIN7:
284 * 7 - General purpose ADIN7
285 * 16 - UID
286 * 17 - Die temperature
287 */
288 if (channel > 7 && channel < 16) {
289 adc1 |= MC13XXX_ADC1_ADSEL;
290 } else if (channel == 16) {
291 adc0 |= MC13XXX_ADC0_ADIN7SEL_UID;
292 channel = 7;
293 } else if (channel == 17) {
294 adc0 |= MC13XXX_ADC0_ADIN7SEL_DIE;
295 channel = 7;
296 }
297
298 switch (mode) {
299 case MC13XXX_ADC_MODE_TS:
300 adc0 |= MC13XXX_ADC0_ADREFEN | MC13XXX_ADC0_TSMOD0 |
301 MC13XXX_ADC0_TSMOD1;
302 adc1 |= 4 << MC13XXX_ADC1_CHAN1_SHIFT;
303 break;
304
305 case MC13XXX_ADC_MODE_SINGLE_CHAN:
306 adc0 |= old_adc0 & MC13XXX_ADC0_CONFIG_MASK;
307 adc1 |= (channel & 0x7) << MC13XXX_ADC1_CHAN0_SHIFT;
308 adc1 |= MC13XXX_ADC1_RAND;
309 break;
310
311 case MC13XXX_ADC_MODE_MULT_CHAN:
312 adc0 |= old_adc0 & MC13XXX_ADC0_CONFIG_MASK;
313 adc1 |= 4 << MC13XXX_ADC1_CHAN1_SHIFT;
314 break;
315
316 default:
317 mc13xxx_unlock(mc13xxx);
318 return -EINVAL;
319 }
320
321 adc1 |= ato << MC13783_ADC1_ATO_SHIFT;
322 if (atox)
323 adc1 |= MC13783_ADC1_ATOX;
324
325 dev_dbg(mc13xxx->dev, "%s: request irq\n", __func__);
326 ret = mc13xxx_irq_request(mc13xxx, MC13XXX_IRQ_ADCDONE,
327 mc13xxx_handler_adcdone, __func__, &adcdone_data);
328 if (ret)
329 goto out;
330
331 mc13xxx_reg_write(mc13xxx, MC13XXX_ADC0, adc0);
332 mc13xxx_reg_write(mc13xxx, MC13XXX_ADC1, adc1);
333
334 mc13xxx_unlock(mc13xxx);
335
336 ret = wait_for_completion_interruptible_timeout(x: &adcdone_data.done, HZ);
337
338 if (!ret)
339 ret = -ETIMEDOUT;
340
341 mc13xxx_lock(mc13xxx);
342
343 mc13xxx_irq_free(mc13xxx, MC13XXX_IRQ_ADCDONE, &adcdone_data);
344
345 if (ret > 0)
346 for (i = 0; i < 4; ++i) {
347 ret = mc13xxx_reg_read(mc13xxx,
348 MC13XXX_ADC2, &sample[i]);
349 if (ret)
350 break;
351 }
352
353 if (mode == MC13XXX_ADC_MODE_TS)
354 /* restore TSMOD */
355 mc13xxx_reg_write(mc13xxx, MC13XXX_ADC0, old_adc0);
356
357 mc13xxx->adcflags &= ~MC13XXX_ADC_WORKING;
358out:
359 mc13xxx_unlock(mc13xxx);
360
361 return ret;
362}
363EXPORT_SYMBOL_GPL(mc13xxx_adc_do_conversion);
364
365static int mc13xxx_add_subdevice_pdata(struct mc13xxx *mc13xxx,
366 const char *format, void *pdata, size_t pdata_size)
367{
368 char buf[30];
369 const char *name = mc13xxx_get_chipname(mc13xxx);
370
371 struct mfd_cell cell = {
372 .platform_data = pdata,
373 .pdata_size = pdata_size,
374 };
375
376 /* there is no asnprintf in the kernel :-( */
377 if (snprintf(buf, size: sizeof(buf), fmt: format, name) > sizeof(buf))
378 return -E2BIG;
379
380 cell.name = kmemdup(p: buf, strlen(buf) + 1, GFP_KERNEL);
381 if (!cell.name)
382 return -ENOMEM;
383
384 return mfd_add_devices(parent: mc13xxx->dev, id: -1, cells: &cell, n_devs: 1, NULL, irq_base: 0,
385 irq_domain: regmap_irq_get_domain(data: mc13xxx->irq_data));
386}
387
388static int mc13xxx_add_subdevice(struct mc13xxx *mc13xxx, const char *format)
389{
390 return mc13xxx_add_subdevice_pdata(mc13xxx, format, NULL, pdata_size: 0);
391}
392
393#ifdef CONFIG_OF
394static int mc13xxx_probe_flags_dt(struct mc13xxx *mc13xxx)
395{
396 struct device_node *np = mc13xxx->dev->of_node;
397
398 if (!np)
399 return -ENODEV;
400
401 if (of_property_read_bool(np, propname: "fsl,mc13xxx-uses-adc"))
402 mc13xxx->flags |= MC13XXX_USE_ADC;
403
404 if (of_property_read_bool(np, propname: "fsl,mc13xxx-uses-codec"))
405 mc13xxx->flags |= MC13XXX_USE_CODEC;
406
407 if (of_property_read_bool(np, propname: "fsl,mc13xxx-uses-rtc"))
408 mc13xxx->flags |= MC13XXX_USE_RTC;
409
410 if (of_property_read_bool(np, propname: "fsl,mc13xxx-uses-touch"))
411 mc13xxx->flags |= MC13XXX_USE_TOUCHSCREEN;
412
413 return 0;
414}
415#else
416static inline int mc13xxx_probe_flags_dt(struct mc13xxx *mc13xxx)
417{
418 return -ENODEV;
419}
420#endif
421
422int mc13xxx_common_init(struct device *dev)
423{
424 struct mc13xxx_platform_data *pdata = dev_get_platdata(dev);
425 struct mc13xxx *mc13xxx = dev_get_drvdata(dev);
426 u32 revision;
427 int i, ret;
428
429 mc13xxx->dev = dev;
430
431 ret = mc13xxx_reg_read(mc13xxx, MC13XXX_REVISION, &revision);
432 if (ret)
433 return ret;
434
435 mc13xxx->variant->print_revision(mc13xxx, revision);
436
437 ret = mc13xxx_reg_rmw(mc13xxx, MC13XXX_PWRCTRL,
438 MC13XXX_PWRCTRL_WDIRESET, MC13XXX_PWRCTRL_WDIRESET);
439 if (ret)
440 return ret;
441
442 for (i = 0; i < ARRAY_SIZE(mc13xxx->irqs); i++) {
443 mc13xxx->irqs[i].reg_offset = i / MC13XXX_IRQ_PER_REG;
444 mc13xxx->irqs[i].mask = BIT(i % MC13XXX_IRQ_PER_REG);
445 }
446
447 mc13xxx->irq_chip.name = dev_name(dev);
448 mc13xxx->irq_chip.status_base = MC13XXX_IRQSTAT0;
449 mc13xxx->irq_chip.mask_base = MC13XXX_IRQMASK0;
450 mc13xxx->irq_chip.ack_base = MC13XXX_IRQSTAT0;
451 mc13xxx->irq_chip.irq_reg_stride = MC13XXX_IRQSTAT1 - MC13XXX_IRQSTAT0;
452 mc13xxx->irq_chip.init_ack_masked = true;
453 mc13xxx->irq_chip.use_ack = true;
454 mc13xxx->irq_chip.num_regs = MC13XXX_IRQ_REG_CNT;
455 mc13xxx->irq_chip.irqs = mc13xxx->irqs;
456 mc13xxx->irq_chip.num_irqs = ARRAY_SIZE(mc13xxx->irqs);
457
458 ret = regmap_add_irq_chip(map: mc13xxx->regmap, irq: mc13xxx->irq, IRQF_ONESHOT,
459 irq_base: 0, chip: &mc13xxx->irq_chip, data: &mc13xxx->irq_data);
460 if (ret)
461 return ret;
462
463 mutex_init(&mc13xxx->lock);
464
465 if (mc13xxx_probe_flags_dt(mc13xxx) < 0 && pdata)
466 mc13xxx->flags = pdata->flags;
467
468 if (pdata) {
469 mc13xxx_add_subdevice_pdata(mc13xxx, format: "%s-regulator",
470 pdata: &pdata->regulators, pdata_size: sizeof(pdata->regulators));
471 mc13xxx_add_subdevice_pdata(mc13xxx, format: "%s-led",
472 pdata: pdata->leds, pdata_size: sizeof(*pdata->leds));
473 mc13xxx_add_subdevice_pdata(mc13xxx, format: "%s-pwrbutton",
474 pdata: pdata->buttons, pdata_size: sizeof(*pdata->buttons));
475 if (mc13xxx->flags & MC13XXX_USE_CODEC)
476 mc13xxx_add_subdevice_pdata(mc13xxx, format: "%s-codec",
477 pdata: pdata->codec, pdata_size: sizeof(*pdata->codec));
478 if (mc13xxx->flags & MC13XXX_USE_TOUCHSCREEN)
479 mc13xxx_add_subdevice_pdata(mc13xxx, format: "%s-ts",
480 pdata: &pdata->touch, pdata_size: sizeof(pdata->touch));
481 } else {
482 mc13xxx_add_subdevice(mc13xxx, format: "%s-regulator");
483 mc13xxx_add_subdevice(mc13xxx, format: "%s-led");
484 mc13xxx_add_subdevice(mc13xxx, format: "%s-pwrbutton");
485 if (mc13xxx->flags & MC13XXX_USE_CODEC)
486 mc13xxx_add_subdevice(mc13xxx, format: "%s-codec");
487 if (mc13xxx->flags & MC13XXX_USE_TOUCHSCREEN)
488 mc13xxx_add_subdevice(mc13xxx, format: "%s-ts");
489 }
490
491 if (mc13xxx->flags & MC13XXX_USE_ADC)
492 mc13xxx_add_subdevice(mc13xxx, format: "%s-adc");
493
494 if (mc13xxx->flags & MC13XXX_USE_RTC)
495 mc13xxx_add_subdevice(mc13xxx, format: "%s-rtc");
496
497 return 0;
498}
499EXPORT_SYMBOL_GPL(mc13xxx_common_init);
500
501void mc13xxx_common_exit(struct device *dev)
502{
503 struct mc13xxx *mc13xxx = dev_get_drvdata(dev);
504
505 mfd_remove_devices(parent: dev);
506 regmap_del_irq_chip(irq: mc13xxx->irq, data: mc13xxx->irq_data);
507 mutex_destroy(lock: &mc13xxx->lock);
508}
509EXPORT_SYMBOL_GPL(mc13xxx_common_exit);
510
511MODULE_DESCRIPTION("Core driver for Freescale MC13XXX PMIC");
512MODULE_AUTHOR("Uwe Kleine-Koenig <u.kleine-koenig@pengutronix.de>");
513MODULE_LICENSE("GPL v2");
514

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