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/*
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");