Blame view
include/linux/backlight.h
5.14 KB
1da177e4c
|
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> |
a55944ca8
|
12 |
#include <linux/fb.h> |
28ee086d5
|
13 |
#include <linux/mutex.h> |
1da177e4c
|
14 |
#include <linux/notifier.h> |
28ee086d5
|
15 16 |
/* Notes on locking: * |
599a52d12
|
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. |
28ee086d5
|
19 20 21 22 23 24 25 26 27 28 |
* * 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. */ |
325253a6b
|
29 30 31 32 |
enum backlight_update_reason { BACKLIGHT_UPDATE_HOTKEY, BACKLIGHT_UPDATE_SYSFS, }; |
bb7ca747f
|
33 34 35 36 37 38 |
enum backlight_type { BACKLIGHT_RAW = 1, BACKLIGHT_PLATFORM, BACKLIGHT_FIRMWARE, BACKLIGHT_TYPE_MAX, }; |
3cc6919bd
|
39 40 41 42 |
enum backlight_notification { BACKLIGHT_REGISTERED, BACKLIGHT_UNREGISTERED, }; |
1da177e4c
|
43 44 |
struct backlight_device; struct fb_info; |
599a52d12
|
45 |
struct backlight_ops { |
b4144e4f6
|
46 |
unsigned int options; |
c835ee7f4
|
47 48 |
#define BL_CORE_SUSPENDRESUME (1 << 0) |
6ca017658
|
49 |
/* Notify the backlight driver some property has changed */ |
b4144e4f6
|
50 |
int (*update_status)(struct backlight_device *); |
6ca017658
|
51 52 |
/* Return the current backlight brightness (accounting for power, fb_blank etc.) */ |
b4144e4f6
|
53 |
int (*get_brightness)(struct backlight_device *); |
1da177e4c
|
54 55 |
/* 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. */ |
57e148b6a
|
56 |
int (*check_fb)(struct backlight_device *, struct fb_info *); |
599a52d12
|
57 |
}; |
6ca017658
|
58 |
|
599a52d12
|
59 60 |
/* This structure defines all the properties of a backlight */ struct backlight_properties { |
6ca017658
|
61 62 63 64 65 66 67 68 |
/* 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) */ |
c835ee7f4
|
69 |
/* Due to be removed, please use (state & BL_CORE_FBBLANK) */ |
6ca017658
|
70 |
int fb_blank; |
bb7ca747f
|
71 72 |
/* Backlight type */ enum backlight_type type; |
c835ee7f4
|
73 74 75 76 77 78 79 80 81 82 |
/* Flags used to signal drivers of state changes */ /* Upper 4 bits are reserved for driver internal use */ unsigned int state; #define BL_CORE_SUSPENDED (1 << 0) /* backlight is suspended */ #define BL_CORE_FBBLANK (1 << 1) /* backlight is under an fb blank event */ #define BL_CORE_DRIVER4 (1 << 28) /* reserved for driver specific use */ #define BL_CORE_DRIVER3 (1 << 29) /* reserved for driver specific use */ #define BL_CORE_DRIVER2 (1 << 30) /* reserved for driver specific use */ #define BL_CORE_DRIVER1 (1 << 31) /* reserved for driver specific use */ |
1da177e4c
|
83 84 85 |
}; struct backlight_device { |
599a52d12
|
86 87 |
/* Backlight properties */ struct backlight_properties props; |
28ee086d5
|
88 89 |
/* Serialise access to update_status method */ struct mutex update_lock; |
599a52d12
|
90 91 92 93 94 |
/* 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; |
9905a43b2
|
95 |
const struct backlight_ops *ops; |
599a52d12
|
96 |
|
1da177e4c
|
97 98 |
/* The framebuffer notifier block */ struct notifier_block fb_notif; |
655bfd7ae
|
99 |
|
5915a3db0
|
100 101 |
/* list entry of all registered backlight devices */ struct list_head entry; |
655bfd7ae
|
102 |
struct device dev; |
a55944ca8
|
103 104 105 106 107 |
/* Multiple framebuffers may share one backlight device */ bool fb_bl_on[FB_MAX]; int use_count; |
1da177e4c
|
108 |
}; |
cca0ba2df
|
109 |
static inline int backlight_update_status(struct backlight_device *bd) |
28ee086d5
|
110 |
{ |
cca0ba2df
|
111 |
int ret = -ENOENT; |
28ee086d5
|
112 |
mutex_lock(&bd->update_lock); |
599a52d12
|
113 |
if (bd->ops && bd->ops->update_status) |
cca0ba2df
|
114 |
ret = bd->ops->update_status(bd); |
28ee086d5
|
115 |
mutex_unlock(&bd->update_lock); |
cca0ba2df
|
116 117 |
return ret; |
28ee086d5
|
118 |
} |
1da177e4c
|
119 |
extern struct backlight_device *backlight_device_register(const char *name, |
a19a6ee6c
|
120 121 |
struct device *dev, void *devdata, const struct backlight_ops *ops, const struct backlight_properties *props); |
8318fde4a
|
122 123 124 125 |
extern struct backlight_device *devm_backlight_device_register( struct device *dev, const char *name, struct device *parent, void *devdata, const struct backlight_ops *ops, const struct backlight_properties *props); |
1da177e4c
|
126 |
extern void backlight_device_unregister(struct backlight_device *bd); |
8318fde4a
|
127 128 |
extern void devm_backlight_device_unregister(struct device *dev, struct backlight_device *bd); |
325253a6b
|
129 130 |
extern void backlight_force_update(struct backlight_device *bd, enum backlight_update_reason reason); |
5915a3db0
|
131 |
extern bool backlight_device_registered(enum backlight_type type); |
3cc6919bd
|
132 133 |
extern int backlight_register_notifier(struct notifier_block *nb); extern int backlight_unregister_notifier(struct notifier_block *nb); |
1da177e4c
|
134 |
|
655bfd7ae
|
135 136 137 138 139 140 |
#define to_backlight_device(obj) container_of(obj, struct backlight_device, dev) static inline void * bl_get_data(struct backlight_device *bl_dev) { return dev_get_drvdata(&bl_dev->dev); } |
1da177e4c
|
141 |
|
c3f8f6504
|
142 143 144 145 146 147 148 149 |
struct generic_bl_info { const char *name; int max_intensity; int default_intensity; int limit_mask; void (*set_bl_intensity)(int intensity); void (*kick_battery)(void); }; |
762a936fb
|
150 151 152 153 154 155 156 157 158 |
#ifdef CONFIG_OF struct backlight_device *of_find_backlight_by_node(struct device_node *node); #else static inline struct backlight_device * of_find_backlight_by_node(struct device_node *node) { return NULL; } #endif |
1da177e4c
|
159 |
#endif |