backlight.c 11.1 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7
/*
 * Backlight Lowlevel Control Abstraction
 *
 * Copyright (C) 2003,2004 Hewlett-Packard Company
 *
 */

8 9
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

Linus Torvalds's avatar
Linus Torvalds committed
10 11 12 13 14 15 16 17
#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>
18
#include <linux/slab.h>
Linus Torvalds's avatar
Linus Torvalds committed
19

20 21 22
#ifdef CONFIG_PMAC_BACKLIGHT
#include <asm/backlight.h>
#endif
23

24
static const char *const backlight_types[] = {
25 26 27 28 29
	[BACKLIGHT_RAW] = "raw",
	[BACKLIGHT_PLATFORM] = "platform",
	[BACKLIGHT_FIRMWARE] = "firmware",
};

30 31 32 33 34 35 36 37 38 39 40 41 42
#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 ... */
43
	if (event != FB_EVENT_BLANK && event != FB_EVENT_CONBLANK)
44 45 46
		return 0;

	bd = container_of(self, struct backlight_device, fb_notif);
47 48 49
	mutex_lock(&bd->ops_lock);
	if (bd->ops)
		if (!bd->ops->check_fb ||
50
		    bd->ops->check_fb(bd, evdata->info)) {
51
			bd->props.fb_blank = *(int *)evdata->data;
52 53 54 55
			if (bd->props.fb_blank == FB_BLANK_UNBLANK)
				bd->props.state &= ~BL_CORE_FBBLANK;
			else
				bd->props.state |= BL_CORE_FBBLANK;
56
			backlight_update_status(bd);
57
		}
58
	mutex_unlock(&bd->ops_lock);
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
	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 */

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
static void backlight_generate_event(struct backlight_device *bd,
				     enum backlight_update_reason reason)
{
	char *envp[2];

	switch (reason) {
	case BACKLIGHT_UPDATE_SYSFS:
		envp[0] = "SOURCE=sysfs";
		break;
	case BACKLIGHT_UPDATE_HOTKEY:
		envp[0] = "SOURCE=hotkey";
		break;
	default:
		envp[0] = "SOURCE=unknown";
		break;
	}
	envp[1] = NULL;
	kobject_uevent_env(&bd->dev.kobj, KOBJ_CHANGE, envp);
103
	sysfs_notify(&bd->dev.kobj, NULL, "actual_brightness");
104 105
}

