[deliverable/linux.git] / drivers / video / backlight / lcd.c

/*
 * LCD Lowlevel Control Abstraction
 *
 * Copyright (C) 2003,2004 Hewlett-Packard Company
 *
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/lcd.h>
#include <linux/notifier.h>
#include <linux/ctype.h>
#include <linux/err.h>
#include <linux/fb.h>

#if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
			   defined(CONFIG_LCD_CLASS_DEVICE_MODULE))
/* This callback gets called when something important happens inside a
 * framebuffer driver. We're looking if that important event is blanking,
 * and if it is, we're switching lcd power as well ...
 */
static int fb_notifier_callback(struct notifier_block *self,
				 unsigned long event, void *data)
{
	struct lcd_device *ld;
	struct fb_event *evdata = data;

	/* If we aren't interested in this event, skip it immediately ... */
	if (event != FB_EVENT_BLANK)
		return 0;

	ld = container_of(self, struct lcd_device, fb_notif);
	mutex_lock(&ld->ops_lock);
	if (ld->ops)
		if (!ld->ops->check_fb || ld->ops->check_fb(evdata->info))
			ld->ops->set_power(ld, *(int *)evdata->data);
	mutex_unlock(&ld->ops_lock);
	return 0;
}

static int lcd_register_fb(struct lcd_device *ld)
{
	memset(&ld->fb_notif, 0, sizeof(&ld->fb_notif));
	ld->fb_notif.notifier_call = fb_notifier_callback;
	return fb_register_client(&ld->fb_notif);
}

static void lcd_unregister_fb(struct lcd_device *ld)
{
	fb_unregister_client(&ld->fb_notif);
}
#else
static int lcd_register_fb(struct lcd_device *ld)
{
	return 0;
}

static inline void lcd_unregister_fb(struct lcd_device *ld)
{
}
#endif /* CONFIG_FB */

static ssize_t lcd_show_power(struct class_device *cdev, char *buf)
{
	int rc;
	struct lcd_device *ld = to_lcd_device(cdev);

	mutex_lock(&ld->ops_lock);
	if (ld->ops && ld->ops->get_power)
		rc = sprintf(buf, "%d\n", ld->ops->get_power(ld));
	else
		rc = -ENXIO;
	mutex_unlock(&ld->ops_lock);

	return rc;
}

static ssize_t lcd_store_power(struct class_device *cdev, const char *buf, size_t count)
{
	int rc = -ENXIO;
	char *endp;
	struct lcd_device *ld = to_lcd_device(cdev);
	int power = simple_strtoul(buf, &endp, 0);
	size_t size = endp - buf;

	if (*endp && isspace(*endp))
		size++;
	if (size != count)
		return -EINVAL;

	mutex_lock(&ld->ops_lock);
	if (ld->ops && ld->ops->set_power) {
		pr_debug("lcd: set power to %d\n", power);
		ld->ops->set_power(ld, power);
		rc = count;
	}
	mutex_unlock(&ld->ops_lock);

	return rc;
}

static ssize_t lcd_show_contrast(struct class_device *cdev, char *buf)
{
	int rc = -ENXIO;
	struct lcd_device *ld = to_lcd_device(cdev);

	mutex_lock(&ld->ops_lock);
	if (ld->ops && ld->ops->get_contrast)
		rc = sprintf(buf, "%d\n", ld->ops->get_contrast(ld));
	mutex_unlock(&ld->ops_lock);

	return rc;
}

static ssize_t lcd_store_contrast(struct class_device *cdev, const char *buf, size_t count)
{
	int rc = -ENXIO;
	char *endp;
	struct lcd_device *ld = to_lcd_device(cdev);
	int contrast = simple_strtoul(buf, &endp, 0);
	size_t size = endp - buf;

	if (*endp && isspace(*endp))
		size++;
	if (size != count)
		return -EINVAL;

	mutex_lock(&ld->ops_lock);
	if (ld->ops && ld->ops->set_contrast) {
		pr_debug("lcd: set contrast to %d\n", contrast);
		ld->ops->set_contrast(ld, contrast);
		rc = count;
	}
	mutex_unlock(&ld->ops_lock);

	return rc;
}

