[mirror_ubuntu-zesty-kernel.git] / include / linux / leds.h

/*
 * Driver model for leds and led triggers
 *
 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
 * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
 *
 * 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.
 *
 */
#ifndef __LINUX_LEDS_H_INCLUDED
#define __LINUX_LEDS_H_INCLUDED

#include <linux/device.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rwsem.h>
#include <linux/spinlock.h>
#include <linux/timer.h>
#include <linux/workqueue.h>

struct device;
/*
 * LED Core
 */

enum led_brightness {
	LED_OFF		= 0,
	LED_HALF	= 127,
	LED_FULL	= 255,
};

struct led_classdev {
	const char		*name;
	enum led_brightness	 brightness;
	enum led_brightness	 max_brightness;
	int			 flags;

	/* Lower 16 bits reflect status */
#define LED_SUSPENDED		(1 << 0)
	/* Upper 16 bits reflect control information */
#define LED_CORE_SUSPENDRESUME	(1 << 16)
#define LED_BLINK_ONESHOT	(1 << 17)
#define LED_BLINK_ONESHOT_STOP	(1 << 18)
#define LED_BLINK_INVERT	(1 << 19)
#define LED_SYSFS_DISABLE	(1 << 20)
#define SET_BRIGHTNESS_ASYNC	(1 << 21)
#define SET_BRIGHTNESS_SYNC	(1 << 22)
#define LED_DEV_CAP_FLASH	(1 << 23)

	/* Set LED brightness level */
	/* Must not sleep, use a workqueue if needed */
	void		(*brightness_set)(struct led_classdev *led_cdev,
					  enum led_brightness brightness);
	/*
	 * Set LED brightness level immediately - it can block the caller for
	 * the time required for accessing a LED device register.
	 */
	int		(*brightness_set_sync)(struct led_classdev *led_cdev,
					enum led_brightness brightness);
	/* Get LED brightness level */
	enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);

	/*
	 * Activate hardware accelerated blink, delays are in milliseconds
	 * and if both are zero then a sensible default should be chosen.
	 * The call should adjust the timings in that case and if it can't
	 * match the values specified exactly.
	 * Deactivate blinking again when the brightness is set to a fixed
	 * value via the brightness_set() callback.
	 */
	int		(*blink_set)(struct led_classdev *led_cdev,
				     unsigned long *delay_on,
				     unsigned long *delay_off);

	struct device		*dev;
	const struct attribute_group	**groups;

	struct list_head	 node;			/* LED Device list */
	const char		*default_trigger;	/* Trigger to use */

	unsigned long		 blink_delay_on, blink_delay_off;
	struct timer_list	 blink_timer;
	int			 blink_brightness;
	void			(*flash_resume)(struct led_classdev *led_cdev);

	struct work_struct	set_brightness_work;
	int			delayed_set_value;

#ifdef CONFIG_LEDS_TRIGGERS
	/* Protects the trigger data below */
	struct rw_semaphore	 trigger_lock;

	struct led_trigger	*trigger;
	struct list_head	 trig_list;
	void			*trigger_data;
	/* true if activated - deactivate routine uses it to do cleanup */
	bool			activated;
#endif

	/* Ensures consistent access to the LED Flash Class device */
	struct mutex		led_access;
};

extern int led_classdev_register(struct device *parent,
				 struct led_classdev *led_cdev);
extern int devm_led_classdev_register(struct device *parent,
				      struct led_classdev *led_cdev);
extern void led_classdev_unregister(struct led_classdev *led_cdev);
extern void devm_led_classdev_unregister(struct device *parent,
					 struct led_classdev *led_cdev);
extern void led_classdev_suspend(struct led_classdev *led_cdev);
extern void led_classdev_resume(struct led_classdev *led_cdev);

/**
 * led_blink_set - set blinking with software fallback
 * @led_cdev: the LED to start blinking
 * @delay_on: the time it should be on (in ms)
 * @delay_off: the time it should ble off (in ms)
 *
 * This function makes the LED blink, attempting to use the
 * hardware acceleration if possible, but falling back to
 * software blinking if there is no hardware blinking or if
 * the LED refuses the passed values.
 *
 * Note that if software blinking is active, simply calling
 * led_cdev->brightness_set() will not stop the blinking,
 * use led_classdev_brightness_set() instead.
 */
