1 // SPDX-License-Identifier: GPL-2.0-only
3 * Simple PWM based backlight control, board code has to setup
4 * 1) pin configuration so PWM waveforms can output
5 * 2) platform_data being correctly configured
8 #include <linux/delay.h>
9 #include <linux/gpio/consumer.h>
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/platform_device.h>
15 #include <linux/backlight.h>
16 #include <linux/err.h>
17 #include <linux/pwm.h>
18 #include <linux/pwm_backlight.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/slab.h>
23 struct pwm_device *pwm;
25 unsigned int lth_brightness;
28 struct regulator *power_supply;
29 struct gpio_desc *enable_gpio;
32 unsigned int post_pwm_on_delay;
33 unsigned int pwm_off_delay;
34 int (*notify)(struct device *,
36 void (*notify_after)(struct device *,
38 int (*check_fb)(struct device *, struct fb_info *);
39 void (*exit)(struct device *);
42 static void pwm_backlight_power_on(struct pwm_bl_data *pb)
44 struct pwm_state state;
47 pwm_get_state(pb->pwm, &state);
51 err = regulator_enable(pb->power_supply);
53 dev_err(pb->dev, "failed to enable power supply\n");
56 pwm_apply_state(pb->pwm, &state);
58 if (pb->post_pwm_on_delay)
59 msleep(pb->post_pwm_on_delay);
62 gpiod_set_value_cansleep(pb->enable_gpio, 1);
67 static void pwm_backlight_power_off(struct pwm_bl_data *pb)
69 struct pwm_state state;
71 pwm_get_state(pb->pwm, &state);
76 gpiod_set_value_cansleep(pb->enable_gpio, 0);
78 if (pb->pwm_off_delay)
79 msleep(pb->pwm_off_delay);
81 state.enabled = false;
83 pwm_apply_state(pb->pwm, &state);
85 regulator_disable(pb->power_supply);
89 static int compute_duty_cycle(struct pwm_bl_data *pb, int brightness)
91 unsigned int lth = pb->lth_brightness;
92 struct pwm_state state;
95 pwm_get_state(pb->pwm, &state);
98 duty_cycle = pb->levels[brightness];
100 duty_cycle = brightness;
102 duty_cycle *= state.period - lth;
103 do_div(duty_cycle, pb->scale);
105 return duty_cycle + lth;
108 static int pwm_backlight_update_status(struct backlight_device *bl)
110 struct pwm_bl_data *pb = bl_get_data(bl);
111 int brightness = backlight_get_brightness(bl);
112 struct pwm_state state;
115 brightness = pb->notify(pb->dev, brightness);
117 if (brightness > 0) {
118 pwm_get_state(pb->pwm, &state);
119 state.duty_cycle = compute_duty_cycle(pb, brightness);
120 pwm_apply_state(pb->pwm, &state);
121 pwm_backlight_power_on(pb);
123 pwm_backlight_power_off(pb);
126 if (pb->notify_after)
127 pb->notify_after(pb->dev, brightness);
132 static int pwm_backlight_check_fb(struct backlight_device *bl,
133 struct fb_info *info)
135 struct pwm_bl_data *pb = bl_get_data(bl);
137 return !pb->check_fb || pb->check_fb(pb->dev, info);
140 static const struct backlight_ops pwm_backlight_ops = {
141 .update_status = pwm_backlight_update_status,
142 .check_fb = pwm_backlight_check_fb,
146 #define PWM_LUMINANCE_SHIFT 16
147 #define PWM_LUMINANCE_SCALE (1 << PWM_LUMINANCE_SHIFT) /* luminance scale */
150 * CIE lightness to PWM conversion.
152 * The CIE 1931 lightness formula is what actually describes how we perceive
154 * Y = (L* / 903.3) if L* ≤ 8
155 * Y = ((L* + 16) / 116)^3 if L* > 8
157 * Where Y is the luminance, the amount of light coming out of the screen, and
158 * is a number between 0.0 and 1.0; and L* is the lightness, how bright a human
159 * perceives the screen to be, and is a number between 0 and 100.
161 * The following function does the fixed point maths needed to implement the
164 static u64 cie1931(unsigned int lightness)
169 * @lightness is given as a number between 0 and 1, expressed
170 * as a fixed-point number in scale
171 * PWM_LUMINANCE_SCALE. Convert to a percentage, still
172 * expressed as a fixed-point number, so the above formulas
176 if (lightness <= (8 * PWM_LUMINANCE_SCALE)) {
177 retval = DIV_ROUND_CLOSEST(lightness * 10, 9033);
179 retval = (lightness + (16 * PWM_LUMINANCE_SCALE)) / 116;
180 retval *= retval * retval;
181 retval += 1ULL << (2*PWM_LUMINANCE_SHIFT - 1);
182 retval >>= 2*PWM_LUMINANCE_SHIFT;
189 * Create a default correction table for PWM values to create linear brightness
190 * for LED based backlights using the CIE1931 algorithm.
193 int pwm_backlight_brightness_default(struct device *dev,
194 struct platform_pwm_backlight_data *data,
201 * Once we have 4096 levels there's little point going much higher...
202 * neither interactive sliders nor animation benefits from having
203 * more values in the table.
205 data->max_brightness =
206 min((int)DIV_ROUND_UP(period, fls(period)), 4096);
208 data->levels = devm_kcalloc(dev, data->max_brightness,
209 sizeof(*data->levels), GFP_KERNEL);
213 /* Fill the table using the cie1931 algorithm */
214 for (i = 0; i < data->max_brightness; i++) {
215 retval = cie1931((i * PWM_LUMINANCE_SCALE) /
216 data->max_brightness) * period;
217 retval = DIV_ROUND_CLOSEST_ULL(retval, PWM_LUMINANCE_SCALE);
218 if (retval > UINT_MAX)
220 data->levels[i] = (unsigned int)retval;
223 data->dft_brightness = data->max_brightness / 2;
224 data->max_brightness--;
229 static int pwm_backlight_parse_dt(struct device *dev,
230 struct platform_pwm_backlight_data *data)
232 struct device_node *node = dev->of_node;
233 unsigned int num_levels = 0;
234 unsigned int levels_count;
235 unsigned int num_steps = 0;
236 struct property *prop;
245 memset(data, 0, sizeof(*data));
248 * These values are optional and set as 0 by default, the out values
249 * are modified only if a valid u32 value can be decoded.
251 of_property_read_u32(node, "post-pwm-on-delay-ms",
252 &data->post_pwm_on_delay);
253 of_property_read_u32(node, "pwm-off-delay-ms", &data->pwm_off_delay);
256 * Determine the number of brightness levels, if this property is not
257 * set a default table of brightness levels will be used.
259 prop = of_find_property(node, "brightness-levels", &length);
263 data->max_brightness = length / sizeof(u32);
265 /* read brightness levels from DT property */
266 if (data->max_brightness > 0) {
267 size_t size = sizeof(*data->levels) * data->max_brightness;
268 unsigned int i, j, n = 0;
270 data->levels = devm_kzalloc(dev, size, GFP_KERNEL);
274 ret = of_property_read_u32_array(node, "brightness-levels",
276 data->max_brightness);
280 ret = of_property_read_u32(node, "default-brightness-level",
285 data->dft_brightness = value;
288 * This property is optional, if is set enables linear
289 * interpolation between each of the values of brightness levels
290 * and creates a new pre-computed table.
292 of_property_read_u32(node, "num-interpolated-steps",
296 * Make sure that there is at least two entries in the
297 * brightness-levels table, otherwise we can't interpolate
298 * between two points.
301 if (data->max_brightness < 2) {
302 dev_err(dev, "can't interpolate\n");
307 * Recalculate the number of brightness levels, now
308 * taking in consideration the number of interpolated
309 * steps between two levels.
311 for (i = 0; i < data->max_brightness - 1; i++) {
312 if ((data->levels[i + 1] - data->levels[i]) /
314 num_levels += num_steps;
319 dev_dbg(dev, "new number of brightness levels: %d\n",
323 * Create a new table of brightness levels with all the
324 * interpolated steps.
326 size = sizeof(*table) * num_levels;
327 table = devm_kzalloc(dev, size, GFP_KERNEL);
331 /* Fill the interpolated table. */
333 for (i = 0; i < data->max_brightness - 1; i++) {
334 value = data->levels[i];
335 n = (data->levels[i + 1] - value) / num_steps;
337 for (j = 0; j < num_steps; j++) {
338 table[levels_count] = value;
343 table[levels_count] = data->levels[i];
347 table[levels_count] = data->levels[i];
350 * As we use interpolation lets remove current
351 * brightness levels table and replace for the
352 * new interpolated table.
354 devm_kfree(dev, data->levels);
355 data->levels = table;
358 * Reassign max_brightness value to the new total number
359 * of brightness levels.
361 data->max_brightness = num_levels;
364 data->max_brightness--;
370 static const struct of_device_id pwm_backlight_of_match[] = {
371 { .compatible = "pwm-backlight" },
375 MODULE_DEVICE_TABLE(of, pwm_backlight_of_match);
377 static int pwm_backlight_parse_dt(struct device *dev,
378 struct platform_pwm_backlight_data *data)
384 int pwm_backlight_brightness_default(struct device *dev,
385 struct platform_pwm_backlight_data *data,
392 static bool pwm_backlight_is_linear(struct platform_pwm_backlight_data *data)
394 unsigned int nlevels = data->max_brightness + 1;
395 unsigned int min_val = data->levels[0];
396 unsigned int max_val = data->levels[nlevels - 1];
398 * Multiplying by 128 means that even in pathological cases such
399 * as (max_val - min_val) == nlevels the error at max_val is less
402 unsigned int slope = (128 * (max_val - min_val)) / nlevels;
403 unsigned int margin = (max_val - min_val) / 20; /* 5% */
406 for (i = 1; i < nlevels; i++) {
407 unsigned int linear_value = min_val + ((i * slope) / 128);
408 unsigned int delta = abs(linear_value - data->levels[i]);
417 static int pwm_backlight_initial_power_state(const struct pwm_bl_data *pb)
419 struct device_node *node = pb->dev->of_node;
423 * If the enable GPIO is present, observable (either as input
424 * or output) and off then the backlight is not currently active.
426 if (pb->enable_gpio && gpiod_get_value_cansleep(pb->enable_gpio) == 0)
429 if (!regulator_is_enabled(pb->power_supply))
432 if (!pwm_is_enabled(pb->pwm))
436 * Synchronize the enable_gpio with the observed state of the
440 gpiod_direction_output(pb->enable_gpio, active);
443 * Do not change pb->enabled here! pb->enabled essentially
444 * tells us if we own one of the regulator's use counts and
445 * right now we do not.
448 /* Not booted with device tree or no phandle link to the node */
449 if (!node || !node->phandle)
450 return FB_BLANK_UNBLANK;
453 * If the driver is probed from the device tree and there is a
454 * phandle link pointing to the backlight node, it is safe to
455 * assume that another driver will enable the backlight at the
456 * appropriate time. Therefore, if it is disabled, keep it so.
458 return active ? FB_BLANK_UNBLANK: FB_BLANK_POWERDOWN;
461 static int pwm_backlight_probe(struct platform_device *pdev)
463 struct platform_pwm_backlight_data *data = dev_get_platdata(&pdev->dev);
464 struct platform_pwm_backlight_data defdata;
465 struct backlight_properties props;
466 struct backlight_device *bl;
467 struct device_node *node = pdev->dev.of_node;
468 struct pwm_bl_data *pb;
469 struct pwm_state state;
474 ret = pwm_backlight_parse_dt(&pdev->dev, &defdata);
476 dev_err(&pdev->dev, "failed to find platform data\n");
484 ret = data->init(&pdev->dev);
489 pb = devm_kzalloc(&pdev->dev, sizeof(*pb), GFP_KERNEL);
495 pb->notify = data->notify;
496 pb->notify_after = data->notify_after;
497 pb->check_fb = data->check_fb;
498 pb->exit = data->exit;
499 pb->dev = &pdev->dev;
501 pb->post_pwm_on_delay = data->post_pwm_on_delay;
502 pb->pwm_off_delay = data->pwm_off_delay;
504 pb->enable_gpio = devm_gpiod_get_optional(&pdev->dev, "enable",
506 if (IS_ERR(pb->enable_gpio)) {
507 ret = PTR_ERR(pb->enable_gpio);
511 pb->power_supply = devm_regulator_get(&pdev->dev, "power");
512 if (IS_ERR(pb->power_supply)) {
513 ret = PTR_ERR(pb->power_supply);
517 pb->pwm = devm_pwm_get(&pdev->dev, NULL);
518 if (IS_ERR(pb->pwm) && PTR_ERR(pb->pwm) != -EPROBE_DEFER && !node) {
519 dev_err(&pdev->dev, "unable to request PWM, trying legacy API\n");
521 pb->pwm = pwm_request(data->pwm_id, "pwm-backlight");
524 if (IS_ERR(pb->pwm)) {
525 ret = PTR_ERR(pb->pwm);
526 if (ret != -EPROBE_DEFER)
527 dev_err(&pdev->dev, "unable to request PWM\n");
531 dev_dbg(&pdev->dev, "got pwm for backlight\n");
533 /* Sync up PWM state. */
534 pwm_init_state(pb->pwm, &state);
537 * The DT case will set the pwm_period_ns field to 0 and store the
538 * period, parsed from the DT, in the PWM device. For the non-DT case,
539 * set the period from platform data if it has not already been set
540 * via the PWM lookup table.
542 if (!state.period && (data->pwm_period_ns > 0))
543 state.period = data->pwm_period_ns;
545 ret = pwm_apply_state(pb->pwm, &state);
547 dev_err(&pdev->dev, "failed to apply initial PWM state: %d\n",
552 memset(&props, 0, sizeof(struct backlight_properties));
555 pb->levels = data->levels;
558 * For the DT case, only when brightness levels is defined
559 * data->levels is filled. For the non-DT case, data->levels
560 * can come from platform data, however is not usual.
562 for (i = 0; i <= data->max_brightness; i++)
563 if (data->levels[i] > pb->scale)
564 pb->scale = data->levels[i];
566 if (pwm_backlight_is_linear(data))
567 props.scale = BACKLIGHT_SCALE_LINEAR;
569 props.scale = BACKLIGHT_SCALE_NON_LINEAR;
570 } else if (!data->max_brightness) {
572 * If no brightness levels are provided and max_brightness is
573 * not set, use the default brightness table. For the DT case,
574 * max_brightness is set to 0 when brightness levels is not
575 * specified. For the non-DT case, max_brightness is usually
579 /* Get the PWM period (in nanoseconds) */
580 pwm_get_state(pb->pwm, &state);
582 ret = pwm_backlight_brightness_default(&pdev->dev, data,
586 "failed to setup default brightness table\n");
590 for (i = 0; i <= data->max_brightness; i++) {
591 if (data->levels[i] > pb->scale)
592 pb->scale = data->levels[i];
594 pb->levels = data->levels;
597 props.scale = BACKLIGHT_SCALE_NON_LINEAR;
600 * That only happens for the non-DT case, where platform data
601 * sets the max_brightness value.
603 pb->scale = data->max_brightness;
606 pb->lth_brightness = data->lth_brightness * (div_u64(state.period,
609 props.type = BACKLIGHT_RAW;
610 props.max_brightness = data->max_brightness;
611 bl = backlight_device_register(dev_name(&pdev->dev), &pdev->dev, pb,
612 &pwm_backlight_ops, &props);
614 dev_err(&pdev->dev, "failed to register backlight\n");
621 if (data->dft_brightness > data->max_brightness) {
623 "invalid default brightness level: %u, using %u\n",
624 data->dft_brightness, data->max_brightness);
625 data->dft_brightness = data->max_brightness;
628 bl->props.brightness = data->dft_brightness;
629 bl->props.power = pwm_backlight_initial_power_state(pb);
630 backlight_update_status(bl);
632 platform_set_drvdata(pdev, bl);
637 data->exit(&pdev->dev);
641 static int pwm_backlight_remove(struct platform_device *pdev)
643 struct backlight_device *bl = platform_get_drvdata(pdev);
644 struct pwm_bl_data *pb = bl_get_data(bl);
646 backlight_device_unregister(bl);
647 pwm_backlight_power_off(pb);
650 pb->exit(&pdev->dev);
657 static void pwm_backlight_shutdown(struct platform_device *pdev)
659 struct backlight_device *bl = platform_get_drvdata(pdev);
660 struct pwm_bl_data *pb = bl_get_data(bl);
662 pwm_backlight_power_off(pb);
665 #ifdef CONFIG_PM_SLEEP
666 static int pwm_backlight_suspend(struct device *dev)
668 struct backlight_device *bl = dev_get_drvdata(dev);
669 struct pwm_bl_data *pb = bl_get_data(bl);
672 pb->notify(pb->dev, 0);
674 pwm_backlight_power_off(pb);
676 if (pb->notify_after)
677 pb->notify_after(pb->dev, 0);
682 static int pwm_backlight_resume(struct device *dev)
684 struct backlight_device *bl = dev_get_drvdata(dev);
686 backlight_update_status(bl);
692 static const struct dev_pm_ops pwm_backlight_pm_ops = {
693 #ifdef CONFIG_PM_SLEEP
694 .suspend = pwm_backlight_suspend,
695 .resume = pwm_backlight_resume,
696 .poweroff = pwm_backlight_suspend,
697 .restore = pwm_backlight_resume,
701 static struct platform_driver pwm_backlight_driver = {
703 .name = "pwm-backlight",
704 .pm = &pwm_backlight_pm_ops,
705 .of_match_table = of_match_ptr(pwm_backlight_of_match),
707 .probe = pwm_backlight_probe,
708 .remove = pwm_backlight_remove,
709 .shutdown = pwm_backlight_shutdown,
712 module_platform_driver(pwm_backlight_driver);
714 MODULE_DESCRIPTION("PWM based Backlight Driver");
715 MODULE_LICENSE("GPL v2");
716 MODULE_ALIAS("platform:pwm-backlight");