GNU Linux-libre 6.9.2-gnu
[releases.git] / include / acpi / video.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __ACPI_VIDEO_H
3 #define __ACPI_VIDEO_H
4
5 #include <linux/errno.h> /* for ENODEV */
6 #include <linux/types.h> /* for bool */
7
8 struct acpi_video_brightness_flags {
9         u8 _BCL_no_ac_battery_levels:1; /* no AC/Battery levels in _BCL */
10         u8 _BCL_reversed:1;             /* _BCL package is in a reversed order */
11         u8 _BQC_use_index:1;            /* _BQC returns an index value */
12 };
13
14 struct acpi_video_device_brightness {
15         int curr;
16         int count;
17         int *levels;
18         struct acpi_video_brightness_flags flags;
19 };
20
21 struct acpi_device;
22
23 #define ACPI_VIDEO_CLASS        "video"
24
25 #define ACPI_VIDEO_DISPLAY_CRT  1
26 #define ACPI_VIDEO_DISPLAY_TV   2
27 #define ACPI_VIDEO_DISPLAY_DVI  3
28 #define ACPI_VIDEO_DISPLAY_LCD  4
29
30 #define ACPI_VIDEO_DISPLAY_LEGACY_MONITOR 0x0100
31 #define ACPI_VIDEO_DISPLAY_LEGACY_PANEL   0x0110
32 #define ACPI_VIDEO_DISPLAY_LEGACY_TV      0x0200
33
34 #define ACPI_VIDEO_NOTIFY_SWITCH                0x80
35 #define ACPI_VIDEO_NOTIFY_PROBE                 0x81
36 #define ACPI_VIDEO_NOTIFY_CYCLE                 0x82
37 #define ACPI_VIDEO_NOTIFY_NEXT_OUTPUT           0x83
38 #define ACPI_VIDEO_NOTIFY_PREV_OUTPUT           0x84
39 #define ACPI_VIDEO_NOTIFY_CYCLE_BRIGHTNESS      0x85
40 #define ACPI_VIDEO_NOTIFY_INC_BRIGHTNESS        0x86
41 #define ACPI_VIDEO_NOTIFY_DEC_BRIGHTNESS        0x87
42 #define ACPI_VIDEO_NOTIFY_ZERO_BRIGHTNESS       0x88
43 #define ACPI_VIDEO_NOTIFY_DISPLAY_OFF           0x89
44
45 enum acpi_backlight_type {
46         acpi_backlight_undef = -1,
47         acpi_backlight_none = 0,
48         acpi_backlight_video,
49         acpi_backlight_vendor,
50         acpi_backlight_native,
51         acpi_backlight_nvidia_wmi_ec,
52         acpi_backlight_apple_gmux,
53 };
54
55 #if IS_ENABLED(CONFIG_ACPI_VIDEO)
56 extern int acpi_video_register(void);
57 extern void acpi_video_unregister(void);
58 extern void acpi_video_register_backlight(void);
59 extern int acpi_video_get_edid(struct acpi_device *device, int type,
60                                int device_id, void **edid);
61 /*
62  * Note: The value returned by acpi_video_handles_brightness_key_presses()
63  * may change over time and should not be cached.
64  */
65 extern bool acpi_video_handles_brightness_key_presses(void);
66 extern int acpi_video_get_levels(struct acpi_device *device,
67                                  struct acpi_video_device_brightness **dev_br,
68                                  int *pmax_level);
69
70 extern enum acpi_backlight_type __acpi_video_get_backlight_type(bool native,
71                                                                 bool *auto_detect);
72
73 static inline enum acpi_backlight_type acpi_video_get_backlight_type(void)
74 {
75         return __acpi_video_get_backlight_type(false, NULL);
76 }
77
78 /*
79  * This function MUST only be called by GPU drivers to check if the driver
80  * should register a backlight class device. This function not only checks
81  * if a GPU native backlight device should be registered it *also* tells
82  * the ACPI video-detect code that native GPU backlight control is available.
83  * Therefor calling this from any place other then the GPU driver is wrong!
84  * To check if GPU native backlight control is used in other places instead use:
85  *   if (acpi_video_get_backlight_type() == acpi_backlight_native) { ... }
86  */
87 static inline bool acpi_video_backlight_use_native(void)
88 {
89         return __acpi_video_get_backlight_type(true, NULL) == acpi_backlight_native;
90 }
91 #else
92 static inline int acpi_video_register(void) { return -ENODEV; }
93 static inline void acpi_video_unregister(void) { return; }
94 static inline void acpi_video_register_backlight(void) { return; }
95 static inline int acpi_video_get_edid(struct acpi_device *device, int type,
96                                       int device_id, void **edid)
97 {
98         return -ENODEV;
99 }
100 static inline enum acpi_backlight_type acpi_video_get_backlight_type(void)
101 {
102         return acpi_backlight_vendor;
103 }
104 static inline bool acpi_video_backlight_use_native(void)
105 {
106         return true;
107 }
108 static inline bool acpi_video_handles_brightness_key_presses(void)
109 {
110         return false;
111 }
112 static inline int acpi_video_get_levels(struct acpi_device *device,
113                         struct acpi_video_device_brightness **dev_br,
114                         int *pmax_level)
115 {
116         return -ENODEV;
117 }
118 #endif
119
120 #endif