Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/drivers/leds-pwm.c
4 *
5 * simple PWM based LED control
6 *
7 * Copyright 2009 Luotao Fu @ Pengutronix (l.fu@pengutronix.de)
8 *
9 * based on leds-gpio.c by Raphael Assenat <raph@8d.com>
10 */
11
12#include <linux/module.h>
13#include <linux/kernel.h>
14#include <linux/platform_device.h>
15#include <linux/of.h>
16#include <linux/leds.h>
17#include <linux/err.h>
18#include <linux/pwm.h>
19#include <linux/slab.h>
20
21struct led_pwm {
22 const char *name;
23 u8 active_low;
24 u8 default_state;
25 unsigned int max_brightness;
26};
27
28struct led_pwm_data {
29 struct led_classdev cdev;
30 struct pwm_device *pwm;
31 struct pwm_state pwmstate;
32 unsigned int active_low;
33};
34
35struct led_pwm_priv {
36 int num_leds;
37 struct led_pwm_data leds[];
38};
39
40static int led_pwm_set(struct led_classdev *led_cdev,
41 enum led_brightness brightness)
42{
43 struct led_pwm_data *led_dat =
44 container_of(led_cdev, struct led_pwm_data, cdev);
45 unsigned int max = led_dat->cdev.max_brightness;
46 unsigned long long duty = led_dat->pwmstate.period;
47
48 duty *= brightness;
49 do_div(duty, max);
50
51 if (led_dat->active_low)
52 duty = led_dat->pwmstate.period - duty;
53
54 led_dat->pwmstate.duty_cycle = duty;
55 /*
56 * Disabling a PWM doesn't guarantee that it emits the inactive level.
57 * So keep it on. Only for suspending the PWM should be disabled because
58 * otherwise it refuses to suspend. The possible downside is that the
59 * LED might stay (or even go) on.
60 */
61 led_dat->pwmstate.enabled = !(led_cdev->flags & LED_SUSPENDED);
62 return pwm_apply_might_sleep(led_dat->pwm, &led_dat->pwmstate);
63}
64
65static int led_pwm_default_brightness_get(struct fwnode_handle *fwnode,
66 int max_brightness)
67{
68 unsigned int default_brightness;
69 int ret;
70
71 ret = fwnode_property_read_u32(fwnode, "default-brightness",
72 &default_brightness);
73 if (ret < 0 || default_brightness > max_brightness)
74 default_brightness = max_brightness;
75
76 return default_brightness;
77}
78
79__attribute__((nonnull))
80static int led_pwm_add(struct device *dev, struct led_pwm_priv *priv,
81 struct led_pwm *led, struct fwnode_handle *fwnode)
82{
83 struct led_pwm_data *led_data = &priv->leds[priv->num_leds];
84 struct led_init_data init_data = { .fwnode = fwnode };
85 int ret;
86
87 led_data->active_low = led->active_low;
88 led_data->cdev.name = led->name;
89 led_data->cdev.brightness = LED_OFF;
90 led_data->cdev.max_brightness = led->max_brightness;
91 led_data->cdev.flags = LED_CORE_SUSPENDRESUME;
92
93 led_data->pwm = devm_fwnode_pwm_get(dev, fwnode, NULL);
94 if (IS_ERR(led_data->pwm))
95 return dev_err_probe(dev, PTR_ERR(led_data->pwm),
96 "unable to request PWM for %s\n",
97 led->name);
98
99 led_data->cdev.brightness_set_blocking = led_pwm_set;
100
101 /* init PWM state */
102 switch (led->default_state) {
103 case LEDS_DEFSTATE_KEEP:
104 pwm_get_state(led_data->pwm, &led_data->pwmstate);
105 if (led_data->pwmstate.period)
106 break;
107 led->default_state = LEDS_DEFSTATE_OFF;
108 dev_warn(dev,
109 "failed to read period for %s, default to off",
110 led->name);
111 fallthrough;
112 default:
113 pwm_init_state(led_data->pwm, &led_data->pwmstate);
114 break;
115 }
116
117 /* set brightness */
118 switch (led->default_state) {
119 case LEDS_DEFSTATE_ON:
120 led_data->cdev.brightness =
121 led_pwm_default_brightness_get(fwnode, led->max_brightness);
122 break;
123 case LEDS_DEFSTATE_KEEP:
124 {
125 uint64_t brightness;
126
127 brightness = led->max_brightness;
128 brightness *= led_data->pwmstate.duty_cycle;
129 do_div(brightness, led_data->pwmstate.period);
130 led_data->cdev.brightness = brightness;
131 }
132 break;
133 }
134
135 ret = devm_led_classdev_register_ext(dev, &led_data->cdev, &init_data);
136 if (ret) {
137 dev_err(dev, "failed to register PWM led for %s: %d\n",
138 led->name, ret);
139 return ret;
140 }
141
142 if (led->default_state != LEDS_DEFSTATE_KEEP) {
143 ret = led_pwm_set(&led_data->cdev, led_data->cdev.brightness);
144 if (ret) {
145 dev_err(dev, "failed to set led PWM value for %s: %d",
146 led->name, ret);
147 return ret;
148 }
149 }
150
151 priv->num_leds++;
152 return 0;
153}
154
155static int led_pwm_create_fwnode(struct device *dev, struct led_pwm_priv *priv)
156{
157 struct led_pwm led;
158 int ret;
159
160 device_for_each_child_node_scoped(dev, fwnode) {
161 memset(&led, 0, sizeof(led));
162
163 ret = fwnode_property_read_string(fwnode, "label", &led.name);
164 if (ret && is_of_node(fwnode))
165 led.name = to_of_node(fwnode)->name;
166
167 if (!led.name)
168 return -EINVAL;
169
170 led.active_low = fwnode_property_read_bool(fwnode,
171 "active-low");
172 fwnode_property_read_u32(fwnode, "max-brightness",
173 &led.max_brightness);
174
175 led.default_state = led_init_default_state_get(fwnode);
176
177 ret = led_pwm_add(dev, priv, &led, fwnode);
178 if (ret)
179 return ret;
180 }
181
182 return 0;
183}
184
185static int led_pwm_probe(struct platform_device *pdev)
186{
187 struct led_pwm_priv *priv;
188 int ret = 0;
189 int count;
190
191 count = device_get_child_node_count(&pdev->dev);
192
193 if (!count)
194 return -EINVAL;
195
196 priv = devm_kzalloc(&pdev->dev, struct_size(priv, leds, count),
197 GFP_KERNEL);
198 if (!priv)
199 return -ENOMEM;
200
201 ret = led_pwm_create_fwnode(&pdev->dev, priv);
202
203 if (ret)
204 return ret;
205
206 platform_set_drvdata(pdev, priv);
207
208 return 0;
209}
210
211static const struct of_device_id of_pwm_leds_match[] = {
212 { .compatible = "pwm-leds", },
213 {},
214};
215MODULE_DEVICE_TABLE(of, of_pwm_leds_match);
216
217static struct platform_driver led_pwm_driver = {
218 .probe = led_pwm_probe,
219 .driver = {
220 .name = "leds_pwm",
221 .of_match_table = of_pwm_leds_match,
222 },
223};
224
225module_platform_driver(led_pwm_driver);
226
227MODULE_AUTHOR("Luotao Fu <l.fu@pengutronix.de>");
228MODULE_DESCRIPTION("generic PWM LED driver");
229MODULE_LICENSE("GPL v2");
230MODULE_ALIAS("platform:leds-pwm");
1/*
2 * linux/drivers/leds-pwm.c
3 *
4 * simple PWM based LED control
5 *
6 * Copyright 2009 Luotao Fu @ Pengutronix (l.fu@pengutronix.de)
7 *
8 * based on leds-gpio.c by Raphael Assenat <raph@8d.com>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 */
14
15#include <linux/module.h>
16#include <linux/kernel.h>
17#include <linux/platform_device.h>
18#include <linux/of_platform.h>
19#include <linux/fb.h>
20#include <linux/leds.h>
21#include <linux/err.h>
22#include <linux/pwm.h>
23#include <linux/leds_pwm.h>
24#include <linux/slab.h>
25#include <linux/workqueue.h>
26
27struct led_pwm_data {
28 struct led_classdev cdev;
29 struct pwm_device *pwm;
30 struct work_struct work;
31 unsigned int active_low;
32 unsigned int period;
33 int duty;
34 bool can_sleep;
35};
36
37struct led_pwm_priv {
38 int num_leds;
39 struct led_pwm_data leds[0];
40};
41
42static void __led_pwm_set(struct led_pwm_data *led_dat)
43{
44 int new_duty = led_dat->duty;
45
46 pwm_config(led_dat->pwm, new_duty, led_dat->period);
47
48 if (new_duty == 0)
49 pwm_disable(led_dat->pwm);
50 else
51 pwm_enable(led_dat->pwm);
52}
53
54static void led_pwm_work(struct work_struct *work)
55{
56 struct led_pwm_data *led_dat =
57 container_of(work, struct led_pwm_data, work);
58
59 __led_pwm_set(led_dat);
60}
61
62static void led_pwm_set(struct led_classdev *led_cdev,
63 enum led_brightness brightness)
64{
65 struct led_pwm_data *led_dat =
66 container_of(led_cdev, struct led_pwm_data, cdev);
67 unsigned int max = led_dat->cdev.max_brightness;
68 unsigned long long duty = led_dat->period;
69
70 duty *= brightness;
71 do_div(duty, max);
72 led_dat->duty = duty;
73
74 if (led_dat->can_sleep)
75 schedule_work(&led_dat->work);
76 else
77 __led_pwm_set(led_dat);
78}
79
80static inline size_t sizeof_pwm_leds_priv(int num_leds)
81{
82 return sizeof(struct led_pwm_priv) +
83 (sizeof(struct led_pwm_data) * num_leds);
84}
85
86static void led_pwm_cleanup(struct led_pwm_priv *priv)
87{
88 while (priv->num_leds--) {
89 led_classdev_unregister(&priv->leds[priv->num_leds].cdev);
90 if (priv->leds[priv->num_leds].can_sleep)
91 cancel_work_sync(&priv->leds[priv->num_leds].work);
92 }
93}
94
95static int led_pwm_create_of(struct platform_device *pdev,
96 struct led_pwm_priv *priv)
97{
98 struct device_node *child;
99 int ret;
100
101 for_each_child_of_node(pdev->dev.of_node, child) {
102 struct led_pwm_data *led_dat = &priv->leds[priv->num_leds];
103
104 led_dat->cdev.name = of_get_property(child, "label",
105 NULL) ? : child->name;
106
107 led_dat->pwm = devm_of_pwm_get(&pdev->dev, child, NULL);
108 if (IS_ERR(led_dat->pwm)) {
109 dev_err(&pdev->dev, "unable to request PWM for %s\n",
110 led_dat->cdev.name);
111 ret = PTR_ERR(led_dat->pwm);
112 goto err;
113 }
114 /* Get the period from PWM core when n*/
115 led_dat->period = pwm_get_period(led_dat->pwm);
116
117 led_dat->cdev.default_trigger = of_get_property(child,
118 "linux,default-trigger", NULL);
119 of_property_read_u32(child, "max-brightness",
120 &led_dat->cdev.max_brightness);
121
122 led_dat->cdev.brightness_set = led_pwm_set;
123 led_dat->cdev.brightness = LED_OFF;
124 led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME;
125
126 led_dat->can_sleep = pwm_can_sleep(led_dat->pwm);
127 if (led_dat->can_sleep)
128 INIT_WORK(&led_dat->work, led_pwm_work);
129
130 ret = led_classdev_register(&pdev->dev, &led_dat->cdev);
131 if (ret < 0) {
132 dev_err(&pdev->dev, "failed to register for %s\n",
133 led_dat->cdev.name);
134 of_node_put(child);
135 goto err;
136 }
137 priv->num_leds++;
138 }
139
140 return 0;
141err:
142 led_pwm_cleanup(priv);
143
144 return ret;
145}
146
147static int led_pwm_probe(struct platform_device *pdev)
148{
149 struct led_pwm_platform_data *pdata = dev_get_platdata(&pdev->dev);
150 struct led_pwm_priv *priv;
151 int count, i;
152 int ret = 0;
153
154 if (pdata)
155 count = pdata->num_leds;
156 else
157 count = of_get_child_count(pdev->dev.of_node);
158
159 if (!count)
160 return -EINVAL;
161
162 priv = devm_kzalloc(&pdev->dev, sizeof_pwm_leds_priv(count),
163 GFP_KERNEL);
164 if (!priv)
165 return -ENOMEM;
166
167 if (pdata) {
168 for (i = 0; i < count; i++) {
169 struct led_pwm *cur_led = &pdata->leds[i];
170 struct led_pwm_data *led_dat = &priv->leds[i];
171
172 led_dat->pwm = devm_pwm_get(&pdev->dev, cur_led->name);
173 if (IS_ERR(led_dat->pwm)) {
174 ret = PTR_ERR(led_dat->pwm);
175 dev_err(&pdev->dev,
176 "unable to request PWM for %s\n",
177 cur_led->name);
178 goto err;
179 }
180
181 led_dat->cdev.name = cur_led->name;
182 led_dat->cdev.default_trigger = cur_led->default_trigger;
183 led_dat->active_low = cur_led->active_low;
184 led_dat->period = cur_led->pwm_period_ns;
185 led_dat->cdev.brightness_set = led_pwm_set;
186 led_dat->cdev.brightness = LED_OFF;
187 led_dat->cdev.max_brightness = cur_led->max_brightness;
188 led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME;
189
190 led_dat->can_sleep = pwm_can_sleep(led_dat->pwm);
191 if (led_dat->can_sleep)
192 INIT_WORK(&led_dat->work, led_pwm_work);
193
194 ret = led_classdev_register(&pdev->dev, &led_dat->cdev);
195 if (ret < 0)
196 goto err;
197 }
198 priv->num_leds = count;
199 } else {
200 ret = led_pwm_create_of(pdev, priv);
201 if (ret)
202 return ret;
203 }
204
205 platform_set_drvdata(pdev, priv);
206
207 return 0;
208
209err:
210 priv->num_leds = i;
211 led_pwm_cleanup(priv);
212
213 return ret;
214}
215
216static int led_pwm_remove(struct platform_device *pdev)
217{
218 struct led_pwm_priv *priv = platform_get_drvdata(pdev);
219
220 led_pwm_cleanup(priv);
221
222 return 0;
223}
224
225static const struct of_device_id of_pwm_leds_match[] = {
226 { .compatible = "pwm-leds", },
227 {},
228};
229MODULE_DEVICE_TABLE(of, of_pwm_leds_match);
230
231static struct platform_driver led_pwm_driver = {
232 .probe = led_pwm_probe,
233 .remove = led_pwm_remove,
234 .driver = {
235 .name = "leds_pwm",
236 .owner = THIS_MODULE,
237 .of_match_table = of_pwm_leds_match,
238 },
239};
240
241module_platform_driver(led_pwm_driver);
242
243MODULE_AUTHOR("Luotao Fu <l.fu@pengutronix.de>");
244MODULE_DESCRIPTION("PWM LED driver for PXA");
245MODULE_LICENSE("GPL");
246MODULE_ALIAS("platform:leds-pwm");