blob: d8bf9665e70cc09b40d781a82c638e1b95dd82af [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 Bergaf410fc2006-09-29 02:00:14 -070018
Richard Purdiec72a1d62006-03-31 02:31:04 -080019struct device;
Richard Purdiec72a1d62006-03-31 02:31:04 -080020/*
21 * LED Core
22 */
23
24enum led_brightness {
Ben Dooksfb5035d2006-04-10 22:54:02 -070025 LED_OFF = 0,
26 LED_HALF = 127,
27 LED_FULL = 255,
Richard Purdiec72a1d62006-03-31 02:31:04 -080028};
29
30struct led_classdev {
Ben Dooksfb5035d2006-04-10 22:54:02 -070031 const char *name;
32 int brightness;
Guennadi Liakhovetski1bd465e2009-01-10 18:54:39 +000033 int max_brightness;
Ben Dooksfb5035d2006-04-10 22:54:02 -070034 int flags;
Richard Purdiec72a1d62006-03-31 02:31:04 -080035
Richard Purdie859cb7f2009-01-08 17:55:03 +000036 /* Lower 16 bits reflect status */
Ben Dooksfb5035d2006-04-10 22:54:02 -070037#define LED_SUSPENDED (1 << 0)
Richard Purdie859cb7f2009-01-08 17:55:03 +000038 /* Upper 16 bits reflect control information */
39#define LED_CORE_SUSPENDRESUME (1 << 16)
Richard Purdiec72a1d62006-03-31 02:31:04 -080040
Ben Dooksfb5035d2006-04-10 22:54:02 -070041 /* Set LED brightness level */
Richard Purdie2e214e02008-04-24 23:49:30 +010042 /* Must not sleep, use a workqueue if needed */
Ben Dooksfb5035d2006-04-10 22:54:02 -070043 void (*brightness_set)(struct led_classdev *led_cdev,
44 enum led_brightness brightness);
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +000045 /* Get LED brightness level */
46 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080047
Mark Brown92722b12009-06-11 14:17:48 +010048 /* Activate hardware accelerated blink, delays are in
49 * miliseconds and if none is provided then a sensible default
Richard Purdiea1dd8c62009-06-22 14:54:13 +010050 * should be chosen. The call can adjust the timings if it can't
51 * match the values specified exactly. */
Márton Németh4c791412007-10-31 15:07:12 +010052 int (*blink_set)(struct led_classdev *led_cdev,
53 unsigned long *delay_on,
54 unsigned long *delay_off);
55
Richard Purdief8a7c6f2007-07-08 23:19:31 +010056 struct device *dev;
Ben Dooksfb5035d2006-04-10 22:54:02 -070057 struct list_head node; /* LED Device list */
Anton Vorontsov781a54e2008-05-31 15:23:19 +010058 const char *default_trigger; /* Trigger to use */
Ben Dooksfb5035d2006-04-10 22:54:02 -070059
Richard Purdiec3bc9952006-03-31 02:31:05 -080060#ifdef CONFIG_LEDS_TRIGGERS
Richard Purdiec3bc9952006-03-31 02:31:05 -080061 /* Protects the trigger data below */
Richard Purdiedc472062007-11-10 13:29:04 +000062 struct rw_semaphore trigger_lock;
Richard Purdiec3bc9952006-03-31 02:31:05 -080063
Ben Dooksfb5035d2006-04-10 22:54:02 -070064 struct led_trigger *trigger;
65 struct list_head trig_list;
66 void *trigger_data;
Richard Purdiec3bc9952006-03-31 02:31:05 -080067#endif
Richard Purdiec72a1d62006-03-31 02:31:04 -080068};
69
70extern int led_classdev_register(struct device *parent,
Ben Dooksfb5035d2006-04-10 22:54:02 -070071 struct led_classdev *led_cdev);
Wolfram Sange2387d62008-11-17 14:35:44 +000072extern void led_classdev_unregister(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080073extern void led_classdev_suspend(struct led_classdev *led_cdev);
74extern void led_classdev_resume(struct led_classdev *led_cdev);
75
Richard Purdiec3bc9952006-03-31 02:31:05 -080076/*
77 * LED Triggers
78 */
79#ifdef CONFIG_LEDS_TRIGGERS
80
81#define TRIG_NAME_MAX 50
82
83struct led_trigger {
84 /* Trigger Properties */
Ben Dooksfb5035d2006-04-10 22:54:02 -070085 const char *name;
86 void (*activate)(struct led_classdev *led_cdev);
87 void (*deactivate)(struct led_classdev *led_cdev);
Richard Purdiec3bc9952006-03-31 02:31:05 -080088
89 /* LEDs under control by this trigger (for simple triggers) */
Ben Dooksfb5035d2006-04-10 22:54:02 -070090 rwlock_t leddev_list_lock;
91 struct list_head led_cdevs;
Richard Purdiec3bc9952006-03-31 02:31:05 -080092
93 /* Link to next registered trigger */
Ben Dooksfb5035d2006-04-10 22:54:02 -070094 struct list_head next_trig;
Richard Purdiec3bc9952006-03-31 02:31:05 -080095};
96
97/* Registration functions for complex triggers */
98extern int led_trigger_register(struct led_trigger *trigger);
99extern void led_trigger_unregister(struct led_trigger *trigger);
100
101/* Registration functions for simple triggers */
102#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
103#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
104extern void led_trigger_register_simple(const char *name,
105 struct led_trigger **trigger);
106extern void led_trigger_unregister_simple(struct led_trigger *trigger);
107extern void led_trigger_event(struct led_trigger *trigger,
108 enum led_brightness event);
109
110#else
111
112/* Triggers aren't active - null macros */
113#define DEFINE_LED_TRIGGER(x)
114#define DEFINE_LED_TRIGGER_GLOBAL(x)
115#define led_trigger_register_simple(x, y) do {} while(0)
116#define led_trigger_unregister_simple(x) do {} while(0)
117#define led_trigger_event(x, y) do {} while(0)
118
119#endif
Richard Purdie2bfb6462006-03-31 02:31:16 -0800120
121/* Trigger specific functions */
122#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
123extern void ledtrig_ide_activity(void);
124#else
125#define ledtrig_ide_activity() do {} while(0)
126#endif
127
Nate Casef46e9202008-07-16 22:49:55 +0100128/*
129 * Generic LED platform data for describing LED names and default triggers.
130 */
131struct led_info {
132 const char *name;
Trent Piepho326bb8a2008-10-13 10:13:01 +0100133 const char *default_trigger;
Nate Casef46e9202008-07-16 22:49:55 +0100134 int flags;
135};
136
137struct led_platform_data {
138 int num_leds;
139 struct led_info *leds;
140};
141
Raphael Assenat22e03f32007-02-27 19:49:53 +0000142/* For the leds-gpio driver */
143struct gpio_led {
144 const char *name;
Trent Piepho326bb8a2008-10-13 10:13:01 +0100145 const char *default_trigger;
Raphael Assenat22e03f32007-02-27 19:49:53 +0000146 unsigned gpio;
Trent Piephoed88bae2009-05-12 15:33:12 -0700147 unsigned active_low : 1;
148 unsigned retain_state_suspended : 1;
149 unsigned default_state : 2;
150 /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
Raphael Assenat22e03f32007-02-27 19:49:53 +0000151};
Trent Piephoed88bae2009-05-12 15:33:12 -0700152#define LEDS_GPIO_DEFSTATE_OFF 0
153#define LEDS_GPIO_DEFSTATE_ON 1
154#define LEDS_GPIO_DEFSTATE_KEEP 2
Raphael Assenat22e03f32007-02-27 19:49:53 +0000155
156struct gpio_led_platform_data {
157 int num_leds;
158 struct gpio_led *leds;
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +0000159 int (*gpio_blink_set)(unsigned gpio,
160 unsigned long *delay_on,
161 unsigned long *delay_off);
Raphael Assenat22e03f32007-02-27 19:49:53 +0000162};
163
164
Richard Purdiec72a1d62006-03-31 02:31:04 -0800165#endif /* __LINUX_LEDS_H_INCLUDED */