[linux-2.6-block.git] / drivers / leds / led-core.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * LED Class Core
 *
 * Copyright 2005-2006 Openedhand Ltd.
 *
 * Author: Richard Purdie <rpurdie@openedhand.com>
 */

#include <linux/kernel.h>
#include <linux/leds.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/of.h>
#include <linux/property.h>
#include <linux/rwsem.h>
#include <linux/slab.h>
#include <uapi/linux/uleds.h>
#include "leds.h"

DECLARE_RWSEM(leds_list_lock);
EXPORT_SYMBOL_GPL(leds_list_lock);

LIST_HEAD(leds_list);
EXPORT_SYMBOL_GPL(leds_list);

const char * const led_colors[LED_COLOR_ID_MAX] = {
	[LED_COLOR_ID_WHITE] = "white",
	[LED_COLOR_ID_RED] = "red",
	[LED_COLOR_ID_GREEN] = "green",
	[LED_COLOR_ID_BLUE] = "blue",
	[LED_COLOR_ID_AMBER] = "amber",
	[LED_COLOR_ID_VIOLET] = "violet",
	[LED_COLOR_ID_YELLOW] = "yellow",
	[LED_COLOR_ID_IR] = "ir",
	[LED_COLOR_ID_MULTI] = "multicolor",
	[LED_COLOR_ID_RGB] = "rgb",
	[LED_COLOR_ID_PURPLE] = "purple",
	[LED_COLOR_ID_ORANGE] = "orange",
	[LED_COLOR_ID_PINK] = "pink",
	[LED_COLOR_ID_CYAN] = "cyan",
	[LED_COLOR_ID_LIME] = "lime",
};
EXPORT_SYMBOL_GPL(led_colors);

static int __led_set_brightness(struct led_classdev *led_cdev, unsigned int value)
{
	if (!led_cdev->brightness_set)
		return -ENOTSUPP;

	led_cdev->brightness_set(led_cdev, value);

	return 0;
}

static int __led_set_brightness_blocking(struct led_classdev *led_cdev, unsigned int value)
{
	if (!led_cdev->brightness_set_blocking)
		return -ENOTSUPP;

	return led_cdev->brightness_set_blocking(led_cdev, value);
}

static void led_timer_function(struct timer_list *t)
{
	struct led_classdev *led_cdev = from_timer(led_cdev, t, blink_timer);
	unsigned long brightness;
	unsigned long delay;

	if (!led_cdev->blink_delay_on || !led_cdev->blink_delay_off) {
		led_set_brightness_nosleep(led_cdev, LED_OFF);
		clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
		return;
	}

	if (test_and_clear_bit(LED_BLINK_ONESHOT_STOP,
			       &led_cdev->work_flags)) {
		clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
		return;
	}

	brightness = led_get_brightness(led_cdev);
	if (!brightness) {
		/* Time to switch the LED on. */
		if (test_and_clear_bit(LED_BLINK_BRIGHTNESS_CHANGE,
					&led_cdev->work_flags))
			brightness = led_cdev->new_blink_brightness;
		else
			brightness = led_cdev->blink_brightness;
		delay = led_cdev->blink_delay_on;
	} else {
		/* Store the current brightness value to be able
		 * to restore it when the delay_off period is over.
		 */
		led_cdev->blink_brightness = brightness;
		brightness = LED_OFF;
		delay = led_cdev->blink_delay_off;
	}

	led_set_brightness_nosleep(led_cdev, brightness);

	/* Return in next iteration if led is in one-shot mode and we are in
	 * the final blink state so that the led is toggled each delay_on +
	 * delay_off milliseconds in worst case.
	 */
	if (test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags)) {
		if (test_bit(LED_BLINK_INVERT, &led_cdev->work_flags)) {
			if (brightness)
				set_bit(LED_BLINK_ONESHOT_STOP,
					&led_cdev->work_flags);
		} else {
			if (!brightness)
				set_bit(LED_BLINK_ONESHOT_STOP,
					&led_cdev->work_flags);
		}
	}

	mod_timer(&led_cdev->blink_timer, jiffies + msecs_to_jiffies(delay));
}

static void set_brightness_delayed_set_brightness(struct led_classdev *led_cdev,
						  unsigned int value)
{
	int ret = 0;

	ret = __led_set_brightness(led_cdev, value);
	if (ret == -ENOTSUPP)
		ret = __led_set_brightness_blocking(led_cdev, value);
	if (ret < 0 &&
	    /* LED HW might have been unplugged, therefore don't warn */
	    !(ret == -ENODEV && (led_cdev->flags & LED_UNREGISTERING) &&
	    (led_cdev->flags & LED_HW_PLUGGABLE)))
		dev_err(led_cdev->dev,
			"Setting an LED's brightness failed (%d)\n", ret);
}

static void set_brightness_delayed(struct work_struct *ws)
{
	struct led_classdev *led_cdev =
		container_of(ws, struct led_classdev, set_brightness_work);

	if (test_and_clear_bit(LED_BLINK_DISABLE, &led_cdev->work_flags)) {
		led_stop_software_blink(led_cdev);
		set_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags);
	}

	/*
	 * Triggers may call led_set_brightness(LED_OFF),
	 * led_set_brightness(LED_FULL) in quick succession to disable blinking
	 * and turn the LED on. Both actions may have been scheduled to run
	 * before this work item runs once. To make sure this works properly
	 * handle LED_SET_BRIGHTNESS_OFF first.
	 */
	if (test_and_clear_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags))
		set_brightness_delayed_set_brightness(led_cdev, LED_OFF);

	if (test_and_clear_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags))
		set_brightness_delayed_set_brightness(led_cdev, led_cdev->delayed_set_value);

	if (test_and_clear_bit(LED_SET_BLINK, &led_cdev->work_flags)) {
		unsigned long delay_on = led_cdev->delayed_delay_on;
		unsigned long delay_off = led_cdev->delayed_delay_off;

		led_blink_set(led_cdev, &delay_on, &delay_off);
	}
}

