Loading...
1/*
2 * lp5523.c - LP5523 LED Driver
3 *
4 * Copyright (C) 2010 Nokia Corporation
5 *
6 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA
21 */
22
23#include <linux/module.h>
24#include <linux/init.h>
25#include <linux/i2c.h>
26#include <linux/mutex.h>
27#include <linux/gpio.h>
28#include <linux/interrupt.h>
29#include <linux/delay.h>
30#include <linux/ctype.h>
31#include <linux/spinlock.h>
32#include <linux/wait.h>
33#include <linux/leds.h>
34#include <linux/leds-lp5523.h>
35#include <linux/workqueue.h>
36#include <linux/slab.h>
37
38#define LP5523_REG_ENABLE 0x00
39#define LP5523_REG_OP_MODE 0x01
40#define LP5523_REG_RATIOMETRIC_MSB 0x02
41#define LP5523_REG_RATIOMETRIC_LSB 0x03
42#define LP5523_REG_ENABLE_LEDS_MSB 0x04
43#define LP5523_REG_ENABLE_LEDS_LSB 0x05
44#define LP5523_REG_LED_CNTRL_BASE 0x06
45#define LP5523_REG_LED_PWM_BASE 0x16
46#define LP5523_REG_LED_CURRENT_BASE 0x26
47#define LP5523_REG_CONFIG 0x36
48#define LP5523_REG_CHANNEL1_PC 0x37
49#define LP5523_REG_CHANNEL2_PC 0x38
50#define LP5523_REG_CHANNEL3_PC 0x39
51#define LP5523_REG_STATUS 0x3a
52#define LP5523_REG_GPO 0x3b
53#define LP5523_REG_VARIABLE 0x3c
54#define LP5523_REG_RESET 0x3d
55#define LP5523_REG_TEMP_CTRL 0x3e
56#define LP5523_REG_TEMP_READ 0x3f
57#define LP5523_REG_TEMP_WRITE 0x40
58#define LP5523_REG_LED_TEST_CTRL 0x41
59#define LP5523_REG_LED_TEST_ADC 0x42
60#define LP5523_REG_ENG1_VARIABLE 0x45
61#define LP5523_REG_ENG2_VARIABLE 0x46
62#define LP5523_REG_ENG3_VARIABLE 0x47
63#define LP5523_REG_MASTER_FADER1 0x48
64#define LP5523_REG_MASTER_FADER2 0x49
65#define LP5523_REG_MASTER_FADER3 0x4a
66#define LP5523_REG_CH1_PROG_START 0x4c
67#define LP5523_REG_CH2_PROG_START 0x4d
68#define LP5523_REG_CH3_PROG_START 0x4e
69#define LP5523_REG_PROG_PAGE_SEL 0x4f
70#define LP5523_REG_PROG_MEM 0x50
71
72#define LP5523_CMD_LOAD 0x15 /* 00010101 */
73#define LP5523_CMD_RUN 0x2a /* 00101010 */
74#define LP5523_CMD_DISABLED 0x00 /* 00000000 */
75
76#define LP5523_ENABLE 0x40
77#define LP5523_AUTO_INC 0x40
78#define LP5523_PWR_SAVE 0x20
79#define LP5523_PWM_PWR_SAVE 0x04
80#define LP5523_CP_1 0x08
81#define LP5523_CP_1_5 0x10
82#define LP5523_CP_AUTO 0x18
83#define LP5523_INT_CLK 0x01
84#define LP5523_AUTO_CLK 0x02
85#define LP5523_EN_LEDTEST 0x80
86#define LP5523_LEDTEST_DONE 0x80
87
88#define LP5523_DEFAULT_CURRENT 50 /* microAmps */
89#define LP5523_PROGRAM_LENGTH 32 /* in bytes */
90#define LP5523_PROGRAM_PAGES 6
91#define LP5523_ADC_SHORTCIRC_LIM 80
92
93#define LP5523_LEDS 9
94#define LP5523_ENGINES 3
95
96#define LP5523_ENG_MASK_BASE 0x30 /* 00110000 */
97
98#define LP5523_ENG_STATUS_MASK 0x07 /* 00000111 */
99
100#define LP5523_IRQ_FLAGS IRQF_TRIGGER_FALLING
101
102#define LP5523_EXT_CLK_USED 0x08
103
104#define LED_ACTIVE(mux, led) (!!(mux & (0x0001 << led)))
105#define SHIFT_MASK(id) (((id) - 1) * 2)
106
107struct lp5523_engine {
108 int id;
109 u8 mode;
110 u8 prog_page;
111 u8 mux_page;
112 u16 led_mux;
113 u8 engine_mask;
114};
115
116struct lp5523_led {
117 int id;
118 u8 chan_nr;
119 u8 led_current;
120 u8 max_current;
121 struct led_classdev cdev;
122 struct work_struct brightness_work;
123 u8 brightness;
124};
125
126struct lp5523_chip {
127 struct mutex lock; /* Serialize control */
128 struct i2c_client *client;
129 struct lp5523_engine engines[LP5523_ENGINES];
130 struct lp5523_led leds[LP5523_LEDS];
131 struct lp5523_platform_data *pdata;
132 u8 num_channels;
133 u8 num_leds;
134};
135
136static inline struct lp5523_led *cdev_to_led(struct led_classdev *cdev)
137{
138 return container_of(cdev, struct lp5523_led, cdev);
139}
140
141static inline struct lp5523_chip *engine_to_lp5523(struct lp5523_engine *engine)
142{
143 return container_of(engine, struct lp5523_chip,
144 engines[engine->id - 1]);
145}
146
147static inline struct lp5523_chip *led_to_lp5523(struct lp5523_led *led)
148{
149 return container_of(led, struct lp5523_chip,
150 leds[led->id]);
151}
152
153static int lp5523_set_mode(struct lp5523_engine *engine, u8 mode);
154static int lp5523_set_engine_mode(struct lp5523_engine *engine, u8 mode);
155static int lp5523_load_program(struct lp5523_engine *engine, const u8 *pattern);
156
157static void lp5523_led_brightness_work(struct work_struct *work);
158
159static int lp5523_write(struct i2c_client *client, u8 reg, u8 value)
160{
161 return i2c_smbus_write_byte_data(client, reg, value);
162}
163
164static int lp5523_read(struct i2c_client *client, u8 reg, u8 *buf)
165{
166 s32 ret = i2c_smbus_read_byte_data(client, reg);
167
168 if (ret < 0)
169 return -EIO;
170
171 *buf = ret;
172 return 0;
173}
174
175static int lp5523_detect(struct i2c_client *client)
176{
177 int ret;
178 u8 buf;
179
180 ret = lp5523_write(client, LP5523_REG_ENABLE, 0x40);
181 if (ret)
182 return ret;
183 ret = lp5523_read(client, LP5523_REG_ENABLE, &buf);
184 if (ret)
185 return ret;
186 if (buf == 0x40)
187 return 0;
188 else
189 return -ENODEV;
190}
191
192static int lp5523_configure(struct i2c_client *client)
193{
194 struct lp5523_chip *chip = i2c_get_clientdata(client);
195 int ret = 0;
196 u8 status;
197
198 /* one pattern per engine setting led mux start and stop addresses */
199 static const u8 pattern[][LP5523_PROGRAM_LENGTH] = {
200 { 0x9c, 0x30, 0x9c, 0xb0, 0x9d, 0x80, 0xd8, 0x00, 0},
201 { 0x9c, 0x40, 0x9c, 0xc0, 0x9d, 0x80, 0xd8, 0x00, 0},
202 { 0x9c, 0x50, 0x9c, 0xd0, 0x9d, 0x80, 0xd8, 0x00, 0},
203 };
204
205 ret |= lp5523_write(client, LP5523_REG_ENABLE, LP5523_ENABLE);
206 /* Chip startup time is 500 us, 1 - 2 ms gives some margin */
207 usleep_range(1000, 2000);
208
209 ret |= lp5523_write(client, LP5523_REG_CONFIG,
210 LP5523_AUTO_INC | LP5523_PWR_SAVE |
211 LP5523_CP_AUTO | LP5523_AUTO_CLK |
212 LP5523_PWM_PWR_SAVE);
213
214 /* turn on all leds */
215 ret |= lp5523_write(client, LP5523_REG_ENABLE_LEDS_MSB, 0x01);
216 ret |= lp5523_write(client, LP5523_REG_ENABLE_LEDS_LSB, 0xff);
217
218 /* hardcode 32 bytes of memory for each engine from program memory */
219 ret |= lp5523_write(client, LP5523_REG_CH1_PROG_START, 0x00);
220 ret |= lp5523_write(client, LP5523_REG_CH2_PROG_START, 0x10);
221 ret |= lp5523_write(client, LP5523_REG_CH3_PROG_START, 0x20);
222
223 /* write led mux address space for each channel */
224 ret |= lp5523_load_program(&chip->engines[0], pattern[0]);
225 ret |= lp5523_load_program(&chip->engines[1], pattern[1]);
226 ret |= lp5523_load_program(&chip->engines[2], pattern[2]);
227
228 if (ret) {
229 dev_err(&client->dev, "could not load mux programs\n");
230 return -1;
231 }
232
233 /* set all engines exec state and mode to run 00101010 */
234 ret |= lp5523_write(client, LP5523_REG_ENABLE,
235 (LP5523_CMD_RUN | LP5523_ENABLE));
236
237 ret |= lp5523_write(client, LP5523_REG_OP_MODE, LP5523_CMD_RUN);
238
239 if (ret) {
240 dev_err(&client->dev, "could not start mux programs\n");
241 return -1;
242 }
243
244 /* Let the programs run for couple of ms and check the engine status */
245 usleep_range(3000, 6000);
246 lp5523_read(client, LP5523_REG_STATUS, &status);
247 status &= LP5523_ENG_STATUS_MASK;
248
249 if (status == LP5523_ENG_STATUS_MASK) {
250 dev_dbg(&client->dev, "all engines configured\n");
251 } else {
252 dev_info(&client->dev, "status == %x\n", status);
253 dev_err(&client->dev, "cound not configure LED engine\n");
254 return -1;
255 }
256
257 dev_info(&client->dev, "disabling engines\n");
258
259 ret |= lp5523_write(client, LP5523_REG_OP_MODE, LP5523_CMD_DISABLED);
260
261 return ret;
262}
263
264static int lp5523_set_engine_mode(struct lp5523_engine *engine, u8 mode)
265{
266 struct lp5523_chip *chip = engine_to_lp5523(engine);
267 struct i2c_client *client = chip->client;
268 int ret;
269 u8 engine_state;
270
271 ret = lp5523_read(client, LP5523_REG_OP_MODE, &engine_state);
272 if (ret)
273 goto fail;
274
275 engine_state &= ~(engine->engine_mask);
276
277 /* set mode only for this engine */
278 mode &= engine->engine_mask;
279
280 engine_state |= mode;
281
282 ret |= lp5523_write(client, LP5523_REG_OP_MODE, engine_state);
283fail:
284 return ret;
285}
286
287static int lp5523_load_mux(struct lp5523_engine *engine, u16 mux)
288{
289 struct lp5523_chip *chip = engine_to_lp5523(engine);
290 struct i2c_client *client = chip->client;
291 int ret = 0;
292
293 ret |= lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
294
295 ret |= lp5523_write(client, LP5523_REG_PROG_PAGE_SEL, engine->mux_page);
296 ret |= lp5523_write(client, LP5523_REG_PROG_MEM,
297 (u8)(mux >> 8));
298 ret |= lp5523_write(client, LP5523_REG_PROG_MEM + 1, (u8)(mux));
299 engine->led_mux = mux;
300
301 return ret;
302}
303
304static int lp5523_load_program(struct lp5523_engine *engine, const u8 *pattern)
305{
306 struct lp5523_chip *chip = engine_to_lp5523(engine);
307 struct i2c_client *client = chip->client;
308
309 int ret = 0;
310
311 ret |= lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
312
313 ret |= lp5523_write(client, LP5523_REG_PROG_PAGE_SEL,
314 engine->prog_page);
315 ret |= i2c_smbus_write_i2c_block_data(client, LP5523_REG_PROG_MEM,
316 LP5523_PROGRAM_LENGTH, pattern);
317
318 return ret;
319}
320
321static int lp5523_run_program(struct lp5523_engine *engine)
322{
323 struct lp5523_chip *chip = engine_to_lp5523(engine);
324 struct i2c_client *client = chip->client;
325 int ret;
326
327 ret = lp5523_write(client, LP5523_REG_ENABLE,
328 LP5523_CMD_RUN | LP5523_ENABLE);
329 if (ret)
330 goto fail;
331
332 ret = lp5523_set_engine_mode(engine, LP5523_CMD_RUN);
333fail:
334 return ret;
335}
336
337static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
338{
339 int i;
340 u16 tmp_mux = 0;
341 len = len < LP5523_LEDS ? len : LP5523_LEDS;
342 for (i = 0; i < len; i++) {
343 switch (buf[i]) {
344 case '1':
345 tmp_mux |= (1 << i);
346 break;
347 case '0':
348 break;
349 case '\n':
350 i = len;
351 break;
352 default:
353 return -1;
354 }
355 }
356 *mux = tmp_mux;
357
358 return 0;
359}
360
361static void lp5523_mux_to_array(u16 led_mux, char *array)
362{
363 int i, pos = 0;
364 for (i = 0; i < LP5523_LEDS; i++)
365 pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
366
367 array[pos] = '\0';
368}
369
370/*--------------------------------------------------------------*/
371/* Sysfs interface */
372/*--------------------------------------------------------------*/
373
374static ssize_t show_engine_leds(struct device *dev,
375 struct device_attribute *attr,
376 char *buf, int nr)
377{
378 struct i2c_client *client = to_i2c_client(dev);
379 struct lp5523_chip *chip = i2c_get_clientdata(client);
380 char mux[LP5523_LEDS + 1];
381
382 lp5523_mux_to_array(chip->engines[nr - 1].led_mux, mux);
383
384 return sprintf(buf, "%s\n", mux);
385}
386
387#define show_leds(nr) \
388static ssize_t show_engine##nr##_leds(struct device *dev, \
389 struct device_attribute *attr, \
390 char *buf) \
391{ \
392 return show_engine_leds(dev, attr, buf, nr); \
393}
394show_leds(1)
395show_leds(2)
396show_leds(3)
397
398static ssize_t store_engine_leds(struct device *dev,
399 struct device_attribute *attr,
400 const char *buf, size_t len, int nr)
401{
402 struct i2c_client *client = to_i2c_client(dev);
403 struct lp5523_chip *chip = i2c_get_clientdata(client);
404 u16 mux = 0;
405 ssize_t ret;
406
407 if (lp5523_mux_parse(buf, &mux, len))
408 return -EINVAL;
409
410 mutex_lock(&chip->lock);
411 ret = -EINVAL;
412 if (chip->engines[nr - 1].mode != LP5523_CMD_LOAD)
413 goto leave;
414
415 if (lp5523_load_mux(&chip->engines[nr - 1], mux))
416 goto leave;
417
418 ret = len;
419leave:
420 mutex_unlock(&chip->lock);
421 return ret;
422}
423
424#define store_leds(nr) \
425static ssize_t store_engine##nr##_leds(struct device *dev, \
426 struct device_attribute *attr, \
427 const char *buf, size_t len) \
428{ \
429 return store_engine_leds(dev, attr, buf, len, nr); \
430}
431store_leds(1)
432store_leds(2)
433store_leds(3)
434
435static ssize_t lp5523_selftest(struct device *dev,
436 struct device_attribute *attr,
437 char *buf)
438{
439 struct i2c_client *client = to_i2c_client(dev);
440 struct lp5523_chip *chip = i2c_get_clientdata(client);
441 int i, ret, pos = 0;
442 int led = 0;
443 u8 status, adc, vdd;
444
445 mutex_lock(&chip->lock);
446
447 ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
448 if (ret < 0)
449 goto fail;
450
451 /* Check that ext clock is really in use if requested */
452 if ((chip->pdata) && (chip->pdata->clock_mode == LP5523_CLOCK_EXT))
453 if ((status & LP5523_EXT_CLK_USED) == 0)
454 goto fail;
455
456 /* Measure VDD (i.e. VBAT) first (channel 16 corresponds to VDD) */
457 lp5523_write(chip->client, LP5523_REG_LED_TEST_CTRL,
458 LP5523_EN_LEDTEST | 16);
459 usleep_range(3000, 6000); /* ADC conversion time is typically 2.7 ms */
460 ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
461 if (!(status & LP5523_LEDTEST_DONE))
462 usleep_range(3000, 6000); /* Was not ready. Wait little bit */
463
464 ret |= lp5523_read(chip->client, LP5523_REG_LED_TEST_ADC, &vdd);
465 vdd--; /* There may be some fluctuation in measurement */
466
467 for (i = 0; i < LP5523_LEDS; i++) {
468 /* Skip non-existing channels */
469 if (chip->pdata->led_config[i].led_current == 0)
470 continue;
471
472 /* Set default current */
473 lp5523_write(chip->client,
474 LP5523_REG_LED_CURRENT_BASE + i,
475 chip->pdata->led_config[i].led_current);
476
477 lp5523_write(chip->client, LP5523_REG_LED_PWM_BASE + i, 0xff);
478 /* let current stabilize 2 - 4ms before measurements start */
479 usleep_range(2000, 4000);
480 lp5523_write(chip->client,
481 LP5523_REG_LED_TEST_CTRL,
482 LP5523_EN_LEDTEST | i);
483 /* ADC conversion time is 2.7 ms typically */
484 usleep_range(3000, 6000);
485 ret = lp5523_read(chip->client, LP5523_REG_STATUS, &status);
486 if (!(status & LP5523_LEDTEST_DONE))
487 usleep_range(3000, 6000);/* Was not ready. Wait. */
488 ret |= lp5523_read(chip->client, LP5523_REG_LED_TEST_ADC, &adc);
489
490 if (adc >= vdd || adc < LP5523_ADC_SHORTCIRC_LIM)
491 pos += sprintf(buf + pos, "LED %d FAIL\n", i);
492
493 lp5523_write(chip->client, LP5523_REG_LED_PWM_BASE + i, 0x00);
494
495 /* Restore current */
496 lp5523_write(chip->client,
497 LP5523_REG_LED_CURRENT_BASE + i,
498 chip->leds[led].led_current);
499 led++;
500 }
501 if (pos == 0)
502 pos = sprintf(buf, "OK\n");
503 goto release_lock;
504fail:
505 pos = sprintf(buf, "FAIL\n");
506
507release_lock:
508 mutex_unlock(&chip->lock);
509
510 return pos;
511}
512
513static void lp5523_set_brightness(struct led_classdev *cdev,
514 enum led_brightness brightness)
515{
516 struct lp5523_led *led = cdev_to_led(cdev);
517
518 led->brightness = (u8)brightness;
519
520 schedule_work(&led->brightness_work);
521}
522
523static void lp5523_led_brightness_work(struct work_struct *work)
524{
525 struct lp5523_led *led = container_of(work,
526 struct lp5523_led,
527 brightness_work);
528 struct lp5523_chip *chip = led_to_lp5523(led);
529 struct i2c_client *client = chip->client;
530
531 mutex_lock(&chip->lock);
532
533 lp5523_write(client, LP5523_REG_LED_PWM_BASE + led->chan_nr,
534 led->brightness);
535
536 mutex_unlock(&chip->lock);
537}
538
539static int lp5523_do_store_load(struct lp5523_engine *engine,
540 const char *buf, size_t len)
541{
542 struct lp5523_chip *chip = engine_to_lp5523(engine);
543 struct i2c_client *client = chip->client;
544 int ret, nrchars, offset = 0, i = 0;
545 char c[3];
546 unsigned cmd;
547 u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
548
549 while ((offset < len - 1) && (i < LP5523_PROGRAM_LENGTH)) {
550 /* separate sscanfs because length is working only for %s */
551 ret = sscanf(buf + offset, "%2s%n ", c, &nrchars);
552 ret = sscanf(c, "%2x", &cmd);
553 if (ret != 1)
554 goto fail;
555 pattern[i] = (u8)cmd;
556
557 offset += nrchars;
558 i++;
559 }
560
561 /* Each instruction is 16bit long. Check that length is even */
562 if (i % 2)
563 goto fail;
564
565 mutex_lock(&chip->lock);
566
567 if (engine->mode == LP5523_CMD_LOAD)
568 ret = lp5523_load_program(engine, pattern);
569 else
570 ret = -EINVAL;
571
572 mutex_unlock(&chip->lock);
573
574 if (ret) {
575 dev_err(&client->dev, "failed loading pattern\n");
576 return ret;
577 }
578
579 return len;
580fail:
581 dev_err(&client->dev, "wrong pattern format\n");
582 return -EINVAL;
583}
584
585static ssize_t store_engine_load(struct device *dev,
586 struct device_attribute *attr,
587 const char *buf, size_t len, int nr)
588{
589 struct i2c_client *client = to_i2c_client(dev);
590 struct lp5523_chip *chip = i2c_get_clientdata(client);
591 return lp5523_do_store_load(&chip->engines[nr - 1], buf, len);
592}
593
594#define store_load(nr) \
595static ssize_t store_engine##nr##_load(struct device *dev, \
596 struct device_attribute *attr, \
597 const char *buf, size_t len) \
598{ \
599 return store_engine_load(dev, attr, buf, len, nr); \
600}
601store_load(1)
602store_load(2)
603store_load(3)
604
605static ssize_t show_engine_mode(struct device *dev,
606 struct device_attribute *attr,
607 char *buf, int nr)
608{
609 struct i2c_client *client = to_i2c_client(dev);
610 struct lp5523_chip *chip = i2c_get_clientdata(client);
611 switch (chip->engines[nr - 1].mode) {
612 case LP5523_CMD_RUN:
613 return sprintf(buf, "run\n");
614 case LP5523_CMD_LOAD:
615 return sprintf(buf, "load\n");
616 case LP5523_CMD_DISABLED:
617 return sprintf(buf, "disabled\n");
618 default:
619 return sprintf(buf, "disabled\n");
620 }
621}
622
623#define show_mode(nr) \
624static ssize_t show_engine##nr##_mode(struct device *dev, \
625 struct device_attribute *attr, \
626 char *buf) \
627{ \
628 return show_engine_mode(dev, attr, buf, nr); \
629}
630show_mode(1)
631show_mode(2)
632show_mode(3)
633
634static ssize_t store_engine_mode(struct device *dev,
635 struct device_attribute *attr,
636 const char *buf, size_t len, int nr)
637{
638 struct i2c_client *client = to_i2c_client(dev);
639 struct lp5523_chip *chip = i2c_get_clientdata(client);
640 struct lp5523_engine *engine = &chip->engines[nr - 1];
641 mutex_lock(&chip->lock);
642
643 if (!strncmp(buf, "run", 3))
644 lp5523_set_mode(engine, LP5523_CMD_RUN);
645 else if (!strncmp(buf, "load", 4))
646 lp5523_set_mode(engine, LP5523_CMD_LOAD);
647 else if (!strncmp(buf, "disabled", 8))
648 lp5523_set_mode(engine, LP5523_CMD_DISABLED);
649
650 mutex_unlock(&chip->lock);
651 return len;
652}
653
654#define store_mode(nr) \
655static ssize_t store_engine##nr##_mode(struct device *dev, \
656 struct device_attribute *attr, \
657 const char *buf, size_t len) \
658{ \
659 return store_engine_mode(dev, attr, buf, len, nr); \
660}
661store_mode(1)
662store_mode(2)
663store_mode(3)
664
665static ssize_t show_max_current(struct device *dev,
666 struct device_attribute *attr,
667 char *buf)
668{
669 struct led_classdev *led_cdev = dev_get_drvdata(dev);
670 struct lp5523_led *led = cdev_to_led(led_cdev);
671
672 return sprintf(buf, "%d\n", led->max_current);
673}
674
675static ssize_t show_current(struct device *dev,
676 struct device_attribute *attr,
677 char *buf)
678{
679 struct led_classdev *led_cdev = dev_get_drvdata(dev);
680 struct lp5523_led *led = cdev_to_led(led_cdev);
681
682 return sprintf(buf, "%d\n", led->led_current);
683}
684
685static ssize_t store_current(struct device *dev,
686 struct device_attribute *attr,
687 const char *buf, size_t len)
688{
689 struct led_classdev *led_cdev = dev_get_drvdata(dev);
690 struct lp5523_led *led = cdev_to_led(led_cdev);
691 struct lp5523_chip *chip = led_to_lp5523(led);
692 ssize_t ret;
693 unsigned long curr;
694
695 if (strict_strtoul(buf, 0, &curr))
696 return -EINVAL;
697
698 if (curr > led->max_current)
699 return -EINVAL;
700
701 mutex_lock(&chip->lock);
702 ret = lp5523_write(chip->client,
703 LP5523_REG_LED_CURRENT_BASE + led->chan_nr,
704 (u8)curr);
705 mutex_unlock(&chip->lock);
706
707 if (ret < 0)
708 return ret;
709
710 led->led_current = (u8)curr;
711
712 return len;
713}
714
715/* led class device attributes */
716static DEVICE_ATTR(led_current, S_IRUGO | S_IWUSR, show_current, store_current);
717static DEVICE_ATTR(max_current, S_IRUGO , show_max_current, NULL);
718
719static struct attribute *lp5523_led_attributes[] = {
720 &dev_attr_led_current.attr,
721 &dev_attr_max_current.attr,
722 NULL,
723};
724
725static struct attribute_group lp5523_led_attribute_group = {
726 .attrs = lp5523_led_attributes
727};
728
729/* device attributes */
730static DEVICE_ATTR(engine1_mode, S_IRUGO | S_IWUSR,
731 show_engine1_mode, store_engine1_mode);
732static DEVICE_ATTR(engine2_mode, S_IRUGO | S_IWUSR,
733 show_engine2_mode, store_engine2_mode);
734static DEVICE_ATTR(engine3_mode, S_IRUGO | S_IWUSR,
735 show_engine3_mode, store_engine3_mode);
736static DEVICE_ATTR(engine1_leds, S_IRUGO | S_IWUSR,
737 show_engine1_leds, store_engine1_leds);
738static DEVICE_ATTR(engine2_leds, S_IRUGO | S_IWUSR,
739 show_engine2_leds, store_engine2_leds);
740static DEVICE_ATTR(engine3_leds, S_IRUGO | S_IWUSR,
741 show_engine3_leds, store_engine3_leds);
742static DEVICE_ATTR(engine1_load, S_IWUSR, NULL, store_engine1_load);
743static DEVICE_ATTR(engine2_load, S_IWUSR, NULL, store_engine2_load);
744static DEVICE_ATTR(engine3_load, S_IWUSR, NULL, store_engine3_load);
745static DEVICE_ATTR(selftest, S_IRUGO, lp5523_selftest, NULL);
746
747static struct attribute *lp5523_attributes[] = {
748 &dev_attr_engine1_mode.attr,
749 &dev_attr_engine2_mode.attr,
750 &dev_attr_engine3_mode.attr,
751 &dev_attr_selftest.attr,
752 &dev_attr_engine1_load.attr,
753 &dev_attr_engine1_leds.attr,
754 &dev_attr_engine2_load.attr,
755 &dev_attr_engine2_leds.attr,
756 &dev_attr_engine3_load.attr,
757 &dev_attr_engine3_leds.attr,
758};
759
760static const struct attribute_group lp5523_group = {
761 .attrs = lp5523_attributes,
762};
763
764static int lp5523_register_sysfs(struct i2c_client *client)
765{
766 struct device *dev = &client->dev;
767 int ret;
768
769 ret = sysfs_create_group(&dev->kobj, &lp5523_group);
770 if (ret < 0)
771 return ret;
772
773 return 0;
774}
775
776static void lp5523_unregister_sysfs(struct i2c_client *client)
777{
778 struct lp5523_chip *chip = i2c_get_clientdata(client);
779 struct device *dev = &client->dev;
780 int i;
781
782 sysfs_remove_group(&dev->kobj, &lp5523_group);
783
784 for (i = 0; i < chip->num_leds; i++)
785 sysfs_remove_group(&chip->leds[i].cdev.dev->kobj,
786 &lp5523_led_attribute_group);
787}
788
789/*--------------------------------------------------------------*/
790/* Set chip operating mode */
791/*--------------------------------------------------------------*/
792static int lp5523_set_mode(struct lp5523_engine *engine, u8 mode)
793{
794 int ret = 0;
795
796 /* if in that mode already do nothing, except for run */
797 if (mode == engine->mode && mode != LP5523_CMD_RUN)
798 return 0;
799
800 if (mode == LP5523_CMD_RUN) {
801 ret = lp5523_run_program(engine);
802 } else if (mode == LP5523_CMD_LOAD) {
803 lp5523_set_engine_mode(engine, LP5523_CMD_DISABLED);
804 lp5523_set_engine_mode(engine, LP5523_CMD_LOAD);
805 } else if (mode == LP5523_CMD_DISABLED) {
806 lp5523_set_engine_mode(engine, LP5523_CMD_DISABLED);
807 }
808
809 engine->mode = mode;
810
811 return ret;
812}
813
814/*--------------------------------------------------------------*/
815/* Probe, Attach, Remove */
816/*--------------------------------------------------------------*/
817static int __init lp5523_init_engine(struct lp5523_engine *engine, int id)
818{
819 if (id < 1 || id > LP5523_ENGINES)
820 return -1;
821 engine->id = id;
822 engine->engine_mask = LP5523_ENG_MASK_BASE >> SHIFT_MASK(id);
823 engine->prog_page = id - 1;
824 engine->mux_page = id + 2;
825
826 return 0;
827}
828
829static int __devinit lp5523_init_led(struct lp5523_led *led, struct device *dev,
830 int chan, struct lp5523_platform_data *pdata)
831{
832 char name[32];
833 int res;
834
835 if (chan >= LP5523_LEDS)
836 return -EINVAL;
837
838 if (pdata->led_config[chan].led_current) {
839 led->led_current = pdata->led_config[chan].led_current;
840 led->max_current = pdata->led_config[chan].max_current;
841 led->chan_nr = pdata->led_config[chan].chan_nr;
842
843 if (led->chan_nr >= LP5523_LEDS) {
844 dev_err(dev, "Use channel numbers between 0 and %d\n",
845 LP5523_LEDS - 1);
846 return -EINVAL;
847 }
848
849 snprintf(name, sizeof(name), "%s:channel%d",
850 pdata->label ?: "lp5523", chan);
851
852 led->cdev.name = name;
853 led->cdev.brightness_set = lp5523_set_brightness;
854 res = led_classdev_register(dev, &led->cdev);
855 if (res < 0) {
856 dev_err(dev, "couldn't register led on channel %d\n",
857 chan);
858 return res;
859 }
860 res = sysfs_create_group(&led->cdev.dev->kobj,
861 &lp5523_led_attribute_group);
862 if (res < 0) {
863 dev_err(dev, "couldn't register current attribute\n");
864 led_classdev_unregister(&led->cdev);
865 return res;
866 }
867 } else {
868 led->led_current = 0;
869 }
870 return 0;
871}
872
873static int __devinit lp5523_probe(struct i2c_client *client,
874 const struct i2c_device_id *id)
875{
876 struct lp5523_chip *chip;
877 struct lp5523_platform_data *pdata;
878 int ret, i, led;
879
880 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
881 if (!chip)
882 return -ENOMEM;
883
884 i2c_set_clientdata(client, chip);
885 chip->client = client;
886
887 pdata = client->dev.platform_data;
888
889 if (!pdata) {
890 dev_err(&client->dev, "no platform data\n");
891 ret = -EINVAL;
892 goto fail1;
893 }
894
895 mutex_init(&chip->lock);
896
897 chip->pdata = pdata;
898
899 if (pdata->setup_resources) {
900 ret = pdata->setup_resources();
901 if (ret < 0)
902 goto fail1;
903 }
904
905 if (pdata->enable) {
906 pdata->enable(0);
907 usleep_range(1000, 2000); /* Keep enable down at least 1ms */
908 pdata->enable(1);
909 usleep_range(1000, 2000); /* 500us abs min. */
910 }
911
912 lp5523_write(client, LP5523_REG_RESET, 0xff);
913 usleep_range(10000, 20000); /*
914 * Exact value is not available. 10 - 20ms
915 * appears to be enough for reset.
916 */
917 ret = lp5523_detect(client);
918 if (ret)
919 goto fail2;
920
921 dev_info(&client->dev, "LP5523 Programmable led chip found\n");
922
923 /* Initialize engines */
924 for (i = 0; i < ARRAY_SIZE(chip->engines); i++) {
925 ret = lp5523_init_engine(&chip->engines[i], i + 1);
926 if (ret) {
927 dev_err(&client->dev, "error initializing engine\n");
928 goto fail2;
929 }
930 }
931 ret = lp5523_configure(client);
932 if (ret < 0) {
933 dev_err(&client->dev, "error configuring chip\n");
934 goto fail2;
935 }
936
937 /* Initialize leds */
938 chip->num_channels = pdata->num_channels;
939 chip->num_leds = 0;
940 led = 0;
941 for (i = 0; i < pdata->num_channels; i++) {
942 /* Do not initialize channels that are not connected */
943 if (pdata->led_config[i].led_current == 0)
944 continue;
945
946 ret = lp5523_init_led(&chip->leds[led], &client->dev, i, pdata);
947 if (ret) {
948 dev_err(&client->dev, "error initializing leds\n");
949 goto fail3;
950 }
951 chip->num_leds++;
952
953 chip->leds[led].id = led;
954 /* Set LED current */
955 lp5523_write(client,
956 LP5523_REG_LED_CURRENT_BASE + chip->leds[led].chan_nr,
957 chip->leds[led].led_current);
958
959 INIT_WORK(&(chip->leds[led].brightness_work),
960 lp5523_led_brightness_work);
961
962 led++;
963 }
964
965 ret = lp5523_register_sysfs(client);
966 if (ret) {
967 dev_err(&client->dev, "registering sysfs failed\n");
968 goto fail3;
969 }
970 return ret;
971fail3:
972 for (i = 0; i < chip->num_leds; i++) {
973 led_classdev_unregister(&chip->leds[i].cdev);
974 cancel_work_sync(&chip->leds[i].brightness_work);
975 }
976fail2:
977 if (pdata->enable)
978 pdata->enable(0);
979 if (pdata->release_resources)
980 pdata->release_resources();
981fail1:
982 kfree(chip);
983 return ret;
984}
985
986static int lp5523_remove(struct i2c_client *client)
987{
988 struct lp5523_chip *chip = i2c_get_clientdata(client);
989 int i;
990
991 lp5523_unregister_sysfs(client);
992
993 for (i = 0; i < chip->num_leds; i++) {
994 led_classdev_unregister(&chip->leds[i].cdev);
995 cancel_work_sync(&chip->leds[i].brightness_work);
996 }
997
998 if (chip->pdata->enable)
999 chip->pdata->enable(0);
1000 if (chip->pdata->release_resources)
1001 chip->pdata->release_resources();
1002 kfree(chip);
1003 return 0;
1004}
1005
1006static const struct i2c_device_id lp5523_id[] = {
1007 { "lp5523", 0 },
1008 { }
1009};
1010
1011MODULE_DEVICE_TABLE(i2c, lp5523_id);
1012
1013static struct i2c_driver lp5523_driver = {
1014 .driver = {
1015 .name = "lp5523",
1016 },
1017 .probe = lp5523_probe,
1018 .remove = lp5523_remove,
1019 .id_table = lp5523_id,
1020};
1021
1022module_i2c_driver(lp5523_driver);
1023
1024MODULE_AUTHOR("Mathias Nyman <mathias.nyman@nokia.com>");
1025MODULE_DESCRIPTION("LP5523 LED engine");
1026MODULE_LICENSE("GPL");
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");