xref: /openbmc/linux/drivers/acpi/video_detect.c (revision c6b2f240)
1 /*
2  *  Copyright (C) 2015       Red Hat Inc.
3  *                           Hans de Goede <hdegoede@redhat.com>
4  *  Copyright (C) 2008       SuSE Linux Products GmbH
5  *                           Thomas Renninger <trenn@suse.de>
6  *
7  *  May be copied or modified under the terms of the GNU General Public License
8  *
9  * video_detect.c:
10  * After PCI devices are glued with ACPI devices
11  * acpi_get_pci_dev() can be called to identify ACPI graphics
12  * devices for which a real graphics card is plugged in
13  *
14  * Depending on whether ACPI graphics extensions (cmp. ACPI spec Appendix B)
15  * are available, video.ko should be used to handle the device.
16  *
17  * Otherwise vendor specific drivers like thinkpad_acpi, asus-laptop,
18  * sony_acpi,... can take care about backlight brightness.
19  *
20  * Backlight drivers can use acpi_video_get_backlight_type() to determine
21  * which driver should handle the backlight.
22  *
23  * If CONFIG_ACPI_VIDEO is neither set as "compiled in" (y) nor as a module (m)
24  * this file will not be compiled and acpi_video_get_backlight_type() will
25  * always return acpi_backlight_vendor.
26  */
27 
28 #include <linux/export.h>
29 #include <linux/acpi.h>
30 #include <linux/backlight.h>
31 #include <linux/dmi.h>
32 #include <linux/module.h>
33 #include <linux/pci.h>
34 #include <linux/types.h>
35 #include <linux/workqueue.h>
36 #include <acpi/video.h>
37 
38 void acpi_video_unregister_backlight(void);
39 
40 static bool backlight_notifier_registered;
41 static struct notifier_block backlight_nb;
42 static struct work_struct backlight_notify_work;
43 
44 static enum acpi_backlight_type acpi_backlight_cmdline = acpi_backlight_undef;
45 static enum acpi_backlight_type acpi_backlight_dmi = acpi_backlight_undef;
46 
47 static void acpi_video_parse_cmdline(void)
48 {
49 	if (!strcmp("vendor", acpi_video_backlight_string))
50 		acpi_backlight_cmdline = acpi_backlight_vendor;
51 	if (!strcmp("video", acpi_video_backlight_string))
52 		acpi_backlight_cmdline = acpi_backlight_video;
53 	if (!strcmp("native", acpi_video_backlight_string))
54 		acpi_backlight_cmdline = acpi_backlight_native;
55 	if (!strcmp("none", acpi_video_backlight_string))
56 		acpi_backlight_cmdline = acpi_backlight_none;
57 }
58 
59 static acpi_status
60 find_video(acpi_handle handle, u32 lvl, void *context, void **rv)
61 {
62 	long *cap = context;
63 	struct pci_dev *dev;
64 	struct acpi_device *acpi_dev;
65 
66 	static const struct acpi_device_id video_ids[] = {
67 		{ACPI_VIDEO_HID, 0},
68 		{"", 0},
69 	};
70 	if (acpi_bus_get_device(handle, &acpi_dev))
71 		return AE_OK;
72 
73 	if (!acpi_match_device_ids(acpi_dev, video_ids)) {
74 		dev = acpi_get_pci_dev(handle);
75 		if (!dev)
76 			return AE_OK;
77 		pci_dev_put(dev);
78 		*cap |= acpi_is_video_device(handle);
79 	}
80 	return AE_OK;
81 }
82 
83 /* Force to use vendor driver when the ACPI device is known to be
84  * buggy */
85 static int video_detect_force_vendor(const struct dmi_system_id *d)
86 {
87 	acpi_backlight_dmi = acpi_backlight_vendor;
88 	return 0;
89 }
90 
91 static int video_detect_force_video(const struct dmi_system_id *d)
92 {
93 	acpi_backlight_dmi = acpi_backlight_video;
94 	return 0;
95 }
96 
97 static int video_detect_force_native(const struct dmi_system_id *d)
98 {
99 	acpi_backlight_dmi = acpi_backlight_native;
100 	return 0;
101 }
102 
103 static int video_detect_force_none(const struct dmi_system_id *d)
104 {
105 	acpi_backlight_dmi = acpi_backlight_none;
106 	return 0;
107 }
108 
109 static const struct dmi_system_id video_detect_dmi_table[] = {
110 	/* On Samsung X360, the BIOS will set a flag (VDRV) if generic
111 	 * ACPI backlight device is used. This flag will definitively break
112 	 * the backlight interface (even the vendor interface) until next
113 	 * reboot. It's why we should prevent video.ko from being used here
114 	 * and we can't rely on a later call to acpi_video_unregister().
115 	 */
116 	{
117 	 .callback = video_detect_force_vendor,
118 	 .ident = "X360",
119 	 .matches = {
120 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
121 		DMI_MATCH(DMI_PRODUCT_NAME, "X360"),
122 		DMI_MATCH(DMI_BOARD_NAME, "X360"),
123 		},
124 	},
125 	{
126 	.callback = video_detect_force_vendor,
127 	.ident = "Asus UL30VT",
128 	.matches = {
129 		DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
130 		DMI_MATCH(DMI_PRODUCT_NAME, "UL30VT"),
131 		},
132 	},
133 	{
134 	.callback = video_detect_force_vendor,
135 	.ident = "Asus UL30A",
136 	.matches = {
137 		DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
138 		DMI_MATCH(DMI_PRODUCT_NAME, "UL30A"),
139 		},
140 	},
141 	{
142 	.callback = video_detect_force_vendor,
143 	.ident = "GIGABYTE GB-BXBT-2807",
144 	.matches = {
145 		DMI_MATCH(DMI_SYS_VENDOR, "GIGABYTE"),
146 		DMI_MATCH(DMI_PRODUCT_NAME, "GB-BXBT-2807"),
147 		},
148 	},
149 	{
150 	.ident = "Sony VPCEH3U1E",
151 	.matches = {
152 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
153 		DMI_MATCH(DMI_PRODUCT_NAME, "VPCEH3U1E"),
154 		},
155 	},
156 
157 	/*
158 	 * These models have a working acpi_video backlight control, and using
159 	 * native backlight causes a regression where backlight does not work
160 	 * when userspace is not handling brightness key events. Disable
161 	 * native_backlight on these to fix this:
162 	 * https://bugzilla.kernel.org/show_bug.cgi?id=81691
163 	 */
164 	{
165 	 .callback = video_detect_force_video,
166 	 .ident = "ThinkPad T420",
167 	 .matches = {
168 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
169 		DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad T420"),
170 		},
171 	},
172 	{
173 	 .callback = video_detect_force_video,
174 	 .ident = "ThinkPad T520",
175 	 .matches = {
176 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
177 		DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad T520"),
178 		},
179 	},
180 	{
181 	 .callback = video_detect_force_video,
182 	 .ident = "ThinkPad X201s",
183 	 .matches = {
184 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
185 		DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad X201s"),
186 		},
187 	},
188 	{
189 	 .callback = video_detect_force_video,
190 	 .ident = "ThinkPad X201T",
191 	 .matches = {
192 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
193 		DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad X201T"),
194 		},
195 	},
196 
197 	/* The native backlight controls do not work on some older machines */
198 	{
199 	 /* https://bugs.freedesktop.org/show_bug.cgi?id=81515 */
200 	 .callback = video_detect_force_video,
201 	 .ident = "HP ENVY 15 Notebook",
202 	 .matches = {
203 		DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
204 		DMI_MATCH(DMI_PRODUCT_NAME, "HP ENVY 15 Notebook PC"),
205 		},
206 	},
207 	{
208 	 .callback = video_detect_force_video,
209 	 .ident = "SAMSUNG 870Z5E/880Z5E/680Z5E",
210 	 .matches = {
211 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
212 		DMI_MATCH(DMI_PRODUCT_NAME, "870Z5E/880Z5E/680Z5E"),
213 		},
214 	},
215 	{
216 	 .callback = video_detect_force_video,
217 	 .ident = "SAMSUNG 370R4E/370R4V/370R5E/3570RE/370R5V",
218 	 .matches = {
219 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
220 		DMI_MATCH(DMI_PRODUCT_NAME,
221 			  "370R4E/370R4V/370R5E/3570RE/370R5V"),
222 		},
223 	},
224 	{
225 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1186097 */
226 	 .callback = video_detect_force_video,
227 	 .ident = "SAMSUNG 3570R/370R/470R/450R/510R/4450RV",
228 	 .matches = {
229 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
230 		DMI_MATCH(DMI_PRODUCT_NAME,
231 			  "3570R/370R/470R/450R/510R/4450RV"),
232 		},
233 	},
234 	{
235 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1557060 */
236 	 .callback = video_detect_force_video,
237 	 .ident = "SAMSUNG 670Z5E",
238 	 .matches = {
239 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
240 		DMI_MATCH(DMI_PRODUCT_NAME, "670Z5E"),
241 		},
242 	},
243 	{
244 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1094948 */
245 	 .callback = video_detect_force_video,
246 	 .ident = "SAMSUNG 730U3E/740U3E",
247 	 .matches = {
248 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
249 		DMI_MATCH(DMI_PRODUCT_NAME, "730U3E/740U3E"),
250 		},
251 	},
252 	{
253 	 /* https://bugs.freedesktop.org/show_bug.cgi?id=87286 */
254 	 .callback = video_detect_force_video,
255 	 .ident = "SAMSUNG 900X3C/900X3D/900X3E/900X4C/900X4D",
256 	 .matches = {
257 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
258 		DMI_MATCH(DMI_PRODUCT_NAME,
259 			  "900X3C/900X3D/900X3E/900X4C/900X4D"),
260 		},
261 	},
262 	{
263 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1272633 */
264 	 .callback = video_detect_force_video,
265 	 .ident = "Dell XPS14 L421X",
266 	 .matches = {
267 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
268 		DMI_MATCH(DMI_PRODUCT_NAME, "XPS L421X"),
269 		},
270 	},
271 	{
272 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1163574 */
273 	 .callback = video_detect_force_video,
274 	 .ident = "Dell XPS15 L521X",
275 	 .matches = {
276 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
277 		DMI_MATCH(DMI_PRODUCT_NAME, "XPS L521X"),
278 		},
279 	},
280 	{
281 	 /* https://bugzilla.kernel.org/show_bug.cgi?id=108971 */
282 	 .callback = video_detect_force_video,
283 	 .ident = "SAMSUNG 530U4E/540U4E",
284 	 .matches = {
285 		DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
286 		DMI_MATCH(DMI_PRODUCT_NAME, "530U4E/540U4E"),
287 		},
288 	},
289 	/* https://bugs.launchpad.net/bugs/1894667 */
290 	{
291 	 .callback = video_detect_force_video,
292 	 .ident = "HP 635 Notebook",
293 	 .matches = {
294 		DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
295 		DMI_MATCH(DMI_PRODUCT_NAME, "HP 635 Notebook PC"),
296 		},
297 	},
298 
299 	/* Non win8 machines which need native backlight nevertheless */
300 	{
301 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1201530 */
302 	 .callback = video_detect_force_native,
303 	 .ident = "Lenovo Ideapad S405",
304 	 .matches = {
305 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
306 		DMI_MATCH(DMI_BOARD_NAME, "Lenovo IdeaPad S405"),
307 		},
308 	},
309 	{
310 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1187004 */
311 	 .callback = video_detect_force_native,
312 	 .ident = "Lenovo Ideapad Z570",
313 	 .matches = {
314 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
315 		DMI_MATCH(DMI_PRODUCT_NAME, "102434U"),
316 		},
317 	},
318 	{
319 	 .callback = video_detect_force_native,
320 	 .ident = "Lenovo E41-25",
321 	 .matches = {
322 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
323 		DMI_MATCH(DMI_PRODUCT_NAME, "81FS"),
324 		},
325 	},
326 	{
327 	 .callback = video_detect_force_native,
328 	 .ident = "Lenovo E41-45",
329 	 .matches = {
330 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
331 		DMI_MATCH(DMI_PRODUCT_NAME, "82BK"),
332 		},
333 	},
334 	{
335 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1217249 */
336 	 .callback = video_detect_force_native,
337 	 .ident = "Apple MacBook Pro 12,1",
338 	 .matches = {
339 		DMI_MATCH(DMI_SYS_VENDOR, "Apple Inc."),
340 		DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro12,1"),
341 		},
342 	},
343 	{
344 	 .callback = video_detect_force_native,
345 	 .ident = "Dell Vostro V131",
346 	 .matches = {
347 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
348 		DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
349 		},
350 	},
351 	{
352 	 /* https://bugzilla.redhat.com/show_bug.cgi?id=1123661 */
353 	 .callback = video_detect_force_native,
354 	 .ident = "Dell XPS 17 L702X",
355 	 .matches = {
356 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
357 		DMI_MATCH(DMI_PRODUCT_NAME, "Dell System XPS L702X"),
358 		},
359 	},
360 	{
361 	 .callback = video_detect_force_native,
362 	 .ident = "Dell Precision 7510",
363 	 .matches = {
364 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
365 		DMI_MATCH(DMI_PRODUCT_NAME, "Precision 7510"),
366 		},
367 	},
368 	{
369 	 .callback = video_detect_force_native,
370 	 .ident = "Acer Aspire 5738z",
371 	 .matches = {
372 		DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
373 		DMI_MATCH(DMI_PRODUCT_NAME, "Aspire 5738"),
374 		DMI_MATCH(DMI_BOARD_NAME, "JV50"),
375 		},
376 	},
377 	{
378 	 /* https://bugzilla.kernel.org/show_bug.cgi?id=207835 */
379 	 .callback = video_detect_force_native,
380 	 .ident = "Acer TravelMate 5735Z",
381 	 .matches = {
382 		DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
383 		DMI_MATCH(DMI_PRODUCT_NAME, "TravelMate 5735Z"),
384 		DMI_MATCH(DMI_BOARD_NAME, "BA51_MV"),
385 		},
386 	},
387 
388 	/*
389 	 * Desktops which falsely report a backlight and which our heuristics
390 	 * for this do not catch.
391 	 */
392 	{
393 	 .callback = video_detect_force_none,
394 	 .ident = "Dell OptiPlex 9020M",
395 	 .matches = {
396 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
397 		DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex 9020M"),
398 		},
399 	},
400 	{
401 	 .callback = video_detect_force_none,
402 	 .ident = "MSI MS-7721",
403 	 .matches = {
404 		DMI_MATCH(DMI_SYS_VENDOR, "MSI"),
405 		DMI_MATCH(DMI_PRODUCT_NAME, "MS-7721"),
406 		},
407 	},
408 	{ },
409 };
410 
411 /* This uses a workqueue to avoid various locking ordering issues */
412 static void acpi_video_backlight_notify_work(struct work_struct *work)
413 {
414 	if (acpi_video_get_backlight_type() != acpi_backlight_video)
415 		acpi_video_unregister_backlight();
416 }
417 
418 static int acpi_video_backlight_notify(struct notifier_block *nb,
419 				       unsigned long val, void *bd)
420 {
421 	struct backlight_device *backlight = bd;
422 
423 	/* A raw bl registering may change video -> native */
424 	if (backlight->props.type == BACKLIGHT_RAW &&
425 	    val == BACKLIGHT_REGISTERED)
426 		schedule_work(&backlight_notify_work);
427 
428 	return NOTIFY_OK;
429 }
430 
431 /*
432  * Determine which type of backlight interface to use on this system,
433  * First check cmdline, then dmi quirks, then do autodetect.
434  *
435  * The autodetect order is:
436  * 1) Is the acpi-video backlight interface supported ->
437  *  no, use a vendor interface
438  * 2) Is this a win8 "ready" BIOS and do we have a native interface ->
439  *  yes, use a native interface
440  * 3) Else use the acpi-video interface
441  *
442  * Arguably the native on win8 check should be done first, but that would
443  * be a behavior change, which may causes issues.
444  */
445 enum acpi_backlight_type acpi_video_get_backlight_type(void)
446 {
447 	static DEFINE_MUTEX(init_mutex);
448 	static bool init_done;
449 	static long video_caps;
450 
451 	/* Parse cmdline, dmi and acpi only once */
452 	mutex_lock(&init_mutex);
453 	if (!init_done) {
454 		acpi_video_parse_cmdline();
455 		dmi_check_system(video_detect_dmi_table);
456 		acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
457 				    ACPI_UINT32_MAX, find_video, NULL,
458 				    &video_caps, NULL);
459 		INIT_WORK(&backlight_notify_work,
460 			  acpi_video_backlight_notify_work);
461 		backlight_nb.notifier_call = acpi_video_backlight_notify;
462 		backlight_nb.priority = 0;
463 		if (backlight_register_notifier(&backlight_nb) == 0)
464 			backlight_notifier_registered = true;
465 		init_done = true;
466 	}
467 	mutex_unlock(&init_mutex);
468 
469 	if (acpi_backlight_cmdline != acpi_backlight_undef)
470 		return acpi_backlight_cmdline;
471 
472 	if (acpi_backlight_dmi != acpi_backlight_undef)
473 		return acpi_backlight_dmi;
474 
475 	if (!(video_caps & ACPI_VIDEO_BACKLIGHT))
476 		return acpi_backlight_vendor;
477 
478 	if (acpi_osi_is_win8() && backlight_device_get_by_type(BACKLIGHT_RAW))
479 		return acpi_backlight_native;
480 
481 	return acpi_backlight_video;
482 }
483 EXPORT_SYMBOL(acpi_video_get_backlight_type);
484 
485 /*
486  * Set the preferred backlight interface type based on DMI info.
487  * This function allows DMI blacklists to be implemented by external
488  * platform drivers instead of putting a big blacklist in video_detect.c
489  */
490 void acpi_video_set_dmi_backlight_type(enum acpi_backlight_type type)
491 {
492 	acpi_backlight_dmi = type;
493 	/* Remove acpi-video backlight interface if it is no longer desired */
494 	if (acpi_video_get_backlight_type() != acpi_backlight_video)
495 		acpi_video_unregister_backlight();
496 }
497 EXPORT_SYMBOL(acpi_video_set_dmi_backlight_type);
498 
499 void __exit acpi_video_detect_exit(void)
500 {
501 	if (backlight_notifier_registered)
502 		backlight_unregister_notifier(&backlight_nb);
503 }
504