extern void led_blink_set(struct led_classdev *led_cdev,
			  unsigned long *delay_on,
			  unsigned long *delay_off);
/**
 * led_blink_set_oneshot - do a oneshot software blink
 * @led_cdev: the LED to start blinking
 * @delay_on: the time it should be on (in ms)
 * @delay_off: the time it should ble off (in ms)
 * @invert: blink off, then on, leaving the led on
 *
 * This function makes the LED blink one time for delay_on +
 * delay_off time, ignoring the request if another one-shot
 * blink is already in progress.
 *
 * If invert is set, led blinks for delay_off first, then for
 * delay_on and leave the led on after the on-off cycle.
 */
extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
				  unsigned long *delay_on,
				  unsigned long *delay_off,
				  int invert);
/**
 * led_set_brightness - set LED brightness
 * @led_cdev: the LED to set
 * @brightness: the brightness to set it to
 *
 * Set an LED's brightness, and, if necessary, cancel the
 * software blink timer that implements blinking when the
 * hardware doesn't.
 */
extern void led_set_brightness(struct led_classdev *led_cdev,
			       enum led_brightness brightness);
/**
 * led_update_brightness - update LED brightness
 * @led_cdev: the LED to query
 *
 * Get an LED's current brightness and update led_cdev->brightness
 * member with the obtained value.
 *
 * Returns: 0 on success or negative error value on failure
 */
extern int led_update_brightness(struct led_classdev *led_cdev);

/**
 * led_sysfs_disable - disable LED sysfs interface
 * @led_cdev: the LED to set
 *
 * Disable the led_cdev's sysfs interface.
 */
extern void led_sysfs_disable(struct led_classdev *led_cdev);

/**
 * led_sysfs_enable - enable LED sysfs interface
 * @led_cdev: the LED to set
 *
 * Enable the led_cdev's sysfs interface.
 */
extern void led_sysfs_enable(struct led_classdev *led_cdev);

/**
 * led_sysfs_is_disabled - check if LED sysfs interface is disabled
 * @led_cdev: the LED to query
 *
 * Returns: true if the led_cdev's sysfs interface is disabled.
 */
static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
{
	return led_cdev->flags & LED_SYSFS_DISABLE;
}

/*
 * LED Triggers
 */
/* Registration functions for simple triggers */
#define DEFINE_LED_TRIGGER(x)		static struct led_trigger *x;
#define DEFINE_LED_TRIGGER_GLOBAL(x)	struct led_trigger *x;

#ifdef CONFIG_LEDS_TRIGGERS

#define TRIG_NAME_MAX 50

struct led_trigger {
	/* Trigger Properties */
	const char	 *name;
	void		(*activate)(struct led_classdev *led_cdev);
	void		(*deactivate)(struct led_classdev *led_cdev);

	/* LEDs under control by this trigger (for simple triggers) */
	rwlock_t	  leddev_list_lock;
	struct list_head  led_cdevs;

	/* Link to next registered trigger */
	struct list_head  next_trig;
};

ssize_t led_trigger_store(struct device *dev, struct device_attribute *attr,
			const char *buf, size_t count);
ssize_t led_trigger_show(struct device *dev, struct device_attribute *attr,
			char *buf);

/* Registration functions for complex triggers */
extern int led_trigger_register(struct led_trigger *trigger);
extern void led_trigger_unregister(struct led_trigger *trigger);

extern void led_trigger_register_simple(const char *name,
				struct led_trigger **trigger);
extern void led_trigger_unregister_simple(struct led_trigger *trigger);
extern void led_trigger_event(struct led_trigger *trigger,
				enum led_brightness event);
extern void led_trigger_blink(struct led_trigger *trigger,
			      unsigned long *delay_on,
			      unsigned long *delay_off);
extern void led_trigger_blink_oneshot(struct led_trigger *trigger,
				      unsigned long *delay_on,
				      unsigned long *delay_off,
				      int invert);
