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 | |
| 15 | struct device; |
| 16 | struct class_device; |
| 17 | /* |
| 18 | * LED Core |
| 19 | */ |
| 20 | |
| 21 | enum led_brightness { |
| 22 | LED_OFF = 0, |
| 23 | LED_HALF = 127, |
| 24 | LED_FULL = 255, |
| 25 | }; |
| 26 | |
| 27 | struct led_classdev { |
| 28 | const char *name; |
| 29 | int brightness; |
| 30 | int flags; |
| 31 | #define LED_SUSPENDED (1 << 0) |
| 32 | |
| 33 | /* A function to set the brightness of the led */ |
| 34 | void (*brightness_set)(struct led_classdev *led_cdev, |
| 35 | enum led_brightness brightness); |
| 36 | |
| 37 | struct class_device *class_dev; |
| 38 | /* LED Device linked list */ |
| 39 | struct list_head node; |
| 40 | |
| 41 | /* Trigger data */ |
| 42 | char *default_trigger; |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 43 | #ifdef CONFIG_LEDS_TRIGGERS |
| 44 | rwlock_t trigger_lock; |
| 45 | /* Protects the trigger data below */ |
| 46 | |
| 47 | struct led_trigger *trigger; |
| 48 | struct list_head trig_list; |
| 49 | void *trigger_data; |
| 50 | #endif |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 51 | }; |
| 52 | |
| 53 | extern int led_classdev_register(struct device *parent, |
| 54 | struct led_classdev *led_cdev); |
| 55 | extern void led_classdev_unregister(struct led_classdev *led_cdev); |
| 56 | extern void led_classdev_suspend(struct led_classdev *led_cdev); |
| 57 | extern void led_classdev_resume(struct led_classdev *led_cdev); |
| 58 | |
Richard Purdie | c3bc995 | 2006-03-31 02:31:05 -0800 | [diff] [blame] | 59 | /* |
| 60 | * LED Triggers |
| 61 | */ |
| 62 | #ifdef CONFIG_LEDS_TRIGGERS |
| 63 | |
| 64 | #define TRIG_NAME_MAX 50 |
| 65 | |
| 66 | struct led_trigger { |
| 67 | /* Trigger Properties */ |
| 68 | const char *name; |
| 69 | void (*activate)(struct led_classdev *led_cdev); |
| 70 | void (*deactivate)(struct led_classdev *led_cdev); |
| 71 | |
| 72 | /* LEDs under control by this trigger (for simple triggers) */ |
| 73 | rwlock_t leddev_list_lock; |
| 74 | struct list_head led_cdevs; |
| 75 | |
| 76 | /* Link to next registered trigger */ |
| 77 | struct list_head next_trig; |
| 78 | }; |
| 79 | |
| 80 | /* Registration functions for complex triggers */ |
| 81 | extern int led_trigger_register(struct led_trigger *trigger); |
| 82 | extern void led_trigger_unregister(struct led_trigger *trigger); |
| 83 | |
| 84 | /* Registration functions for simple triggers */ |
| 85 | #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x; |
| 86 | #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x; |
| 87 | extern void led_trigger_register_simple(const char *name, |
| 88 | struct led_trigger **trigger); |
| 89 | extern void led_trigger_unregister_simple(struct led_trigger *trigger); |
| 90 | extern void led_trigger_event(struct led_trigger *trigger, |
| 91 | enum led_brightness event); |
| 92 | |
| 93 | #else |
| 94 | |
| 95 | /* Triggers aren't active - null macros */ |
| 96 | #define DEFINE_LED_TRIGGER(x) |
| 97 | #define DEFINE_LED_TRIGGER_GLOBAL(x) |
| 98 | #define led_trigger_register_simple(x, y) do {} while(0) |
| 99 | #define led_trigger_unregister_simple(x) do {} while(0) |
| 100 | #define led_trigger_event(x, y) do {} while(0) |
| 101 | |
| 102 | #endif |
Richard Purdie | 2bfb646 | 2006-03-31 02:31:16 -0800 | [diff] [blame] | 103 | |
| 104 | /* Trigger specific functions */ |
| 105 | #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK |
| 106 | extern void ledtrig_ide_activity(void); |
| 107 | #else |
| 108 | #define ledtrig_ide_activity() do {} while(0) |
| 109 | #endif |
| 110 | |
Richard Purdie | c72a1d6 | 2006-03-31 02:31:04 -0800 | [diff] [blame] | 111 | #endif /* __LINUX_LEDS_H_INCLUDED */ |