Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | * Backlight Lowlevel Control Abstraction | |
4 | * | |
5 | * Copyright (C) 2003,2004 Hewlett-Packard Company | |
6 | * | |
7 | */ | |
8 | ||
9 | #ifndef _LINUX_BACKLIGHT_H | |
10 | #define _LINUX_BACKLIGHT_H | |
11 | ||
12 | #include <linux/device.h> | |
a55944ca | 13 | #include <linux/fb.h> |
28ee086d | 14 | #include <linux/mutex.h> |
1da177e4 LT |
15 | #include <linux/notifier.h> |
16 | ||
28ee086d RP |
17 | /* Notes on locking: |
18 | * | |
599a52d1 RP |
19 | * backlight_device->ops_lock is an internal backlight lock protecting the |
20 | * ops pointer and no code outside the core should need to touch it. | |
28ee086d RP |
21 | * |
22 | * Access to update_status() is serialised by the update_lock mutex since | |
23 | * most drivers seem to need this and historically get it wrong. | |
24 | * | |
25 | * Most drivers don't need locking on their get_brightness() method. | |
26 | * If yours does, you need to implement it in the driver. You can use the | |
27 | * update_lock mutex if appropriate. | |
28 | * | |
29 | * Any other use of the locks below is probably wrong. | |
30 | */ | |
31 | ||
325253a6 MG |
32 | enum backlight_update_reason { |
33 | BACKLIGHT_UPDATE_HOTKEY, | |
34 | BACKLIGHT_UPDATE_SYSFS, | |
35 | }; | |
36 | ||
bb7ca747 MG |
37 | enum backlight_type { |
38 | BACKLIGHT_RAW = 1, | |
39 | BACKLIGHT_PLATFORM, | |
40 | BACKLIGHT_FIRMWARE, | |
41 | BACKLIGHT_TYPE_MAX, | |
42 | }; | |
43 | ||
3cc6919b HG |
44 | enum backlight_notification { |
45 | BACKLIGHT_REGISTERED, | |
46 | BACKLIGHT_UNREGISTERED, | |
47 | }; | |
48 | ||
1da177e4 LT |
49 | struct backlight_device; |
50 | struct fb_info; | |
51 | ||
599a52d1 | 52 | struct backlight_ops { |
b4144e4f | 53 | unsigned int options; |
c835ee7f RP |
54 | |
55 | #define BL_CORE_SUSPENDRESUME (1 << 0) | |
56 | ||
6ca01765 | 57 | /* Notify the backlight driver some property has changed */ |
b4144e4f | 58 | int (*update_status)(struct backlight_device *); |
6ca01765 RP |
59 | /* Return the current backlight brightness (accounting for power, |
60 | fb_blank etc.) */ | |
b4144e4f | 61 | int (*get_brightness)(struct backlight_device *); |
1da177e4 LT |
62 | /* Check if given framebuffer device is the one bound to this backlight; |
63 | return 0 if not, !=0 if it is. If NULL, backlight always matches the fb. */ | |
57e148b6 | 64 | int (*check_fb)(struct backlight_device *, struct fb_info *); |
599a52d1 | 65 | }; |
6ca01765 | 66 | |
599a52d1 RP |
67 | /* This structure defines all the properties of a backlight */ |
68 | struct backlight_properties { | |
6ca01765 RP |
69 | /* Current User requested brightness (0 - max_brightness) */ |
70 | int brightness; | |
71 | /* Maximal value for brightness (read-only) */ | |
72 | int max_brightness; | |
73 | /* Current FB Power mode (0: full on, 1..3: power saving | |
74 | modes; 4: full off), see FB_BLANK_XXX */ | |
75 | int power; | |
76 | /* FB Blanking active? (values as for power) */ | |
c835ee7f | 77 | /* Due to be removed, please use (state & BL_CORE_FBBLANK) */ |
6ca01765 | 78 | int fb_blank; |
bb7ca747 MG |
79 | /* Backlight type */ |
80 | enum backlight_type type; | |
c835ee7f | 81 | /* Flags used to signal drivers of state changes */ |
c835ee7f RP |
82 | unsigned int state; |
83 | ||
84 | #define BL_CORE_SUSPENDED (1 << 0) /* backlight is suspended */ | |
85 | #define BL_CORE_FBBLANK (1 << 1) /* backlight is under an fb blank event */ | |
c835ee7f | 86 | |
1da177e4 LT |
87 | }; |
88 | ||
89 | struct backlight_device { | |
599a52d1 RP |
90 | /* Backlight properties */ |
91 | struct backlight_properties props; | |
92 | ||
28ee086d RP |
93 | /* Serialise access to update_status method */ |
94 | struct mutex update_lock; | |
599a52d1 RP |
95 | |
96 | /* This protects the 'ops' field. If 'ops' is NULL, the driver that | |
97 | registered this device has been unloaded, and if class_get_devdata() | |
98 | points to something in the body of that driver, it is also invalid. */ | |
99 | struct mutex ops_lock; | |
9905a43b | 100 | const struct backlight_ops *ops; |
599a52d1 | 101 | |
1da177e4 LT |
102 | /* The framebuffer notifier block */ |
103 | struct notifier_block fb_notif; | |
655bfd7a | 104 | |
5915a3db AL |
105 | /* list entry of all registered backlight devices */ |
106 | struct list_head entry; | |
107 | ||
655bfd7a | 108 | struct device dev; |
a55944ca LY |
109 | |
110 | /* Multiple framebuffers may share one backlight device */ | |
111 | bool fb_bl_on[FB_MAX]; | |
112 | ||
113 | int use_count; | |
1da177e4 LT |
114 | }; |
115 | ||
cca0ba2d | 116 | static inline int backlight_update_status(struct backlight_device *bd) |
28ee086d | 117 | { |
cca0ba2d HH |
118 | int ret = -ENOENT; |
119 | ||
28ee086d | 120 | mutex_lock(&bd->update_lock); |
599a52d1 | 121 | if (bd->ops && bd->ops->update_status) |
cca0ba2d | 122 | ret = bd->ops->update_status(bd); |
28ee086d | 123 | mutex_unlock(&bd->update_lock); |
cca0ba2d HH |
124 | |
125 | return ret; | |
28ee086d RP |
126 | } |
127 | ||
5b698be0 MM |
128 | /** |
129 | * backlight_enable - Enable backlight | |
130 | * @bd: the backlight device to enable | |
131 | */ | |
132 | static inline int backlight_enable(struct backlight_device *bd) | |
133 | { | |
134 | if (!bd) | |
135 | return 0; | |
136 | ||
137 | bd->props.power = FB_BLANK_UNBLANK; | |
138 | bd->props.fb_blank = FB_BLANK_UNBLANK; | |
139 | bd->props.state &= ~BL_CORE_FBBLANK; | |
140 | ||
141 | return backlight_update_status(bd); | |
142 | } | |
143 | ||
144 | /** | |
145 | * backlight_disable - Disable backlight | |
146 | * @bd: the backlight device to disable | |
147 | */ | |
148 | static inline int backlight_disable(struct backlight_device *bd) | |
149 | { | |
150 | if (!bd) | |
151 | return 0; | |
152 | ||
153 | bd->props.power = FB_BLANK_POWERDOWN; | |
154 | bd->props.fb_blank = FB_BLANK_POWERDOWN; | |
155 | bd->props.state |= BL_CORE_FBBLANK; | |
156 | ||
157 | return backlight_update_status(bd); | |
158 | } | |
159 | ||
c2adda27 MM |
160 | /** |
161 | * backlight_put - Drop backlight reference | |
162 | * @bd: the backlight device to put | |
163 | */ | |
164 | static inline void backlight_put(struct backlight_device *bd) | |
165 | { | |
166 | if (bd) | |
167 | put_device(&bd->dev); | |
168 | } | |
169 | ||
1da177e4 | 170 | extern struct backlight_device *backlight_device_register(const char *name, |
a19a6ee6 MG |
171 | struct device *dev, void *devdata, const struct backlight_ops *ops, |
172 | const struct backlight_properties *props); | |
8318fde4 JH |
173 | extern struct backlight_device *devm_backlight_device_register( |
174 | struct device *dev, const char *name, struct device *parent, | |
175 | void *devdata, const struct backlight_ops *ops, | |
176 | const struct backlight_properties *props); | |
1da177e4 | 177 | extern void backlight_device_unregister(struct backlight_device *bd); |
8318fde4 JH |
178 | extern void devm_backlight_device_unregister(struct device *dev, |
179 | struct backlight_device *bd); | |
325253a6 MG |
180 | extern void backlight_force_update(struct backlight_device *bd, |
181 | enum backlight_update_reason reason); | |
3cc6919b HG |
182 | extern int backlight_register_notifier(struct notifier_block *nb); |
183 | extern int backlight_unregister_notifier(struct notifier_block *nb); | |
f6a4790a AL |
184 | extern struct backlight_device *backlight_device_get_by_type(enum backlight_type type); |
185 | extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned long brightness); | |
1da177e4 | 186 | |
655bfd7a RP |
187 | #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev) |
188 | ||
189 | static inline void * bl_get_data(struct backlight_device *bl_dev) | |
190 | { | |
191 | return dev_get_drvdata(&bl_dev->dev); | |
192 | } | |
1da177e4 | 193 | |
c3f8f650 RP |
194 | struct generic_bl_info { |
195 | const char *name; | |
196 | int max_intensity; | |
197 | int default_intensity; | |
198 | int limit_mask; | |
199 | void (*set_bl_intensity)(int intensity); | |
200 | void (*kick_battery)(void); | |
201 | }; | |
202 | ||
762a936f TR |
203 | #ifdef CONFIG_OF |
204 | struct backlight_device *of_find_backlight_by_node(struct device_node *node); | |
205 | #else | |
206 | static inline struct backlight_device * | |
207 | of_find_backlight_by_node(struct device_node *node) | |
208 | { | |
209 | return NULL; | |
210 | } | |
211 | #endif | |
212 | ||
c2adda27 MM |
213 | #if IS_ENABLED(CONFIG_BACKLIGHT_CLASS_DEVICE) |
214 | struct backlight_device *of_find_backlight(struct device *dev); | |
2e4ef334 | 215 | struct backlight_device *devm_of_find_backlight(struct device *dev); |
c2adda27 MM |
216 | #else |
217 | static inline struct backlight_device *of_find_backlight(struct device *dev) | |
218 | { | |
219 | return NULL; | |
220 | } | |
2e4ef334 MM |
221 | |
222 | static inline struct backlight_device * | |
223 | devm_of_find_backlight(struct device *dev) | |
224 | { | |
225 | return NULL; | |
226 | } | |
c2adda27 MM |
227 | #endif |
228 | ||
1da177e4 | 229 | #endif |