blob: 383811d9af83fdfd45210e83c326cf1abd25b026 [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>
Johannes Bergaf410fc2006-09-29 02:00:14 -070019
Richard Purdiec72a1d62006-03-31 02:31:04 -080020struct device;
Richard Purdiec72a1d62006-03-31 02:31:04 -080021/*
22 * LED Core
23 */
24
25enum led_brightness {
Ben Dooksfb5035d2006-04-10 22:54:02 -070026 LED_OFF = 0,
27 LED_HALF = 127,
28 LED_FULL = 255,
Richard Purdiec72a1d62006-03-31 02:31:04 -080029};
30
31struct led_classdev {
Ben Dooksfb5035d2006-04-10 22:54:02 -070032 const char *name;
33 int brightness;
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +000034 int max_brightness;
Ben Dooksfb5035d2006-04-10 22:54:02 -070035 int flags;
Richard Purdiec72a1d62006-03-31 02:31:04 -080036
Richard Purdie859cb7f2009-01-08 17:55:03 +000037 /* Lower 16 bits reflect status */
Ben Dooksfb5035d2006-04-10 22:54:02 -070038#define LED_SUSPENDED (1 << 0)
Richard Purdie859cb7f2009-01-08 17:55:03 +000039 /* Upper 16 bits reflect control information */
40#define LED_CORE_SUSPENDRESUME (1 << 16)
Richard Purdiec72a1d62006-03-31 02:31:04 -080041
Ben Dooksfb5035d2006-04-10 22:54:02 -070042 /* Set LED brightness level */
Richard Purdie2e214e02008-04-24 23:49:30 +010043 /* Must not sleep, use a workqueue if needed */
Ben Dooksfb5035d2006-04-10 22:54:02 -070044 void (*brightness_set)(struct led_classdev *led_cdev,
45 enum led_brightness brightness);
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +000046 /* Get LED brightness level */
47 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080048
Johannes Berg5ada28b2010-11-11 14:05:21 -080049 /*
50 * Activate hardware accelerated blink, delays are in milliseconds
51 * and if both are zero then a sensible default should be chosen.
52 * The call should adjust the timings in that case and if it can't
53 * match the values specified exactly.
54 * Deactivate blinking again when the brightness is set to a fixed
55 * value via the brightness_set() callback.
56 */
Márton Németh4c791412007-10-31 15:07:12 +010057 int (*blink_set)(struct led_classdev *led_cdev,
58 unsigned long *delay_on,
59 unsigned long *delay_off);
60
Richard Purdief8a7c6f2007-07-08 23:19:31 +010061 struct device *dev;
Ben Dooksfb5035d2006-04-10 22:54:02 -070062 struct list_head node; /* LED Device list */
Anton Vorontsov781a54e2008-05-31 15:23:19 +010063 const char *default_trigger; /* Trigger to use */
Ben Dooksfb5035d2006-04-10 22:54:02 -070064
Johannes Berg5ada28b2010-11-11 14:05:21 -080065 unsigned long blink_delay_on, blink_delay_off;
66 struct timer_list blink_timer;
67 int blink_brightness;
68
Richard Purdiec3bc9952006-03-31 02:31:05 -080069#ifdef CONFIG_LEDS_TRIGGERS
Richard Purdiec3bc9952006-03-31 02:31:05 -080070 /* Protects the trigger data below */
Richard Purdiedc472062007-11-10 13:29:04 +000071 struct rw_semaphore trigger_lock;
Richard Purdiec3bc9952006-03-31 02:31:05 -080072
Ben Dooksfb5035d2006-04-10 22:54:02 -070073 struct led_trigger *trigger;
74 struct list_head trig_list;
75 void *trigger_data;
Richard Purdiec3bc9952006-03-31 02:31:05 -080076#endif
Richard Purdiec72a1d62006-03-31 02:31:04 -080077};
78
79extern int led_classdev_register(struct device *parent,
Ben Dooksfb5035d2006-04-10 22:54:02 -070080 struct led_classdev *led_cdev);
Wolfram Sange2387d62008-11-17 14:35:44 +000081extern void led_classdev_unregister(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080082extern void led_classdev_suspend(struct led_classdev *led_cdev);
83extern void led_classdev_resume(struct led_classdev *led_cdev);
84
Johannes Berg5ada28b2010-11-11 14:05:21 -080085/**
86 * led_blink_set - set blinking with software fallback
87 * @led_cdev: the LED to start blinking
88 * @delay_on: the time it should be on (in ms)
89 * @delay_off: the time it should ble off (in ms)
90 *
91 * This function makes the LED blink, attempting to use the
92 * hardware acceleration if possible, but falling back to
93 * software blinking if there is no hardware blinking or if
94 * the LED refuses the passed values.
95 *
96 * Note that if software blinking is active, simply calling
97 * led_cdev->brightness_set() will not stop the blinking,
98 * use led_classdev_brightness_set() instead.
99 */
100extern void led_blink_set(struct led_classdev *led_cdev,
101 unsigned long *delay_on,
102 unsigned long *delay_off);
103/**
104 * led_brightness_set - set LED brightness
105 * @led_cdev: the LED to set
106 * @brightness: the brightness to set it to
107 *
108 * Set an LED's brightness, and, if necessary, cancel the
109 * software blink timer that implements blinking when the
110 * hardware doesn't.
111 */
112extern void led_brightness_set(struct led_classdev *led_cdev,
113 enum led_brightness brightness);
114
Richard Purdiec3bc9952006-03-31 02:31:05 -0800115/*
116 * LED Triggers
117 */
118#ifdef CONFIG_LEDS_TRIGGERS
119
120#define TRIG_NAME_MAX 50
121
122struct led_trigger {
123 /* Trigger Properties */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700124 const char *name;
125 void (*activate)(struct led_classdev *led_cdev);
126 void (*deactivate)(struct led_classdev *led_cdev);
Richard Purdiec3bc9952006-03-31 02:31:05 -0800127
128 /* LEDs under control by this trigger (for simple triggers) */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700129 rwlock_t leddev_list_lock;
130 struct list_head led_cdevs;
Richard Purdiec3bc9952006-03-31 02:31:05 -0800131
132 /* Link to next registered trigger */
Ben Dooksfb5035d2006-04-10 22:54:02 -0700133 struct list_head next_trig;
Richard Purdiec3bc9952006-03-31 02:31:05 -0800134};
135
136/* Registration functions for complex triggers */
137extern int led_trigger_register(struct led_trigger *trigger);
138extern void led_trigger_unregister(struct led_trigger *trigger);
139
140/* Registration functions for simple triggers */
141#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
142#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
143extern void led_trigger_register_simple(const char *name,
144 struct led_trigger **trigger);
145extern void led_trigger_unregister_simple(struct led_trigger *trigger);
146extern void led_trigger_event(struct led_trigger *trigger,
147 enum led_brightness event);
148
149#else
150
151/* Triggers aren't active - null macros */
152#define DEFINE_LED_TRIGGER(x)
153#define DEFINE_LED_TRIGGER_GLOBAL(x)
154#define led_trigger_register_simple(x, y) do {} while(0)
155#define led_trigger_unregister_simple(x) do {} while(0)
156#define led_trigger_event(x, y) do {} while(0)
157
158#endif
Richard Purdie2bfb6462006-03-31 02:31:16 -0800159
160/* Trigger specific functions */
161#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
162extern void ledtrig_ide_activity(void);
163#else
164#define ledtrig_ide_activity() do {} while(0)
165#endif
166
Nate Casef46e9202008-07-16 22:49:55 +0100167/*
168 * Generic LED platform data for describing LED names and default triggers.
169 */
170struct led_info {
171 const char *name;
Trent Piepho326bb8a2008-10-13 10:13:01 +0100172 const char *default_trigger;
Nate Casef46e9202008-07-16 22:49:55 +0100173 int flags;
174};
175
176struct led_platform_data {
177 int num_leds;
178 struct led_info *leds;
179};
180
Raphael Assenat22e03f32007-02-27 19:49:53 +0000181/* For the leds-gpio driver */
182struct gpio_led {
183 const char *name;
Trent Piepho326bb8a2008-10-13 10:13:01 +0100184 const char *default_trigger;
Raphael Assenat22e03f32007-02-27 19:49:53 +0000185 unsigned gpio;
Trent Piephoed88bae2009-05-12 15:33:12 -0700186 unsigned active_low : 1;
187 unsigned retain_state_suspended : 1;
188 unsigned default_state : 2;
189 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
Raphael Assenat22e03f32007-02-27 19:49:53 +0000190};
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000191#define LEDS_GPIO_DEFSTATE_OFF 0
192#define LEDS_GPIO_DEFSTATE_ON 1
193#define LEDS_GPIO_DEFSTATE_KEEP 2
Raphael Assenat22e03f32007-02-27 19:49:53 +0000194
195struct gpio_led_platform_data {
196 int num_leds;
Uwe Kleine-König9517f922011-03-22 16:30:17 -0700197 const struct gpio_led *leds;
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000198
199#define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */
200#define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */
Uwe Kleine-König9517f922011-03-22 16:30:17 -0700201#define GPIO_LED_BLINK 2 /* Please, blink */
Benjamin Herrenschmidt21463252010-05-22 20:54:55 +1000202 int (*gpio_blink_set)(unsigned gpio, int state,
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +0000203 unsigned long *delay_on,
204 unsigned long *delay_off);
Raphael Assenat22e03f32007-02-27 19:49:53 +0000205};
206
207
Richard Purdiec72a1d62006-03-31 02:31:04 -0800208#endif /* __LINUX_LEDS_H_INCLUDED */