static ssize_t lcd_show_max_contrast(struct class_device *cdev, char *buf)
{
	struct lcd_device *ld = to_lcd_device(cdev);

	return sprintf(buf, "%d\n", ld->props.max_contrast);
}

static void lcd_class_release(struct class_device *dev)
{
	struct lcd_device *ld = to_lcd_device(dev);
	kfree(ld);
}

static struct class lcd_class = {
	.name = "lcd",
	.release = lcd_class_release,
};

#define DECLARE_ATTR(_name,_mode,_show,_store)			\
{							 	\
	.attr	= { .name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE },	\
	.show	= _show,					\
	.store	= _store,					\
}

static const struct class_device_attribute lcd_class_device_attributes[] = {
	DECLARE_ATTR(power, 0644, lcd_show_power, lcd_store_power),
	DECLARE_ATTR(contrast, 0644, lcd_show_contrast, lcd_store_contrast),
	DECLARE_ATTR(max_contrast, 0444, lcd_show_max_contrast, NULL),
};

/**
 * lcd_device_register - register a new object of lcd_device class.
 * @name: the name of the new object(must be the same as the name of the
 *   respective framebuffer device).
 * @devdata: an optional pointer to be stored in the class_device. The
 *   methods may retrieve it by using class_get_devdata(ld->class_dev).
 * @ops: the lcd operations structure.
 *
 * Creates and registers a new lcd class_device. Returns either an ERR_PTR()
 * or a pointer to the newly allocated device.
 */
struct lcd_device *lcd_device_register(const char *name, void *devdata,
				       struct lcd_ops *ops)
{
	int i, rc;
	struct lcd_device *new_ld;

	pr_debug("lcd_device_register: name=%s\n", name);

	new_ld = kzalloc(sizeof(struct lcd_device), GFP_KERNEL);
	if (!new_ld)
		return ERR_PTR(-ENOMEM);

	mutex_init(&new_ld->ops_lock);
	mutex_init(&new_ld->update_lock);
	new_ld->ops = ops;
	new_ld->class_dev.class = &lcd_class;
	strlcpy(new_ld->class_dev.class_id, name, KOBJ_NAME_LEN);
	class_set_devdata(&new_ld->class_dev, devdata);

	rc = class_device_register(&new_ld->class_dev);
	if (rc) {
		kfree(new_ld);
		return ERR_PTR(rc);
	}

	rc = lcd_register_fb(new_ld);
	if (rc) {
		class_device_unregister(&new_ld->class_dev);
		return ERR_PTR(rc);
	}

	for (i = 0; i < ARRAY_SIZE(lcd_class_device_attributes); i++) {
		rc = class_device_create_file(&new_ld->class_dev,
					      &lcd_class_device_attributes[i]);
		if (rc) {
			while (--i >= 0)
				class_device_remove_file(&new_ld->class_dev,
							 &lcd_class_device_attributes[i]);
			class_device_unregister(&new_ld->class_dev);
			/* No need to kfree(new_ld) since release() method was called */
			return ERR_PTR(rc);
		}
	}

	return new_ld;
}
EXPORT_SYMBOL(lcd_device_register);

/**
 * lcd_device_unregister - unregisters a object of lcd_device class.
 * @ld: the lcd device object to be unregistered and freed.
 *
 * Unregisters a previously registered via lcd_device_register object.
 */
void lcd_device_unregister(struct lcd_device *ld)
{
	int i;

	if (!ld)
		return;

	pr_debug("lcd_device_unregister: name=%s\n", ld->class_dev.class_id);

	for (i = 0; i < ARRAY_SIZE(lcd_class_device_attributes); i++)
		class_device_remove_file(&ld->class_dev,
					 &lcd_class_device_attributes[i]);

	mutex_lock(&ld->ops_lock);
	ld->ops = NULL;
	mutex_unlock(&ld->ops_lock);
	lcd_unregister_fb(ld);
	class_device_unregister(&ld->class_dev);
}
EXPORT_SYMBOL(lcd_device_unregister);