106
static ssize_t backlight_show_power(struct device *dev,
Jingoo Han's avatar
Jingoo Han committed
107
		struct device_attribute *attr, char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
108
{
109
	struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds's avatar
Linus Torvalds committed
110

111
	return sprintf(buf, "%d\n", bd->props.power);
Linus Torvalds's avatar
Linus Torvalds committed
112 113
}

114 115
static ssize_t backlight_store_power(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
116
{
117
	int rc;
118
	struct backlight_device *bd = to_backlight_device(dev);
119
	unsigned long power;
Linus Torvalds's avatar
Linus Torvalds committed
120

Jingoo Han's avatar
Jingoo Han committed
121
	rc = kstrtoul(buf, 0, &power);
122 123
	if (rc)
		return rc;
Linus Torvalds's avatar
Linus Torvalds committed
124

125
	rc = -ENXIO;
126 127
	mutex_lock(&bd->ops_lock);
	if (bd->ops) {
128
		pr_debug("set power to %lu\n", power);
129 130 131 132
		if (bd->props.power != power) {
			bd->props.power = power;
			backlight_update_status(bd);
		}
Linus Torvalds's avatar
Linus Torvalds committed
133
		rc = count;
134
	}
135
	mutex_unlock(&bd->ops_lock);
Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139

	return rc;
}

140 141
static ssize_t backlight_show_brightness(struct device *dev,
		struct device_attribute *attr, char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
142
{
143
	struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds's avatar
Linus Torvalds committed
144

145
	return sprintf(buf, "%d\n", bd->props.brightness);
Linus Torvalds's avatar
Linus Torvalds committed
146 147
}

148 149
static ssize_t backlight_store_brightness(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
150
{
151
	int rc;
152
	struct backlight_device *bd = to_backlight_device(dev);
153
	unsigned long brightness;
Linus Torvalds's avatar
Linus Torvalds committed
154

Jingoo Han's avatar
Jingoo Han committed
155
	rc = kstrtoul(buf, 0, &brightness);
156 157 158 159
	if (rc)
		return rc;

	rc = -ENXIO;
Linus Torvalds's avatar
Linus Torvalds committed
160

161 162 163
	mutex_lock(&bd->ops_lock);
	if (bd->ops) {
		if (brightness > bd->props.max_brightness)
164 165
			rc = -EINVAL;
		else {
166
			pr_debug("set brightness to %lu\n", brightness);
167 168
			bd->props.brightness = brightness;
			backlight_update_status(bd);
169 170 171
			rc = count;
		}
	}
172
	mutex_unlock(&bd->ops_lock);
Linus Torvalds's avatar
Linus Torvalds committed
173

174 175
	backlight_generate_event(bd, BACKLIGHT_UPDATE_SYSFS);

Linus Torvalds's avatar
Linus Torvalds committed
176 177 178
	return rc;
}

179 180 181 182 183 184 185 186
static ssize_t backlight_show_type(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct backlight_device *bd = to_backlight_device(dev);

	return sprintf(buf, "%s\n", backlight_types[bd->props.type]);
}

187 188
static ssize_t backlight_show_max_brightness(struct device *dev,
		struct device_attribute *attr, char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
189
{
190
	struct backlight_device *bd = to_backlight_device(dev);
Linus Torvalds's avatar
Linus Torvalds committed
191

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

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

201 202 203 204
	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);
Linus Torvalds's avatar
Linus Torvalds committed
205 206 207 208

	return rc;
}

209
static struct class *backlight_class;
210

211 212 213 214
static int backlight_suspend(struct device *dev, pm_message_t state)
{
	struct backlight_device *bd = to_backlight_device(dev);

215 216
	mutex_lock(&bd->ops_lock);
	if (bd->ops && bd->ops->options & BL_CORE_SUSPENDRESUME) {
217 218 219
		bd->props.state |= BL_CORE_SUSPENDED;
		backlight_update_status(bd);
	}
220
	mutex_unlock(&bd->ops_lock);
221 222 223 224 225 226 227 228

	return 0;
}

static int backlight_resume(struct device *dev)
{
	struct backlight_device *bd = to_backlight_device(dev);

229 230
	mutex_lock(&bd->ops_lock);
	if (bd->ops && bd->ops->options & BL_CORE_SUSPENDRESUME) {
231 232 233
		bd->props.state &= ~BL_CORE_SUSPENDED;
		backlight_update_status(bd);
	}
234
	mutex_unlock(&bd->ops_lock);
235 236 237 238

	return 0;
}

239
static void bl_device_release(struct device *dev)
Linus Torvalds's avatar
Linus Torvalds committed
240 241 242 243 244
{
	struct backlight_device *bd = to_backlight_device(dev);
	kfree(bd);
}

245 246 247
static struct device_attribute bl_device_attributes[] = {
	__ATTR(bl_power, 0644, backlight_show_power, backlight_store_power),
	__ATTR(brightness, 0644, backlight_show_brightness,
248
		     backlight_store_brightness),
249
	__ATTR(actual_brightness, 0444, backlight_show_actual_brightness,
250
		     NULL),
251
	__ATTR(max_brightness, 0444, backlight_show_max_brightness, NULL),
252
	__ATTR(type, 0444, backlight_show_type, NULL),
253
	__ATTR_NULL,
Linus Torvalds's avatar
Linus Torvalds committed
254 255
};

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
/**
 * backlight_force_update - tell the backlight subsystem that hardware state
 *   has changed
 * @bd: the backlight device to update
 *
 * Updates the internal state of the backlight in response to a hardware event,
 * and generate a uevent to notify userspace
 */
void backlight_force_update(struct backlight_device *bd,
			    enum backlight_update_reason reason)
{
	mutex_lock(&bd->ops_lock);
	if (bd->ops && bd->ops->get_brightness)
		bd->props.brightness = bd->ops->get_brightness(bd);
	mutex_unlock(&bd->ops_lock);
	backlight_generate_event(bd, reason);
}
EXPORT_SYMBOL(backlight_force_update);

Linus Torvalds's avatar
Linus Torvalds committed
275 276 277 278 279
/**
 * 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).
280
 * @parent: a pointer to the parent device
281 282
 * @devdata: an optional pointer to be stored for private driver use. The
 *   methods may retrieve it by using bl_get_data(bd).
283
 * @ops: the backlight operations structure.
Linus Torvalds's avatar
Linus Torvalds committed
284
 *
285
 * Creates and registers new backlight device. Returns either an
Linus Torvalds's avatar
Linus Torvalds committed
286 287
 * ERR_PTR() or a pointer to the newly allocated device.
 */
288
struct backlight_device *backlight_device_register(const char *name,
289 290
	struct device *parent, void *devdata, const struct backlight_ops *ops,
	const struct backlight_properties *props)
Linus Torvalds's avatar
Linus Torvalds committed
291 292
{
	struct backlight_device *new_bd;
293
	int rc;
Linus Torvalds's avatar
Linus Torvalds committed
294

295
	pr_debug("backlight_device_register: name=%s\n", name);
Linus Torvalds's avatar
Linus Torvalds committed
296

297
	new_bd = kzalloc(sizeof(struct backlight_device), GFP_KERNEL);
298
	if (!new_bd)
299
		return ERR_PTR(-ENOMEM);
Linus Torvalds's avatar
Linus Torvalds committed
300

301
	mutex_init(&new_bd->update_lock);
302
	mutex_init(&new_bd->ops_lock);
Linus Torvalds's avatar
Linus Torvalds committed
303

304 305 306
	new_bd->dev.class = backlight_class;
	new_bd->dev.parent = parent;
	new_bd->dev.release = bl_device_release;
307
	dev_set_name(&new_bd->dev, "%s", name);
308 309
	dev_set_drvdata(&new_bd->dev, devdata);

310
	/* Set default properties */
311
	if (props) {
312 313
		memcpy(&new_bd->props, props,
		       sizeof(struct backlight_properties));
314 315 316 317 318 319 320
		if (props->type <= 0 || props->type >= BACKLIGHT_TYPE_MAX) {
			WARN(1, "%s: invalid backlight type", name);
			new_bd->props.type = BACKLIGHT_RAW;
		}
	} else {
		new_bd->props.type = BACKLIGHT_RAW;
	}
321

322
	rc = device_register(&new_bd->dev);
323
	if (rc) {
324
		kfree(new_bd);
Linus Torvalds's avatar
Linus Torvalds committed
325 326 327
		return ERR_PTR(rc);
	}

328
	rc = backlight_register_fb(new_bd);
329
	if (rc) {
330
		device_unregister(&new_bd->dev);
331 332 333
		return ERR_PTR(rc);
	}

334
	new_bd->ops = ops;
Linus Torvalds's avatar
Linus Torvalds committed
335

336 337 338 339 340 341 342
#ifdef CONFIG_PMAC_BACKLIGHT
	mutex_lock(&pmac_backlight_mutex);
	if (!pmac_backlight)
		pmac_backlight = new_bd;
	mutex_unlock(&pmac_backlight_mutex);
#endif

Linus Torvalds's avatar
Linus Torvalds committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
	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;

358 359 360 361 362 363
#ifdef CONFIG_PMAC_BACKLIGHT
	mutex_lock(&pmac_backlight_mutex);
	if (pmac_backlight == bd)
		pmac_backlight = NULL;
	mutex_unlock(&pmac_backlight_mutex);
#endif
364 365 366
	mutex_lock(&bd->ops_lock);
	bd->ops = NULL;
	mutex_unlock(&bd->ops_lock);
Linus Torvalds's avatar
Linus Torvalds committed
367

368
	backlight_unregister_fb(bd);
369
	device_unregister(&bd->dev);
Linus Torvalds's avatar
Linus Torvalds committed
370 371 372
}
EXPORT_SYMBOL(backlight_device_unregister);

373
#ifdef CONFIG_OF
374
static int of_parent_match(struct device *dev, const void *data)
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
{
	return dev->parent && dev->parent->of_node == data;
}

/**
 * of_find_backlight_by_node() - find backlight device by device-tree node
 * @node: device-tree node of the backlight device
 *
 * Returns a pointer to the backlight device corresponding to the given DT
 * node or NULL if no such backlight device exists or if the device hasn't
 * been probed yet.
 *
 * This function obtains a reference on the backlight device and it is the
 * caller's responsibility to drop the reference by calling put_device() on
 * the backlight device's .dev field.
 */
struct backlight_device *of_find_backlight_by_node(struct device_node *node)
{
	struct device *dev;

	dev = class_find_device(backlight_class, NULL, node, of_parent_match);

	return dev ? to_backlight_device(dev) : NULL;
}
EXPORT_SYMBOL(of_find_backlight_by_node);
#endif

Linus Torvalds's avatar
Linus Torvalds committed
402 403
static void __exit backlight_class_exit(void)
{
404
	class_destroy(backlight_class);
Linus Torvalds's avatar
Linus Torvalds committed
405 406 407 408
}

static int __init backlight_class_init(void)
{
409 410
	backlight_class = class_create(THIS_MODULE, "backlight");
	if (IS_ERR(backlight_class)) {
411 412
		pr_warn("Unable to create backlight class; errno = %ld\n",
			PTR_ERR(backlight_class));
413 414 415 416
		return PTR_ERR(backlight_class);
	}

	backlight_class->dev_attrs = bl_device_attributes;
417 418
	backlight_class->suspend = backlight_suspend;
	backlight_class->resume = backlight_resume;
419
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
420 421 422 423 424 425 426 427 428 429 430 431
}

/*
 * 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");