blob: 79c1b0d609a809e189f43515ee20f648a7d2e8fa [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
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/lcd.h>
12#include <linux/notifier.h>
13#include <linux/ctype.h>
14#include <linux/err.h>
15#include <linux/fb.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090016#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
James Simmons3d5eead2006-12-08 02:40:47 -080018#if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
19 defined(CONFIG_LCD_CLASS_DEVICE_MODULE))
20/* This callback gets called when something important happens inside a
21 * framebuffer driver. We're looking if that important event is blanking,
22 * and if it is, we're switching lcd power as well ...
23 */
24static int fb_notifier_callback(struct notifier_block *self,
25 unsigned long event, void *data)
26{
27 struct lcd_device *ld;
28 struct fb_event *evdata = data;
29
30 /* If we aren't interested in this event, skip it immediately ... */
Eric Miaofaa312d2008-08-29 04:18:43 +080031 switch (event) {
32 case FB_EVENT_BLANK:
33 case FB_EVENT_MODE_CHANGE:
34 case FB_EVENT_MODE_CHANGE_ALL:
35 break;
36 default:
James Simmons3d5eead2006-12-08 02:40:47 -080037 return 0;
Eric Miaofaa312d2008-08-29 04:18:43 +080038 }
James Simmons3d5eead2006-12-08 02:40:47 -080039
40 ld = container_of(self, struct lcd_device, fb_notif);
Eric Miaofaa312d2008-08-29 04:18:43 +080041 if (!ld->ops)
42 return 0;
43
Richard Purdie599a52d2007-02-10 23:07:48 +000044 mutex_lock(&ld->ops_lock);
Eric Miaofaa312d2008-08-29 04:18:43 +080045 if (!ld->ops->check_fb || ld->ops->check_fb(ld, evdata->info)) {
Ben Dooksb3b4dc82008-11-19 15:36:25 -080046 if (event == FB_EVENT_BLANK) {
47 if (ld->ops->set_power)
48 ld->ops->set_power(ld, *(int *)evdata->data);
49 } else {
50 if (ld->ops->set_mode)
51 ld->ops->set_mode(ld, evdata->data);
52 }
Eric Miaofaa312d2008-08-29 04:18:43 +080053 }
Richard Purdie599a52d2007-02-10 23:07:48 +000054 mutex_unlock(&ld->ops_lock);
James Simmons3d5eead2006-12-08 02:40:47 -080055 return 0;
56}
57
58static int lcd_register_fb(struct lcd_device *ld)
59{
Jean Delvare1e0fa6b2009-10-02 11:28:18 +020060 memset(&ld->fb_notif, 0, sizeof(ld->fb_notif));
James Simmons3d5eead2006-12-08 02:40:47 -080061 ld->fb_notif.notifier_call = fb_notifier_callback;
62 return fb_register_client(&ld->fb_notif);
63}
64
65static void lcd_unregister_fb(struct lcd_device *ld)
66{
67 fb_unregister_client(&ld->fb_notif);
68}
69#else
70static int lcd_register_fb(struct lcd_device *ld)
71{
72 return 0;
73}
74
75static inline void lcd_unregister_fb(struct lcd_device *ld)
76{
77}
78#endif /* CONFIG_FB */
79
Richard Purdie655bfd72007-07-09 12:17:24 +010080static ssize_t lcd_show_power(struct device *dev, struct device_attribute *attr,
81 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
83 int rc;
Richard Purdie655bfd72007-07-09 12:17:24 +010084 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Richard Purdie599a52d2007-02-10 23:07:48 +000086 mutex_lock(&ld->ops_lock);
87 if (ld->ops && ld->ops->get_power)
88 rc = sprintf(buf, "%d\n", ld->ops->get_power(ld));
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 else
90 rc = -ENXIO;
Richard Purdie599a52d2007-02-10 23:07:48 +000091 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93 return rc;
94}
95
Richard Purdie655bfd72007-07-09 12:17:24 +010096static ssize_t lcd_store_power(struct device *dev,
97 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098{
Richard Purdie68673af2006-05-15 09:44:15 -070099 int rc = -ENXIO;
Richard Purdie655bfd72007-07-09 12:17:24 +0100100 struct lcd_device *ld = to_lcd_device(dev);
Jingoo Han66655762012-01-10 15:09:19 -0800101 unsigned long power;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Jingoo Han66655762012-01-10 15:09:19 -0800103 rc = kstrtoul(buf, 0, &power);
104 if (rc)
105 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Richard Purdie599a52d2007-02-10 23:07:48 +0000107 mutex_lock(&ld->ops_lock);
108 if (ld->ops && ld->ops->set_power) {
Jingoo Han66655762012-01-10 15:09:19 -0800109 pr_debug("lcd: set power to %lu\n", power);
Richard Purdie599a52d2007-02-10 23:07:48 +0000110 ld->ops->set_power(ld, power);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 rc = count;
Richard Purdie68673af2006-05-15 09:44:15 -0700112 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000113 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115 return rc;
116}
117
Richard Purdie655bfd72007-07-09 12:17:24 +0100118static ssize_t lcd_show_contrast(struct device *dev,
119 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
Richard Purdie68673af2006-05-15 09:44:15 -0700121 int rc = -ENXIO;
Richard Purdie655bfd72007-07-09 12:17:24 +0100122 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Richard Purdie599a52d2007-02-10 23:07:48 +0000124 mutex_lock(&ld->ops_lock);
125 if (ld->ops && ld->ops->get_contrast)
126 rc = sprintf(buf, "%d\n", ld->ops->get_contrast(ld));
127 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 return rc;
130}
131
Richard Purdie655bfd72007-07-09 12:17:24 +0100132static ssize_t lcd_store_contrast(struct device *dev,
133 struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134{
Richard Purdie68673af2006-05-15 09:44:15 -0700135 int rc = -ENXIO;
Richard Purdie655bfd72007-07-09 12:17:24 +0100136 struct lcd_device *ld = to_lcd_device(dev);
Jingoo Han66655762012-01-10 15:09:19 -0800137 unsigned long contrast;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Jingoo Han66655762012-01-10 15:09:19 -0800139 rc = kstrtoul(buf, 0, &contrast);
140 if (rc)
141 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Richard Purdie599a52d2007-02-10 23:07:48 +0000143 mutex_lock(&ld->ops_lock);
144 if (ld->ops && ld->ops->set_contrast) {
Jingoo Han66655762012-01-10 15:09:19 -0800145 pr_debug("lcd: set contrast to %lu\n", contrast);
Richard Purdie599a52d2007-02-10 23:07:48 +0000146 ld->ops->set_contrast(ld, contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 rc = count;
Richard Purdie68673af2006-05-15 09:44:15 -0700148 }
Richard Purdie599a52d2007-02-10 23:07:48 +0000149 mutex_unlock(&ld->ops_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151 return rc;
152}
153
Richard Purdie655bfd72007-07-09 12:17:24 +0100154static ssize_t lcd_show_max_contrast(struct device *dev,
155 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Richard Purdie655bfd72007-07-09 12:17:24 +0100157 struct lcd_device *ld = to_lcd_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Richard Purdie599a52d2007-02-10 23:07:48 +0000159 return sprintf(buf, "%d\n", ld->props.max_contrast);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160}
161
Adrian Bunk0ad90ef2007-08-11 10:27:19 +0100162static struct class *lcd_class;
Richard Purdie655bfd72007-07-09 12:17:24 +0100163
164static void lcd_device_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 struct lcd_device *ld = to_lcd_device(dev);
167 kfree(ld);
168}
169
Richard Purdie655bfd72007-07-09 12:17:24 +0100170static struct device_attribute lcd_device_attributes[] = {
171 __ATTR(lcd_power, 0644, lcd_show_power, lcd_store_power),
172 __ATTR(contrast, 0644, lcd_show_contrast, lcd_store_contrast),
173 __ATTR(max_contrast, 0444, lcd_show_max_contrast, NULL),
174 __ATTR_NULL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175};
176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177/**
178 * lcd_device_register - register a new object of lcd_device class.
179 * @name: the name of the new object(must be the same as the name of the
180 * respective framebuffer device).
Richard Purdie655bfd72007-07-09 12:17:24 +0100181 * @devdata: an optional pointer to be stored in the device. The
182 * methods may retrieve it by using lcd_get_data(ld).
Richard Purdie599a52d2007-02-10 23:07:48 +0000183 * @ops: the lcd operations structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 *
Richard Purdie655bfd72007-07-09 12:17:24 +0100185 * Creates and registers a new lcd device. Returns either an ERR_PTR()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 * or a pointer to the newly allocated device.
187 */
Richard Purdie655bfd72007-07-09 12:17:24 +0100188struct lcd_device *lcd_device_register(const char *name, struct device *parent,
189 void *devdata, struct lcd_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 struct lcd_device *new_ld;
Richard Purdie655bfd72007-07-09 12:17:24 +0100192 int rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 pr_debug("lcd_device_register: name=%s\n", name);
195
Richard Purdie599a52d2007-02-10 23:07:48 +0000196 new_ld = kzalloc(sizeof(struct lcd_device), GFP_KERNEL);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000197 if (!new_ld)
Jean Delvare10ad1b72006-03-09 17:33:36 -0800198 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Richard Purdie599a52d2007-02-10 23:07:48 +0000200 mutex_init(&new_ld->ops_lock);
Richard Purdie28ee0862007-02-08 22:25:09 +0000201 mutex_init(&new_ld->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Richard Purdie655bfd72007-07-09 12:17:24 +0100203 new_ld->dev.class = lcd_class;
204 new_ld->dev.parent = parent;
205 new_ld->dev.release = lcd_device_release;
Kay Sievers64dba9a2009-01-06 10:44:35 -0800206 dev_set_name(&new_ld->dev, name);
Richard Purdie655bfd72007-07-09 12:17:24 +0100207 dev_set_drvdata(&new_ld->dev, devdata);
208
209 rc = device_register(&new_ld->dev);
Dmitry Torokhov90968e82007-02-08 00:12:28 +0000210 if (rc) {
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000211 kfree(new_ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 return ERR_PTR(rc);
213 }
214
James Simmons3d5eead2006-12-08 02:40:47 -0800215 rc = lcd_register_fb(new_ld);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000216 if (rc) {
Richard Purdie655bfd72007-07-09 12:17:24 +0100217 device_unregister(&new_ld->dev);
Dmitry Torokhov2fd5a152007-02-07 22:25:50 +0000218 return ERR_PTR(rc);
219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Richard Purdie655bfd72007-07-09 12:17:24 +0100221 new_ld->ops = ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 return new_ld;
224}
225EXPORT_SYMBOL(lcd_device_register);
226
227/**
228 * lcd_device_unregister - unregisters a object of lcd_device class.
229 * @ld: the lcd device object to be unregistered and freed.
230 *
231 * Unregisters a previously registered via lcd_device_register object.
232 */
233void lcd_device_unregister(struct lcd_device *ld)
234{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 if (!ld)
236 return;
237
Richard Purdie599a52d2007-02-10 23:07:48 +0000238 mutex_lock(&ld->ops_lock);
239 ld->ops = NULL;
240 mutex_unlock(&ld->ops_lock);
James Simmons3d5eead2006-12-08 02:40:47 -0800241 lcd_unregister_fb(ld);
Richard Purdie655bfd72007-07-09 12:17:24 +0100242
243 device_unregister(&ld->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244}
245EXPORT_SYMBOL(lcd_device_unregister);
246
247static void __exit lcd_class_exit(void)
248{
Richard Purdie655bfd72007-07-09 12:17:24 +0100249 class_destroy(lcd_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
252static int __init lcd_class_init(void)
253{
Richard Purdie655bfd72007-07-09 12:17:24 +0100254 lcd_class = class_create(THIS_MODULE, "lcd");
255 if (IS_ERR(lcd_class)) {
256 printk(KERN_WARNING "Unable to create backlight class; errno = %ld\n",
257 PTR_ERR(lcd_class));
258 return PTR_ERR(lcd_class);
259 }
260
261 lcd_class->dev_attrs = lcd_device_attributes;
262 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
265/*
266 * if this is compiled into the kernel, we need to ensure that the
267 * class is registered before users of the class try to register lcd's
268 */
269postcore_initcall(lcd_class_init);
270module_exit(lcd_class_exit);
271
272MODULE_LICENSE("GPL");
273MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
274MODULE_DESCRIPTION("LCD Lowlevel Control Abstraction");