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 | |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 15 | #include <linux/device.h> |
Hans de Goede | 0cb8eb3 | 2017-01-29 14:42:52 +0100 | [diff] [blame] | 16 | #include <linux/kernfs.h> |
Johannes Berg | af410fc | 2006-09-29 02:00:14 -0700 | [diff] [blame] | 17 | #include <linux/list.h> |
Jacek Anaszewski | acd899e | 2014-09-22 08:21:04 -0700 | [diff] [blame] | 18 | #include <linux/mutex.h> |
Richard Purdie | dc47206 | 2007-11-10 13:29:04 +0000 | [diff] [blame] | 19 | #include <linux/rwsem.h> |
Jacek Anaszewski | 0471330 | 2014-08-07 05:10:22 -0700 | [diff] [blame] | 20 | #include <linux/spinlock.h> |
Jiri Kosina | 9067359 | 2014-09-02 02:03:12 -0700 | [diff] [blame] | 21 | #include <linux/timer.h> |
Fabio Baltieri | d23a22a | 2012-08-15 21:44:34 +0800 | [diff] [blame] | 22 | #include <linux/workqueue.h> |
Johannes Berg | af410fc | 2006-09-29 02:00:14 -0700 | [diff] [blame] | 23 | |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 24 | struct device; |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 25 | /* |
| 26 | * LED Core |
| 27 | */ |
| 28 | |
| 29 | enum led_brightness { |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 30 | LED_OFF = 0, |
Andi Shyti | 4e552c8 | 2017-01-05 11:34:12 +0900 | [diff] [blame] | 31 | LED_ON = 1, |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 32 | LED_HALF = 127, |
| 33 | LED_FULL = 255, |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 34 | }; |
| 35 | |
| 36 | struct led_classdev { |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 37 | const char *name; |
Jacek Anaszewski | d808282 | 2014-08-07 05:10:23 -0700 | [diff] [blame] | 38 | enum led_brightness brightness; |
| 39 | enum led_brightness max_brightness; |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 40 | int flags; |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 41 | |
Richard Purdie | 859cb7f | 2009-01-08 17:55:03 +0000 | [diff] [blame] | 42 | /* Lower 16 bits reflect status */ |
David Lin | 55edd1d | 2017-09-13 10:53:58 -0700 | [diff] [blame] | 43 | #define LED_SUSPENDED BIT(0) |
| 44 | #define LED_UNREGISTERING BIT(1) |
Richard Purdie | 859cb7f | 2009-01-08 17:55:03 +0000 | [diff] [blame] | 45 | /* Upper 16 bits reflect control information */ |
David Lin | 55edd1d | 2017-09-13 10:53:58 -0700 | [diff] [blame] | 46 | #define LED_CORE_SUSPENDRESUME BIT(16) |
| 47 | #define LED_SYSFS_DISABLE BIT(17) |
| 48 | #define LED_DEV_CAP_FLASH BIT(18) |
| 49 | #define LED_HW_PLUGGABLE BIT(19) |
| 50 | #define LED_PANIC_INDICATOR BIT(20) |
| 51 | #define LED_BRIGHT_HW_CHANGED BIT(21) |
| 52 | #define LED_RETAIN_AT_SHUTDOWN BIT(22) |
Subbaraman Narayanamurthy | b827b53 | 2017-01-04 18:46:48 -0800 | [diff] [blame] | 53 | #define LED_KEEP_TRIGGER BIT(23) |
Hans de Goede | a9c6ce5 | 2016-11-08 14:38:46 +0100 | [diff] [blame] | 54 | |
| 55 | /* set_brightness_work / blink_timer flags, atomic, private. */ |
| 56 | unsigned long work_flags; |
| 57 | |
| 58 | #define LED_BLINK_SW 0 |
| 59 | #define LED_BLINK_ONESHOT 1 |
| 60 | #define LED_BLINK_ONESHOT_STOP 2 |
| 61 | #define LED_BLINK_INVERT 3 |
| 62 | #define LED_BLINK_BRIGHTNESS_CHANGE 4 |
| 63 | #define LED_BLINK_DISABLE 5 |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 64 | |
Heiner Kallweit | 70b2563 | 2016-01-21 23:11:25 +0100 | [diff] [blame] | 65 | /* Set LED brightness level |
| 66 | * Must not sleep. Use brightness_set_blocking for drivers |
| 67 | * that can sleep while setting brightness. |
| 68 | */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 69 | void (*brightness_set)(struct led_classdev *led_cdev, |
| 70 | enum led_brightness brightness); |
Jacek Anaszewski | 4d71a4a | 2014-11-14 02:50:18 -0800 | [diff] [blame] | 71 | /* |
| 72 | * Set LED brightness level immediately - it can block the caller for |
| 73 | * the time required for accessing a LED device register. |
| 74 | */ |
Jacek Anaszewski | 437a424 | 2015-10-07 11:10:40 +0200 | [diff] [blame] | 75 | int (*brightness_set_blocking)(struct led_classdev *led_cdev, |
| 76 | enum led_brightness brightness); |
Henrique de Moraes Holschuh | 29d76df | 2008-03-18 09:47:48 +0000 | [diff] [blame] | 77 | /* Get LED brightness level */ |
| 78 | enum led_brightness (*brightness_get)(struct led_classdev *led_cdev); |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 79 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 80 | /* |
| 81 | * Activate hardware accelerated blink, delays are in milliseconds |
| 82 | * and if both are zero then a sensible default should be chosen. |
| 83 | * The call should adjust the timings in that case and if it can't |
| 84 | * match the values specified exactly. |
Tony Makkiel | 7cfe749 | 2016-05-18 17:22:45 +0100 | [diff] [blame] | 85 | * Deactivate blinking again when the brightness is set to LED_OFF |
| 86 | * via the brightness_set() callback. |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 87 | */ |
Márton Németh | 4c79141 | 2007-10-31 15:07:12 +0100 | [diff] [blame] | 88 | int (*blink_set)(struct led_classdev *led_cdev, |
| 89 | unsigned long *delay_on, |
| 90 | unsigned long *delay_off); |
| 91 | |
Richard Purdie | f8a7c6f | 2007-07-08 23:19:31 +0100 | [diff] [blame] | 92 | struct device *dev; |
Johan Hovold | d0d480c | 2014-06-25 10:08:44 -0700 | [diff] [blame] | 93 | const struct attribute_group **groups; |
| 94 | |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 95 | struct list_head node; /* LED Device list */ |
Anton Vorontsov | 781a54e | 2008-05-31 15:23:19 +0100 | [diff] [blame] | 96 | const char *default_trigger; /* Trigger to use */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 97 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 98 | unsigned long blink_delay_on, blink_delay_off; |
Jiri Kosina | 9067359 | 2014-09-02 02:03:12 -0700 | [diff] [blame] | 99 | struct timer_list blink_timer; |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 100 | int blink_brightness; |
Hans de Goede | eb1610b | 2016-10-23 21:47:26 +0200 | [diff] [blame] | 101 | int new_blink_brightness; |
Jacek Anaszewski | 7aea838 | 2015-01-09 07:22:51 -0800 | [diff] [blame] | 102 | void (*flash_resume)(struct led_classdev *led_cdev); |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 103 | |
Fabio Baltieri | d23a22a | 2012-08-15 21:44:34 +0800 | [diff] [blame] | 104 | struct work_struct set_brightness_work; |
| 105 | int delayed_set_value; |
| 106 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 107 | #ifdef CONFIG_LEDS_TRIGGERS |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 108 | /* Protects the trigger data below */ |
Richard Purdie | dc47206 | 2007-11-10 13:29:04 +0000 | [diff] [blame] | 109 | struct rw_semaphore trigger_lock; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 110 | |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 111 | struct led_trigger *trigger; |
| 112 | struct list_head trig_list; |
| 113 | void *trigger_data; |
Shuah Khan | b009618 | 2012-05-29 15:07:27 -0700 | [diff] [blame] | 114 | /* true if activated - deactivate routine uses it to do cleanup */ |
| 115 | bool activated; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 116 | #endif |
Jacek Anaszewski | acd899e | 2014-09-22 08:21:04 -0700 | [diff] [blame] | 117 | |
Hans de Goede | 0cb8eb3 | 2017-01-29 14:42:52 +0100 | [diff] [blame] | 118 | #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED |
| 119 | int brightness_hw_changed; |
| 120 | struct kernfs_node *brightness_hw_changed_kn; |
| 121 | #endif |
| 122 | |
Jacek Anaszewski | acd899e | 2014-09-22 08:21:04 -0700 | [diff] [blame] | 123 | /* Ensures consistent access to the LED Flash Class device */ |
| 124 | struct mutex led_access; |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 125 | }; |
| 126 | |
Rafał Miłecki | 442c609 | 2017-03-06 06:19:44 +0100 | [diff] [blame] | 127 | extern int of_led_classdev_register(struct device *parent, |
| 128 | struct device_node *np, |
| 129 | struct led_classdev *led_cdev); |
| 130 | #define led_classdev_register(parent, led_cdev) \ |
| 131 | of_led_classdev_register(parent, NULL, led_cdev) |
| 132 | extern int devm_of_led_classdev_register(struct device *parent, |
| 133 | struct device_node *np, |
| 134 | struct led_classdev *led_cdev); |
| 135 | #define devm_led_classdev_register(parent, led_cdev) \ |
| 136 | devm_of_led_classdev_register(parent, NULL, led_cdev) |
Wolfram Sang | e2387d6 | 2008-11-17 14:35:44 +0000 | [diff] [blame] | 137 | extern void led_classdev_unregister(struct led_classdev *led_cdev); |
Bjorn Andersson | ca1bb4e | 2015-02-23 16:11:41 -0800 | [diff] [blame] | 138 | extern void devm_led_classdev_unregister(struct device *parent, |
| 139 | struct led_classdev *led_cdev); |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 140 | extern void led_classdev_suspend(struct led_classdev *led_cdev); |
| 141 | extern void led_classdev_resume(struct led_classdev *led_cdev); |
| 142 | |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 143 | /** |
| 144 | * led_blink_set - set blinking with software fallback |
| 145 | * @led_cdev: the LED to start blinking |
| 146 | * @delay_on: the time it should be on (in ms) |
| 147 | * @delay_off: the time it should ble off (in ms) |
| 148 | * |
| 149 | * This function makes the LED blink, attempting to use the |
| 150 | * hardware acceleration if possible, but falling back to |
| 151 | * software blinking if there is no hardware blinking or if |
| 152 | * the LED refuses the passed values. |
| 153 | * |
| 154 | * Note that if software blinking is active, simply calling |
| 155 | * led_cdev->brightness_set() will not stop the blinking, |
| 156 | * use led_classdev_brightness_set() instead. |
| 157 | */ |
| 158 | extern void led_blink_set(struct led_classdev *led_cdev, |
| 159 | unsigned long *delay_on, |
| 160 | unsigned long *delay_off); |
| 161 | /** |
Fabio Baltieri | 5bb629c | 2012-05-27 07:19:22 +0800 | [diff] [blame] | 162 | * led_blink_set_oneshot - do a oneshot software blink |
| 163 | * @led_cdev: the LED to start blinking |
| 164 | * @delay_on: the time it should be on (in ms) |
| 165 | * @delay_off: the time it should ble off (in ms) |
| 166 | * @invert: blink off, then on, leaving the led on |
| 167 | * |
| 168 | * This function makes the LED blink one time for delay_on + |
| 169 | * delay_off time, ignoring the request if another one-shot |
| 170 | * blink is already in progress. |
| 171 | * |
| 172 | * If invert is set, led blinks for delay_off first, then for |
| 173 | * delay_on and leave the led on after the on-off cycle. |
| 174 | */ |
| 175 | extern void led_blink_set_oneshot(struct led_classdev *led_cdev, |
| 176 | unsigned long *delay_on, |
| 177 | unsigned long *delay_off, |
| 178 | int invert); |
| 179 | /** |
Shuah Khan | 19cd67e | 2012-06-14 04:34:30 +0800 | [diff] [blame] | 180 | * led_set_brightness - set LED brightness |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 181 | * @led_cdev: the LED to set |
| 182 | * @brightness: the brightness to set it to |
| 183 | * |
| 184 | * Set an LED's brightness, and, if necessary, cancel the |
| 185 | * software blink timer that implements blinking when the |
Jacek Anaszewski | 1afcadf | 2015-10-19 09:04:01 +0200 | [diff] [blame] | 186 | * hardware doesn't. This function is guaranteed not to sleep. |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 187 | */ |
Shuah Khan | 19cd67e | 2012-06-14 04:34:30 +0800 | [diff] [blame] | 188 | extern void led_set_brightness(struct led_classdev *led_cdev, |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 189 | enum led_brightness brightness); |
Jacek Anaszewski | 13ae79b | 2015-10-07 11:10:43 +0200 | [diff] [blame] | 190 | |
| 191 | /** |
| 192 | * led_set_brightness_sync - set LED brightness synchronously |
| 193 | * @led_cdev: the LED to set |
| 194 | * @brightness: the brightness to set it to |
| 195 | * |
| 196 | * Set an LED's brightness immediately. This function will block |
| 197 | * the caller for the time required for accessing device registers, |
| 198 | * and it can sleep. |
| 199 | * |
| 200 | * Returns: 0 on success or negative error value on failure |
| 201 | */ |
| 202 | extern int led_set_brightness_sync(struct led_classdev *led_cdev, |
| 203 | enum led_brightness value); |
| 204 | |
Jacek Anaszewski | 3ef7de5 | 2014-08-20 06:41:55 -0700 | [diff] [blame] | 205 | /** |
| 206 | * led_update_brightness - update LED brightness |
| 207 | * @led_cdev: the LED to query |
| 208 | * |
| 209 | * Get an LED's current brightness and update led_cdev->brightness |
| 210 | * member with the obtained value. |
| 211 | * |
| 212 | * Returns: 0 on success or negative error value on failure |
| 213 | */ |
| 214 | extern int led_update_brightness(struct led_classdev *led_cdev); |
Johannes Berg | 5ada28b | 2010-11-11 14:05:21 -0800 | [diff] [blame] | 215 | |
Jacek Anaszewski | acd899e | 2014-09-22 08:21:04 -0700 | [diff] [blame] | 216 | /** |
| 217 | * led_sysfs_disable - disable LED sysfs interface |
| 218 | * @led_cdev: the LED to set |
| 219 | * |
| 220 | * Disable the led_cdev's sysfs interface. |
| 221 | */ |
| 222 | extern void led_sysfs_disable(struct led_classdev *led_cdev); |
| 223 | |
| 224 | /** |
| 225 | * led_sysfs_enable - enable LED sysfs interface |
| 226 | * @led_cdev: the LED to set |
| 227 | * |
| 228 | * Enable the led_cdev's sysfs interface. |
| 229 | */ |
| 230 | extern void led_sysfs_enable(struct led_classdev *led_cdev); |
| 231 | |
| 232 | /** |
| 233 | * led_sysfs_is_disabled - check if LED sysfs interface is disabled |
| 234 | * @led_cdev: the LED to query |
| 235 | * |
| 236 | * Returns: true if the led_cdev's sysfs interface is disabled. |
| 237 | */ |
| 238 | static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev) |
| 239 | { |
| 240 | return led_cdev->flags & LED_SYSFS_DISABLE; |
| 241 | } |
| 242 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 243 | /* |
| 244 | * LED Triggers |
| 245 | */ |
Kim, Milo | 39f7e08 | 2013-03-14 04:29:19 -0700 | [diff] [blame] | 246 | /* Registration functions for simple triggers */ |
| 247 | #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x; |
| 248 | #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x; |
| 249 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 250 | #ifdef CONFIG_LEDS_TRIGGERS |
| 251 | |
| 252 | #define TRIG_NAME_MAX 50 |
| 253 | |
| 254 | struct led_trigger { |
| 255 | /* Trigger Properties */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 256 | const char *name; |
Uwe Kleine-König | 2282e125 | 2018-07-02 22:05:21 +0200 | [diff] [blame] | 257 | int (*activate)(struct led_classdev *led_cdev); |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 258 | void (*deactivate)(struct led_classdev *led_cdev); |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 259 | |
| 260 | /* LEDs under control by this trigger (for simple triggers) */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 261 | rwlock_t leddev_list_lock; |
| 262 | struct list_head led_cdevs; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 263 | |
| 264 | /* Link to next registered trigger */ |
Ben Dooks | fb5035d | 2006-04-10 22:54:02 -0700 | [diff] [blame] | 265 | struct list_head next_trig; |
Uwe Kleine-König | a7e7a31 | 2018-07-02 22:05:22 +0200 | [diff] [blame] | 266 | |
| 267 | const struct attribute_group **groups; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 268 | }; |
| 269 | |
Uwe Kleine-König | a7e7a31 | 2018-07-02 22:05:22 +0200 | [diff] [blame] | 270 | /* |
| 271 | * Currently the attributes in struct led_trigger::groups are added directly to |
| 272 | * the LED device. As this might change in the future, the following |
| 273 | * macros abstract getting the LED device and its trigger_data from the dev |
| 274 | * parameter passed to the attribute accessor functions. |
| 275 | */ |
| 276 | #define led_trigger_get_led(dev) ((struct led_classdev *)dev_get_drvdata((dev))) |
| 277 | #define led_trigger_get_drvdata(dev) (led_get_trigger_data(led_trigger_get_led(dev))) |
| 278 | |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 279 | ssize_t led_trigger_store(struct device *dev, struct device_attribute *attr, |
| 280 | const char *buf, size_t count); |
| 281 | ssize_t led_trigger_show(struct device *dev, struct device_attribute *attr, |
| 282 | char *buf); |
| 283 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 284 | /* Registration functions for complex triggers */ |
| 285 | extern int led_trigger_register(struct led_trigger *trigger); |
| 286 | extern void led_trigger_unregister(struct led_trigger *trigger); |
Heiner Kallweit | 9534cc3 | 2016-01-02 01:36:41 +0100 | [diff] [blame] | 287 | extern int devm_led_trigger_register(struct device *dev, |
| 288 | struct led_trigger *trigger); |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 289 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 290 | extern void led_trigger_register_simple(const char *name, |
| 291 | struct led_trigger **trigger); |
| 292 | extern void led_trigger_unregister_simple(struct led_trigger *trigger); |
| 293 | extern void led_trigger_event(struct led_trigger *trigger, |
| 294 | enum led_brightness event); |
Vasily Khoruzhick | 0b9536c | 2011-01-07 16:28:16 +0000 | [diff] [blame] | 295 | extern void led_trigger_blink(struct led_trigger *trigger, |
| 296 | unsigned long *delay_on, |
| 297 | unsigned long *delay_off); |
Fabio Baltieri | 5bb629c | 2012-05-27 07:19:22 +0800 | [diff] [blame] | 298 | extern void led_trigger_blink_oneshot(struct led_trigger *trigger, |
| 299 | unsigned long *delay_on, |
| 300 | unsigned long *delay_off, |
| 301 | int invert); |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 302 | extern void led_trigger_set_default(struct led_classdev *led_cdev); |
Uwe Kleine-König | 2282e125 | 2018-07-02 22:05:21 +0200 | [diff] [blame] | 303 | extern int led_trigger_set(struct led_classdev *led_cdev, |
| 304 | struct led_trigger *trigger); |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 305 | extern void led_trigger_remove(struct led_classdev *led_cdev); |
| 306 | |
Uwe Kleine-König | 9acc560 | 2018-07-02 22:05:25 +0200 | [diff] [blame] | 307 | static inline void led_set_trigger_data(struct led_classdev *led_cdev, |
| 308 | void *trigger_data) |
| 309 | { |
| 310 | led_cdev->trigger_data = trigger_data; |
| 311 | } |
| 312 | |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 313 | static inline void *led_get_trigger_data(struct led_classdev *led_cdev) |
| 314 | { |
| 315 | return led_cdev->trigger_data; |
| 316 | } |
| 317 | |
Jingoo Han | 057407c | 2012-11-18 21:35:55 -0800 | [diff] [blame] | 318 | /** |
| 319 | * led_trigger_rename_static - rename a trigger |
| 320 | * @name: the new trigger name |
| 321 | * @trig: the LED trigger to rename |
| 322 | * |
| 323 | * Change a LED trigger name by copying the string passed in |
| 324 | * name into current trigger name, which MUST be large |
| 325 | * enough for the new string. |
| 326 | * |
| 327 | * Note that name must NOT point to the same string used |
| 328 | * during LED registration, as that could lead to races. |
| 329 | * |
| 330 | * This is meant to be used on triggers with statically |
| 331 | * allocated name. |
| 332 | */ |
| 333 | extern void led_trigger_rename_static(const char *name, |
| 334 | struct led_trigger *trig); |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 335 | |
Uwe Kleine-König | a0b7507 | 2018-07-02 22:05:24 +0200 | [diff] [blame] | 336 | #define module_led_trigger(__led_trigger) \ |
| 337 | module_driver(__led_trigger, led_trigger_register, \ |
| 338 | led_trigger_unregister) |
| 339 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 340 | #else |
| 341 | |
Kim, Milo | 39f7e08 | 2013-03-14 04:29:19 -0700 | [diff] [blame] | 342 | /* Trigger has no members */ |
| 343 | struct led_trigger {}; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 344 | |
Kim, Milo | 39f7e08 | 2013-03-14 04:29:19 -0700 | [diff] [blame] | 345 | /* Trigger inline empty functions */ |
| 346 | static inline void led_trigger_register_simple(const char *name, |
| 347 | struct led_trigger **trigger) {} |
| 348 | static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {} |
| 349 | static inline void led_trigger_event(struct led_trigger *trigger, |
| 350 | enum led_brightness event) {} |
Michael Grzeschik | 8890624 | 2014-09-18 00:12:50 +0200 | [diff] [blame] | 351 | static inline void led_trigger_blink(struct led_trigger *trigger, |
| 352 | unsigned long *delay_on, |
| 353 | unsigned long *delay_off) {} |
| 354 | static inline void led_trigger_blink_oneshot(struct led_trigger *trigger, |
| 355 | unsigned long *delay_on, |
| 356 | unsigned long *delay_off, |
| 357 | int invert) {} |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 358 | static inline void led_trigger_set_default(struct led_classdev *led_cdev) {} |
Uwe Kleine-König | 2282e125 | 2018-07-02 22:05:21 +0200 | [diff] [blame] | 359 | static inline int led_trigger_set(struct led_classdev *led_cdev, |
| 360 | struct led_trigger *trigger) |
| 361 | { |
| 362 | return 0; |
| 363 | } |
| 364 | |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 365 | static inline void led_trigger_remove(struct led_classdev *led_cdev) {} |
Uwe Kleine-König | 9acc560 | 2018-07-02 22:05:25 +0200 | [diff] [blame] | 366 | static inline void led_set_trigger_data(struct led_classdev *led_cdev) {} |
Jacek Anaszewski | 20f5675 | 2015-04-28 00:18:41 -0700 | [diff] [blame] | 367 | static inline void *led_get_trigger_data(struct led_classdev *led_cdev) |
| 368 | { |
| 369 | return NULL; |
| 370 | } |
| 371 | |
Kim, Milo | 39f7e08 | 2013-03-14 04:29:19 -0700 | [diff] [blame] | 372 | #endif /* CONFIG_LEDS_TRIGGERS */ |
Richard Purdie | 2bfb646 | 2006-03-31 02:31:16 -0800 | [diff] [blame] | 373 | |
| 374 | /* Trigger specific functions */ |
Stephan Linz | eb25cb9 | 2016-06-10 07:59:56 +0200 | [diff] [blame] | 375 | #ifdef CONFIG_LEDS_TRIGGER_DISK |
Linus Walleij | d1ed7c5 | 2018-02-24 23:45:56 +0100 | [diff] [blame] | 376 | extern void ledtrig_disk_activity(bool write); |
Richard Purdie | 2bfb646 | 2006-03-31 02:31:16 -0800 | [diff] [blame] | 377 | #else |
Linus Walleij | d1ed7c5 | 2018-02-24 23:45:56 +0100 | [diff] [blame] | 378 | static inline void ledtrig_disk_activity(bool write) {} |
Richard Purdie | 2bfb646 | 2006-03-31 02:31:16 -0800 | [diff] [blame] | 379 | #endif |
| 380 | |
Ezequiel Garcia | 4b72117 | 2016-04-12 17:46:40 -0300 | [diff] [blame] | 381 | #ifdef CONFIG_LEDS_TRIGGER_MTD |
| 382 | extern void ledtrig_mtd_activity(void); |
| 383 | #else |
| 384 | static inline void ledtrig_mtd_activity(void) {} |
| 385 | #endif |
| 386 | |
Kim, Milo | 48a1d03 | 2013-03-14 04:29:24 -0700 | [diff] [blame] | 387 | #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE) |
| 388 | extern void ledtrig_flash_ctrl(bool on); |
| 389 | extern void ledtrig_torch_ctrl(bool on); |
| 390 | #else |
| 391 | static inline void ledtrig_flash_ctrl(bool on) {} |
| 392 | static inline void ledtrig_torch_ctrl(bool on) {} |
| 393 | #endif |
| 394 | |
Nate Case | f46e920 | 2008-07-16 22:49:55 +0100 | [diff] [blame] | 395 | /* |
| 396 | * Generic LED platform data for describing LED names and default triggers. |
| 397 | */ |
| 398 | struct led_info { |
| 399 | const char *name; |
Trent Piepho | 326bb8a5 | 2008-10-13 10:13:01 +0100 | [diff] [blame] | 400 | const char *default_trigger; |
Nate Case | f46e920 | 2008-07-16 22:49:55 +0100 | [diff] [blame] | 401 | int flags; |
| 402 | }; |
| 403 | |
| 404 | struct led_platform_data { |
| 405 | int num_leds; |
| 406 | struct led_info *leds; |
| 407 | }; |
| 408 | |
Heiner Kallweit | 68620e5 | 2016-09-14 20:54:12 +0200 | [diff] [blame] | 409 | struct gpio_desc; |
| 410 | typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state, |
| 411 | unsigned long *delay_on, |
| 412 | unsigned long *delay_off); |
| 413 | |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 414 | /* For the leds-gpio driver */ |
| 415 | struct gpio_led { |
| 416 | const char *name; |
Trent Piepho | 326bb8a5 | 2008-10-13 10:13:01 +0100 | [diff] [blame] | 417 | const char *default_trigger; |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 418 | unsigned gpio; |
Trent Piepho | ed88bae | 2009-05-12 15:33:12 -0700 | [diff] [blame] | 419 | unsigned active_low : 1; |
| 420 | unsigned retain_state_suspended : 1; |
Ezequiel Garcia | 80d6737 | 2016-04-28 19:03:40 -0300 | [diff] [blame] | 421 | unsigned panic_indicator : 1; |
Trent Piepho | ed88bae | 2009-05-12 15:33:12 -0700 | [diff] [blame] | 422 | unsigned default_state : 2; |
Andrew Jeffery | f5808ac | 2017-08-28 09:47:11 +0930 | [diff] [blame] | 423 | unsigned retain_state_shutdown : 1; |
Trent Piepho | ed88bae | 2009-05-12 15:33:12 -0700 | [diff] [blame] | 424 | /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */ |
Mika Westerberg | 5c51277 | 2014-10-27 23:29:32 +0100 | [diff] [blame] | 425 | struct gpio_desc *gpiod; |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 426 | }; |
Benjamin Herrenschmidt | 2146325 | 2010-05-22 20:54:55 +1000 | [diff] [blame] | 427 | #define LEDS_GPIO_DEFSTATE_OFF 0 |
| 428 | #define LEDS_GPIO_DEFSTATE_ON 1 |
| 429 | #define LEDS_GPIO_DEFSTATE_KEEP 2 |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 430 | |
| 431 | struct gpio_led_platform_data { |
| 432 | int num_leds; |
Uwe Kleine-König | 9517f92 | 2011-03-22 16:30:17 -0700 | [diff] [blame] | 433 | const struct gpio_led *leds; |
Benjamin Herrenschmidt | 2146325 | 2010-05-22 20:54:55 +1000 | [diff] [blame] | 434 | |
| 435 | #define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */ |
| 436 | #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] | 437 | #define GPIO_LED_BLINK 2 /* Please, blink */ |
Heiner Kallweit | 68620e5 | 2016-09-14 20:54:12 +0200 | [diff] [blame] | 438 | gpio_blink_set_t gpio_blink_set; |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 439 | }; |
| 440 | |
Andrew F. Davis | fca23e4 | 2016-06-21 14:40:11 +0200 | [diff] [blame] | 441 | #ifdef CONFIG_NEW_LEDS |
Uwe Kleine-König | 4440673 | 2011-05-24 17:13:29 -0700 | [diff] [blame] | 442 | struct platform_device *gpio_led_register_device( |
| 443 | int id, const struct gpio_led_platform_data *pdata); |
Andrew F. Davis | fca23e4 | 2016-06-21 14:40:11 +0200 | [diff] [blame] | 444 | #else |
| 445 | static inline struct platform_device *gpio_led_register_device( |
| 446 | int id, const struct gpio_led_platform_data *pdata) |
| 447 | { |
| 448 | return 0; |
| 449 | } |
| 450 | #endif |
Raphael Assenat | 22e03f3 | 2007-02-27 19:49:53 +0000 | [diff] [blame] | 451 | |
Bryan Wu | 8f88731 | 2011-06-25 18:33:50 +0800 | [diff] [blame] | 452 | enum cpu_led_event { |
| 453 | CPU_LED_IDLE_START, /* CPU enters idle */ |
| 454 | CPU_LED_IDLE_END, /* CPU idle ends */ |
| 455 | CPU_LED_START, /* Machine starts, especially resume */ |
| 456 | CPU_LED_STOP, /* Machine stops, especially suspend */ |
| 457 | CPU_LED_HALTED, /* Machine shutdown */ |
| 458 | }; |
| 459 | #ifdef CONFIG_LEDS_TRIGGER_CPU |
| 460 | extern void ledtrig_cpu(enum cpu_led_event evt); |
| 461 | #else |
| 462 | static inline void ledtrig_cpu(enum cpu_led_event evt) |
| 463 | { |
| 464 | return; |
| 465 | } |
| 466 | #endif |
| 467 | |
Hans de Goede | 0cb8eb3 | 2017-01-29 14:42:52 +0100 | [diff] [blame] | 468 | #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED |
| 469 | extern void led_classdev_notify_brightness_hw_changed( |
| 470 | struct led_classdev *led_cdev, enum led_brightness brightness); |
| 471 | #else |
| 472 | static inline void led_classdev_notify_brightness_hw_changed( |
| 473 | struct led_classdev *led_cdev, enum led_brightness brightness) { } |
| 474 | #endif |
| 475 | |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 476 | #endif /* __LINUX_LEDS_H_INCLUDED */ |