static void led_set_software_blink(struct led_classdev *led_cdev,
				   unsigned long delay_on,
				   unsigned long delay_off)
{
	int current_brightness;

	current_brightness = led_get_brightness(led_cdev);
	if (current_brightness)
		led_cdev->blink_brightness = current_brightness;
	if (!led_cdev->blink_brightness)
		led_cdev->blink_brightness = led_cdev->max_brightness;

	led_cdev->blink_delay_on = delay_on;
	led_cdev->blink_delay_off = delay_off;

	/* never on - just set to off */
	if (!delay_on) {
		led_set_brightness_nosleep(led_cdev, LED_OFF);
		return;
	}

	/* never off - just set to brightness */
	if (!delay_off) {
		led_set_brightness_nosleep(led_cdev,
					   led_cdev->blink_brightness);
		return;
	}

	set_bit(LED_BLINK_SW, &led_cdev->work_flags);
	mod_timer(&led_cdev->blink_timer, jiffies + 1);
}


static void led_blink_setup(struct led_classdev *led_cdev,
		     unsigned long *delay_on,
		     unsigned long *delay_off)
{
	if (!test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags) &&
	    led_cdev->blink_set &&
	    !led_cdev->blink_set(led_cdev, delay_on, delay_off))
		return;

	/* blink with 1 Hz as default if nothing specified */
	if (!*delay_on && !*delay_off)
		*delay_on = *delay_off = 500;

	led_set_software_blink(led_cdev, *delay_on, *delay_off);
}

void led_init_core(struct led_classdev *led_cdev)
{
	INIT_WORK(&led_cdev->set_brightness_work, set_brightness_delayed);

	timer_setup(&led_cdev->blink_timer, led_timer_function, 0);
}
EXPORT_SYMBOL_GPL(led_init_core);

void led_blink_set(struct led_classdev *led_cdev,
		   unsigned long *delay_on,
		   unsigned long *delay_off)
{
	del_timer_sync(&led_cdev->blink_timer);

	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
	clear_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags);
	clear_bit(LED_BLINK_ONESHOT_STOP, &led_cdev->work_flags);

	led_blink_setup(led_cdev, delay_on, delay_off);
}
EXPORT_SYMBOL_GPL(led_blink_set);

void led_blink_set_oneshot(struct led_classdev *led_cdev,
			   unsigned long *delay_on,
			   unsigned long *delay_off,
			   int invert)
{
	if (test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags) &&
	     timer_pending(&led_cdev->blink_timer))
		return;

	set_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags);
	clear_bit(LED_BLINK_ONESHOT_STOP, &led_cdev->work_flags);

	if (invert)
		set_bit(LED_BLINK_INVERT, &led_cdev->work_flags);
	else
		clear_bit(LED_BLINK_INVERT, &led_cdev->work_flags);

	led_blink_setup(led_cdev, delay_on, delay_off);
}
EXPORT_SYMBOL_GPL(led_blink_set_oneshot);

void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
			   unsigned long delay_off)
{
	/* If necessary delegate to a work queue task. */
	if (led_cdev->blink_set && led_cdev->brightness_set_blocking) {
		led_cdev->delayed_delay_on = delay_on;
		led_cdev->delayed_delay_off = delay_off;
		set_bit(LED_SET_BLINK, &led_cdev->work_flags);
		schedule_work(&led_cdev->set_brightness_work);
		return;
	}

	led_blink_set(led_cdev, &delay_on, &delay_off);
}
EXPORT_SYMBOL_GPL(led_blink_set_nosleep);

void led_stop_software_blink(struct led_classdev *led_cdev)
{
	del_timer_sync(&led_cdev->blink_timer);
	led_cdev->blink_delay_on = 0;
	led_cdev->blink_delay_off = 0;
	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
}
EXPORT_SYMBOL_GPL(led_stop_software_blink);

void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness)
{
	/*
	 * If software blink is active, delay brightness setting
	 * until the next timer tick.
	 */
	if (test_bit(LED_BLINK_SW, &led_cdev->work_flags)) {
		/*
		 * If we need to disable soft blinking delegate this to the
		 * work queue task to avoid problems in case we are called
		 * from hard irq context.
		 */
		if (!brightness) {
			set_bit(LED_BLINK_DISABLE, &led_cdev->work_flags);
			schedule_work(&led_cdev->set_brightness_work);
		} else {
			set_bit(LED_BLINK_BRIGHTNESS_CHANGE,
				&led_cdev->work_flags);
			led_cdev->new_blink_brightness = brightness;
		}
		return;
	}

	led_set_brightness_nosleep(led_cdev, brightness);
}
EXPORT_SYMBOL_GPL(led_set_brightness);

