include/linux/leds.h

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