blob: 157057c79ca3760fc80d6df28236dc0bbf106044 [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 Purdie599a52d2007-02-10 23:07:48 +000038 mutex_lock(&bd->ops_lock);
39 if (bd->ops)
40 if (!bd->ops->check_fb ||
41 bd->ops->check_fb(evdata->info)) {
42 bd->props.fb_blank = *(int *)evdata->data;
Richard Purdiec835ee72009-01-06 21:00:19 +000043 if (bd->props.fb_blank == FB_BLANK_UNBLANK)
44 bd->props.state &= ~BL_CORE_FBBLANK;
45 else
46 bd->props.state |= BL_CORE_FBBLANK;
Richard Purdie28ee0862007-02-08 22:25:09 +000047 backlight_update_status(bd);
James Simmons3d5eead2006-12-08 02:40:47 -080048 }
Richard Purdie599a52d2007-02-10 23:07:48 +000049 mutex_unlock(&bd->ops_lock);
James Simmons3d5eead2006-12-08 02:40:47 -080050 return 0;
51}
52
53static int backlight_register_fb(struct backlight_device *bd)
54{
55 memset(&bd->fb_notif, 0, sizeof(bd->fb_notif));
56 bd->fb_notif.notifier_call = fb_notifier_callback;
57
58 return fb_register_client(&bd->fb_notif);
59}
60
61static void backlight_unregister_fb(struct backlight_device *bd)
62{
63 fb_unregister_client(&bd->fb_notif);
64}
65#else
66static inline int backlight_register_fb(struct backlight_device *bd)
67{
68 return 0;
69}
70
71static inline void backlight_unregister_fb(struct backlight_device *bd)
72{
73}
74#endif /* CONFIG_FB */
75
Richard Purdie655bfd72007-07-09 12:17:24 +010076static ssize_t backlight_show_power(struct device *dev,
77 struct device_attribute *attr,char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078{
Richard Purdie655bfd72007-07-09 12:17:24 +010079 struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Richard Purdie599a52d2007-02-10 23:07:48 +000081 return sprintf(buf, "%d\n", bd->props.power);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082}
83
Richard Purdie655bfd72007-07-09 12:17:24 +010084static ssize_t backlight_store_power(struct device *dev,
85 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
Pavel Machek9a2c61a2008-12-03 08:43:48 +000087 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +010088 struct backlight_device *bd = to_backlight_device(dev);
Pavel Machek9a2c61a2008-12-03 08:43:48 +000089 unsigned long power;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Pavel Machek9a2c61a2008-12-03 08:43:48 +000091 rc = strict_strtoul(buf, 0, &power);
92 if (rc)
93 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Pavel Machek9a2c61a2008-12-03 08:43:48 +000095 rc = -ENXIO;
Richard Purdie599a52d2007-02-10 23:07:48 +000096 mutex_lock(&bd->ops_lock);
97 if (bd->ops) {
Pavel Machek9a2c61a2008-12-03 08:43:48 +000098 pr_debug("backlight: set power to %lu\n", power);
Helge Deller51552452008-01-13 23:01:13 +000099 if (bd->props.power != power) {
100 bd->props.power = power;
101 backlight_update_status(bd);
102 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 rc = count;
Richard Purdie6ca01762006-03-31 02:31:49 -0800104 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000105 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107 return rc;
108}
109
Richard Purdie655bfd72007-07-09 12:17:24 +0100110static ssize_t backlight_show_brightness(struct device *dev,
111 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112{
Richard Purdie655bfd72007-07-09 12:17:24 +0100113 struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Richard Purdie599a52d2007-02-10 23:07:48 +0000115 return sprintf(buf, "%d\n", bd->props.brightness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116}
117
Richard Purdie655bfd72007-07-09 12:17:24 +0100118static ssize_t backlight_store_brightness(struct device *dev,
119 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
Pavel Machek9a2c61a2008-12-03 08:43:48 +0000121 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +0100122 struct backlight_device *bd = to_backlight_device(dev);
Pavel Machek9a2c61a2008-12-03 08:43:48 +0000123 unsigned long brightness;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Pavel Machek9a2c61a2008-12-03 08:43:48 +0000125 rc = strict_strtoul(buf, 0, &brightness);
126 if (rc)
127 return rc;
128
129 rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Richard Purdie599a52d2007-02-10 23:07:48 +0000131 mutex_lock(&bd->ops_lock);
132 if (bd->ops) {
133 if (brightness > bd->props.max_brightness)
Richard Purdie6ca01762006-03-31 02:31:49 -0800134 rc = -EINVAL;
135 else {
Pavel Machek9a2c61a2008-12-03 08:43:48 +0000136 pr_debug("backlight: set brightness to %lu\n",
Richard Purdie6ca01762006-03-31 02:31:49 -0800137 brightness);
Zhang Rui9be1df92009-01-08 14:11:30 +0000138 bd->props.brightness = brightness;
139 backlight_update_status(bd);
Richard Purdie6ca01762006-03-31 02:31:49 -0800140 rc = count;
141 }
142 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000143 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 return rc;
146}
147
Richard Purdie655bfd72007-07-09 12:17:24 +0100148static ssize_t backlight_show_max_brightness(struct device *dev,
149 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Richard Purdie655bfd72007-07-09 12:17:24 +0100151 struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Richard Purdie599a52d2007-02-10 23:07:48 +0000153 return sprintf(buf, "%d\n", bd->props.max_brightness);
Richard Purdie6ca01762006-03-31 02:31:49 -0800154}
155
Richard Purdie655bfd72007-07-09 12:17:24 +0100156static ssize_t backlight_show_actual_brightness(struct device *dev,
157 struct device_attribute *attr, char *buf)
Richard Purdie6ca01762006-03-31 02:31:49 -0800158{
159 int rc = -ENXIO;
Richard Purdie655bfd72007-07-09 12:17:24 +0100160 struct backlight_device *bd = to_backlight_device(dev);
Richard Purdie6ca01762006-03-31 02:31:49 -0800161
Richard Purdie599a52d2007-02-10 23:07:48 +0000162 mutex_lock(&bd->ops_lock);
163 if (bd->ops && bd->ops->get_brightness)
164 rc = sprintf(buf, "%d\n", bd->ops->get_brightness(bd));
165 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167 return rc;
168}
169
Adrian Bunk0ad90ef2007-08-11 10:27:19 +0100170static struct class *backlight_class;
Richard Purdie655bfd72007-07-09 12:17:24 +0100171
Richard Purdiec835ee72009-01-06 21:00:19 +0000172static int backlight_suspend(struct device *dev, pm_message_t state)
173{
174 struct backlight_device *bd = to_backlight_device(dev);
175
176 if (bd->ops->options & BL_CORE_SUSPENDRESUME) {
177 mutex_lock(&bd->ops_lock);
178 bd->props.state |= BL_CORE_SUSPENDED;
179 backlight_update_status(bd);
180 mutex_unlock(&bd->ops_lock);
181 }
182
183 return 0;
184}
185
186static int backlight_resume(struct device *dev)
187{
188 struct backlight_device *bd = to_backlight_device(dev);
189
190 if (bd->ops->options & BL_CORE_SUSPENDRESUME) {
191 mutex_lock(&bd->ops_lock);
192 bd->props.state &= ~BL_CORE_SUSPENDED;
193 backlight_update_status(bd);
194 mutex_unlock(&bd->ops_lock);
195 }
196
197 return 0;
198}
199
Richard Purdie655bfd72007-07-09 12:17:24 +0100200static void bl_device_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
202 struct backlight_device *bd = to_backlight_device(dev);
203 kfree(bd);
204}
205
Richard Purdie655bfd72007-07-09 12:17:24 +0100206static struct device_attribute bl_device_attributes[] = {
207 __ATTR(bl_power, 0644, backlight_show_power, backlight_store_power),
208 __ATTR(brightness, 0644, backlight_show_brightness,
Richard Purdie6ca01762006-03-31 02:31:49 -0800209 backlight_store_brightness),
Richard Purdie655bfd72007-07-09 12:17:24 +0100210 __ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
Richard Purdie6ca01762006-03-31 02:31:49 -0800211 NULL),
Richard Purdie655bfd72007-07-09 12:17:24 +0100212 __ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
213 __ATTR_NULL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214};
215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216/**
217 * backlight_device_register - create and register a new object of
218 * backlight_device class.
219 * @name: the name of the new object(must be the same as the name of the
220 * respective framebuffer device).
Sebastian Siewiorf6ec2d92008-07-16 23:05:49 +0100221 * @parent: a pointer to the parent device
Richard Purdie655bfd72007-07-09 12:17:24 +0100222 * @devdata: an optional pointer to be stored for private driver use. The
223 * methods may retrieve it by using bl_get_data(bd).
Richard Purdie599a52d2007-02-10 23:07:48 +0000224 * @ops: the backlight operations structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 *
Richard Purdie655bfd72007-07-09 12:17:24 +0100226 * Creates and registers new backlight device. Returns either an
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 * ERR_PTR() or a pointer to the newly allocated device.
228 */
Yu Luming519ab5f2006-12-19 12:56:15 -0800229struct backlight_device *backlight_device_register(const char *name,
Richard Purdie655bfd72007-07-09 12:17:24 +0100230 struct device *parent, void *devdata, struct backlight_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 struct backlight_device *new_bd;
Richard Purdie655bfd72007-07-09 12:17:24 +0100233 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Richard Purdie655bfd72007-07-09 12:17:24 +0100235 pr_debug("backlight_device_register: name=%s\n", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Richard Purdie599a52d2007-02-10 23:07:48 +0000237 new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000238 if (!new_bd)
Jean Delvare10ad1b72006-03-09 17:33:36 -0800239 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Richard Purdie28ee0862007-02-08 22:25:09 +0000241 mutex_init(&new_bd->update_lock);
Richard Purdie599a52d2007-02-10 23:07:48 +0000242 mutex_init(&new_bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Richard Purdie655bfd72007-07-09 12:17:24 +0100244 new_bd->dev.class = backlight_class;
245 new_bd->dev.parent = parent;
246 new_bd->dev.release = bl_device_release;
Kay Sievers64dba9a2009-01-06 10:44:35 -0800247 dev_set_name(&new_bd->dev, name);
Richard Purdie655bfd72007-07-09 12:17:24 +0100248 dev_set_drvdata(&new_bd->dev, devdata);
249
250 rc = device_register(&new_bd->dev);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000251 if (rc) {
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000252 kfree(new_bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 return ERR_PTR(rc);
254 }
255
James Simmons3d5eead2006-12-08 02:40:47 -0800256 rc = backlight_register_fb(new_bd);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000257 if (rc) {
Richard Purdie655bfd72007-07-09 12:17:24 +0100258 device_unregister(&new_bd->dev);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000259 return ERR_PTR(rc);
260 }
261
Richard Purdie655bfd72007-07-09 12:17:24 +0100262 new_bd->ops = ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Richard Purdie321709c2007-02-10 15:04:08 +0000264#ifdef CONFIG_PMAC_BACKLIGHT
265 mutex_lock(&pmac_backlight_mutex);
266 if (!pmac_backlight)
267 pmac_backlight = new_bd;
268 mutex_unlock(&pmac_backlight_mutex);
269#endif
270
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return new_bd;
272}
273EXPORT_SYMBOL(backlight_device_register);
274
275/**
276 * backlight_device_unregister - unregisters a backlight device object.
277 * @bd: the backlight device object to be unregistered and freed.
278 *
279 * Unregisters a previously registered via backlight_device_register object.
280 */
281void backlight_device_unregister(struct backlight_device *bd)
282{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 if (!bd)
284 return;
285
Richard Purdie321709c2007-02-10 15:04:08 +0000286#ifdef CONFIG_PMAC_BACKLIGHT
287 mutex_lock(&pmac_backlight_mutex);
288 if (pmac_backlight == bd)
289 pmac_backlight = NULL;
290 mutex_unlock(&pmac_backlight_mutex);
291#endif
Richard Purdie599a52d2007-02-10 23:07:48 +0000292 mutex_lock(&bd->ops_lock);
293 bd->ops = NULL;
294 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
James Simmons3d5eead2006-12-08 02:40:47 -0800296 backlight_unregister_fb(bd);
Richard Purdie655bfd72007-07-09 12:17:24 +0100297 device_unregister(&bd->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298}
299EXPORT_SYMBOL(backlight_device_unregister);
300
301static void __exit backlight_class_exit(void)
302{
Richard Purdie655bfd72007-07-09 12:17:24 +0100303 class_destroy(backlight_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304}
305
306static int __init backlight_class_init(void)
307{
Richard Purdie655bfd72007-07-09 12:17:24 +0100308 backlight_class = class_create(THIS_MODULE, "backlight");
309 if (IS_ERR(backlight_class)) {
310 printk(KERN_WARNING "Unable to create backlight class; errno = %ld\n",
311 PTR_ERR(backlight_class));
312 return PTR_ERR(backlight_class);
313 }
314
315 backlight_class->dev_attrs = bl_device_attributes;
Richard Purdiec835ee72009-01-06 21:00:19 +0000316 backlight_class->suspend = backlight_suspend;
317 backlight_class->resume = backlight_resume;
Richard Purdie655bfd72007-07-09 12:17:24 +0100318 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319}
320
321/*
322 * if this is compiled into the kernel, we need to ensure that the
323 * class is registered before users of the class try to register lcd's
324 */
325postcore_initcall(backlight_class_init);
326module_exit(backlight_class_exit);
327
328MODULE_LICENSE("GPL");
329MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
330MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");