blob: 822a373d334657688802e1d2de1578f0245836ba [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Backlight Lowlevel Control Abstraction
3 *
4 * Copyright (C) 2003,2004 Hewlett-Packard Company
5 *
6 */
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/module.h>
9#include <linux/init.h>
10#include <linux/device.h>
11#include <linux/backlight.h>
12#include <linux/notifier.h>
13#include <linux/ctype.h>
14#include <linux/err.h>
15#include <linux/fb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Richard Purdie321709c2007-02-10 15:04:08 +000017#ifdef CONFIG_PMAC_BACKLIGHT
18#include <asm/backlight.h>
19#endif
James Simmons3d5eead2006-12-08 02:40:47 -080020
21#if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
22 defined(CONFIG_BACKLIGHT_CLASS_DEVICE_MODULE))
23/* This callback gets called when something important happens inside a
24 * framebuffer driver. We're looking if that important event is blanking,
25 * and if it is, we're switching backlight power as well ...
26 */
27static int fb_notifier_callback(struct notifier_block *self,
28 unsigned long event, void *data)
29{
30 struct backlight_device *bd;
31 struct fb_event *evdata = data;
32
33 /* If we aren't interested in this event, skip it immediately ... */
Richard Purdie994efac2007-02-09 09:46:45 +000034 if (event != FB_EVENT_BLANK && event != FB_EVENT_CONBLANK)
James Simmons3d5eead2006-12-08 02:40:47 -080035 return 0;
36
37 bd = container_of(self, struct backlight_device, fb_notif);
Richard Purdie249040d2007-02-08 22:53:55 +000038 mutex_lock(&bd->props_lock);
James Simmons3d5eead2006-12-08 02:40:47 -080039 if (bd->props)
40 if (!bd->props->check_fb ||
41 bd->props->check_fb(evdata->info)) {
42 bd->props->fb_blank = *(int *)evdata->data;
Richard Purdie28ee0862007-02-08 22:25:09 +000043 backlight_update_status(bd);
James Simmons3d5eead2006-12-08 02:40:47 -080044 }
Richard Purdie249040d2007-02-08 22:53:55 +000045 mutex_unlock(&bd->props_lock);
James Simmons3d5eead2006-12-08 02:40:47 -080046 return 0;
47}
48
49static int backlight_register_fb(struct backlight_device *bd)
50{
51 memset(&bd->fb_notif, 0, sizeof(bd->fb_notif));
52 bd->fb_notif.notifier_call = fb_notifier_callback;
53
54 return fb_register_client(&bd->fb_notif);
55}
56
57static void backlight_unregister_fb(struct backlight_device *bd)
58{
59 fb_unregister_client(&bd->fb_notif);
60}
61#else
62static inline int backlight_register_fb(struct backlight_device *bd)
63{
64 return 0;
65}
66
67static inline void backlight_unregister_fb(struct backlight_device *bd)
68{
69}
70#endif /* CONFIG_FB */
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static ssize_t backlight_show_power(struct class_device *cdev, char *buf)
73{
Richard Purdie6ca01762006-03-31 02:31:49 -080074 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 struct backlight_device *bd = to_backlight_device(cdev);
76
Richard Purdie249040d2007-02-08 22:53:55 +000077 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +000078 if (bd->props)
Richard Purdie6ca01762006-03-31 02:31:49 -080079 rc = sprintf(buf, "%d\n", bd->props->power);
Richard Purdie249040d2007-02-08 22:53:55 +000080 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82 return rc;
83}
84
85static ssize_t backlight_store_power(struct class_device *cdev, const char *buf, size_t count)
86{
Richard Purdie68673af2006-05-15 09:44:15 -070087 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 char *endp;
89 struct backlight_device *bd = to_backlight_device(cdev);
Richard Purdie68673af2006-05-15 09:44:15 -070090 int power = simple_strtoul(buf, &endp, 0);
91 size_t size = endp - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Richard Purdie68673af2006-05-15 09:44:15 -070093 if (*endp && isspace(*endp))
94 size++;
95 if (size != count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 return -EINVAL;
97
Richard Purdie249040d2007-02-08 22:53:55 +000098 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +000099 if (bd->props) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 pr_debug("backlight: set power to %d\n", power);
Richard Purdie6ca01762006-03-31 02:31:49 -0800101 bd->props->power = power;
Richard Purdie28ee0862007-02-08 22:25:09 +0000102 backlight_update_status(bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 rc = count;
Richard Purdie6ca01762006-03-31 02:31:49 -0800104 }
Richard Purdie249040d2007-02-08 22:53:55 +0000105 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107 return rc;
108}
109
110static ssize_t backlight_show_brightness(struct class_device *cdev, char *buf)
111{
Richard Purdie6ca01762006-03-31 02:31:49 -0800112 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 struct backlight_device *bd = to_backlight_device(cdev);
114
Richard Purdie249040d2007-02-08 22:53:55 +0000115 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000116 if (bd->props)
Richard Purdie6ca01762006-03-31 02:31:49 -0800117 rc = sprintf(buf, "%d\n", bd->props->brightness);
Richard Purdie249040d2007-02-08 22:53:55 +0000118 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 return rc;
121}
122
123static ssize_t backlight_store_brightness(struct class_device *cdev, const char *buf, size_t count)
124{
Richard Purdie68673af2006-05-15 09:44:15 -0700125 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 char *endp;
127 struct backlight_device *bd = to_backlight_device(cdev);
Richard Purdie68673af2006-05-15 09:44:15 -0700128 int brightness = simple_strtoul(buf, &endp, 0);
129 size_t size = endp - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Richard Purdie68673af2006-05-15 09:44:15 -0700131 if (*endp && isspace(*endp))
132 size++;
133 if (size != count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 return -EINVAL;
135
Richard Purdie249040d2007-02-08 22:53:55 +0000136 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000137 if (bd->props) {
Richard Purdie6ca01762006-03-31 02:31:49 -0800138 if (brightness > bd->props->max_brightness)
139 rc = -EINVAL;
140 else {
141 pr_debug("backlight: set brightness to %d\n",
142 brightness);
143 bd->props->brightness = brightness;
Richard Purdie28ee0862007-02-08 22:25:09 +0000144 backlight_update_status(bd);
Richard Purdie6ca01762006-03-31 02:31:49 -0800145 rc = count;
146 }
147 }
Richard Purdie249040d2007-02-08 22:53:55 +0000148 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 return rc;
151}
152
153static ssize_t backlight_show_max_brightness(struct class_device *cdev, char *buf)
154{
Richard Purdie6ca01762006-03-31 02:31:49 -0800155 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 struct backlight_device *bd = to_backlight_device(cdev);
157
Richard Purdie249040d2007-02-08 22:53:55 +0000158 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000159 if (bd->props)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 rc = sprintf(buf, "%d\n", bd->props->max_brightness);
Richard Purdie249040d2007-02-08 22:53:55 +0000161 mutex_unlock(&bd->props_lock);
Richard Purdie6ca01762006-03-31 02:31:49 -0800162
163 return rc;
164}
165
166static ssize_t backlight_show_actual_brightness(struct class_device *cdev,
167 char *buf)
168{
169 int rc = -ENXIO;
170 struct backlight_device *bd = to_backlight_device(cdev);
171
Richard Purdie249040d2007-02-08 22:53:55 +0000172 mutex_lock(&bd->props_lock);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000173 if (bd->props && bd->props->get_brightness)
Richard Purdie6ca01762006-03-31 02:31:49 -0800174 rc = sprintf(buf, "%d\n", bd->props->get_brightness(bd));
Richard Purdie249040d2007-02-08 22:53:55 +0000175 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 return rc;
178}
179
180static void backlight_class_release(struct class_device *dev)
181{
182 struct backlight_device *bd = to_backlight_device(dev);
183 kfree(bd);
184}
185
186static struct class backlight_class = {
187 .name = "backlight",
188 .release = backlight_class_release,
189};
190
191#define DECLARE_ATTR(_name,_mode,_show,_store) \
192{ \
193 .attr = { .name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \
194 .show = _show, \
195 .store = _store, \
196}
197
Helge Dellerd95159c2006-12-08 02:40:28 -0800198static const struct class_device_attribute bl_class_device_attributes[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 DECLARE_ATTR(power, 0644, backlight_show_power, backlight_store_power),
Richard Purdie6ca01762006-03-31 02:31:49 -0800200 DECLARE_ATTR(brightness, 0644, backlight_show_brightness,
201 backlight_store_brightness),
202 DECLARE_ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
203 NULL),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 DECLARE_ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
205};
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207/**
208 * backlight_device_register - create and register a new object of
209 * backlight_device class.
210 * @name: the name of the new object(must be the same as the name of the
211 * respective framebuffer device).
212 * @devdata: an optional pointer to be stored in the class_device. The
213 * methods may retrieve it by using class_get_devdata(&bd->class_dev).
214 * @bp: the backlight properties structure.
215 *
216 * Creates and registers new backlight class_device. Returns either an
217 * ERR_PTR() or a pointer to the newly allocated device.
218 */
Yu Luming519ab5f2006-12-19 12:56:15 -0800219struct backlight_device *backlight_device_register(const char *name,
220 struct device *dev,
221 void *devdata,
222 struct backlight_properties *bp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
224 int i, rc;
225 struct backlight_device *new_bd;
226
227 pr_debug("backlight_device_alloc: name=%s\n", name);
228
229 new_bd = kmalloc(sizeof(struct backlight_device), GFP_KERNEL);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000230 if (!new_bd)
Jean Delvare10ad1b72006-03-09 17:33:36 -0800231 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Richard Purdie28ee0862007-02-08 22:25:09 +0000233 mutex_init(&new_bd->update_lock);
Richard Purdie249040d2007-02-08 22:53:55 +0000234 mutex_init(&new_bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 new_bd->props = bp;
236 memset(&new_bd->class_dev, 0, sizeof(new_bd->class_dev));
237 new_bd->class_dev.class = &backlight_class;
Yu Luming519ab5f2006-12-19 12:56:15 -0800238 new_bd->class_dev.dev = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 strlcpy(new_bd->class_dev.class_id, name, KOBJ_NAME_LEN);
240 class_set_devdata(&new_bd->class_dev, devdata);
241
242 rc = class_device_register(&new_bd->class_dev);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000243 if (rc) {
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000244 kfree(new_bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 return ERR_PTR(rc);
246 }
247
James Simmons3d5eead2006-12-08 02:40:47 -0800248 rc = backlight_register_fb(new_bd);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000249 if (rc) {
250 class_device_unregister(&new_bd->class_dev);
251 return ERR_PTR(rc);
252 }
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255 for (i = 0; i < ARRAY_SIZE(bl_class_device_attributes); i++) {
256 rc = class_device_create_file(&new_bd->class_dev,
257 &bl_class_device_attributes[i]);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000258 if (rc) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 while (--i >= 0)
260 class_device_remove_file(&new_bd->class_dev,
261 &bl_class_device_attributes[i]);
262 class_device_unregister(&new_bd->class_dev);
263 /* No need to kfree(new_bd) since release() method was called */
264 return ERR_PTR(rc);
265 }
266 }
267
Richard Purdie321709c2007-02-10 15:04:08 +0000268#ifdef CONFIG_PMAC_BACKLIGHT
269 mutex_lock(&pmac_backlight_mutex);
270 if (!pmac_backlight)
271 pmac_backlight = new_bd;
272 mutex_unlock(&pmac_backlight_mutex);
273#endif
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return new_bd;
276}
277EXPORT_SYMBOL(backlight_device_register);
278
279/**
280 * backlight_device_unregister - unregisters a backlight device object.
281 * @bd: the backlight device object to be unregistered and freed.
282 *
283 * Unregisters a previously registered via backlight_device_register object.
284 */
285void backlight_device_unregister(struct backlight_device *bd)
286{
287 int i;
288
289 if (!bd)
290 return;
291
292 pr_debug("backlight_device_unregister: name=%s\n", bd->class_dev.class_id);
293
Richard Purdie321709c2007-02-10 15:04:08 +0000294#ifdef CONFIG_PMAC_BACKLIGHT
295 mutex_lock(&pmac_backlight_mutex);
296 if (pmac_backlight == bd)
297 pmac_backlight = NULL;
298 mutex_unlock(&pmac_backlight_mutex);
299#endif
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 for (i = 0; i < ARRAY_SIZE(bl_class_device_attributes); i++)
302 class_device_remove_file(&bd->class_dev,
303 &bl_class_device_attributes[i]);
304
Richard Purdie249040d2007-02-08 22:53:55 +0000305 mutex_lock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 bd->props = NULL;
Richard Purdie249040d2007-02-08 22:53:55 +0000307 mutex_unlock(&bd->props_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
James Simmons3d5eead2006-12-08 02:40:47 -0800309 backlight_unregister_fb(bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 class_device_unregister(&bd->class_dev);
312}
313EXPORT_SYMBOL(backlight_device_unregister);
314
315static void __exit backlight_class_exit(void)
316{
317 class_unregister(&backlight_class);
318}
319
320static int __init backlight_class_init(void)
321{
322 return class_register(&backlight_class);
323}
324
325/*
326 * if this is compiled into the kernel, we need to ensure that the
327 * class is registered before users of the class try to register lcd's
328 */
329postcore_initcall(backlight_class_init);
330module_exit(backlight_class_exit);
331
332MODULE_LICENSE("GPL");
333MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
334MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");