Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * LED driver for Mediatek MT6323 PMIC
4 *
5 * Copyright (C) 2017 Sean Wang <sean.wang@mediatek.com>
6 */
7#include <linux/kernel.h>
8#include <linux/leds.h>
9#include <linux/mfd/mt6323/registers.h>
10#include <linux/mfd/mt6397/core.h>
11#include <linux/module.h>
12#include <linux/of.h>
13#include <linux/platform_device.h>
14#include <linux/regmap.h>
15
16/*
17 * Register field for TOP_CKPDN0 to enable
18 * 32K clock common for LED device.
19 */
20#define RG_DRV_32K_CK_PDN BIT(11)
21#define RG_DRV_32K_CK_PDN_MASK BIT(11)
22
23/* 32K/1M/6M clock common for WLED device */
24#define RG_VWLED_1M_CK_PDN BIT(0)
25#define RG_VWLED_32K_CK_PDN BIT(12)
26#define RG_VWLED_6M_CK_PDN BIT(13)
27
28/*
29 * Register field for TOP_CKPDN2 to enable
30 * individual clock for LED device.
31 */
32#define RG_ISINK_CK_PDN(i) BIT(i)
33#define RG_ISINK_CK_PDN_MASK(i) BIT(i)
34
35/*
36 * Register field for TOP_CKCON1 to select
37 * clock source.
38 */
39#define RG_ISINK_CK_SEL_MASK(i) (BIT(10) << (i))
40
41#define ISINK_CON(r, i) (r + 0x8 * (i))
42
43/* ISINK_CON0: Register to setup the duty cycle of the blink. */
44#define ISINK_DIM_DUTY_MASK (0x1f << 8)
45#define ISINK_DIM_DUTY(i) (((i) << 8) & ISINK_DIM_DUTY_MASK)
46
47/* ISINK_CON1: Register to setup the period of the blink. */
48#define ISINK_DIM_FSEL_MASK (0xffff)
49#define ISINK_DIM_FSEL(i) ((i) & ISINK_DIM_FSEL_MASK)
50
51/* ISINK_CON2: Register to control the brightness. */
52#define ISINK_CH_STEP_SHIFT 12
53#define ISINK_CH_STEP_MASK (0x7 << 12)
54#define ISINK_CH_STEP(i) (((i) << 12) & ISINK_CH_STEP_MASK)
55#define ISINK_SFSTR0_TC_MASK (0x3 << 1)
56#define ISINK_SFSTR0_TC(i) (((i) << 1) & ISINK_SFSTR0_TC_MASK)
57#define ISINK_SFSTR0_EN_MASK BIT(0)
58#define ISINK_SFSTR0_EN BIT(0)
59
60/* Register to LED channel enablement. */
61#define ISINK_CH_EN_MASK(i) BIT(i)
62#define ISINK_CH_EN(i) BIT(i)
63
64#define MAX_SUPPORTED_LEDS 8
65
66struct mt6323_leds;
67
68/**
69 * struct mt6323_led - state container for the LED device
70 * @id: the identifier in MT6323 LED device
71 * @parent: the pointer to MT6323 LED controller
72 * @cdev: LED class device for this LED device
73 * @current_brightness: current state of the LED device
74 */
75struct mt6323_led {
76 int id;
77 struct mt6323_leds *parent;
78 struct led_classdev cdev;
79 enum led_brightness current_brightness;
80};
81
82/**
83 * struct mt6323_regs - register spec for the LED device
84 * @top_ckpdn: Offset to ISINK_CKPDN[0..x] registers
85 * @num_top_ckpdn: Number of ISINK_CKPDN registers
86 * @top_ckcon: Offset to ISINK_CKCON[0..x] registers
87 * @num_top_ckcon: Number of ISINK_CKCON registers
88 * @isink_con: Offset to ISINKx_CON[0..x] registers
89 * @num_isink_con: Number of ISINKx_CON registers
90 * @isink_max_regs: Number of ISINK[0..x] registers
91 * @isink_en_ctrl: Offset to ISINK_EN_CTRL register
92 * @iwled_en_ctrl: Offset to IWLED_EN_CTRL register
93 */
94struct mt6323_regs {
95 const u16 *top_ckpdn;
96 u8 num_top_ckpdn;
97 const u16 *top_ckcon;
98 u8 num_top_ckcon;
99 const u16 *isink_con;
100 u8 num_isink_con;
101 u8 isink_max_regs;
102 u16 isink_en_ctrl;
103 u16 iwled_en_ctrl;
104};
105
106/**
107 * struct mt6323_hwspec - hardware specific parameters
108 * @max_period: Maximum period for all LEDs
109 * @max_leds: Maximum number of supported LEDs
110 * @max_wleds: Maximum number of WLEDs
111 * @max_brightness: Maximum brightness for all LEDs
112 * @unit_duty: Steps of duty per period
113 */
114struct mt6323_hwspec {
115 u16 max_period;
116 u8 max_leds;
117 u8 max_wleds;
118 u16 max_brightness;
119 u16 unit_duty;
120};
121
122/**
123 * struct mt6323_data - device specific data
124 * @regs: Register spec for this device
125 * @spec: Hardware specific parameters
126 */
127struct mt6323_data {
128 const struct mt6323_regs *regs;
129 const struct mt6323_hwspec *spec;
130};
131
132/**
133 * struct mt6323_leds - state container for holding LED controller
134 * of the driver
135 * @dev: the device pointer
136 * @hw: the underlying hardware providing shared
137 * bus for the register operations
138 * @pdata: device specific data
139 * @lock: the lock among process context
140 * @led: the array that contains the state of individual
141 * LED device
142 */
143struct mt6323_leds {
144 struct device *dev;
145 struct mt6397_chip *hw;
146 const struct mt6323_data *pdata;
147 /* protect among process context */
148 struct mutex lock;
149 struct mt6323_led *led[MAX_SUPPORTED_LEDS];
150};
151
152static int mt6323_led_hw_brightness(struct led_classdev *cdev,
153 enum led_brightness brightness)
154{
155 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
156 struct mt6323_leds *leds = led->parent;
157 const struct mt6323_regs *regs = leds->pdata->regs;
158 struct regmap *regmap = leds->hw->regmap;
159 u32 con2_mask = 0, con2_val = 0;
160 int ret;
161
162 /*
163 * Setup current output for the corresponding
164 * brightness level.
165 */
166 con2_mask |= ISINK_CH_STEP_MASK |
167 ISINK_SFSTR0_TC_MASK |
168 ISINK_SFSTR0_EN_MASK;
169 con2_val |= ISINK_CH_STEP(brightness - 1) |
170 ISINK_SFSTR0_TC(2) |
171 ISINK_SFSTR0_EN;
172
173 ret = regmap_update_bits(regmap, ISINK_CON(regs->isink_con[2], led->id),
174 con2_mask, con2_val);
175 return ret;
176}
177
178static int mt6323_led_hw_off(struct led_classdev *cdev)
179{
180 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
181 struct mt6323_leds *leds = led->parent;
182 const struct mt6323_regs *regs = leds->pdata->regs;
183 struct regmap *regmap = leds->hw->regmap;
184 unsigned int status;
185 int ret;
186
187 status = ISINK_CH_EN(led->id);
188 ret = regmap_update_bits(regmap, regs->isink_en_ctrl,
189 ISINK_CH_EN_MASK(led->id), ~status);
190 if (ret < 0)
191 return ret;
192
193 usleep_range(100, 300);
194 ret = regmap_update_bits(regmap, regs->top_ckpdn[2],
195 RG_ISINK_CK_PDN_MASK(led->id),
196 RG_ISINK_CK_PDN(led->id));
197 if (ret < 0)
198 return ret;
199
200 return 0;
201}
202
203static enum led_brightness
204mt6323_get_led_hw_brightness(struct led_classdev *cdev)
205{
206 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
207 struct mt6323_leds *leds = led->parent;
208 const struct mt6323_regs *regs = leds->pdata->regs;
209 struct regmap *regmap = leds->hw->regmap;
210 unsigned int status;
211 int ret;
212
213 ret = regmap_read(regmap, regs->top_ckpdn[2], &status);
214 if (ret < 0)
215 return ret;
216
217 if (status & RG_ISINK_CK_PDN_MASK(led->id))
218 return 0;
219
220 ret = regmap_read(regmap, regs->isink_en_ctrl, &status);
221 if (ret < 0)
222 return ret;
223
224 if (!(status & ISINK_CH_EN(led->id)))
225 return 0;
226
227 ret = regmap_read(regmap, ISINK_CON(regs->isink_con[2], led->id), &status);
228 if (ret < 0)
229 return ret;
230
231 return ((status & ISINK_CH_STEP_MASK)
232 >> ISINK_CH_STEP_SHIFT) + 1;
233}
234
235static int mt6323_led_hw_on(struct led_classdev *cdev,
236 enum led_brightness brightness)
237{
238 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
239 struct mt6323_leds *leds = led->parent;
240 const struct mt6323_regs *regs = leds->pdata->regs;
241 struct regmap *regmap = leds->hw->regmap;
242 unsigned int status;
243 int ret;
244
245 /*
246 * Setup required clock source, enable the corresponding
247 * clock and channel and let work with continuous blink as
248 * the default.
249 */
250 ret = regmap_update_bits(regmap, regs->top_ckcon[1],
251 RG_ISINK_CK_SEL_MASK(led->id), 0);
252 if (ret < 0)
253 return ret;
254
255 status = RG_ISINK_CK_PDN(led->id);
256 ret = regmap_update_bits(regmap, regs->top_ckpdn[2],
257 RG_ISINK_CK_PDN_MASK(led->id),
258 ~status);
259 if (ret < 0)
260 return ret;
261
262 usleep_range(100, 300);
263
264 ret = regmap_update_bits(regmap, regs->isink_en_ctrl,
265 ISINK_CH_EN_MASK(led->id),
266 ISINK_CH_EN(led->id));
267 if (ret < 0)
268 return ret;
269
270 ret = mt6323_led_hw_brightness(cdev, brightness);
271 if (ret < 0)
272 return ret;
273
274 ret = regmap_update_bits(regmap, ISINK_CON(regs->isink_con[0], led->id),
275 ISINK_DIM_DUTY_MASK,
276 ISINK_DIM_DUTY(31));
277 if (ret < 0)
278 return ret;
279
280 ret = regmap_update_bits(regmap, ISINK_CON(regs->isink_con[1], led->id),
281 ISINK_DIM_FSEL_MASK,
282 ISINK_DIM_FSEL(1000));
283 if (ret < 0)
284 return ret;
285
286 return 0;
287}
288
289static int mt6323_led_set_blink(struct led_classdev *cdev,
290 unsigned long *delay_on,
291 unsigned long *delay_off)
292{
293 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
294 struct mt6323_leds *leds = led->parent;
295 const struct mt6323_regs *regs = leds->pdata->regs;
296 const struct mt6323_hwspec *spec = leds->pdata->spec;
297 struct regmap *regmap = leds->hw->regmap;
298 unsigned long period;
299 u8 duty_hw;
300 int ret;
301
302 /*
303 * LED subsystem requires a default user
304 * friendly blink pattern for the LED so using
305 * 1Hz duty cycle 50% here if without specific
306 * value delay_on and delay off being assigned.
307 */
308 if (!*delay_on && !*delay_off) {
309 *delay_on = 500;
310 *delay_off = 500;
311 }
312
313 /*
314 * Units are in ms, if over the hardware able
315 * to support, fallback into software blink
316 */
317 period = *delay_on + *delay_off;
318
319 if (period > spec->max_period)
320 return -EINVAL;
321
322 /*
323 * Calculate duty_hw based on the percentage of period during
324 * which the led is ON.
325 */
326 duty_hw = DIV_ROUND_CLOSEST(*delay_on * 100000ul, period * spec->unit_duty);
327
328 /* hardware doesn't support zero duty cycle. */
329 if (!duty_hw)
330 return -EINVAL;
331
332 mutex_lock(&leds->lock);
333 /*
334 * Set max_brightness as the software blink behavior
335 * when no blink brightness.
336 */
337 if (!led->current_brightness) {
338 ret = mt6323_led_hw_on(cdev, cdev->max_brightness);
339 if (ret < 0)
340 goto out;
341 led->current_brightness = cdev->max_brightness;
342 }
343
344 ret = regmap_update_bits(regmap, ISINK_CON(regs->isink_con[0], led->id),
345 ISINK_DIM_DUTY_MASK,
346 ISINK_DIM_DUTY(duty_hw - 1));
347 if (ret < 0)
348 goto out;
349
350 ret = regmap_update_bits(regmap, ISINK_CON(regs->isink_con[1], led->id),
351 ISINK_DIM_FSEL_MASK,
352 ISINK_DIM_FSEL(period - 1));
353out:
354 mutex_unlock(&leds->lock);
355
356 return ret;
357}
358
359static int mt6323_led_set_brightness(struct led_classdev *cdev,
360 enum led_brightness brightness)
361{
362 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
363 struct mt6323_leds *leds = led->parent;
364 int ret;
365
366 mutex_lock(&leds->lock);
367
368 if (!led->current_brightness && brightness) {
369 ret = mt6323_led_hw_on(cdev, brightness);
370 if (ret < 0)
371 goto out;
372 } else if (brightness) {
373 ret = mt6323_led_hw_brightness(cdev, brightness);
374 if (ret < 0)
375 goto out;
376 } else {
377 ret = mt6323_led_hw_off(cdev);
378 if (ret < 0)
379 goto out;
380 }
381
382 led->current_brightness = brightness;
383out:
384 mutex_unlock(&leds->lock);
385
386 return ret;
387}
388
389static int mtk_wled_hw_on(struct led_classdev *cdev)
390{
391 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
392 struct mt6323_leds *leds = led->parent;
393 const struct mt6323_regs *regs = leds->pdata->regs;
394 struct regmap *regmap = leds->hw->regmap;
395 int ret;
396
397 ret = regmap_clear_bits(regmap, regs->top_ckpdn[0], RG_VWLED_32K_CK_PDN);
398 if (ret)
399 return ret;
400
401 ret = regmap_clear_bits(regmap, regs->top_ckpdn[0], RG_VWLED_6M_CK_PDN);
402 if (ret)
403 return ret;
404
405 ret = regmap_clear_bits(regmap, regs->top_ckpdn[0], RG_VWLED_1M_CK_PDN);
406 if (ret)
407 return ret;
408
409 usleep_range(5000, 6000);
410
411 /* Enable WLED channel pair */
412 ret = regmap_set_bits(regmap, regs->iwled_en_ctrl, BIT(led->id));
413 if (ret)
414 return ret;
415
416 ret = regmap_set_bits(regmap, regs->iwled_en_ctrl, BIT(led->id + 1));
417 if (ret)
418 return ret;
419
420 return 0;
421}
422
423static int mtk_wled_hw_off(struct led_classdev *cdev)
424{
425 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
426 struct mt6323_leds *leds = led->parent;
427 const struct mt6323_regs *regs = leds->pdata->regs;
428 struct regmap *regmap = leds->hw->regmap;
429 int ret;
430
431 ret = regmap_clear_bits(regmap, regs->iwled_en_ctrl, BIT(led->id + 1));
432 if (ret)
433 return ret;
434
435 ret = regmap_clear_bits(regmap, regs->iwled_en_ctrl, BIT(led->id));
436 if (ret)
437 return ret;
438
439 ret = regmap_set_bits(regmap, regs->top_ckpdn[0], RG_VWLED_32K_CK_PDN);
440 if (ret)
441 return ret;
442
443 ret = regmap_set_bits(regmap, regs->top_ckpdn[0], RG_VWLED_6M_CK_PDN);
444 if (ret)
445 return ret;
446
447 ret = regmap_set_bits(regmap, regs->top_ckpdn[0], RG_VWLED_1M_CK_PDN);
448 if (ret)
449 return ret;
450
451 return 0;
452}
453
454static enum led_brightness mt6323_get_wled_brightness(struct led_classdev *cdev)
455{
456 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
457 struct mt6323_leds *leds = led->parent;
458 const struct mt6323_regs *regs = leds->pdata->regs;
459 struct regmap *regmap = leds->hw->regmap;
460 unsigned int status;
461 int ret;
462
463 ret = regmap_read(regmap, regs->iwled_en_ctrl, &status);
464 if (ret)
465 return 0;
466
467 /* Always two channels per WLED */
468 status &= BIT(led->id) | BIT(led->id + 1);
469
470 return status ? led->current_brightness : 0;
471}
472
473static int mt6323_wled_set_brightness(struct led_classdev *cdev,
474 enum led_brightness brightness)
475{
476 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
477 struct mt6323_leds *leds = led->parent;
478 int ret = 0;
479
480 mutex_lock(&leds->lock);
481
482 if (brightness) {
483 if (!led->current_brightness)
484 ret = mtk_wled_hw_on(cdev);
485 if (ret)
486 goto out;
487 } else {
488 ret = mtk_wled_hw_off(cdev);
489 if (ret)
490 goto out;
491 }
492
493 led->current_brightness = brightness;
494out:
495 mutex_unlock(&leds->lock);
496
497 return ret;
498}
499
500static int mt6323_led_set_dt_default(struct led_classdev *cdev,
501 struct device_node *np)
502{
503 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
504 enum led_default_state state;
505 int ret = 0;
506
507 state = led_init_default_state_get(of_fwnode_handle(np));
508 switch (state) {
509 case LEDS_DEFSTATE_ON:
510 ret = mt6323_led_set_brightness(cdev, cdev->max_brightness);
511 break;
512 case LEDS_DEFSTATE_KEEP:
513 ret = mt6323_get_led_hw_brightness(cdev);
514 if (ret < 0)
515 return ret;
516 led->current_brightness = ret;
517 ret = 0;
518 break;
519 default:
520 ret = mt6323_led_set_brightness(cdev, LED_OFF);
521 }
522
523 return ret;
524}
525
526static int mt6323_led_probe(struct platform_device *pdev)
527{
528 struct device *dev = &pdev->dev;
529 struct device_node *np = dev_of_node(dev);
530 struct device_node *child;
531 struct mt6397_chip *hw = dev_get_drvdata(dev->parent);
532 struct mt6323_leds *leds;
533 struct mt6323_led *led;
534 const struct mt6323_regs *regs;
535 const struct mt6323_hwspec *spec;
536 int ret;
537 unsigned int status;
538 u32 reg;
539 u8 max_leds;
540
541 leds = devm_kzalloc(dev, sizeof(*leds), GFP_KERNEL);
542 if (!leds)
543 return -ENOMEM;
544
545 platform_set_drvdata(pdev, leds);
546 leds->dev = dev;
547 leds->pdata = device_get_match_data(dev);
548 regs = leds->pdata->regs;
549 spec = leds->pdata->spec;
550 max_leds = spec->max_leds + spec->max_wleds;
551
552 /*
553 * leds->hw points to the underlying bus for the register
554 * controlled.
555 */
556 leds->hw = hw;
557 mutex_init(&leds->lock);
558
559 status = RG_DRV_32K_CK_PDN;
560 ret = regmap_update_bits(leds->hw->regmap, regs->top_ckpdn[0],
561 RG_DRV_32K_CK_PDN_MASK, ~status);
562 if (ret < 0) {
563 dev_err(leds->dev,
564 "Failed to update TOP_CKPDN0 Register\n");
565 return ret;
566 }
567
568 for_each_available_child_of_node(np, child) {
569 struct led_init_data init_data = {};
570 bool is_wled;
571
572 ret = of_property_read_u32(child, "reg", ®);
573 if (ret) {
574 dev_err(dev, "Failed to read led 'reg' property\n");
575 goto put_child_node;
576 }
577
578 if (reg >= max_leds || reg >= MAX_SUPPORTED_LEDS ||
579 leds->led[reg]) {
580 dev_err(dev, "Invalid led reg %u\n", reg);
581 ret = -EINVAL;
582 goto put_child_node;
583 }
584
585 led = devm_kzalloc(dev, sizeof(*led), GFP_KERNEL);
586 if (!led) {
587 ret = -ENOMEM;
588 goto put_child_node;
589 }
590
591 is_wled = of_property_read_bool(child, "mediatek,is-wled");
592
593 leds->led[reg] = led;
594 leds->led[reg]->id = reg;
595 leds->led[reg]->cdev.max_brightness = spec->max_brightness;
596
597 if (is_wled) {
598 leds->led[reg]->cdev.brightness_set_blocking =
599 mt6323_wled_set_brightness;
600 leds->led[reg]->cdev.brightness_get =
601 mt6323_get_wled_brightness;
602 } else {
603 leds->led[reg]->cdev.brightness_set_blocking =
604 mt6323_led_set_brightness;
605 leds->led[reg]->cdev.blink_set = mt6323_led_set_blink;
606 leds->led[reg]->cdev.brightness_get =
607 mt6323_get_led_hw_brightness;
608 }
609 leds->led[reg]->parent = leds;
610
611 ret = mt6323_led_set_dt_default(&leds->led[reg]->cdev, child);
612 if (ret < 0) {
613 dev_err(leds->dev,
614 "Failed to LED set default from devicetree\n");
615 goto put_child_node;
616 }
617
618 init_data.fwnode = of_fwnode_handle(child);
619
620 ret = devm_led_classdev_register_ext(dev, &leds->led[reg]->cdev,
621 &init_data);
622 if (ret) {
623 dev_err(dev, "Failed to register LED: %d\n", ret);
624 goto put_child_node;
625 }
626 }
627
628 return 0;
629
630put_child_node:
631 of_node_put(child);
632 return ret;
633}
634
635static void mt6323_led_remove(struct platform_device *pdev)
636{
637 struct mt6323_leds *leds = platform_get_drvdata(pdev);
638 const struct mt6323_regs *regs = leds->pdata->regs;
639 int i;
640
641 /* Turn the LEDs off on driver removal. */
642 for (i = 0 ; leds->led[i] ; i++)
643 mt6323_led_hw_off(&leds->led[i]->cdev);
644
645 regmap_update_bits(leds->hw->regmap, regs->top_ckpdn[0],
646 RG_DRV_32K_CK_PDN_MASK,
647 RG_DRV_32K_CK_PDN);
648
649 mutex_destroy(&leds->lock);
650}
651
652static const struct mt6323_regs mt6323_registers = {
653 .top_ckpdn = (const u16[]){ 0x102, 0x106, 0x10e },
654 .num_top_ckpdn = 3,
655 .top_ckcon = (const u16[]){ 0x120, 0x126 },
656 .num_top_ckcon = 2,
657 .isink_con = (const u16[]){ 0x330, 0x332, 0x334 },
658 .num_isink_con = 3,
659 .isink_max_regs = 4, /* ISINK[0..3] */
660 .isink_en_ctrl = 0x356,
661};
662
663static const struct mt6323_regs mt6331_registers = {
664 .top_ckpdn = (const u16[]){ 0x138, 0x13e, 0x144 },
665 .num_top_ckpdn = 3,
666 .top_ckcon = (const u16[]){ 0x14c, 0x14a },
667 .num_top_ckcon = 2,
668 .isink_con = (const u16[]){ 0x40c, 0x40e, 0x410, 0x412, 0x414 },
669 .num_isink_con = 5,
670 .isink_max_regs = 4, /* ISINK[0..3] */
671 .isink_en_ctrl = 0x43a,
672};
673
674static const struct mt6323_regs mt6332_registers = {
675 .top_ckpdn = (const u16[]){ 0x8094, 0x809a, 0x80a0 },
676 .num_top_ckpdn = 3,
677 .top_ckcon = (const u16[]){ 0x80a6, 0x80ac },
678 .num_top_ckcon = 2,
679 .isink_con = (const u16[]){ 0x8cd4 },
680 .num_isink_con = 1,
681 .isink_max_regs = 12, /* IWLED[0..2, 3..9] */
682 .iwled_en_ctrl = 0x8cda,
683};
684
685static const struct mt6323_hwspec mt6323_spec = {
686 .max_period = 10000,
687 .max_leds = 4,
688 .max_brightness = 6,
689 .unit_duty = 3125,
690};
691
692static const struct mt6323_hwspec mt6332_spec = {
693 /* There are no LEDs in MT6332. Only WLEDs are present. */
694 .max_leds = 0,
695 .max_wleds = 1,
696 .max_brightness = 1024,
697};
698
699static const struct mt6323_data mt6323_pdata = {
700 .regs = &mt6323_registers,
701 .spec = &mt6323_spec,
702};
703
704static const struct mt6323_data mt6331_pdata = {
705 .regs = &mt6331_registers,
706 .spec = &mt6323_spec,
707};
708
709static const struct mt6323_data mt6332_pdata = {
710 .regs = &mt6332_registers,
711 .spec = &mt6332_spec,
712};
713
714static const struct of_device_id mt6323_led_dt_match[] = {
715 { .compatible = "mediatek,mt6323-led", .data = &mt6323_pdata},
716 { .compatible = "mediatek,mt6331-led", .data = &mt6331_pdata },
717 { .compatible = "mediatek,mt6332-led", .data = &mt6332_pdata },
718 {},
719};
720MODULE_DEVICE_TABLE(of, mt6323_led_dt_match);
721
722static struct platform_driver mt6323_led_driver = {
723 .probe = mt6323_led_probe,
724 .remove_new = mt6323_led_remove,
725 .driver = {
726 .name = "mt6323-led",
727 .of_match_table = mt6323_led_dt_match,
728 },
729};
730
731module_platform_driver(mt6323_led_driver);
732
733MODULE_DESCRIPTION("LED driver for Mediatek MT6323 PMIC");
734MODULE_AUTHOR("Sean Wang <sean.wang@mediatek.com>");
735MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * LED driver for Mediatek MT6323 PMIC
4 *
5 * Copyright (C) 2017 Sean Wang <sean.wang@mediatek.com>
6 */
7#include <linux/kernel.h>
8#include <linux/leds.h>
9#include <linux/mfd/mt6323/registers.h>
10#include <linux/mfd/mt6397/core.h>
11#include <linux/module.h>
12#include <linux/of.h>
13#include <linux/platform_device.h>
14#include <linux/regmap.h>
15
16/*
17 * Register field for MT6323_TOP_CKPDN0 to enable
18 * 32K clock common for LED device.
19 */
20#define MT6323_RG_DRV_32K_CK_PDN BIT(11)
21#define MT6323_RG_DRV_32K_CK_PDN_MASK BIT(11)
22
23/*
24 * Register field for MT6323_TOP_CKPDN2 to enable
25 * individual clock for LED device.
26 */
27#define MT6323_RG_ISINK_CK_PDN(i) BIT(i)
28#define MT6323_RG_ISINK_CK_PDN_MASK(i) BIT(i)
29
30/*
31 * Register field for MT6323_TOP_CKCON1 to select
32 * clock source.
33 */
34#define MT6323_RG_ISINK_CK_SEL_MASK(i) (BIT(10) << (i))
35
36/*
37 * Register for MT6323_ISINK_CON0 to setup the
38 * duty cycle of the blink.
39 */
40#define MT6323_ISINK_CON0(i) (MT6323_ISINK0_CON0 + 0x8 * (i))
41#define MT6323_ISINK_DIM_DUTY_MASK (0x1f << 8)
42#define MT6323_ISINK_DIM_DUTY(i) (((i) << 8) & \
43 MT6323_ISINK_DIM_DUTY_MASK)
44
45/* Register to setup the period of the blink. */
46#define MT6323_ISINK_CON1(i) (MT6323_ISINK0_CON1 + 0x8 * (i))
47#define MT6323_ISINK_DIM_FSEL_MASK (0xffff)
48#define MT6323_ISINK_DIM_FSEL(i) ((i) & MT6323_ISINK_DIM_FSEL_MASK)
49
50/* Register to control the brightness. */
51#define MT6323_ISINK_CON2(i) (MT6323_ISINK0_CON2 + 0x8 * (i))
52#define MT6323_ISINK_CH_STEP_SHIFT 12
53#define MT6323_ISINK_CH_STEP_MASK (0x7 << 12)
54#define MT6323_ISINK_CH_STEP(i) (((i) << 12) & \
55 MT6323_ISINK_CH_STEP_MASK)
56#define MT6323_ISINK_SFSTR0_TC_MASK (0x3 << 1)
57#define MT6323_ISINK_SFSTR0_TC(i) (((i) << 1) & \
58 MT6323_ISINK_SFSTR0_TC_MASK)
59#define MT6323_ISINK_SFSTR0_EN_MASK BIT(0)
60#define MT6323_ISINK_SFSTR0_EN BIT(0)
61
62/* Register to LED channel enablement. */
63#define MT6323_ISINK_CH_EN_MASK(i) BIT(i)
64#define MT6323_ISINK_CH_EN(i) BIT(i)
65
66#define MT6323_MAX_PERIOD 10000
67#define MT6323_MAX_LEDS 4
68#define MT6323_MAX_BRIGHTNESS 6
69#define MT6323_UNIT_DUTY 3125
70#define MT6323_CAL_HW_DUTY(o, p) DIV_ROUND_CLOSEST((o) * 100000ul,\
71 (p) * MT6323_UNIT_DUTY)
72
73struct mt6323_leds;
74
75/**
76 * struct mt6323_led - state container for the LED device
77 * @id: the identifier in MT6323 LED device
78 * @parent: the pointer to MT6323 LED controller
79 * @cdev: LED class device for this LED device
80 * @current_brightness: current state of the LED device
81 */
82struct mt6323_led {
83 int id;
84 struct mt6323_leds *parent;
85 struct led_classdev cdev;
86 enum led_brightness current_brightness;
87};
88
89/**
90 * struct mt6323_leds - state container for holding LED controller
91 * of the driver
92 * @dev: the device pointer
93 * @hw: the underlying hardware providing shared
94 * bus for the register operations
95 * @lock: the lock among process context
96 * @led: the array that contains the state of individual
97 * LED device
98 */
99struct mt6323_leds {
100 struct device *dev;
101 struct mt6397_chip *hw;
102 /* protect among process context */
103 struct mutex lock;
104 struct mt6323_led *led[MT6323_MAX_LEDS];
105};
106
107static int mt6323_led_hw_brightness(struct led_classdev *cdev,
108 enum led_brightness brightness)
109{
110 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
111 struct mt6323_leds *leds = led->parent;
112 struct regmap *regmap = leds->hw->regmap;
113 u32 con2_mask = 0, con2_val = 0;
114 int ret;
115
116 /*
117 * Setup current output for the corresponding
118 * brightness level.
119 */
120 con2_mask |= MT6323_ISINK_CH_STEP_MASK |
121 MT6323_ISINK_SFSTR0_TC_MASK |
122 MT6323_ISINK_SFSTR0_EN_MASK;
123 con2_val |= MT6323_ISINK_CH_STEP(brightness - 1) |
124 MT6323_ISINK_SFSTR0_TC(2) |
125 MT6323_ISINK_SFSTR0_EN;
126
127 ret = regmap_update_bits(regmap, MT6323_ISINK_CON2(led->id),
128 con2_mask, con2_val);
129 return ret;
130}
131
132static int mt6323_led_hw_off(struct led_classdev *cdev)
133{
134 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
135 struct mt6323_leds *leds = led->parent;
136 struct regmap *regmap = leds->hw->regmap;
137 unsigned int status;
138 int ret;
139
140 status = MT6323_ISINK_CH_EN(led->id);
141 ret = regmap_update_bits(regmap, MT6323_ISINK_EN_CTRL,
142 MT6323_ISINK_CH_EN_MASK(led->id), ~status);
143 if (ret < 0)
144 return ret;
145
146 usleep_range(100, 300);
147 ret = regmap_update_bits(regmap, MT6323_TOP_CKPDN2,
148 MT6323_RG_ISINK_CK_PDN_MASK(led->id),
149 MT6323_RG_ISINK_CK_PDN(led->id));
150 if (ret < 0)
151 return ret;
152
153 return 0;
154}
155
156static enum led_brightness
157mt6323_get_led_hw_brightness(struct led_classdev *cdev)
158{
159 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
160 struct mt6323_leds *leds = led->parent;
161 struct regmap *regmap = leds->hw->regmap;
162 unsigned int status;
163 int ret;
164
165 ret = regmap_read(regmap, MT6323_TOP_CKPDN2, &status);
166 if (ret < 0)
167 return ret;
168
169 if (status & MT6323_RG_ISINK_CK_PDN_MASK(led->id))
170 return 0;
171
172 ret = regmap_read(regmap, MT6323_ISINK_EN_CTRL, &status);
173 if (ret < 0)
174 return ret;
175
176 if (!(status & MT6323_ISINK_CH_EN(led->id)))
177 return 0;
178
179 ret = regmap_read(regmap, MT6323_ISINK_CON2(led->id), &status);
180 if (ret < 0)
181 return ret;
182
183 return ((status & MT6323_ISINK_CH_STEP_MASK)
184 >> MT6323_ISINK_CH_STEP_SHIFT) + 1;
185}
186
187static int mt6323_led_hw_on(struct led_classdev *cdev,
188 enum led_brightness brightness)
189{
190 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
191 struct mt6323_leds *leds = led->parent;
192 struct regmap *regmap = leds->hw->regmap;
193 unsigned int status;
194 int ret;
195
196 /*
197 * Setup required clock source, enable the corresponding
198 * clock and channel and let work with continuous blink as
199 * the default.
200 */
201 ret = regmap_update_bits(regmap, MT6323_TOP_CKCON1,
202 MT6323_RG_ISINK_CK_SEL_MASK(led->id), 0);
203 if (ret < 0)
204 return ret;
205
206 status = MT6323_RG_ISINK_CK_PDN(led->id);
207 ret = regmap_update_bits(regmap, MT6323_TOP_CKPDN2,
208 MT6323_RG_ISINK_CK_PDN_MASK(led->id),
209 ~status);
210 if (ret < 0)
211 return ret;
212
213 usleep_range(100, 300);
214
215 ret = regmap_update_bits(regmap, MT6323_ISINK_EN_CTRL,
216 MT6323_ISINK_CH_EN_MASK(led->id),
217 MT6323_ISINK_CH_EN(led->id));
218 if (ret < 0)
219 return ret;
220
221 ret = mt6323_led_hw_brightness(cdev, brightness);
222 if (ret < 0)
223 return ret;
224
225 ret = regmap_update_bits(regmap, MT6323_ISINK_CON0(led->id),
226 MT6323_ISINK_DIM_DUTY_MASK,
227 MT6323_ISINK_DIM_DUTY(31));
228 if (ret < 0)
229 return ret;
230
231 ret = regmap_update_bits(regmap, MT6323_ISINK_CON1(led->id),
232 MT6323_ISINK_DIM_FSEL_MASK,
233 MT6323_ISINK_DIM_FSEL(1000));
234 if (ret < 0)
235 return ret;
236
237 return 0;
238}
239
240static int mt6323_led_set_blink(struct led_classdev *cdev,
241 unsigned long *delay_on,
242 unsigned long *delay_off)
243{
244 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
245 struct mt6323_leds *leds = led->parent;
246 struct regmap *regmap = leds->hw->regmap;
247 unsigned long period;
248 u8 duty_hw;
249 int ret;
250
251 /*
252 * LED subsystem requires a default user
253 * friendly blink pattern for the LED so using
254 * 1Hz duty cycle 50% here if without specific
255 * value delay_on and delay off being assigned.
256 */
257 if (!*delay_on && !*delay_off) {
258 *delay_on = 500;
259 *delay_off = 500;
260 }
261
262 /*
263 * Units are in ms, if over the hardware able
264 * to support, fallback into software blink
265 */
266 period = *delay_on + *delay_off;
267
268 if (period > MT6323_MAX_PERIOD)
269 return -EINVAL;
270
271 /*
272 * Calculate duty_hw based on the percentage of period during
273 * which the led is ON.
274 */
275 duty_hw = MT6323_CAL_HW_DUTY(*delay_on, period);
276
277 /* hardware doesn't support zero duty cycle. */
278 if (!duty_hw)
279 return -EINVAL;
280
281 mutex_lock(&leds->lock);
282 /*
283 * Set max_brightness as the software blink behavior
284 * when no blink brightness.
285 */
286 if (!led->current_brightness) {
287 ret = mt6323_led_hw_on(cdev, cdev->max_brightness);
288 if (ret < 0)
289 goto out;
290 led->current_brightness = cdev->max_brightness;
291 }
292
293 ret = regmap_update_bits(regmap, MT6323_ISINK_CON0(led->id),
294 MT6323_ISINK_DIM_DUTY_MASK,
295 MT6323_ISINK_DIM_DUTY(duty_hw - 1));
296 if (ret < 0)
297 goto out;
298
299 ret = regmap_update_bits(regmap, MT6323_ISINK_CON1(led->id),
300 MT6323_ISINK_DIM_FSEL_MASK,
301 MT6323_ISINK_DIM_FSEL(period - 1));
302out:
303 mutex_unlock(&leds->lock);
304
305 return ret;
306}
307
308static int mt6323_led_set_brightness(struct led_classdev *cdev,
309 enum led_brightness brightness)
310{
311 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
312 struct mt6323_leds *leds = led->parent;
313 int ret;
314
315 mutex_lock(&leds->lock);
316
317 if (!led->current_brightness && brightness) {
318 ret = mt6323_led_hw_on(cdev, brightness);
319 if (ret < 0)
320 goto out;
321 } else if (brightness) {
322 ret = mt6323_led_hw_brightness(cdev, brightness);
323 if (ret < 0)
324 goto out;
325 } else {
326 ret = mt6323_led_hw_off(cdev);
327 if (ret < 0)
328 goto out;
329 }
330
331 led->current_brightness = brightness;
332out:
333 mutex_unlock(&leds->lock);
334
335 return ret;
336}
337
338static int mt6323_led_set_dt_default(struct led_classdev *cdev,
339 struct device_node *np)
340{
341 struct mt6323_led *led = container_of(cdev, struct mt6323_led, cdev);
342 const char *state;
343 int ret = 0;
344
345 state = of_get_property(np, "default-state", NULL);
346 if (state) {
347 if (!strcmp(state, "keep")) {
348 ret = mt6323_get_led_hw_brightness(cdev);
349 if (ret < 0)
350 return ret;
351 led->current_brightness = ret;
352 ret = 0;
353 } else if (!strcmp(state, "on")) {
354 ret =
355 mt6323_led_set_brightness(cdev, cdev->max_brightness);
356 } else {
357 ret = mt6323_led_set_brightness(cdev, LED_OFF);
358 }
359 }
360
361 return ret;
362}
363
364static int mt6323_led_probe(struct platform_device *pdev)
365{
366 struct device *dev = &pdev->dev;
367 struct device_node *np = dev_of_node(dev);
368 struct device_node *child;
369 struct mt6397_chip *hw = dev_get_drvdata(dev->parent);
370 struct mt6323_leds *leds;
371 struct mt6323_led *led;
372 int ret;
373 unsigned int status;
374 u32 reg;
375
376 leds = devm_kzalloc(dev, sizeof(*leds), GFP_KERNEL);
377 if (!leds)
378 return -ENOMEM;
379
380 platform_set_drvdata(pdev, leds);
381 leds->dev = dev;
382
383 /*
384 * leds->hw points to the underlying bus for the register
385 * controlled.
386 */
387 leds->hw = hw;
388 mutex_init(&leds->lock);
389
390 status = MT6323_RG_DRV_32K_CK_PDN;
391 ret = regmap_update_bits(leds->hw->regmap, MT6323_TOP_CKPDN0,
392 MT6323_RG_DRV_32K_CK_PDN_MASK, ~status);
393 if (ret < 0) {
394 dev_err(leds->dev,
395 "Failed to update MT6323_TOP_CKPDN0 Register\n");
396 return ret;
397 }
398
399 for_each_available_child_of_node(np, child) {
400 struct led_init_data init_data = {};
401
402 ret = of_property_read_u32(child, "reg", ®);
403 if (ret) {
404 dev_err(dev, "Failed to read led 'reg' property\n");
405 goto put_child_node;
406 }
407
408 if (reg >= MT6323_MAX_LEDS || leds->led[reg]) {
409 dev_err(dev, "Invalid led reg %u\n", reg);
410 ret = -EINVAL;
411 goto put_child_node;
412 }
413
414 led = devm_kzalloc(dev, sizeof(*led), GFP_KERNEL);
415 if (!led) {
416 ret = -ENOMEM;
417 goto put_child_node;
418 }
419
420 leds->led[reg] = led;
421 leds->led[reg]->id = reg;
422 leds->led[reg]->cdev.max_brightness = MT6323_MAX_BRIGHTNESS;
423 leds->led[reg]->cdev.brightness_set_blocking =
424 mt6323_led_set_brightness;
425 leds->led[reg]->cdev.blink_set = mt6323_led_set_blink;
426 leds->led[reg]->cdev.brightness_get =
427 mt6323_get_led_hw_brightness;
428 leds->led[reg]->parent = leds;
429
430 ret = mt6323_led_set_dt_default(&leds->led[reg]->cdev, child);
431 if (ret < 0) {
432 dev_err(leds->dev,
433 "Failed to LED set default from devicetree\n");
434 goto put_child_node;
435 }
436
437 init_data.fwnode = of_fwnode_handle(child);
438
439 ret = devm_led_classdev_register_ext(dev, &leds->led[reg]->cdev,
440 &init_data);
441 if (ret) {
442 dev_err(dev, "Failed to register LED: %d\n", ret);
443 goto put_child_node;
444 }
445 }
446
447 return 0;
448
449put_child_node:
450 of_node_put(child);
451 return ret;
452}
453
454static int mt6323_led_remove(struct platform_device *pdev)
455{
456 struct mt6323_leds *leds = platform_get_drvdata(pdev);
457 int i;
458
459 /* Turn the LEDs off on driver removal. */
460 for (i = 0 ; leds->led[i] ; i++)
461 mt6323_led_hw_off(&leds->led[i]->cdev);
462
463 regmap_update_bits(leds->hw->regmap, MT6323_TOP_CKPDN0,
464 MT6323_RG_DRV_32K_CK_PDN_MASK,
465 MT6323_RG_DRV_32K_CK_PDN);
466
467 mutex_destroy(&leds->lock);
468
469 return 0;
470}
471
472static const struct of_device_id mt6323_led_dt_match[] = {
473 { .compatible = "mediatek,mt6323-led" },
474 {},
475};
476MODULE_DEVICE_TABLE(of, mt6323_led_dt_match);
477
478static struct platform_driver mt6323_led_driver = {
479 .probe = mt6323_led_probe,
480 .remove = mt6323_led_remove,
481 .driver = {
482 .name = "mt6323-led",
483 .of_match_table = mt6323_led_dt_match,
484 },
485};
486
487module_platform_driver(mt6323_led_driver);
488
489MODULE_DESCRIPTION("LED driver for Mediatek MT6323 PMIC");
490MODULE_AUTHOR("Sean Wang <sean.wang@mediatek.com>");
491MODULE_LICENSE("GPL");