static void __exit lcd_class_exit(void)
{
	class_unregister(&lcd_class);
}

static int __init lcd_class_init(void)
{
	return class_register(&lcd_class);
}

/*
 * if this is compiled into the kernel, we need to ensure that the
 * class is registered before users of the class try to register lcd's
 */
postcore_initcall(lcd_class_init);
module_exit(lcd_class_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
MODULE_DESCRIPTION("LCD Lowlevel Control Abstraction");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* LCD Lowlevel Control Abstraction
	3	*
	4	* Copyright (C) 2003,2004 Hewlett-Packard Company
	5	*
	6	*/
	7
1da177e4 LT	8	#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>
1da177e4	16
3d5eeadd JS	17	#if defined(CONFIG_FB) \|\| (defined(CONFIG_FB_MODULE) && \
	18	defined(CONFIG_LCD_CLASS_DEVICE_MODULE))
	19	/* This callback gets called when something important happens inside a
	20	* framebuffer driver. We're looking if that important event is blanking,
	21	* and if it is, we're switching lcd power as well ...
	22	*/
	23	static int fb_notifier_callback(struct notifier_block *self,
	24	unsigned long event, void *data)
	25	{
	26	struct lcd_device *ld;
	27	struct fb_event *evdata = data;
	28
	29	/* If we aren't interested in this event, skip it immediately ... */
	30	if (event != FB_EVENT_BLANK)
	31	return 0;
	32
	33	ld = container_of(self, struct lcd_device, fb_notif);
599a52d1 RP	34	mutex_lock(&ld->ops_lock);
	35	if (ld->ops)
	36	if (!ld->ops->check_fb \|\| ld->ops->check_fb(evdata->info))
	37	ld->ops->set_power(ld, (int )evdata->data);
	38	mutex_unlock(&ld->ops_lock);
3d5eeadd JS	39	return 0;
	40	}
	41
	42	static int lcd_register_fb(struct lcd_device *ld)
	43	{
	44	memset(&ld->fb_notif, 0, sizeof(&ld->fb_notif));
	45	ld->fb_notif.notifier_call = fb_notifier_callback;
	46	return fb_register_client(&ld->fb_notif);
	47	}
	48
	49	static void lcd_unregister_fb(struct lcd_device *ld)
	50	{
	51	fb_unregister_client(&ld->fb_notif);
	52	}
	53	#else
	54	static int lcd_register_fb(struct lcd_device *ld)
	55	{
	56	return 0;
	57	}
	58
	59	static inline void lcd_unregister_fb(struct lcd_device *ld)
	60	{
	61	}
	62	#endif /* CONFIG_FB */
	63
