Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * lp5523.c - LP5523, LP55231 LED Driver
4 *
5 * Copyright (C) 2010 Nokia Corporation
6 * Copyright (C) 2012 Texas Instruments
7 *
8 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
9 * Milo(Woogyom) Kim <milo.kim@ti.com>
10 */
11
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/of.h>
19#include <linux/platform_data/leds-lp55xx.h>
20#include <linux/slab.h>
21
22#include "leds-lp55xx-common.h"
23
24#define LP5523_PROGRAM_LENGTH 32 /* bytes */
25/* Memory is used like this:
26 * 0x00 engine 1 program
27 * 0x10 engine 2 program
28 * 0x20 engine 3 program
29 * 0x30 engine 1 muxing info
30 * 0x40 engine 2 muxing info
31 * 0x50 engine 3 muxing info
32 */
33#define LP5523_MAX_LEDS 9
34
35/* Registers */
36#define LP5523_REG_ENABLE 0x00
37#define LP5523_REG_OP_MODE 0x01
38#define LP5523_REG_ENABLE_LEDS_MSB 0x04
39#define LP5523_REG_ENABLE_LEDS_LSB 0x05
40#define LP5523_REG_LED_CTRL_BASE 0x06
41#define LP5523_REG_LED_PWM_BASE 0x16
42#define LP5523_REG_LED_CURRENT_BASE 0x26
43#define LP5523_REG_CONFIG 0x36
44#define LP5523_REG_STATUS 0x3A
45#define LP5523_REG_RESET 0x3D
46#define LP5523_REG_LED_TEST_CTRL 0x41
47#define LP5523_REG_LED_TEST_ADC 0x42
48#define LP5523_REG_MASTER_FADER_BASE 0x48
49#define LP5523_REG_CH1_PROG_START 0x4C
50#define LP5523_REG_CH2_PROG_START 0x4D
51#define LP5523_REG_CH3_PROG_START 0x4E
52#define LP5523_REG_PROG_PAGE_SEL 0x4F
53#define LP5523_REG_PROG_MEM 0x50
54
55/* Bit description in registers */
56#define LP5523_ENABLE 0x40
57#define LP5523_AUTO_INC 0x40
58#define LP5523_PWR_SAVE 0x20
59#define LP5523_PWM_PWR_SAVE 0x04
60#define LP5523_CP_AUTO 0x18
61#define LP5523_AUTO_CLK 0x02
62
63#define LP5523_EN_LEDTEST 0x80
64#define LP5523_LEDTEST_DONE 0x80
65#define LP5523_RESET 0xFF
66#define LP5523_ADC_SHORTCIRC_LIM 80
67#define LP5523_EXT_CLK_USED 0x08
68#define LP5523_ENG_STATUS_MASK 0x07
69
70#define LP5523_FADER_MAPPING_MASK 0xC0
71#define LP5523_FADER_MAPPING_SHIFT 6
72
73/* Memory Page Selection */
74#define LP5523_PAGE_ENG1 0
75#define LP5523_PAGE_ENG2 1
76#define LP5523_PAGE_ENG3 2
77#define LP5523_PAGE_MUX1 3
78#define LP5523_PAGE_MUX2 4
79#define LP5523_PAGE_MUX3 5
80
81/* Program Memory Operations */
82#define LP5523_MODE_ENG1_M 0x30 /* Operation Mode Register */
83#define LP5523_MODE_ENG2_M 0x0C
84#define LP5523_MODE_ENG3_M 0x03
85#define LP5523_LOAD_ENG1 0x10
86#define LP5523_LOAD_ENG2 0x04
87#define LP5523_LOAD_ENG3 0x01
88
89#define LP5523_ENG1_IS_LOADING(mode) \
90 ((mode & LP5523_MODE_ENG1_M) == LP5523_LOAD_ENG1)
91#define LP5523_ENG2_IS_LOADING(mode) \
92 ((mode & LP5523_MODE_ENG2_M) == LP5523_LOAD_ENG2)
93#define LP5523_ENG3_IS_LOADING(mode) \
94 ((mode & LP5523_MODE_ENG3_M) == LP5523_LOAD_ENG3)
95
96#define LP5523_EXEC_ENG1_M 0x30 /* Enable Register */
97#define LP5523_EXEC_ENG2_M 0x0C
98#define LP5523_EXEC_ENG3_M 0x03
99#define LP5523_EXEC_M 0x3F
100#define LP5523_RUN_ENG1 0x20
101#define LP5523_RUN_ENG2 0x08
102#define LP5523_RUN_ENG3 0x02
103
104#define LED_ACTIVE(mux, led) (!!(mux & (0x0001 << led)))
105
106enum lp5523_chip_id {
107 LP5523,
108 LP55231,
109};
110
111static int lp5523_init_program_engine(struct lp55xx_chip *chip);
112
113static inline void lp5523_wait_opmode_done(void)
114{
115 usleep_range(1000, 2000);
116}
117
118static void lp5523_set_led_current(struct lp55xx_led *led, u8 led_current)
119{
120 led->led_current = led_current;
121 lp55xx_write(led->chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
122 led_current);
123}
124
125static int lp5523_post_init_device(struct lp55xx_chip *chip)
126{
127 int ret;
128
129 ret = lp55xx_write(chip, LP5523_REG_ENABLE, LP5523_ENABLE);
130 if (ret)
131 return ret;
132
133 /* Chip startup time is 500 us, 1 - 2 ms gives some margin */
134 usleep_range(1000, 2000);
135
136 ret = lp55xx_write(chip, LP5523_REG_CONFIG,
137 LP5523_AUTO_INC | LP5523_PWR_SAVE |
138 LP5523_CP_AUTO | LP5523_AUTO_CLK |
139 LP5523_PWM_PWR_SAVE);
140 if (ret)
141 return ret;
142
143 /* turn on all leds */
144 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
145 if (ret)
146 return ret;
147
148 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
149 if (ret)
150 return ret;
151
152 return lp5523_init_program_engine(chip);
153}
154
155static void lp5523_load_engine(struct lp55xx_chip *chip)
156{
157 enum lp55xx_engine_index idx = chip->engine_idx;
158 static const u8 mask[] = {
159 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
160 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
161 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
162 };
163
164 static const u8 val[] = {
165 [LP55XX_ENGINE_1] = LP5523_LOAD_ENG1,
166 [LP55XX_ENGINE_2] = LP5523_LOAD_ENG2,
167 [LP55XX_ENGINE_3] = LP5523_LOAD_ENG3,
168 };
169
170 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], val[idx]);
171
172 lp5523_wait_opmode_done();
173}
174
175static void lp5523_load_engine_and_select_page(struct lp55xx_chip *chip)
176{
177 enum lp55xx_engine_index idx = chip->engine_idx;
178 static const u8 page_sel[] = {
179 [LP55XX_ENGINE_1] = LP5523_PAGE_ENG1,
180 [LP55XX_ENGINE_2] = LP5523_PAGE_ENG2,
181 [LP55XX_ENGINE_3] = LP5523_PAGE_ENG3,
182 };
183
184 lp5523_load_engine(chip);
185
186 lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, page_sel[idx]);
187}
188
189static void lp5523_stop_all_engines(struct lp55xx_chip *chip)
190{
191 lp55xx_write(chip, LP5523_REG_OP_MODE, 0);
192 lp5523_wait_opmode_done();
193}
194
195static void lp5523_stop_engine(struct lp55xx_chip *chip)
196{
197 enum lp55xx_engine_index idx = chip->engine_idx;
198 static const u8 mask[] = {
199 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
200 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
201 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
202 };
203
204 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], 0);
205
206 lp5523_wait_opmode_done();
207}
208
209static void lp5523_turn_off_channels(struct lp55xx_chip *chip)
210{
211 int i;
212
213 for (i = 0; i < LP5523_MAX_LEDS; i++)
214 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0);
215}
216
217static void lp5523_run_engine(struct lp55xx_chip *chip, bool start)
218{
219 int ret;
220 u8 mode;
221 u8 exec;
222
223 /* stop engine */
224 if (!start) {
225 lp5523_stop_engine(chip);
226 lp5523_turn_off_channels(chip);
227 return;
228 }
229
230 /*
231 * To run the engine,
232 * operation mode and enable register should updated at the same time
233 */
234
235 ret = lp55xx_read(chip, LP5523_REG_OP_MODE, &mode);
236 if (ret)
237 return;
238
239 ret = lp55xx_read(chip, LP5523_REG_ENABLE, &exec);
240 if (ret)
241 return;
242
243 /* change operation mode to RUN only when each engine is loading */
244 if (LP5523_ENG1_IS_LOADING(mode)) {
245 mode = (mode & ~LP5523_MODE_ENG1_M) | LP5523_RUN_ENG1;
246 exec = (exec & ~LP5523_EXEC_ENG1_M) | LP5523_RUN_ENG1;
247 }
248
249 if (LP5523_ENG2_IS_LOADING(mode)) {
250 mode = (mode & ~LP5523_MODE_ENG2_M) | LP5523_RUN_ENG2;
251 exec = (exec & ~LP5523_EXEC_ENG2_M) | LP5523_RUN_ENG2;
252 }
253
254 if (LP5523_ENG3_IS_LOADING(mode)) {
255 mode = (mode & ~LP5523_MODE_ENG3_M) | LP5523_RUN_ENG3;
256 exec = (exec & ~LP5523_EXEC_ENG3_M) | LP5523_RUN_ENG3;
257 }
258
259 lp55xx_write(chip, LP5523_REG_OP_MODE, mode);
260 lp5523_wait_opmode_done();
261
262 lp55xx_update_bits(chip, LP5523_REG_ENABLE, LP5523_EXEC_M, exec);
263}
264
265static int lp5523_init_program_engine(struct lp55xx_chip *chip)
266{
267 int i;
268 int j;
269 int ret;
270 u8 status;
271 /* one pattern per engine setting LED MUX start and stop addresses */
272 static const u8 pattern[][LP5523_PROGRAM_LENGTH] = {
273 { 0x9c, 0x30, 0x9c, 0xb0, 0x9d, 0x80, 0xd8, 0x00, 0},
274 { 0x9c, 0x40, 0x9c, 0xc0, 0x9d, 0x80, 0xd8, 0x00, 0},
275 { 0x9c, 0x50, 0x9c, 0xd0, 0x9d, 0x80, 0xd8, 0x00, 0},
276 };
277
278 /* hardcode 32 bytes of memory for each engine from program memory */
279 ret = lp55xx_write(chip, LP5523_REG_CH1_PROG_START, 0x00);
280 if (ret)
281 return ret;
282
283 ret = lp55xx_write(chip, LP5523_REG_CH2_PROG_START, 0x10);
284 if (ret)
285 return ret;
286
287 ret = lp55xx_write(chip, LP5523_REG_CH3_PROG_START, 0x20);
288 if (ret)
289 return ret;
290
291 /* write LED MUX address space for each engine */
292 for (i = LP55XX_ENGINE_1; i <= LP55XX_ENGINE_3; i++) {
293 chip->engine_idx = i;
294 lp5523_load_engine_and_select_page(chip);
295
296 for (j = 0; j < LP5523_PROGRAM_LENGTH; j++) {
297 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + j,
298 pattern[i - 1][j]);
299 if (ret)
300 goto out;
301 }
302 }
303
304 lp5523_run_engine(chip, true);
305
306 /* Let the programs run for couple of ms and check the engine status */
307 usleep_range(3000, 6000);
308 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
309 if (ret)
310 goto out;
311 status &= LP5523_ENG_STATUS_MASK;
312
313 if (status != LP5523_ENG_STATUS_MASK) {
314 dev_err(&chip->cl->dev,
315 "could not configure LED engine, status = 0x%.2x\n",
316 status);
317 ret = -1;
318 }
319
320out:
321 lp5523_stop_all_engines(chip);
322 return ret;
323}
324
325static int lp5523_update_program_memory(struct lp55xx_chip *chip,
326 const u8 *data, size_t size)
327{
328 u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
329 unsigned int cmd;
330 char c[3];
331 int nrchars;
332 int ret;
333 int offset = 0;
334 int i = 0;
335
336 while ((offset < size - 1) && (i < LP5523_PROGRAM_LENGTH)) {
337 /* separate sscanfs because length is working only for %s */
338 ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
339 if (ret != 1)
340 goto err;
341
342 ret = sscanf(c, "%2x", &cmd);
343 if (ret != 1)
344 goto err;
345
346 pattern[i] = (u8)cmd;
347 offset += nrchars;
348 i++;
349 }
350
351 /* Each instruction is 16bit long. Check that length is even */
352 if (i % 2)
353 goto err;
354
355 for (i = 0; i < LP5523_PROGRAM_LENGTH; i++) {
356 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + i, pattern[i]);
357 if (ret)
358 return -EINVAL;
359 }
360
361 return size;
362
363err:
364 dev_err(&chip->cl->dev, "wrong pattern format\n");
365 return -EINVAL;
366}
367
368static void lp5523_firmware_loaded(struct lp55xx_chip *chip)
369{
370 const struct firmware *fw = chip->fw;
371
372 if (fw->size > LP5523_PROGRAM_LENGTH) {
373 dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
374 fw->size);
375 return;
376 }
377
378 /*
379 * Program memory sequence
380 * 1) set engine mode to "LOAD"
381 * 2) write firmware data into program memory
382 */
383
384 lp5523_load_engine_and_select_page(chip);
385 lp5523_update_program_memory(chip, fw->data, fw->size);
386}
387
388static ssize_t show_engine_mode(struct device *dev,
389 struct device_attribute *attr,
390 char *buf, int nr)
391{
392 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
393 struct lp55xx_chip *chip = led->chip;
394 enum lp55xx_engine_mode mode = chip->engines[nr - 1].mode;
395
396 switch (mode) {
397 case LP55XX_ENGINE_RUN:
398 return sprintf(buf, "run\n");
399 case LP55XX_ENGINE_LOAD:
400 return sprintf(buf, "load\n");
401 case LP55XX_ENGINE_DISABLED:
402 default:
403 return sprintf(buf, "disabled\n");
404 }
405}
406show_mode(1)
407show_mode(2)
408show_mode(3)
409
410static ssize_t store_engine_mode(struct device *dev,
411 struct device_attribute *attr,
412 const char *buf, size_t len, int nr)
413{
414 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
415 struct lp55xx_chip *chip = led->chip;
416 struct lp55xx_engine *engine = &chip->engines[nr - 1];
417
418 mutex_lock(&chip->lock);
419
420 chip->engine_idx = nr;
421
422 if (!strncmp(buf, "run", 3)) {
423 lp5523_run_engine(chip, true);
424 engine->mode = LP55XX_ENGINE_RUN;
425 } else if (!strncmp(buf, "load", 4)) {
426 lp5523_stop_engine(chip);
427 lp5523_load_engine(chip);
428 engine->mode = LP55XX_ENGINE_LOAD;
429 } else if (!strncmp(buf, "disabled", 8)) {
430 lp5523_stop_engine(chip);
431 engine->mode = LP55XX_ENGINE_DISABLED;
432 }
433
434 mutex_unlock(&chip->lock);
435
436 return len;
437}
438store_mode(1)
439store_mode(2)
440store_mode(3)
441
442static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
443{
444 u16 tmp_mux = 0;
445 int i;
446
447 len = min_t(int, len, LP5523_MAX_LEDS);
448
449 for (i = 0; i < len; i++) {
450 switch (buf[i]) {
451 case '1':
452 tmp_mux |= (1 << i);
453 break;
454 case '0':
455 break;
456 case '\n':
457 i = len;
458 break;
459 default:
460 return -1;
461 }
462 }
463 *mux = tmp_mux;
464
465 return 0;
466}
467
468static void lp5523_mux_to_array(u16 led_mux, char *array)
469{
470 int i, pos = 0;
471
472 for (i = 0; i < LP5523_MAX_LEDS; i++)
473 pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
474
475 array[pos] = '\0';
476}
477
478static ssize_t show_engine_leds(struct device *dev,
479 struct device_attribute *attr,
480 char *buf, int nr)
481{
482 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
483 struct lp55xx_chip *chip = led->chip;
484 char mux[LP5523_MAX_LEDS + 1];
485
486 lp5523_mux_to_array(chip->engines[nr - 1].led_mux, mux);
487
488 return sprintf(buf, "%s\n", mux);
489}
490show_leds(1)
491show_leds(2)
492show_leds(3)
493
494static int lp5523_load_mux(struct lp55xx_chip *chip, u16 mux, int nr)
495{
496 struct lp55xx_engine *engine = &chip->engines[nr - 1];
497 int ret;
498 static const u8 mux_page[] = {
499 [LP55XX_ENGINE_1] = LP5523_PAGE_MUX1,
500 [LP55XX_ENGINE_2] = LP5523_PAGE_MUX2,
501 [LP55XX_ENGINE_3] = LP5523_PAGE_MUX3,
502 };
503
504 lp5523_load_engine(chip);
505
506 ret = lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, mux_page[nr]);
507 if (ret)
508 return ret;
509
510 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM, (u8)(mux >> 8));
511 if (ret)
512 return ret;
513
514 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + 1, (u8)(mux));
515 if (ret)
516 return ret;
517
518 engine->led_mux = mux;
519 return 0;
520}
521
522static ssize_t store_engine_leds(struct device *dev,
523 struct device_attribute *attr,
524 const char *buf, size_t len, int nr)
525{
526 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
527 struct lp55xx_chip *chip = led->chip;
528 struct lp55xx_engine *engine = &chip->engines[nr - 1];
529 u16 mux = 0;
530 ssize_t ret;
531
532 if (lp5523_mux_parse(buf, &mux, len))
533 return -EINVAL;
534
535 mutex_lock(&chip->lock);
536
537 chip->engine_idx = nr;
538 ret = -EINVAL;
539
540 if (engine->mode != LP55XX_ENGINE_LOAD)
541 goto leave;
542
543 if (lp5523_load_mux(chip, mux, nr))
544 goto leave;
545
546 ret = len;
547leave:
548 mutex_unlock(&chip->lock);
549 return ret;
550}
551store_leds(1)
552store_leds(2)
553store_leds(3)
554
555static ssize_t store_engine_load(struct device *dev,
556 struct device_attribute *attr,
557 const char *buf, size_t len, int nr)
558{
559 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
560 struct lp55xx_chip *chip = led->chip;
561 int ret;
562
563 mutex_lock(&chip->lock);
564
565 chip->engine_idx = nr;
566 lp5523_load_engine_and_select_page(chip);
567 ret = lp5523_update_program_memory(chip, buf, len);
568
569 mutex_unlock(&chip->lock);
570
571 return ret;
572}
573store_load(1)
574store_load(2)
575store_load(3)
576
577static ssize_t lp5523_selftest(struct device *dev,
578 struct device_attribute *attr,
579 char *buf)
580{
581 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
582 struct lp55xx_chip *chip = led->chip;
583 struct lp55xx_platform_data *pdata = chip->pdata;
584 int ret, pos = 0;
585 u8 status, adc, vdd, i;
586
587 mutex_lock(&chip->lock);
588
589 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
590 if (ret < 0)
591 goto fail;
592
593 /* Check that ext clock is really in use if requested */
594 if (pdata->clock_mode == LP55XX_CLOCK_EXT) {
595 if ((status & LP5523_EXT_CLK_USED) == 0)
596 goto fail;
597 }
598
599 /* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
600 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL, LP5523_EN_LEDTEST | 16);
601 usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
602 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
603 if (ret < 0)
604 goto fail;
605
606 if (!(status & LP5523_LEDTEST_DONE))
607 usleep_range(3000, 6000); /* Was not ready. Wait little bit */
608
609 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &vdd);
610 if (ret < 0)
611 goto fail;
612
613 vdd--; /* There may be some fluctuation in measurement */
614
615 for (i = 0; i < pdata->num_channels; i++) {
616 /* Skip disabled channels */
617 if (pdata->led_config[i].led_current == 0)
618 continue;
619
620 /* Set default current */
621 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
622 pdata->led_config[i].led_current);
623
624 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
625 0xff);
626 /* let current stabilize 2 - 4ms before measurements start */
627 usleep_range(2000, 4000);
628 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL,
629 LP5523_EN_LEDTEST | led->chan_nr);
630 /* ADC conversion time is 2.7 ms typically */
631 usleep_range(3000, 6000);
632 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
633 if (ret < 0)
634 goto fail;
635
636 if (!(status & LP5523_LEDTEST_DONE))
637 usleep_range(3000, 6000); /* Was not ready. Wait. */
638
639 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &adc);
640 if (ret < 0)
641 goto fail;
642
643 if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
644 pos += sprintf(buf + pos, "LED %d FAIL\n",
645 led->chan_nr);
646
647 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
648 0x00);
649
650 /* Restore current */
651 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
652 led->led_current);
653 led++;
654 }
655 if (pos == 0)
656 pos = sprintf(buf, "OK\n");
657 goto release_lock;
658fail:
659 pos = sprintf(buf, "FAIL\n");
660
661release_lock:
662 mutex_unlock(&chip->lock);
663
664 return pos;
665}
666
667#define show_fader(nr) \
668static ssize_t show_master_fader##nr(struct device *dev, \
669 struct device_attribute *attr, \
670 char *buf) \
671{ \
672 return show_master_fader(dev, attr, buf, nr); \
673}
674
675#define store_fader(nr) \
676static ssize_t store_master_fader##nr(struct device *dev, \
677 struct device_attribute *attr, \
678 const char *buf, size_t len) \
679{ \
680 return store_master_fader(dev, attr, buf, len, nr); \
681}
682
683static ssize_t show_master_fader(struct device *dev,
684 struct device_attribute *attr,
685 char *buf, int nr)
686{
687 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
688 struct lp55xx_chip *chip = led->chip;
689 int ret;
690 u8 val;
691
692 mutex_lock(&chip->lock);
693 ret = lp55xx_read(chip, LP5523_REG_MASTER_FADER_BASE + nr - 1, &val);
694 mutex_unlock(&chip->lock);
695
696 if (ret == 0)
697 ret = sprintf(buf, "%u\n", val);
698
699 return ret;
700}
701show_fader(1)
702show_fader(2)
703show_fader(3)
704
705static ssize_t store_master_fader(struct device *dev,
706 struct device_attribute *attr,
707 const char *buf, size_t len, int nr)
708{
709 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
710 struct lp55xx_chip *chip = led->chip;
711 int ret;
712 unsigned long val;
713
714 if (kstrtoul(buf, 0, &val))
715 return -EINVAL;
716
717 if (val > 0xff)
718 return -EINVAL;
719
720 mutex_lock(&chip->lock);
721 ret = lp55xx_write(chip, LP5523_REG_MASTER_FADER_BASE + nr - 1,
722 (u8)val);
723 mutex_unlock(&chip->lock);
724
725 if (ret == 0)
726 ret = len;
727
728 return ret;
729}
730store_fader(1)
731store_fader(2)
732store_fader(3)
733
734static ssize_t show_master_fader_leds(struct device *dev,
735 struct device_attribute *attr,
736 char *buf)
737{
738 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
739 struct lp55xx_chip *chip = led->chip;
740 int i, ret, pos = 0;
741 u8 val;
742
743 mutex_lock(&chip->lock);
744
745 for (i = 0; i < LP5523_MAX_LEDS; i++) {
746 ret = lp55xx_read(chip, LP5523_REG_LED_CTRL_BASE + i, &val);
747 if (ret)
748 goto leave;
749
750 val = (val & LP5523_FADER_MAPPING_MASK)
751 >> LP5523_FADER_MAPPING_SHIFT;
752 if (val > 3) {
753 ret = -EINVAL;
754 goto leave;
755 }
756 buf[pos++] = val + '0';
757 }
758 buf[pos++] = '\n';
759 ret = pos;
760leave:
761 mutex_unlock(&chip->lock);
762 return ret;
763}
764
765static ssize_t store_master_fader_leds(struct device *dev,
766 struct device_attribute *attr,
767 const char *buf, size_t len)
768{
769 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
770 struct lp55xx_chip *chip = led->chip;
771 int i, n, ret;
772 u8 val;
773
774 n = min_t(int, len, LP5523_MAX_LEDS);
775
776 mutex_lock(&chip->lock);
777
778 for (i = 0; i < n; i++) {
779 if (buf[i] >= '0' && buf[i] <= '3') {
780 val = (buf[i] - '0') << LP5523_FADER_MAPPING_SHIFT;
781 ret = lp55xx_update_bits(chip,
782 LP5523_REG_LED_CTRL_BASE + i,
783 LP5523_FADER_MAPPING_MASK,
784 val);
785 if (ret)
786 goto leave;
787 } else {
788 ret = -EINVAL;
789 goto leave;
790 }
791 }
792 ret = len;
793leave:
794 mutex_unlock(&chip->lock);
795 return ret;
796}
797
798static int lp5523_multicolor_brightness(struct lp55xx_led *led)
799{
800 struct lp55xx_chip *chip = led->chip;
801 int ret;
802 int i;
803
804 mutex_lock(&chip->lock);
805 for (i = 0; i < led->mc_cdev.num_colors; i++) {
806 ret = lp55xx_write(chip,
807 LP5523_REG_LED_PWM_BASE +
808 led->mc_cdev.subled_info[i].channel,
809 led->mc_cdev.subled_info[i].brightness);
810 if (ret)
811 break;
812 }
813 mutex_unlock(&chip->lock);
814 return ret;
815}
816
817static int lp5523_led_brightness(struct lp55xx_led *led)
818{
819 struct lp55xx_chip *chip = led->chip;
820 int ret;
821
822 mutex_lock(&chip->lock);
823 ret = lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
824 led->brightness);
825 mutex_unlock(&chip->lock);
826 return ret;
827}
828
829static LP55XX_DEV_ATTR_RW(engine1_mode, show_engine1_mode, store_engine1_mode);
830static LP55XX_DEV_ATTR_RW(engine2_mode, show_engine2_mode, store_engine2_mode);
831static LP55XX_DEV_ATTR_RW(engine3_mode, show_engine3_mode, store_engine3_mode);
832static LP55XX_DEV_ATTR_RW(engine1_leds, show_engine1_leds, store_engine1_leds);
833static LP55XX_DEV_ATTR_RW(engine2_leds, show_engine2_leds, store_engine2_leds);
834static LP55XX_DEV_ATTR_RW(engine3_leds, show_engine3_leds, store_engine3_leds);
835static LP55XX_DEV_ATTR_WO(engine1_load, store_engine1_load);
836static LP55XX_DEV_ATTR_WO(engine2_load, store_engine2_load);
837static LP55XX_DEV_ATTR_WO(engine3_load, store_engine3_load);
838static LP55XX_DEV_ATTR_RO(selftest, lp5523_selftest);
839static LP55XX_DEV_ATTR_RW(master_fader1, show_master_fader1,
840 store_master_fader1);
841static LP55XX_DEV_ATTR_RW(master_fader2, show_master_fader2,
842 store_master_fader2);
843static LP55XX_DEV_ATTR_RW(master_fader3, show_master_fader3,
844 store_master_fader3);
845static LP55XX_DEV_ATTR_RW(master_fader_leds, show_master_fader_leds,
846 store_master_fader_leds);
847
848static struct attribute *lp5523_attributes[] = {
849 &dev_attr_engine1_mode.attr,
850 &dev_attr_engine2_mode.attr,
851 &dev_attr_engine3_mode.attr,
852 &dev_attr_engine1_load.attr,
853 &dev_attr_engine2_load.attr,
854 &dev_attr_engine3_load.attr,
855 &dev_attr_engine1_leds.attr,
856 &dev_attr_engine2_leds.attr,
857 &dev_attr_engine3_leds.attr,
858 &dev_attr_selftest.attr,
859 &dev_attr_master_fader1.attr,
860 &dev_attr_master_fader2.attr,
861 &dev_attr_master_fader3.attr,
862 &dev_attr_master_fader_leds.attr,
863 NULL,
864};
865
866static const struct attribute_group lp5523_group = {
867 .attrs = lp5523_attributes,
868};
869
870/* Chip specific configurations */
871static struct lp55xx_device_config lp5523_cfg = {
872 .reset = {
873 .addr = LP5523_REG_RESET,
874 .val = LP5523_RESET,
875 },
876 .enable = {
877 .addr = LP5523_REG_ENABLE,
878 .val = LP5523_ENABLE,
879 },
880 .max_channel = LP5523_MAX_LEDS,
881 .post_init_device = lp5523_post_init_device,
882 .brightness_fn = lp5523_led_brightness,
883 .multicolor_brightness_fn = lp5523_multicolor_brightness,
884 .set_led_current = lp5523_set_led_current,
885 .firmware_cb = lp5523_firmware_loaded,
886 .run_engine = lp5523_run_engine,
887 .dev_attr_group = &lp5523_group,
888};
889
890static int lp5523_probe(struct i2c_client *client,
891 const struct i2c_device_id *id)
892{
893 int ret;
894 struct lp55xx_chip *chip;
895 struct lp55xx_led *led;
896 struct lp55xx_platform_data *pdata = dev_get_platdata(&client->dev);
897 struct device_node *np = dev_of_node(&client->dev);
898
899 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
900 if (!chip)
901 return -ENOMEM;
902
903 chip->cfg = &lp5523_cfg;
904
905 if (!pdata) {
906 if (np) {
907 pdata = lp55xx_of_populate_pdata(&client->dev, np,
908 chip);
909 if (IS_ERR(pdata))
910 return PTR_ERR(pdata);
911 } else {
912 dev_err(&client->dev, "no platform data\n");
913 return -EINVAL;
914 }
915 }
916
917 led = devm_kcalloc(&client->dev,
918 pdata->num_channels, sizeof(*led), GFP_KERNEL);
919 if (!led)
920 return -ENOMEM;
921
922 chip->cl = client;
923 chip->pdata = pdata;
924
925 mutex_init(&chip->lock);
926
927 i2c_set_clientdata(client, led);
928
929 ret = lp55xx_init_device(chip);
930 if (ret)
931 goto err_init;
932
933 dev_info(&client->dev, "%s Programmable led chip found\n", id->name);
934
935 ret = lp55xx_register_leds(led, chip);
936 if (ret)
937 goto err_out;
938
939 ret = lp55xx_register_sysfs(chip);
940 if (ret) {
941 dev_err(&client->dev, "registering sysfs failed\n");
942 goto err_out;
943 }
944
945 return 0;
946
947err_out:
948 lp55xx_deinit_device(chip);
949err_init:
950 return ret;
951}
952
953static void lp5523_remove(struct i2c_client *client)
954{
955 struct lp55xx_led *led = i2c_get_clientdata(client);
956 struct lp55xx_chip *chip = led->chip;
957
958 lp5523_stop_all_engines(chip);
959 lp55xx_unregister_sysfs(chip);
960 lp55xx_deinit_device(chip);
961}
962
963static const struct i2c_device_id lp5523_id[] = {
964 { "lp5523", LP5523 },
965 { "lp55231", LP55231 },
966 { }
967};
968
969MODULE_DEVICE_TABLE(i2c, lp5523_id);
970
971#ifdef CONFIG_OF
972static const struct of_device_id of_lp5523_leds_match[] = {
973 { .compatible = "national,lp5523", },
974 { .compatible = "ti,lp55231", },
975 {},
976};
977
978MODULE_DEVICE_TABLE(of, of_lp5523_leds_match);
979#endif
980
981static struct i2c_driver lp5523_driver = {
982 .driver = {
983 .name = "lp5523x",
984 .of_match_table = of_match_ptr(of_lp5523_leds_match),
985 },
986 .probe = lp5523_probe,
987 .remove = lp5523_remove,
988 .id_table = lp5523_id,
989};
990
991module_i2c_driver(lp5523_driver);
992
993MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
994MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
995MODULE_DESCRIPTION("LP5523 LED engine");
996MODULE_LICENSE("GPL");
1/*
2 * lp5523.c - LP5523 LED Driver
3 *
4 * Copyright (C) 2010 Nokia Corporation
5 * Copyright (C) 2012 Texas Instruments
6 *
7 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
8 * Milo(Woogyom) Kim <milo.kim@ti.com>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * version 2 as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA
23 */
24
25#include <linux/delay.h>
26#include <linux/firmware.h>
27#include <linux/i2c.h>
28#include <linux/leds.h>
29#include <linux/module.h>
30#include <linux/mutex.h>
31#include <linux/of.h>
32#include <linux/platform_data/leds-lp55xx.h>
33#include <linux/slab.h>
34
35#include "leds-lp55xx-common.h"
36
37#define LP5523_PROGRAM_LENGTH 32 /* bytes */
38/* Memory is used like this:
39 0x00 engine 1 program
40 0x10 engine 2 program
41 0x20 engine 3 program
42 0x30 engine 1 muxing info
43 0x40 engine 2 muxing info
44 0x50 engine 3 muxing info
45*/
46#define LP5523_MAX_LEDS 9
47
48/* Registers */
49#define LP5523_REG_ENABLE 0x00
50#define LP5523_REG_OP_MODE 0x01
51#define LP5523_REG_ENABLE_LEDS_MSB 0x04
52#define LP5523_REG_ENABLE_LEDS_LSB 0x05
53#define LP5523_REG_LED_PWM_BASE 0x16
54#define LP5523_REG_LED_CURRENT_BASE 0x26
55#define LP5523_REG_CONFIG 0x36
56#define LP5523_REG_STATUS 0x3A
57#define LP5523_REG_RESET 0x3D
58#define LP5523_REG_LED_TEST_CTRL 0x41
59#define LP5523_REG_LED_TEST_ADC 0x42
60#define LP5523_REG_CH1_PROG_START 0x4C
61#define LP5523_REG_CH2_PROG_START 0x4D
62#define LP5523_REG_CH3_PROG_START 0x4E
63#define LP5523_REG_PROG_PAGE_SEL 0x4F
64#define LP5523_REG_PROG_MEM 0x50
65
66/* Bit description in registers */
67#define LP5523_ENABLE 0x40
68#define LP5523_AUTO_INC 0x40
69#define LP5523_PWR_SAVE 0x20
70#define LP5523_PWM_PWR_SAVE 0x04
71#define LP5523_CP_AUTO 0x18
72#define LP5523_AUTO_CLK 0x02
73
74#define LP5523_EN_LEDTEST 0x80
75#define LP5523_LEDTEST_DONE 0x80
76#define LP5523_RESET 0xFF
77#define LP5523_ADC_SHORTCIRC_LIM 80
78#define LP5523_EXT_CLK_USED 0x08
79#define LP5523_ENG_STATUS_MASK 0x07
80
81/* Memory Page Selection */
82#define LP5523_PAGE_ENG1 0
83#define LP5523_PAGE_ENG2 1
84#define LP5523_PAGE_ENG3 2
85#define LP5523_PAGE_MUX1 3
86#define LP5523_PAGE_MUX2 4
87#define LP5523_PAGE_MUX3 5
88
89/* Program Memory Operations */
90#define LP5523_MODE_ENG1_M 0x30 /* Operation Mode Register */
91#define LP5523_MODE_ENG2_M 0x0C
92#define LP5523_MODE_ENG3_M 0x03
93#define LP5523_LOAD_ENG1 0x10
94#define LP5523_LOAD_ENG2 0x04
95#define LP5523_LOAD_ENG3 0x01
96
97#define LP5523_ENG1_IS_LOADING(mode) \
98 ((mode & LP5523_MODE_ENG1_M) == LP5523_LOAD_ENG1)
99#define LP5523_ENG2_IS_LOADING(mode) \
100 ((mode & LP5523_MODE_ENG2_M) == LP5523_LOAD_ENG2)
101#define LP5523_ENG3_IS_LOADING(mode) \
102 ((mode & LP5523_MODE_ENG3_M) == LP5523_LOAD_ENG3)
103
104#define LP5523_EXEC_ENG1_M 0x30 /* Enable Register */
105#define LP5523_EXEC_ENG2_M 0x0C
106#define LP5523_EXEC_ENG3_M 0x03
107#define LP5523_EXEC_M 0x3F
108#define LP5523_RUN_ENG1 0x20
109#define LP5523_RUN_ENG2 0x08
110#define LP5523_RUN_ENG3 0x02
111
112#define LED_ACTIVE(mux, led) (!!(mux & (0x0001 << led)))
113
114enum lp5523_chip_id {
115 LP5523,
116 LP55231,
117};
118
119static int lp5523_init_program_engine(struct lp55xx_chip *chip);
120
121static inline void lp5523_wait_opmode_done(void)
122{
123 usleep_range(1000, 2000);
124}
125
126static void lp5523_set_led_current(struct lp55xx_led *led, u8 led_current)
127{
128 led->led_current = led_current;
129 lp55xx_write(led->chip, LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
130 led_current);
131}
132
133static int lp5523_post_init_device(struct lp55xx_chip *chip)
134{
135 int ret;
136
137 ret = lp55xx_write(chip, LP5523_REG_ENABLE, LP5523_ENABLE);
138 if (ret)
139 return ret;
140
141 /* Chip startup time is 500 us, 1 - 2 ms gives some margin */
142 usleep_range(1000, 2000);
143
144 ret = lp55xx_write(chip, LP5523_REG_CONFIG,
145 LP5523_AUTO_INC | LP5523_PWR_SAVE |
146 LP5523_CP_AUTO | LP5523_AUTO_CLK |
147 LP5523_PWM_PWR_SAVE);
148 if (ret)
149 return ret;
150
151 /* turn on all leds */
152 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
153 if (ret)
154 return ret;
155
156 ret = lp55xx_write(chip, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
157 if (ret)
158 return ret;
159
160 return lp5523_init_program_engine(chip);
161}
162
163static void lp5523_load_engine(struct lp55xx_chip *chip)
164{
165 enum lp55xx_engine_index idx = chip->engine_idx;
166 u8 mask[] = {
167 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
168 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
169 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
170 };
171
172 u8 val[] = {
173 [LP55XX_ENGINE_1] = LP5523_LOAD_ENG1,
174 [LP55XX_ENGINE_2] = LP5523_LOAD_ENG2,
175 [LP55XX_ENGINE_3] = LP5523_LOAD_ENG3,
176 };
177
178 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], val[idx]);
179
180 lp5523_wait_opmode_done();
181}
182
183static void lp5523_load_engine_and_select_page(struct lp55xx_chip *chip)
184{
185 enum lp55xx_engine_index idx = chip->engine_idx;
186 u8 page_sel[] = {
187 [LP55XX_ENGINE_1] = LP5523_PAGE_ENG1,
188 [LP55XX_ENGINE_2] = LP5523_PAGE_ENG2,
189 [LP55XX_ENGINE_3] = LP5523_PAGE_ENG3,
190 };
191
192 lp5523_load_engine(chip);
193
194 lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, page_sel[idx]);
195}
196
197static void lp5523_stop_all_engines(struct lp55xx_chip *chip)
198{
199 lp55xx_write(chip, LP5523_REG_OP_MODE, 0);
200 lp5523_wait_opmode_done();
201}
202
203static void lp5523_stop_engine(struct lp55xx_chip *chip)
204{
205 enum lp55xx_engine_index idx = chip->engine_idx;
206 u8 mask[] = {
207 [LP55XX_ENGINE_1] = LP5523_MODE_ENG1_M,
208 [LP55XX_ENGINE_2] = LP5523_MODE_ENG2_M,
209 [LP55XX_ENGINE_3] = LP5523_MODE_ENG3_M,
210 };
211
212 lp55xx_update_bits(chip, LP5523_REG_OP_MODE, mask[idx], 0);
213
214 lp5523_wait_opmode_done();
215}
216
217static void lp5523_turn_off_channels(struct lp55xx_chip *chip)
218{
219 int i;
220
221 for (i = 0; i < LP5523_MAX_LEDS; i++)
222 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0);
223}
224
225static void lp5523_run_engine(struct lp55xx_chip *chip, bool start)
226{
227 int ret;
228 u8 mode;
229 u8 exec;
230
231 /* stop engine */
232 if (!start) {
233 lp5523_stop_engine(chip);
234 lp5523_turn_off_channels(chip);
235 return;
236 }
237
238 /*
239 * To run the engine,
240 * operation mode and enable register should updated at the same time
241 */
242
243 ret = lp55xx_read(chip, LP5523_REG_OP_MODE, &mode);
244 if (ret)
245 return;
246
247 ret = lp55xx_read(chip, LP5523_REG_ENABLE, &exec);
248 if (ret)
249 return;
250
251 /* change operation mode to RUN only when each engine is loading */
252 if (LP5523_ENG1_IS_LOADING(mode)) {
253 mode = (mode & ~LP5523_MODE_ENG1_M) | LP5523_RUN_ENG1;
254 exec = (exec & ~LP5523_EXEC_ENG1_M) | LP5523_RUN_ENG1;
255 }
256
257 if (LP5523_ENG2_IS_LOADING(mode)) {
258 mode = (mode & ~LP5523_MODE_ENG2_M) | LP5523_RUN_ENG2;
259 exec = (exec & ~LP5523_EXEC_ENG2_M) | LP5523_RUN_ENG2;
260 }
261
262 if (LP5523_ENG3_IS_LOADING(mode)) {
263 mode = (mode & ~LP5523_MODE_ENG3_M) | LP5523_RUN_ENG3;
264 exec = (exec & ~LP5523_EXEC_ENG3_M) | LP5523_RUN_ENG3;
265 }
266
267 lp55xx_write(chip, LP5523_REG_OP_MODE, mode);
268 lp5523_wait_opmode_done();
269
270 lp55xx_update_bits(chip, LP5523_REG_ENABLE, LP5523_EXEC_M, exec);
271}
272
273static int lp5523_init_program_engine(struct lp55xx_chip *chip)
274{
275 int i;
276 int j;
277 int ret;
278 u8 status;
279 /* one pattern per engine setting LED MUX start and stop addresses */
280 static const u8 pattern[][LP5523_PROGRAM_LENGTH] = {
281 { 0x9c, 0x30, 0x9c, 0xb0, 0x9d, 0x80, 0xd8, 0x00, 0},
282 { 0x9c, 0x40, 0x9c, 0xc0, 0x9d, 0x80, 0xd8, 0x00, 0},
283 { 0x9c, 0x50, 0x9c, 0xd0, 0x9d, 0x80, 0xd8, 0x00, 0},
284 };
285
286 /* hardcode 32 bytes of memory for each engine from program memory */
287 ret = lp55xx_write(chip, LP5523_REG_CH1_PROG_START, 0x00);
288 if (ret)
289 return ret;
290
291 ret = lp55xx_write(chip, LP5523_REG_CH2_PROG_START, 0x10);
292 if (ret)
293 return ret;
294
295 ret = lp55xx_write(chip, LP5523_REG_CH3_PROG_START, 0x20);
296 if (ret)
297 return ret;
298
299 /* write LED MUX address space for each engine */
300 for (i = LP55XX_ENGINE_1; i <= LP55XX_ENGINE_3; i++) {
301 chip->engine_idx = i;
302 lp5523_load_engine_and_select_page(chip);
303
304 for (j = 0; j < LP5523_PROGRAM_LENGTH; j++) {
305 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + j,
306 pattern[i - 1][j]);
307 if (ret)
308 goto out;
309 }
310 }
311
312 lp5523_run_engine(chip, true);
313
314 /* Let the programs run for couple of ms and check the engine status */
315 usleep_range(3000, 6000);
316 lp55xx_read(chip, LP5523_REG_STATUS, &status);
317 status &= LP5523_ENG_STATUS_MASK;
318
319 if (status != LP5523_ENG_STATUS_MASK) {
320 dev_err(&chip->cl->dev,
321 "cound not configure LED engine, status = 0x%.2x\n",
322 status);
323 ret = -1;
324 }
325
326out:
327 lp5523_stop_all_engines(chip);
328 return ret;
329}
330
331static int lp5523_update_program_memory(struct lp55xx_chip *chip,
332 const u8 *data, size_t size)
333{
334 u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
335 unsigned cmd;
336 char c[3];
337 int nrchars;
338 int ret;
339 int offset = 0;
340 int i = 0;
341
342 while ((offset < size - 1) && (i < LP5523_PROGRAM_LENGTH)) {
343 /* separate sscanfs because length is working only for %s */
344 ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
345 if (ret != 1)
346 goto err;
347
348 ret = sscanf(c, "%2x", &cmd);
349 if (ret != 1)
350 goto err;
351
352 pattern[i] = (u8)cmd;
353 offset += nrchars;
354 i++;
355 }
356
357 /* Each instruction is 16bit long. Check that length is even */
358 if (i % 2)
359 goto err;
360
361 for (i = 0; i < LP5523_PROGRAM_LENGTH; i++) {
362 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + i, pattern[i]);
363 if (ret)
364 return -EINVAL;
365 }
366
367 return size;
368
369err:
370 dev_err(&chip->cl->dev, "wrong pattern format\n");
371 return -EINVAL;
372}
373
374static void lp5523_firmware_loaded(struct lp55xx_chip *chip)
375{
376 const struct firmware *fw = chip->fw;
377
378 if (fw->size > LP5523_PROGRAM_LENGTH) {
379 dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
380 fw->size);
381 return;
382 }
383
384 /*
385 * Program momery sequence
386 * 1) set engine mode to "LOAD"
387 * 2) write firmware data into program memory
388 */
389
390 lp5523_load_engine_and_select_page(chip);
391 lp5523_update_program_memory(chip, fw->data, fw->size);
392}
393
394static ssize_t show_engine_mode(struct device *dev,
395 struct device_attribute *attr,
396 char *buf, int nr)
397{
398 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
399 struct lp55xx_chip *chip = led->chip;
400 enum lp55xx_engine_mode mode = chip->engines[nr - 1].mode;
401
402 switch (mode) {
403 case LP55XX_ENGINE_RUN:
404 return sprintf(buf, "run\n");
405 case LP55XX_ENGINE_LOAD:
406 return sprintf(buf, "load\n");
407 case LP55XX_ENGINE_DISABLED:
408 default:
409 return sprintf(buf, "disabled\n");
410 }
411}
412show_mode(1)
413show_mode(2)
414show_mode(3)
415
416static ssize_t store_engine_mode(struct device *dev,
417 struct device_attribute *attr,
418 const char *buf, size_t len, int nr)
419{
420 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
421 struct lp55xx_chip *chip = led->chip;
422 struct lp55xx_engine *engine = &chip->engines[nr - 1];
423
424 mutex_lock(&chip->lock);
425
426 chip->engine_idx = nr;
427
428 if (!strncmp(buf, "run", 3)) {
429 lp5523_run_engine(chip, true);
430 engine->mode = LP55XX_ENGINE_RUN;
431 } else if (!strncmp(buf, "load", 4)) {
432 lp5523_stop_engine(chip);
433 lp5523_load_engine(chip);
434 engine->mode = LP55XX_ENGINE_LOAD;
435 } else if (!strncmp(buf, "disabled", 8)) {
436 lp5523_stop_engine(chip);
437 engine->mode = LP55XX_ENGINE_DISABLED;
438 }
439
440 mutex_unlock(&chip->lock);
441
442 return len;
443}
444store_mode(1)
445store_mode(2)
446store_mode(3)
447
448static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
449{
450 u16 tmp_mux = 0;
451 int i;
452
453 len = min_t(int, len, LP5523_MAX_LEDS);
454
455 for (i = 0; i < len; i++) {
456 switch (buf[i]) {
457 case '1':
458 tmp_mux |= (1 << i);
459 break;
460 case '0':
461 break;
462 case '\n':
463 i = len;
464 break;
465 default:
466 return -1;
467 }
468 }
469 *mux = tmp_mux;
470
471 return 0;
472}
473
474static void lp5523_mux_to_array(u16 led_mux, char *array)
475{
476 int i, pos = 0;
477 for (i = 0; i < LP5523_MAX_LEDS; i++)
478 pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
479
480 array[pos] = '\0';
481}
482
483static ssize_t show_engine_leds(struct device *dev,
484 struct device_attribute *attr,
485 char *buf, int nr)
486{
487 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
488 struct lp55xx_chip *chip = led->chip;
489 char mux[LP5523_MAX_LEDS + 1];
490
491 lp5523_mux_to_array(chip->engines[nr - 1].led_mux, mux);
492
493 return sprintf(buf, "%s\n", mux);
494}
495show_leds(1)
496show_leds(2)
497show_leds(3)
498
499static int lp5523_load_mux(struct lp55xx_chip *chip, u16 mux, int nr)
500{
501 struct lp55xx_engine *engine = &chip->engines[nr - 1];
502 int ret;
503 u8 mux_page[] = {
504 [LP55XX_ENGINE_1] = LP5523_PAGE_MUX1,
505 [LP55XX_ENGINE_2] = LP5523_PAGE_MUX2,
506 [LP55XX_ENGINE_3] = LP5523_PAGE_MUX3,
507 };
508
509 lp5523_load_engine(chip);
510
511 ret = lp55xx_write(chip, LP5523_REG_PROG_PAGE_SEL, mux_page[nr]);
512 if (ret)
513 return ret;
514
515 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM , (u8)(mux >> 8));
516 if (ret)
517 return ret;
518
519 ret = lp55xx_write(chip, LP5523_REG_PROG_MEM + 1, (u8)(mux));
520 if (ret)
521 return ret;
522
523 engine->led_mux = mux;
524 return 0;
525}
526
527static ssize_t store_engine_leds(struct device *dev,
528 struct device_attribute *attr,
529 const char *buf, size_t len, int nr)
530{
531 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
532 struct lp55xx_chip *chip = led->chip;
533 struct lp55xx_engine *engine = &chip->engines[nr - 1];
534 u16 mux = 0;
535 ssize_t ret;
536
537 if (lp5523_mux_parse(buf, &mux, len))
538 return -EINVAL;
539
540 mutex_lock(&chip->lock);
541
542 chip->engine_idx = nr;
543 ret = -EINVAL;
544
545 if (engine->mode != LP55XX_ENGINE_LOAD)
546 goto leave;
547
548 if (lp5523_load_mux(chip, mux, nr))
549 goto leave;
550
551 ret = len;
552leave:
553 mutex_unlock(&chip->lock);
554 return ret;
555}
556store_leds(1)
557store_leds(2)
558store_leds(3)
559
560static ssize_t store_engine_load(struct device *dev,
561 struct device_attribute *attr,
562 const char *buf, size_t len, int nr)
563{
564 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
565 struct lp55xx_chip *chip = led->chip;
566 int ret;
567
568 mutex_lock(&chip->lock);
569
570 chip->engine_idx = nr;
571 lp5523_load_engine_and_select_page(chip);
572 ret = lp5523_update_program_memory(chip, buf, len);
573
574 mutex_unlock(&chip->lock);
575
576 return ret;
577}
578store_load(1)
579store_load(2)
580store_load(3)
581
582static ssize_t lp5523_selftest(struct device *dev,
583 struct device_attribute *attr,
584 char *buf)
585{
586 struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
587 struct lp55xx_chip *chip = led->chip;
588 struct lp55xx_platform_data *pdata = chip->pdata;
589 int i, ret, pos = 0;
590 u8 status, adc, vdd;
591
592 mutex_lock(&chip->lock);
593
594 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
595 if (ret < 0)
596 goto fail;
597
598 /* Check that ext clock is really in use if requested */
599 if (pdata->clock_mode == LP55XX_CLOCK_EXT) {
600 if ((status & LP5523_EXT_CLK_USED) == 0)
601 goto fail;
602 }
603
604 /* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
605 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL, LP5523_EN_LEDTEST | 16);
606 usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
607 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
608 if (ret < 0)
609 goto fail;
610
611 if (!(status & LP5523_LEDTEST_DONE))
612 usleep_range(3000, 6000); /* Was not ready. Wait little bit */
613
614 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &vdd);
615 if (ret < 0)
616 goto fail;
617
618 vdd--; /* There may be some fluctuation in measurement */
619
620 for (i = 0; i < LP5523_MAX_LEDS; i++) {
621 /* Skip non-existing channels */
622 if (pdata->led_config[i].led_current == 0)
623 continue;
624
625 /* Set default current */
626 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
627 pdata->led_config[i].led_current);
628
629 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0xff);
630 /* let current stabilize 2 - 4ms before measurements start */
631 usleep_range(2000, 4000);
632 lp55xx_write(chip, LP5523_REG_LED_TEST_CTRL,
633 LP5523_EN_LEDTEST | i);
634 /* ADC conversion time is 2.7 ms typically */
635 usleep_range(3000, 6000);
636 ret = lp55xx_read(chip, LP5523_REG_STATUS, &status);
637 if (ret < 0)
638 goto fail;
639
640 if (!(status & LP5523_LEDTEST_DONE))
641 usleep_range(3000, 6000);/* Was not ready. Wait. */
642
643 ret = lp55xx_read(chip, LP5523_REG_LED_TEST_ADC, &adc);
644 if (ret < 0)
645 goto fail;
646
647 if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
648 pos += sprintf(buf + pos, "LED %d FAIL\n", i);
649
650 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + i, 0x00);
651
652 /* Restore current */
653 lp55xx_write(chip, LP5523_REG_LED_CURRENT_BASE + i,
654 led->led_current);
655 led++;
656 }
657 if (pos == 0)
658 pos = sprintf(buf, "OK\n");
659 goto release_lock;
660fail:
661 pos = sprintf(buf, "FAIL\n");
662
663release_lock:
664 mutex_unlock(&chip->lock);
665
666 return pos;
667}
668
669static void lp5523_led_brightness_work(struct work_struct *work)
670{
671 struct lp55xx_led *led = container_of(work, struct lp55xx_led,
672 brightness_work);
673 struct lp55xx_chip *chip = led->chip;
674
675 mutex_lock(&chip->lock);
676 lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + led->chan_nr,
677 led->brightness);
678 mutex_unlock(&chip->lock);
679}
680
681static LP55XX_DEV_ATTR_RW(engine1_mode, show_engine1_mode, store_engine1_mode);
682static LP55XX_DEV_ATTR_RW(engine2_mode, show_engine2_mode, store_engine2_mode);
683static LP55XX_DEV_ATTR_RW(engine3_mode, show_engine3_mode, store_engine3_mode);
684static LP55XX_DEV_ATTR_RW(engine1_leds, show_engine1_leds, store_engine1_leds);
685static LP55XX_DEV_ATTR_RW(engine2_leds, show_engine2_leds, store_engine2_leds);
686static LP55XX_DEV_ATTR_RW(engine3_leds, show_engine3_leds, store_engine3_leds);
687static LP55XX_DEV_ATTR_WO(engine1_load, store_engine1_load);
688static LP55XX_DEV_ATTR_WO(engine2_load, store_engine2_load);
689static LP55XX_DEV_ATTR_WO(engine3_load, store_engine3_load);
690static LP55XX_DEV_ATTR_RO(selftest, lp5523_selftest);
691
692static struct attribute *lp5523_attributes[] = {
693 &dev_attr_engine1_mode.attr,
694 &dev_attr_engine2_mode.attr,
695 &dev_attr_engine3_mode.attr,
696 &dev_attr_engine1_load.attr,
697 &dev_attr_engine2_load.attr,
698 &dev_attr_engine3_load.attr,
699 &dev_attr_engine1_leds.attr,
700 &dev_attr_engine2_leds.attr,
701 &dev_attr_engine3_leds.attr,
702 &dev_attr_selftest.attr,
703 NULL,
704};
705
706static const struct attribute_group lp5523_group = {
707 .attrs = lp5523_attributes,
708};
709
710/* Chip specific configurations */
711static struct lp55xx_device_config lp5523_cfg = {
712 .reset = {
713 .addr = LP5523_REG_RESET,
714 .val = LP5523_RESET,
715 },
716 .enable = {
717 .addr = LP5523_REG_ENABLE,
718 .val = LP5523_ENABLE,
719 },
720 .max_channel = LP5523_MAX_LEDS,
721 .post_init_device = lp5523_post_init_device,
722 .brightness_work_fn = lp5523_led_brightness_work,
723 .set_led_current = lp5523_set_led_current,
724 .firmware_cb = lp5523_firmware_loaded,
725 .run_engine = lp5523_run_engine,
726 .dev_attr_group = &lp5523_group,
727};
728
729static int lp5523_probe(struct i2c_client *client,
730 const struct i2c_device_id *id)
731{
732 int ret;
733 struct lp55xx_chip *chip;
734 struct lp55xx_led *led;
735 struct lp55xx_platform_data *pdata;
736 struct device_node *np = client->dev.of_node;
737
738 if (!dev_get_platdata(&client->dev)) {
739 if (np) {
740 ret = lp55xx_of_populate_pdata(&client->dev, np);
741 if (ret < 0)
742 return ret;
743 } else {
744 dev_err(&client->dev, "no platform data\n");
745 return -EINVAL;
746 }
747 }
748 pdata = dev_get_platdata(&client->dev);
749
750 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
751 if (!chip)
752 return -ENOMEM;
753
754 led = devm_kzalloc(&client->dev,
755 sizeof(*led) * pdata->num_channels, GFP_KERNEL);
756 if (!led)
757 return -ENOMEM;
758
759 chip->cl = client;
760 chip->pdata = pdata;
761 chip->cfg = &lp5523_cfg;
762
763 mutex_init(&chip->lock);
764
765 i2c_set_clientdata(client, led);
766
767 ret = lp55xx_init_device(chip);
768 if (ret)
769 goto err_init;
770
771 dev_info(&client->dev, "%s Programmable led chip found\n", id->name);
772
773 ret = lp55xx_register_leds(led, chip);
774 if (ret)
775 goto err_register_leds;
776
777 ret = lp55xx_register_sysfs(chip);
778 if (ret) {
779 dev_err(&client->dev, "registering sysfs failed\n");
780 goto err_register_sysfs;
781 }
782
783 return 0;
784
785err_register_sysfs:
786 lp55xx_unregister_leds(led, chip);
787err_register_leds:
788 lp55xx_deinit_device(chip);
789err_init:
790 return ret;
791}
792
793static int lp5523_remove(struct i2c_client *client)
794{
795 struct lp55xx_led *led = i2c_get_clientdata(client);
796 struct lp55xx_chip *chip = led->chip;
797
798 lp5523_stop_all_engines(chip);
799 lp55xx_unregister_sysfs(chip);
800 lp55xx_unregister_leds(led, chip);
801 lp55xx_deinit_device(chip);
802
803 return 0;
804}
805
806static const struct i2c_device_id lp5523_id[] = {
807 { "lp5523", LP5523 },
808 { "lp55231", LP55231 },
809 { }
810};
811
812MODULE_DEVICE_TABLE(i2c, lp5523_id);
813
814#ifdef CONFIG_OF
815static const struct of_device_id of_lp5523_leds_match[] = {
816 { .compatible = "national,lp5523", },
817 {},
818};
819
820MODULE_DEVICE_TABLE(of, of_lp5523_leds_match);
821#endif
822
823static struct i2c_driver lp5523_driver = {
824 .driver = {
825 .name = "lp5523x",
826 .of_match_table = of_match_ptr(of_lp5523_leds_match),
827 },
828 .probe = lp5523_probe,
829 .remove = lp5523_remove,
830 .id_table = lp5523_id,
831};
832
833module_i2c_driver(lp5523_driver);
834
835MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
836MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
837MODULE_DESCRIPTION("LP5523 LED engine");
838MODULE_LICENSE("GPL");