[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/list.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)

	/* Set LED brightness level */
	/* Must not sleep, use a workqueue if needed */
	void		(*brightness_set)(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;

	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
};

extern int led_classdev_register(struct device *parent,
				 struct led_classdev *led_cdev);
extern void led_classdev_unregister(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 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;
};

/* 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);
/**
 * 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) {}
#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) */
};
#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)(unsigned gpio, 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
af410fc1	15	#include <linux/list.h>
dc47206e	16	#include <linux/rwsem.h>
04713306	17	#include <linux/spinlock.h>
9067359f	18	#include <linux/timer.h>
d23a22a7	19	#include <linux/workqueue.h>
af410fc1	20
c72a1d60	21	struct device;
c72a1d60 RP	22	/*
	23	* LED Core
	24	*/
	25
	26	enum led_brightness {
fb5035db BD	27	LED_OFF = 0,
	28	LED_HALF = 127,
	29	LED_FULL = 255,
c72a1d60 RP	30	};
	31
	32	struct led_classdev {
fb5035db	33	const char *name;
d8082827 JA	34	enum led_brightness brightness;
d8082827 JA	35	enum led_brightness max_brightness;
fb5035db	36	int flags;
c72a1d60	37
859cb7f2	38	/* Lower 16 bits reflect status */
fb5035db	39	#define LED_SUSPENDED (1 << 0)
859cb7f2 RP	40	/* Upper 16 bits reflect control information */
859cb7f2 RP	41	#define LED_CORE_SUSPENDRESUME (1 << 16)
5bb629c5 FB	42	#define LED_BLINK_ONESHOT (1 << 17)
	43	#define LED_BLINK_ONESHOT_STOP (1 << 18)
	44	#define LED_BLINK_INVERT (1 << 19)
c72a1d60	45
fb5035db	46	/* Set LED brightness level */
2e214e0f	47	/* Must not sleep, use a workqueue if needed */
fb5035db BD	48	void (brightness_set)(struct led_classdev led_cdev,
fb5035db BD	49	enum led_brightness brightness);
29d76dfa HMH	50	/* Get LED brightness level */
29d76dfa HMH	51	enum led_brightness (brightness_get)(struct led_classdev led_cdev);
fb5035db	52
5ada28bf JB	53	/*
	54	* Activate hardware accelerated blink, delays are in milliseconds
	55	* and if both are zero then a sensible default should be chosen.
	56	* The call should adjust the timings in that case and if it can't
	57	* match the values specified exactly.
	58	* Deactivate blinking again when the brightness is set to a fixed
	59	* value via the brightness_set() callback.
	60	*/
4c79141d MN	61	int (blink_set)(struct led_classdev led_cdev,
	62	unsigned long *delay_on,
	63	unsigned long *delay_off);
	64
f8a7c6fe	65	struct device *dev;
d0d480cc JH	66	const struct attribute_group **groups;
d0d480cc JH	67
fb5035db	68	struct list_head node; /* LED Device list */
781a54e7	69	const char default_trigger; / Trigger to use */
c72a1d60	70
5ada28bf	71	unsigned long blink_delay_on, blink_delay_off;
9067359f	72	struct timer_list blink_timer;
5ada28bf JB	73	int blink_brightness;
5ada28bf JB	74
d23a22a7 FB	75	struct work_struct set_brightness_work;
	76	int delayed_set_value;
	77
c3bc9956	78	#ifdef CONFIG_LEDS_TRIGGERS
c3bc9956	79	/* Protects the trigger data below */
dc47206e	80	struct rw_semaphore trigger_lock;
c3bc9956	81
fb5035db BD	82	struct led_trigger *trigger;
	83	struct list_head trig_list;
	84	void *trigger_data;
b0096182 SK	85	/* true if activated - deactivate routine uses it to do cleanup */
b0096182 SK	86	bool activated;
c3bc9956	87	#endif
c72a1d60 RP	88	};
	89
	90	extern int led_classdev_register(struct device *parent,
fb5035db	91	struct led_classdev *led_cdev);
e2387d6c	92	extern void led_classdev_unregister(struct led_classdev *led_cdev);
c72a1d60 RP	93	extern void led_classdev_suspend(struct led_classdev *led_cdev);
	94	extern void led_classdev_resume(struct led_classdev *led_cdev);
	95