extern void led_trigger_set_default(struct led_classdev *led_cdev);
extern void led_trigger_set(struct led_classdev *led_cdev,
			struct led_trigger *trigger);
extern void led_trigger_remove(struct led_classdev *led_cdev);

static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
{
	return led_cdev->trigger_data;
}

/**
 * led_trigger_rename_static - rename a trigger
 * @name: the new trigger name
 * @trig: the LED trigger to rename
 *
 * Change a LED trigger name by copying the string passed in
 * name into current trigger name, which MUST be large
 * enough for the new string.
 *
 * Note that name must NOT point to the same string used
 * during LED registration, as that could lead to races.
 *
 * This is meant to be used on triggers with statically
 * allocated name.
 */
extern void led_trigger_rename_static(const char *name,
				      struct led_trigger *trig);

#else

/* Trigger has no members */
struct led_trigger {};

/* Trigger inline empty functions */
static inline void led_trigger_register_simple(const char *name,
					struct led_trigger **trigger) {}
static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
static inline void led_trigger_event(struct led_trigger *trigger,
				enum led_brightness event) {}
static inline void led_trigger_blink(struct led_trigger *trigger,
				      unsigned long *delay_on,
				      unsigned long *delay_off) {}
static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
				      unsigned long *delay_on,
				      unsigned long *delay_off,
				      int invert) {}
static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
static inline void led_trigger_set(struct led_classdev *led_cdev,
				struct led_trigger *trigger) {}
static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
static inline void *led_get_trigger_data(struct led_classdev *led_cdev)
{
	return NULL;
}

#endif /* CONFIG_LEDS_TRIGGERS */

/* Trigger specific functions */
#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
extern void ledtrig_ide_activity(void);
#else
static inline void ledtrig_ide_activity(void) {}
#endif

#if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
extern void ledtrig_flash_ctrl(bool on);
extern void ledtrig_torch_ctrl(bool on);
#else
static inline void ledtrig_flash_ctrl(bool on) {}
static inline void ledtrig_torch_ctrl(bool on) {}
#endif

/*
 * Generic LED platform data for describing LED names and default triggers.
 */
struct led_info {
	const char	*name;
	const char	*default_trigger;
	int		flags;
};

struct led_platform_data {
	int		num_leds;
	struct led_info	*leds;
};

/* For the leds-gpio driver */
struct gpio_led {
	const char *name;
	const char *default_trigger;
	unsigned 	gpio;
	unsigned	active_low : 1;
	unsigned	retain_state_suspended : 1;
	unsigned	default_state : 2;
	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
	struct gpio_desc *gpiod;
};
#define LEDS_GPIO_DEFSTATE_OFF		0
#define LEDS_GPIO_DEFSTATE_ON		1
#define LEDS_GPIO_DEFSTATE_KEEP		2

struct gpio_led_platform_data {
	int 		num_leds;
	const struct gpio_led *leds;

#define GPIO_LED_NO_BLINK_LOW	0	/* No blink GPIO state low */
#define GPIO_LED_NO_BLINK_HIGH	1	/* No blink GPIO state high */
#define GPIO_LED_BLINK		2	/* Please, blink */
	int		(*gpio_blink_set)(struct gpio_desc *desc, int state,
					unsigned long *delay_on,
					unsigned long *delay_off);
};

struct platform_device *gpio_led_register_device(
		int id, const struct gpio_led_platform_data *pdata);

enum cpu_led_event {
	CPU_LED_IDLE_START,	/* CPU enters idle */
	CPU_LED_IDLE_END,	/* CPU idle ends */
	CPU_LED_START,		/* Machine starts, especially resume */
	CPU_LED_STOP,		/* Machine stops, especially suspend */
	CPU_LED_HALTED,		/* Machine shutdown */
};
#ifdef CONFIG_LEDS_TRIGGER_CPU
extern void ledtrig_cpu(enum cpu_led_event evt);
#else
static inline void ledtrig_cpu(enum cpu_led_event evt)
{
	return;
}
#endif

#endif		/* __LINUX_LEDS_H_INCLUDED */
Commit	Line	Data
c72a1d60 RP	1	/*
	2	* Driver model for leds and led triggers
	3	*
	4	* Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
	5	* Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*
	11	*/
	12	#ifndef __LINUX_LEDS_H_INCLUDED
	13	#define __LINUX_LEDS_H_INCLUDED
	14
