xref: /openbmc/linux/drivers/acpi/x86/utils.c (revision ba46e42e925b5d09b4e441f8de3db119cc7df58f)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * X86 ACPI Utility Functions
4  *
5  * Copyright (C) 2017 Hans de Goede <hdegoede@redhat.com>
6  *
7  * Based on various non upstream patches to support the CHT Whiskey Cove PMIC:
8  * Copyright (C) 2013-2015 Intel Corporation. All rights reserved.
9  */
10 
11 #include <linux/acpi.h>
12 #include <linux/dmi.h>
13 #include <asm/cpu_device_id.h>
14 #include <asm/intel-family.h>
15 #include "../internal.h"
16 
17 /*
18  * Some ACPI devices are hidden (status == 0x0) in recent BIOS-es because
19  * some recent Windows drivers bind to one device but poke at multiple
20  * devices at the same time, so the others get hidden.
21  *
22  * Some BIOS-es (temporarily) hide specific APCI devices to work around Windows
23  * driver bugs. We use DMI matching to match known cases of this.
24  *
25  * Likewise sometimes some not-actually present devices are sometimes
26  * reported as present, which may cause issues.
27  *
28  * We work around this by using the below quirk list to override the status
29  * reported by the _STA method with a fixed value (ACPI_STA_DEFAULT or 0).
30  * Note this MUST only be done for devices where this is safe.
31  *
32  * This status overriding is limited to specific CPU (SoC) models both to
33  * avoid potentially causing trouble on other models and because some HIDs
34  * are re-used on different SoCs for completely different devices.
35  */
36 struct override_status_id {
37 	struct acpi_device_id hid[2];
38 	struct x86_cpu_id cpu_ids[2];
39 	struct dmi_system_id dmi_ids[2]; /* Optional */
40 	const char *uid;
41 	const char *path;
42 	unsigned long long status;
43 };
44 
45 #define ENTRY(status, hid, uid, path, cpu_model, dmi...) {		\
46 	{ { hid, }, {} },						\
47 	{ X86_MATCH_INTEL_FAM6_MODEL(cpu_model, NULL), {} },		\
48 	{ { .matches = dmi }, {} },					\
49 	uid,								\
50 	path,								\
51 	status,								\
52 }
53 
54 #define PRESENT_ENTRY_HID(hid, uid, cpu_model, dmi...) \
55 	ENTRY(ACPI_STA_DEFAULT, hid, uid, NULL, cpu_model, dmi)
56 
57 #define NOT_PRESENT_ENTRY_HID(hid, uid, cpu_model, dmi...) \
58 	ENTRY(0, hid, uid, NULL, cpu_model, dmi)
59 
60 #define PRESENT_ENTRY_PATH(path, cpu_model, dmi...) \
61 	ENTRY(ACPI_STA_DEFAULT, "", NULL, path, cpu_model, dmi)
62 
63 #define NOT_PRESENT_ENTRY_PATH(path, cpu_model, dmi...) \
64 	ENTRY(0, "", NULL, path, cpu_model, dmi)
65 
66 static const struct override_status_id override_status_ids[] = {
67 	/*
68 	 * Bay / Cherry Trail PWM directly poked by GPU driver in win10,
69 	 * but Linux uses a separate PWM driver, harmless if not used.
70 	 */
71 	PRESENT_ENTRY_HID("80860F09", "1", ATOM_SILVERMONT, {}),
72 	PRESENT_ENTRY_HID("80862288", "1", ATOM_AIRMONT, {}),
73 
74 	/*
75 	 * The INT0002 device is necessary to clear wakeup interrupt sources
76 	 * on Cherry Trail devices, without it we get nobody cared IRQ msgs.
77 	 */
78 	PRESENT_ENTRY_HID("INT0002", "1", ATOM_AIRMONT, {}),
79 	/*
80 	 * On the Dell Venue 11 Pro 7130 and 7139, the DSDT hides
81 	 * the touchscreen ACPI device until a certain time
82 	 * after _SB.PCI0.GFX0.LCD.LCD1._ON gets called has passed
83 	 * *and* _STA has been called at least 3 times since.
84 	 */
85 	PRESENT_ENTRY_HID("SYNA7500", "1", HASWELL_L, {
86 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
87 		DMI_MATCH(DMI_PRODUCT_NAME, "Venue 11 Pro 7130"),
88 	      }),
89 	PRESENT_ENTRY_HID("SYNA7500", "1", HASWELL_L, {
90 		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
91 		DMI_MATCH(DMI_PRODUCT_NAME, "Venue 11 Pro 7139"),
92 	      }),
93 
94 	/*
95 	 * The GPD win BIOS dated 20170221 has disabled the accelerometer, the
96 	 * drivers sometimes cause crashes under Windows and this is how the
97 	 * manufacturer has solved this :| Note that the the DMI data is less
98 	 * generic then it seems, a board_vendor of "AMI Corporation" is quite
99 	 * rare and a board_name of "Default String" also is rare.
100 	 *
101 	 * Unfortunately the GPD pocket also uses these strings and its BIOS
102 	 * was copy-pasted from the GPD win, so it has a disabled KIOX000A
103 	 * node which we should not enable, thus we also check the BIOS date.
104 	 */
105 	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
106 		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
107 		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
108 		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
109 		DMI_MATCH(DMI_BIOS_DATE, "02/21/2017")
110 	      }),
111 	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
112 		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
113 		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
114 		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
115 		DMI_MATCH(DMI_BIOS_DATE, "03/20/2017")
116 	      }),
117 	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
118 		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
119 		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
120 		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
121 		DMI_MATCH(DMI_BIOS_DATE, "05/25/2017")
122 	      }),
123 };
124 
125 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status)
126 {
127 	bool ret = false;
128 	unsigned int i;
129 
130 	for (i = 0; i < ARRAY_SIZE(override_status_ids); i++) {
131 		if (!x86_match_cpu(override_status_ids[i].cpu_ids))
132 			continue;
133 
134 		if (override_status_ids[i].dmi_ids[0].matches[0].slot &&
135 		    !dmi_check_system(override_status_ids[i].dmi_ids))
136 			continue;
137 
138 		if (override_status_ids[i].path) {
139 			struct acpi_buffer path = { ACPI_ALLOCATE_BUFFER, NULL };
140 			bool match;
141 
142 			if (acpi_get_name(adev->handle, ACPI_FULL_PATHNAME, &path))
143 				continue;
144 
145 			match = strcmp((char *)path.pointer, override_status_ids[i].path) == 0;
146 			kfree(path.pointer);
147 
148 			if (!match)
149 				continue;
150 		} else {
151 			if (acpi_match_device_ids(adev, override_status_ids[i].hid))
152 				continue;
153 
154 			if (!adev->pnp.unique_id ||
155 			    strcmp(adev->pnp.unique_id, override_status_ids[i].uid))
156 				continue;
157 		}
158 
159 		*status = override_status_ids[i].status;
160 		ret = true;
161 		break;
162 	}
163 
164 	return ret;
165 }
166 
167 /*
168  * AMD systems from Renoir and Lucienne *require* that the NVME controller
169  * is put into D3 over a Modern Standby / suspend-to-idle cycle.
170  *
171  * This is "typically" accomplished using the `StorageD3Enable`
172  * property in the _DSD that is checked via the `acpi_storage_d3` function
173  * but this property was introduced after many of these systems launched
174  * and most OEM systems don't have it in their BIOS.
175  *
176  * The Microsoft documentation for StorageD3Enable mentioned that Windows has
177  * a hardcoded allowlist for D3 support, which was used for these platforms.
178  *
179  * This allows quirking on Linux in a similar fashion.
180  */
181 static const struct x86_cpu_id storage_d3_cpu_ids[] = {
182 	X86_MATCH_VENDOR_FAM_MODEL(AMD, 23, 96, NULL),	/* Renoir */
183 	X86_MATCH_VENDOR_FAM_MODEL(AMD, 23, 104, NULL),	/* Lucienne */
184 	{}
185 };
186 
187 bool force_storage_d3(void)
188 {
189 	return x86_match_cpu(storage_d3_cpu_ids);
190 }
191