[deliverable/linux.git] / drivers / leds / leds-gpio.c

/*
 * LEDs driver for GPIOs
 *
 * Copyright (C) 2007 8D Technologies inc.
 * Raphael Assenat <raph@8d.com>
 * Copyright (C) 2008 Freescale Semiconductor, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */
#include <linux/err.h>
#include <linux/gpio.h>
#include <linux/gpio/consumer.h>
#include <linux/kernel.h>
#include <linux/leds.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/property.h>
#include <linux/slab.h>

struct gpio_led_data {
	struct led_classdev cdev;
	struct gpio_desc *gpiod;
	u8 can_sleep;
	u8 blinking;
	int (*platform_gpio_blink_set)(struct gpio_desc *desc, int state,
			unsigned long *delay_on, unsigned long *delay_off);
};

static void gpio_led_set(struct led_classdev *led_cdev,
	enum led_brightness value)
{
	struct gpio_led_data *led_dat =
		container_of(led_cdev, struct gpio_led_data, cdev);
	int level;

	if (value == LED_OFF)
		level = 0;
	else
		level = 1;

	if (led_dat->blinking) {
		led_dat->platform_gpio_blink_set(led_dat->gpiod, level,
						 NULL, NULL);
		led_dat->blinking = 0;
	} else {
		if (led_dat->can_sleep)
			gpiod_set_value_cansleep(led_dat->gpiod, level);
		else
			gpiod_set_value(led_dat->gpiod, level);
	}
}

static int gpio_led_set_blocking(struct led_classdev *led_cdev,
	enum led_brightness value)
{
	gpio_led_set(led_cdev, value);
	return 0;
}

static int gpio_blink_set(struct led_classdev *led_cdev,
	unsigned long *delay_on, unsigned long *delay_off)
{
	struct gpio_led_data *led_dat =
		container_of(led_cdev, struct gpio_led_data, cdev);

	led_dat->blinking = 1;
	return led_dat->platform_gpio_blink_set(led_dat->gpiod, GPIO_LED_BLINK,
						delay_on, delay_off);
}

static int create_gpio_led(const struct gpio_led *template,
	struct gpio_led_data *led_dat, struct device *parent,
	int (*blink_set)(struct gpio_desc *, int, unsigned long *,
			 unsigned long *))
{
	int ret, state;

	led_dat->gpiod = template->gpiod;
	if (!led_dat->gpiod) {
		/*
		 * This is the legacy code path for platform code that
		 * still uses GPIO numbers. Ultimately we would like to get
		 * rid of this block completely.
		 */
		unsigned long flags = GPIOF_OUT_INIT_LOW;

		/* skip leds that aren't available */
		if (!gpio_is_valid(template->gpio)) {
			dev_info(parent, "Skipping unavailable LED gpio %d (%s)\n",
					template->gpio, template->name);
			return 0;
		}

		if (template->active_low)
			flags |= GPIOF_ACTIVE_LOW;

		ret = devm_gpio_request_one(parent, template->gpio, flags,
					    template->name);
		if (ret < 0)
			return ret;

		led_dat->gpiod = gpio_to_desc(template->gpio);
		if (!led_dat->gpiod)
			return -EINVAL;
	}

	led_dat->cdev.name = template->name;
	led_dat->cdev.default_trigger = template->default_trigger;
	led_dat->can_sleep = gpiod_cansleep(led_dat->gpiod);
	if (!led_dat->can_sleep)
		led_dat->cdev.brightness_set = gpio_led_set;
	else
		led_dat->cdev.brightness_set_blocking = gpio_led_set_blocking;
	led_dat->blinking = 0;
	if (blink_set) {
		led_dat->platform_gpio_blink_set = blink_set;
		led_dat->cdev.blink_set = gpio_blink_set;
	}
	if (template->default_state == LEDS_GPIO_DEFSTATE_KEEP)
		state = !!gpiod_get_value_cansleep(led_dat->gpiod);
	else
		state = (template->default_state == LEDS_GPIO_DEFSTATE_ON);
	led_dat->cdev.brightness = state ? LED_FULL : LED_OFF;
	if (!template->retain_state_suspended)
		led_dat->cdev.flags |= LED_CORE_SUSPENDRESUME;
	if (template->panic_indicator)
		led_dat->cdev.flags |= LED_PANIC_INDICATOR;

	ret = gpiod_direction_output(led_dat->gpiod, state);
	if (ret < 0)
		return ret;

	return led_classdev_register(parent, &led_dat->cdev);
}

