Merge tag 'sound-4.17-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[linux-2.6-microblaze.git] / drivers / video / backlight / backlight.c
1 /*
2  * Backlight Lowlevel Control Abstraction
3  *
4  * Copyright (C) 2003,2004 Hewlett-Packard Company
5  *
6  */
7
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9
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>
17 #include <linux/fb.h>
18 #include <linux/slab.h>
19
20 #ifdef CONFIG_PMAC_BACKLIGHT
21 #include <asm/backlight.h>
22 #endif
23
24 static struct list_head backlight_dev_list;
25 static struct mutex backlight_dev_list_mutex;
26 static struct blocking_notifier_head backlight_notifier;
27
28 static const char *const backlight_types[] = {
29         [BACKLIGHT_RAW] = "raw",
30         [BACKLIGHT_PLATFORM] = "platform",
31         [BACKLIGHT_FIRMWARE] = "firmware",
32 };
33
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 ...
39  */
40 static int fb_notifier_callback(struct notifier_block *self,
41                                 unsigned long event, void *data)
42 {
43         struct backlight_device *bd;
44         struct fb_event *evdata = data;
45         int node = evdata->info->node;
46         int fb_blank = 0;
47
48         /* If we aren't interested in this event, skip it immediately ... */
49         if (event != FB_EVENT_BLANK && event != FB_EVENT_CONBLANK)
50                 return 0;
51
52         bd = container_of(self, struct backlight_device, fb_notif);
53         mutex_lock(&bd->ops_lock);
54         if (bd->ops)
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);
65                                 }
66                         } else if (fb_blank != FB_BLANK_UNBLANK &&
67                                    bd->fb_bl_on[node]) {
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);
73                                 }
74                         }
75                 }
76         mutex_unlock(&bd->ops_lock);
77         return 0;
78 }
79
80 static int backlight_register_fb(struct backlight_device *bd)
81 {
82         memset(&bd->fb_notif, 0, sizeof(bd->fb_notif));
83         bd->fb_notif.notifier_call = fb_notifier_callback;
84
85         return fb_register_client(&bd->fb_notif);
86 }
87
88 static void backlight_unregister_fb(struct backlight_device *bd)
89 {
90         fb_unregister_client(&bd->fb_notif);
91 }
92 #else
93 static inline int backlight_register_fb(struct backlight_device *bd)
94 {
95         return 0;
96 }
97
98 static inline void backlight_unregister_fb(struct backlight_device *bd)
99 {
100 }
101 #endif /* CONFIG_FB */
102
103 static void backlight_generate_event(struct backlight_device *bd,
104                                      enum backlight_update_reason reason)
105 {
106         char *envp[2];
107
108         switch (reason) {
109         case BACKLIGHT_UPDATE_SYSFS:
110                 envp[0] = "SOURCE=sysfs";
111                 break;
112         case BACKLIGHT_UPDATE_HOTKEY:
113                 envp[0] = "SOURCE=hotkey";
114                 break;
115         default:
116                 envp[0] = "SOURCE=unknown";
117                 break;
118         }
119         envp[1] = NULL;
120         kobject_uevent_env(&bd->dev.kobj, KOBJ_CHANGE, envp);
121         sysfs_notify(&bd->dev.kobj, NULL, "actual_brightness");
122 }
123
124 static ssize_t bl_power_show(struct device *dev, struct device_attribute *attr,
125                 char *buf)
126 {
127         struct backlight_device *bd = to_backlight_device(dev);
128
129         return sprintf(buf, "%d\n", bd->props.power);
130 }
131
132 static ssize_t bl_power_store(struct device *dev, struct device_attribute *attr,
133                 const char *buf, size_t count)
134 {
135         int rc;
136         struct backlight_device *bd = to_backlight_device(dev);
137         unsigned long power, old_power;
138
139         rc = kstrtoul(buf, 0, &power);
140         if (rc)
141                 return rc;
142
143         rc = -ENXIO;
144         mutex_lock(&bd->ops_lock);
145         if (bd->ops) {
146                 pr_debug("set power to %lu\n", power);
147                 if (bd->props.power != power) {
148                         old_power = bd->props.power;
149                         bd->props.power = power;
150                         rc = backlight_update_status(bd);
151                         if (rc)
152                                 bd->props.power = old_power;
153                         else
154                                 rc = count;
155                 } else {
156                         rc = count;
157                 }
158         }
159         mutex_unlock(&bd->ops_lock);
160
161         return rc;
162 }
163 static DEVICE_ATTR_RW(bl_power);
164
165 static ssize_t brightness_show(struct device *dev,
166                 struct device_attribute *attr, char *buf)
167 {
168         struct backlight_device *bd = to_backlight_device(dev);
169
170         return sprintf(buf, "%d\n", bd->props.brightness);
171 }
172
173 int backlight_device_set_brightness(struct backlight_device *bd,
174                                     unsigned long brightness)
175 {
176         int rc = -ENXIO;
177
178         mutex_lock(&bd->ops_lock);
179         if (bd->ops) {
180                 if (brightness > bd->props.max_brightness)
181                         rc = -EINVAL;
182                 else {
183                         pr_debug("set brightness to %lu\n", brightness);
184                         bd->props.brightness = brightness;
185                         rc = backlight_update_status(bd);
186                 }
187         }
188         mutex_unlock(&bd->ops_lock);
189
190         backlight_generate_event(bd, BACKLIGHT_UPDATE_SYSFS);
191
192         return rc;
193 }
194 EXPORT_SYMBOL(backlight_device_set_brightness);
195
196 static ssize_t brightness_store(struct device *dev,
197                 struct device_attribute *attr, const char *buf, size_t count)
198 {
199         int rc;
200         struct backlight_device *bd = to_backlight_device(dev);
201         unsigned long brightness;
202
203         rc = kstrtoul(buf, 0, &brightness);
204         if (rc)
205                 return rc;
206
207         rc = backlight_device_set_brightness(bd, brightness);
208
209         return rc ? rc : count;
210 }
211 static DEVICE_ATTR_RW(brightness);
212
213 static ssize_t type_show(struct device *dev, struct device_attribute *attr,
214                 char *buf)
215 {
216         struct backlight_device *bd = to_backlight_device(dev);
217
218         return sprintf(buf, "%s\n", backlight_types[bd->props.type]);
219 }
220 static DEVICE_ATTR_RO(type);
221
222 static ssize_t max_brightness_show(struct device *dev,
223                 struct device_attribute *attr, char *buf)
224 {
225         struct backlight_device *bd = to_backlight_device(dev);
226
227         return sprintf(buf, "%d\n", bd->props.max_brightness);
228 }
229 static DEVICE_ATTR_RO(max_brightness);
230
231 static ssize_t actual_brightness_show(struct device *dev,
232                 struct device_attribute *attr, char *buf)
233 {
234         int rc = -ENXIO;
235         struct backlight_device *bd = to_backlight_device(dev);
236
237         mutex_lock(&bd->ops_lock);
238         if (bd->ops && bd->ops->get_brightness)
239                 rc = sprintf(buf, "%d\n", bd->ops->get_brightness(bd));
240         else
241                 rc = sprintf(buf, "%d\n", bd->props.brightness);
242         mutex_unlock(&bd->ops_lock);
243
244         return rc;
245 }
246 static DEVICE_ATTR_RO(actual_brightness);
247
248 static struct class *backlight_class;
249
250 #ifdef CONFIG_PM_SLEEP
251 static int backlight_suspend(struct device *dev)
252 {
253         struct backlight_device *bd = to_backlight_device(dev);
254
255         mutex_lock(&bd->ops_lock);
256         if (bd->ops && bd->ops->options & BL_CORE_SUSPENDRESUME) {
257                 bd->props.state |= BL_CORE_SUSPENDED;
258                 backlight_update_status(bd);
259         }
260         mutex_unlock(&bd->ops_lock);
261
262         return 0;
263 }
264
265 static int backlight_resume(struct device *dev)
266 {
267         struct backlight_device *bd = to_backlight_device(dev);
268
269         mutex_lock(&bd->ops_lock);
270         if (bd->ops && bd->ops->options & BL_CORE_SUSPENDRESUME) {
271                 bd->props.state &= ~BL_CORE_SUSPENDED;
272                 backlight_update_status(bd);
273         }
274         mutex_unlock(&bd->ops_lock);
275
276         return 0;
277 }
278 #endif
279
280 static SIMPLE_DEV_PM_OPS(backlight_class_dev_pm_ops, backlight_suspend,
281                          backlight_resume);
282
283 static void bl_device_release(struct device *dev)
284 {
285         struct backlight_device *bd = to_backlight_device(dev);
286         kfree(bd);
287 }
288
289 static struct attribute *bl_device_attrs[] = {
290         &dev_attr_bl_power.attr,
291         &dev_attr_brightness.attr,
292         &dev_attr_actual_brightness.attr,
293         &dev_attr_max_brightness.attr,
294         &dev_attr_type.attr,
295         NULL,
296 };
297 ATTRIBUTE_GROUPS(bl_device);
298
299 /**
300  * backlight_force_update - tell the backlight subsystem that hardware state
301  *   has changed
302  * @bd: the backlight device to update
303  *
304  * Updates the internal state of the backlight in response to a hardware event,
305  * and generate a uevent to notify userspace
306  */
307 void backlight_force_update(struct backlight_device *bd,
308                             enum backlight_update_reason reason)
309 {
310         mutex_lock(&bd->ops_lock);
311         if (bd->ops && bd->ops->get_brightness)
312                 bd->props.brightness = bd->ops->get_brightness(bd);
313         mutex_unlock(&bd->ops_lock);
314         backlight_generate_event(bd, reason);
315 }
316 EXPORT_SYMBOL(backlight_force_update);
317
318 /**
319  * backlight_device_register - create and register a new object of
320  *   backlight_device class.
321  * @name: the name of the new object(must be the same as the name of the
322  *   respective framebuffer device).
323  * @parent: a pointer to the parent device
324  * @devdata: an optional pointer to be stored for private driver use. The
325  *   methods may retrieve it by using bl_get_data(bd).
326  * @ops: the backlight operations structure.
327  *
328  * Creates and registers new backlight device. Returns either an
329  * ERR_PTR() or a pointer to the newly allocated device.
330  */
331 struct backlight_device *backlight_device_register(const char *name,
332         struct device *parent, void *devdata, const struct backlight_ops *ops,
333         const struct backlight_properties *props)
334 {
335         struct backlight_device *new_bd;
336         int rc;
337
338         pr_debug("backlight_device_register: name=%s\n", name);
339
340         new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
341         if (!new_bd)
342                 return ERR_PTR(-ENOMEM);
343
344         mutex_init(&new_bd->update_lock);
345         mutex_init(&new_bd->ops_lock);
346
347         new_bd->dev.class = backlight_class;
348         new_bd->dev.parent = parent;
349         new_bd->dev.release = bl_device_release;
350         dev_set_name(&new_bd->dev, "%s", name);
351         dev_set_drvdata(&new_bd->dev, devdata);
352
353         /* Set default properties */
354         if (props) {
355                 memcpy(&new_bd->props, props,
356                        sizeof(struct backlight_properties));
357                 if (props->type <= 0 || props->type >= BACKLIGHT_TYPE_MAX) {
358                         WARN(1, "%s: invalid backlight type", name);
359                         new_bd->props.type = BACKLIGHT_RAW;
360                 }
361         } else {
362                 new_bd->props.type = BACKLIGHT_RAW;
363         }
364
365         rc = device_register(&new_bd->dev);
366         if (rc) {
367                 put_device(&new_bd->dev);
368                 return ERR_PTR(rc);
369         }
370
371         rc = backlight_register_fb(new_bd);
372         if (rc) {
373                 device_unregister(&new_bd->dev);
374                 return ERR_PTR(rc);
375         }
376
377         new_bd->ops = ops;
378
379 #ifdef CONFIG_PMAC_BACKLIGHT
380         mutex_lock(&pmac_backlight_mutex);
381         if (!pmac_backlight)
382                 pmac_backlight = new_bd;
383         mutex_unlock(&pmac_backlight_mutex);
384 #endif
385
386         mutex_lock(&backlight_dev_list_mutex);
387         list_add(&new_bd->entry, &backlight_dev_list);
388         mutex_unlock(&backlight_dev_list_mutex);
389
390         blocking_notifier_call_chain(&backlight_notifier,
391                                      BACKLIGHT_REGISTERED, new_bd);
392
393         return new_bd;
394 }
395 EXPORT_SYMBOL(backlight_device_register);
396
397 struct backlight_device *backlight_device_get_by_type(enum backlight_type type)
398 {
399         bool found = false;
400         struct backlight_device *bd;
401
402         mutex_lock(&backlight_dev_list_mutex);
403         list_for_each_entry(bd, &backlight_dev_list, entry) {
404                 if (bd->props.type == type) {
405                         found = true;
406                         break;
407                 }
408         }
409         mutex_unlock(&backlight_dev_list_mutex);
410
411         return found ? bd : NULL;
412 }
413 EXPORT_SYMBOL(backlight_device_get_by_type);
414
415 /**
416  * backlight_device_unregister - unregisters a backlight device object.
417  * @bd: the backlight device object to be unregistered and freed.
418  *
419  * Unregisters a previously registered via backlight_device_register object.
420  */
421 void backlight_device_unregister(struct backlight_device *bd)
422 {
423         if (!bd)
424                 return;
425
426         mutex_lock(&backlight_dev_list_mutex);
427         list_del(&bd->entry);
428         mutex_unlock(&backlight_dev_list_mutex);
429
430 #ifdef CONFIG_PMAC_BACKLIGHT
431         mutex_lock(&pmac_backlight_mutex);
432         if (pmac_backlight == bd)
433                 pmac_backlight = NULL;
434         mutex_unlock(&pmac_backlight_mutex);
435 #endif
436
437         blocking_notifier_call_chain(&backlight_notifier,
438                                      BACKLIGHT_UNREGISTERED, bd);
439
440         mutex_lock(&bd->ops_lock);
441         bd->ops = NULL;
442         mutex_unlock(&bd->ops_lock);
443
444         backlight_unregister_fb(bd);
445         device_unregister(&bd->dev);
446 }
447 EXPORT_SYMBOL(backlight_device_unregister);
448
449 static void devm_backlight_device_release(struct device *dev, void *res)
450 {
451         struct backlight_device *backlight = *(struct backlight_device **)res;
452
453         backlight_device_unregister(backlight);
454 }
455
456 static int devm_backlight_device_match(struct device *dev, void *res,
457                                         void *data)
458 {
459         struct backlight_device **r = res;
460
461         return *r == data;
462 }
463
464 /**
465  * backlight_register_notifier - get notified of backlight (un)registration
466  * @nb: notifier block with the notifier to call on backlight (un)registration
467  *
468  * @return 0 on success, otherwise a negative error code
469  *
470  * Register a notifier to get notified when backlight devices get registered
471  * or unregistered.
472  */
473 int backlight_register_notifier(struct notifier_block *nb)
474 {
475         return blocking_notifier_chain_register(&backlight_notifier, nb);
476 }
477 EXPORT_SYMBOL(backlight_register_notifier);
478
479 /**
480  * backlight_unregister_notifier - unregister a backlight notifier
481  * @nb: notifier block to unregister
482  *
483  * @return 0 on success, otherwise a negative error code
484  *
485  * Register a notifier to get notified when backlight devices get registered
486  * or unregistered.
487  */
488 int backlight_unregister_notifier(struct notifier_block *nb)
489 {
490         return blocking_notifier_chain_unregister(&backlight_notifier, nb);
491 }
492 EXPORT_SYMBOL(backlight_unregister_notifier);
493
494 /**
495  * devm_backlight_device_register - resource managed backlight_device_register()
496  * @dev: the device to register
497  * @name: the name of the device
498  * @parent: a pointer to the parent device
499  * @devdata: an optional pointer to be stored for private driver use
500  * @ops: the backlight operations structure
501  * @props: the backlight properties
502  *
503  * @return a struct backlight on success, or an ERR_PTR on error
504  *
505  * Managed backlight_device_register(). The backlight_device returned
506  * from this function are automatically freed on driver detach.
507  * See backlight_device_register() for more information.
508  */
509 struct backlight_device *devm_backlight_device_register(struct device *dev,
510         const char *name, struct device *parent, void *devdata,
511         const struct backlight_ops *ops,
512         const struct backlight_properties *props)
513 {
514         struct backlight_device **ptr, *backlight;
515
516         ptr = devres_alloc(devm_backlight_device_release, sizeof(*ptr),
517                         GFP_KERNEL);
518         if (!ptr)
519                 return ERR_PTR(-ENOMEM);
520
521         backlight = backlight_device_register(name, parent, devdata, ops,
522                                                 props);
523         if (!IS_ERR(backlight)) {
524                 *ptr = backlight;
525                 devres_add(dev, ptr);
526         } else {
527                 devres_free(ptr);
528         }
529
530         return backlight;
531 }
532 EXPORT_SYMBOL(devm_backlight_device_register);
533
534 /**
535  * devm_backlight_device_unregister - resource managed backlight_device_unregister()
536  * @dev: the device to unregister
537  * @bd: the backlight device to unregister
538  *
539  * Deallocated a backlight allocated with devm_backlight_device_register().
540  * Normally this function will not need to be called and the resource management
541  * code will ensure that the resource is freed.
542  */
543 void devm_backlight_device_unregister(struct device *dev,
544                                 struct backlight_device *bd)
545 {
546         int rc;
547
548         rc = devres_release(dev, devm_backlight_device_release,
549                                 devm_backlight_device_match, bd);
550         WARN_ON(rc);
551 }
552 EXPORT_SYMBOL(devm_backlight_device_unregister);
553
554 #ifdef CONFIG_OF
555 static int of_parent_match(struct device *dev, const void *data)
556 {
557         return dev->parent && dev->parent->of_node == data;
558 }
559
560 /**
561  * of_find_backlight_by_node() - find backlight device by device-tree node
562  * @node: device-tree node of the backlight device
563  *
564  * Returns a pointer to the backlight device corresponding to the given DT
565  * node or NULL if no such backlight device exists or if the device hasn't
566  * been probed yet.
567  *
568  * This function obtains a reference on the backlight device and it is the
569  * caller's responsibility to drop the reference by calling put_device() on
570  * the backlight device's .dev field.
571  */
572 struct backlight_device *of_find_backlight_by_node(struct device_node *node)
573 {
574         struct device *dev;
575
576         dev = class_find_device(backlight_class, NULL, node, of_parent_match);
577
578         return dev ? to_backlight_device(dev) : NULL;
579 }
580 EXPORT_SYMBOL(of_find_backlight_by_node);
581 #endif
582
583 /**
584  * of_find_backlight - Get backlight device
585  * @dev: Device
586  *
587  * This function looks for a property named 'backlight' on the DT node
588  * connected to @dev and looks up the backlight device.
589  *
590  * Call backlight_put() to drop the reference on the backlight device.
591  *
592  * Returns:
593  * A pointer to the backlight device if found.
594  * Error pointer -EPROBE_DEFER if the DT property is set, but no backlight
595  * device is found.
596  * NULL if there's no backlight property.
597  */
598 struct backlight_device *of_find_backlight(struct device *dev)
599 {
600         struct backlight_device *bd = NULL;
601         struct device_node *np;
602
603         if (!dev)
604                 return NULL;
605
606         if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
607                 np = of_parse_phandle(dev->of_node, "backlight", 0);
608                 if (np) {
609                         bd = of_find_backlight_by_node(np);
610                         of_node_put(np);
611                         if (!bd)
612                                 return ERR_PTR(-EPROBE_DEFER);
613                         /*
614                          * Note: gpio_backlight uses brightness as
615                          * power state during probe
616                          */
617                         if (!bd->props.brightness)
618                                 bd->props.brightness = bd->props.max_brightness;
619                 }
620         }
621
622         return bd;
623 }
624 EXPORT_SYMBOL(of_find_backlight);
625
626 static void devm_backlight_release(void *data)
627 {
628         backlight_put(data);
629 }
630
631 /**
632  * devm_of_find_backlight - Resource-managed of_find_backlight()
633  * @dev: Device
634  *
635  * Device managed version of of_find_backlight().
636  * The reference on the backlight device is automatically
637  * dropped on driver detach.
638  */
639 struct backlight_device *devm_of_find_backlight(struct device *dev)
640 {
641         struct backlight_device *bd;
642         int ret;
643
644         bd = of_find_backlight(dev);
645         if (IS_ERR_OR_NULL(bd))
646                 return bd;
647         ret = devm_add_action(dev, devm_backlight_release, bd);
648         if (ret) {
649                 backlight_put(bd);
650                 return ERR_PTR(ret);
651         }
652         return bd;
653 }
654 EXPORT_SYMBOL(devm_of_find_backlight);
655
656 static void __exit backlight_class_exit(void)
657 {
658         class_destroy(backlight_class);
659 }
660
661 static int __init backlight_class_init(void)
662 {
663         backlight_class = class_create(THIS_MODULE, "backlight");
664         if (IS_ERR(backlight_class)) {
665                 pr_warn("Unable to create backlight class; errno = %ld\n",
666                         PTR_ERR(backlight_class));
667                 return PTR_ERR(backlight_class);
668         }
669
670         backlight_class->dev_groups = bl_device_groups;
671         backlight_class->pm = &backlight_class_dev_pm_ops;
672         INIT_LIST_HEAD(&backlight_dev_list);
673         mutex_init(&backlight_dev_list_mutex);
674         BLOCKING_INIT_NOTIFIER_HEAD(&backlight_notifier);
675
676         return 0;
677 }
678
679 /*
680  * if this is compiled into the kernel, we need to ensure that the
681  * class is registered before users of the class try to register lcd's
682  */
683 postcore_initcall(backlight_class_init);
684 module_exit(backlight_class_exit);
685
686 MODULE_LICENSE("GPL");
687 MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
688 MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");