5ada28bf JB	96	/**
	97	* led_blink_set - set blinking with software fallback
	98	* @led_cdev: the LED to start blinking
	99	* @delay_on: the time it should be on (in ms)
	100	* @delay_off: the time it should ble off (in ms)
	101	*
	102	* This function makes the LED blink, attempting to use the
	103	* hardware acceleration if possible, but falling back to
	104	* software blinking if there is no hardware blinking or if
	105	* the LED refuses the passed values.
	106	*
	107	* Note that if software blinking is active, simply calling
	108	* led_cdev->brightness_set() will not stop the blinking,
	109	* use led_classdev_brightness_set() instead.
	110	*/
	111	extern void led_blink_set(struct led_classdev *led_cdev,
	112	unsigned long *delay_on,
	113	unsigned long *delay_off);
5bb629c5 FB	114	/**
	115	* led_blink_set_oneshot - do a oneshot software blink
	116	* @led_cdev: the LED to start blinking
	117	* @delay_on: the time it should be on (in ms)
	118	* @delay_off: the time it should ble off (in ms)
	119	* @invert: blink off, then on, leaving the led on
	120	*
	121	* This function makes the LED blink one time for delay_on +
	122	* delay_off time, ignoring the request if another one-shot
	123	* blink is already in progress.
	124	*
	125	* If invert is set, led blinks for delay_off first, then for
	126	* delay_on and leave the led on after the on-off cycle.
	127	*/
	128	extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
	129	unsigned long *delay_on,
	130	unsigned long *delay_off,
	131	int invert);
5ada28bf	132	/**
19cd67e2	133	* led_set_brightness - set LED brightness
5ada28bf JB	134	* @led_cdev: the LED to set
	135	* @brightness: the brightness to set it to
	136	*
	137	* Set an LED's brightness, and, if necessary, cancel the
	138	* software blink timer that implements blinking when the
	139	* hardware doesn't.
	140	*/
19cd67e2	141	extern void led_set_brightness(struct led_classdev *led_cdev,
5ada28bf	142	enum led_brightness brightness);
3ef7de53 JA	143	/**
	144	* led_update_brightness - update LED brightness
	145	* @led_cdev: the LED to query
	146	*
	147	* Get an LED's current brightness and update led_cdev->brightness
	148	* member with the obtained value.
	149	*
	150	* Returns: 0 on success or negative error value on failure
	151	*/
	152	extern int led_update_brightness(struct led_classdev *led_cdev);
5ada28bf	153
c3bc9956 RP	154	/*
	155	* LED Triggers
	156	*/
39f7e08a KM	157	/* Registration functions for simple triggers */
	158	#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
	159	#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
	160
c3bc9956 RP	161	#ifdef CONFIG_LEDS_TRIGGERS
	162
	163	#define TRIG_NAME_MAX 50
	164
	165	struct led_trigger {
	166	/* Trigger Properties */
fb5035db BD	167	const char *name;
	168	void (activate)(struct led_classdev led_cdev);
	169	void (deactivate)(struct led_classdev led_cdev);
c3bc9956 RP	170
c3bc9956 RP	171	/* LEDs under control by this trigger (for simple triggers) */
fb5035db BD	172	rwlock_t leddev_list_lock;
fb5035db BD	173	struct list_head led_cdevs;
c3bc9956 RP	174
c3bc9956 RP	175	/* Link to next registered trigger */
fb5035db	176	struct list_head next_trig;
c3bc9956 RP	177	};
	178
	179	/* Registration functions for complex triggers */
	180	extern int led_trigger_register(struct led_trigger *trigger);
	181	extern void led_trigger_unregister(struct led_trigger *trigger);
	182
c3bc9956 RP	183	extern void led_trigger_register_simple(const char *name,
	184	struct led_trigger **trigger);
	185	extern void led_trigger_unregister_simple(struct led_trigger *trigger);
	186	extern void led_trigger_event(struct led_trigger *trigger,
	187	enum led_brightness event);
0b9536c9 VK	188	extern void led_trigger_blink(struct led_trigger *trigger,
	189	unsigned long *delay_on,
	190	unsigned long *delay_off);
5bb629c5 FB	191	extern void led_trigger_blink_oneshot(struct led_trigger *trigger,
	192	unsigned long *delay_on,
	193	unsigned long *delay_off,
	194	int invert);
