1 // SPDX-License-Identifier: GPL-2.0-only
3 * LP5521/LP5523/LP55231/LP5562 Common Driver
5 * Copyright 2012 Texas Instruments
7 * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
9 * Derived from leds-lp5521.c, leds-lp5523.c
12 #include <linux/bitfield.h>
13 #include <linux/cleanup.h>
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/firmware.h>
17 #include <linux/i2c.h>
18 #include <linux/iopoll.h>
19 #include <linux/leds.h>
20 #include <linux/module.h>
21 #include <linux/platform_data/leds-lp55xx.h>
22 #include <linux/slab.h>
23 #include <linux/gpio/consumer.h>
24 #include <dt-bindings/leds/leds-lp55xx.h>
26 #include "leds-lp55xx-common.h"
28 /* OP MODE require at least 153 us to clear regs */
29 #define LP55XX_CMD_SLEEP 200
31 #define LP55xx_PROGRAM_PAGES 16
32 #define LP55xx_MAX_PROGRAM_LENGTH (LP55xx_BYTES_PER_PAGE * 4) /* 128 bytes (4 pages) */
35 * Program Memory Operations
36 * Same Mask for each engine for both mode and exec
41 #define LP55xx_MODE_DISABLE_ALL_ENG 0x0
42 #define LP55xx_MODE_ENG_MASK GENMASK(1, 0)
43 #define LP55xx_MODE_DISABLE_ENG FIELD_PREP_CONST(LP55xx_MODE_ENG_MASK, 0x0)
44 #define LP55xx_MODE_LOAD_ENG FIELD_PREP_CONST(LP55xx_MODE_ENG_MASK, 0x1)
45 #define LP55xx_MODE_RUN_ENG FIELD_PREP_CONST(LP55xx_MODE_ENG_MASK, 0x2)
46 #define LP55xx_MODE_HALT_ENG FIELD_PREP_CONST(LP55xx_MODE_ENG_MASK, 0x3)
48 #define LP55xx_MODE_ENGn_SHIFT(n, shift) ((shift) + (2 * (3 - (n))))
49 #define LP55xx_MODE_ENGn_MASK(n, shift) (LP55xx_MODE_ENG_MASK << LP55xx_MODE_ENGn_SHIFT(n, shift))
50 #define LP55xx_MODE_ENGn_GET(n, mode, shift) \
51 (((mode) >> LP55xx_MODE_ENGn_SHIFT(n, shift)) & LP55xx_MODE_ENG_MASK)
53 #define LP55xx_EXEC_ENG_MASK GENMASK(1, 0)
54 #define LP55xx_EXEC_HOLD_ENG FIELD_PREP_CONST(LP55xx_EXEC_ENG_MASK, 0x0)
55 #define LP55xx_EXEC_STEP_ENG FIELD_PREP_CONST(LP55xx_EXEC_ENG_MASK, 0x1)
56 #define LP55xx_EXEC_RUN_ENG FIELD_PREP_CONST(LP55xx_EXEC_ENG_MASK, 0x2)
57 #define LP55xx_EXEC_ONCE_ENG FIELD_PREP_CONST(LP55xx_EXEC_ENG_MASK, 0x3)
59 #define LP55xx_EXEC_ENGn_SHIFT(n, shift) ((shift) + (2 * (3 - (n))))
60 #define LP55xx_EXEC_ENGn_MASK(n, shift) (LP55xx_EXEC_ENG_MASK << LP55xx_EXEC_ENGn_SHIFT(n, shift))
62 /* Memory Page Selection */
63 #define LP55xx_REG_PROG_PAGE_SEL 0x4f
64 /* If supported, each ENGINE have an equal amount of pages offset from page 0 */
65 #define LP55xx_PAGE_OFFSET(n, pages) (((n) - 1) * (pages))
67 #define LED_ACTIVE(mux, led) (!!((mux) & (0x0001 << (led))))
69 /* MASTER FADER common property */
70 #define LP55xx_FADER_MAPPING_MASK GENMASK(7, 6)
72 /* External clock rate */
73 #define LP55XX_CLK_32K 32768
75 static struct lp55xx_led
*cdev_to_lp55xx_led(struct led_classdev
*cdev
)
77 return container_of(cdev
, struct lp55xx_led
, cdev
);
80 static struct lp55xx_led
*dev_to_lp55xx_led(struct device
*dev
)
82 return cdev_to_lp55xx_led(dev_get_drvdata(dev
));
85 static struct lp55xx_led
*mcled_cdev_to_led(struct led_classdev_mc
*mc_cdev
)
87 return container_of(mc_cdev
, struct lp55xx_led
, mc_cdev
);
90 static void lp55xx_wait_opmode_done(struct lp55xx_chip
*chip
)
92 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
93 int __always_unused ret
;
97 * Recent chip supports BUSY bit for engine.
98 * Check support by checking if val is not 0.
99 * For legacy device, sleep at least 153 us.
101 if (cfg
->engine_busy
.val
) {
102 read_poll_timeout(lp55xx_read
, ret
, !(val
& cfg
->engine_busy
.mask
),
103 LP55XX_CMD_SLEEP
, LP55XX_CMD_SLEEP
* 10, false,
104 chip
, cfg
->engine_busy
.addr
, &val
);
106 usleep_range(LP55XX_CMD_SLEEP
, LP55XX_CMD_SLEEP
* 2);
110 void lp55xx_stop_all_engine(struct lp55xx_chip
*chip
)
112 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
114 lp55xx_write(chip
, cfg
->reg_op_mode
.addr
, LP55xx_MODE_DISABLE_ALL_ENG
);
115 lp55xx_wait_opmode_done(chip
);
117 EXPORT_SYMBOL_GPL(lp55xx_stop_all_engine
);
119 void lp55xx_load_engine(struct lp55xx_chip
*chip
)
121 enum lp55xx_engine_index idx
= chip
->engine_idx
;
122 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
125 mask
= LP55xx_MODE_ENGn_MASK(idx
, cfg
->reg_op_mode
.shift
);
126 val
= LP55xx_MODE_LOAD_ENG
<< LP55xx_MODE_ENGn_SHIFT(idx
, cfg
->reg_op_mode
.shift
);
128 lp55xx_update_bits(chip
, cfg
->reg_op_mode
.addr
, mask
, val
);
129 lp55xx_wait_opmode_done(chip
);
131 /* Setup PAGE if supported (pages_per_engine not 0)*/
132 if (cfg
->pages_per_engine
)
133 lp55xx_write(chip
, LP55xx_REG_PROG_PAGE_SEL
,
134 LP55xx_PAGE_OFFSET(idx
, cfg
->pages_per_engine
));
136 EXPORT_SYMBOL_GPL(lp55xx_load_engine
);
138 int lp55xx_run_engine_common(struct lp55xx_chip
*chip
)
140 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
144 /* To run the engine, both OP MODE and EXEC needs to be put in RUN mode */
145 ret
= lp55xx_read(chip
, cfg
->reg_op_mode
.addr
, &mode
);
149 ret
= lp55xx_read(chip
, cfg
->reg_exec
.addr
, &exec
);
153 /* Switch to RUN only for engine that were put in LOAD previously */
154 for (i
= LP55XX_ENGINE_1
; i
<= LP55XX_ENGINE_3
; i
++) {
155 if (LP55xx_MODE_ENGn_GET(i
, mode
, cfg
->reg_op_mode
.shift
) != LP55xx_MODE_LOAD_ENG
)
158 mode
&= ~LP55xx_MODE_ENGn_MASK(i
, cfg
->reg_op_mode
.shift
);
159 mode
|= LP55xx_MODE_RUN_ENG
<< LP55xx_MODE_ENGn_SHIFT(i
, cfg
->reg_op_mode
.shift
);
160 exec
&= ~LP55xx_EXEC_ENGn_MASK(i
, cfg
->reg_exec
.shift
);
161 exec
|= LP55xx_EXEC_RUN_ENG
<< LP55xx_EXEC_ENGn_SHIFT(i
, cfg
->reg_exec
.shift
);
164 lp55xx_write(chip
, cfg
->reg_op_mode
.addr
, mode
);
165 lp55xx_wait_opmode_done(chip
);
166 lp55xx_write(chip
, cfg
->reg_exec
.addr
, exec
);
170 EXPORT_SYMBOL_GPL(lp55xx_run_engine_common
);
172 int lp55xx_update_program_memory(struct lp55xx_chip
*chip
,
173 const u8
*data
, size_t size
)
175 enum lp55xx_engine_index idx
= chip
->engine_idx
;
176 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
177 u8 pattern
[LP55xx_MAX_PROGRAM_LENGTH
] = { };
178 u8 start_addr
= cfg
->prog_mem_base
.addr
;
179 int page
, i
= 0, offset
= 0;
180 int program_length
, ret
;
182 program_length
= LP55xx_BYTES_PER_PAGE
;
183 if (cfg
->pages_per_engine
)
184 program_length
*= cfg
->pages_per_engine
;
186 while ((offset
< size
- 1) && (i
< program_length
)) {
191 /* separate sscanfs because length is working only for %s */
192 ret
= sscanf(data
+ offset
, "%2s%n ", c
, &nrchars
);
196 ret
= sscanf(c
, "%2x", &cmd
);
200 pattern
[i
] = (u8
)cmd
;
205 /* Each instruction is 16bit long. Check that length is even */
210 * For legacy LED chip with no page support, engine base address are
211 * one after another at offset of 32.
212 * For LED chip that support page, PAGE is already set in load_engine.
214 if (!cfg
->pages_per_engine
)
215 start_addr
+= LP55xx_BYTES_PER_PAGE
* idx
;
217 for (page
= 0; page
< program_length
/ LP55xx_BYTES_PER_PAGE
; page
++) {
218 /* Write to the next page each 32 bytes (if supported) */
219 if (cfg
->pages_per_engine
)
220 lp55xx_write(chip
, LP55xx_REG_PROG_PAGE_SEL
,
221 LP55xx_PAGE_OFFSET(idx
, cfg
->pages_per_engine
) + page
);
223 for (i
= 0; i
< LP55xx_BYTES_PER_PAGE
; i
++) {
224 ret
= lp55xx_write(chip
, start_addr
+ i
,
225 pattern
[i
+ (page
* LP55xx_BYTES_PER_PAGE
)]);
234 dev_err(&chip
->cl
->dev
, "wrong pattern format\n");
237 EXPORT_SYMBOL_GPL(lp55xx_update_program_memory
);
239 void lp55xx_firmware_loaded_cb(struct lp55xx_chip
*chip
)
241 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
242 const struct firmware
*fw
= chip
->fw
;
245 program_length
= LP55xx_BYTES_PER_PAGE
;
246 if (cfg
->pages_per_engine
)
247 program_length
*= cfg
->pages_per_engine
;
250 * the firmware is encoded in ascii hex character, with 2 chars
253 if (fw
->size
> program_length
* 2) {
254 dev_err(&chip
->cl
->dev
, "firmware data size overflow: %zu\n",
260 * Program memory sequence
261 * 1) set engine mode to "LOAD"
262 * 2) write firmware data into program memory
265 lp55xx_load_engine(chip
);
266 lp55xx_update_program_memory(chip
, fw
->data
, fw
->size
);
268 EXPORT_SYMBOL_GPL(lp55xx_firmware_loaded_cb
);
270 int lp55xx_led_brightness(struct lp55xx_led
*led
)
272 struct lp55xx_chip
*chip
= led
->chip
;
273 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
276 guard(mutex
)(&chip
->lock
);
278 ret
= lp55xx_write(chip
, cfg
->reg_led_pwm_base
.addr
+ led
->chan_nr
,
282 EXPORT_SYMBOL_GPL(lp55xx_led_brightness
);
284 int lp55xx_multicolor_brightness(struct lp55xx_led
*led
)
286 struct lp55xx_chip
*chip
= led
->chip
;
287 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
291 guard(mutex
)(&chip
->lock
);
293 for (i
= 0; i
< led
->mc_cdev
.num_colors
; i
++) {
294 ret
= lp55xx_write(chip
,
295 cfg
->reg_led_pwm_base
.addr
+
296 led
->mc_cdev
.subled_info
[i
].channel
,
297 led
->mc_cdev
.subled_info
[i
].brightness
);
304 EXPORT_SYMBOL_GPL(lp55xx_multicolor_brightness
);
306 void lp55xx_set_led_current(struct lp55xx_led
*led
, u8 led_current
)
308 struct lp55xx_chip
*chip
= led
->chip
;
309 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
311 led
->led_current
= led_current
;
312 lp55xx_write(led
->chip
, cfg
->reg_led_current_base
.addr
+ led
->chan_nr
,
315 EXPORT_SYMBOL_GPL(lp55xx_set_led_current
);
317 void lp55xx_turn_off_channels(struct lp55xx_chip
*chip
)
319 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
322 for (i
= 0; i
< cfg
->max_channel
; i
++)
323 lp55xx_write(chip
, cfg
->reg_led_pwm_base
.addr
+ i
, 0);
325 EXPORT_SYMBOL_GPL(lp55xx_turn_off_channels
);
327 void lp55xx_stop_engine(struct lp55xx_chip
*chip
)
329 enum lp55xx_engine_index idx
= chip
->engine_idx
;
330 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
333 mask
= LP55xx_MODE_ENGn_MASK(idx
, cfg
->reg_op_mode
.shift
);
334 lp55xx_update_bits(chip
, cfg
->reg_op_mode
.addr
, mask
, 0);
336 lp55xx_wait_opmode_done(chip
);
338 EXPORT_SYMBOL_GPL(lp55xx_stop_engine
);
340 static void lp55xx_reset_device(struct lp55xx_chip
*chip
)
342 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
343 u8 addr
= cfg
->reset
.addr
;
344 u8 val
= cfg
->reset
.val
;
346 /* no error checking here because no ACK from the device after reset */
347 lp55xx_write(chip
, addr
, val
);
350 static int lp55xx_detect_device(struct lp55xx_chip
*chip
)
352 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
353 u8 addr
= cfg
->enable
.addr
;
354 u8 val
= cfg
->enable
.val
;
357 ret
= lp55xx_write(chip
, addr
, val
);
361 usleep_range(1000, 2000);
363 ret
= lp55xx_read(chip
, addr
, &val
);
367 if (val
!= cfg
->enable
.val
)
373 static int lp55xx_post_init_device(struct lp55xx_chip
*chip
)
375 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
377 if (!cfg
->post_init_device
)
380 return cfg
->post_init_device(chip
);
383 static ssize_t
led_current_show(struct device
*dev
,
384 struct device_attribute
*attr
,
387 struct lp55xx_led
*led
= dev_to_lp55xx_led(dev
);
389 return sysfs_emit(buf
, "%d\n", led
->led_current
);
392 static ssize_t
led_current_store(struct device
*dev
,
393 struct device_attribute
*attr
,
394 const char *buf
, size_t len
)
396 struct lp55xx_led
*led
= dev_to_lp55xx_led(dev
);
397 struct lp55xx_chip
*chip
= led
->chip
;
400 if (kstrtoul(buf
, 0, &curr
))
403 if (curr
> led
->max_current
)
406 if (!chip
->cfg
->set_led_current
)
409 guard(mutex
)(&chip
->lock
);
411 chip
->cfg
->set_led_current(led
, (u8
)curr
);
416 static ssize_t
max_current_show(struct device
*dev
,
417 struct device_attribute
*attr
,
420 struct lp55xx_led
*led
= dev_to_lp55xx_led(dev
);
422 return sysfs_emit(buf
, "%d\n", led
->max_current
);
425 static DEVICE_ATTR_RW(led_current
);
426 static DEVICE_ATTR_RO(max_current
);
428 static struct attribute
*lp55xx_led_attrs
[] = {
429 &dev_attr_led_current
.attr
,
430 &dev_attr_max_current
.attr
,
433 ATTRIBUTE_GROUPS(lp55xx_led
);
435 static int lp55xx_set_mc_brightness(struct led_classdev
*cdev
,
436 enum led_brightness brightness
)
438 struct led_classdev_mc
*mc_dev
= lcdev_to_mccdev(cdev
);
439 struct lp55xx_led
*led
= mcled_cdev_to_led(mc_dev
);
440 const struct lp55xx_device_config
*cfg
= led
->chip
->cfg
;
442 led_mc_calc_color_components(&led
->mc_cdev
, brightness
);
443 return cfg
->multicolor_brightness_fn(led
);
447 static int lp55xx_set_brightness(struct led_classdev
*cdev
,
448 enum led_brightness brightness
)
450 struct lp55xx_led
*led
= cdev_to_lp55xx_led(cdev
);
451 const struct lp55xx_device_config
*cfg
= led
->chip
->cfg
;
453 led
->brightness
= (u8
)brightness
;
454 return cfg
->brightness_fn(led
);
457 static int lp55xx_init_led(struct lp55xx_led
*led
,
458 struct lp55xx_chip
*chip
, int chan
)
460 struct lp55xx_platform_data
*pdata
= chip
->pdata
;
461 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
462 struct device
*dev
= &chip
->cl
->dev
;
463 int max_channel
= cfg
->max_channel
;
464 struct mc_subled
*mc_led_info
;
465 struct led_classdev
*led_cdev
;
470 if (chan
>= max_channel
) {
471 dev_err(dev
, "invalid channel: %d / %d\n", chan
, max_channel
);
475 if (pdata
->led_config
[chan
].led_current
== 0)
478 if (pdata
->led_config
[chan
].name
) {
479 led
->cdev
.name
= pdata
->led_config
[chan
].name
;
481 snprintf(name
, sizeof(name
), "%s:channel%d",
482 pdata
->label
? : chip
->cl
->name
, chan
);
483 led
->cdev
.name
= name
;
486 if (pdata
->led_config
[chan
].num_colors
> 1) {
487 mc_led_info
= devm_kcalloc(dev
,
488 pdata
->led_config
[chan
].num_colors
,
489 sizeof(*mc_led_info
), GFP_KERNEL
);
493 led_cdev
= &led
->mc_cdev
.led_cdev
;
494 led_cdev
->name
= led
->cdev
.name
;
495 led_cdev
->brightness_set_blocking
= lp55xx_set_mc_brightness
;
496 led
->mc_cdev
.num_colors
= pdata
->led_config
[chan
].num_colors
;
497 for (i
= 0; i
< led
->mc_cdev
.num_colors
; i
++) {
498 mc_led_info
[i
].color_index
=
499 pdata
->led_config
[chan
].color_id
[i
];
500 mc_led_info
[i
].channel
=
501 pdata
->led_config
[chan
].output_num
[i
];
504 led
->mc_cdev
.subled_info
= mc_led_info
;
506 led
->cdev
.brightness_set_blocking
= lp55xx_set_brightness
;
509 led
->cdev
.groups
= lp55xx_led_groups
;
510 led
->cdev
.default_trigger
= pdata
->led_config
[chan
].default_trigger
;
511 led
->led_current
= pdata
->led_config
[chan
].led_current
;
512 led
->max_current
= pdata
->led_config
[chan
].max_current
;
513 led
->chan_nr
= pdata
->led_config
[chan
].chan_nr
;
515 if (led
->chan_nr
>= max_channel
) {
516 dev_err(dev
, "Use channel numbers between 0 and %d\n",
521 if (pdata
->led_config
[chan
].num_colors
> 1)
522 ret
= devm_led_classdev_multicolor_register(dev
, &led
->mc_cdev
);
524 ret
= devm_led_classdev_register(dev
, &led
->cdev
);
527 dev_err(dev
, "led register err: %d\n", ret
);
534 static void lp55xx_firmware_loaded(const struct firmware
*fw
, void *context
)
536 struct lp55xx_chip
*chip
= context
;
537 struct device
*dev
= &chip
->cl
->dev
;
538 enum lp55xx_engine_index idx
= chip
->engine_idx
;
541 dev_err(dev
, "firmware request failed\n");
545 /* handling firmware data is chip dependent */
546 scoped_guard(mutex
, &chip
->lock
) {
547 chip
->engines
[idx
- 1].mode
= LP55XX_ENGINE_LOAD
;
549 if (chip
->cfg
->firmware_cb
)
550 chip
->cfg
->firmware_cb(chip
);
553 /* firmware should be released for other channel use */
554 release_firmware(chip
->fw
);
558 static int lp55xx_request_firmware(struct lp55xx_chip
*chip
)
560 const char *name
= chip
->cl
->name
;
561 struct device
*dev
= &chip
->cl
->dev
;
563 return request_firmware_nowait(THIS_MODULE
, false, name
, dev
,
564 GFP_KERNEL
, chip
, lp55xx_firmware_loaded
);
567 static ssize_t
select_engine_show(struct device
*dev
,
568 struct device_attribute
*attr
,
571 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
572 struct lp55xx_chip
*chip
= led
->chip
;
574 return sprintf(buf
, "%d\n", chip
->engine_idx
);
577 static ssize_t
select_engine_store(struct device
*dev
,
578 struct device_attribute
*attr
,
579 const char *buf
, size_t len
)
581 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
582 struct lp55xx_chip
*chip
= led
->chip
;
586 if (kstrtoul(buf
, 0, &val
))
589 /* select the engine to be run */
592 case LP55XX_ENGINE_1
:
593 case LP55XX_ENGINE_2
:
594 case LP55XX_ENGINE_3
:
595 scoped_guard(mutex
, &chip
->lock
) {
596 chip
->engine_idx
= val
;
597 ret
= lp55xx_request_firmware(chip
);
601 dev_err(dev
, "%lu: invalid engine index. (1, 2, 3)\n", val
);
606 dev_err(dev
, "request firmware err: %d\n", ret
);
613 static inline void lp55xx_run_engine(struct lp55xx_chip
*chip
, bool start
)
615 if (chip
->cfg
->run_engine
)
616 chip
->cfg
->run_engine(chip
, start
);
619 static ssize_t
run_engine_store(struct device
*dev
,
620 struct device_attribute
*attr
,
621 const char *buf
, size_t len
)
623 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
624 struct lp55xx_chip
*chip
= led
->chip
;
627 if (kstrtoul(buf
, 0, &val
))
630 /* run or stop the selected engine */
633 lp55xx_run_engine(chip
, false);
637 guard(mutex
)(&chip
->lock
);
639 lp55xx_run_engine(chip
, true);
644 static DEVICE_ATTR_RW(select_engine
);
645 static DEVICE_ATTR_WO(run_engine
);
647 ssize_t
lp55xx_show_engine_mode(struct device
*dev
,
648 struct device_attribute
*attr
,
651 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
652 struct lp55xx_chip
*chip
= led
->chip
;
653 enum lp55xx_engine_mode mode
= chip
->engines
[nr
- 1].mode
;
656 case LP55XX_ENGINE_RUN
:
657 return sysfs_emit(buf
, "run\n");
658 case LP55XX_ENGINE_LOAD
:
659 return sysfs_emit(buf
, "load\n");
660 case LP55XX_ENGINE_DISABLED
:
662 return sysfs_emit(buf
, "disabled\n");
665 EXPORT_SYMBOL_GPL(lp55xx_show_engine_mode
);
667 ssize_t
lp55xx_store_engine_mode(struct device
*dev
,
668 struct device_attribute
*attr
,
669 const char *buf
, size_t len
, int nr
)
671 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
672 struct lp55xx_chip
*chip
= led
->chip
;
673 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
674 struct lp55xx_engine
*engine
= &chip
->engines
[nr
- 1];
676 guard(mutex
)(&chip
->lock
);
678 chip
->engine_idx
= nr
;
680 if (!strncmp(buf
, "run", 3)) {
681 cfg
->run_engine(chip
, true);
682 engine
->mode
= LP55XX_ENGINE_RUN
;
683 } else if (!strncmp(buf
, "load", 4)) {
684 lp55xx_stop_engine(chip
);
685 lp55xx_load_engine(chip
);
686 engine
->mode
= LP55XX_ENGINE_LOAD
;
687 } else if (!strncmp(buf
, "disabled", 8)) {
688 lp55xx_stop_engine(chip
);
689 engine
->mode
= LP55XX_ENGINE_DISABLED
;
694 EXPORT_SYMBOL_GPL(lp55xx_store_engine_mode
);
696 ssize_t
lp55xx_store_engine_load(struct device
*dev
,
697 struct device_attribute
*attr
,
698 const char *buf
, size_t len
, int nr
)
700 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
701 struct lp55xx_chip
*chip
= led
->chip
;
704 guard(mutex
)(&chip
->lock
);
706 chip
->engine_idx
= nr
;
707 lp55xx_load_engine(chip
);
708 ret
= lp55xx_update_program_memory(chip
, buf
, len
);
712 EXPORT_SYMBOL_GPL(lp55xx_store_engine_load
);
714 static int lp55xx_mux_parse(struct lp55xx_chip
*chip
, const char *buf
,
715 u16
*mux
, size_t len
)
717 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
721 len
= min_t(int, len
, cfg
->max_channel
);
723 for (i
= 0; i
< len
; i
++) {
742 ssize_t
lp55xx_show_engine_leds(struct device
*dev
,
743 struct device_attribute
*attr
,
746 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
747 struct lp55xx_chip
*chip
= led
->chip
;
748 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
749 unsigned int led_active
;
752 for (i
= 0; i
< cfg
->max_channel
; i
++) {
753 led_active
= LED_ACTIVE(chip
->engines
[nr
- 1].led_mux
, i
);
754 pos
+= sysfs_emit_at(buf
, pos
, "%x", led_active
);
757 pos
+= sysfs_emit_at(buf
, pos
, "\n");
761 EXPORT_SYMBOL_GPL(lp55xx_show_engine_leds
);
763 static int lp55xx_load_mux(struct lp55xx_chip
*chip
, u16 mux
, int nr
)
765 struct lp55xx_engine
*engine
= &chip
->engines
[nr
- 1];
766 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
770 lp55xx_load_engine(chip
);
772 /* Derive the MUX page offset by starting at the end of the ENGINE pages */
773 mux_page
= cfg
->pages_per_engine
* LP55XX_ENGINE_MAX
+ (nr
- 1);
774 ret
= lp55xx_write(chip
, LP55xx_REG_PROG_PAGE_SEL
, mux_page
);
778 ret
= lp55xx_write(chip
, cfg
->prog_mem_base
.addr
, (u8
)(mux
>> 8));
782 ret
= lp55xx_write(chip
, cfg
->prog_mem_base
.addr
+ 1, (u8
)(mux
));
786 engine
->led_mux
= mux
;
790 ssize_t
lp55xx_store_engine_leds(struct device
*dev
,
791 struct device_attribute
*attr
,
792 const char *buf
, size_t len
, int nr
)
794 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
795 struct lp55xx_chip
*chip
= led
->chip
;
796 struct lp55xx_engine
*engine
= &chip
->engines
[nr
- 1];
799 if (lp55xx_mux_parse(chip
, buf
, &mux
, len
))
802 guard(mutex
)(&chip
->lock
);
804 chip
->engine_idx
= nr
;
806 if (engine
->mode
!= LP55XX_ENGINE_LOAD
)
809 if (lp55xx_load_mux(chip
, mux
, nr
))
814 EXPORT_SYMBOL_GPL(lp55xx_store_engine_leds
);
816 ssize_t
lp55xx_show_master_fader(struct device
*dev
,
817 struct device_attribute
*attr
,
820 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
821 struct lp55xx_chip
*chip
= led
->chip
;
822 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
826 guard(mutex
)(&chip
->lock
);
828 ret
= lp55xx_read(chip
, cfg
->reg_master_fader_base
.addr
+ nr
- 1, &val
);
830 return ret
? ret
: sysfs_emit(buf
, "%u\n", val
);
832 EXPORT_SYMBOL_GPL(lp55xx_show_master_fader
);
834 ssize_t
lp55xx_store_master_fader(struct device
*dev
,
835 struct device_attribute
*attr
,
836 const char *buf
, size_t len
, int nr
)
838 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
839 struct lp55xx_chip
*chip
= led
->chip
;
840 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
844 if (kstrtoul(buf
, 0, &val
))
850 guard(mutex
)(&chip
->lock
);
852 ret
= lp55xx_write(chip
, cfg
->reg_master_fader_base
.addr
+ nr
- 1,
855 return ret
? ret
: len
;
857 EXPORT_SYMBOL_GPL(lp55xx_store_master_fader
);
859 ssize_t
lp55xx_show_master_fader_leds(struct device
*dev
,
860 struct device_attribute
*attr
,
863 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
864 struct lp55xx_chip
*chip
= led
->chip
;
865 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
869 guard(mutex
)(&chip
->lock
);
871 for (i
= 0; i
< cfg
->max_channel
; i
++) {
872 ret
= lp55xx_read(chip
, cfg
->reg_led_ctrl_base
.addr
+ i
, &val
);
876 val
= FIELD_GET(LP55xx_FADER_MAPPING_MASK
, val
);
877 if (val
> FIELD_MAX(LP55xx_FADER_MAPPING_MASK
)) {
880 buf
[pos
++] = val
+ '0';
886 EXPORT_SYMBOL_GPL(lp55xx_show_master_fader_leds
);
888 ssize_t
lp55xx_store_master_fader_leds(struct device
*dev
,
889 struct device_attribute
*attr
,
890 const char *buf
, size_t len
)
892 struct lp55xx_led
*led
= i2c_get_clientdata(to_i2c_client(dev
));
893 struct lp55xx_chip
*chip
= led
->chip
;
894 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
898 n
= min_t(int, len
, cfg
->max_channel
);
900 guard(mutex
)(&chip
->lock
);
902 for (i
= 0; i
< n
; i
++) {
903 if (buf
[i
] >= '0' && buf
[i
] <= '3') {
904 val
= (buf
[i
] - '0') << __bf_shf(LP55xx_FADER_MAPPING_MASK
);
905 ret
= lp55xx_update_bits(chip
,
906 cfg
->reg_led_ctrl_base
.addr
+ i
,
907 LP55xx_FADER_MAPPING_MASK
,
918 EXPORT_SYMBOL_GPL(lp55xx_store_master_fader_leds
);
920 static struct attribute
*lp55xx_engine_attributes
[] = {
921 &dev_attr_select_engine
.attr
,
922 &dev_attr_run_engine
.attr
,
926 static const struct attribute_group lp55xx_engine_attr_group
= {
927 .attrs
= lp55xx_engine_attributes
,
930 int lp55xx_write(struct lp55xx_chip
*chip
, u8 reg
, u8 val
)
932 return i2c_smbus_write_byte_data(chip
->cl
, reg
, val
);
934 EXPORT_SYMBOL_GPL(lp55xx_write
);
936 int lp55xx_read(struct lp55xx_chip
*chip
, u8 reg
, u8
*val
)
940 ret
= i2c_smbus_read_byte_data(chip
->cl
, reg
);
947 EXPORT_SYMBOL_GPL(lp55xx_read
);
949 int lp55xx_update_bits(struct lp55xx_chip
*chip
, u8 reg
, u8 mask
, u8 val
)
954 ret
= lp55xx_read(chip
, reg
, &tmp
);
961 return lp55xx_write(chip
, reg
, tmp
);
963 EXPORT_SYMBOL_GPL(lp55xx_update_bits
);
965 bool lp55xx_is_extclk_used(struct lp55xx_chip
*chip
)
969 clk
= devm_clk_get_enabled(&chip
->cl
->dev
, "32k_clk");
971 goto use_internal_clk
;
973 if (clk_get_rate(clk
) != LP55XX_CLK_32K
)
974 goto use_internal_clk
;
976 dev_info(&chip
->cl
->dev
, "%dHz external clock used\n", LP55XX_CLK_32K
);
981 dev_info(&chip
->cl
->dev
, "internal clock used\n");
984 EXPORT_SYMBOL_GPL(lp55xx_is_extclk_used
);
986 static void lp55xx_deinit_device(struct lp55xx_chip
*chip
)
988 struct lp55xx_platform_data
*pdata
= chip
->pdata
;
990 if (pdata
->enable_gpiod
)
991 gpiod_set_value(pdata
->enable_gpiod
, 0);
994 static int lp55xx_init_device(struct lp55xx_chip
*chip
)
996 struct lp55xx_platform_data
*pdata
;
997 const struct lp55xx_device_config
*cfg
;
998 struct device
*dev
= &chip
->cl
->dev
;
1003 pdata
= chip
->pdata
;
1009 if (pdata
->enable_gpiod
) {
1010 gpiod_direction_output(pdata
->enable_gpiod
, 0);
1012 gpiod_set_consumer_name(pdata
->enable_gpiod
, "LP55xx enable");
1013 gpiod_set_value_cansleep(pdata
->enable_gpiod
, 0);
1014 usleep_range(1000, 2000); /* Keep enable down at least 1ms */
1015 gpiod_set_value_cansleep(pdata
->enable_gpiod
, 1);
1016 usleep_range(1000, 2000); /* 500us abs min. */
1019 lp55xx_reset_device(chip
);
1022 * Exact value is not available. 10 - 20ms
1023 * appears to be enough for reset.
1025 usleep_range(10000, 20000);
1027 ret
= lp55xx_detect_device(chip
);
1029 dev_err(dev
, "device detection err: %d\n", ret
);
1033 /* chip specific initialization */
1034 ret
= lp55xx_post_init_device(chip
);
1036 dev_err(dev
, "post init device err: %d\n", ret
);
1043 lp55xx_deinit_device(chip
);
1048 static int lp55xx_register_leds(struct lp55xx_led
*led
, struct lp55xx_chip
*chip
)
1050 struct lp55xx_platform_data
*pdata
= chip
->pdata
;
1051 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
1052 int num_channels
= pdata
->num_channels
;
1053 struct lp55xx_led
*each
;
1058 if (!cfg
->brightness_fn
) {
1059 dev_err(&chip
->cl
->dev
, "empty brightness configuration\n");
1063 for (i
= 0; i
< num_channels
; i
++) {
1065 /* do not initialize channels that are not connected */
1066 if (pdata
->led_config
[i
].led_current
== 0)
1069 led_current
= pdata
->led_config
[i
].led_current
;
1071 ret
= lp55xx_init_led(each
, chip
, i
);
1078 /* setting led current at each channel */
1079 if (cfg
->set_led_current
)
1080 cfg
->set_led_current(each
, led_current
);
1089 static int lp55xx_register_sysfs(struct lp55xx_chip
*chip
)
1091 struct device
*dev
= &chip
->cl
->dev
;
1092 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
1095 if (!cfg
->run_engine
|| !cfg
->firmware_cb
)
1096 goto dev_specific_attrs
;
1098 ret
= sysfs_create_group(&dev
->kobj
, &lp55xx_engine_attr_group
);
1103 return cfg
->dev_attr_group
?
1104 sysfs_create_group(&dev
->kobj
, cfg
->dev_attr_group
) : 0;
1107 static void lp55xx_unregister_sysfs(struct lp55xx_chip
*chip
)
1109 struct device
*dev
= &chip
->cl
->dev
;
1110 const struct lp55xx_device_config
*cfg
= chip
->cfg
;
1112 if (cfg
->dev_attr_group
)
1113 sysfs_remove_group(&dev
->kobj
, cfg
->dev_attr_group
);
1115 sysfs_remove_group(&dev
->kobj
, &lp55xx_engine_attr_group
);
1118 static int lp55xx_parse_common_child(struct device_node
*np
,
1119 struct lp55xx_led_config
*cfg
,
1120 int led_number
, int *chan_nr
)
1124 of_property_read_string(np
, "chan-name",
1125 &cfg
[led_number
].name
);
1126 of_property_read_u8(np
, "led-cur",
1127 &cfg
[led_number
].led_current
);
1128 of_property_read_u8(np
, "max-cur",
1129 &cfg
[led_number
].max_current
);
1131 ret
= of_property_read_u32(np
, "reg", chan_nr
);
1135 if (*chan_nr
< 0 || *chan_nr
> cfg
->max_channel
)
1141 static int lp55xx_parse_multi_led_child(struct device_node
*child
,
1142 struct lp55xx_led_config
*cfg
,
1143 int child_number
, int color_number
)
1145 int chan_nr
, color_id
, ret
;
1147 ret
= lp55xx_parse_common_child(child
, cfg
, child_number
, &chan_nr
);
1151 ret
= of_property_read_u32(child
, "color", &color_id
);
1155 cfg
[child_number
].color_id
[color_number
] = color_id
;
1156 cfg
[child_number
].output_num
[color_number
] = chan_nr
;
1161 static int lp55xx_parse_multi_led(struct device_node
*np
,
1162 struct lp55xx_led_config
*cfg
,
1165 int num_colors
= 0, ret
;
1167 for_each_available_child_of_node_scoped(np
, child
) {
1168 ret
= lp55xx_parse_multi_led_child(child
, cfg
, child_number
,
1175 cfg
[child_number
].num_colors
= num_colors
;
1180 static int lp55xx_parse_logical_led(struct device_node
*np
,
1181 struct lp55xx_led_config
*cfg
,
1187 cfg
[child_number
].default_trigger
=
1188 of_get_property(np
, "linux,default-trigger", NULL
);
1190 ret
= of_property_read_u32(np
, "color", &led_color
);
1194 if (led_color
== LED_COLOR_ID_RGB
)
1195 return lp55xx_parse_multi_led(np
, cfg
, child_number
);
1197 ret
= lp55xx_parse_common_child(np
, cfg
, child_number
, &chan_nr
);
1201 cfg
[child_number
].chan_nr
= chan_nr
;
1206 static struct lp55xx_platform_data
*lp55xx_of_populate_pdata(struct device
*dev
,
1207 struct device_node
*np
,
1208 struct lp55xx_chip
*chip
)
1210 struct device_node
*child
;
1211 struct lp55xx_platform_data
*pdata
;
1212 struct lp55xx_led_config
*cfg
;
1217 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
1219 return ERR_PTR(-ENOMEM
);
1221 num_channels
= of_get_available_child_count(np
);
1222 if (num_channels
== 0) {
1223 dev_err(dev
, "no LED channels\n");
1224 return ERR_PTR(-EINVAL
);
1227 cfg
= devm_kcalloc(dev
, num_channels
, sizeof(*cfg
), GFP_KERNEL
);
1229 return ERR_PTR(-ENOMEM
);
1231 pdata
->led_config
= &cfg
[0];
1232 pdata
->num_channels
= num_channels
;
1233 cfg
->max_channel
= chip
->cfg
->max_channel
;
1235 for_each_available_child_of_node(np
, child
) {
1236 ret
= lp55xx_parse_logical_led(child
, cfg
, i
);
1239 return ERR_PTR(-EINVAL
);
1244 if (of_property_read_u32(np
, "ti,charge-pump-mode", &pdata
->charge_pump_mode
))
1245 pdata
->charge_pump_mode
= LP55XX_CP_AUTO
;
1247 if (pdata
->charge_pump_mode
> LP55XX_CP_AUTO
) {
1248 dev_err(dev
, "invalid charge pump mode %d\n", pdata
->charge_pump_mode
);
1249 return ERR_PTR(-EINVAL
);
1252 of_property_read_string(np
, "label", &pdata
->label
);
1253 of_property_read_u8(np
, "clock-mode", &pdata
->clock_mode
);
1255 pdata
->enable_gpiod
= devm_gpiod_get_optional(dev
, "enable",
1257 if (IS_ERR(pdata
->enable_gpiod
))
1258 return ERR_CAST(pdata
->enable_gpiod
);
1260 /* LP8501 specific */
1261 of_property_read_u8(np
, "pwr-sel", (u8
*)&pdata
->pwr_sel
);
1266 int lp55xx_probe(struct i2c_client
*client
)
1268 const struct i2c_device_id
*id
= i2c_client_get_device_id(client
);
1269 int program_length
, ret
;
1270 struct lp55xx_chip
*chip
;
1271 struct lp55xx_led
*led
;
1272 struct lp55xx_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
1273 struct device_node
*np
= dev_of_node(&client
->dev
);
1275 chip
= devm_kzalloc(&client
->dev
, sizeof(*chip
), GFP_KERNEL
);
1279 chip
->cfg
= i2c_get_match_data(client
);
1283 pdata
= lp55xx_of_populate_pdata(&client
->dev
, np
,
1286 return PTR_ERR(pdata
);
1288 dev_err(&client
->dev
, "no platform data\n");
1293 /* Validate max program page */
1294 program_length
= LP55xx_BYTES_PER_PAGE
;
1295 if (chip
->cfg
->pages_per_engine
)
1296 program_length
*= chip
->cfg
->pages_per_engine
;
1298 /* support a max of 128bytes */
1299 if (program_length
> LP55xx_MAX_PROGRAM_LENGTH
) {
1300 dev_err(&client
->dev
, "invalid pages_per_engine configured\n");
1304 led
= devm_kcalloc(&client
->dev
,
1305 pdata
->num_channels
, sizeof(*led
), GFP_KERNEL
);
1310 chip
->pdata
= pdata
;
1312 mutex_init(&chip
->lock
);
1314 i2c_set_clientdata(client
, led
);
1316 ret
= lp55xx_init_device(chip
);
1320 dev_info(&client
->dev
, "%s Programmable led chip found\n", id
->name
);
1322 ret
= lp55xx_register_leds(led
, chip
);
1326 ret
= lp55xx_register_sysfs(chip
);
1328 dev_err(&client
->dev
, "registering sysfs failed\n");
1335 lp55xx_deinit_device(chip
);
1339 EXPORT_SYMBOL_GPL(lp55xx_probe
);
1341 void lp55xx_remove(struct i2c_client
*client
)
1343 struct lp55xx_led
*led
= i2c_get_clientdata(client
);
1344 struct lp55xx_chip
*chip
= led
->chip
;
1346 lp55xx_stop_all_engine(chip
);
1347 lp55xx_unregister_sysfs(chip
);
1348 lp55xx_deinit_device(chip
);
1350 EXPORT_SYMBOL_GPL(lp55xx_remove
);
1352 MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
1353 MODULE_DESCRIPTION("LP55xx Common Driver");
1354 MODULE_LICENSE("GPL");