leds: Add support for hardware accelerated LED flashing
[linux-2.6.git] / include / linux / leds.h
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
15 #include <linux/list.h>
16 #include <linux/spinlock.h>
17 #include <linux/rwsem.h>
18
19 struct device;
20 /*
21  * LED Core
22  */
23
24 enum led_brightness {
25         LED_OFF         = 0,
26         LED_HALF        = 127,
27         LED_FULL        = 255,
28 };
29
30 struct led_classdev {
31         const char              *name;
32         int                      brightness;
33         int                      flags;
34
35 #define LED_SUSPENDED           (1 << 0)
36
37         /* Set LED brightness level */
38         void            (*brightness_set)(struct led_classdev *led_cdev,
39                                           enum led_brightness brightness);
40
41         /* Activate hardware accelerated blink */
42         int             (*blink_set)(struct led_classdev *led_cdev,
43                                      unsigned long *delay_on,
44                                      unsigned long *delay_off);
45
46         struct device           *dev;
47         struct list_head         node;                  /* LED Device list */
48         char                    *default_trigger;       /* Trigger to use */
49
50 #ifdef CONFIG_LEDS_TRIGGERS
51         /* Protects the trigger data below */
52         struct rw_semaphore      trigger_lock;
53
54         struct led_trigger      *trigger;
55         struct list_head         trig_list;
56         void                    *trigger_data;
57 #endif
58 };
59
60 extern int led_classdev_register(struct device *parent,
61                                  struct led_classdev *led_cdev);
62 extern void __led_classdev_unregister(struct led_classdev *led_cdev, bool sus);
63 static inline void led_classdev_unregister(struct led_classdev *lcd)
64 {
65         __led_classdev_unregister(lcd, false);
66 }
67 static inline void led_classdev_unregister_suspended(struct led_classdev *lcd)
68 {
69         __led_classdev_unregister(lcd, true);
70 }
71 extern void led_classdev_suspend(struct led_classdev *led_cdev);
72 extern void led_classdev_resume(struct led_classdev *led_cdev);
73
74 /*
75  * LED Triggers
76  */
77 #ifdef CONFIG_LEDS_TRIGGERS
78
79 #define TRIG_NAME_MAX 50
80
81 struct led_trigger {
82         /* Trigger Properties */
83         const char       *name;
84         void            (*activate)(struct led_classdev *led_cdev);
85         void            (*deactivate)(struct led_classdev *led_cdev);
86
87         /* LEDs under control by this trigger (for simple triggers) */
88         rwlock_t          leddev_list_lock;
89         struct list_head  led_cdevs;
90
91         /* Link to next registered trigger */
92         struct list_head  next_trig;
93 };
94
95 /* Registration functions for complex triggers */
96 extern int led_trigger_register(struct led_trigger *trigger);
97 extern void led_trigger_unregister(struct led_trigger *trigger);
98
99 /* Registration functions for simple triggers */
100 #define DEFINE_LED_TRIGGER(x)           static struct led_trigger *x;
101 #define DEFINE_LED_TRIGGER_GLOBAL(x)    struct led_trigger *x;
102 extern void led_trigger_register_simple(const char *name,
103                                 struct led_trigger **trigger);
104 extern void led_trigger_unregister_simple(struct led_trigger *trigger);
105 extern void led_trigger_event(struct led_trigger *trigger,
106                                 enum led_brightness event);
107
108 #else
109
110 /* Triggers aren't active - null macros */
111 #define DEFINE_LED_TRIGGER(x)
112 #define DEFINE_LED_TRIGGER_GLOBAL(x)
113 #define led_trigger_register_simple(x, y) do {} while(0)
114 #define led_trigger_unregister_simple(x) do {} while(0)
115 #define led_trigger_event(x, y) do {} while(0)
116
117 #endif
118
119 /* Trigger specific functions */
120 #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
121 extern void ledtrig_ide_activity(void);
122 #else
123 #define ledtrig_ide_activity() do {} while(0)
124 #endif
125
126 /* For the leds-gpio driver */
127 struct gpio_led {
128         const char *name;
129         char *default_trigger;
130         unsigned        gpio;
131         u8              active_low;
132 };
133
134 struct gpio_led_platform_data {
135         int             num_leds;
136         struct gpio_led *leds;
137 };
138
139
140 #endif          /* __LINUX_LEDS_H_INCLUDED */