leds.h 3.4 KB

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