[mirror_ubuntu-artful-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_ON		= 1,
	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)
#define LED_UNREGISTERING	(1 << 1)
	/* Upper 16 bits reflect control information */
#define LED_CORE_SUSPENDRESUME	(1 << 16)
#define LED_SYSFS_DISABLE	(1 << 17)
#define LED_DEV_CAP_FLASH	(1 << 18)
#define LED_HW_PLUGGABLE	(1 << 19)
#define LED_PANIC_INDICATOR	(1 << 20)

	/* set_brightness_work / blink_timer flags, atomic, private. */
	unsigned long		work_flags;

#define LED_BLINK_SW			0
#define LED_BLINK_ONESHOT		1
#define LED_BLINK_ONESHOT_STOP		2
#define LED_BLINK_INVERT		3
#define LED_BLINK_BRIGHTNESS_CHANGE 	4
#define LED_BLINK_DISABLE		5

	/* Set LED brightness level
	 * Must not sleep. Use brightness_set_blocking for drivers
	 * that can sleep while setting brightness.
	 */
	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_blocking)(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 LED_OFF
	 * 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;
	int			 new_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. This function is guaranteed not to sleep.
 */
extern void led_set_brightness(struct led_classdev *led_cdev,
			       enum led_brightness brightness);

/**
 * led_set_brightness_sync - set LED brightness synchronously
 * @led_cdev: the LED to set
 * @brightness: the brightness to set it to
 *
 * Set an LED's brightness immediately. This function will block
 * the caller for the time required for accessing device registers,
 * and it can sleep.
 *
 * Returns: 0 on success or negative error value on failure
 */
extern int led_set_brightness_sync(struct led_classdev *led_cdev,
				   enum led_brightness value);

/**
 * 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 int devm_led_trigger_register(struct device *dev,
				     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_DISK
extern void ledtrig_disk_activity(void);
#else
static inline void ledtrig_disk_activity(void) {}
#endif

#ifdef CONFIG_LEDS_TRIGGER_MTD
extern void ledtrig_mtd_activity(void);
#else
static inline void ledtrig_mtd_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;
};

struct gpio_desc;
typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
				unsigned long *delay_on,
				unsigned long *delay_off);

/* 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	panic_indicator : 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 */
	gpio_blink_set_t	gpio_blink_set;
};

#ifdef CONFIG_NEW_LEDS
struct platform_device *gpio_led_register_device(
		int id, const struct gpio_led_platform_data *pdata);
#else
static inline struct platform_device *gpio_led_register_device(
		int id, const struct gpio_led_platform_data *pdata)
{
	return 0;
}
#endif

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