blob: 93cf15efc717d4ea015a05c06da529831af1192f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * LCD Lowlevel Control Abstraction
3 *
4 * Copyright (C) 2003,2004 Hewlett-Packard Company
5 *
6 */
7
Jingoo Han35f96162012-05-29 15:07:16 -07008#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/module.h>
11#include <linux/init.h>
12#include <linux/device.h>
13#include <linux/lcd.h>
14#include <linux/notifier.h>
15#include <linux/ctype.h>
16#include <linux/err.h>
17#include <linux/fb.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
James Simmons3d5eead2006-12-08 02:40:47 -080020#if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
21 defined(CONFIG_LCD_CLASS_DEVICE_MODULE))
22/* This callback gets called when something important happens inside a
23 * framebuffer driver. We're looking if that important event is blanking,
24 * and if it is, we're switching lcd power as well ...
25 */
26static int fb_notifier_callback(struct notifier_block *self,
27 unsigned long event, void *data)
28{
29 struct lcd_device *ld;
30 struct fb_event *evdata = data;
31
32 /* If we aren't interested in this event, skip it immediately ... */
Eric Miaofaa312d2008-08-29 04:18:43 +080033 switch (event) {
34 case FB_EVENT_BLANK:
35 case FB_EVENT_MODE_CHANGE:
36 case FB_EVENT_MODE_CHANGE_ALL:
Inki Daed54ad832012-05-29 15:07:13 -070037 case FB_EARLY_EVENT_BLANK:
38 case FB_R_EARLY_EVENT_BLANK:
Eric Miaofaa312d2008-08-29 04:18:43 +080039 break;
40 default:
James Simmons3d5eead2006-12-08 02:40:47 -080041 return 0;
Eric Miaofaa312d2008-08-29 04:18:43 +080042 }
James Simmons3d5eead2006-12-08 02:40:47 -080043
44 ld = container_of(self, struct lcd_device, fb_notif);
Eric Miaofaa312d2008-08-29 04:18:43 +080045 if (!ld->ops)
46 return 0;
47
Richard Purdie599a52d2007-02-10 23:07:48 +000048 mutex_lock(&ld->ops_lock);
Eric Miaofaa312d2008-08-29 04:18:43 +080049 if (!ld->ops->check_fb || ld->ops->check_fb(ld, evdata->info)) {
Ben Dooksb3b4dc82008-11-19 15:36:25 -080050 if (event == FB_EVENT_BLANK) {
51 if (ld->ops->set_power)
52 ld->ops->set_power(ld, *(int *)evdata->data);
Inki Daed54ad832012-05-29 15:07:13 -070053 } else if (event == FB_EARLY_EVENT_BLANK) {
54 if (ld->ops->early_set_power)
55 ld->ops->early_set_power(ld,
56 *(int *)evdata->data);
57 } else if (event == FB_R_EARLY_EVENT_BLANK) {
58 if (ld->ops->r_early_set_power)
59 ld->ops->r_early_set_power(ld,
60 *(int *)evdata->data);
Ben Dooksb3b4dc82008-11-19 15:36:25 -080061 } else {
62 if (ld->ops->set_mode)
63 ld->ops->set_mode(ld, evdata->data);
64 }
Eric Miaofaa312d2008-08-29 04:18:43 +080065 }
Richard Purdie599a52d2007-02-10 23:07:48 +000066 mutex_unlock(&ld->ops_lock);
James Simmons3d5eead2006-12-08 02:40:47 -080067 return 0;
68}
69
70static int lcd_register_fb(struct lcd_device *ld)
71{
Jean Delvare1e0fa6b2009-10-02 11:28:18 +020072 memset(&ld->fb_notif, 0, sizeof(ld->fb_notif));
James Simmons3d5eead2006-12-08 02:40:47 -080073 ld->fb_notif.notifier_call = fb_notifier_callback;
74 return fb_register_client(&ld->fb_notif);
75}
76
77static void lcd_unregister_fb(struct lcd_device *ld)
78{
79 fb_unregister_client(&ld->fb_notif);
80}
81#else
82static int lcd_register_fb(struct lcd_device *ld)
83{
84 return 0;
85}
86
87static inline void lcd_unregister_fb(struct lcd_device *ld)
88{
89}
90#endif /* CONFIG_FB */
91
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -070092static ssize_t lcd_power_show(struct device *dev, struct device_attribute *attr,
Richard Purdie655bfd72007-07-09 12:17:24 +010093 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
95 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +010096 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Richard Purdie599a52d2007-02-10 23:07:48 +000098 mutex_lock(&ld->ops_lock);
99 if (ld->ops && ld->ops->get_power)
100 rc = sprintf(buf, "%d\n", ld->ops->get_power(ld));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 else
102 rc = -ENXIO;
Richard Purdie599a52d2007-02-10 23:07:48 +0000103 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105 return rc;
106}
107
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700108static ssize_t lcd_power_store(struct device *dev,
Richard Purdie655bfd72007-07-09 12:17:24 +0100109 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
Jingoo Han424e06e2012-12-17 16:01:10 -0800111 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +0100112 struct lcd_device *ld = to_lcd_device(dev);
Jingoo Han66655762012-01-10 15:09:19 -0800113 unsigned long power;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Jingoo Han66655762012-01-10 15:09:19 -0800115 rc = kstrtoul(buf, 0, &power);
116 if (rc)
117 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Jingoo Han424e06e2012-12-17 16:01:10 -0800119 rc = -ENXIO;
120
Richard Purdie599a52d2007-02-10 23:07:48 +0000121 mutex_lock(&ld->ops_lock);
122 if (ld->ops && ld->ops->set_power) {
Jingoo Han35f96162012-05-29 15:07:16 -0700123 pr_debug("set power to %lu\n", power);
Richard Purdie599a52d2007-02-10 23:07:48 +0000124 ld->ops->set_power(ld, power);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 rc = count;
Richard Purdie68673af2006-05-15 09:44:15 -0700126 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000127 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 return rc;
130}
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700131static DEVICE_ATTR_RW(lcd_power);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700133static ssize_t contrast_show(struct device *dev,
Richard Purdie655bfd72007-07-09 12:17:24 +0100134 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
Richard Purdie68673af2006-05-15 09:44:15 -0700136 int rc = -ENXIO;
Richard Purdie655bfd72007-07-09 12:17:24 +0100137 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Richard Purdie599a52d2007-02-10 23:07:48 +0000139 mutex_lock(&ld->ops_lock);
140 if (ld->ops && ld->ops->get_contrast)
141 rc = sprintf(buf, "%d\n", ld->ops->get_contrast(ld));
142 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144 return rc;
145}
146
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700147static ssize_t contrast_store(struct device *dev,
Richard Purdie655bfd72007-07-09 12:17:24 +0100148 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149{
Jingoo Han424e06e2012-12-17 16:01:10 -0800150 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +0100151 struct lcd_device *ld = to_lcd_device(dev);
Jingoo Han66655762012-01-10 15:09:19 -0800152 unsigned long contrast;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Jingoo Han66655762012-01-10 15:09:19 -0800154 rc = kstrtoul(buf, 0, &contrast);
155 if (rc)
156 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Jingoo Han424e06e2012-12-17 16:01:10 -0800158 rc = -ENXIO;
159
Richard Purdie599a52d2007-02-10 23:07:48 +0000160 mutex_lock(&ld->ops_lock);
161 if (ld->ops && ld->ops->set_contrast) {
Jingoo Han35f96162012-05-29 15:07:16 -0700162 pr_debug("set contrast to %lu\n", contrast);
Richard Purdie599a52d2007-02-10 23:07:48 +0000163 ld->ops->set_contrast(ld, contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 rc = count;
Richard Purdie68673af2006-05-15 09:44:15 -0700165 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000166 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168 return rc;
169}
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700170static DEVICE_ATTR_RW(contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700172static ssize_t max_contrast_show(struct device *dev,
Richard Purdie655bfd72007-07-09 12:17:24 +0100173 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Richard Purdie655bfd72007-07-09 12:17:24 +0100175 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Richard Purdie599a52d2007-02-10 23:07:48 +0000177 return sprintf(buf, "%d\n", ld->props.max_contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178}
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700179static DEVICE_ATTR_RO(max_contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Adrian Bunk0ad90ef2007-08-11 10:27:19 +0100181static struct class *lcd_class;
Richard Purdie655bfd72007-07-09 12:17:24 +0100182
183static void lcd_device_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
185 struct lcd_device *ld = to_lcd_device(dev);
186 kfree(ld);
187}
188
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700189static struct attribute *lcd_device_attrs[] = {
190 &dev_attr_lcd_power.attr,
191 &dev_attr_contrast.attr,
192 &dev_attr_max_contrast.attr,
193 NULL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194};
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700195ATTRIBUTE_GROUPS(lcd_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197/**
198 * lcd_device_register - register a new object of lcd_device class.
199 * @name: the name of the new object(must be the same as the name of the
200 * respective framebuffer device).
Richard Purdie655bfd72007-07-09 12:17:24 +0100201 * @devdata: an optional pointer to be stored in the device. The
202 * methods may retrieve it by using lcd_get_data(ld).
Richard Purdie599a52d2007-02-10 23:07:48 +0000203 * @ops: the lcd operations structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 *
Richard Purdie655bfd72007-07-09 12:17:24 +0100205 * Creates and registers a new lcd device. Returns either an ERR_PTR()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 * or a pointer to the newly allocated device.
207 */
Richard Purdie655bfd72007-07-09 12:17:24 +0100208struct lcd_device *lcd_device_register(const char *name, struct device *parent,
209 void *devdata, struct lcd_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 struct lcd_device *new_ld;
Richard Purdie655bfd72007-07-09 12:17:24 +0100212 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214 pr_debug("lcd_device_register: name=%s\n", name);
215
Richard Purdie599a52d2007-02-10 23:07:48 +0000216 new_ld = kzalloc(sizeof(struct lcd_device), GFP_KERNEL);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000217 if (!new_ld)
Jean Delvare10ad1b72006-03-09 17:33:36 -0800218 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Richard Purdie599a52d2007-02-10 23:07:48 +0000220 mutex_init(&new_ld->ops_lock);
Richard Purdie28ee0862007-02-08 22:25:09 +0000221 mutex_init(&new_ld->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Richard Purdie655bfd72007-07-09 12:17:24 +0100223 new_ld->dev.class = lcd_class;
224 new_ld->dev.parent = parent;
225 new_ld->dev.release = lcd_device_release;
Kees Cook02aa2a32013-07-03 15:04:56 -0700226 dev_set_name(&new_ld->dev, "%s", name);
Richard Purdie655bfd72007-07-09 12:17:24 +0100227 dev_set_drvdata(&new_ld->dev, devdata);
228
229 rc = device_register(&new_ld->dev);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000230 if (rc) {
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000231 kfree(new_ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 return ERR_PTR(rc);
233 }
234
James Simmons3d5eead2006-12-08 02:40:47 -0800235 rc = lcd_register_fb(new_ld);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000236 if (rc) {
Richard Purdie655bfd72007-07-09 12:17:24 +0100237 device_unregister(&new_ld->dev);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000238 return ERR_PTR(rc);
239 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Richard Purdie655bfd72007-07-09 12:17:24 +0100241 new_ld->ops = ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 return new_ld;
244}
245EXPORT_SYMBOL(lcd_device_register);
246
247/**
248 * lcd_device_unregister - unregisters a object of lcd_device class.
249 * @ld: the lcd device object to be unregistered and freed.
250 *
251 * Unregisters a previously registered via lcd_device_register object.
252 */
253void lcd_device_unregister(struct lcd_device *ld)
254{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (!ld)
256 return;
257
Richard Purdie599a52d2007-02-10 23:07:48 +0000258 mutex_lock(&ld->ops_lock);
259 ld->ops = NULL;
260 mutex_unlock(&ld->ops_lock);
James Simmons3d5eead2006-12-08 02:40:47 -0800261 lcd_unregister_fb(ld);
Richard Purdie655bfd72007-07-09 12:17:24 +0100262
263 device_unregister(&ld->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264}
265EXPORT_SYMBOL(lcd_device_unregister);
266
Jingoo Han1d0c48e2013-07-03 15:05:14 -0700267static void devm_lcd_device_release(struct device *dev, void *res)
268{
269 struct lcd_device *lcd = *(struct lcd_device **)res;
270
271 lcd_device_unregister(lcd);
272}
273
274static int devm_lcd_device_match(struct device *dev, void *res, void *data)
275{
276 struct lcd_device **r = res;
277
278 return *r == data;
279}
280
281/**
282 * devm_lcd_device_register - resource managed lcd_device_register()
283 * @dev: the device to register
284 * @name: the name of the device
285 * @parent: a pointer to the parent device
286 * @devdata: an optional pointer to be stored for private driver use
287 * @ops: the lcd operations structure
288 *
289 * @return a struct lcd on success, or an ERR_PTR on error
290 *
291 * Managed lcd_device_register(). The lcd_device returned from this function
292 * are automatically freed on driver detach. See lcd_device_register()
293 * for more information.
294 */
295struct lcd_device *devm_lcd_device_register(struct device *dev,
296 const char *name, struct device *parent,
297 void *devdata, struct lcd_ops *ops)
298{
299 struct lcd_device **ptr, *lcd;
300
301 ptr = devres_alloc(devm_lcd_device_release, sizeof(*ptr), GFP_KERNEL);
302 if (!ptr)
303 return ERR_PTR(-ENOMEM);
304
305 lcd = lcd_device_register(name, parent, devdata, ops);
306 if (!IS_ERR(lcd)) {
307 *ptr = lcd;
308 devres_add(dev, ptr);
309 } else {
310 devres_free(ptr);
311 }
312
313 return lcd;
314}
315EXPORT_SYMBOL(devm_lcd_device_register);
316
317/**
318 * devm_lcd_device_unregister - resource managed lcd_device_unregister()
319 * @dev: the device to unregister
320 * @ld: the lcd device to unregister
321 *
322 * Deallocated a lcd allocated with devm_lcd_device_register(). Normally
323 * this function will not need to be called and the resource management
324 * code will ensure that the resource is freed.
325 */
326void devm_lcd_device_unregister(struct device *dev, struct lcd_device *ld)
327{
328 int rc;
329
330 rc = devres_release(dev, devm_lcd_device_release,
331 devm_lcd_device_match, ld);
332 WARN_ON(rc);
333}
334EXPORT_SYMBOL(devm_lcd_device_unregister);
335
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337static void __exit lcd_class_exit(void)
338{
Richard Purdie655bfd72007-07-09 12:17:24 +0100339 class_destroy(lcd_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340}
341
342static int __init lcd_class_init(void)
343{
Richard Purdie655bfd72007-07-09 12:17:24 +0100344 lcd_class = class_create(THIS_MODULE, "lcd");
345 if (IS_ERR(lcd_class)) {
Jingoo Han35f96162012-05-29 15:07:16 -0700346 pr_warn("Unable to create backlight class; errno = %ld\n",
347 PTR_ERR(lcd_class));
Richard Purdie655bfd72007-07-09 12:17:24 +0100348 return PTR_ERR(lcd_class);
349 }
350
Greg Kroah-Hartmand79fd032013-07-24 15:05:31 -0700351 lcd_class->dev_groups = lcd_device_groups;
Richard Purdie655bfd72007-07-09 12:17:24 +0100352 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353}
354
355/*
356 * if this is compiled into the kernel, we need to ensure that the
357 * class is registered before users of the class try to register lcd's
358 */
359postcore_initcall(lcd_class_init);
360module_exit(lcd_class_exit);
361
362MODULE_LICENSE("GPL");
363MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
364MODULE_DESCRIPTION("LCD Lowlevel Control Abstraction");