void led_set_brightness_nopm(struct led_classdev *led_cdev, unsigned int value)
{
	/* Use brightness_set op if available, it is guaranteed not to sleep */
	if (!__led_set_brightness(led_cdev, value))
		return;

	/*
	 * Brightness setting can sleep, delegate it to a work queue task.
	 * value 0 / LED_OFF is special, since it also disables hw-blinking
	 * (sw-blink disable is handled in led_set_brightness()).
	 * To avoid a hw-blink-disable getting lost when a second brightness
	 * change is done immediately afterwards (before the work runs),
	 * it uses a separate work_flag.
	 */
	if (value) {
		led_cdev->delayed_set_value = value;
		set_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags);
	} else {
		clear_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags);
		clear_bit(LED_SET_BLINK, &led_cdev->work_flags);
		set_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags);
	}

	schedule_work(&led_cdev->set_brightness_work);
}
EXPORT_SYMBOL_GPL(led_set_brightness_nopm);

void led_set_brightness_nosleep(struct led_classdev *led_cdev, unsigned int value)
{
	led_cdev->brightness = min(value, led_cdev->max_brightness);

	if (led_cdev->flags & LED_SUSPENDED)
		return;

	led_set_brightness_nopm(led_cdev, led_cdev->brightness);
}
EXPORT_SYMBOL_GPL(led_set_brightness_nosleep);

int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value)
{
	if (led_cdev->blink_delay_on || led_cdev->blink_delay_off)
		return -EBUSY;

	led_cdev->brightness = min(value, led_cdev->max_brightness);

	if (led_cdev->flags & LED_SUSPENDED)
		return 0;

	return __led_set_brightness_blocking(led_cdev, led_cdev->brightness);
}
EXPORT_SYMBOL_GPL(led_set_brightness_sync);

int led_update_brightness(struct led_classdev *led_cdev)
{
	int ret;

	if (led_cdev->brightness_get) {
		ret = led_cdev->brightness_get(led_cdev);
		if (ret < 0)
			return ret;

		led_cdev->brightness = ret;
	}

	return 0;
}
EXPORT_SYMBOL_GPL(led_update_brightness);

u32 *led_get_default_pattern(struct led_classdev *led_cdev, unsigned int *size)
{
	struct fwnode_handle *fwnode = led_cdev->dev->fwnode;
	u32 *pattern;
	int count;

	count = fwnode_property_count_u32(fwnode, "led-pattern");
	if (count < 0)
		return NULL;

	pattern = kcalloc(count, sizeof(*pattern), GFP_KERNEL);
	if (!pattern)
		return NULL;

	if (fwnode_property_read_u32_array(fwnode, "led-pattern", pattern, count)) {
		kfree(pattern);
		return NULL;
	}

	*size = count;

	return pattern;
}
EXPORT_SYMBOL_GPL(led_get_default_pattern);

/* Caller must ensure led_cdev->led_access held */
void led_sysfs_disable(struct led_classdev *led_cdev)
{
	lockdep_assert_held(&led_cdev->led_access);

	led_cdev->flags |= LED_SYSFS_DISABLE;
}
EXPORT_SYMBOL_GPL(led_sysfs_disable);

/* Caller must ensure led_cdev->led_access held */
void led_sysfs_enable(struct led_classdev *led_cdev)
{
	lockdep_assert_held(&led_cdev->led_access);

	led_cdev->flags &= ~LED_SYSFS_DISABLE;
}
EXPORT_SYMBOL_GPL(led_sysfs_enable);

static void led_parse_fwnode_props(struct device *dev,
				   struct fwnode_handle *fwnode,
				   struct led_properties *props)
{
	int ret;

	if (!fwnode)
		return;

	if (fwnode_property_present(fwnode, "label")) {
		ret = fwnode_property_read_string(fwnode, "label", &props->label);
		if (ret)
			dev_err(dev, "Error parsing 'label' property (%d)\n", ret);
		return;
	}

	if (fwnode_property_present(fwnode, "color")) {
		ret = fwnode_property_read_u32(fwnode, "color", &props->color);
		if (ret)
			dev_err(dev, "Error parsing 'color' property (%d)\n", ret);
		else if (props->color >= LED_COLOR_ID_MAX)
			dev_err(dev, "LED color identifier out of range\n");
		else
			props->color_present = true;
	}


	if (!fwnode_property_present(fwnode, "function"))
		return;

	ret = fwnode_property_read_string(fwnode, "function", &props->function);
	if (ret) {
		dev_err(dev,
			"Error parsing 'function' property (%d)\n",
			ret);
	}

	if (!fwnode_property_present(fwnode, "function-enumerator"))
		return;

	ret = fwnode_property_read_u32(fwnode, "function-enumerator",
				       &props->func_enum);
	if (ret) {
		dev_err(dev,
			"Error parsing 'function-enumerator' property (%d)\n",
			ret);
	} else {
		props->func_enum_present = true;
	}
}

