leds.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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. struct device;
  15. struct class_device;
  16. /*
  17. * LED Core
  18. */
  19. enum led_brightness {
  20. LED_OFF = 0,
  21. LED_HALF = 127,
  22. LED_FULL = 255,
  23. };
  24. struct led_classdev {
  25. const char *name;
  26. int brightness;
  27. int flags;
  28. #define LED_SUSPENDED (1 << 0)
  29. /* A function to set the brightness of the led */
  30. void (*brightness_set)(struct led_classdev *led_cdev,
  31. enum led_brightness brightness);
  32. struct class_device *class_dev;
  33. /* LED Device linked list */
  34. struct list_head node;
  35. /* Trigger data */
  36. char *default_trigger;
  37. #ifdef CONFIG_LEDS_TRIGGERS
  38. rwlock_t trigger_lock;
  39. /* Protects the trigger data below */
  40. struct led_trigger *trigger;
  41. struct list_head trig_list;
  42. void *trigger_data;
  43. #endif
  44. };
  45. extern int led_classdev_register(struct device *parent,
  46. struct led_classdev *led_cdev);
  47. extern void led_classdev_unregister(struct led_classdev *led_cdev);
  48. extern void led_classdev_suspend(struct led_classdev *led_cdev);
  49. extern void led_classdev_resume(struct led_classdev *led_cdev);
  50. /*
  51. * LED Triggers
  52. */
  53. #ifdef CONFIG_LEDS_TRIGGERS
  54. #define TRIG_NAME_MAX 50
  55. struct led_trigger {
  56. /* Trigger Properties */
  57. const char *name;
  58. void (*activate)(struct led_classdev *led_cdev);
  59. void (*deactivate)(struct led_classdev *led_cdev);
  60. /* LEDs under control by this trigger (for simple triggers) */
  61. rwlock_t leddev_list_lock;
  62. struct list_head led_cdevs;
  63. /* Link to next registered trigger */
  64. struct list_head next_trig;
  65. };
  66. /* Registration functions for complex triggers */
  67. extern int led_trigger_register(struct led_trigger *trigger);
  68. extern void led_trigger_unregister(struct led_trigger *trigger);
  69. /* Registration functions for simple triggers */
  70. #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
  71. #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
  72. extern void led_trigger_register_simple(const char *name,
  73. struct led_trigger **trigger);
  74. extern void led_trigger_unregister_simple(struct led_trigger *trigger);
  75. extern void led_trigger_event(struct led_trigger *trigger,
  76. enum led_brightness event);
  77. #else
  78. /* Triggers aren't active - null macros */
  79. #define DEFINE_LED_TRIGGER(x)
  80. #define DEFINE_LED_TRIGGER_GLOBAL(x)
  81. #define led_trigger_register_simple(x, y) do {} while(0)
  82. #define led_trigger_unregister_simple(x) do {} while(0)
  83. #define led_trigger_event(x, y) do {} while(0)
  84. #endif
  85. #endif /* __LINUX_LEDS_H_INCLUDED */