2 * Backlight Lowlevel Control Abstraction
4 * Copyright (C) 2003,2004 Hewlett-Packard Company
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/device.h>
13 #include <linux/backlight.h>
14 #include <linux/notifier.h>
15 #include <linux/ctype.h>
16 #include <linux/err.h>
18 #include <linux/slab.h>
20 #ifdef CONFIG_PMAC_BACKLIGHT
21 #include <asm/backlight.h>
24 static struct list_head backlight_dev_list
;
25 static struct mutex backlight_dev_list_mutex
;
26 static struct blocking_notifier_head backlight_notifier
;
28 static const char *const backlight_types
[] = {
29 [BACKLIGHT_RAW
] = "raw",
30 [BACKLIGHT_PLATFORM
] = "platform",
31 [BACKLIGHT_FIRMWARE
] = "firmware",
34 #if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
35 defined(CONFIG_BACKLIGHT_CLASS_DEVICE_MODULE))
36 /* This callback gets called when something important happens inside a
37 * framebuffer driver. We're looking if that important event is blanking,
38 * and if it is and necessary, we're switching backlight power as well ...
40 static int fb_notifier_callback(struct notifier_block
*self
,
41 unsigned long event
, void *data
)
43 struct backlight_device
*bd
;
44 struct fb_event
*evdata
= data
;
45 int node
= evdata
->info
->node
;
48 /* If we aren't interested in this event, skip it immediately ... */
49 if (event
!= FB_EVENT_BLANK
&& event
!= FB_EVENT_CONBLANK
)
52 bd
= container_of(self
, struct backlight_device
, fb_notif
);
53 mutex_lock(&bd
->ops_lock
);
55 if (!bd
->ops
->check_fb
||
56 bd
->ops
->check_fb(bd
, evdata
->info
)) {
57 fb_blank
= *(int *)evdata
->data
;
58 if (fb_blank
== FB_BLANK_UNBLANK
&&
59 !bd
->fb_bl_on
[node
]) {
60 bd
->fb_bl_on
[node
] = true;
61 if (!bd
->use_count
++) {
62 bd
->props
.state
&= ~BL_CORE_FBBLANK
;
63 bd
->props
.fb_blank
= FB_BLANK_UNBLANK
;
64 backlight_update_status(bd
);
66 } else if (fb_blank
!= FB_BLANK_UNBLANK
&&
68 bd
->fb_bl_on
[node
] = false;
69 if (!(--bd
->use_count
)) {
70 bd
->props
.state
|= BL_CORE_FBBLANK
;
71 bd
->props
.fb_blank
= fb_blank
;
72 backlight_update_status(bd
);
76 mutex_unlock(&bd
->ops_lock
);
80 static int backlight_register_fb(struct backlight_device
*bd
)
82 memset(&bd
->fb_notif
, 0, sizeof(bd
->fb_notif
));
83 bd
->fb_notif
.notifier_call
= fb_notifier_callback
;
85 return fb_register_client(&bd
->fb_notif
);
88 static void backlight_unregister_fb(struct backlight_device
*bd
)
90 fb_unregister_client(&bd
->fb_notif
);
93 static inline int backlight_register_fb(struct backlight_device
*bd
)
98 static inline void backlight_unregister_fb(struct backlight_device
*bd
)
101 #endif /* CONFIG_FB */
103 static void backlight_generate_event(struct backlight_device
*bd
,
104 enum backlight_update_reason reason
)
109 case BACKLIGHT_UPDATE_SYSFS
:
110 envp
[0] = "SOURCE=sysfs";
112 case BACKLIGHT_UPDATE_HOTKEY
:
113 envp
[0] = "SOURCE=hotkey";
116 envp
[0] = "SOURCE=unknown";
120 kobject_uevent_env(&bd
->dev
.kobj
, KOBJ_CHANGE
, envp
);
121 sysfs_notify(&bd
->dev
.kobj
, NULL
, "actual_brightness");
124 static ssize_t
bl_power_show(struct device
*dev
, struct device_attribute
*attr
,
127 struct backlight_device
*bd
= to_backlight_device(dev
);
129 return sprintf(buf
, "%d\n", bd
->props
.power
);
132 static ssize_t
bl_power_store(struct device
*dev
, struct device_attribute
*attr
,
133 const char *buf
, size_t count
)
136 struct backlight_device
*bd
= to_backlight_device(dev
);
139 rc
= kstrtoul(buf
, 0, &power
);
144 mutex_lock(&bd
->ops_lock
);
146 pr_debug("set power to %lu\n", power
);
147 if (bd
->props
.power
!= power
) {
148 bd
->props
.power
= power
;
149 backlight_update_status(bd
);
153 mutex_unlock(&bd
->ops_lock
);
157 static DEVICE_ATTR_RW(bl_power
);
159 static ssize_t
brightness_show(struct device
*dev
,
160 struct device_attribute
*attr
, char *buf
)
162 struct backlight_device
*bd
= to_backlight_device(dev
);
164 return sprintf(buf
, "%d\n", bd
->props
.brightness
);
167 int backlight_device_set_brightness(struct backlight_device
*bd
,
168 unsigned long brightness
)
172 mutex_lock(&bd
->ops_lock
);
174 if (brightness
> bd
->props
.max_brightness
)
177 pr_debug("set brightness to %lu\n", brightness
);
178 bd
->props
.brightness
= brightness
;
179 backlight_update_status(bd
);
183 mutex_unlock(&bd
->ops_lock
);
185 backlight_generate_event(bd
, BACKLIGHT_UPDATE_SYSFS
);
189 EXPORT_SYMBOL(backlight_device_set_brightness
);
191 static ssize_t
brightness_store(struct device
*dev
,
192 struct device_attribute
*attr
, const char *buf
, size_t count
)
195 struct backlight_device
*bd
= to_backlight_device(dev
);
196 unsigned long brightness
;
198 rc
= kstrtoul(buf
, 0, &brightness
);
202 rc
= backlight_device_set_brightness(bd
, brightness
);
204 return rc
? rc
: count
;
206 static DEVICE_ATTR_RW(brightness
);
208 static ssize_t
type_show(struct device
*dev
, struct device_attribute
*attr
,
211 struct backlight_device
*bd
= to_backlight_device(dev
);
213 return sprintf(buf
, "%s\n", backlight_types
[bd
->props
.type
]);
215 static DEVICE_ATTR_RO(type
);
217 static ssize_t
max_brightness_show(struct device
*dev
,
218 struct device_attribute
*attr
, char *buf
)
220 struct backlight_device
*bd
= to_backlight_device(dev
);
222 return sprintf(buf
, "%d\n", bd
->props
.max_brightness
);
224 static DEVICE_ATTR_RO(max_brightness
);
226 static ssize_t
actual_brightness_show(struct device
*dev
,
227 struct device_attribute
*attr
, char *buf
)
230 struct backlight_device
*bd
= to_backlight_device(dev
);
232 mutex_lock(&bd
->ops_lock
);
233 if (bd
->ops
&& bd
->ops
->get_brightness
)
234 rc
= sprintf(buf
, "%d\n", bd
->ops
->get_brightness(bd
));
236 rc
= sprintf(buf
, "%d\n", bd
->props
.brightness
);
237 mutex_unlock(&bd
->ops_lock
);
241 static DEVICE_ATTR_RO(actual_brightness
);
243 static struct class *backlight_class
;
245 #ifdef CONFIG_PM_SLEEP
246 static int backlight_suspend(struct device
*dev
)
248 struct backlight_device
*bd
= to_backlight_device(dev
);
250 mutex_lock(&bd
->ops_lock
);
251 if (bd
->ops
&& bd
->ops
->options
& BL_CORE_SUSPENDRESUME
) {
252 bd
->props
.state
|= BL_CORE_SUSPENDED
;
253 backlight_update_status(bd
);
255 mutex_unlock(&bd
->ops_lock
);
260 static int backlight_resume(struct device
*dev
)
262 struct backlight_device
*bd
= to_backlight_device(dev
);
264 mutex_lock(&bd
->ops_lock
);
265 if (bd
->ops
&& bd
->ops
->options
& BL_CORE_SUSPENDRESUME
) {
266 bd
->props
.state
&= ~BL_CORE_SUSPENDED
;
267 backlight_update_status(bd
);
269 mutex_unlock(&bd
->ops_lock
);
275 static SIMPLE_DEV_PM_OPS(backlight_class_dev_pm_ops
, backlight_suspend
,
278 static void bl_device_release(struct device
*dev
)
280 struct backlight_device
*bd
= to_backlight_device(dev
);
284 static struct attribute
*bl_device_attrs
[] = {
285 &dev_attr_bl_power
.attr
,
286 &dev_attr_brightness
.attr
,
287 &dev_attr_actual_brightness
.attr
,
288 &dev_attr_max_brightness
.attr
,
292 ATTRIBUTE_GROUPS(bl_device
);
295 * backlight_force_update - tell the backlight subsystem that hardware state
297 * @bd: the backlight device to update
299 * Updates the internal state of the backlight in response to a hardware event,
300 * and generate a uevent to notify userspace
302 void backlight_force_update(struct backlight_device
*bd
,
303 enum backlight_update_reason reason
)
305 mutex_lock(&bd
->ops_lock
);
306 if (bd
->ops
&& bd
->ops
->get_brightness
)
307 bd
->props
.brightness
= bd
->ops
->get_brightness(bd
);
308 mutex_unlock(&bd
->ops_lock
);
309 backlight_generate_event(bd
, reason
);
311 EXPORT_SYMBOL(backlight_force_update
);
314 * backlight_device_register - create and register a new object of
315 * backlight_device class.
316 * @name: the name of the new object(must be the same as the name of the
317 * respective framebuffer device).
318 * @parent: a pointer to the parent device
319 * @devdata: an optional pointer to be stored for private driver use. The
320 * methods may retrieve it by using bl_get_data(bd).
321 * @ops: the backlight operations structure.
323 * Creates and registers new backlight device. Returns either an
324 * ERR_PTR() or a pointer to the newly allocated device.
326 struct backlight_device
*backlight_device_register(const char *name
,
327 struct device
*parent
, void *devdata
, const struct backlight_ops
*ops
,
328 const struct backlight_properties
*props
)
330 struct backlight_device
*new_bd
;
333 pr_debug("backlight_device_register: name=%s\n", name
);
335 new_bd
= kzalloc(sizeof(struct backlight_device
), GFP_KERNEL
);
337 return ERR_PTR(-ENOMEM
);
339 mutex_init(&new_bd
->update_lock
);
340 mutex_init(&new_bd
->ops_lock
);
342 new_bd
->dev
.class = backlight_class
;
343 new_bd
->dev
.parent
= parent
;
344 new_bd
->dev
.release
= bl_device_release
;
345 dev_set_name(&new_bd
->dev
, "%s", name
);
346 dev_set_drvdata(&new_bd
->dev
, devdata
);
348 /* Set default properties */
350 memcpy(&new_bd
->props
, props
,
351 sizeof(struct backlight_properties
));
352 if (props
->type
<= 0 || props
->type
>= BACKLIGHT_TYPE_MAX
) {
353 WARN(1, "%s: invalid backlight type", name
);
354 new_bd
->props
.type
= BACKLIGHT_RAW
;
357 new_bd
->props
.type
= BACKLIGHT_RAW
;
360 rc
= device_register(&new_bd
->dev
);
362 put_device(&new_bd
->dev
);
366 rc
= backlight_register_fb(new_bd
);
368 device_unregister(&new_bd
->dev
);
374 #ifdef CONFIG_PMAC_BACKLIGHT
375 mutex_lock(&pmac_backlight_mutex
);
377 pmac_backlight
= new_bd
;
378 mutex_unlock(&pmac_backlight_mutex
);
381 mutex_lock(&backlight_dev_list_mutex
);
382 list_add(&new_bd
->entry
, &backlight_dev_list
);
383 mutex_unlock(&backlight_dev_list_mutex
);
385 blocking_notifier_call_chain(&backlight_notifier
,
386 BACKLIGHT_REGISTERED
, new_bd
);
390 EXPORT_SYMBOL(backlight_device_register
);
392 struct backlight_device
*backlight_device_get_by_type(enum backlight_type type
)
395 struct backlight_device
*bd
;
397 mutex_lock(&backlight_dev_list_mutex
);
398 list_for_each_entry(bd
, &backlight_dev_list
, entry
) {
399 if (bd
->props
.type
== type
) {
404 mutex_unlock(&backlight_dev_list_mutex
);
406 return found
? bd
: NULL
;
408 EXPORT_SYMBOL(backlight_device_get_by_type
);
411 * backlight_device_unregister - unregisters a backlight device object.
412 * @bd: the backlight device object to be unregistered and freed.
414 * Unregisters a previously registered via backlight_device_register object.
416 void backlight_device_unregister(struct backlight_device
*bd
)
421 mutex_lock(&backlight_dev_list_mutex
);
422 list_del(&bd
->entry
);
423 mutex_unlock(&backlight_dev_list_mutex
);
425 #ifdef CONFIG_PMAC_BACKLIGHT
426 mutex_lock(&pmac_backlight_mutex
);
427 if (pmac_backlight
== bd
)
428 pmac_backlight
= NULL
;
429 mutex_unlock(&pmac_backlight_mutex
);
432 blocking_notifier_call_chain(&backlight_notifier
,
433 BACKLIGHT_UNREGISTERED
, bd
);
435 mutex_lock(&bd
->ops_lock
);
437 mutex_unlock(&bd
->ops_lock
);
439 backlight_unregister_fb(bd
);
440 device_unregister(&bd
->dev
);
442 EXPORT_SYMBOL(backlight_device_unregister
);
444 static void devm_backlight_device_release(struct device
*dev
, void *res
)
446 struct backlight_device
*backlight
= *(struct backlight_device
**)res
;
448 backlight_device_unregister(backlight
);
451 static int devm_backlight_device_match(struct device
*dev
, void *res
,
454 struct backlight_device
**r
= res
;
460 * backlight_register_notifier - get notified of backlight (un)registration
461 * @nb: notifier block with the notifier to call on backlight (un)registration
463 * @return 0 on success, otherwise a negative error code
465 * Register a notifier to get notified when backlight devices get registered
468 int backlight_register_notifier(struct notifier_block
*nb
)
470 return blocking_notifier_chain_register(&backlight_notifier
, nb
);
472 EXPORT_SYMBOL(backlight_register_notifier
);
475 * backlight_unregister_notifier - unregister a backlight notifier
476 * @nb: notifier block to unregister
478 * @return 0 on success, otherwise a negative error code
480 * Register a notifier to get notified when backlight devices get registered
483 int backlight_unregister_notifier(struct notifier_block
*nb
)
485 return blocking_notifier_chain_unregister(&backlight_notifier
, nb
);
487 EXPORT_SYMBOL(backlight_unregister_notifier
);
490 * devm_backlight_device_register - resource managed backlight_device_register()
491 * @dev: the device to register
492 * @name: the name of the device
493 * @parent: a pointer to the parent device
494 * @devdata: an optional pointer to be stored for private driver use
495 * @ops: the backlight operations structure
496 * @props: the backlight properties
498 * @return a struct backlight on success, or an ERR_PTR on error
500 * Managed backlight_device_register(). The backlight_device returned
501 * from this function are automatically freed on driver detach.
502 * See backlight_device_register() for more information.
504 struct backlight_device
*devm_backlight_device_register(struct device
*dev
,
505 const char *name
, struct device
*parent
, void *devdata
,
506 const struct backlight_ops
*ops
,
507 const struct backlight_properties
*props
)
509 struct backlight_device
**ptr
, *backlight
;
511 ptr
= devres_alloc(devm_backlight_device_release
, sizeof(*ptr
),
514 return ERR_PTR(-ENOMEM
);
516 backlight
= backlight_device_register(name
, parent
, devdata
, ops
,
518 if (!IS_ERR(backlight
)) {
520 devres_add(dev
, ptr
);
527 EXPORT_SYMBOL(devm_backlight_device_register
);
530 * devm_backlight_device_unregister - resource managed backlight_device_unregister()
531 * @dev: the device to unregister
532 * @bd: the backlight device to unregister
534 * Deallocated a backlight allocated with devm_backlight_device_register().
535 * Normally this function will not need to be called and the resource management
536 * code will ensure that the resource is freed.
538 void devm_backlight_device_unregister(struct device
*dev
,
539 struct backlight_device
*bd
)
543 rc
= devres_release(dev
, devm_backlight_device_release
,
544 devm_backlight_device_match
, bd
);
547 EXPORT_SYMBOL(devm_backlight_device_unregister
);
550 static int of_parent_match(struct device
*dev
, const void *data
)
552 return dev
->parent
&& dev
->parent
->of_node
== data
;
556 * of_find_backlight_by_node() - find backlight device by device-tree node
557 * @node: device-tree node of the backlight device
559 * Returns a pointer to the backlight device corresponding to the given DT
560 * node or NULL if no such backlight device exists or if the device hasn't
563 * This function obtains a reference on the backlight device and it is the
564 * caller's responsibility to drop the reference by calling put_device() on
565 * the backlight device's .dev field.
567 struct backlight_device
*of_find_backlight_by_node(struct device_node
*node
)
571 dev
= class_find_device(backlight_class
, NULL
, node
, of_parent_match
);
573 return dev
? to_backlight_device(dev
) : NULL
;
575 EXPORT_SYMBOL(of_find_backlight_by_node
);
578 static void __exit
backlight_class_exit(void)
580 class_destroy(backlight_class
);
583 static int __init
backlight_class_init(void)
585 backlight_class
= class_create(THIS_MODULE
, "backlight");
586 if (IS_ERR(backlight_class
)) {
587 pr_warn("Unable to create backlight class; errno = %ld\n",
588 PTR_ERR(backlight_class
));
589 return PTR_ERR(backlight_class
);
592 backlight_class
->dev_groups
= bl_device_groups
;
593 backlight_class
->pm
= &backlight_class_dev_pm_ops
;
594 INIT_LIST_HEAD(&backlight_dev_list
);
595 mutex_init(&backlight_dev_list_mutex
);
596 BLOCKING_INIT_NOTIFIER_HEAD(&backlight_notifier
);
602 * if this is compiled into the kernel, we need to ensure that the
603 * class is registered before users of the class try to register lcd's
605 postcore_initcall(backlight_class_init
);
606 module_exit(backlight_class_exit
);
608 MODULE_LICENSE("GPL");
609 MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
610 MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");