20f56758	15	#include <linux/device.h>
af410fc1	16	#include <linux/list.h>
acd899e4	17	#include <linux/mutex.h>
dc47206e	18	#include <linux/rwsem.h>
04713306	19	#include <linux/spinlock.h>
9067359f	20	#include <linux/timer.h>
d23a22a7	21	#include <linux/workqueue.h>
af410fc1	22
c72a1d60	23	struct device;
c72a1d60 RP	24	/*
	25	* LED Core
	26	*/
	27
	28	enum led_brightness {
fb5035db BD	29	LED_OFF = 0,
	30	LED_HALF = 127,
	31	LED_FULL = 255,
c72a1d60 RP	32	};
	33
	34	struct led_classdev {
fb5035db	35	const char *name;
d8082827 JA	36	enum led_brightness brightness;
d8082827 JA	37	enum led_brightness max_brightness;
fb5035db	38	int flags;
c72a1d60	39
859cb7f2	40	/* Lower 16 bits reflect status */
fb5035db	41	#define LED_SUSPENDED (1 << 0)
859cb7f2 RP	42	/* Upper 16 bits reflect control information */
859cb7f2 RP	43	#define LED_CORE_SUSPENDRESUME (1 << 16)
5bb629c5 FB	44	#define LED_BLINK_ONESHOT (1 << 17)
	45	#define LED_BLINK_ONESHOT_STOP (1 << 18)
	46	#define LED_BLINK_INVERT (1 << 19)
acd899e4	47	#define LED_SYSFS_DISABLE (1 << 20)
4d71a4a1 JA	48	#define SET_BRIGHTNESS_ASYNC (1 << 21)
4d71a4a1 JA	49	#define SET_BRIGHTNESS_SYNC (1 << 22)
7aea8389	50	#define LED_DEV_CAP_FLASH (1 << 23)
c72a1d60	51
fb5035db	52	/* Set LED brightness level */
2e214e0f	53	/* Must not sleep, use a workqueue if needed */
fb5035db BD	54	void (brightness_set)(struct led_classdev led_cdev,
fb5035db BD	55	enum led_brightness brightness);
4d71a4a1 JA	56	/*
	57	* Set LED brightness level immediately - it can block the caller for
	58	* the time required for accessing a LED device register.
	59	*/
	60	int (brightness_set_sync)(struct led_classdev led_cdev,
	61	enum led_brightness brightness);
29d76dfa HMH	62	/* Get LED brightness level */
29d76dfa HMH	63	enum led_brightness (brightness_get)(struct led_classdev led_cdev);
fb5035db	64
5ada28bf JB	65	/*
	66	* Activate hardware accelerated blink, delays are in milliseconds
	67	* and if both are zero then a sensible default should be chosen.
	68	* The call should adjust the timings in that case and if it can't
	69	* match the values specified exactly.
	70	* Deactivate blinking again when the brightness is set to a fixed
	71	* value via the brightness_set() callback.
	72	*/
4c79141d MN	73	int (blink_set)(struct led_classdev led_cdev,
	74	unsigned long *delay_on,
	75	unsigned long *delay_off);
	76
f8a7c6fe	77	struct device *dev;
d0d480cc JH	78	const struct attribute_group **groups;
d0d480cc JH	79
fb5035db	80	struct list_head node; /* LED Device list */
781a54e7	81	const char default_trigger; / Trigger to use */
c72a1d60	82
5ada28bf	83	unsigned long blink_delay_on, blink_delay_off;
9067359f	84	struct timer_list blink_timer;
5ada28bf	85	int blink_brightness;
7aea8389	86	void (flash_resume)(struct led_classdev led_cdev);
5ada28bf	87
d23a22a7 FB	88	struct work_struct set_brightness_work;
	89	int delayed_set_value;
	90
c3bc9956	91	#ifdef CONFIG_LEDS_TRIGGERS
c3bc9956	92	/* Protects the trigger data below */
dc47206e	93	struct rw_semaphore trigger_lock;
c3bc9956	94
fb5035db BD	95	struct led_trigger *trigger;
	96	struct list_head trig_list;
	97	void *trigger_data;
b0096182 SK	98	/* true if activated - deactivate routine uses it to do cleanup */
b0096182 SK	99	bool activated;
c3bc9956	100	#endif
acd899e4 JA	101
	102	/* Ensures consistent access to the LED Flash Class device */
	103	struct mutex led_access;
c72a1d60 RP	104	};
	105
	106	extern int led_classdev_register(struct device *parent,
fb5035db	107	struct led_classdev *led_cdev);
ca1bb4ee BA	108	extern int devm_led_classdev_register(struct device *parent,
ca1bb4ee BA	109	struct led_classdev *led_cdev);
e2387d6c	110	extern void led_classdev_unregister(struct led_classdev *led_cdev);
ca1bb4ee BA	111	extern void devm_led_classdev_unregister(struct device *parent,
ca1bb4ee BA	112	struct led_classdev *led_cdev);
c72a1d60 RP	113	extern void led_classdev_suspend(struct led_classdev *led_cdev);
	114	extern void led_classdev_resume(struct led_classdev *led_cdev);
	115
