1 // SPDX-License-Identifier: GPL-2.0-only
3 * LP5521 LED chip driver.
5 * Copyright (C) 2010 Nokia Corporation
6 * Copyright (C) 2012 Texas Instruments
8 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
9 * Milo(Woogyom) Kim <milo.kim@ti.com>
12 #include <linux/delay.h>
13 #include <linux/firmware.h>
14 #include <linux/i2c.h>
15 #include <linux/leds.h>
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/platform_data/leds-lp55xx.h>
19 #include <linux/slab.h>
22 #include "leds-lp55xx-common.h"
24 #define LP5521_PROGRAM_LENGTH 32
25 #define LP5521_MAX_LEDS 3
26 #define LP5521_CMD_DIRECT 0x3F
29 #define LP5521_REG_ENABLE 0x00
30 #define LP5521_REG_OP_MODE 0x01
31 #define LP5521_REG_R_PWM 0x02
32 #define LP5521_REG_G_PWM 0x03
33 #define LP5521_REG_B_PWM 0x04
34 #define LP5521_REG_R_CURRENT 0x05
35 #define LP5521_REG_G_CURRENT 0x06
36 #define LP5521_REG_B_CURRENT 0x07
37 #define LP5521_REG_CONFIG 0x08
38 #define LP5521_REG_STATUS 0x0C
39 #define LP5521_REG_RESET 0x0D
40 #define LP5521_REG_R_PROG_MEM 0x10
41 #define LP5521_REG_G_PROG_MEM 0x30
42 #define LP5521_REG_B_PROG_MEM 0x50
44 /* Base register to set LED current */
45 #define LP5521_REG_LED_CURRENT_BASE LP5521_REG_R_CURRENT
46 /* Base register to set the brightness */
47 #define LP5521_REG_LED_PWM_BASE LP5521_REG_R_PWM
49 /* Bits in ENABLE register */
50 #define LP5521_MASTER_ENABLE 0x40 /* Chip master enable */
51 #define LP5521_LOGARITHMIC_PWM 0x80 /* Logarithmic PWM adjustment */
52 #define LP5521_EXEC_RUN 0x2A
53 #define LP5521_ENABLE_DEFAULT \
54 (LP5521_MASTER_ENABLE | LP5521_LOGARITHMIC_PWM)
55 #define LP5521_ENABLE_RUN_PROGRAM \
56 (LP5521_ENABLE_DEFAULT | LP5521_EXEC_RUN)
59 #define LP5521_PWM_HF 0x40 /* PWM: 0 = 256Hz, 1 = 558Hz */
60 #define LP5521_PWRSAVE_EN 0x20 /* 1 = Power save mode */
61 #define LP5521_CP_MODE_MASK 0x18 /* Charge pump mode */
62 #define LP5521_CP_MODE_SHIFT 3
63 #define LP5521_R_TO_BATT 0x04 /* R out: 0 = CP, 1 = Vbat */
64 #define LP5521_CLK_INT 0x01 /* Internal clock */
65 #define LP5521_DEFAULT_CFG (LP5521_PWM_HF | LP5521_PWRSAVE_EN)
68 #define LP5521_EXT_CLK_USED 0x08
70 /* default R channel current register value */
71 #define LP5521_REG_R_CURR_DEFAULT 0xAF
73 /* Reset register value */
74 #define LP5521_RESET 0xFF
76 /* Program Memory Operations */
77 #define LP5521_MODE_R_M 0x30 /* Operation Mode Register */
78 #define LP5521_MODE_G_M 0x0C
79 #define LP5521_MODE_B_M 0x03
80 #define LP5521_LOAD_R 0x10
81 #define LP5521_LOAD_G 0x04
82 #define LP5521_LOAD_B 0x01
84 #define LP5521_R_IS_LOADING(mode) \
85 ((mode & LP5521_MODE_R_M) == LP5521_LOAD_R)
86 #define LP5521_G_IS_LOADING(mode) \
87 ((mode & LP5521_MODE_G_M) == LP5521_LOAD_G)
88 #define LP5521_B_IS_LOADING(mode) \
89 ((mode & LP5521_MODE_B_M) == LP5521_LOAD_B)
91 #define LP5521_EXEC_R_M 0x30 /* Enable Register */
92 #define LP5521_EXEC_G_M 0x0C
93 #define LP5521_EXEC_B_M 0x03
94 #define LP5521_EXEC_M 0x3F
95 #define LP5521_RUN_R 0x20
96 #define LP5521_RUN_G 0x08
97 #define LP5521_RUN_B 0x02
99 static inline void lp5521_wait_opmode_done(void)
101 /* operation mode change needs to be longer than 153 us */
102 usleep_range(200, 300);
105 static inline void lp5521_wait_enable_done(void)
107 /* it takes more 488 us to update ENABLE register */
108 usleep_range(500, 600);
111 static void lp5521_set_led_current(struct lp55xx_led *led, u8 led_current)
113 led->led_current = led_current;
114 lp55xx_write(led->chip, LP5521_REG_LED_CURRENT_BASE + led->chan_nr,
118 static void lp5521_load_engine(struct lp55xx_chip *chip)
120 enum lp55xx_engine_index idx = chip->engine_idx;
121 static const u8 mask[] = {
122 [LP55XX_ENGINE_1] = LP5521_MODE_R_M,
123 [LP55XX_ENGINE_2] = LP5521_MODE_G_M,
124 [LP55XX_ENGINE_3] = LP5521_MODE_B_M,
127 static const u8 val[] = {
128 [LP55XX_ENGINE_1] = LP5521_LOAD_R,
129 [LP55XX_ENGINE_2] = LP5521_LOAD_G,
130 [LP55XX_ENGINE_3] = LP5521_LOAD_B,
133 lp55xx_update_bits(chip, LP5521_REG_OP_MODE, mask[idx], val[idx]);
135 lp5521_wait_opmode_done();
138 static void lp5521_stop_all_engines(struct lp55xx_chip *chip)
140 lp55xx_write(chip, LP5521_REG_OP_MODE, 0);
141 lp5521_wait_opmode_done();
144 static void lp5521_stop_engine(struct lp55xx_chip *chip)
146 enum lp55xx_engine_index idx = chip->engine_idx;
147 static const u8 mask[] = {
148 [LP55XX_ENGINE_1] = LP5521_MODE_R_M,
149 [LP55XX_ENGINE_2] = LP5521_MODE_G_M,
150 [LP55XX_ENGINE_3] = LP5521_MODE_B_M,
153 lp55xx_update_bits(chip, LP5521_REG_OP_MODE, mask[idx], 0);
155 lp5521_wait_opmode_done();
158 static void lp5521_run_engine(struct lp55xx_chip *chip, bool start)
166 lp5521_stop_engine(chip);
167 lp55xx_write(chip, LP5521_REG_OP_MODE, LP5521_CMD_DIRECT);
168 lp5521_wait_opmode_done();
174 * operation mode and enable register should updated at the same time
177 ret = lp55xx_read(chip, LP5521_REG_OP_MODE, &mode);
181 ret = lp55xx_read(chip, LP5521_REG_ENABLE, &exec);
185 /* change operation mode to RUN only when each engine is loading */
186 if (LP5521_R_IS_LOADING(mode)) {
187 mode = (mode & ~LP5521_MODE_R_M) | LP5521_RUN_R;
188 exec = (exec & ~LP5521_EXEC_R_M) | LP5521_RUN_R;
191 if (LP5521_G_IS_LOADING(mode)) {
192 mode = (mode & ~LP5521_MODE_G_M) | LP5521_RUN_G;
193 exec = (exec & ~LP5521_EXEC_G_M) | LP5521_RUN_G;
196 if (LP5521_B_IS_LOADING(mode)) {
197 mode = (mode & ~LP5521_MODE_B_M) | LP5521_RUN_B;
198 exec = (exec & ~LP5521_EXEC_B_M) | LP5521_RUN_B;
201 lp55xx_write(chip, LP5521_REG_OP_MODE, mode);
202 lp5521_wait_opmode_done();
204 lp55xx_update_bits(chip, LP5521_REG_ENABLE, LP5521_EXEC_M, exec);
205 lp5521_wait_enable_done();
208 static int lp5521_update_program_memory(struct lp55xx_chip *chip,
209 const u8 *data, size_t size)
211 enum lp55xx_engine_index idx = chip->engine_idx;
212 u8 pattern[LP5521_PROGRAM_LENGTH] = {0};
213 static const u8 addr[] = {
214 [LP55XX_ENGINE_1] = LP5521_REG_R_PROG_MEM,
215 [LP55XX_ENGINE_2] = LP5521_REG_G_PROG_MEM,
216 [LP55XX_ENGINE_3] = LP5521_REG_B_PROG_MEM,
225 while ((offset < size - 1) && (i < LP5521_PROGRAM_LENGTH)) {
226 /* separate sscanfs because length is working only for %s */
227 ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
231 ret = sscanf(c, "%2x", &cmd);
235 pattern[i] = (u8)cmd;
240 /* Each instruction is 16bit long. Check that length is even */
244 for (i = 0; i < LP5521_PROGRAM_LENGTH; i++) {
245 ret = lp55xx_write(chip, addr[idx] + i, pattern[i]);
253 dev_err(&chip->cl->dev, "wrong pattern format\n");
257 static void lp5521_firmware_loaded(struct lp55xx_chip *chip)
259 const struct firmware *fw = chip->fw;
261 if (fw->size > LP5521_PROGRAM_LENGTH) {
262 dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
268 * Program memory sequence
269 * 1) set engine mode to "LOAD"
270 * 2) write firmware data into program memory
273 lp5521_load_engine(chip);
274 lp5521_update_program_memory(chip, fw->data, fw->size);
277 static int lp5521_post_init_device(struct lp55xx_chip *chip)
283 * Make sure that the chip is reset by reading back the r channel
284 * current reg. This is dummy read is required on some platforms -
285 * otherwise further access to the R G B channels in the
286 * LP5521_REG_ENABLE register will not have any effect - strange!
288 ret = lp55xx_read(chip, LP5521_REG_R_CURRENT, &val);
290 dev_err(&chip->cl->dev, "error in resetting chip\n");
293 if (val != LP5521_REG_R_CURR_DEFAULT) {
294 dev_err(&chip->cl->dev,
295 "unexpected data in register (expected 0x%x got 0x%x)\n",
296 LP5521_REG_R_CURR_DEFAULT, val);
300 usleep_range(10000, 20000);
302 /* Set all PWMs to direct control mode */
303 ret = lp55xx_write(chip, LP5521_REG_OP_MODE, LP5521_CMD_DIRECT);
307 /* Update configuration for the clock setting */
308 val = LP5521_DEFAULT_CFG;
309 if (!lp55xx_is_extclk_used(chip))
310 val |= LP5521_CLK_INT;
312 val |= (chip->pdata->charge_pump_mode << LP5521_CP_MODE_SHIFT) & LP5521_CP_MODE_MASK;
314 ret = lp55xx_write(chip, LP5521_REG_CONFIG, val);
318 /* Initialize all channels PWM to zero -> leds off */
319 lp55xx_write(chip, LP5521_REG_R_PWM, 0);
320 lp55xx_write(chip, LP5521_REG_G_PWM, 0);
321 lp55xx_write(chip, LP5521_REG_B_PWM, 0);
323 /* Set engines are set to run state when OP_MODE enables engines */
324 ret = lp55xx_write(chip, LP5521_REG_ENABLE, LP5521_ENABLE_RUN_PROGRAM);
328 lp5521_wait_enable_done();
333 static int lp5521_run_selftest(struct lp55xx_chip *chip, char *buf)
335 struct lp55xx_platform_data *pdata = chip->pdata;
339 ret = lp55xx_read(chip, LP5521_REG_STATUS, &status);
343 if (pdata->clock_mode != LP55XX_CLOCK_EXT)
346 /* Check that ext clock is really in use if requested */
347 if ((status & LP5521_EXT_CLK_USED) == 0)
353 static int lp5521_multicolor_brightness(struct lp55xx_led *led)
355 struct lp55xx_chip *chip = led->chip;
359 mutex_lock(&chip->lock);
360 for (i = 0; i < led->mc_cdev.num_colors; i++) {
361 ret = lp55xx_write(chip,
362 LP5521_REG_LED_PWM_BASE +
363 led->mc_cdev.subled_info[i].channel,
364 led->mc_cdev.subled_info[i].brightness);
368 mutex_unlock(&chip->lock);
372 static int lp5521_led_brightness(struct lp55xx_led *led)
374 struct lp55xx_chip *chip = led->chip;
377 mutex_lock(&chip->lock);
378 ret = lp55xx_write(chip, LP5521_REG_LED_PWM_BASE + led->chan_nr,
380 mutex_unlock(&chip->lock);
385 static ssize_t show_engine_mode(struct device *dev,
386 struct device_attribute *attr,
389 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
390 struct lp55xx_chip *chip = led->chip;
391 enum lp55xx_engine_mode mode = chip->engines[nr - 1].mode;
394 case LP55XX_ENGINE_RUN:
395 return sprintf(buf, "run\n");
396 case LP55XX_ENGINE_LOAD:
397 return sprintf(buf, "load\n");
398 case LP55XX_ENGINE_DISABLED:
400 return sprintf(buf, "disabled\n");
407 static ssize_t store_engine_mode(struct device *dev,
408 struct device_attribute *attr,
409 const char *buf, size_t len, int nr)
411 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
412 struct lp55xx_chip *chip = led->chip;
413 struct lp55xx_engine *engine = &chip->engines[nr - 1];
415 mutex_lock(&chip->lock);
417 chip->engine_idx = nr;
419 if (!strncmp(buf, "run", 3)) {
420 lp5521_run_engine(chip, true);
421 engine->mode = LP55XX_ENGINE_RUN;
422 } else if (!strncmp(buf, "load", 4)) {
423 lp5521_stop_engine(chip);
424 lp5521_load_engine(chip);
425 engine->mode = LP55XX_ENGINE_LOAD;
426 } else if (!strncmp(buf, "disabled", 8)) {
427 lp5521_stop_engine(chip);
428 engine->mode = LP55XX_ENGINE_DISABLED;
431 mutex_unlock(&chip->lock);
439 static ssize_t store_engine_load(struct device *dev,
440 struct device_attribute *attr,
441 const char *buf, size_t len, int nr)
443 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
444 struct lp55xx_chip *chip = led->chip;
447 mutex_lock(&chip->lock);
449 chip->engine_idx = nr;
450 lp5521_load_engine(chip);
451 ret = lp5521_update_program_memory(chip, buf, len);
453 mutex_unlock(&chip->lock);
461 static ssize_t lp5521_selftest(struct device *dev,
462 struct device_attribute *attr,
465 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
466 struct lp55xx_chip *chip = led->chip;
469 mutex_lock(&chip->lock);
470 ret = lp5521_run_selftest(chip, buf);
471 mutex_unlock(&chip->lock);
473 return sysfs_emit(buf, "%s\n", ret ? "FAIL" : "OK");
476 /* device attributes */
477 static LP55XX_DEV_ATTR_RW(engine1_mode, show_engine1_mode, store_engine1_mode);
478 static LP55XX_DEV_ATTR_RW(engine2_mode, show_engine2_mode, store_engine2_mode);
479 static LP55XX_DEV_ATTR_RW(engine3_mode, show_engine3_mode, store_engine3_mode);
480 static LP55XX_DEV_ATTR_WO(engine1_load, store_engine1_load);
481 static LP55XX_DEV_ATTR_WO(engine2_load, store_engine2_load);
482 static LP55XX_DEV_ATTR_WO(engine3_load, store_engine3_load);
483 static LP55XX_DEV_ATTR_RO(selftest, lp5521_selftest);
485 static struct attribute *lp5521_attributes[] = {
486 &dev_attr_engine1_mode.attr,
487 &dev_attr_engine2_mode.attr,
488 &dev_attr_engine3_mode.attr,
489 &dev_attr_engine1_load.attr,
490 &dev_attr_engine2_load.attr,
491 &dev_attr_engine3_load.attr,
492 &dev_attr_selftest.attr,
496 static const struct attribute_group lp5521_group = {
497 .attrs = lp5521_attributes,
500 /* Chip specific configurations */
501 static struct lp55xx_device_config lp5521_cfg = {
503 .addr = LP5521_REG_RESET,
507 .addr = LP5521_REG_ENABLE,
508 .val = LP5521_ENABLE_DEFAULT,
510 .max_channel = LP5521_MAX_LEDS,
511 .post_init_device = lp5521_post_init_device,
512 .brightness_fn = lp5521_led_brightness,
513 .multicolor_brightness_fn = lp5521_multicolor_brightness,
514 .set_led_current = lp5521_set_led_current,
515 .firmware_cb = lp5521_firmware_loaded,
516 .run_engine = lp5521_run_engine,
517 .dev_attr_group = &lp5521_group,
520 static int lp5521_probe(struct i2c_client *client)
522 const struct i2c_device_id *id = i2c_client_get_device_id(client);
524 struct lp55xx_chip *chip;
525 struct lp55xx_led *led;
526 struct lp55xx_platform_data *pdata = dev_get_platdata(&client->dev);
527 struct device_node *np = dev_of_node(&client->dev);
529 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
533 chip->cfg = &lp5521_cfg;
537 pdata = lp55xx_of_populate_pdata(&client->dev, np,
540 return PTR_ERR(pdata);
542 dev_err(&client->dev, "no platform data\n");
547 led = devm_kcalloc(&client->dev,
548 pdata->num_channels, sizeof(*led), GFP_KERNEL);
555 mutex_init(&chip->lock);
557 i2c_set_clientdata(client, led);
559 ret = lp55xx_init_device(chip);
563 dev_info(&client->dev, "%s programmable led chip found\n", id->name);
565 ret = lp55xx_register_leds(led, chip);
569 ret = lp55xx_register_sysfs(chip);
571 dev_err(&client->dev, "registering sysfs failed\n");
578 lp55xx_deinit_device(chip);
583 static void lp5521_remove(struct i2c_client *client)
585 struct lp55xx_led *led = i2c_get_clientdata(client);
586 struct lp55xx_chip *chip = led->chip;
588 lp5521_stop_all_engines(chip);
589 lp55xx_unregister_sysfs(chip);
590 lp55xx_deinit_device(chip);
593 static const struct i2c_device_id lp5521_id[] = {
594 { "lp5521", 0 }, /* Three channel chip */
597 MODULE_DEVICE_TABLE(i2c, lp5521_id);
599 static const struct of_device_id of_lp5521_leds_match[] = {
600 { .compatible = "national,lp5521", },
604 MODULE_DEVICE_TABLE(of, of_lp5521_leds_match);
606 static struct i2c_driver lp5521_driver = {
609 .of_match_table = of_lp5521_leds_match,
611 .probe = lp5521_probe,
612 .remove = lp5521_remove,
613 .id_table = lp5521_id,
616 module_i2c_driver(lp5521_driver);
618 MODULE_AUTHOR("Mathias Nyman, Yuri Zaporozhets, Samu Onkalo");
619 MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
620 MODULE_DESCRIPTION("LP5521 LED engine");
621 MODULE_LICENSE("GPL v2");