struct gpio_leds_priv {
	int num_leds;
	struct gpio_led_data leds[];
};

static inline int sizeof_gpio_leds_priv(int num_leds)
{
	return sizeof(struct gpio_leds_priv) +
		(sizeof(struct gpio_led_data) * num_leds);
}

static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct fwnode_handle *child;
	struct gpio_leds_priv *priv;
	int count, ret;
	struct device_node *np;

	count = device_get_child_node_count(dev);
	if (!count)
		return ERR_PTR(-ENODEV);

	priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL);
	if (!priv)
		return ERR_PTR(-ENOMEM);

	device_for_each_child_node(dev, child) {
		struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
		struct gpio_led led = {};
		const char *state = NULL;

		led.gpiod = devm_get_gpiod_from_child(dev, NULL, child);
		if (IS_ERR(led.gpiod)) {
			fwnode_handle_put(child);
			ret = PTR_ERR(led.gpiod);
			goto err;
		}

		np = to_of_node(child);

		if (fwnode_property_present(child, "label")) {
			fwnode_property_read_string(child, "label", &led.name);
		} else {
			if (IS_ENABLED(CONFIG_OF) && !led.name && np)
				led.name = np->name;
			if (!led.name) {
				ret = -EINVAL;
				goto err;
			}
		}
		fwnode_property_read_string(child, "linux,default-trigger",
					    &led.default_trigger);

		if (!fwnode_property_read_string(child, "default-state",
						 &state)) {
			if (!strcmp(state, "keep"))
				led.default_state = LEDS_GPIO_DEFSTATE_KEEP;
			else if (!strcmp(state, "on"))
				led.default_state = LEDS_GPIO_DEFSTATE_ON;
			else
				led.default_state = LEDS_GPIO_DEFSTATE_OFF;
		}

		if (fwnode_property_present(child, "retain-state-suspended"))
			led.retain_state_suspended = 1;
		if (fwnode_property_present(child, "panic-indicator"))
			led.panic_indicator = 1;

		ret = create_gpio_led(&led, led_dat, dev, NULL);
		if (ret < 0) {
			fwnode_handle_put(child);
			goto err;
		}
		led_dat->cdev.dev->of_node = np;
		priv->num_leds++;
	}

	return priv;

err:
	for (count = priv->num_leds - 1; count >= 0; count--)
		led_classdev_unregister(&priv->leds[count].cdev);
	return ERR_PTR(ret);
}

static const struct of_device_id of_gpio_leds_match[] = {
	{ .compatible = "gpio-leds", },
	{},
};

MODULE_DEVICE_TABLE(of, of_gpio_leds_match);

static int gpio_led_probe(struct platform_device *pdev)
{
	struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev);
	struct gpio_leds_priv *priv;
	int i, ret = 0;

	if (pdata && pdata->num_leds) {
		priv = devm_kzalloc(&pdev->dev,
				sizeof_gpio_leds_priv(pdata->num_leds),
					GFP_KERNEL);
		if (!priv)
			return -ENOMEM;

		priv->num_leds = pdata->num_leds;
		for (i = 0; i < priv->num_leds; i++) {
			ret = create_gpio_led(&pdata->leds[i],
					      &priv->leds[i],
					      &pdev->dev, pdata->gpio_blink_set);
			if (ret < 0) {
				/* On failure: unwind the led creations */
				for (i = i - 1; i >= 0; i--)
					led_classdev_unregister(
							&priv->leds[i].cdev);
				return ret;
			}
		}
	} else {
		priv = gpio_leds_create(pdev);
		if (IS_ERR(priv))
			return PTR_ERR(priv);
	}

	platform_set_drvdata(pdev, priv);

	return 0;
}

