Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 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 | |
Johannes Berg | af410fc | 2006-09-29 02:00:14 -0700 | [diff] [blame] | 15 | #include <linux/list.h> |
Yoichi Yuasa | df96efd | 2007-09-11 22:24:45 +0100 | [diff] [blame] | 16 | #include <linux/spinlock.h> |
Richard Purdie | dc47206 | 2007-11-10 13:29:04 +0000 | [diff] [blame] | 17 | #include <linux/rwsem.h> |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 18 | #include <linux/timer.h> |
Johannes Berg | af410fc | 2006-09-29 02:00:14 -0700 | [diff] [blame] | 19 | |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 20 | struct device; |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 21 | /* |
| 22 | * LED Core |
| 23 | */ |
| 24 | |
| 25 | enum led_brightness { |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 26 | LED_OFF = 0, |
| 27 | LED_HALF = 127, |
| 28 | LED_FULL = 255, |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 29 | }; |
| 30 | |
| 31 | struct led_classdev { |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 32 | const char *name; |
| 33 | int brightness; |
Guennadi Liakhovetski | 1bd465e | 2009-01-10 18:54:39 +0000 | [diff] [blame] | 34 | int max_brightness; |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 35 | int flags; |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 36 | |
Richard Purdie | 859cb7f | 2009-01-08 17:55:03 +0000 | [diff] [blame] | 37 | /* Lower 16 bits reflect status */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 38 | #define LED_SUSPENDED (1 << 0) |
Richard Purdie | 859cb7f | 2009-01-08 17:55:03 +0000 | [diff] [blame] | 39 | /* Upper 16 bits reflect control information */ |
| 40 | #define LED_CORE_SUSPENDRESUME (1 << 16) |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 41 | |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 42 | /* Set LED brightness level */ |
Richard Purdie | 2e214e0 | 2008-04-24 23:49:30 +0100 | [diff] [blame] | 43 | /* Must not sleep, use a workqueue if needed */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 44 | void (*brightness_set)(struct led_classdev *led_cdev, |
| 45 | enum led_brightness brightness); |
Henrique de Moraes Holschuh | 29d76df | 2008-03-18 09:47:48 +0000 | [diff] [blame] | 46 | /* Get LED brightness level */ |
| 47 | enum led_brightness (*brightness_get)(struct led_classdev *led_cdev); |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 48 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 49 | /* |
| 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émeth | 4c79141 | 2007-10-31 15:07:12 +0100 | [diff] [blame] | 57 | int (*blink_set)(struct led_classdev *led_cdev, |
| 58 | unsigned long *delay_on, |
| 59 | unsigned long *delay_off); |
| 60 | |
Richard Purdie | f8a7c6f | 2007-07-08 23:19:31 +0100 | [diff] [blame] | 61 | struct device *dev; |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 62 | struct list_head node; /* LED Device list */ |
Anton Vorontsov | 781a54e | 2008-05-31 15:23:19 +0100 | [diff] [blame] | 63 | const char *default_trigger; /* Trigger to use */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 64 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 65 | unsigned long blink_delay_on, blink_delay_off; |
| 66 | struct timer_list blink_timer; |
| 67 | int blink_brightness; |
| 68 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 69 | #ifdef CONFIG_LEDS_TRIGGERS |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 70 | /* Protects the trigger data below */ |
Richard Purdie | dc47206 | 2007-11-10 13:29:04 +0000 | [diff] [blame] | 71 | struct rw_semaphore trigger_lock; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 72 | |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 73 | struct led_trigger *trigger; |
| 74 | struct list_head trig_list; |
| 75 | void *trigger_data; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 76 | #endif |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 77 | }; |
| 78 | |
| 79 | extern int led_classdev_register(struct device *parent, |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 80 | struct led_classdev *led_cdev); |
Wolfram Sang | e2387d6 | 2008-11-17 14:35:44 +0000 | [diff] [blame] | 81 | extern void led_classdev_unregister(struct led_classdev *led_cdev); |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 82 | extern void led_classdev_suspend(struct led_classdev *led_cdev); |
| 83 | extern void led_classdev_resume(struct led_classdev *led_cdev); |
| 84 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 85 | /** |
| 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 | */ |
| 100 | extern 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 | */ |
| 112 | extern void led_brightness_set(struct led_classdev *led_cdev, |
| 113 | enum led_brightness brightness); |
| 114 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 115 | /* |
| 116 | * LED Triggers |
| 117 | */ |
| 118 | #ifdef CONFIG_LEDS_TRIGGERS |
| 119 | |
| 120 | #define TRIG_NAME_MAX 50 |
| 121 | |
| 122 | struct led_trigger { |
| 123 | /* Trigger Properties */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 124 | const char *name; |
| 125 | void (*activate)(struct led_classdev *led_cdev); |
| 126 | void (*deactivate)(struct led_classdev *led_cdev); |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 127 | |
| 128 | /* LEDs under control by this trigger (for simple triggers) */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 129 | rwlock_t leddev_list_lock; |
| 130 | struct list_head led_cdevs; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 131 | |
| 132 | /* Link to next registered trigger */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 133 | struct list_head next_trig; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 134 | }; |
| 135 | |
| 136 | /* Registration functions for complex triggers */ |
| 137 | extern int led_trigger_register(struct led_trigger *trigger); |
| 138 | extern 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; |
| 143 | extern void led_trigger_register_simple(const char *name, |
| 144 | struct led_trigger **trigger); |
| 145 | extern void led_trigger_unregister_simple(struct led_trigger *trigger); |
| 146 | extern 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 Purdie | 2bfb646 | 2006-03-31 02:31:16 -0800 | [diff] [blame] | 159 | |
| 160 | /* Trigger specific functions */ |
| 161 | #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK |
| 162 | extern void ledtrig_ide_activity(void); |
| 163 | #else |
| 164 | #define ledtrig_ide_activity() do {} while(0) |
| 165 | #endif |
| 166 | |
Nate Case | f46e920 | 2008-07-16 22:49:55 +0100 | [diff] [blame] | 167 | /* |
| 168 | * Generic LED platform data for describing LED names and default triggers. |
| 169 | */ |
| 170 | struct led_info { |
| 171 | const char *name; |
Trent Piepho | 326bb8a | 2008-10-13 10:13:01 +0100 | [diff] [blame] | 172 | const char *default_trigger; |
Nate Case | f46e920 | 2008-07-16 22:49:55 +0100 | [diff] [blame] | 173 | int flags; |
| 174 | }; |
| 175 | |
| 176 | struct led_platform_data { |
| 177 | int num_leds; |
| 178 | struct led_info *leds; |
| 179 | }; |
| 180 | |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 181 | /* For the leds-gpio driver */ |
| 182 | struct gpio_led { |
| 183 | const char *name; |
Trent Piepho | 326bb8a | 2008-10-13 10:13:01 +0100 | [diff] [blame] | 184 | const char *default_trigger; |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 185 | unsigned gpio; |
Trent Piepho | ed88bae | 2009-05-12 15:33:12 -0700 | [diff] [blame] | 186 | 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 Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 190 | }; |
Benjamin Herrenschmidt | 2146325 | 2010-05-22 20:54:55 +1000 | [diff] [blame] | 191 | #define LEDS_GPIO_DEFSTATE_OFF 0 |
| 192 | #define LEDS_GPIO_DEFSTATE_ON 1 |
| 193 | #define LEDS_GPIO_DEFSTATE_KEEP 2 |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 194 | |
| 195 | struct gpio_led_platform_data { |
| 196 | int num_leds; |
Uwe Kleine-König | 9517f92 | 2011-03-22 16:30:17 -0700 | [diff] [blame^] | 197 | const struct gpio_led *leds; |
Benjamin Herrenschmidt | 2146325 | 2010-05-22 20:54:55 +1000 | [diff] [blame] | 198 | |
| 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önig | 9517f92 | 2011-03-22 16:30:17 -0700 | [diff] [blame^] | 201 | #define GPIO_LED_BLINK 2 /* Please, blink */ |
Benjamin Herrenschmidt | 2146325 | 2010-05-22 20:54:55 +1000 | [diff] [blame] | 202 | int (*gpio_blink_set)(unsigned gpio, int state, |
Herbert Valerio Riedel | ca3259b | 2008-03-09 23:48:25 +0000 | [diff] [blame] | 203 | unsigned long *delay_on, |
| 204 | unsigned long *delay_off); |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 205 | }; |
| 206 | |
| 207 | |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 208 | #endif /* __LINUX_LEDS_H_INCLUDED */ |