int led_compose_name(struct device *dev, struct led_init_data *init_data,
		     char *led_classdev_name)
{
	struct led_properties props = {};
	struct fwnode_handle *fwnode = init_data->fwnode;
	const char *devicename = init_data->devicename;

	if (!led_classdev_name)
		return -EINVAL;

	led_parse_fwnode_props(dev, fwnode, &props);

	if (props.label) {
		/*
		 * If init_data.devicename is NULL, then it indicates that
		 * DT label should be used as-is for LED class device name.
		 * Otherwise the label is prepended with devicename to compose
		 * the final LED class device name.
		 */
		if (!devicename) {
			strscpy(led_classdev_name, props.label,
				LED_MAX_NAME_SIZE);
		} else {
			snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
				 devicename, props.label);
		}
	} else if (props.function || props.color_present) {
		char tmp_buf[LED_MAX_NAME_SIZE];

		if (props.func_enum_present) {
			snprintf(tmp_buf, LED_MAX_NAME_SIZE, "%s:%s-%d",
				 props.color_present ? led_colors[props.color] : "",
				 props.function ?: "", props.func_enum);
		} else {
			snprintf(tmp_buf, LED_MAX_NAME_SIZE, "%s:%s",
				 props.color_present ? led_colors[props.color] : "",
				 props.function ?: "");
		}
		if (init_data->devname_mandatory) {
			snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
				 devicename, tmp_buf);
		} else {
			strscpy(led_classdev_name, tmp_buf, LED_MAX_NAME_SIZE);

		}
	} else if (init_data->default_label) {
		if (!devicename) {
			dev_err(dev, "Legacy LED naming requires devicename segment");
			return -EINVAL;
		}
		snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
			 devicename, init_data->default_label);
	} else if (is_of_node(fwnode)) {
		strscpy(led_classdev_name, to_of_node(fwnode)->name,
			LED_MAX_NAME_SIZE);
	} else
		return -EINVAL;

	return 0;
}
EXPORT_SYMBOL_GPL(led_compose_name);

enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode)
{
	const char *state = NULL;

	if (!fwnode_property_read_string(fwnode, "default-state", &state)) {
		if (!strcmp(state, "keep"))
			return LEDS_DEFSTATE_KEEP;
		if (!strcmp(state, "on"))
			return LEDS_DEFSTATE_ON;
	}

	return LEDS_DEFSTATE_OFF;
}
EXPORT_SYMBOL_GPL(led_init_default_state_get);
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
c72a1d60 RP	2	/*
	3	* LED Class Core
	4	*
	5	* Copyright 2005-2006 Openedhand Ltd.
	6	*
	7	* Author: Richard Purdie <rpurdie@openedhand.com>
c72a1d60 RP	8	*/
	9
	10	#include <linux/kernel.h>
04713306	11	#include <linux/leds.h>
c72a1d60 RP	12	#include <linux/list.h>
c72a1d60 RP	13	#include <linux/module.h>
04713306	14	#include <linux/mutex.h>
8e1f4561	15	#include <linux/of.h>
bb4e9af0	16	#include <linux/property.h>
72f8da32	17	#include <linux/rwsem.h>
8e1f4561	18	#include <linux/slab.h>
bb4e9af0	19	#include <uapi/linux/uleds.h>
c72a1d60 RP	20	#include "leds.h"
c72a1d60 RP	21
72f8da32	22	DECLARE_RWSEM(leds_list_lock);
4d404fd5	23	EXPORT_SYMBOL_GPL(leds_list_lock);
c72a1d60	24
4d404fd5	25	LIST_HEAD(leds_list);
c72a1d60	26	EXPORT_SYMBOL_GPL(leds_list);
a403d930	27
bb4e9af0 JA	28	const char * const led_colors[LED_COLOR_ID_MAX] = {
	29	[LED_COLOR_ID_WHITE] = "white",
	30	[LED_COLOR_ID_RED] = "red",
	31	[LED_COLOR_ID_GREEN] = "green",
	32	[LED_COLOR_ID_BLUE] = "blue",
	33	[LED_COLOR_ID_AMBER] = "amber",
	34	[LED_COLOR_ID_VIOLET] = "violet",
	35	[LED_COLOR_ID_YELLOW] = "yellow",
	36	[LED_COLOR_ID_IR] = "ir",
10d3e0d8	37	[LED_COLOR_ID_MULTI] = "multicolor",
54212f5a	38	[LED_COLOR_ID_RGB] = "rgb",
a0679431 OJ	39	[LED_COLOR_ID_PURPLE] = "purple",
	40	[LED_COLOR_ID_ORANGE] = "orange",
	41	[LED_COLOR_ID_PINK] = "pink",
	42	[LED_COLOR_ID_CYAN] = "cyan",
	43	[LED_COLOR_ID_LIME] = "lime",
bb4e9af0 JA	44	};
	45	EXPORT_SYMBOL_GPL(led_colors);
	46
af0bfab9	47	static int __led_set_brightness(struct led_classdev *led_cdev, unsigned int value)
d4887af9 HK	48	{
	49	if (!led_cdev->brightness_set)
	50	return -ENOTSUPP;
	51
	52	led_cdev->brightness_set(led_cdev, value);
	53
	54	return 0;
	55	}
	56
af0bfab9	57	static int __led_set_brightness_blocking(struct led_classdev *led_cdev, unsigned int value)
d4887af9 HK	58	{
	59	if (!led_cdev->brightness_set_blocking)
	60	return -ENOTSUPP;
	61
	62	return led_cdev->brightness_set_blocking(led_cdev, value);
	63	}
	64
