blob: d41ccb56146ace0077cf09b2add2a5c6209a266b [file] [log] [blame]
Richard Purdiec72a1d62006-03-31 02:31:04 -08001/*
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
Johannes Bergaf410fc2006-09-29 02:00:14 -070015#include <linux/list.h>
Yoichi Yuasadf96efd2007-09-11 22:24:45 +010016#include <linux/spinlock.h>
Richard Purdiedc472062007-11-10 13:29:04 +000017#include <linux/rwsem.h>
Johannes Bergaf410fc2006-09-29 02:00:14 -070018
Richard Purdiec72a1d62006-03-31 02:31:04 -080019struct device;
Richard Purdiec72a1d62006-03-31 02:31:04 -080020/*
21 * LED Core
22 */
23
24enum led_brightness {
Ben Dooksfb5035d2006-04-10 22:54:02 -070025 LED_OFF = 0,
26 LED_HALF = 127,
27 LED_FULL = 255,
Richard Purdiec72a1d62006-03-31 02:31:04 -080028};
29
30struct led_classdev {
Ben Dooksfb5035d2006-04-10 22:54:02 -070031 const char *name;
32 int brightness;
33 int flags;
Richard Purdiec72a1d62006-03-31 02:31:04 -080034
Ben Dooksfb5035d2006-04-10 22:54:02 -070035#define LED_SUSPENDED (1 << 0)
Richard Purdiec72a1d62006-03-31 02:31:04 -080036
Ben Dooksfb5035d2006-04-10 22:54:02 -070037 /* Set LED brightness level */
Richard Purdie2e214e02008-04-24 23:49:30 +010038 /* Must not sleep, use a workqueue if needed */
Ben Dooksfb5035d2006-04-10 22:54:02 -070039 void (*brightness_set)(struct led_classdev *led_cdev,
40 enum led_brightness brightness);
Henrique de Moraes Holschuh29d76df2008-03-18 09:47:48 +000041 /* Get LED brightness level */
42 enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
Richard Purdiec72a1d62006-03-31 02:31:04 -080043
Márton Németh4c791412007-10-31 15:07:12 +010044 /* Activate hardware accelerated blink */
45 int (*blink_set)(struct led_classdev *led_cdev,
46 unsigned long *delay_on,
47 unsigned long *delay_off);
48
Richard Purdief8a7c6f2007-07-08 23:19:31 +010049 struct device *dev;
Ben Dooksfb5035d2006-04-10 22:54:02 -070050 struct list_head node; /* LED Device list */
Anton Vorontsov781a54e2008-05-31 15:23:19 +010051 const char *default_trigger; /* Trigger to use */
Ben Dooksfb5035d2006-04-10 22:54:02 -070052
Richard Purdiec3bc9952006-03-31 02:31:05 -080053#ifdef CONFIG_LEDS_TRIGGERS
Richard Purdiec3bc9952006-03-31 02:31:05 -080054 /* Protects the trigger data below */
Richard Purdiedc472062007-11-10 13:29:04 +000055 struct rw_semaphore trigger_lock;
Richard Purdiec3bc9952006-03-31 02:31:05 -080056
Ben Dooksfb5035d2006-04-10 22:54:02 -070057 struct led_trigger *trigger;
58 struct list_head trig_list;
59 void *trigger_data;
Richard Purdiec3bc9952006-03-31 02:31:05 -080060#endif
Richard Purdiec72a1d62006-03-31 02:31:04 -080061};
62
63extern int led_classdev_register(struct device *parent,
Ben Dooksfb5035d2006-04-10 22:54:02 -070064 struct led_classdev *led_cdev);
Rafael J. Wysockib844eba2008-03-23 20:28:24 +010065extern void led_classdev_unregister(struct led_classdev *lcd);
Richard Purdiec72a1d62006-03-31 02:31:04 -080066extern void led_classdev_suspend(struct led_classdev *led_cdev);
67extern void led_classdev_resume(struct led_classdev *led_cdev);
68
Richard Purdiec3bc9952006-03-31 02:31:05 -080069/*
70 * LED Triggers
71 */
72#ifdef CONFIG_LEDS_TRIGGERS
73
74#define TRIG_NAME_MAX 50
75
76struct led_trigger {
77 /* Trigger Properties */
Ben Dooksfb5035d2006-04-10 22:54:02 -070078 const char *name;
79 void (*activate)(struct led_classdev *led_cdev);
80 void (*deactivate)(struct led_classdev *led_cdev);
Richard Purdiec3bc9952006-03-31 02:31:05 -080081
82 /* LEDs under control by this trigger (for simple triggers) */
Ben Dooksfb5035d2006-04-10 22:54:02 -070083 rwlock_t leddev_list_lock;
84 struct list_head led_cdevs;
Richard Purdiec3bc9952006-03-31 02:31:05 -080085
86 /* Link to next registered trigger */
Ben Dooksfb5035d2006-04-10 22:54:02 -070087 struct list_head next_trig;
Richard Purdiec3bc9952006-03-31 02:31:05 -080088};
89
90/* Registration functions for complex triggers */
91extern int led_trigger_register(struct led_trigger *trigger);
92extern void led_trigger_unregister(struct led_trigger *trigger);
93
94/* Registration functions for simple triggers */
95#define DEFINE_LED_TRIGGER(x) static struct led_trigger *x;
96#define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x;
97extern void led_trigger_register_simple(const char *name,
98 struct led_trigger **trigger);
99extern void led_trigger_unregister_simple(struct led_trigger *trigger);
100extern void led_trigger_event(struct led_trigger *trigger,
101 enum led_brightness event);
102
103#else
104
105/* Triggers aren't active - null macros */
106#define DEFINE_LED_TRIGGER(x)
107#define DEFINE_LED_TRIGGER_GLOBAL(x)
108#define led_trigger_register_simple(x, y) do {} while(0)
109#define led_trigger_unregister_simple(x) do {} while(0)
110#define led_trigger_event(x, y) do {} while(0)
111
112#endif
Richard Purdie2bfb6462006-03-31 02:31:16 -0800113
114/* Trigger specific functions */
115#ifdef CONFIG_LEDS_TRIGGER_IDE_DISK
116extern void ledtrig_ide_activity(void);
117#else
118#define ledtrig_ide_activity() do {} while(0)
119#endif
120
Nate Casef46e9202008-07-16 22:49:55 +0100121/*
122 * Generic LED platform data for describing LED names and default triggers.
123 */
124struct led_info {
125 const char *name;
126 char *default_trigger;
127 int flags;
128};
129
130struct led_platform_data {
131 int num_leds;
132 struct led_info *leds;
133};
134
Raphael Assenat22e03f32007-02-27 19:49:53 +0000135/* For the leds-gpio driver */
136struct gpio_led {
137 const char *name;
138 char *default_trigger;
139 unsigned gpio;
140 u8 active_low;
141};
142
143struct gpio_led_platform_data {
144 int num_leds;
145 struct gpio_led *leds;
Herbert Valerio Riedelca3259b2008-03-09 23:48:25 +0000146 int (*gpio_blink_set)(unsigned gpio,
147 unsigned long *delay_on,
148 unsigned long *delay_off);
Raphael Assenat22e03f32007-02-27 19:49:53 +0000149};
150
151
Richard Purdiec72a1d62006-03-31 02:31:04 -0800152#endif /* __LINUX_LEDS_H_INCLUDED */