SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 #include <linux/rwsem.h>
  18
  19 struct device;
  20 /*
  21  * LED Core
  22  */
  23
  24 enum led_brightness {
  25         LED_OFF         = 0,
  26         LED_HALF        = 127,
  27         LED_FULL        = 255,
  28 };
  29
  30 struct led_classdev {
  31         const char              *name;
  32         int                      brightness;
  33         int                      max_brightness;
  34         int                      flags;
  35
  36         /* Lower 16 bits reflect status */
  37 #define LED_SUSPENDED           (1 << 0)
  38         /* Upper 16 bits reflect control information */
  39 #define LED_CORE_SUSPENDRESUME  (1 << 16)
  40
  41         /* Set LED brightness level */
  42         /* Must not sleep, use a workqueue if needed */
  43         void            (*brightness_set)(struct led_classdev *led_cdev,
  44                                           enum led_brightness brightness);
  45         /* Get LED brightness level */
  46         enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
  47
  48         /* Activate hardware accelerated blink, delays are in
  49          * miliseconds and if none is provided then a sensible default
  50          * should be chosen. */
  51         int             (*blink_set)(struct led_classdev *led_cdev,
  52                                      unsigned long *delay_on,
  53                                      unsigned long *delay_off);
  54
  55         struct device           *dev;
  56         struct list_head         node;                  /* LED Device list */
  57         const char              *default_trigger;       /* Trigger to use */
  58
  59 #ifdef CONFIG_LEDS_TRIGGERS
  60         /* Protects the trigger data below */
  61         struct rw_semaphore      trigger_lock;
  62
  63         struct led_trigger      *trigger;
  64         struct list_head         trig_list;
  65         void                    *trigger_data;
  66 #endif
  67 };
  68
  69 extern int led_classdev_register(struct device *parent,
  70                                  struct led_classdev *led_cdev);
  71 extern void led_classdev_unregister(struct led_classdev *led_cdev);
  72 extern void led_classdev_suspend(struct led_classdev *led_cdev);
  73 extern void led_classdev_resume(struct led_classdev *led_cdev);
  74
  75 /*
  76  * LED Triggers
  77  */
  78 #ifdef CONFIG_LEDS_TRIGGERS
  79
  80 #define TRIG_NAME_MAX 50
  81
  82 struct led_trigger {
  83         /* Trigger Properties */
  84         const char       *name;
  85         void            (*activate)(struct led_classdev *led_cdev);
  86         void            (*deactivate)(struct led_classdev *led_cdev);
  87
  88         /* LEDs under control by this trigger (for simple triggers) */
  89         rwlock_t          leddev_list_lock;
  90         struct list_head  led_cdevs;
  91
  92         /* Link to next registered trigger */
  93         struct list_head  next_trig;
  94 };
  95
  96 /* Registration functions for complex triggers */
  97 extern int led_trigger_register(struct led_trigger *trigger);
  98 extern void led_trigger_unregister(struct led_trigger *trigger);
  99
 100 /* Registration functions for simple triggers */
 101 #define DEFINE_LED_TRIGGER(x)           static struct led_trigger *x;
 102 #define DEFINE_LED_TRIGGER_GLOBAL(x)    struct led_trigger *x;
 103 extern void led_trigger_register_simple(const char *name,
 104                                 struct led_trigger **trigger);
 105 extern void led_trigger_unregister_simple(struct led_trigger *trigger);
 106 extern void led_trigger_event(struct led_trigger *trigger,
 107                                 enum led_brightness event);
 108
 109 #else
 110
 111 /* Triggers aren't active - null macros */
 112 #define DEFINE_LED_TRIGGER(x)
 113 #define DEFINE_LED_TRIGGER_GLOBAL(x)
 114 #define led_trigger_register_simple(x, y) do {} while(0)
 115 #define led_trigger_unregister_simple(x) do {} while(0)
 116 #define led_trigger_event(x, y) do {} while(0)
 117
 118 #endif
 119
 120 /* Trigger specific functions */
 121 #ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
 122 extern void ledtrig_ide_activity(void);
 123 #else
 124 #define ledtrig_ide_activity() do {} while(0)
 125 #endif
 126
 127 /*
 128  * Generic LED platform data for describing LED names and default triggers.
 129  */
 130 struct led_info {
 131         const char      *name;
 132         const char      *default_trigger;
 133         int             flags;
 134 };
 135
 136 struct led_platform_data {
 137         int             num_leds;
 138         struct led_info *leds;
 139 };
 140
 141 /* For the leds-gpio driver */
 142 struct gpio_led {
 143         const char *name;
 144         const char *default_trigger;
 145         unsigned        gpio;
 146         unsigned        active_low : 1;
 147         unsigned        retain_state_suspended : 1;
 148         unsigned        default_state : 2;
 149         /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */
 150 };
 151 #define LEDS_GPIO_DEFSTATE_OFF  0
 152 #define LEDS_GPIO_DEFSTATE_ON   1
 153 #define LEDS_GPIO_DEFSTATE_KEEP 2
 154
 155 struct gpio_led_platform_data {
 156         int             num_leds;
 157         struct gpio_led *leds;
 158         int             (*gpio_blink_set)(unsigned gpio,
 159                                         unsigned long *delay_on,
 160                                         unsigned long *delay_off);
 161 };
 162
 163
 164 #endif          /* __LINUX_LEDS_H_INCLUDED */