49404665	65	static void led_timer_function(struct timer_list *t)
757b06ae	66	{
49404665	67	struct led_classdev *led_cdev = from_timer(led_cdev, t, blink_timer);
757b06ae JA	68	unsigned long brightness;
	69	unsigned long delay;
	70
	71	if (!led_cdev->blink_delay_on \|\| !led_cdev->blink_delay_off) {
81fe8e5b	72	led_set_brightness_nosleep(led_cdev, LED_OFF);
a9c6ce57	73	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
757b06ae JA	74	return;
	75	}
	76
a9c6ce57 HG	77	if (test_and_clear_bit(LED_BLINK_ONESHOT_STOP,
	78	&led_cdev->work_flags)) {
	79	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
757b06ae JA	80	return;
	81	}
	82
	83	brightness = led_get_brightness(led_cdev);
	84	if (!brightness) {
	85	/* Time to switch the LED on. */
eb1610b4 HG	86	if (test_and_clear_bit(LED_BLINK_BRIGHTNESS_CHANGE,
	87	&led_cdev->work_flags))
	88	brightness = led_cdev->new_blink_brightness;
	89	else
	90	brightness = led_cdev->blink_brightness;
757b06ae JA	91	delay = led_cdev->blink_delay_on;
	92	} else {
	93	/* Store the current brightness value to be able
	94	* to restore it when the delay_off period is over.
	95	*/
eb1610b4	96	led_cdev->blink_brightness = brightness;
757b06ae JA	97	brightness = LED_OFF;
	98	delay = led_cdev->blink_delay_off;
	99	}
	100
81fe8e5b	101	led_set_brightness_nosleep(led_cdev, brightness);
757b06ae JA	102
	103	/* Return in next iteration if led is in one-shot mode and we are in
	104	* the final blink state so that the led is toggled each delay_on +
	105	* delay_off milliseconds in worst case.
	106	*/
a9c6ce57 HG	107	if (test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags)) {
a9c6ce57 HG	108	if (test_bit(LED_BLINK_INVERT, &led_cdev->work_flags)) {
757b06ae	109	if (brightness)
a9c6ce57 HG	110	set_bit(LED_BLINK_ONESHOT_STOP,
a9c6ce57 HG	111	&led_cdev->work_flags);
757b06ae JA	112	} else {
757b06ae JA	113	if (!brightness)
a9c6ce57 HG	114	set_bit(LED_BLINK_ONESHOT_STOP,
a9c6ce57 HG	115	&led_cdev->work_flags);
757b06ae JA	116	}
	117	}
	118
	119	mod_timer(&led_cdev->blink_timer, jiffies + msecs_to_jiffies(delay));
	120	}
	121
fa15d8c6 HG	122	static void set_brightness_delayed_set_brightness(struct led_classdev *led_cdev,
fa15d8c6 HG	123	unsigned int value)
757b06ae	124	{
1afcadfc	125	int ret = 0;
757b06ae	126
fa15d8c6	127	ret = __led_set_brightness(led_cdev, value);
d4887af9	128	if (ret == -ENOTSUPP)
fa15d8c6	129	ret = __led_set_brightness_blocking(led_cdev, value);
d84d80f3 HK	130	if (ret < 0 &&
	131	/* LED HW might have been unplugged, therefore don't warn */
	132	!(ret == -ENODEV && (led_cdev->flags & LED_UNREGISTERING) &&
	133	(led_cdev->flags & LED_HW_PLUGGABLE)))
1afcadfc JA	134	dev_err(led_cdev->dev,
1afcadfc JA	135	"Setting an LED's brightness failed (%d)\n", ret);
757b06ae JA	136	}
757b06ae JA	137
fa15d8c6 HG	138	static void set_brightness_delayed(struct work_struct *ws)
	139	{
	140	struct led_classdev *led_cdev =
	141	container_of(ws, struct led_classdev, set_brightness_work);
	142
	143	if (test_and_clear_bit(LED_BLINK_DISABLE, &led_cdev->work_flags)) {
	144	led_stop_software_blink(led_cdev);
	145	set_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags);
	146	}
	147
	148	/*
	149	* Triggers may call led_set_brightness(LED_OFF),
	150	* led_set_brightness(LED_FULL) in quick succession to disable blinking
	151	* and turn the LED on. Both actions may have been scheduled to run
	152	* before this work item runs once. To make sure this works properly
	153	* handle LED_SET_BRIGHTNESS_OFF first.
	154	*/
	155	if (test_and_clear_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags))
	156	set_brightness_delayed_set_brightness(led_cdev, LED_OFF);
	157
	158	if (test_and_clear_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags))
	159	set_brightness_delayed_set_brightness(led_cdev, led_cdev->delayed_set_value);
22720a87 HG	160
	161	if (test_and_clear_bit(LED_SET_BLINK, &led_cdev->work_flags)) {
	162	unsigned long delay_on = led_cdev->delayed_delay_on;
	163	unsigned long delay_off = led_cdev->delayed_delay_off;
	164
	165	led_blink_set(led_cdev, &delay_on, &delay_off);
	166	}