1da177e4 LT	64	static ssize_t lcd_show_power(struct class_device cdev, char buf)
	65	{
	66	int rc;
	67	struct lcd_device *ld = to_lcd_device(cdev);
	68
599a52d1 RP	69	mutex_lock(&ld->ops_lock);
	70	if (ld->ops && ld->ops->get_power)
	71	rc = sprintf(buf, "%d\n", ld->ops->get_power(ld));
1da177e4 LT	72	else
1da177e4 LT	73	rc = -ENXIO;
599a52d1	74	mutex_unlock(&ld->ops_lock);
1da177e4 LT	75
	76	return rc;
	77	}
	78
	79	static ssize_t lcd_store_power(struct class_device cdev, const char buf, size_t count)
	80	{
68673afd	81	int rc = -ENXIO;
1da177e4 LT	82	char *endp;
1da177e4 LT	83	struct lcd_device *ld = to_lcd_device(cdev);
68673afd RP	84	int power = simple_strtoul(buf, &endp, 0);
68673afd RP	85	size_t size = endp - buf;
1da177e4	86
68673afd RP	87	if (endp && isspace(endp))
	88	size++;
	89	if (size != count)
1da177e4 LT	90	return -EINVAL;
1da177e4 LT	91
599a52d1 RP	92	mutex_lock(&ld->ops_lock);
599a52d1 RP	93	if (ld->ops && ld->ops->set_power) {
1da177e4	94	pr_debug("lcd: set power to %d\n", power);
599a52d1	95	ld->ops->set_power(ld, power);
1da177e4	96	rc = count;
68673afd	97	}
599a52d1	98	mutex_unlock(&ld->ops_lock);
1da177e4 LT	99
	100	return rc;
	101	}
	102
	103	static ssize_t lcd_show_contrast(struct class_device cdev, char buf)
	104	{
68673afd	105	int rc = -ENXIO;
1da177e4 LT	106	struct lcd_device *ld = to_lcd_device(cdev);
1da177e4 LT	107
599a52d1 RP	108	mutex_lock(&ld->ops_lock);
	109	if (ld->ops && ld->ops->get_contrast)
	110	rc = sprintf(buf, "%d\n", ld->ops->get_contrast(ld));
	111	mutex_unlock(&ld->ops_lock);
1da177e4 LT	112
	113	return rc;
	114	}
	115
	116	static ssize_t lcd_store_contrast(struct class_device cdev, const char buf, size_t count)
	117	{
68673afd	118	int rc = -ENXIO;
1da177e4 LT	119	char *endp;
1da177e4 LT	120	struct lcd_device *ld = to_lcd_device(cdev);
68673afd RP	121	int contrast = simple_strtoul(buf, &endp, 0);
68673afd RP	122	size_t size = endp - buf;
1da177e4	123
68673afd RP	124	if (endp && isspace(endp))
	125	size++;
	126	if (size != count)
1da177e4 LT	127	return -EINVAL;
1da177e4 LT	128
599a52d1 RP	129	mutex_lock(&ld->ops_lock);
599a52d1 RP	130	if (ld->ops && ld->ops->set_contrast) {
1da177e4	131	pr_debug("lcd: set contrast to %d\n", contrast);
599a52d1	132	ld->ops->set_contrast(ld, contrast);
1da177e4	133	rc = count;
68673afd	134	}
599a52d1	135	mutex_unlock(&ld->ops_lock);
1da177e4 LT	136
	137	return rc;
	138	}
	139
	140	static ssize_t lcd_show_max_contrast(struct class_device cdev, char buf)
	141	{
1da177e4 LT	142	struct lcd_device *ld = to_lcd_device(cdev);
1da177e4 LT	143
599a52d1	144	return sprintf(buf, "%d\n", ld->props.max_contrast);
1da177e4 LT	145	}
	146
	147	static void lcd_class_release(struct class_device *dev)
	148	{
	149	struct lcd_device *ld = to_lcd_device(dev);
	150	kfree(ld);
	151	}
	152
	153	static struct class lcd_class = {
	154	.name = "lcd",
	155	.release = lcd_class_release,
	156	};
	157
	158	#define DECLARE_ATTR(_name,_mode,_show,_store) \
	159	{ \
	160	.attr = { .name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \
	161	.show = _show, \
	162	.store = _store, \
	163	}
	164
d95159cf	165	static const struct class_device_attribute lcd_class_device_attributes[] = {
1da177e4 LT	166	DECLARE_ATTR(power, 0644, lcd_show_power, lcd_store_power),
	167	DECLARE_ATTR(contrast, 0644, lcd_show_contrast, lcd_store_contrast),
	168	DECLARE_ATTR(max_contrast, 0444, lcd_show_max_contrast, NULL),
	169	};
	170
1da177e4 LT	171	/**
	172	* lcd_device_register - register a new object of lcd_device class.
	173	* @name: the name of the new object(must be the same as the name of the
	174	* respective framebuffer device).
	175	* @devdata: an optional pointer to be stored in the class_device. The
	176	* methods may retrieve it by using class_get_devdata(ld->class_dev).
599a52d1	177	* @ops: the lcd operations structure.
1da177e4 LT	178	*
	179	* Creates and registers a new lcd class_device. Returns either an ERR_PTR()
	180	* or a pointer to the newly allocated device.
	181	*/
	182	struct lcd_device lcd_device_register(const char name, void *devdata,
599a52d1	183	struct lcd_ops *ops)
1da177e4 LT	184	{
	185	int i, rc;
	186	struct lcd_device *new_ld;
	187
	188	pr_debug("lcd_device_register: name=%s\n", name);
	189
599a52d1	190	new_ld = kzalloc(sizeof(struct lcd_device), GFP_KERNEL);
90968e8e	191	if (!new_ld)
10ad1b73	192	return ERR_PTR(-ENOMEM);
1da177e4	193
599a52d1	194	mutex_init(&new_ld->ops_lock);
28ee086d	195	mutex_init(&new_ld->update_lock);
599a52d1	196	new_ld->ops = ops;
1da177e4 LT	197	new_ld->class_dev.class = &lcd_class;
	198	strlcpy(new_ld->class_dev.class_id, name, KOBJ_NAME_LEN);
	199	class_set_devdata(&new_ld->class_dev, devdata);
	200
	201	rc = class_device_register(&new_ld->class_dev);
90968e8e	202	if (rc) {
2fd5a154	203	kfree(new_ld);
1da177e4 LT	204	return ERR_PTR(rc);
	205	}
	206
3d5eeadd	207	rc = lcd_register_fb(new_ld);
2fd5a154 DT	208	if (rc) {
	209	class_device_unregister(&new_ld->class_dev);
	210	return ERR_PTR(rc);
	211	}
1da177e4 LT	212
	213	for (i = 0; i < ARRAY_SIZE(lcd_class_device_attributes); i++) {
	214	rc = class_device_create_file(&new_ld->class_dev,
	215	&lcd_class_device_attributes[i]);
90968e8e	216	if (rc) {
1da177e4 LT	217	while (--i >= 0)
	218	class_device_remove_file(&new_ld->class_dev,
	219	&lcd_class_device_attributes[i]);
	220	class_device_unregister(&new_ld->class_dev);
	221	/* No need to kfree(new_ld) since release() method was called */
	222	return ERR_PTR(rc);
	223	}
	224	}
	225
	226	return new_ld;
	227	}
	228	EXPORT_SYMBOL(lcd_device_register);
	229
	230	/**
	231	* lcd_device_unregister - unregisters a object of lcd_device class.
	232	* @ld: the lcd device object to be unregistered and freed.
	233	*
	234	* Unregisters a previously registered via lcd_device_register object.
	235	*/
	236	void lcd_device_unregister(struct lcd_device *ld)
	237	{
	238	int i;
	239
	240	if (!ld)
	241	return;
	242
	243	pr_debug("lcd_device_unregister: name=%s\n", ld->class_dev.class_id);
	244
	245	for (i = 0; i < ARRAY_SIZE(lcd_class_device_attributes); i++)
	246	class_device_remove_file(&ld->class_dev,
	247	&lcd_class_device_attributes[i]);
	248
599a52d1 RP	249	mutex_lock(&ld->ops_lock);
	250	ld->ops = NULL;
	251	mutex_unlock(&ld->ops_lock);
3d5eeadd	252	lcd_unregister_fb(ld);
1da177e4 LT	253	class_device_unregister(&ld->class_dev);
	254	}
	255	EXPORT_SYMBOL(lcd_device_unregister);
	256
	257	static void __exit lcd_class_exit(void)
	258	{
	259	class_unregister(&lcd_class);
	260	}
	261
	262	static int __init lcd_class_init(void)
	263	{
	264	return class_register(&lcd_class);
	265	}
	266
	267	/*
	268	* if this is compiled into the kernel, we need to ensure that the
	269	* class is registered before users of the class try to register lcd's
	270	*/
	271	postcore_initcall(lcd_class_init);
	272	module_exit(lcd_class_exit);
	273
	274	MODULE_LICENSE("GPL");
	275	MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
	276	MODULE_DESCRIPTION("LCD Lowlevel Control Abstraction");