static int gpio_led_remove(struct platform_device *pdev)
{
	struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
	int i;

	for (i = 0; i < priv->num_leds; i++)
		led_classdev_unregister(&priv->leds[i].cdev);

	return 0;
}

static void gpio_led_shutdown(struct platform_device *pdev)
{
	struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
	int i;

	for (i = 0; i < priv->num_leds; i++) {
		struct gpio_led_data *led = &priv->leds[i];

		gpio_led_set(&led->cdev, LED_OFF);
	}
}

static struct platform_driver gpio_led_driver = {
	.probe		= gpio_led_probe,
	.remove		= gpio_led_remove,
	.shutdown	= gpio_led_shutdown,
	.driver		= {
		.name	= "leds-gpio",
		.of_match_table = of_gpio_leds_match,
	},
};

module_platform_driver(gpio_led_driver);

MODULE_AUTHOR("Raphael Assenat <raph@8d.com>, Trent Piepho <tpiepho@freescale.com>");
MODULE_DESCRIPTION("GPIO LED driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:leds-gpio");
Commit	Line	Data
22e03f3b RA	1	/*
	2	* LEDs driver for GPIOs
	3	*
	4	* Copyright (C) 2007 8D Technologies inc.
	5	* Raphael Assenat <raph@8d.com>
a7d878af	6	* Copyright (C) 2008 Freescale Semiconductor, Inc.
22e03f3b RA	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	*/
4cc72346	13	#include <linux/err.h>
16db7f90	14	#include <linux/gpio.h>
5c51277a	15	#include <linux/gpio/consumer.h>
4cc72346	16	#include <linux/kernel.h>
22e03f3b	17	#include <linux/leds.h>
4cc72346	18	#include <linux/module.h>
403097f7	19	#include <linux/of.h>
4cc72346	20	#include <linux/platform_device.h>
a43f2cbb	21	#include <linux/property.h>
5a0e3ad6	22	#include <linux/slab.h>
00852279	23
22e03f3b RA	24	struct gpio_led_data {
22e03f3b RA	25	struct led_classdev cdev;
5c51277a	26	struct gpio_desc *gpiod;
00852279	27	u8 can_sleep;
2146325d	28	u8 blinking;
c673a2b4	29	int (platform_gpio_blink_set)(struct gpio_desc desc, int state,
ca3259b3	30	unsigned long delay_on, unsigned long delay_off);
22e03f3b RA	31	};
22e03f3b RA	32
22e03f3b RA	33	static void gpio_led_set(struct led_classdev *led_cdev,
	34	enum led_brightness value)
	35	{
	36	struct gpio_led_data *led_dat =
	37	container_of(led_cdev, struct gpio_led_data, cdev);
	38	int level;
	39
	40	if (value == LED_OFF)
	41	level = 0;
	42	else
	43	level = 1;
	44
d5b8a090 JA	45	if (led_dat->blinking) {
	46	led_dat->platform_gpio_blink_set(led_dat->gpiod, level,
	47	NULL, NULL);
	48	led_dat->blinking = 0;
2146325d	49	} else {
d5b8a090 JA	50	if (led_dat->can_sleep)
	51	gpiod_set_value_cansleep(led_dat->gpiod, level);
	52	else
5c51277a	53	gpiod_set_value(led_dat->gpiod, level);
2146325d	54	}
22e03f3b RA	55	}
22e03f3b RA	56
d5b8a090 JA	57	static int gpio_led_set_blocking(struct led_classdev *led_cdev,
	58	enum led_brightness value)
	59	{
	60	gpio_led_set(led_cdev, value);
	61	return 0;
	62	}
	63