fa15d8c6 HG	167	}
fa15d8c6 HG	168
a403d930 BW	169	static void led_set_software_blink(struct led_classdev *led_cdev,
	170	unsigned long delay_on,
	171	unsigned long delay_off)
	172	{
	173	int current_brightness;
	174
	175	current_brightness = led_get_brightness(led_cdev);
	176	if (current_brightness)
	177	led_cdev->blink_brightness = current_brightness;
	178	if (!led_cdev->blink_brightness)
	179	led_cdev->blink_brightness = led_cdev->max_brightness;
	180
a403d930 BW	181	led_cdev->blink_delay_on = delay_on;
	182	led_cdev->blink_delay_off = delay_off;
	183
8d82fef8 SS	184	/* never on - just set to off */
8d82fef8 SS	185	if (!delay_on) {
81fe8e5b	186	led_set_brightness_nosleep(led_cdev, LED_OFF);
a403d930	187	return;
8d82fef8	188	}
a403d930 BW	189
	190	/* never off - just set to brightness */
	191	if (!delay_off) {
81fe8e5b JA	192	led_set_brightness_nosleep(led_cdev,
81fe8e5b JA	193	led_cdev->blink_brightness);
a403d930 BW	194	return;
	195	}
	196
a9c6ce57	197	set_bit(LED_BLINK_SW, &led_cdev->work_flags);
9067359f	198	mod_timer(&led_cdev->blink_timer, jiffies + 1);
a403d930 BW	199	}
	200
	201
20c0e6b8	202	static void led_blink_setup(struct led_classdev *led_cdev,
5bb629c5 FB	203	unsigned long *delay_on,
5bb629c5 FB	204	unsigned long *delay_off)
a403d930	205	{
a9c6ce57	206	if (!test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags) &&
5bb629c5	207	led_cdev->blink_set &&
a403d930 BW	208	!led_cdev->blink_set(led_cdev, delay_on, delay_off))
	209	return;
	210
	211	/* blink with 1 Hz as default if nothing specified */
	212	if (!delay_on && !delay_off)
	213	delay_on = delay_off = 500;
	214
	215	led_set_software_blink(led_cdev, delay_on, delay_off);
	216	}
5bb629c5	217
757b06ae JA	218	void led_init_core(struct led_classdev *led_cdev)
	219	{
	220	INIT_WORK(&led_cdev->set_brightness_work, set_brightness_delayed);
	221
49404665	222	timer_setup(&led_cdev->blink_timer, led_timer_function, 0);
757b06ae JA	223	}
	224	EXPORT_SYMBOL_GPL(led_init_core);
	225
5bb629c5 FB	226	void led_blink_set(struct led_classdev *led_cdev,
	227	unsigned long *delay_on,
	228	unsigned long *delay_off)
	229	{
7b6af2c5	230	del_timer_sync(&led_cdev->blink_timer);
5bb629c5	231
7b6af2c5	232	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
a9c6ce57 HG	233	clear_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags);
a9c6ce57 HG	234	clear_bit(LED_BLINK_ONESHOT_STOP, &led_cdev->work_flags);
5bb629c5 FB	235
	236	led_blink_setup(led_cdev, delay_on, delay_off);
	237	}
2806e2ff	238	EXPORT_SYMBOL_GPL(led_blink_set);
a403d930	239
5bb629c5 FB	240	void led_blink_set_oneshot(struct led_classdev *led_cdev,
	241	unsigned long *delay_on,
	242	unsigned long *delay_off,
	243	int invert)
	244	{
a9c6ce57	245	if (test_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags) &&
9067359f	246	timer_pending(&led_cdev->blink_timer))
5bb629c5 FB	247	return;
5bb629c5 FB	248
a9c6ce57 HG	249	set_bit(LED_BLINK_ONESHOT, &led_cdev->work_flags);
a9c6ce57 HG	250	clear_bit(LED_BLINK_ONESHOT_STOP, &led_cdev->work_flags);
5bb629c5 FB	251
5bb629c5 FB	252	if (invert)
a9c6ce57	253	set_bit(LED_BLINK_INVERT, &led_cdev->work_flags);
5bb629c5	254	else
a9c6ce57	255	clear_bit(LED_BLINK_INVERT, &led_cdev->work_flags);
5bb629c5 FB	256
	257	led_blink_setup(led_cdev, delay_on, delay_off);
	258	}
2806e2ff	259	EXPORT_SYMBOL_GPL(led_blink_set_oneshot);
5bb629c5	260
22720a87 HG	261	void led_blink_set_nosleep(struct led_classdev *led_cdev, unsigned long delay_on,
	262	unsigned long delay_off)
	263	{
	264	/* If necessary delegate to a work queue task. */
	265	if (led_cdev->blink_set && led_cdev->brightness_set_blocking) {
	266	led_cdev->delayed_delay_on = delay_on;
	267	led_cdev->delayed_delay_off = delay_off;
	268	set_bit(LED_SET_BLINK, &led_cdev->work_flags);
	269	schedule_work(&led_cdev->set_brightness_work);
	270	return;
	271	}
	272
	273	led_blink_set(led_cdev, &delay_on, &delay_off);
	274	}
	275	EXPORT_SYMBOL_GPL(led_blink_set_nosleep);
	276
d23a22a7	277	void led_stop_software_blink(struct led_classdev *led_cdev)
a403d930	278	{
9067359f	279	del_timer_sync(&led_cdev->blink_timer);
43786482 FB	280	led_cdev->blink_delay_on = 0;
43786482 FB	281	led_cdev->blink_delay_off = 0;
a9c6ce57	282	clear_bit(LED_BLINK_SW, &led_cdev->work_flags);
d23a22a7 FB	283	}
	284	EXPORT_SYMBOL_GPL(led_stop_software_blink);
	285