5ada28bf JB	116	/**
	117	* led_blink_set - set blinking with software fallback
	118	* @led_cdev: the LED to start blinking
	119	* @delay_on: the time it should be on (in ms)
	120	* @delay_off: the time it should ble off (in ms)
	121	*
	122	* This function makes the LED blink, attempting to use the
	123	* hardware acceleration if possible, but falling back to
	124	* software blinking if there is no hardware blinking or if
	125	* the LED refuses the passed values.
	126	*
	127	* Note that if software blinking is active, simply calling
	128	* led_cdev->brightness_set() will not stop the blinking,
	129	* use led_classdev_brightness_set() instead.
	130	*/
	131	extern void led_blink_set(struct led_classdev *led_cdev,
	132	unsigned long *delay_on,
	133	unsigned long *delay_off);
5bb629c5 FB	134	/**
	135	* led_blink_set_oneshot - do a oneshot software blink
	136	* @led_cdev: the LED to start blinking
	137	* @delay_on: the time it should be on (in ms)
	138	* @delay_off: the time it should ble off (in ms)
	139	* @invert: blink off, then on, leaving the led on
	140	*
	141	* This function makes the LED blink one time for delay_on +
	142	* delay_off time, ignoring the request if another one-shot
	143	* blink is already in progress.
	144	*
	145	* If invert is set, led blinks for delay_off first, then for
	146	* delay_on and leave the led on after the on-off cycle.
	147	*/
	148	extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
	149	unsigned long *delay_on,
	150	unsigned long *delay_off,
	151	int invert);
5ada28bf	152	/**
19cd67e2	153	* led_set_brightness - set LED brightness
5ada28bf JB	154	* @led_cdev: the LED to set
	155	* @brightness: the brightness to set it to
	156	*
	157	* Set an LED's brightness, and, if necessary, cancel the
	158	* software blink timer that implements blinking when the
	159	* hardware doesn't.
	160	*/
19cd67e2	161	extern void led_set_brightness(struct led_classdev *led_cdev,
5ada28bf	162	enum led_brightness brightness);
3ef7de53 JA	163	/**
	164	* led_update_brightness - update LED brightness
	165	* @led_cdev: the LED to query
	166	*
	167	* Get an LED's current brightness and update led_cdev->brightness
	168	* member with the obtained value.
	169	*
	170	* Returns: 0 on success or negative error value on failure
	171	*/
	172	extern int led_update_brightness(struct led_classdev *led_cdev);
5ada28bf	173
acd899e4 JA	174	/**
	175	* led_sysfs_disable - disable LED sysfs interface
	176	* @led_cdev: the LED to set
	177	*
	178	* Disable the led_cdev's sysfs interface.
	179	*/
	180	extern void led_sysfs_disable(struct led_classdev *led_cdev);
	181
	182	/**
	183	* led_sysfs_enable - enable LED sysfs interface
	184	* @led_cdev: the LED to set
	185	*
	186	* Enable the led_cdev's sysfs interface.
	187	*/
	188	extern void led_sysfs_enable(struct led_classdev *led_cdev);
	189
	190	/**
	191	* led_sysfs_is_disabled - check if LED sysfs interface is disabled
	192	* @led_cdev: the LED to query
	193	*
	194	* Returns: true if the led_cdev's sysfs interface is disabled.
	195	*/
	196	static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev)
	197	{
	198	return led_cdev->flags & LED_SYSFS_DISABLE;
	199	}
	200
