blob: c65e81ff3578fedb1ff1e00bde752f252f77a8e0 [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 Purdie28ee0862007-02-08 22:25:09 +000043 backlight_update_status(bd);
James Simmons3d5eead2006-12-08 02:40:47 -080044 }
Richard Purdie599a52d2007-02-10 23:07:48 +000045 mutex_unlock(&bd->ops_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{
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 struct backlight_device *bd = to_backlight_device(cdev);
75
Richard Purdie599a52d2007-02-10 23:07:48 +000076 return sprintf(buf, "%d\n", bd->props.power);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077}
78
79static ssize_t backlight_store_power(struct class_device *cdev, const char *buf, size_t count)
80{
Richard Purdie68673af2006-05-15 09:44:15 -070081 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 char *endp;
83 struct backlight_device *bd = to_backlight_device(cdev);
Richard Purdie68673af2006-05-15 09:44:15 -070084 int power = simple_strtoul(buf, &endp, 0);
85 size_t size = endp - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Richard Purdie68673af2006-05-15 09:44:15 -070087 if (*endp && isspace(*endp))
88 size++;
89 if (size != count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 return -EINVAL;
91
Richard Purdie599a52d2007-02-10 23:07:48 +000092 mutex_lock(&bd->ops_lock);
93 if (bd->ops) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 pr_debug("backlight: set power to %d\n", power);
Richard Purdie599a52d2007-02-10 23:07:48 +000095 bd->props.power = power;
Richard Purdie28ee0862007-02-08 22:25:09 +000096 backlight_update_status(bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 rc = count;
Richard Purdie6ca01762006-03-31 02:31:49 -080098 }
Richard Purdie599a52d2007-02-10 23:07:48 +000099 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101 return rc;
102}
103
104static ssize_t backlight_show_brightness(struct class_device *cdev, char *buf)
105{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 struct backlight_device *bd = to_backlight_device(cdev);
107
Richard Purdie599a52d2007-02-10 23:07:48 +0000108 return sprintf(buf, "%d\n", bd->props.brightness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
110
111static ssize_t backlight_store_brightness(struct class_device *cdev, const char *buf, size_t count)
112{
Richard Purdie68673af2006-05-15 09:44:15 -0700113 int rc = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 char *endp;
115 struct backlight_device *bd = to_backlight_device(cdev);
Richard Purdie68673af2006-05-15 09:44:15 -0700116 int brightness = simple_strtoul(buf, &endp, 0);
117 size_t size = endp - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Richard Purdie68673af2006-05-15 09:44:15 -0700119 if (*endp && isspace(*endp))
120 size++;
121 if (size != count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 return -EINVAL;
123
Richard Purdie599a52d2007-02-10 23:07:48 +0000124 mutex_lock(&bd->ops_lock);
125 if (bd->ops) {
126 if (brightness > bd->props.max_brightness)
Richard Purdie6ca01762006-03-31 02:31:49 -0800127 rc = -EINVAL;
128 else {
129 pr_debug("backlight: set brightness to %d\n",
130 brightness);
Richard Purdie599a52d2007-02-10 23:07:48 +0000131 bd->props.brightness = brightness;
Richard Purdie28ee0862007-02-08 22:25:09 +0000132 backlight_update_status(bd);
Richard Purdie6ca01762006-03-31 02:31:49 -0800133 rc = count;
134 }
135 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000136 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 return rc;
139}
140
141static ssize_t backlight_show_max_brightness(struct class_device *cdev, char *buf)
142{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct backlight_device *bd = to_backlight_device(cdev);
144
Richard Purdie599a52d2007-02-10 23:07:48 +0000145 return sprintf(buf, "%d\n", bd->props.max_brightness);
Richard Purdie6ca01762006-03-31 02:31:49 -0800146}
147
148static ssize_t backlight_show_actual_brightness(struct class_device *cdev,
149 char *buf)
150{
151 int rc = -ENXIO;
152 struct backlight_device *bd = to_backlight_device(cdev);
153
Richard Purdie599a52d2007-02-10 23:07:48 +0000154 mutex_lock(&bd->ops_lock);
155 if (bd->ops && bd->ops->get_brightness)
156 rc = sprintf(buf, "%d\n", bd->ops->get_brightness(bd));
157 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159 return rc;
160}
161
162static void backlight_class_release(struct class_device *dev)
163{
164 struct backlight_device *bd = to_backlight_device(dev);
165 kfree(bd);
166}
167
168static struct class backlight_class = {
169 .name = "backlight",
170 .release = backlight_class_release,
171};
172
173#define DECLARE_ATTR(_name,_mode,_show,_store) \
174{ \
175 .attr = { .name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \
176 .show = _show, \
177 .store = _store, \
178}
179
Helge Dellerd95159c2006-12-08 02:40:28 -0800180static const struct class_device_attribute bl_class_device_attributes[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 DECLARE_ATTR(power, 0644, backlight_show_power, backlight_store_power),
Richard Purdie6ca01762006-03-31 02:31:49 -0800182 DECLARE_ATTR(brightness, 0644, backlight_show_brightness,
183 backlight_store_brightness),
184 DECLARE_ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
185 NULL),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 DECLARE_ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
187};
188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/**
190 * backlight_device_register - create and register a new object of
191 * backlight_device class.
192 * @name: the name of the new object(must be the same as the name of the
193 * respective framebuffer device).
194 * @devdata: an optional pointer to be stored in the class_device. The
195 * methods may retrieve it by using class_get_devdata(&bd->class_dev).
Richard Purdie599a52d2007-02-10 23:07:48 +0000196 * @ops: the backlight operations structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 *
198 * Creates and registers new backlight class_device. Returns either an
199 * ERR_PTR() or a pointer to the newly allocated device.
200 */
Yu Luming519ab5f2006-12-19 12:56:15 -0800201struct backlight_device *backlight_device_register(const char *name,
202 struct device *dev,
203 void *devdata,
Richard Purdie599a52d2007-02-10 23:07:48 +0000204 struct backlight_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205{
206 int i, rc;
207 struct backlight_device *new_bd;
208
209 pr_debug("backlight_device_alloc: name=%s\n", name);
210
Richard Purdie599a52d2007-02-10 23:07:48 +0000211 new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000212 if (!new_bd)
Jean Delvare10ad1b72006-03-09 17:33:36 -0800213 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Richard Purdie28ee0862007-02-08 22:25:09 +0000215 mutex_init(&new_bd->update_lock);
Richard Purdie599a52d2007-02-10 23:07:48 +0000216 mutex_init(&new_bd->ops_lock);
217 new_bd->ops = ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 new_bd->class_dev.class = &backlight_class;
Yu Luming519ab5f2006-12-19 12:56:15 -0800219 new_bd->class_dev.dev = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 strlcpy(new_bd->class_dev.class_id, name, KOBJ_NAME_LEN);
221 class_set_devdata(&new_bd->class_dev, devdata);
222
223 rc = class_device_register(&new_bd->class_dev);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000224 if (rc) {
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000225 kfree(new_bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 return ERR_PTR(rc);
227 }
228
James Simmons3d5eead2006-12-08 02:40:47 -0800229 rc = backlight_register_fb(new_bd);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000230 if (rc) {
231 class_device_unregister(&new_bd->class_dev);
232 return ERR_PTR(rc);
233 }
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236 for (i = 0; i < ARRAY_SIZE(bl_class_device_attributes); i++) {
237 rc = class_device_create_file(&new_bd->class_dev,
238 &bl_class_device_attributes[i]);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000239 if (rc) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 while (--i >= 0)
241 class_device_remove_file(&new_bd->class_dev,
242 &bl_class_device_attributes[i]);
243 class_device_unregister(&new_bd->class_dev);
244 /* No need to kfree(new_bd) since release() method was called */
245 return ERR_PTR(rc);
246 }
247 }
248
Richard Purdie321709c2007-02-10 15:04:08 +0000249#ifdef CONFIG_PMAC_BACKLIGHT
250 mutex_lock(&pmac_backlight_mutex);
251 if (!pmac_backlight)
252 pmac_backlight = new_bd;
253 mutex_unlock(&pmac_backlight_mutex);
254#endif
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 return new_bd;
257}
258EXPORT_SYMBOL(backlight_device_register);
259
260/**
261 * backlight_device_unregister - unregisters a backlight device object.
262 * @bd: the backlight device object to be unregistered and freed.
263 *
264 * Unregisters a previously registered via backlight_device_register object.
265 */
266void backlight_device_unregister(struct backlight_device *bd)
267{
268 int i;
269
270 if (!bd)
271 return;
272
273 pr_debug("backlight_device_unregister: name=%s\n", bd->class_dev.class_id);
274
Richard Purdie321709c2007-02-10 15:04:08 +0000275#ifdef CONFIG_PMAC_BACKLIGHT
276 mutex_lock(&pmac_backlight_mutex);
277 if (pmac_backlight == bd)
278 pmac_backlight = NULL;
279 mutex_unlock(&pmac_backlight_mutex);
280#endif
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 for (i = 0; i < ARRAY_SIZE(bl_class_device_attributes); i++)
283 class_device_remove_file(&bd->class_dev,
284 &bl_class_device_attributes[i]);
285
Richard Purdie599a52d2007-02-10 23:07:48 +0000286 mutex_lock(&bd->ops_lock);
287 bd->ops = NULL;
288 mutex_unlock(&bd->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
James Simmons3d5eead2006-12-08 02:40:47 -0800290 backlight_unregister_fb(bd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 class_device_unregister(&bd->class_dev);
293}
294EXPORT_SYMBOL(backlight_device_unregister);
295
296static void __exit backlight_class_exit(void)
297{
298 class_unregister(&backlight_class);
299}
300
301static int __init backlight_class_init(void)
302{
303 return class_register(&backlight_class);
304}
305
306/*
307 * if this is compiled into the kernel, we need to ensure that the
308 * class is registered before users of the class try to register lcd's
309 */
310postcore_initcall(backlight_class_init);
311module_exit(backlight_class_exit);
312
313MODULE_LICENSE("GPL");
314MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
315MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");