blob: 0d9b5eed714ecd9f46323d334a6d2e7e27ddc8ff [file] [log] [blame]
Richard Purdiec72a1d62006-03-31 02:31:04 -08001/*
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
Johannes Bergaf410fc2006-09-29 02:00:14 -070015#include <linux/list.h>
Yoichi Yuasadf96efd2007-09-11 22:24:45 +010016#include <linux/spinlock.h>
Richard Purdiedc472062007-11-10 13:29:04 +000017#include <linux/rwsem.h>
Johannes Berg5ada28b2010-11-11 14:05:21 -080018#include <linux/timer.h>
Fabio Baltierid23a22a2012-08-15 21:44:34 +080019#include <linux/workqueue.h>
Johannes Bergaf410fc2006-09-29 02:00:14 -070020
Richard Purdiec72a1d62006-03-31 02:31:04 -080021struct device;
Richard Purdiec72a1d62006-03-31 02:31:04 -080022/*
23 * LED Core
24 */
25
26enum led_brightness {
Ben Dooksfb5035d2006-04-10 22:54:02 -070027 LED_OFF = 0,
28 LED_HALF = 127,
29 LED_FULL = 255,
Richard Purdiec72a1d62006-03-31 02:31:04 -080030};
31
32struct led_classdev {
Ben Dooksfb5035d2006-04-10 22:54:02 -070033 const char *name;
34 int brightness;
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +000035 int max_brightness;
Ben Dooksfb5035d2006-04-10 22:54:02 -070036 int flags;
Richard Purdiec72a1d62006-03-31 02:31:04 -080037
Richard Purdie859cb7f2009-01-08 17:55:03 +000038 /* Lower 16 bits reflect status */
Ben Dooksfb5035d2006-04-10 22:54:02 -070039#define LED_SUSPENDED (1 << 0)
Richard Purdie859cb7f2009-01-08 17:55:03 +000040 /* Upper 16 bits reflect control information */
41#define LED_CORE_SUSPENDRESUME (1 << 16)
Fabio Baltieri5bb629c2012-05-27 07:19:22 +080042#define LED_BLINK_ONESHOT (1 << 17)
43#define LED_BLINK_ONESHOT_STOP (1 << 18)
44#define LED_BLINK_INVERT (1 << 19)
Richard Purdiec72a1d62006-03-31 02:31:04 -080045
Ben Dooksfb5035d2006-04-10 22:54:02 -070046 /* Set LED brightness level */
Richard Purdie2e214e02008-04-24 23:49:30 +010047 /* Must not sleep, use a workqueue if needed */
Ben Dooksfb5035d2006-04-10 22:54:02 -070048 void (*brightness_set)(struct led_classdev *led_cdev,
49 enum led_brightness brightness);
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +000050 /* Get LED brightness level */
51 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080052
Johannes Berg5ada28b2010-11-11 14:05:21 -080053 /*
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 */
Márton Németh4c791412007-10-31 15:07:12 +010061 int (*blink_set)(struct led_classdev *led_cdev,
62 unsigned long *delay_on,
63 unsigned long *delay_off);
64
Richard Purdief8a7c6f2007-07-08 23:19:31 +010065 struct device *dev;
Ben Dooksfb5035d2006-04-10 22:54:02 -070066 struct list_head node; /* LED Device list */
Anton Vorontsov781a54e2008-05-31 15:23:19 +010067 const char *default_trigger; /* Trigger to use */
Ben Dooksfb5035d2006-04-10 22:54:02 -070068
Johannes Berg5ada28b2010-11-11 14:05:21 -080069 unsigned long blink_delay_on, blink_delay_off;
70 struct timer_list blink_timer;
71 int blink_brightness;
72
Fabio Baltierid23a22a2012-08-15 21:44:34 +080073 struct work_struct set_brightness_work;
74 int delayed_set_value;
75
Richard Purdiec3bc9952006-03-31 02:31:05 -080076#ifdef CONFIG_LEDS_TRIGGERS
Richard Purdiec3bc9952006-03-31 02:31:05 -080077 /* Protects the trigger data below */
Richard Purdiedc472062007-11-10 13:29:04 +000078 struct rw_semaphore trigger_lock;
Richard Purdiec3bc9952006-03-31 02:31:05 -080079
Ben Dooksfb5035d2006-04-10 22:54:02 -070080 struct led_trigger *trigger;
81 struct list_head trig_list;
82 void *trigger_data;
Shuah Khanb0096182012-05-29 15:07:27 -070083 /* true if activated - deactivate routine uses it to do cleanup */
84 bool activated;
Richard Purdiec3bc9952006-03-31 02:31:05 -080085#endif
Richard Purdiec72a1d62006-03-31 02:31:04 -080086};
87
88extern int led_classdev_register(struct device *parent,
Ben Dooksfb5035d2006-04-10 22:54:02 -070089 struct led_classdev *led_cdev);
Wolfram Sange2387d62008-11-17 14:35:44 +000090extern void led_classdev_unregister(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080091extern void led_classdev_suspend(struct led_classdev *led_cdev);
92extern void led_classdev_resume(struct led_classdev *led_cdev);
93
Johannes Berg5ada28b2010-11-11 14:05:21 -080094/**
95 * led_blink_set - set blinking with software fallback
96 * @led_cdev: the LED to start blinking
97 * @delay_on: the time it should be on (in ms)
98 * @delay_off: the time it should ble off (in ms)
99 *
100 * This function makes the LED blink, attempting to use the
101 * hardware acceleration if possible, but falling back to
102 * software blinking if there is no hardware blinking or if
103 * the LED refuses the passed values.
104 *
105 * Note that if software blinking is active, simply calling
106 * led_cdev->brightness_set() will not stop the blinking,
107 * use led_classdev_brightness_set() instead.
108 */
109extern void led_blink_set(struct led_classdev *led_cdev,
110 unsigned long *delay_on,
111 unsigned long *delay_off);
112/**
Fabio Baltieri5bb629c2012-05-27 07:19:22 +0800113 * led_blink_set_oneshot - do a oneshot software blink
114 * @led_cdev: the LED to start blinking
115 * @delay_on: the time it should be on (in ms)
116 * @delay_off: the time it should ble off (in ms)
117 * @invert: blink off, then on, leaving the led on
118 *
119 * This function makes the LED blink one time for delay_on +
120 * delay_off time, ignoring the request if another one-shot
121 * blink is already in progress.
122 *
123 * If invert is set, led blinks for delay_off first, then for
124 * delay_on and leave the led on after the on-off cycle.
125 */
126extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
127 unsigned long *delay_on,
128 unsigned long *delay_off,
129 int invert);
130/**
Shuah Khan19cd67e2012-06-14 04:34:30 +0800131 * led_set_brightness - set LED brightness
Johannes Berg5ada28b2010-11-11 14:05:21 -0800132 * @led_cdev: the LED to set
133 * @brightness: the brightness to set it to
134 *
135 * Set an LED's brightness, and, if necessary, cancel the
136 * software blink timer that implements blinking when the
137 * hardware doesn't.
138 */
Shuah Khan19cd67e2012-06-14 04:34:30 +0800139extern void led_set_brightness(struct led_classdev *led_cdev,
Johannes Berg5ada28b2010-11-11 14:05:21 -0800140 enum led_brightness brightness);
141
Richard Purdiec3bc9952006-03-31 02:31:05 -0800142/*
143 * LED Triggers
144 */
145#ifdef CONFIG_LEDS_TRIGGERS
146
147#define TRIG_NAME_MAX 50
148
149struct led_trigger {
150 /* Trigger Properties */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700151 const char *name;
152 void (*activate)(struct led_classdev *led_cdev);
153 void (*deactivate)(struct led_classdev *led_cdev);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800154
155 /* LEDs under control by this trigger (for simple triggers) */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700156 rwlock_t leddev_list_lock;
157 struct list_head led_cdevs;
Richard Purdiec3bc9952006-03-31 02:31:05 -0800158
159 /* Link to next registered trigger */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700160 struct list_head next_trig;
Richard Purdiec3bc9952006-03-31 02:31:05 -0800161};
162
163/* Registration functions for complex triggers */
164extern int led_trigger_register(struct led_trigger *trigger);
165extern void led_trigger_unregister(struct led_trigger *trigger);
166
167/* Registration functions for simple triggers */
168#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
169#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
170extern void led_trigger_register_simple(const char *name,
171 struct led_trigger **trigger);
172extern void led_trigger_unregister_simple(struct led_trigger *trigger);
173extern void led_trigger_event(struct led_trigger *trigger,
174 enum led_brightness event);
Vasily Khoruzhick0b9536c2011-01-07 16:28:16 +0000175extern void led_trigger_blink(struct led_trigger *trigger,
176 unsigned long *delay_on,
177 unsigned long *delay_off);
Fabio Baltieri5bb629c2012-05-27 07:19:22 +0800178extern void led_trigger_blink_oneshot(struct led_trigger *trigger,
179 unsigned long *delay_on,
180 unsigned long *delay_off,
181 int invert);
Jingoo Han057407c2012-11-18 21:35:55 -0800182/**
183 * led_trigger_rename_static - rename a trigger
184 * @name: the new trigger name
185 * @trig: the LED trigger to rename
186 *
187 * Change a LED trigger name by copying the string passed in
188 * name into current trigger name, which MUST be large
189 * enough for the new string.
190 *
191 * Note that name must NOT point to the same string used
192 * during LED registration, as that could lead to races.
193 *
194 * This is meant to be used on triggers with statically
195 * allocated name.
196 */
197extern void led_trigger_rename_static(const char *name,
198 struct led_trigger *trig);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800199
200#else
201
202/* Triggers aren't active - null macros */
203#define DEFINE_LED_TRIGGER(x)
204#define DEFINE_LED_TRIGGER_GLOBAL(x)
205#define led_trigger_register_simple(x, y) do {} while(0)
206#define led_trigger_unregister_simple(x) do {} while(0)
207#define led_trigger_event(x, y) do {} while(0)
208
209#endif
Richard Purdie2bfb6462006-03-31 02:31:16 -0800210
211/* Trigger specific functions */
212#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
213extern void ledtrig_ide_activity(void);
214#else
215#define ledtrig_ide_activity() do {} while(0)
216#endif
217
Nate Casef46e9202008-07-16 22:49:55 +0100218/*
219 * Generic LED platform data for describing LED names and default triggers.
220 */
221struct led_info {
222 const char *name;
Trent Piepho326bb8a52008-10-13 10:13:01 +0100223 const char *default_trigger;
Nate Casef46e9202008-07-16 22:49:55 +0100224 int flags;
225};
226
227struct led_platform_data {
228 int num_leds;
229 struct led_info *leds;
230};
231
Raphael Assenat22e03f32007-02-27 19:49:53 +0000232/* For the leds-gpio driver */
233struct gpio_led {
234 const char *name;
Trent Piepho326bb8a52008-10-13 10:13:01 +0100235 const char *default_trigger;
Raphael Assenat22e03f32007-02-27 19:49:53 +0000236 unsigned gpio;
Trent Piephoed88bae2009-05-12 15:33:12 -0700237 unsigned active_low : 1;
238 unsigned retain_state_suspended : 1;
239 unsigned default_state : 2;
240 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
Raphael Assenat22e03f32007-02-27 19:49:53 +0000241};
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000242#define LEDS_GPIO_DEFSTATE_OFF 0
243#define LEDS_GPIO_DEFSTATE_ON 1
244#define LEDS_GPIO_DEFSTATE_KEEP 2
Raphael Assenat22e03f32007-02-27 19:49:53 +0000245
246struct gpio_led_platform_data {
247 int num_leds;
Uwe Kleine-König9517f922011-03-22 16:30:17 -0700248 const struct gpio_led *leds;
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000249
250#define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
251#define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
Uwe Kleine-König9517f922011-03-22 16:30:17 -0700252#define GPIO_LED_BLINK 2 /* Please, blink */
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000253 int (*gpio_blink_set)(unsigned gpio, int state,
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +0000254 unsigned long *delay_on,
255 unsigned long *delay_off);
Raphael Assenat22e03f32007-02-27 19:49:53 +0000256};
257
Uwe Kleine-König44406732011-05-24 17:13:29 -0700258struct platform_device *gpio_led_register_device(
259 int id, const struct gpio_led_platform_data *pdata);
Raphael Assenat22e03f32007-02-27 19:49:53 +0000260
Bryan Wu8f887312011-06-25 18:33:50 +0800261enum cpu_led_event {
262 CPU_LED_IDLE_START, /* CPU enters idle */
263 CPU_LED_IDLE_END, /* CPU idle ends */
264 CPU_LED_START, /* Machine starts, especially resume */
265 CPU_LED_STOP, /* Machine stops, especially suspend */
266 CPU_LED_HALTED, /* Machine shutdown */
267};
268#ifdef CONFIG_LEDS_TRIGGER_CPU
269extern void ledtrig_cpu(enum cpu_led_event evt);
270#else
271static inline void ledtrig_cpu(enum cpu_led_event evt)
272{
273 return;
274}
275#endif
276
Richard Purdiec72a1d62006-03-31 02:31:04 -0800277#endif /* __LINUX_LEDS_H_INCLUDED */