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

#ifndef _LINUX_BACKLIGHT_H
#define _LINUX_BACKLIGHT_H

#include <linux/device.h>
12
#include <linux/mutex.h>
Linus Torvalds's avatar
Linus Torvalds committed
13 14
#include <linux/notifier.h>

15 16
/* Notes on locking:
 *
17 18
 * backlight_device->ops_lock is an internal backlight lock protecting the
 * ops pointer and no code outside the core should need to touch it.
19 20 21 22 23 24 25 26 27 28 29
 *
 * Access to update_status() is serialised by the update_lock mutex since
 * most drivers seem to need this and historically get it wrong.
 *
 * Most drivers don't need locking on their get_brightness() method.
 * If yours does, you need to implement it in the driver. You can use the
 * update_lock mutex if appropriate.
 *
 * Any other use of the locks below is probably wrong.
 */

Linus Torvalds's avatar
Linus Torvalds committed
30 31 32
struct backlight_device;
struct fb_info;

33
struct backlight_ops {
34 35 36 37
	/* Notify the backlight driver some property has changed */
	int (*update_status)(struct backlight_device *);
	/* Return the current backlight brightness (accounting for power,
	   fb_blank etc.) */
Linus Torvalds's avatar
Linus Torvalds committed
38 39 40 41
	int (*get_brightness)(struct backlight_device *);
	/* Check if given framebuffer device is the one bound to this backlight;
	   return 0 if not, !=0 if it is. If NULL, backlight always matches the fb. */
	int (*check_fb)(struct fb_info *);
42
};
43

44 45
/* This structure defines all the properties of a backlight */
struct backlight_properties {
46 47 48 49 50 51 52 53 54
	/* Current User requested brightness (0 - max_brightness) */
	int brightness;
	/* Maximal value for brightness (read-only) */
	int max_brightness;
	/* Current FB Power mode (0: full on, 1..3: power saving
	   modes; 4: full off), see FB_BLANK_XXX */
	int power;
	/* FB Blanking active? (values as for power) */
	int fb_blank;
Linus Torvalds's avatar
Linus Torvalds committed
55 56 57
};

struct backlight_device {
58 59 60
	/* Backlight properties */
	struct backlight_properties props;

61 62
	/* Serialise access to update_status method */
	struct mutex update_lock;
63 64 65 66 67 68 69

	/* This protects the 'ops' field. If 'ops' is NULL, the driver that
	   registered this device has been unloaded, and if class_get_devdata()
	   points to something in the body of that driver, it is also invalid. */
	struct mutex ops_lock;
	struct backlight_ops *ops;

Linus Torvalds's avatar
Linus Torvalds committed
70 71 72 73 74 75
	/* The framebuffer notifier block */
	struct notifier_block fb_notif;
	/* The class device structure */
	struct class_device class_dev;
};

76 77 78
static inline void backlight_update_status(struct backlight_device *bd)
{
	mutex_lock(&bd->update_lock);
79 80
	if (bd->ops && bd->ops->update_status)
		bd->ops->update_status(bd);
81 82 83
	mutex_unlock(&bd->update_lock);
}

Linus Torvalds's avatar
Linus Torvalds committed
84
extern struct backlight_device *backlight_device_register(const char *name,
85
	struct device *dev, void *devdata, struct backlight_ops *ops);
Linus Torvalds's avatar
Linus Torvalds committed
86 87 88 89 90
extern void backlight_device_unregister(struct backlight_device *bd);

#define to_backlight_device(obj) container_of(obj, struct backlight_device, class_dev)

#endif