c3bc9956 RP	201	/*
	202	* LED Triggers
	203	*/
39f7e08a KM	204	/* Registration functions for simple triggers */
	205	#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
	206	#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
	207
c3bc9956 RP	208	#ifdef CONFIG_LEDS_TRIGGERS
	209
	210	#define TRIG_NAME_MAX 50
	211
	212	struct led_trigger {
	213	/* Trigger Properties */
fb5035db BD	214	const char *name;
	215	void (activate)(struct led_classdev led_cdev);
	216	void (deactivate)(struct led_classdev led_cdev);
c3bc9956 RP	217
c3bc9956 RP	218	/* LEDs under control by this trigger (for simple triggers) */
fb5035db BD	219	rwlock_t leddev_list_lock;
fb5035db BD	220	struct list_head led_cdevs;
c3bc9956 RP	221
c3bc9956 RP	222	/* Link to next registered trigger */
fb5035db	223	struct list_head next_trig;
c3bc9956 RP	224	};
c3bc9956 RP	225
20f56758 JA	226	ssize_t led_trigger_store(struct device dev, struct device_attribute attr,
	227	const char *buf, size_t count);
	228	ssize_t led_trigger_show(struct device dev, struct device_attribute attr,
	229	char *buf);
	230
c3bc9956 RP	231	/* Registration functions for complex triggers */
	232	extern int led_trigger_register(struct led_trigger *trigger);
	233	extern void led_trigger_unregister(struct led_trigger *trigger);
	234
c3bc9956 RP	235	extern void led_trigger_register_simple(const char *name,
	236	struct led_trigger **trigger);
	237	extern void led_trigger_unregister_simple(struct led_trigger *trigger);
	238	extern void led_trigger_event(struct led_trigger *trigger,
	239	enum led_brightness event);
0b9536c9 VK	240	extern void led_trigger_blink(struct led_trigger *trigger,
	241	unsigned long *delay_on,
	242	unsigned long *delay_off);
5bb629c5 FB	243	extern void led_trigger_blink_oneshot(struct led_trigger *trigger,
	244	unsigned long *delay_on,
	245	unsigned long *delay_off,
	246	int invert);
20f56758 JA	247	extern void led_trigger_set_default(struct led_classdev *led_cdev);
	248	extern void led_trigger_set(struct led_classdev *led_cdev,
	249	struct led_trigger *trigger);
	250	extern void led_trigger_remove(struct led_classdev *led_cdev);
	251
	252	static inline void led_get_trigger_data(struct led_classdev led_cdev)
	253	{
	254	return led_cdev->trigger_data;
	255	}
	256
057407c7 JH	257	/**
	258	* led_trigger_rename_static - rename a trigger
	259	* @name: the new trigger name
	260	* @trig: the LED trigger to rename
	261	*
	262	* Change a LED trigger name by copying the string passed in
	263	* name into current trigger name, which MUST be large
	264	* enough for the new string.
	265	*
	266	* Note that name must NOT point to the same string used
	267	* during LED registration, as that could lead to races.
	268	*
	269	* This is meant to be used on triggers with statically
	270	* allocated name.
	271	*/
	272	extern void led_trigger_rename_static(const char *name,
	273	struct led_trigger *trig);
c3bc9956 RP	274
	275	#else
	276
39f7e08a KM	277	/* Trigger has no members */
39f7e08a KM	278	struct led_trigger {};
c3bc9956	279
39f7e08a KM	280	/* Trigger inline empty functions */
	281	static inline void led_trigger_register_simple(const char *name,
	282	struct led_trigger **trigger) {}
	283	static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
	284	static inline void led_trigger_event(struct led_trigger *trigger,
	285	enum led_brightness event) {}
