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