af0bfab9	286	void led_set_brightness(struct led_classdev *led_cdev, unsigned int brightness)
d23a22a7	287	{
f1e80c07	288	/*
7cfe749f	289	* If software blink is active, delay brightness setting
f1e80c07 JA	290	* until the next timer tick.
f1e80c07 JA	291	*/
a9c6ce57	292	if (test_bit(LED_BLINK_SW, &led_cdev->work_flags)) {
f1e80c07 JA	293	/*
	294	* If we need to disable soft blinking delegate this to the
	295	* work queue task to avoid problems in case we are called
	296	* from hard irq context.
	297	*/
af0bfab9	298	if (!brightness) {
a9c6ce57	299	set_bit(LED_BLINK_DISABLE, &led_cdev->work_flags);
76931edd	300	schedule_work(&led_cdev->set_brightness_work);
f1e80c07	301	} else {
a9c6ce57 HG	302	set_bit(LED_BLINK_BRIGHTNESS_CHANGE,
a9c6ce57 HG	303	&led_cdev->work_flags);
eb1610b4	304	led_cdev->new_blink_brightness = brightness;
f1e80c07	305	}
d23a22a7 FB	306	return;
d23a22a7 FB	307	}
43786482	308
13ae79bb	309	led_set_brightness_nosleep(led_cdev, brightness);
a403d930	310	}
2806e2ff	311	EXPORT_SYMBOL_GPL(led_set_brightness);
3ef7de53	312
af0bfab9	313	void led_set_brightness_nopm(struct led_classdev *led_cdev, unsigned int value)
81fe8e5b JA	314	{
81fe8e5b JA	315	/* Use brightness_set op if available, it is guaranteed not to sleep */
d4887af9	316	if (!__led_set_brightness(led_cdev, value))
81fe8e5b	317	return;
81fe8e5b	318
fa15d8c6 HG	319	/*
	320	* Brightness setting can sleep, delegate it to a work queue task.
	321	* value 0 / LED_OFF is special, since it also disables hw-blinking
	322	* (sw-blink disable is handled in led_set_brightness()).
	323	* To avoid a hw-blink-disable getting lost when a second brightness
	324	* change is done immediately afterwards (before the work runs),
	325	* it uses a separate work_flag.
	326	*/
	327	if (value) {
	328	led_cdev->delayed_set_value = value;
	329	set_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags);
	330	} else {
	331	clear_bit(LED_SET_BRIGHTNESS, &led_cdev->work_flags);
22720a87	332	clear_bit(LED_SET_BLINK, &led_cdev->work_flags);
fa15d8c6 HG	333	set_bit(LED_SET_BRIGHTNESS_OFF, &led_cdev->work_flags);
	334	}
	335
81fe8e5b JA	336	schedule_work(&led_cdev->set_brightness_work);
	337	}
	338	EXPORT_SYMBOL_GPL(led_set_brightness_nopm);
	339
af0bfab9	340	void led_set_brightness_nosleep(struct led_classdev *led_cdev, unsigned int value)
81fe8e5b JA	341	{
	342	led_cdev->brightness = min(value, led_cdev->max_brightness);
	343
	344	if (led_cdev->flags & LED_SUSPENDED)
	345	return;
	346
	347	led_set_brightness_nopm(led_cdev, led_cdev->brightness);
	348	}
	349	EXPORT_SYMBOL_GPL(led_set_brightness_nosleep);
	350
af0bfab9	351	int led_set_brightness_sync(struct led_classdev *led_cdev, unsigned int value)
13ae79bb JA	352	{
	353	if (led_cdev->blink_delay_on \|\| led_cdev->blink_delay_off)
	354	return -EBUSY;
	355
	356	led_cdev->brightness = min(value, led_cdev->max_brightness);
	357
	358	if (led_cdev->flags & LED_SUSPENDED)
	359	return 0;
	360
d4887af9	361	return __led_set_brightness_blocking(led_cdev, led_cdev->brightness);
13ae79bb JA	362	}
	363	EXPORT_SYMBOL_GPL(led_set_brightness_sync);
	364
3ef7de53 JA	365	int led_update_brightness(struct led_classdev *led_cdev)
3ef7de53 JA	366	{
49e50aad	367	int ret;
3ef7de53 JA	368
	369	if (led_cdev->brightness_get) {
	370	ret = led_cdev->brightness_get(led_cdev);
49e50aad AS	371	if (ret < 0)
	372	return ret;
	373
	374	led_cdev->brightness = ret;
3ef7de53 JA	375	}
3ef7de53 JA	376
49e50aad	377	return 0;
3ef7de53	378	}
2806e2ff	379	EXPORT_SYMBOL_GPL(led_update_brightness);
acd899e4	380
8e1f4561 KK	381	u32 led_get_default_pattern(struct led_classdev led_cdev, unsigned int *size)
8e1f4561 KK	382	{
fd81d7e9	383	struct fwnode_handle *fwnode = led_cdev->dev->fwnode;
8e1f4561 KK	384	u32 *pattern;
	385	int count;
	386
fd81d7e9	387	count = fwnode_property_count_u32(fwnode, "led-pattern");
8e1f4561 KK	388	if (count < 0)
	389	return NULL;
	390
	391	pattern = kcalloc(count, sizeof(*pattern), GFP_KERNEL);
	392	if (!pattern)
	393	return NULL;
	394
fd81d7e9	395	if (fwnode_property_read_u32_array(fwnode, "led-pattern", pattern, count)) {
8e1f4561 KK	396	kfree(pattern);
	397	return NULL;
	398	}
	399
	400	*size = count;
	401
	402	return pattern;
	403	}
	404	EXPORT_SYMBOL_GPL(led_get_default_pattern);
	405