8890624a MG	286	static inline void led_trigger_blink(struct led_trigger *trigger,
	287	unsigned long *delay_on,
	288	unsigned long *delay_off) {}
	289	static inline void led_trigger_blink_oneshot(struct led_trigger *trigger,
	290	unsigned long *delay_on,
	291	unsigned long *delay_off,
	292	int invert) {}
20f56758 JA	293	static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}
	294	static inline void led_trigger_set(struct led_classdev *led_cdev,
	295	struct led_trigger *trigger) {}
	296	static inline void led_trigger_remove(struct led_classdev *led_cdev) {}
	297	static inline void led_get_trigger_data(struct led_classdev led_cdev)
	298	{
	299	return NULL;
	300	}
	301
39f7e08a	302	#endif /* CONFIG_LEDS_TRIGGERS */
2bfb646c RP	303
	304	/* Trigger specific functions */
	305	#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
	306	extern void ledtrig_ide_activity(void);
	307	#else
39f7e08a	308	static inline void ledtrig_ide_activity(void) {}
2bfb646c RP	309	#endif
2bfb646c RP	310
48a1d032 KM	311	#if defined(CONFIG_LEDS_TRIGGER_CAMERA) \|\| defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
	312	extern void ledtrig_flash_ctrl(bool on);
	313	extern void ledtrig_torch_ctrl(bool on);
	314	#else
	315	static inline void ledtrig_flash_ctrl(bool on) {}
	316	static inline void ledtrig_torch_ctrl(bool on) {}
	317	#endif
	318
f46e9203 NC	319	/*
	320	* Generic LED platform data for describing LED names and default triggers.
	321	*/
	322	struct led_info {
	323	const char *name;
326bb8a5	324	const char *default_trigger;
f46e9203 NC	325	int flags;
	326	};
	327
	328	struct led_platform_data {
	329	int num_leds;
	330	struct led_info *leds;
	331	};
	332
22e03f3b RA	333	/* For the leds-gpio driver */
	334	struct gpio_led {
	335	const char *name;
326bb8a5	336	const char *default_trigger;
22e03f3b	337	unsigned gpio;
ed88bae6 TP	338	unsigned active_low : 1;
	339	unsigned retain_state_suspended : 1;
	340	unsigned default_state : 2;
	341	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON\|OFF\|KEEP) */
5c51277a	342	struct gpio_desc *gpiod;
22e03f3b	343	};
2146325d BH	344	#define LEDS_GPIO_DEFSTATE_OFF 0
	345	#define LEDS_GPIO_DEFSTATE_ON 1
	346	#define LEDS_GPIO_DEFSTATE_KEEP 2
22e03f3b RA	347
	348	struct gpio_led_platform_data {
	349	int num_leds;
9517f925	350	const struct gpio_led *leds;
2146325d BH	351
	352	#define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
	353	#define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
9517f925	354	#define GPIO_LED_BLINK 2 /* Please, blink */
c673a2b4	355	int (gpio_blink_set)(struct gpio_desc desc, int state,
ca3259b3 HVR	356	unsigned long *delay_on,
ca3259b3 HVR	357	unsigned long *delay_off);
22e03f3b RA	358	};
22e03f3b RA	359
4440673a UKK	360	struct platform_device *gpio_led_register_device(
4440673a UKK	361	int id, const struct gpio_led_platform_data *pdata);
22e03f3b	362
8f88731d BW	363	enum cpu_led_event {
	364	CPU_LED_IDLE_START, /* CPU enters idle */
	365	CPU_LED_IDLE_END, /* CPU idle ends */
	366	CPU_LED_START, /* Machine starts, especially resume */
	367	CPU_LED_STOP, /* Machine stops, especially suspend */
	368	CPU_LED_HALTED, /* Machine shutdown */
	369	};
	370	#ifdef CONFIG_LEDS_TRIGGER_CPU
	371	extern void ledtrig_cpu(enum cpu_led_event evt);
	372	#else
	373	static inline void ledtrig_cpu(enum cpu_led_event evt)
	374	{
	375	return;
	376	}
	377	#endif
	378
c72a1d60	379	#endif /* __LINUX_LEDS_H_INCLUDED */