ca3259b3 HVR	64	static int gpio_blink_set(struct led_classdev *led_cdev,
	65	unsigned long delay_on, unsigned long delay_off)
	66	{
	67	struct gpio_led_data *led_dat =
	68	container_of(led_cdev, struct gpio_led_data, cdev);
	69
2146325d	70	led_dat->blinking = 1;
c673a2b4	71	return led_dat->platform_gpio_blink_set(led_dat->gpiod, GPIO_LED_BLINK,
2146325d	72	delay_on, delay_off);
ca3259b3 HVR	73	}
ca3259b3 HVR	74
98ea1ea2	75	static int create_gpio_led(const struct gpio_led *template,
a7d878af	76	struct gpio_led_data led_dat, struct device parent,
c673a2b4 MW	77	int (blink_set)(struct gpio_desc , int, unsigned long *,
c673a2b4 MW	78	unsigned long *))
a7d878af	79	{
ed88bae6	80	int ret, state;
a7d878af	81
ec98a497 GU	82	led_dat->gpiod = template->gpiod;
ec98a497 GU	83	if (!led_dat->gpiod) {
c673a2b4 MW	84	/*
	85	* This is the legacy code path for platform code that
	86	* still uses GPIO numbers. Ultimately we would like to get
	87	* rid of this block completely.
	88	*/
eae7c98a	89	unsigned long flags = GPIOF_OUT_INIT_LOW;
0b4634fc	90
5c51277a MW	91	/* skip leds that aren't available */
	92	if (!gpio_is_valid(template->gpio)) {
	93	dev_info(parent, "Skipping unavailable LED gpio %d (%s)\n",
	94	template->gpio, template->name);
	95	return 0;
	96	}
d379ee8a	97
5c51277a MW	98	if (template->active_low)
	99	flags \|= GPIOF_ACTIVE_LOW;
	100
	101	ret = devm_gpio_request_one(parent, template->gpio, flags,
	102	template->name);
	103	if (ret < 0)
	104	return ret;
	105
	106	led_dat->gpiod = gpio_to_desc(template->gpio);
2d88a331 WY	107	if (!led_dat->gpiod)
2d88a331 WY	108	return -EINVAL;
5c51277a	109	}
803d19d5	110
a7d878af TP	111	led_dat->cdev.name = template->name;
a7d878af TP	112	led_dat->cdev.default_trigger = template->default_trigger;
ec98a497	113	led_dat->can_sleep = gpiod_cansleep(led_dat->gpiod);
d5b8a090 JA	114	if (!led_dat->can_sleep)
	115	led_dat->cdev.brightness_set = gpio_led_set;
	116	else
	117	led_dat->cdev.brightness_set_blocking = gpio_led_set_blocking;
2146325d	118	led_dat->blinking = 0;
a7d878af TP	119	if (blink_set) {
	120	led_dat->platform_gpio_blink_set = blink_set;
	121	led_dat->cdev.blink_set = gpio_blink_set;
	122	}
ed88bae6	123	if (template->default_state == LEDS_GPIO_DEFSTATE_KEEP)
5c51277a	124	state = !!gpiod_get_value_cansleep(led_dat->gpiod);
ed88bae6 TP	125	else
	126	state = (template->default_state == LEDS_GPIO_DEFSTATE_ON);
	127	led_dat->cdev.brightness = state ? LED_FULL : LED_OFF;
defb512d RP	128	if (!template->retain_state_suspended)
defb512d RP	129	led_dat->cdev.flags \|= LED_CORE_SUSPENDRESUME;
80d6737b EG	130	if (template->panic_indicator)
80d6737b EG	131	led_dat->cdev.flags \|= LED_PANIC_INDICATOR;
a7d878af	132
5c51277a	133	ret = gpiod_direction_output(led_dat->gpiod, state);
a7d878af	134	if (ret < 0)
a99d76f9 JH	135	return ret;
a99d76f9 JH	136
5c51277a	137	return led_classdev_register(parent, &led_dat->cdev);
a7d878af TP	138	}
a7d878af TP	139
a314c5c0 GL	140	struct gpio_leds_priv {
	141	int num_leds;
	142	struct gpio_led_data leds[];
	143	};