acd899e4 JA	406	/* Caller must ensure led_cdev->led_access held */
	407	void led_sysfs_disable(struct led_classdev *led_cdev)
	408	{
	409	lockdep_assert_held(&led_cdev->led_access);
	410
	411	led_cdev->flags \|= LED_SYSFS_DISABLE;
	412	}
	413	EXPORT_SYMBOL_GPL(led_sysfs_disable);
	414
	415	/* Caller must ensure led_cdev->led_access held */
	416	void led_sysfs_enable(struct led_classdev *led_cdev)
	417	{
	418	lockdep_assert_held(&led_cdev->led_access);
	419
	420	led_cdev->flags &= ~LED_SYSFS_DISABLE;
	421	}
	422	EXPORT_SYMBOL_GPL(led_sysfs_enable);
bb4e9af0 JA	423
	424	static void led_parse_fwnode_props(struct device *dev,
	425	struct fwnode_handle *fwnode,
	426	struct led_properties *props)
	427	{
	428	int ret;
	429
	430	if (!fwnode)
	431	return;
	432
	433	if (fwnode_property_present(fwnode, "label")) {
	434	ret = fwnode_property_read_string(fwnode, "label", &props->label);
	435	if (ret)
	436	dev_err(dev, "Error parsing 'label' property (%d)\n", ret);
	437	return;
	438	}
	439
	440	if (fwnode_property_present(fwnode, "color")) {
	441	ret = fwnode_property_read_u32(fwnode, "color", &props->color);
	442	if (ret)
	443	dev_err(dev, "Error parsing 'color' property (%d)\n", ret);
	444	else if (props->color >= LED_COLOR_ID_MAX)
	445	dev_err(dev, "LED color identifier out of range\n");
	446	else
	447	props->color_present = true;
	448	}
	449
	450
	451	if (!fwnode_property_present(fwnode, "function"))
	452	return;
	453
	454	ret = fwnode_property_read_string(fwnode, "function", &props->function);
	455	if (ret) {
	456	dev_err(dev,
	457	"Error parsing 'function' property (%d)\n",
	458	ret);
	459	}
	460
	461	if (!fwnode_property_present(fwnode, "function-enumerator"))
	462	return;
	463
	464	ret = fwnode_property_read_u32(fwnode, "function-enumerator",
	465	&props->func_enum);
	466	if (ret) {
	467	dev_err(dev,
	468	"Error parsing 'function-enumerator' property (%d)\n",
	469	ret);
	470	} else {
	471	props->func_enum_present = true;
	472	}
	473	}
	474
	475	int led_compose_name(struct device dev, struct led_init_data init_data,
	476	char *led_classdev_name)
	477	{
	478	struct led_properties props = {};
	479	struct fwnode_handle *fwnode = init_data->fwnode;
	480	const char *devicename = init_data->devicename;
	481
	482	if (!led_classdev_name)
	483	return -EINVAL;
	484
	485	led_parse_fwnode_props(dev, fwnode, &props);
	486
487	if (props.label) {
488	/*
489	* If init_data.devicename is NULL, then it indicates that
490	* DT label should be used as-is for LED class device name.
491	* Otherwise the label is prepended with devicename to compose
492	* the final LED class device name.
493	*/
494	if (!devicename) {
495	strscpy(led_classdev_name, props.label,
496	LED_MAX_NAME_SIZE);
497	} else {
498	snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
499	devicename, props.label);
500	}
501	} else if (props.function \|\| props.color_present) {
502	char tmp_buf[LED_MAX_NAME_SIZE];
503
504	if (props.func_enum_present) {
505	snprintf(tmp_buf, LED_MAX_NAME_SIZE, "%s:%s-%d",
506	props.color_present ? led_colors[props.color] : "",
507	props.function ?: "", props.func_enum);
508	} else {
509	snprintf(tmp_buf, LED_MAX_NAME_SIZE, "%s:%s",
510	props.color_present ? led_colors[props.color] : "",
511	props.function ?: "");
512	}
513	if (init_data->devname_mandatory) {
514	snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
515	devicename, tmp_buf);
516	} else {
517	strscpy(led_classdev_name, tmp_buf, LED_MAX_NAME_SIZE);
518
519	}
520	} else if (init_data->default_label) {
521	if (!devicename) {
522	dev_err(dev, "Legacy LED naming requires devicename segment");
523	return -EINVAL;
524	}
525	snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
526	devicename, init_data->default_label);
527	} else if (is_of_node(fwnode)) {
528	strscpy(led_classdev_name, to_of_node(fwnode)->name,
529	LED_MAX_NAME_SIZE);
530	} else
531	return -EINVAL;
532
533	return 0;
534	}
535	EXPORT_SYMBOL_GPL(led_compose_name);
791bc411 DOH	536
	537	enum led_default_state led_init_default_state_get(struct fwnode_handle *fwnode)
	538	{
	539	const char *state = NULL;
	540
	541	if (!fwnode_property_read_string(fwnode, "default-state", &state)) {
	542	if (!strcmp(state, "keep"))
	543	return LEDS_DEFSTATE_KEEP;
	544	if (!strcmp(state, "on"))
	545	return LEDS_DEFSTATE_ON;
	546	}
	547
	548	return LEDS_DEFSTATE_OFF;
	549	}
	550	EXPORT_SYMBOL_GPL(led_init_default_state_get);