GNU Linux-libre 5.10.217-gnu1
[releases.git] / drivers / video / backlight / lm3630a_bl.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Simple driver for Texas Instruments LM3630A Backlight driver chip
4 * Copyright (C) 2012 Texas Instruments
5 */
6 #include <linux/module.h>
7 #include <linux/slab.h>
8 #include <linux/i2c.h>
9 #include <linux/backlight.h>
10 #include <linux/err.h>
11 #include <linux/delay.h>
12 #include <linux/uaccess.h>
13 #include <linux/interrupt.h>
14 #include <linux/regmap.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/pwm.h>
17 #include <linux/platform_data/lm3630a_bl.h>
18
19 #define REG_CTRL        0x00
20 #define REG_BOOST       0x02
21 #define REG_CONFIG      0x01
22 #define REG_BRT_A       0x03
23 #define REG_BRT_B       0x04
24 #define REG_I_A         0x05
25 #define REG_I_B         0x06
26 #define REG_INT_STATUS  0x09
27 #define REG_INT_EN      0x0A
28 #define REG_FAULT       0x0B
29 #define REG_PWM_OUTLOW  0x12
30 #define REG_PWM_OUTHIGH 0x13
31 #define REG_FILTER_STRENGTH     0x50
32 #define REG_MAX         0x50
33
34 #define INT_DEBOUNCE_MSEC       10
35
36 #define LM3630A_BANK_0          0
37 #define LM3630A_BANK_1          1
38
39 #define LM3630A_NUM_SINKS       2
40 #define LM3630A_SINK_0          0
41 #define LM3630A_SINK_1          1
42
43 struct lm3630a_chip {
44         struct device *dev;
45         struct delayed_work work;
46
47         int irq;
48         struct workqueue_struct *irqthread;
49         struct lm3630a_platform_data *pdata;
50         struct backlight_device *bleda;
51         struct backlight_device *bledb;
52         struct gpio_desc *enable_gpio;
53         struct regmap *regmap;
54         struct pwm_device *pwmd;
55 };
56
57 /* i2c access */
58 static int lm3630a_read(struct lm3630a_chip *pchip, unsigned int reg)
59 {
60         int rval;
61         unsigned int reg_val;
62
63         rval = regmap_read(pchip->regmap, reg, &reg_val);
64         if (rval < 0)
65                 return rval;
66         return reg_val & 0xFF;
67 }
68
69 static int lm3630a_write(struct lm3630a_chip *pchip,
70                          unsigned int reg, unsigned int data)
71 {
72         return regmap_write(pchip->regmap, reg, data);
73 }
74
75 static int lm3630a_update(struct lm3630a_chip *pchip,
76                           unsigned int reg, unsigned int mask,
77                           unsigned int data)
78 {
79         return regmap_update_bits(pchip->regmap, reg, mask, data);
80 }
81
82 /* initialize chip */
83 static int lm3630a_chip_init(struct lm3630a_chip *pchip)
84 {
85         int rval;
86         struct lm3630a_platform_data *pdata = pchip->pdata;
87
88         usleep_range(1000, 2000);
89         /* set Filter Strength Register */
90         rval = lm3630a_write(pchip, REG_FILTER_STRENGTH, 0x03);
91         /* set Cofig. register */
92         rval |= lm3630a_update(pchip, REG_CONFIG, 0x07, pdata->pwm_ctrl);
93         /* set boost control */
94         rval |= lm3630a_write(pchip, REG_BOOST, 0x38);
95         /* set current A */
96         rval |= lm3630a_update(pchip, REG_I_A, 0x1F, 0x1F);
97         /* set current B */
98         rval |= lm3630a_write(pchip, REG_I_B, 0x1F);
99         /* set control */
100         rval |= lm3630a_update(pchip, REG_CTRL, 0x14, pdata->leda_ctrl);
101         rval |= lm3630a_update(pchip, REG_CTRL, 0x0B, pdata->ledb_ctrl);
102         usleep_range(1000, 2000);
103         /* set brightness A and B */
104         rval |= lm3630a_write(pchip, REG_BRT_A, pdata->leda_init_brt);
105         rval |= lm3630a_write(pchip, REG_BRT_B, pdata->ledb_init_brt);
106
107         if (rval < 0)
108                 dev_err(pchip->dev, "i2c failed to access register\n");
109         return rval;
110 }
111
112 /* interrupt handling */
113 static void lm3630a_delayed_func(struct work_struct *work)
114 {
115         int rval;
116         struct lm3630a_chip *pchip;
117
118         pchip = container_of(work, struct lm3630a_chip, work.work);
119
120         rval = lm3630a_read(pchip, REG_INT_STATUS);
121         if (rval < 0) {
122                 dev_err(pchip->dev,
123                         "i2c failed to access REG_INT_STATUS Register\n");
124                 return;
125         }
126
127         dev_info(pchip->dev, "REG_INT_STATUS Register is 0x%x\n", rval);
128 }
129
130 static irqreturn_t lm3630a_isr_func(int irq, void *chip)
131 {
132         int rval;
133         struct lm3630a_chip *pchip = chip;
134         unsigned long delay = msecs_to_jiffies(INT_DEBOUNCE_MSEC);
135
136         queue_delayed_work(pchip->irqthread, &pchip->work, delay);
137
138         rval = lm3630a_update(pchip, REG_CTRL, 0x80, 0x00);
139         if (rval < 0) {
140                 dev_err(pchip->dev, "i2c failed to access register\n");
141                 return IRQ_NONE;
142         }
143         return IRQ_HANDLED;
144 }
145
146 static int lm3630a_intr_config(struct lm3630a_chip *pchip)
147 {
148         int rval;
149
150         rval = lm3630a_write(pchip, REG_INT_EN, 0x87);
151         if (rval < 0)
152                 return rval;
153
154         INIT_DELAYED_WORK(&pchip->work, lm3630a_delayed_func);
155         pchip->irqthread = create_singlethread_workqueue("lm3630a-irqthd");
156         if (!pchip->irqthread) {
157                 dev_err(pchip->dev, "create irq thread fail\n");
158                 return -ENOMEM;
159         }
160         if (request_threaded_irq
161             (pchip->irq, NULL, lm3630a_isr_func,
162              IRQF_TRIGGER_FALLING | IRQF_ONESHOT, "lm3630a_irq", pchip)) {
163                 dev_err(pchip->dev, "request threaded irq fail\n");
164                 destroy_workqueue(pchip->irqthread);
165                 return -ENOMEM;
166         }
167         return rval;
168 }
169
170 static void lm3630a_pwm_ctrl(struct lm3630a_chip *pchip, int br, int br_max)
171 {
172         unsigned int period = pchip->pdata->pwm_period;
173         unsigned int duty = br * period / br_max;
174
175         pwm_config(pchip->pwmd, duty, period);
176         if (duty)
177                 pwm_enable(pchip->pwmd);
178         else
179                 pwm_disable(pchip->pwmd);
180 }
181
182 /* update and get brightness */
183 static int lm3630a_bank_a_update_status(struct backlight_device *bl)
184 {
185         int ret;
186         struct lm3630a_chip *pchip = bl_get_data(bl);
187         enum lm3630a_pwm_ctrl pwm_ctrl = pchip->pdata->pwm_ctrl;
188
189         /* pwm control */
190         if ((pwm_ctrl & LM3630A_PWM_BANK_A) != 0) {
191                 lm3630a_pwm_ctrl(pchip, bl->props.brightness,
192                                  bl->props.max_brightness);
193                 return 0;
194         }
195
196         /* disable sleep */
197         ret = lm3630a_update(pchip, REG_CTRL, 0x80, 0x00);
198         if (ret < 0)
199                 goto out_i2c_err;
200         usleep_range(1000, 2000);
201         /* minimum brightness is 0x04 */
202         ret = lm3630a_write(pchip, REG_BRT_A, bl->props.brightness);
203         if (bl->props.brightness < 0x4)
204                 ret |= lm3630a_update(pchip, REG_CTRL, LM3630A_LEDA_ENABLE, 0);
205         else
206                 ret |= lm3630a_update(pchip, REG_CTRL,
207                                       LM3630A_LEDA_ENABLE, LM3630A_LEDA_ENABLE);
208         if (ret < 0)
209                 goto out_i2c_err;
210         return 0;
211
212 out_i2c_err:
213         dev_err(pchip->dev, "i2c failed to access (%pe)\n", ERR_PTR(ret));
214         return ret;
215 }
216
217 static int lm3630a_bank_a_get_brightness(struct backlight_device *bl)
218 {
219         int brightness, rval;
220         struct lm3630a_chip *pchip = bl_get_data(bl);
221         enum lm3630a_pwm_ctrl pwm_ctrl = pchip->pdata->pwm_ctrl;
222
223         if ((pwm_ctrl & LM3630A_PWM_BANK_A) != 0) {
224                 rval = lm3630a_read(pchip, REG_PWM_OUTHIGH);
225                 if (rval < 0)
226                         goto out_i2c_err;
227                 brightness = (rval & 0x01) << 8;
228                 rval = lm3630a_read(pchip, REG_PWM_OUTLOW);
229                 if (rval < 0)
230                         goto out_i2c_err;
231                 brightness |= rval;
232                 return brightness;
233         }
234
235         /* disable sleep */
236         rval = lm3630a_update(pchip, REG_CTRL, 0x80, 0x00);
237         if (rval < 0)
238                 goto out_i2c_err;
239         usleep_range(1000, 2000);
240         rval = lm3630a_read(pchip, REG_BRT_A);
241         if (rval < 0)
242                 goto out_i2c_err;
243         return rval;
244
245 out_i2c_err:
246         dev_err(pchip->dev, "i2c failed to access register\n");
247         return 0;
248 }
249
250 static const struct backlight_ops lm3630a_bank_a_ops = {
251         .options = BL_CORE_SUSPENDRESUME,
252         .update_status = lm3630a_bank_a_update_status,
253         .get_brightness = lm3630a_bank_a_get_brightness,
254 };
255
256 /* update and get brightness */
257 static int lm3630a_bank_b_update_status(struct backlight_device *bl)
258 {
259         int ret;
260         struct lm3630a_chip *pchip = bl_get_data(bl);
261         enum lm3630a_pwm_ctrl pwm_ctrl = pchip->pdata->pwm_ctrl;
262
263         /* pwm control */
264         if ((pwm_ctrl & LM3630A_PWM_BANK_B) != 0) {
265                 lm3630a_pwm_ctrl(pchip, bl->props.brightness,
266                                  bl->props.max_brightness);
267                 return 0;
268         }
269
270         /* disable sleep */
271         ret = lm3630a_update(pchip, REG_CTRL, 0x80, 0x00);
272         if (ret < 0)
273                 goto out_i2c_err;
274         usleep_range(1000, 2000);
275         /* minimum brightness is 0x04 */
276         ret = lm3630a_write(pchip, REG_BRT_B, bl->props.brightness);
277         if (bl->props.brightness < 0x4)
278                 ret |= lm3630a_update(pchip, REG_CTRL, LM3630A_LEDB_ENABLE, 0);
279         else
280                 ret |= lm3630a_update(pchip, REG_CTRL,
281                                       LM3630A_LEDB_ENABLE, LM3630A_LEDB_ENABLE);
282         if (ret < 0)
283                 goto out_i2c_err;
284         return 0;
285
286 out_i2c_err:
287         dev_err(pchip->dev, "i2c failed to access (%pe)\n", ERR_PTR(ret));
288         return ret;
289 }
290
291 static int lm3630a_bank_b_get_brightness(struct backlight_device *bl)
292 {
293         int brightness, rval;
294         struct lm3630a_chip *pchip = bl_get_data(bl);
295         enum lm3630a_pwm_ctrl pwm_ctrl = pchip->pdata->pwm_ctrl;
296
297         if ((pwm_ctrl & LM3630A_PWM_BANK_B) != 0) {
298                 rval = lm3630a_read(pchip, REG_PWM_OUTHIGH);
299                 if (rval < 0)
300                         goto out_i2c_err;
301                 brightness = (rval & 0x01) << 8;
302                 rval = lm3630a_read(pchip, REG_PWM_OUTLOW);
303                 if (rval < 0)
304                         goto out_i2c_err;
305                 brightness |= rval;
306                 return brightness;
307         }
308
309         /* disable sleep */
310         rval = lm3630a_update(pchip, REG_CTRL, 0x80, 0x00);
311         if (rval < 0)
312                 goto out_i2c_err;
313         usleep_range(1000, 2000);
314         rval = lm3630a_read(pchip, REG_BRT_B);
315         if (rval < 0)
316                 goto out_i2c_err;
317         return rval;
318
319 out_i2c_err:
320         dev_err(pchip->dev, "i2c failed to access register\n");
321         return 0;
322 }
323
324 static const struct backlight_ops lm3630a_bank_b_ops = {
325         .options = BL_CORE_SUSPENDRESUME,
326         .update_status = lm3630a_bank_b_update_status,
327         .get_brightness = lm3630a_bank_b_get_brightness,
328 };
329
330 static int lm3630a_backlight_register(struct lm3630a_chip *pchip)
331 {
332         struct lm3630a_platform_data *pdata = pchip->pdata;
333         struct backlight_properties props;
334         const char *label;
335
336         memset(&props, 0, sizeof(struct backlight_properties));
337         props.type = BACKLIGHT_RAW;
338         if (pdata->leda_ctrl != LM3630A_LEDA_DISABLE) {
339                 props.brightness = pdata->leda_init_brt;
340                 props.max_brightness = pdata->leda_max_brt;
341                 label = pdata->leda_label ? pdata->leda_label : "lm3630a_leda";
342                 pchip->bleda =
343                     devm_backlight_device_register(pchip->dev, label,
344                                                    pchip->dev, pchip,
345                                                    &lm3630a_bank_a_ops, &props);
346                 if (IS_ERR(pchip->bleda))
347                         return PTR_ERR(pchip->bleda);
348         }
349
350         if ((pdata->ledb_ctrl != LM3630A_LEDB_DISABLE) &&
351             (pdata->ledb_ctrl != LM3630A_LEDB_ON_A)) {
352                 props.brightness = pdata->ledb_init_brt;
353                 props.max_brightness = pdata->ledb_max_brt;
354                 label = pdata->ledb_label ? pdata->ledb_label : "lm3630a_ledb";
355                 pchip->bledb =
356                     devm_backlight_device_register(pchip->dev, label,
357                                                    pchip->dev, pchip,
358                                                    &lm3630a_bank_b_ops, &props);
359                 if (IS_ERR(pchip->bledb))
360                         return PTR_ERR(pchip->bledb);
361         }
362         return 0;
363 }
364
365 static const struct regmap_config lm3630a_regmap = {
366         .reg_bits = 8,
367         .val_bits = 8,
368         .max_register = REG_MAX,
369 };
370
371 static int lm3630a_parse_led_sources(struct fwnode_handle *node,
372                                      int default_led_sources)
373 {
374         u32 sources[LM3630A_NUM_SINKS];
375         int ret, num_sources, i;
376
377         num_sources = fwnode_property_count_u32(node, "led-sources");
378         if (num_sources < 0)
379                 return default_led_sources;
380         else if (num_sources > ARRAY_SIZE(sources))
381                 return -EINVAL;
382
383         ret = fwnode_property_read_u32_array(node, "led-sources", sources,
384                                              num_sources);
385         if (ret)
386                 return ret;
387
388         for (i = 0; i < num_sources; i++) {
389                 if (sources[i] != LM3630A_SINK_0 && sources[i] != LM3630A_SINK_1)
390                         return -EINVAL;
391
392                 ret |= BIT(sources[i]);
393         }
394
395         return ret;
396 }
397
398 static int lm3630a_parse_bank(struct lm3630a_platform_data *pdata,
399                               struct fwnode_handle *node, int *seen_led_sources)
400 {
401         int led_sources, ret;
402         const char *label;
403         u32 bank, val;
404         bool linear;
405
406         ret = fwnode_property_read_u32(node, "reg", &bank);
407         if (ret)
408                 return ret;
409
410         if (bank != LM3630A_BANK_0 && bank != LM3630A_BANK_1)
411                 return -EINVAL;
412
413         led_sources = lm3630a_parse_led_sources(node, BIT(bank));
414         if (led_sources < 0)
415                 return led_sources;
416
417         if (*seen_led_sources & led_sources)
418                 return -EINVAL;
419
420         *seen_led_sources |= led_sources;
421
422         linear = fwnode_property_read_bool(node,
423                                            "ti,linear-mapping-mode");
424         if (bank) {
425                 if (led_sources & BIT(LM3630A_SINK_0) ||
426                     !(led_sources & BIT(LM3630A_SINK_1)))
427                         return -EINVAL;
428
429                 pdata->ledb_ctrl = linear ?
430                         LM3630A_LEDB_ENABLE_LINEAR :
431                         LM3630A_LEDB_ENABLE;
432         } else {
433                 if (!(led_sources & BIT(LM3630A_SINK_0)))
434                         return -EINVAL;
435
436                 pdata->leda_ctrl = linear ?
437                         LM3630A_LEDA_ENABLE_LINEAR :
438                         LM3630A_LEDA_ENABLE;
439
440                 if (led_sources & BIT(LM3630A_SINK_1))
441                         pdata->ledb_ctrl = LM3630A_LEDB_ON_A;
442         }
443
444         ret = fwnode_property_read_string(node, "label", &label);
445         if (!ret) {
446                 if (bank)
447                         pdata->ledb_label = label;
448                 else
449                         pdata->leda_label = label;
450         }
451
452         ret = fwnode_property_read_u32(node, "default-brightness",
453                                        &val);
454         if (!ret) {
455                 if (bank)
456                         pdata->ledb_init_brt = val;
457                 else
458                         pdata->leda_init_brt = val;
459         }
460
461         ret = fwnode_property_read_u32(node, "max-brightness", &val);
462         if (!ret) {
463                 if (bank)
464                         pdata->ledb_max_brt = val;
465                 else
466                         pdata->leda_max_brt = val;
467         }
468
469         return 0;
470 }
471
472 static int lm3630a_parse_node(struct lm3630a_chip *pchip,
473                               struct lm3630a_platform_data *pdata)
474 {
475         int ret = -ENODEV, seen_led_sources = 0;
476         struct fwnode_handle *node;
477
478         device_for_each_child_node(pchip->dev, node) {
479                 ret = lm3630a_parse_bank(pdata, node, &seen_led_sources);
480                 if (ret) {
481                         fwnode_handle_put(node);
482                         return ret;
483                 }
484         }
485
486         return ret;
487 }
488
489 static int lm3630a_probe(struct i2c_client *client,
490                          const struct i2c_device_id *id)
491 {
492         struct lm3630a_platform_data *pdata = dev_get_platdata(&client->dev);
493         struct lm3630a_chip *pchip;
494         int rval;
495
496         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
497                 dev_err(&client->dev, "fail : i2c functionality check\n");
498                 return -EOPNOTSUPP;
499         }
500
501         pchip = devm_kzalloc(&client->dev, sizeof(struct lm3630a_chip),
502                              GFP_KERNEL);
503         if (!pchip)
504                 return -ENOMEM;
505         pchip->dev = &client->dev;
506
507         pchip->regmap = devm_regmap_init_i2c(client, &lm3630a_regmap);
508         if (IS_ERR(pchip->regmap)) {
509                 rval = PTR_ERR(pchip->regmap);
510                 dev_err(&client->dev, "fail : allocate reg. map: %d\n", rval);
511                 return rval;
512         }
513
514         i2c_set_clientdata(client, pchip);
515         if (pdata == NULL) {
516                 pdata = devm_kzalloc(pchip->dev,
517                                      sizeof(struct lm3630a_platform_data),
518                                      GFP_KERNEL);
519                 if (pdata == NULL)
520                         return -ENOMEM;
521
522                 /* default values */
523                 pdata->leda_max_brt = LM3630A_MAX_BRIGHTNESS;
524                 pdata->ledb_max_brt = LM3630A_MAX_BRIGHTNESS;
525                 pdata->leda_init_brt = LM3630A_MAX_BRIGHTNESS;
526                 pdata->ledb_init_brt = LM3630A_MAX_BRIGHTNESS;
527
528                 rval = lm3630a_parse_node(pchip, pdata);
529                 if (rval) {
530                         dev_err(&client->dev, "fail : parse node\n");
531                         return rval;
532                 }
533         }
534         pchip->pdata = pdata;
535
536         pchip->enable_gpio = devm_gpiod_get_optional(&client->dev, "enable",
537                                                 GPIOD_OUT_HIGH);
538         if (IS_ERR(pchip->enable_gpio)) {
539                 rval = PTR_ERR(pchip->enable_gpio);
540                 return rval;
541         }
542
543         /* chip initialize */
544         rval = lm3630a_chip_init(pchip);
545         if (rval < 0) {
546                 dev_err(&client->dev, "fail : init chip\n");
547                 return rval;
548         }
549         /* backlight register */
550         rval = lm3630a_backlight_register(pchip);
551         if (rval < 0) {
552                 dev_err(&client->dev, "fail : backlight register.\n");
553                 return rval;
554         }
555         /* pwm */
556         if (pdata->pwm_ctrl != LM3630A_PWM_DISABLE) {
557                 pchip->pwmd = devm_pwm_get(pchip->dev, "lm3630a-pwm");
558                 if (IS_ERR(pchip->pwmd)) {
559                         dev_err(&client->dev, "fail : get pwm device\n");
560                         return PTR_ERR(pchip->pwmd);
561                 }
562
563                 /*
564                  * FIXME: pwm_apply_args() should be removed when switching to
565                  * the atomic PWM API.
566                  */
567                 pwm_apply_args(pchip->pwmd);
568         }
569
570         /* interrupt enable  : irq 0 is not allowed */
571         pchip->irq = client->irq;
572         if (pchip->irq) {
573                 rval = lm3630a_intr_config(pchip);
574                 if (rval < 0)
575                         return rval;
576         }
577         dev_info(&client->dev, "LM3630A backlight register OK.\n");
578         return 0;
579 }
580
581 static int lm3630a_remove(struct i2c_client *client)
582 {
583         int rval;
584         struct lm3630a_chip *pchip = i2c_get_clientdata(client);
585
586         rval = lm3630a_write(pchip, REG_BRT_A, 0);
587         if (rval < 0)
588                 dev_err(pchip->dev, "i2c failed to access register\n");
589
590         rval = lm3630a_write(pchip, REG_BRT_B, 0);
591         if (rval < 0)
592                 dev_err(pchip->dev, "i2c failed to access register\n");
593
594         if (pchip->irq) {
595                 free_irq(pchip->irq, pchip);
596                 flush_workqueue(pchip->irqthread);
597                 destroy_workqueue(pchip->irqthread);
598         }
599         return 0;
600 }
601
602 static const struct i2c_device_id lm3630a_id[] = {
603         {LM3630A_NAME, 0},
604         {}
605 };
606
607 MODULE_DEVICE_TABLE(i2c, lm3630a_id);
608
609 static const struct of_device_id lm3630a_match_table[] = {
610         { .compatible = "ti,lm3630a", },
611         { },
612 };
613
614 MODULE_DEVICE_TABLE(of, lm3630a_match_table);
615
616 static struct i2c_driver lm3630a_i2c_driver = {
617         .driver = {
618                    .name = LM3630A_NAME,
619                    .of_match_table = lm3630a_match_table,
620                    },
621         .probe = lm3630a_probe,
622         .remove = lm3630a_remove,
623         .id_table = lm3630a_id,
624 };
625
626 module_i2c_driver(lm3630a_i2c_driver);
627
628 MODULE_DESCRIPTION("Texas Instruments Backlight driver for LM3630A");
629 MODULE_AUTHOR("Daniel Jeong <gshark.jeong@gmail.com>");
630 MODULE_AUTHOR("LDD MLP <ldd-mlp@list.ti.com>");
631 MODULE_LICENSE("GPL v2");