22e03f3b	144
a314c5c0	145	static inline int sizeof_gpio_leds_priv(int num_leds)
22e03f3b	146	{
a314c5c0 GL	147	return sizeof(struct gpio_leds_priv) +
a314c5c0 GL	148	(sizeof(struct gpio_led_data) * num_leds);
22e03f3b RA	149	}
22e03f3b RA	150
a43f2cbb	151	static struct gpio_leds_priv gpio_leds_create(struct platform_device pdev)
a7d878af	152	{
a43f2cbb RW	153	struct device *dev = &pdev->dev;
a43f2cbb RW	154	struct fwnode_handle *child;
a314c5c0	155	struct gpio_leds_priv *priv;
127aedc8	156	int count, ret;
29470ea8	157	struct device_node *np;
a7d878af	158
a43f2cbb	159	count = device_get_child_node_count(dev);
a7d878af	160	if (!count)
04553e92 RS	161	return ERR_PTR(-ENODEV);
04553e92 RS	162
a43f2cbb	163	priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL);
a314c5c0	164	if (!priv)
04553e92	165	return ERR_PTR(-ENOMEM);
a7d878af	166
a43f2cbb	167	device_for_each_child_node(dev, child) {
bff23714	168	struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
0493a4ff	169	struct gpio_led led = {};
a43f2cbb RW	170	const char *state = NULL;
a43f2cbb RW	171
1feb57a2	172	led.gpiod = devm_get_gpiod_from_child(dev, NULL, child);
a43f2cbb RW	173	if (IS_ERR(led.gpiod)) {
a43f2cbb RW	174	fwnode_handle_put(child);
c6e71f81	175	ret = PTR_ERR(led.gpiod);
a43f2cbb RW	176	goto err;
	177	}
	178
c181fb3e	179	np = to_of_node(child);
29470ea8 FE	180
	181	if (fwnode_property_present(child, "label")) {
	182	fwnode_property_read_string(child, "label", &led.name);
	183	} else {
	184	if (IS_ENABLED(CONFIG_OF) && !led.name && np)
	185	led.name = np->name;
0e14e0bf JA	186	if (!led.name) {
	187	ret = -EINVAL;
	188	goto err;
	189	}
29470ea8	190	}
a43f2cbb RW	191	fwnode_property_read_string(child, "linux,default-trigger",
	192	&led.default_trigger);
	193
d735d25e	194	if (!fwnode_property_read_string(child, "default-state",
a43f2cbb	195	&state)) {
ed88bae6 TP	196	if (!strcmp(state, "keep"))
ed88bae6 TP	197	led.default_state = LEDS_GPIO_DEFSTATE_KEEP;
a314c5c0	198	else if (!strcmp(state, "on"))
ed88bae6 TP	199	led.default_state = LEDS_GPIO_DEFSTATE_ON;
	200	else
	201	led.default_state = LEDS_GPIO_DEFSTATE_OFF;
	202	}
a7d878af	203
a43f2cbb	204	if (fwnode_property_present(child, "retain-state-suspended"))
4270a78d	205	led.retain_state_suspended = 1;
80d6737b EG	206	if (fwnode_property_present(child, "panic-indicator"))
80d6737b EG	207	led.panic_indicator = 1;
4270a78d	208
bff23714	209	ret = create_gpio_led(&led, led_dat, dev, NULL);
a7d878af	210	if (ret < 0) {
a43f2cbb	211	fwnode_handle_put(child);
a7d878af TP	212	goto err;
a7d878af TP	213	}
bff23714	214	led_dat->cdev.dev->of_node = np;
65c6b7e3	215	priv->num_leds++;
a7d878af TP	216	}
a7d878af TP	217
a314c5c0	218	return priv;
a7d878af TP	219
a7d878af TP	220	err:
65c6b7e3	221	for (count = priv->num_leds - 1; count >= 0; count--)
d5b8a090	222	led_classdev_unregister(&priv->leds[count].cdev);
c6e71f81	223	return ERR_PTR(ret);
a314c5c0	224	}
a7d878af	225
a314c5c0 GL	226	static const struct of_device_id of_gpio_leds_match[] = {
	227	{ .compatible = "gpio-leds", },
	228	{},
	229	};
