[deliverable/linux.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/spinlock.h>
#include <linux/rwsem.h>
#include <linux/timer.h>

struct device;
/*
 * LED Core
 */

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

struct led_classdev {
	const char		*name;
	int			 brightness;
	int			 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;
	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;

#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 Triggers
 */
#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);

/* 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;
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);

#else

/* Triggers aren't active - null macros */
#define DEFINE_LED_TRIGGER(x)
#define DEFINE_LED_TRIGGER_GLOBAL(x)
#define led_trigger_register_simple(x, y) do {} while(0)
#define led_trigger_unregister_simple(x) do {} while(0)
#define led_trigger_event(x, y) do {} while(0)

#endif

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