xref: /OK3568_Linux_fs/kernel/drivers/leds/leds-regulator.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * leds-regulator.c - LED class driver for regulator driven LEDs.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2009 Antonio Ospite <ospite@studenti.unina.it>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Inspired by leds-wm8350 driver.
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/module.h>
11*4882a593Smuzhiyun #include <linux/err.h>
12*4882a593Smuzhiyun #include <linux/slab.h>
13*4882a593Smuzhiyun #include <linux/leds.h>
14*4882a593Smuzhiyun #include <linux/leds-regulator.h>
15*4882a593Smuzhiyun #include <linux/platform_device.h>
16*4882a593Smuzhiyun #include <linux/regulator/consumer.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define to_regulator_led(led_cdev) \
19*4882a593Smuzhiyun 	container_of(led_cdev, struct regulator_led, cdev)
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct regulator_led {
22*4882a593Smuzhiyun 	struct led_classdev cdev;
23*4882a593Smuzhiyun 	int enabled;
24*4882a593Smuzhiyun 	struct mutex mutex;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	struct regulator *vcc;
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun 
led_regulator_get_max_brightness(struct regulator * supply)29*4882a593Smuzhiyun static inline int led_regulator_get_max_brightness(struct regulator *supply)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun 	int ret;
32*4882a593Smuzhiyun 	int voltage = regulator_list_voltage(supply, 0);
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	if (voltage <= 0)
35*4882a593Smuzhiyun 		return 1;
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	/* even if regulator can't change voltages,
38*4882a593Smuzhiyun 	 * we still assume it can change status
39*4882a593Smuzhiyun 	 * and the LED can be turned on and off.
40*4882a593Smuzhiyun 	 */
41*4882a593Smuzhiyun 	ret = regulator_set_voltage(supply, voltage, voltage);
42*4882a593Smuzhiyun 	if (ret < 0)
43*4882a593Smuzhiyun 		return 1;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	return regulator_count_voltages(supply);
46*4882a593Smuzhiyun }
47*4882a593Smuzhiyun 
led_regulator_get_voltage(struct regulator * supply,enum led_brightness brightness)48*4882a593Smuzhiyun static int led_regulator_get_voltage(struct regulator *supply,
49*4882a593Smuzhiyun 		enum led_brightness brightness)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun 	if (brightness == 0)
52*4882a593Smuzhiyun 		return -EINVAL;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	return regulator_list_voltage(supply, brightness - 1);
55*4882a593Smuzhiyun }
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 
regulator_led_enable(struct regulator_led * led)58*4882a593Smuzhiyun static void regulator_led_enable(struct regulator_led *led)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	int ret;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	if (led->enabled)
63*4882a593Smuzhiyun 		return;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	ret = regulator_enable(led->vcc);
66*4882a593Smuzhiyun 	if (ret != 0) {
67*4882a593Smuzhiyun 		dev_err(led->cdev.dev, "Failed to enable vcc: %d\n", ret);
68*4882a593Smuzhiyun 		return;
69*4882a593Smuzhiyun 	}
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	led->enabled = 1;
72*4882a593Smuzhiyun }
73*4882a593Smuzhiyun 
regulator_led_disable(struct regulator_led * led)74*4882a593Smuzhiyun static void regulator_led_disable(struct regulator_led *led)
75*4882a593Smuzhiyun {
76*4882a593Smuzhiyun 	int ret;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	if (!led->enabled)
79*4882a593Smuzhiyun 		return;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	ret = regulator_disable(led->vcc);
82*4882a593Smuzhiyun 	if (ret != 0) {
83*4882a593Smuzhiyun 		dev_err(led->cdev.dev, "Failed to disable vcc: %d\n", ret);
84*4882a593Smuzhiyun 		return;
85*4882a593Smuzhiyun 	}
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	led->enabled = 0;
88*4882a593Smuzhiyun }
89*4882a593Smuzhiyun 
regulator_led_brightness_set(struct led_classdev * led_cdev,enum led_brightness value)90*4882a593Smuzhiyun static int regulator_led_brightness_set(struct led_classdev *led_cdev,
91*4882a593Smuzhiyun 					 enum led_brightness value)
92*4882a593Smuzhiyun {
93*4882a593Smuzhiyun 	struct regulator_led *led = to_regulator_led(led_cdev);
94*4882a593Smuzhiyun 	int voltage;
95*4882a593Smuzhiyun 	int ret = 0;
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	mutex_lock(&led->mutex);
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	if (value == LED_OFF) {
100*4882a593Smuzhiyun 		regulator_led_disable(led);
101*4882a593Smuzhiyun 		goto out;
102*4882a593Smuzhiyun 	}
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	if (led->cdev.max_brightness > 1) {
105*4882a593Smuzhiyun 		voltage = led_regulator_get_voltage(led->vcc, value);
106*4882a593Smuzhiyun 		dev_dbg(led->cdev.dev, "brightness: %d voltage: %d\n",
107*4882a593Smuzhiyun 				value, voltage);
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun 		ret = regulator_set_voltage(led->vcc, voltage, voltage);
110*4882a593Smuzhiyun 		if (ret != 0)
111*4882a593Smuzhiyun 			dev_err(led->cdev.dev, "Failed to set voltage %d: %d\n",
112*4882a593Smuzhiyun 				voltage, ret);
113*4882a593Smuzhiyun 	}
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	regulator_led_enable(led);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun out:
118*4882a593Smuzhiyun 	mutex_unlock(&led->mutex);
119*4882a593Smuzhiyun 	return ret;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun 
regulator_led_probe(struct platform_device * pdev)122*4882a593Smuzhiyun static int regulator_led_probe(struct platform_device *pdev)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun 	struct led_regulator_platform_data *pdata =
125*4882a593Smuzhiyun 			dev_get_platdata(&pdev->dev);
126*4882a593Smuzhiyun 	struct regulator_led *led;
127*4882a593Smuzhiyun 	struct regulator *vcc;
128*4882a593Smuzhiyun 	int ret = 0;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	if (pdata == NULL) {
131*4882a593Smuzhiyun 		dev_err(&pdev->dev, "no platform data\n");
132*4882a593Smuzhiyun 		return -ENODEV;
133*4882a593Smuzhiyun 	}
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	vcc = devm_regulator_get_exclusive(&pdev->dev, "vled");
136*4882a593Smuzhiyun 	if (IS_ERR(vcc)) {
137*4882a593Smuzhiyun 		dev_err(&pdev->dev, "Cannot get vcc for %s\n", pdata->name);
138*4882a593Smuzhiyun 		return PTR_ERR(vcc);
139*4882a593Smuzhiyun 	}
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	led = devm_kzalloc(&pdev->dev, sizeof(*led), GFP_KERNEL);
142*4882a593Smuzhiyun 	if (led == NULL)
143*4882a593Smuzhiyun 		return -ENOMEM;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	led->cdev.max_brightness = led_regulator_get_max_brightness(vcc);
146*4882a593Smuzhiyun 	if (pdata->brightness > led->cdev.max_brightness) {
147*4882a593Smuzhiyun 		dev_err(&pdev->dev, "Invalid default brightness %d\n",
148*4882a593Smuzhiyun 				pdata->brightness);
149*4882a593Smuzhiyun 		return -EINVAL;
150*4882a593Smuzhiyun 	}
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	led->cdev.brightness_set_blocking = regulator_led_brightness_set;
153*4882a593Smuzhiyun 	led->cdev.name = pdata->name;
154*4882a593Smuzhiyun 	led->cdev.flags |= LED_CORE_SUSPENDRESUME;
155*4882a593Smuzhiyun 	led->vcc = vcc;
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	/* to handle correctly an already enabled regulator */
158*4882a593Smuzhiyun 	if (regulator_is_enabled(led->vcc))
159*4882a593Smuzhiyun 		led->enabled = 1;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	mutex_init(&led->mutex);
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun 	platform_set_drvdata(pdev, led);
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun 	ret = led_classdev_register(&pdev->dev, &led->cdev);
166*4882a593Smuzhiyun 	if (ret < 0)
167*4882a593Smuzhiyun 		return ret;
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	/* to expose the default value to userspace */
170*4882a593Smuzhiyun 	led->cdev.brightness = pdata->brightness;
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	/* Set the default led status */
173*4882a593Smuzhiyun 	regulator_led_brightness_set(&led->cdev, led->cdev.brightness);
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	return 0;
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun 
regulator_led_remove(struct platform_device * pdev)178*4882a593Smuzhiyun static int regulator_led_remove(struct platform_device *pdev)
179*4882a593Smuzhiyun {
180*4882a593Smuzhiyun 	struct regulator_led *led = platform_get_drvdata(pdev);
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 	led_classdev_unregister(&led->cdev);
183*4882a593Smuzhiyun 	regulator_led_disable(led);
184*4882a593Smuzhiyun 	return 0;
185*4882a593Smuzhiyun }
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun static struct platform_driver regulator_led_driver = {
188*4882a593Smuzhiyun 	.driver = {
189*4882a593Smuzhiyun 		   .name  = "leds-regulator",
190*4882a593Smuzhiyun 		   },
191*4882a593Smuzhiyun 	.probe  = regulator_led_probe,
192*4882a593Smuzhiyun 	.remove = regulator_led_remove,
193*4882a593Smuzhiyun };
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun module_platform_driver(regulator_led_driver);
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun MODULE_AUTHOR("Antonio Ospite <ospite@studenti.unina.it>");
198*4882a593Smuzhiyun MODULE_DESCRIPTION("Regulator driven LED driver");
199*4882a593Smuzhiyun MODULE_LICENSE("GPL");
200*4882a593Smuzhiyun MODULE_ALIAS("platform:leds-regulator");
201