xref: /linux/drivers/leds/leds-pwm.c (revision bb4e9af0348dfeafd66c7e7f82e8a0983fe5390c)
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_platform.h>
16 #include <linux/leds.h>
17 #include <linux/err.h>
18 #include <linux/pwm.h>
19 #include <linux/leds_pwm.h>
20 #include <linux/slab.h>
21 
22 struct led_pwm_data {
23 	struct led_classdev	cdev;
24 	struct pwm_device	*pwm;
25 	unsigned int		active_low;
26 	unsigned int		period;
27 	int			duty;
28 };
29 
30 struct led_pwm_priv {
31 	int num_leds;
32 	struct led_pwm_data leds[0];
33 };
34 
35 static void __led_pwm_set(struct led_pwm_data *led_dat)
36 {
37 	int new_duty = led_dat->duty;
38 
39 	pwm_config(led_dat->pwm, new_duty, led_dat->period);
40 
41 	if (new_duty == 0)
42 		pwm_disable(led_dat->pwm);
43 	else
44 		pwm_enable(led_dat->pwm);
45 }
46 
47 static int led_pwm_set(struct led_classdev *led_cdev,
48 		       enum led_brightness brightness)
49 {
50 	struct led_pwm_data *led_dat =
51 		container_of(led_cdev, struct led_pwm_data, cdev);
52 	unsigned int max = led_dat->cdev.max_brightness;
53 	unsigned long long duty =  led_dat->period;
54 
55 	duty *= brightness;
56 	do_div(duty, max);
57 
58 	if (led_dat->active_low)
59 		duty = led_dat->period - duty;
60 
61 	led_dat->duty = duty;
62 
63 	__led_pwm_set(led_dat);
64 
65 	return 0;
66 }
67 
68 static inline size_t sizeof_pwm_leds_priv(int num_leds)
69 {
70 	return sizeof(struct led_pwm_priv) +
71 		      (sizeof(struct led_pwm_data) * num_leds);
72 }
73 
74 static int led_pwm_add(struct device *dev, struct led_pwm_priv *priv,
75 		       struct led_pwm *led, struct fwnode_handle *fwnode)
76 {
77 	struct led_pwm_data *led_data = &priv->leds[priv->num_leds];
78 	struct pwm_args pargs;
79 	int ret;
80 
81 	led_data->active_low = led->active_low;
82 	led_data->cdev.name = led->name;
83 	led_data->cdev.default_trigger = led->default_trigger;
84 	led_data->cdev.brightness = LED_OFF;
85 	led_data->cdev.max_brightness = led->max_brightness;
86 	led_data->cdev.flags = LED_CORE_SUSPENDRESUME;
87 
88 	if (fwnode)
89 		led_data->pwm = devm_fwnode_pwm_get(dev, fwnode, NULL);
90 	else
91 		led_data->pwm = devm_pwm_get(dev, led->name);
92 	if (IS_ERR(led_data->pwm)) {
93 		ret = PTR_ERR(led_data->pwm);
94 		if (ret != -EPROBE_DEFER)
95 			dev_err(dev, "unable to request PWM for %s: %d\n",
96 				led->name, ret);
97 		return ret;
98 	}
99 
100 	led_data->cdev.brightness_set_blocking = led_pwm_set;
101 
102 	/*
103 	 * FIXME: pwm_apply_args() should be removed when switching to the
104 	 * atomic PWM API.
105 	 */
106 	pwm_apply_args(led_data->pwm);
107 
108 	pwm_get_args(led_data->pwm, &pargs);
109 
110 	led_data->period = pargs.period;
111 	if (!led_data->period && (led->pwm_period_ns > 0))
112 		led_data->period = led->pwm_period_ns;
113 
114 	ret = devm_led_classdev_register(dev, &led_data->cdev);
115 	if (ret == 0) {
116 		priv->num_leds++;
117 		led_pwm_set(&led_data->cdev, led_data->cdev.brightness);
118 	} else {
119 		dev_err(dev, "failed to register PWM led for %s: %d\n",
120 			led->name, ret);
121 	}
122 
123 	return ret;
124 }
125 
126 static int led_pwm_create_fwnode(struct device *dev, struct led_pwm_priv *priv)
127 {
128 	struct fwnode_handle *fwnode;
129 	struct led_pwm led;
130 	int ret = 0;
131 
132 	memset(&led, 0, sizeof(led));
133 
134 	device_for_each_child_node(dev, fwnode) {
135 		ret = fwnode_property_read_string(fwnode, "label", &led.name);
136 		if (ret && is_of_node(fwnode))
137 			led.name = to_of_node(fwnode)->name;
138 
139 		if (!led.name) {
140 			fwnode_handle_put(fwnode);
141 			return -EINVAL;
142 		}
143 
144 		fwnode_property_read_string(fwnode, "linux,default-trigger",
145 					    &led.default_trigger);
146 
147 		led.active_low = fwnode_property_read_bool(fwnode,
148 							   "active-low");
149 		fwnode_property_read_u32(fwnode, "max-brightness",
150 					 &led.max_brightness);
151 
152 		ret = led_pwm_add(dev, priv, &led, fwnode);
153 		if (ret) {
154 			fwnode_handle_put(fwnode);
155 			break;
156 		}
157 	}
158 
159 	return ret;
160 }
161 
162 static int led_pwm_probe(struct platform_device *pdev)
163 {
164 	struct led_pwm_platform_data *pdata = dev_get_platdata(&pdev->dev);
165 	struct led_pwm_priv *priv;
166 	int count, i;
167 	int ret = 0;
168 
169 	if (pdata)
170 		count = pdata->num_leds;
171 	else
172 		count = device_get_child_node_count(&pdev->dev);
173 
174 	if (!count)
175 		return -EINVAL;
176 
177 	priv = devm_kzalloc(&pdev->dev, sizeof_pwm_leds_priv(count),
178 			    GFP_KERNEL);
179 	if (!priv)
180 		return -ENOMEM;
181 
182 	if (pdata) {
183 		for (i = 0; i < count; i++) {
184 			ret = led_pwm_add(&pdev->dev, priv, &pdata->leds[i],
185 					  NULL);
186 			if (ret)
187 				break;
188 		}
189 	} else {
190 		ret = led_pwm_create_fwnode(&pdev->dev, priv);
191 	}
192 
193 	if (ret)
194 		return ret;
195 
196 	platform_set_drvdata(pdev, priv);
197 
198 	return 0;
199 }
200 
201 static const struct of_device_id of_pwm_leds_match[] = {
202 	{ .compatible = "pwm-leds", },
203 	{},
204 };
205 MODULE_DEVICE_TABLE(of, of_pwm_leds_match);
206 
207 static struct platform_driver led_pwm_driver = {
208 	.probe		= led_pwm_probe,
209 	.driver		= {
210 		.name	= "leds_pwm",
211 		.of_match_table = of_pwm_leds_match,
212 	},
213 };
214 
215 module_platform_driver(led_pwm_driver);
216 
217 MODULE_AUTHOR("Luotao Fu <l.fu@pengutronix.de>");
218 MODULE_DESCRIPTION("generic PWM LED driver");
219 MODULE_LICENSE("GPL v2");
220 MODULE_ALIAS("platform:leds-pwm");
221