GNU Linux-libre 4.4.297-gnu1
[releases.git] / drivers / leds / leds-lp5562.c
1 /*
2  * LP5562 LED driver
3  *
4  * Copyright (C) 2013 Texas Instruments
5  *
6  * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #include <linux/delay.h>
14 #include <linux/firmware.h>
15 #include <linux/i2c.h>
16 #include <linux/leds.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/of.h>
20 #include <linux/platform_data/leds-lp55xx.h>
21 #include <linux/slab.h>
22
23 #include "leds-lp55xx-common.h"
24
25 #define LP5562_PROGRAM_LENGTH           32
26 #define LP5562_MAX_LEDS                 4
27
28 /* ENABLE Register 00h */
29 #define LP5562_REG_ENABLE               0x00
30 #define LP5562_EXEC_ENG1_M              0x30
31 #define LP5562_EXEC_ENG2_M              0x0C
32 #define LP5562_EXEC_ENG3_M              0x03
33 #define LP5562_EXEC_M                   0x3F
34 #define LP5562_MASTER_ENABLE            0x40    /* Chip master enable */
35 #define LP5562_LOGARITHMIC_PWM          0x80    /* Logarithmic PWM adjustment */
36 #define LP5562_EXEC_RUN                 0x2A
37 #define LP5562_ENABLE_DEFAULT   \
38         (LP5562_MASTER_ENABLE | LP5562_LOGARITHMIC_PWM)
39 #define LP5562_ENABLE_RUN_PROGRAM       \
40         (LP5562_ENABLE_DEFAULT | LP5562_EXEC_RUN)
41
42 /* OPMODE Register 01h */
43 #define LP5562_REG_OP_MODE              0x01
44 #define LP5562_MODE_ENG1_M              0x30
45 #define LP5562_MODE_ENG2_M              0x0C
46 #define LP5562_MODE_ENG3_M              0x03
47 #define LP5562_LOAD_ENG1                0x10
48 #define LP5562_LOAD_ENG2                0x04
49 #define LP5562_LOAD_ENG3                0x01
50 #define LP5562_RUN_ENG1                 0x20
51 #define LP5562_RUN_ENG2                 0x08
52 #define LP5562_RUN_ENG3                 0x02
53 #define LP5562_ENG1_IS_LOADING(mode)    \
54         ((mode & LP5562_MODE_ENG1_M) == LP5562_LOAD_ENG1)
55 #define LP5562_ENG2_IS_LOADING(mode)    \
56         ((mode & LP5562_MODE_ENG2_M) == LP5562_LOAD_ENG2)
57 #define LP5562_ENG3_IS_LOADING(mode)    \
58         ((mode & LP5562_MODE_ENG3_M) == LP5562_LOAD_ENG3)
59
60 /* BRIGHTNESS Registers */
61 #define LP5562_REG_R_PWM                0x04
62 #define LP5562_REG_G_PWM                0x03
63 #define LP5562_REG_B_PWM                0x02
64 #define LP5562_REG_W_PWM                0x0E
65
66 /* CURRENT Registers */
67 #define LP5562_REG_R_CURRENT            0x07
68 #define LP5562_REG_G_CURRENT            0x06
69 #define LP5562_REG_B_CURRENT            0x05
70 #define LP5562_REG_W_CURRENT            0x0F
71
72 /* CONFIG Register 08h */
73 #define LP5562_REG_CONFIG               0x08
74 #define LP5562_PWM_HF                   0x40
75 #define LP5562_PWRSAVE_EN               0x20
76 #define LP5562_CLK_INT                  0x01    /* Internal clock */
77 #define LP5562_DEFAULT_CFG              (LP5562_PWM_HF | LP5562_PWRSAVE_EN)
78
79 /* RESET Register 0Dh */
80 #define LP5562_REG_RESET                0x0D
81 #define LP5562_RESET                    0xFF
82
83 /* PROGRAM ENGINE Registers */
84 #define LP5562_REG_PROG_MEM_ENG1        0x10
85 #define LP5562_REG_PROG_MEM_ENG2        0x30
86 #define LP5562_REG_PROG_MEM_ENG3        0x50
87
88 /* LEDMAP Register 70h */
89 #define LP5562_REG_ENG_SEL              0x70
90 #define LP5562_ENG_SEL_PWM              0
91 #define LP5562_ENG_FOR_RGB_M            0x3F
92 #define LP5562_ENG_SEL_RGB              0x1B    /* R:ENG1, G:ENG2, B:ENG3 */
93 #define LP5562_ENG_FOR_W_M              0xC0
94 #define LP5562_ENG1_FOR_W               0x40    /* W:ENG1 */
95 #define LP5562_ENG2_FOR_W               0x80    /* W:ENG2 */
96 #define LP5562_ENG3_FOR_W               0xC0    /* W:ENG3 */
97
98 /* Program Commands */
99 #define LP5562_CMD_DISABLE              0x00
100 #define LP5562_CMD_LOAD                 0x15
101 #define LP5562_CMD_RUN                  0x2A
102 #define LP5562_CMD_DIRECT               0x3F
103 #define LP5562_PATTERN_OFF              0
104
105 static inline void lp5562_wait_opmode_done(void)
106 {
107         /* operation mode change needs to be longer than 153 us */
108         usleep_range(200, 300);
109 }
110
111 static inline void lp5562_wait_enable_done(void)
112 {
113         /* it takes more 488 us to update ENABLE register */
114         usleep_range(500, 600);
115 }
116
117 static void lp5562_set_led_current(struct lp55xx_led *led, u8 led_current)
118 {
119         u8 addr[] = {
120                 LP5562_REG_R_CURRENT,
121                 LP5562_REG_G_CURRENT,
122                 LP5562_REG_B_CURRENT,
123                 LP5562_REG_W_CURRENT,
124         };
125
126         led->led_current = led_current;
127         lp55xx_write(led->chip, addr[led->chan_nr], led_current);
128 }
129
130 static void lp5562_load_engine(struct lp55xx_chip *chip)
131 {
132         enum lp55xx_engine_index idx = chip->engine_idx;
133         u8 mask[] = {
134                 [LP55XX_ENGINE_1] = LP5562_MODE_ENG1_M,
135                 [LP55XX_ENGINE_2] = LP5562_MODE_ENG2_M,
136                 [LP55XX_ENGINE_3] = LP5562_MODE_ENG3_M,
137         };
138
139         u8 val[] = {
140                 [LP55XX_ENGINE_1] = LP5562_LOAD_ENG1,
141                 [LP55XX_ENGINE_2] = LP5562_LOAD_ENG2,
142                 [LP55XX_ENGINE_3] = LP5562_LOAD_ENG3,
143         };
144
145         lp55xx_update_bits(chip, LP5562_REG_OP_MODE, mask[idx], val[idx]);
146
147         lp5562_wait_opmode_done();
148 }
149
150 static void lp5562_stop_engine(struct lp55xx_chip *chip)
151 {
152         lp55xx_write(chip, LP5562_REG_OP_MODE, LP5562_CMD_DISABLE);
153         lp5562_wait_opmode_done();
154 }
155
156 static void lp5562_run_engine(struct lp55xx_chip *chip, bool start)
157 {
158         int ret;
159         u8 mode;
160         u8 exec;
161
162         /* stop engine */
163         if (!start) {
164                 lp55xx_write(chip, LP5562_REG_ENABLE, LP5562_ENABLE_DEFAULT);
165                 lp5562_wait_enable_done();
166                 lp5562_stop_engine(chip);
167                 lp55xx_write(chip, LP5562_REG_ENG_SEL, LP5562_ENG_SEL_PWM);
168                 lp55xx_write(chip, LP5562_REG_OP_MODE, LP5562_CMD_DIRECT);
169                 lp5562_wait_opmode_done();
170                 return;
171         }
172
173         /*
174          * To run the engine,
175          * operation mode and enable register should updated at the same time
176          */
177
178         ret = lp55xx_read(chip, LP5562_REG_OP_MODE, &mode);
179         if (ret)
180                 return;
181
182         ret = lp55xx_read(chip, LP5562_REG_ENABLE, &exec);
183         if (ret)
184                 return;
185
186         /* change operation mode to RUN only when each engine is loading */
187         if (LP5562_ENG1_IS_LOADING(mode)) {
188                 mode = (mode & ~LP5562_MODE_ENG1_M) | LP5562_RUN_ENG1;
189                 exec = (exec & ~LP5562_EXEC_ENG1_M) | LP5562_RUN_ENG1;
190         }
191
192         if (LP5562_ENG2_IS_LOADING(mode)) {
193                 mode = (mode & ~LP5562_MODE_ENG2_M) | LP5562_RUN_ENG2;
194                 exec = (exec & ~LP5562_EXEC_ENG2_M) | LP5562_RUN_ENG2;
195         }
196
197         if (LP5562_ENG3_IS_LOADING(mode)) {
198                 mode = (mode & ~LP5562_MODE_ENG3_M) | LP5562_RUN_ENG3;
199                 exec = (exec & ~LP5562_EXEC_ENG3_M) | LP5562_RUN_ENG3;
200         }
201
202         lp55xx_write(chip, LP5562_REG_OP_MODE, mode);
203         lp5562_wait_opmode_done();
204
205         lp55xx_update_bits(chip, LP5562_REG_ENABLE, LP5562_EXEC_M, exec);
206         lp5562_wait_enable_done();
207 }
208
209 static int lp5562_update_firmware(struct lp55xx_chip *chip,
210                                         const u8 *data, size_t size)
211 {
212         enum lp55xx_engine_index idx = chip->engine_idx;
213         u8 pattern[LP5562_PROGRAM_LENGTH] = {0};
214         u8 addr[] = {
215                 [LP55XX_ENGINE_1] = LP5562_REG_PROG_MEM_ENG1,
216                 [LP55XX_ENGINE_2] = LP5562_REG_PROG_MEM_ENG2,
217                 [LP55XX_ENGINE_3] = LP5562_REG_PROG_MEM_ENG3,
218         };
219         unsigned cmd;
220         char c[3];
221         int program_size;
222         int nrchars;
223         int offset = 0;
224         int ret;
225         int i;
226
227         /* clear program memory before updating */
228         for (i = 0; i < LP5562_PROGRAM_LENGTH; i++)
229                 lp55xx_write(chip, addr[idx] + i, 0);
230
231         i = 0;
232         while ((offset < size - 1) && (i < LP5562_PROGRAM_LENGTH)) {
233                 /* separate sscanfs because length is working only for %s */
234                 ret = sscanf(data + offset, "%2s%n ", c, &nrchars);
235                 if (ret != 1)
236                         goto err;
237
238                 ret = sscanf(c, "%2x", &cmd);
239                 if (ret != 1)
240                         goto err;
241
242                 pattern[i] = (u8)cmd;
243                 offset += nrchars;
244                 i++;
245         }
246
247         /* Each instruction is 16bit long. Check that length is even */
248         if (i % 2)
249                 goto err;
250
251         program_size = i;
252         for (i = 0; i < program_size; i++)
253                 lp55xx_write(chip, addr[idx] + i, pattern[i]);
254
255         return 0;
256
257 err:
258         dev_err(&chip->cl->dev, "wrong pattern format\n");
259         return -EINVAL;
260 }
261
262 static void lp5562_firmware_loaded(struct lp55xx_chip *chip)
263 {
264         const struct firmware *fw = chip->fw;
265
266         /*
267          * the firmware is encoded in ascii hex character, with 2 chars
268          * per byte
269          */
270         if (fw->size > (LP5562_PROGRAM_LENGTH * 2)) {
271                 dev_err(&chip->cl->dev, "firmware data size overflow: %zu\n",
272                         fw->size);
273                 return;
274         }
275
276         /*
277          * Program momery sequence
278          *  1) set engine mode to "LOAD"
279          *  2) write firmware data into program memory
280          */
281
282         lp5562_load_engine(chip);
283         lp5562_update_firmware(chip, fw->data, fw->size);
284 }
285
286 static int lp5562_post_init_device(struct lp55xx_chip *chip)
287 {
288         int ret;
289         u8 cfg = LP5562_DEFAULT_CFG;
290
291         /* Set all PWMs to direct control mode */
292         ret = lp55xx_write(chip, LP5562_REG_OP_MODE, LP5562_CMD_DIRECT);
293         if (ret)
294                 return ret;
295
296         lp5562_wait_opmode_done();
297
298         /* Update configuration for the clock setting */
299         if (!lp55xx_is_extclk_used(chip))
300                 cfg |= LP5562_CLK_INT;
301
302         ret = lp55xx_write(chip, LP5562_REG_CONFIG, cfg);
303         if (ret)
304                 return ret;
305
306         /* Initialize all channels PWM to zero -> leds off */
307         lp55xx_write(chip, LP5562_REG_R_PWM, 0);
308         lp55xx_write(chip, LP5562_REG_G_PWM, 0);
309         lp55xx_write(chip, LP5562_REG_B_PWM, 0);
310         lp55xx_write(chip, LP5562_REG_W_PWM, 0);
311
312         /* Set LED map as register PWM by default */
313         lp55xx_write(chip, LP5562_REG_ENG_SEL, LP5562_ENG_SEL_PWM);
314
315         return 0;
316 }
317
318 static void lp5562_led_brightness_work(struct work_struct *work)
319 {
320         struct lp55xx_led *led = container_of(work, struct lp55xx_led,
321                                               brightness_work);
322         struct lp55xx_chip *chip = led->chip;
323         u8 addr[] = {
324                 LP5562_REG_R_PWM,
325                 LP5562_REG_G_PWM,
326                 LP5562_REG_B_PWM,
327                 LP5562_REG_W_PWM,
328         };
329
330         mutex_lock(&chip->lock);
331         lp55xx_write(chip, addr[led->chan_nr], led->brightness);
332         mutex_unlock(&chip->lock);
333 }
334
335 static void lp5562_write_program_memory(struct lp55xx_chip *chip,
336                                         u8 base, const u8 *rgb, int size)
337 {
338         int i;
339
340         if (!rgb || size <= 0)
341                 return;
342
343         for (i = 0; i < size; i++)
344                 lp55xx_write(chip, base + i, *(rgb + i));
345
346         lp55xx_write(chip, base + i, 0);
347         lp55xx_write(chip, base + i + 1, 0);
348 }
349
350 /* check the size of program count */
351 static inline bool _is_pc_overflow(struct lp55xx_predef_pattern *ptn)
352 {
353         return ptn->size_r >= LP5562_PROGRAM_LENGTH ||
354                ptn->size_g >= LP5562_PROGRAM_LENGTH ||
355                ptn->size_b >= LP5562_PROGRAM_LENGTH;
356 }
357
358 static int lp5562_run_predef_led_pattern(struct lp55xx_chip *chip, int mode)
359 {
360         struct lp55xx_predef_pattern *ptn;
361         int i;
362
363         if (mode == LP5562_PATTERN_OFF) {
364                 lp5562_run_engine(chip, false);
365                 return 0;
366         }
367
368         ptn = chip->pdata->patterns + (mode - 1);
369         if (!ptn || _is_pc_overflow(ptn)) {
370                 dev_err(&chip->cl->dev, "invalid pattern data\n");
371                 return -EINVAL;
372         }
373
374         lp5562_stop_engine(chip);
375
376         /* Set LED map as RGB */
377         lp55xx_write(chip, LP5562_REG_ENG_SEL, LP5562_ENG_SEL_RGB);
378
379         /* Load engines */
380         for (i = LP55XX_ENGINE_1; i <= LP55XX_ENGINE_3; i++) {
381                 chip->engine_idx = i;
382                 lp5562_load_engine(chip);
383         }
384
385         /* Clear program registers */
386         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG1, 0);
387         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG1 + 1, 0);
388         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG2, 0);
389         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG2 + 1, 0);
390         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG3, 0);
391         lp55xx_write(chip, LP5562_REG_PROG_MEM_ENG3 + 1, 0);
392
393         /* Program engines */
394         lp5562_write_program_memory(chip, LP5562_REG_PROG_MEM_ENG1,
395                                 ptn->r, ptn->size_r);
396         lp5562_write_program_memory(chip, LP5562_REG_PROG_MEM_ENG2,
397                                 ptn->g, ptn->size_g);
398         lp5562_write_program_memory(chip, LP5562_REG_PROG_MEM_ENG3,
399                                 ptn->b, ptn->size_b);
400
401         /* Run engines */
402         lp5562_run_engine(chip, true);
403
404         return 0;
405 }
406
407 static ssize_t lp5562_store_pattern(struct device *dev,
408                                 struct device_attribute *attr,
409                                 const char *buf, size_t len)
410 {
411         struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
412         struct lp55xx_chip *chip = led->chip;
413         struct lp55xx_predef_pattern *ptn = chip->pdata->patterns;
414         int num_patterns = chip->pdata->num_patterns;
415         unsigned long mode;
416         int ret;
417
418         ret = kstrtoul(buf, 0, &mode);
419         if (ret)
420                 return ret;
421
422         if (mode > num_patterns || !ptn)
423                 return -EINVAL;
424
425         mutex_lock(&chip->lock);
426         ret = lp5562_run_predef_led_pattern(chip, mode);
427         mutex_unlock(&chip->lock);
428
429         if (ret)
430                 return ret;
431
432         return len;
433 }
434
435 static ssize_t lp5562_store_engine_mux(struct device *dev,
436                                      struct device_attribute *attr,
437                                      const char *buf, size_t len)
438 {
439         struct lp55xx_led *led = i2c_get_clientdata(to_i2c_client(dev));
440         struct lp55xx_chip *chip = led->chip;
441         u8 mask;
442         u8 val;
443
444         /* LED map
445          * R ... Engine 1 (fixed)
446          * G ... Engine 2 (fixed)
447          * B ... Engine 3 (fixed)
448          * W ... Engine 1 or 2 or 3
449          */
450
451         if (sysfs_streq(buf, "RGB")) {
452                 mask = LP5562_ENG_FOR_RGB_M;
453                 val = LP5562_ENG_SEL_RGB;
454         } else if (sysfs_streq(buf, "W")) {
455                 enum lp55xx_engine_index idx = chip->engine_idx;
456
457                 mask = LP5562_ENG_FOR_W_M;
458                 switch (idx) {
459                 case LP55XX_ENGINE_1:
460                         val = LP5562_ENG1_FOR_W;
461                         break;
462                 case LP55XX_ENGINE_2:
463                         val = LP5562_ENG2_FOR_W;
464                         break;
465                 case LP55XX_ENGINE_3:
466                         val = LP5562_ENG3_FOR_W;
467                         break;
468                 default:
469                         return -EINVAL;
470                 }
471
472         } else {
473                 dev_err(dev, "choose RGB or W\n");
474                 return -EINVAL;
475         }
476
477         mutex_lock(&chip->lock);
478         lp55xx_update_bits(chip, LP5562_REG_ENG_SEL, mask, val);
479         mutex_unlock(&chip->lock);
480
481         return len;
482 }
483
484 static LP55XX_DEV_ATTR_WO(led_pattern, lp5562_store_pattern);
485 static LP55XX_DEV_ATTR_WO(engine_mux, lp5562_store_engine_mux);
486
487 static struct attribute *lp5562_attributes[] = {
488         &dev_attr_led_pattern.attr,
489         &dev_attr_engine_mux.attr,
490         NULL,
491 };
492
493 static const struct attribute_group lp5562_group = {
494         .attrs = lp5562_attributes,
495 };
496
497 /* Chip specific configurations */
498 static struct lp55xx_device_config lp5562_cfg = {
499         .max_channel  = LP5562_MAX_LEDS,
500         .reset = {
501                 .addr = LP5562_REG_RESET,
502                 .val  = LP5562_RESET,
503         },
504         .enable = {
505                 .addr = LP5562_REG_ENABLE,
506                 .val  = LP5562_ENABLE_DEFAULT,
507         },
508         .post_init_device   = lp5562_post_init_device,
509         .set_led_current    = lp5562_set_led_current,
510         .brightness_work_fn = lp5562_led_brightness_work,
511         .run_engine         = lp5562_run_engine,
512         .firmware_cb        = lp5562_firmware_loaded,
513         .dev_attr_group     = &lp5562_group,
514 };
515
516 static int lp5562_probe(struct i2c_client *client,
517                         const struct i2c_device_id *id)
518 {
519         int ret;
520         struct lp55xx_chip *chip;
521         struct lp55xx_led *led;
522         struct lp55xx_platform_data *pdata = dev_get_platdata(&client->dev);
523         struct device_node *np = client->dev.of_node;
524
525         if (!pdata) {
526                 if (np) {
527                         pdata = lp55xx_of_populate_pdata(&client->dev, np);
528                         if (IS_ERR(pdata))
529                                 return PTR_ERR(pdata);
530                 } else {
531                         dev_err(&client->dev, "no platform data\n");
532                         return -EINVAL;
533                 }
534         }
535
536         chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
537         if (!chip)
538                 return -ENOMEM;
539
540         led = devm_kzalloc(&client->dev,
541                         sizeof(*led) * pdata->num_channels, GFP_KERNEL);
542         if (!led)
543                 return -ENOMEM;
544
545         chip->cl = client;
546         chip->pdata = pdata;
547         chip->cfg = &lp5562_cfg;
548
549         mutex_init(&chip->lock);
550
551         i2c_set_clientdata(client, led);
552
553         ret = lp55xx_init_device(chip);
554         if (ret)
555                 goto err_init;
556
557         ret = lp55xx_register_leds(led, chip);
558         if (ret)
559                 goto err_register_leds;
560
561         ret = lp55xx_register_sysfs(chip);
562         if (ret) {
563                 dev_err(&client->dev, "registering sysfs failed\n");
564                 goto err_register_sysfs;
565         }
566
567         return 0;
568
569 err_register_sysfs:
570         lp55xx_unregister_leds(led, chip);
571 err_register_leds:
572         lp55xx_deinit_device(chip);
573 err_init:
574         return ret;
575 }
576
577 static int lp5562_remove(struct i2c_client *client)
578 {
579         struct lp55xx_led *led = i2c_get_clientdata(client);
580         struct lp55xx_chip *chip = led->chip;
581
582         lp5562_stop_engine(chip);
583
584         lp55xx_unregister_sysfs(chip);
585         lp55xx_unregister_leds(led, chip);
586         lp55xx_deinit_device(chip);
587
588         return 0;
589 }
590
591 static const struct i2c_device_id lp5562_id[] = {
592         { "lp5562", 0 },
593         { }
594 };
595 MODULE_DEVICE_TABLE(i2c, lp5562_id);
596
597 #ifdef CONFIG_OF
598 static const struct of_device_id of_lp5562_leds_match[] = {
599         { .compatible = "ti,lp5562", },
600         {},
601 };
602
603 MODULE_DEVICE_TABLE(of, of_lp5562_leds_match);
604 #endif
605
606 static struct i2c_driver lp5562_driver = {
607         .driver = {
608                 .name   = "lp5562",
609                 .of_match_table = of_match_ptr(of_lp5562_leds_match),
610         },
611         .probe          = lp5562_probe,
612         .remove         = lp5562_remove,
613         .id_table       = lp5562_id,
614 };
615
616 module_i2c_driver(lp5562_driver);
617
618 MODULE_DESCRIPTION("Texas Instruments LP5562 LED Driver");
619 MODULE_AUTHOR("Milo Kim");
620 MODULE_LICENSE("GPL");