[mirror_ubuntu-zesty-kernel.git] / drivers / video / backlight / backlight.c

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

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

#ifdef CONFIG_PMAC_BACKLIGHT
#include <asm/backlight.h>
#endif

#if defined(CONFIG_FB) || (defined(CONFIG_FB_MODULE) && \
			   defined(CONFIG_BACKLIGHT_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 backlight power as well ...
 */
static int fb_notifier_callback(struct notifier_block *self,
				unsigned long event, void *data)
{
	struct backlight_device *bd;
	struct fb_event *evdata = data;

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

	bd = container_of(self, struct backlight_device, fb_notif);
	mutex_lock(&bd->ops_lock);
	if (bd->ops)
		if (!bd->ops->check_fb ||
		    bd->ops->check_fb(evdata->info)) {
			bd->props.fb_blank = *(int *)evdata->data;
			backlight_update_status(bd);
		}
	mutex_unlock(&bd->ops_lock);
	return 0;
}

static int backlight_register_fb(struct backlight_device *bd)
{
	memset(&bd->fb_notif, 0, sizeof(bd->fb_notif));
	bd->fb_notif.notifier_call = fb_notifier_callback;

	return fb_register_client(&bd->fb_notif);
}

static void backlight_unregister_fb(struct backlight_device *bd)
{
	fb_unregister_client(&bd->fb_notif);
}
#else
static inline int backlight_register_fb(struct backlight_device *bd)
{
	return 0;
}

static inline void backlight_unregister_fb(struct backlight_device *bd)
{
}
#endif /* CONFIG_FB */

static ssize_t backlight_show_power(struct device *dev,
		struct device_attribute *attr,char *buf)
{
	struct backlight_device *bd = to_backlight_device(dev);

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

static ssize_t backlight_store_power(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	int rc = -ENXIO;
	char *endp;
	struct backlight_device *bd = to_backlight_device(dev);
	int power = simple_strtoul(buf, &endp, 0);
	size_t size = endp - buf;

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

	mutex_lock(&bd->ops_lock);
	if (bd->ops) {
		pr_debug("backlight: set power to %d\n", power);
		if (bd->props.power != power) {
			bd->props.power = power;
			backlight_update_status(bd);
		}
		rc = count;
	}
	mutex_unlock(&bd->ops_lock);

	return rc;
}

static ssize_t backlight_show_brightness(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct backlight_device *bd = to_backlight_device(dev);

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

static ssize_t backlight_store_brightness(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	int rc = -ENXIO;
	char *endp;
	struct backlight_device *bd = to_backlight_device(dev);
	int brightness = simple_strtoul(buf, &endp, 0);
	size_t size = endp - buf;

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

	mutex_lock(&bd->ops_lock);
	if (bd->ops) {
		if (brightness > bd->props.max_brightness)
			rc = -EINVAL;
		else {
			pr_debug("backlight: set brightness to %d\n",
				 brightness);
			if (bd->props.brightness != brightness) {
				bd->props.brightness = brightness;
				backlight_update_status(bd);
			}
			rc = count;
		}
	}
	mutex_unlock(&bd->ops_lock);

	return rc;
}

static ssize_t backlight_show_max_brightness(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct backlight_device *bd = to_backlight_device(dev);

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

static ssize_t backlight_show_actual_brightness(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	int rc = -ENXIO;
	struct backlight_device *bd = to_backlight_device(dev);

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

	return rc;
}

static struct class *backlight_class;

static void bl_device_release(struct device *dev)
{
	struct backlight_device *bd = to_backlight_device(dev);
	kfree(bd);
}

static struct device_attribute bl_device_attributes[] = {
	__ATTR(bl_power, 0644, backlight_show_power, backlight_store_power),
	__ATTR(brightness, 0644, backlight_show_brightness,
		     backlight_store_brightness),
	__ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
		     NULL),
	__ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
	__ATTR_NULL,
};

/**
 * backlight_device_register - create and register a new object of
 *   backlight_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 for private driver use. The
 *   methods may retrieve it by using bl_get_data(bd).
 * @ops: the backlight operations structure.
 *
 * Creates and registers new backlight device. Returns either an
 * ERR_PTR() or a pointer to the newly allocated device.
 */
struct backlight_device *backlight_device_register(const char *name,
		struct device *parent, void *devdata, struct backlight_ops *ops)
{
	struct backlight_device *new_bd;
	int rc;

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

	new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
	if (!new_bd)
		return ERR_PTR(-ENOMEM);

	mutex_init(&new_bd->update_lock);
	mutex_init(&new_bd->ops_lock);

	new_bd->dev.class = backlight_class;
	new_bd->dev.parent = parent;
	new_bd->dev.release = bl_device_release;
	strlcpy(new_bd->dev.bus_id, name, BUS_ID_SIZE);
	dev_set_drvdata(&new_bd->dev, devdata);

	rc = device_register(&new_bd->dev);
	if (rc) {
		kfree(new_bd);
		return ERR_PTR(rc);
	}

	rc = backlight_register_fb(new_bd);
	if (rc) {
		device_unregister(&new_bd->dev);
		return ERR_PTR(rc);
	}

	new_bd->ops = ops;

#ifdef CONFIG_PMAC_BACKLIGHT
	mutex_lock(&pmac_backlight_mutex);
	if (!pmac_backlight)
		pmac_backlight = new_bd;
	mutex_unlock(&pmac_backlight_mutex);
#endif

	return new_bd;
}
EXPORT_SYMBOL(backlight_device_register);

/**
 * backlight_device_unregister - unregisters a backlight device object.
 * @bd: the backlight device object to be unregistered and freed.
 *
 * Unregisters a previously registered via backlight_device_register object.
 */
void backlight_device_unregister(struct backlight_device *bd)
{
	if (!bd)
		return;

#ifdef CONFIG_PMAC_BACKLIGHT
	mutex_lock(&pmac_backlight_mutex);
	if (pmac_backlight == bd)
		pmac_backlight = NULL;
	mutex_unlock(&pmac_backlight_mutex);
#endif
	mutex_lock(&bd->ops_lock);
	bd->ops = NULL;
	mutex_unlock(&bd->ops_lock);

	backlight_unregister_fb(bd);
	device_unregister(&bd->dev);
}
EXPORT_SYMBOL(backlight_device_unregister);

static void __exit backlight_class_exit(void)
{
	class_destroy(backlight_class);
}

static int __init backlight_class_init(void)
{
	backlight_class = class_create(THIS_MODULE, "backlight");
	if (IS_ERR(backlight_class)) {
		printk(KERN_WARNING "Unable to create backlight class; errno = %ld\n",
				PTR_ERR(backlight_class));
		return PTR_ERR(backlight_class);
	}

	backlight_class->dev_attrs = bl_device_attributes;
	return 0;
}

/*
 * 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(backlight_class_init);
module_exit(backlight_class_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Backlight 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/backlight.h>
	12	#include <linux/notifier.h>
	13	#include <linux/ctype.h>
	14	#include <linux/err.h>
	15	#include <linux/fb.h>
1da177e4	16
321709c5 RP	17	#ifdef CONFIG_PMAC_BACKLIGHT
	18	#include <asm/backlight.h>
	19	#endif
3d5eeadd JS	20
	21	#if defined(CONFIG_FB) \|\| (defined(CONFIG_FB_MODULE) && \
	22	defined(CONFIG_BACKLIGHT_CLASS_DEVICE_MODULE))
	23	/* This callback gets called when something important happens inside a
	24	* framebuffer driver. We're looking if that important event is blanking,
	25	* and if it is, we're switching backlight power as well ...
	26	*/
	27	static int fb_notifier_callback(struct notifier_block *self,
	28	unsigned long event, void *data)
	29	{
	30	struct backlight_device *bd;
	31	struct fb_event *evdata = data;
	32
	33	/* If we aren't interested in this event, skip it immediately ... */
994efacd	34	if (event != FB_EVENT_BLANK && event != FB_EVENT_CONBLANK)
3d5eeadd JS	35	return 0;
	36
	37	bd = container_of(self, struct backlight_device, fb_notif);
599a52d1 RP	38	mutex_lock(&bd->ops_lock);
	39	if (bd->ops)
	40	if (!bd->ops->check_fb \|\|
	41	bd->ops->check_fb(evdata->info)) {
	42	bd->props.fb_blank = (int )evdata->data;
28ee086d	43	backlight_update_status(bd);
3d5eeadd	44	}
599a52d1	45	mutex_unlock(&bd->ops_lock);
3d5eeadd JS	46	return 0;
	47	}
	48
	49	static int backlight_register_fb(struct backlight_device *bd)
	50	{
	51	memset(&bd->fb_notif, 0, sizeof(bd->fb_notif));
	52	bd->fb_notif.notifier_call = fb_notifier_callback;
	53
	54	return fb_register_client(&bd->fb_notif);
	55	}
	56
	57	static void backlight_unregister_fb(struct backlight_device *bd)
	58	{
	59	fb_unregister_client(&bd->fb_notif);
	60	}
	61	#else
	62	static inline int backlight_register_fb(struct backlight_device *bd)
	63	{
	64	return 0;
	65	}
	66
	67	static inline void backlight_unregister_fb(struct backlight_device *bd)
	68	{
	69	}
	70	#endif /* CONFIG_FB */
	71
655bfd7a RP	72	static ssize_t backlight_show_power(struct device *dev,
655bfd7a RP	73	struct device_attribute attr,char buf)
1da177e4	74	{
655bfd7a	75	struct backlight_device *bd = to_backlight_device(dev);
1da177e4	76
599a52d1	77	return sprintf(buf, "%d\n", bd->props.power);
1da177e4 LT	78	}
1da177e4 LT	79
655bfd7a RP	80	static ssize_t backlight_store_power(struct device *dev,
655bfd7a RP	81	struct device_attribute attr, const char buf, size_t count)
1da177e4	82	{
68673afd	83	int rc = -ENXIO;
1da177e4	84	char *endp;
655bfd7a	85	struct backlight_device *bd = to_backlight_device(dev);
68673afd RP	86	int power = simple_strtoul(buf, &endp, 0);
68673afd RP	87	size_t size = endp - buf;
1da177e4	88
68673afd RP	89	if (endp && isspace(endp))
	90	size++;
	91	if (size != count)
1da177e4 LT	92	return -EINVAL;
1da177e4 LT	93
599a52d1 RP	94	mutex_lock(&bd->ops_lock);
599a52d1 RP	95	if (bd->ops) {
1da177e4	96	pr_debug("backlight: set power to %d\n", power);
51552453 HD	97	if (bd->props.power != power) {
	98	bd->props.power = power;
	99	backlight_update_status(bd);
	100	}
1da177e4	101	rc = count;
6ca01765	102	}
599a52d1	103	mutex_unlock(&bd->ops_lock);
1da177e4 LT	104
	105	return rc;
	106	}
	107
655bfd7a RP	108	static ssize_t backlight_show_brightness(struct device *dev,
655bfd7a RP	109	struct device_attribute attr, char buf)
1da177e4	110	{
655bfd7a	111	struct backlight_device *bd = to_backlight_device(dev);
1da177e4	112
599a52d1	113	return sprintf(buf, "%d\n", bd->props.brightness);
1da177e4 LT	114	}
1da177e4 LT	115
655bfd7a RP	116	static ssize_t backlight_store_brightness(struct device *dev,
655bfd7a RP	117	struct device_attribute attr, const char buf, size_t count)
1da177e4	118	{
68673afd	119	int rc = -ENXIO;
1da177e4	120	char *endp;
655bfd7a	121	struct backlight_device *bd = to_backlight_device(dev);
68673afd RP	122	int brightness = simple_strtoul(buf, &endp, 0);
68673afd RP	123	size_t size = endp - buf;
1da177e4	124
68673afd RP	125	if (endp && isspace(endp))
	126	size++;
	127	if (size != count)
1da177e4 LT	128	return -EINVAL;
1da177e4 LT	129
599a52d1 RP	130	mutex_lock(&bd->ops_lock);
	131	if (bd->ops) {
	132	if (brightness > bd->props.max_brightness)
6ca01765 RP	133	rc = -EINVAL;
	134	else {
	135	pr_debug("backlight: set brightness to %d\n",
	136	brightness);
51552453 HD	137	if (bd->props.brightness != brightness) {
	138	bd->props.brightness = brightness;
	139	backlight_update_status(bd);
	140	}
6ca01765 RP	141	rc = count;
	142	}
	143	}
599a52d1	144	mutex_unlock(&bd->ops_lock);
1da177e4 LT	145
	146	return rc;
	147	}
	148
655bfd7a RP	149	static ssize_t backlight_show_max_brightness(struct device *dev,
655bfd7a RP	150	struct device_attribute attr, char buf)
1da177e4	151	{
655bfd7a	152	struct backlight_device *bd = to_backlight_device(dev);
1da177e4	153
599a52d1	154	return sprintf(buf, "%d\n", bd->props.max_brightness);
6ca01765 RP	155	}
6ca01765 RP	156
655bfd7a RP	157	static ssize_t backlight_show_actual_brightness(struct device *dev,
655bfd7a RP	158	struct device_attribute attr, char buf)
6ca01765 RP	159	{
6ca01765 RP	160	int rc = -ENXIO;
655bfd7a	161	struct backlight_device *bd = to_backlight_device(dev);
6ca01765	162
599a52d1 RP	163	mutex_lock(&bd->ops_lock);
	164	if (bd->ops && bd->ops->get_brightness)
	165	rc = sprintf(buf, "%d\n", bd->ops->get_brightness(bd));
	166	mutex_unlock(&bd->ops_lock);
1da177e4 LT	167
	168	return rc;
	169	}
	170
0ad90efd	171	static struct class *backlight_class;
655bfd7a RP	172
655bfd7a RP	173	static void bl_device_release(struct device *dev)
1da177e4 LT	174	{
	175	struct backlight_device *bd = to_backlight_device(dev);
	176	kfree(bd);
	177	}
	178
655bfd7a RP	179	static struct device_attribute bl_device_attributes[] = {
	180	__ATTR(bl_power, 0644, backlight_show_power, backlight_store_power),
	181	__ATTR(brightness, 0644, backlight_show_brightness,
6ca01765	182	backlight_store_brightness),
655bfd7a	183	__ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
6ca01765	184	NULL),
655bfd7a RP	185	__ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
655bfd7a RP	186	__ATTR_NULL,
1da177e4 LT	187	};
1da177e4 LT	188
1da177e4 LT	189	/**
	190	* backlight_device_register - create and register a new object of
	191	* backlight_device class.
	192	* @name: the name of the new object(must be the same as the name of the
	193	* respective framebuffer device).
655bfd7a RP	194	* @devdata: an optional pointer to be stored for private driver use. The
655bfd7a RP	195	* methods may retrieve it by using bl_get_data(bd).
599a52d1	196	* @ops: the backlight operations structure.
1da177e4	197	*
655bfd7a	198	* Creates and registers new backlight device. Returns either an
1da177e4 LT	199	* ERR_PTR() or a pointer to the newly allocated device.
1da177e4 LT	200	*/
519ab5f2	201	struct backlight_device backlight_device_register(const char name,
655bfd7a	202	struct device parent, void devdata, struct backlight_ops *ops)
1da177e4	203	{
1da177e4	204	struct backlight_device *new_bd;
655bfd7a	205	int rc;
1da177e4	206
655bfd7a	207	pr_debug("backlight_device_register: name=%s\n", name);
1da177e4	208
599a52d1	209	new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
90968e8e	210	if (!new_bd)
10ad1b73	211	return ERR_PTR(-ENOMEM);
1da177e4	212
28ee086d	213	mutex_init(&new_bd->update_lock);
599a52d1	214	mutex_init(&new_bd->ops_lock);
1da177e4	215
655bfd7a RP	216	new_bd->dev.class = backlight_class;
	217	new_bd->dev.parent = parent;
	218	new_bd->dev.release = bl_device_release;
	219	strlcpy(new_bd->dev.bus_id, name, BUS_ID_SIZE);
	220	dev_set_drvdata(&new_bd->dev, devdata);
	221
	222	rc = device_register(&new_bd->dev);
90968e8e	223	if (rc) {
2fd5a154	224	kfree(new_bd);
1da177e4 LT	225	return ERR_PTR(rc);
	226	}
	227
3d5eeadd	228	rc = backlight_register_fb(new_bd);
2fd5a154	229	if (rc) {
655bfd7a	230	device_unregister(&new_bd->dev);
2fd5a154 DT	231	return ERR_PTR(rc);
	232	}
	233
655bfd7a	234	new_bd->ops = ops;
1da177e4	235
321709c5 RP	236	#ifdef CONFIG_PMAC_BACKLIGHT
	237	mutex_lock(&pmac_backlight_mutex);
	238	if (!pmac_backlight)
	239	pmac_backlight = new_bd;
	240	mutex_unlock(&pmac_backlight_mutex);
	241	#endif
	242
1da177e4 LT	243	return new_bd;
	244	}
	245	EXPORT_SYMBOL(backlight_device_register);
	246
	247	/**
	248	* backlight_device_unregister - unregisters a backlight device object.
	249	* @bd: the backlight device object to be unregistered and freed.
	250	*
	251	* Unregisters a previously registered via backlight_device_register object.
	252	*/
	253	void backlight_device_unregister(struct backlight_device *bd)
	254	{
1da177e4 LT	255	if (!bd)
	256	return;
	257
321709c5 RP	258	#ifdef CONFIG_PMAC_BACKLIGHT
	259	mutex_lock(&pmac_backlight_mutex);
	260	if (pmac_backlight == bd)
	261	pmac_backlight = NULL;
	262	mutex_unlock(&pmac_backlight_mutex);
	263	#endif
599a52d1 RP	264	mutex_lock(&bd->ops_lock);
	265	bd->ops = NULL;
	266	mutex_unlock(&bd->ops_lock);
1da177e4	267
3d5eeadd	268	backlight_unregister_fb(bd);
655bfd7a	269	device_unregister(&bd->dev);
1da177e4 LT	270	}
	271	EXPORT_SYMBOL(backlight_device_unregister);
	272
	273	static void __exit backlight_class_exit(void)
	274	{
655bfd7a	275	class_destroy(backlight_class);
1da177e4 LT	276	}
	277
	278	static int __init backlight_class_init(void)
	279	{
655bfd7a RP	280	backlight_class = class_create(THIS_MODULE, "backlight");
	281	if (IS_ERR(backlight_class)) {
	282	printk(KERN_WARNING "Unable to create backlight class; errno = %ld\n",
	283	PTR_ERR(backlight_class));
	284	return PTR_ERR(backlight_class);
	285	}
	286
	287	backlight_class->dev_attrs = bl_device_attributes;
	288	return 0;
1da177e4 LT	289	}
	290
	291	/*
	292	* if this is compiled into the kernel, we need to ensure that the
	293	* class is registered before users of the class try to register lcd's
	294	*/
	295	postcore_initcall(backlight_class_init);
	296	module_exit(backlight_class_exit);
	297
	298	MODULE_LICENSE("GPL");
	299	MODULE_AUTHOR("Jamey Hicks <jamey.hicks@hp.com>, Andrew Zabolotny <zap@homelink.ru>");
	300	MODULE_DESCRIPTION("Backlight Lowlevel Control Abstraction");