472b854b PP	230
472b854b PP	231	MODULE_DEVICE_TABLE(of, of_gpio_leds_match);
a7d878af	232
98ea1ea2	233	static int gpio_led_probe(struct platform_device *pdev)
a314c5c0	234	{
87aae1ea	235	struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev);
a314c5c0 GL	236	struct gpio_leds_priv *priv;
	237	int i, ret = 0;
	238
	239	if (pdata && pdata->num_leds) {
198b8611 SK	240	priv = devm_kzalloc(&pdev->dev,
	241	sizeof_gpio_leds_priv(pdata->num_leds),
	242	GFP_KERNEL);
a314c5c0 GL	243	if (!priv)
	244	return -ENOMEM;
	245
	246	priv->num_leds = pdata->num_leds;
	247	for (i = 0; i < priv->num_leds; i++) {
	248	ret = create_gpio_led(&pdata->leds[i],
	249	&priv->leds[i],
	250	&pdev->dev, pdata->gpio_blink_set);
	251	if (ret < 0) {
	252	/* On failure: unwind the led creations */
	253	for (i = i - 1; i >= 0; i--)
d5b8a090 JA	254	led_classdev_unregister(
d5b8a090 JA	255	&priv->leds[i].cdev);
a314c5c0 GL	256	return ret;
	257	}
	258	}
	259	} else {
a43f2cbb	260	priv = gpio_leds_create(pdev);
04553e92 RS	261	if (IS_ERR(priv))
04553e92 RS	262	return PTR_ERR(priv);
a314c5c0 GL	263	}
	264
	265	platform_set_drvdata(pdev, priv);
	266
	267	return 0;
a7d878af TP	268	}
a7d878af TP	269
678e8a6b	270	static int gpio_led_remove(struct platform_device *pdev)
a7d878af	271	{
59c4dce1	272	struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
a7d878af TP	273	int i;
a7d878af TP	274
a314c5c0	275	for (i = 0; i < priv->num_leds; i++)
d5b8a090	276	led_classdev_unregister(&priv->leds[i].cdev);
a7d878af	277
a7d878af TP	278	return 0;
	279	}
	280
707f33ed HS	281	static void gpio_led_shutdown(struct platform_device *pdev)
	282	{
	283	struct gpio_leds_priv *priv = platform_get_drvdata(pdev);
	284	int i;
	285
	286	for (i = 0; i < priv->num_leds; i++) {
	287	struct gpio_led_data *led = &priv->leds[i];
	288
	289	gpio_led_set(&led->cdev, LED_OFF);
	290	}
	291	}
	292
a314c5c0 GL	293	static struct platform_driver gpio_led_driver = {
a314c5c0 GL	294	.probe = gpio_led_probe,
df07cf81	295	.remove = gpio_led_remove,
707f33ed	296	.shutdown = gpio_led_shutdown,
a314c5c0 GL	297	.driver = {
a314c5c0 GL	298	.name = "leds-gpio",
a43f2cbb	299	.of_match_table = of_gpio_leds_match,
a7d878af	300	},
a7d878af	301	};
a314c5c0	302
892a8843	303	module_platform_driver(gpio_led_driver);
a7d878af TP	304
a7d878af TP	305	MODULE_AUTHOR("Raphael Assenat <raph@8d.com>, Trent Piepho <tpiepho@freescale.com>");
22e03f3b RA	306	MODULE_DESCRIPTION("GPIO LED driver");
22e03f3b RA	307	MODULE_LICENSE("GPL");
892a8843	308	MODULE_ALIAS("platform:leds-gpio");