057407c7 JH	195	/**
	196	* led_trigger_rename_static - rename a trigger
	197	* @name: the new trigger name
	198	* @trig: the LED trigger to rename
	199	*
	200	* Change a LED trigger name by copying the string passed in
	201	* name into current trigger name, which MUST be large
	202	* enough for the new string.
	203	*
	204	* Note that name must NOT point to the same string used
	205	* during LED registration, as that could lead to races.
	206	*
	207	* This is meant to be used on triggers with statically
	208	* allocated name.
	209	*/
	210	extern void led_trigger_rename_static(const char *name,
	211	struct led_trigger *trig);
c3bc9956 RP	212
	213	#else
	214
39f7e08a KM	215	/* Trigger has no members */
39f7e08a KM	216	struct led_trigger {};
c3bc9956	217
39f7e08a KM	218	/* Trigger inline empty functions */
	219	static inline void led_trigger_register_simple(const char *name,
	220	struct led_trigger **trigger) {}
	221	static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}
	222	static inline void led_trigger_event(struct led_trigger *trigger,
	223	enum led_brightness event) {}
	224	#endif /* CONFIG_LEDS_TRIGGERS */
2bfb646c RP	225
	226	/* Trigger specific functions */
	227	#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
	228	extern void ledtrig_ide_activity(void);
	229	#else
39f7e08a	230	static inline void ledtrig_ide_activity(void) {}
2bfb646c RP	231	#endif
2bfb646c RP	232
48a1d032 KM	233	#if defined(CONFIG_LEDS_TRIGGER_CAMERA) \|\| defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE)
	234	extern void ledtrig_flash_ctrl(bool on);
	235	extern void ledtrig_torch_ctrl(bool on);
	236	#else
	237	static inline void ledtrig_flash_ctrl(bool on) {}
	238	static inline void ledtrig_torch_ctrl(bool on) {}
	239	#endif
	240
f46e9203 NC	241	/*
	242	* Generic LED platform data for describing LED names and default triggers.
	243	*/
	244	struct led_info {
	245	const char *name;
326bb8a5	246	const char *default_trigger;
f46e9203 NC	247	int flags;
	248	};
	249
	250	struct led_platform_data {
	251	int num_leds;
	252	struct led_info *leds;
	253	};
	254
22e03f3b RA	255	/* For the leds-gpio driver */
	256	struct gpio_led {
	257	const char *name;
326bb8a5	258	const char *default_trigger;
22e03f3b	259	unsigned gpio;
ed88bae6 TP	260	unsigned active_low : 1;
	261	unsigned retain_state_suspended : 1;
	262	unsigned default_state : 2;
	263	/* default_state should be one of LEDS_GPIO_DEFSTATE_(ON\|OFF\|KEEP) */
22e03f3b	264	};
2146325d BH	265	#define LEDS_GPIO_DEFSTATE_OFF 0
	266	#define LEDS_GPIO_DEFSTATE_ON 1
	267	#define LEDS_GPIO_DEFSTATE_KEEP 2
22e03f3b RA	268
	269	struct gpio_led_platform_data {
	270	int num_leds;
9517f925	271	const struct gpio_led *leds;
2146325d BH	272
	273	#define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
	274	#define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
9517f925	275	#define GPIO_LED_BLINK 2 /* Please, blink */
2146325d	276	int (*gpio_blink_set)(unsigned gpio, int state,
ca3259b3 HVR	277	unsigned long *delay_on,
ca3259b3 HVR	278	unsigned long *delay_off);
22e03f3b RA	279	};
22e03f3b RA	280
4440673a UKK	281	struct platform_device *gpio_led_register_device(
4440673a UKK	282	int id, const struct gpio_led_platform_data *pdata);
22e03f3b	283
8f88731d BW	284	enum cpu_led_event {
	285	CPU_LED_IDLE_START, /* CPU enters idle */
	286	CPU_LED_IDLE_END, /* CPU idle ends */
	287	CPU_LED_START, /* Machine starts, especially resume */
	288	CPU_LED_STOP, /* Machine stops, especially suspend */
	289	CPU_LED_HALTED, /* Machine shutdown */
	290	};
	291	#ifdef CONFIG_LEDS_TRIGGER_CPU
	292	extern void ledtrig_cpu(enum cpu_led_event evt);
	293	#else
	294	static inline void ledtrig_cpu(enum cpu_led_event evt)
	295	{
	296	return;
	297	}
	298	#endif
	299
c72a1d60	300	#endif /* __LINUX_LEDS_H_INCLUDED */