xref: /openbmc/linux/drivers/leds/leds-lp5523.c (revision 287dcc2b)
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 
106 enum lp5523_chip_id {
107 	LP5523,
108 	LP55231,
109 };
110 
111 static int lp5523_init_program_engine(struct lp55xx_chip *chip);
112 
113 static inline void lp5523_wait_opmode_done(void)
114 {
115 	usleep_range(1000, 2000);
116 }
117 
118 static 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 
125 static 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 
155 static 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 
175 static 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 
189 static 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 
195 static 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 
209 static 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 
217 static 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 
265 static 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 
320 out:
321 	lp5523_stop_all_engines(chip);
322 	return ret;
323 }
324 
325 static 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 
363 err:
364 	dev_err(&chip->cl->dev, "wrong pattern format\n");
365 	return -EINVAL;
366 }
367 
368 static 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 
388 static 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 }
406 show_mode(1)
407 show_mode(2)
408 show_mode(3)
409 
410 static 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 }
438 store_mode(1)
439 store_mode(2)
440 store_mode(3)
441 
442 static 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 
468 static 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 
478 static 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 }
490 show_leds(1)
491 show_leds(2)
492 show_leds(3)
493 
494 static 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 
522 static 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;
547 leave:
548 	mutex_unlock(&chip->lock);
549 	return ret;
550 }
551 store_leds(1)
552 store_leds(2)
553 store_leds(3)
554 
555 static 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 }
573 store_load(1)
574 store_load(2)
575 store_load(3)
576 
577 static 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;
658 fail:
659 	pos = sprintf(buf, "FAIL\n");
660 
661 release_lock:
662 	mutex_unlock(&chip->lock);
663 
664 	return pos;
665 }
666 
667 #define show_fader(nr)						\
668 static 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)						\
676 static 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 
683 static 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 }
701 show_fader(1)
702 show_fader(2)
703 show_fader(3)
704 
705 static 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 }
730 store_fader(1)
731 store_fader(2)
732 store_fader(3)
733 
734 static 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;
760 leave:
761 	mutex_unlock(&chip->lock);
762 	return ret;
763 }
764 
765 static 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;
793 leave:
794 	mutex_unlock(&chip->lock);
795 	return ret;
796 }
797 
798 static 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 
817 static 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 
829 static LP55XX_DEV_ATTR_RW(engine1_mode, show_engine1_mode, store_engine1_mode);
830 static LP55XX_DEV_ATTR_RW(engine2_mode, show_engine2_mode, store_engine2_mode);
831 static LP55XX_DEV_ATTR_RW(engine3_mode, show_engine3_mode, store_engine3_mode);
832 static LP55XX_DEV_ATTR_RW(engine1_leds, show_engine1_leds, store_engine1_leds);
833 static LP55XX_DEV_ATTR_RW(engine2_leds, show_engine2_leds, store_engine2_leds);
834 static LP55XX_DEV_ATTR_RW(engine3_leds, show_engine3_leds, store_engine3_leds);
835 static LP55XX_DEV_ATTR_WO(engine1_load, store_engine1_load);
836 static LP55XX_DEV_ATTR_WO(engine2_load, store_engine2_load);
837 static LP55XX_DEV_ATTR_WO(engine3_load, store_engine3_load);
838 static LP55XX_DEV_ATTR_RO(selftest, lp5523_selftest);
839 static LP55XX_DEV_ATTR_RW(master_fader1, show_master_fader1,
840 			  store_master_fader1);
841 static LP55XX_DEV_ATTR_RW(master_fader2, show_master_fader2,
842 			  store_master_fader2);
843 static LP55XX_DEV_ATTR_RW(master_fader3, show_master_fader3,
844 			  store_master_fader3);
845 static LP55XX_DEV_ATTR_RW(master_fader_leds, show_master_fader_leds,
846 			  store_master_fader_leds);
847 
848 static 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 
866 static const struct attribute_group lp5523_group = {
867 	.attrs = lp5523_attributes,
868 };
869 
870 /* Chip specific configurations */
871 static 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 
890 static int lp5523_probe(struct i2c_client *client)
891 {
892 	const struct i2c_device_id *id = i2c_client_get_device_id(client);
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 
947 err_out:
948 	lp55xx_deinit_device(chip);
949 err_init:
950 	return ret;
951 }
952 
953 static 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 
963 static const struct i2c_device_id lp5523_id[] = {
964 	{ "lp5523",  LP5523 },
965 	{ "lp55231", LP55231 },
966 	{ }
967 };
968 
969 MODULE_DEVICE_TABLE(i2c, lp5523_id);
970 
971 #ifdef CONFIG_OF
972 static const struct of_device_id of_lp5523_leds_match[] = {
973 	{ .compatible = "national,lp5523", },
974 	{ .compatible = "ti,lp55231", },
975 	{},
976 };
977 
978 MODULE_DEVICE_TABLE(of, of_lp5523_leds_match);
979 #endif
980 
981 static struct i2c_driver lp5523_driver = {
982 	.driver = {
983 		.name	= "lp5523x",
984 		.of_match_table = of_match_ptr(of_lp5523_leds_match),
985 	},
986 	.probe_new	= lp5523_probe,
987 	.remove		= lp5523_remove,
988 	.id_table	= lp5523_id,
989 };
990 
991 module_i2c_driver(lp5523_driver);
992 
993 MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
994 MODULE_AUTHOR("Milo Kim <milo.kim@ti.com>");
995 MODULE_DESCRIPTION("LP5523 LED engine");
996 MODULE_LICENSE("GPL");
997