xref: /freebsd/sys/compat/linuxkpi/common/include/linux/backlight.h (revision 6ba2210ee039f2f12878c217bcf058e9c8b26b29)
1 /*-
2  * Copyright (c) 2020 The FreeBSD Foundation
3  *
4  * This software was developed by Emmanuel Vadot under sponsorship
5  * from the FreeBSD Foundation.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _LINUX_BACKLIGHT_H_
32 #define _LINUX_BACKLIGHT_H_
33 
34 #include <linux/notifier.h>
35 
36 struct backlight_device;
37 
38 enum backlight_type {
39 	BACKLIGHT_RAW = 0,
40 };
41 
42 struct backlight_properties {
43 	int type;
44 	int max_brightness;
45 	int brightness;
46 	int power;
47 };
48 
49 enum backlight_notification {
50 	BACKLIGHT_REGISTERED,
51 	BACKLIGHT_UNREGISTERED,
52 };
53 
54 enum backlight_update_reason {
55 	BACKLIGHT_UPDATE_HOTKEY = 0
56 };
57 
58 struct backlight_ops {
59 	int options;
60 #define	BL_CORE_SUSPENDRESUME   1
61 	int (*update_status)(struct backlight_device *);
62 	int (*get_brightness)(struct backlight_device *);
63 };
64 
65 struct backlight_device {
66 	const struct backlight_ops *ops;
67 	struct backlight_properties props;
68 	void *data;
69 	struct device *dev;
70 	char *name;
71 };
72 
73 #define bl_get_data(bd) (bd)->data
74 
75 struct backlight_device *linux_backlight_device_register(const char *name,
76     struct device *dev, void *data, const struct backlight_ops *ops, struct backlight_properties *props);
77 void linux_backlight_device_unregister(struct backlight_device *bd);
78 #define	backlight_device_register(name, dev, data, ops, props)	\
79 	linux_backlight_device_register(name, dev, data, ops, props)
80 #define	backlight_device_unregister(bd)	linux_backlight_device_unregister(bd)
81 
82 static inline int
83 backlight_update_status(struct backlight_device *bd)
84 {
85 	return (bd->ops->update_status(bd));
86 }
87 
88 static inline void
89 backlight_force_update(struct backlight_device *bd, int reason)
90 {
91 	bd->props.brightness = bd->ops->get_brightness(bd);
92 }
93 
94 static inline int
95 backlight_enable(struct backlight_device *bd)
96 {
97 	if (bd == NULL)
98 		return (0);
99 	bd->props.power = 0/* FB_BLANK_UNBLANK */;
100 	return (backlight_update_status(bd));
101 }
102 
103 static inline int
104 backlight_disable(struct backlight_device *bd)
105 {
106 	if (bd == NULL)
107 		return (0);
108 	bd->props.power = 4/* FB_BLANK_POWERDOWN */;
109 	return (backlight_update_status(bd));
110 }
111 
112 #endif	/* _LINUX_BACKLIGHT_H_ */
113