Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
  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#define pr_fmt(fmt) "ACPI: " fmt
 12
 13#include <linux/acpi.h>
 14#include <linux/dmi.h>
 15#include <linux/platform_device.h>
 16#include <asm/cpu_device_id.h>
 17#include <asm/intel-family.h>
 18#include "../internal.h"
 19
 20/*
 21 * Some ACPI devices are hidden (status == 0x0) in recent BIOS-es because
 22 * some recent Windows drivers bind to one device but poke at multiple
 23 * devices at the same time, so the others get hidden.
 24 *
 25 * Some BIOS-es (temporarily) hide specific APCI devices to work around Windows
 26 * driver bugs. We use DMI matching to match known cases of this.
 27 *
 28 * Likewise sometimes some not-actually present devices are sometimes
 29 * reported as present, which may cause issues.
 30 *
 31 * We work around this by using the below quirk list to override the status
 32 * reported by the _STA method with a fixed value (ACPI_STA_DEFAULT or 0).
 33 * Note this MUST only be done for devices where this is safe.
 34 *
 35 * This status overriding is limited to specific CPU (SoC) models both to
 36 * avoid potentially causing trouble on other models and because some HIDs
 37 * are re-used on different SoCs for completely different devices.
 38 */
 39struct override_status_id {
 40	struct acpi_device_id hid[2];
 41	struct x86_cpu_id cpu_ids[2];
 42	struct dmi_system_id dmi_ids[2]; /* Optional */
 43	const char *uid;
 44	const char *path;
 45	unsigned long long status;
 46};
 47
 48#define ENTRY(status, hid, uid, path, cpu_model, dmi...) {		\
 49	{ { hid, }, {} },						\
 50	{ X86_MATCH_INTEL_FAM6_MODEL(cpu_model, NULL), {} },		\
 51	{ { .matches = dmi }, {} },					\
 52	uid,								\
 53	path,								\
 54	status,								\
 55}
 56
 57#define PRESENT_ENTRY_HID(hid, uid, cpu_model, dmi...) \
 58	ENTRY(ACPI_STA_DEFAULT, hid, uid, NULL, cpu_model, dmi)
 59
 60#define NOT_PRESENT_ENTRY_HID(hid, uid, cpu_model, dmi...) \
 61	ENTRY(0, hid, uid, NULL, cpu_model, dmi)
 62
 63#define PRESENT_ENTRY_PATH(path, cpu_model, dmi...) \
 64	ENTRY(ACPI_STA_DEFAULT, "", NULL, path, cpu_model, dmi)
 65
 66#define NOT_PRESENT_ENTRY_PATH(path, cpu_model, dmi...) \
 67	ENTRY(0, "", NULL, path, cpu_model, dmi)
 68
 69static const struct override_status_id override_status_ids[] = {
 70	/*
 71	 * Bay / Cherry Trail PWM directly poked by GPU driver in win10,
 72	 * but Linux uses a separate PWM driver, harmless if not used.
 73	 */
 74	PRESENT_ENTRY_HID("80860F09", "1", ATOM_SILVERMONT, {}),
 75	PRESENT_ENTRY_HID("80862288", "1", ATOM_AIRMONT, {}),
 76
 77	/* The Xiaomi Mi Pad 2 uses PWM2 for touchkeys backlight control */
 78	PRESENT_ENTRY_HID("80862289", "2", ATOM_AIRMONT, {
 79		DMI_MATCH(DMI_SYS_VENDOR, "Xiaomi Inc"),
 80		DMI_MATCH(DMI_PRODUCT_NAME, "Mipad2"),
 81	      }),
 82
 83	/*
 84	 * The INT0002 device is necessary to clear wakeup interrupt sources
 85	 * on Cherry Trail devices, without it we get nobody cared IRQ msgs.
 86	 */
 87	PRESENT_ENTRY_HID("INT0002", "1", ATOM_AIRMONT, {}),
 88	/*
 89	 * On the Dell Venue 11 Pro 7130 and 7139, the DSDT hides
 90	 * the touchscreen ACPI device until a certain time
 91	 * after _SB.PCI0.GFX0.LCD.LCD1._ON gets called has passed
 92	 * *and* _STA has been called at least 3 times since.
 93	 */
 94	PRESENT_ENTRY_HID("SYNA7500", "1", HASWELL_L, {
 95		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 96		DMI_MATCH(DMI_PRODUCT_NAME, "Venue 11 Pro 7130"),
 97	      }),
 98	PRESENT_ENTRY_HID("SYNA7500", "1", HASWELL_L, {
 99		DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
100		DMI_MATCH(DMI_PRODUCT_NAME, "Venue 11 Pro 7139"),
101	      }),
102
103	/*
104	 * The GPD win BIOS dated 20170221 has disabled the accelerometer, the
105	 * drivers sometimes cause crashes under Windows and this is how the
106	 * manufacturer has solved this :|  The DMI match may not seem unique,
107	 * but it is. In the 67000+ DMI decode dumps from linux-hardware.org
108	 * only 116 have board_vendor set to "AMI Corporation" and of those 116
109	 * only the GPD win and pocket entries' board_name is "Default string".
110	 *
111	 * Unfortunately the GPD pocket also uses these strings and its BIOS
112	 * was copy-pasted from the GPD win, so it has a disabled KIOX000A
113	 * node which we should not enable, thus we also check the BIOS date.
114	 */
115	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
116		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
117		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
118		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
119		DMI_MATCH(DMI_BIOS_DATE, "02/21/2017")
120	      }),
121	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
122		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
123		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
124		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
125		DMI_MATCH(DMI_BIOS_DATE, "03/20/2017")
126	      }),
127	PRESENT_ENTRY_HID("KIOX000A", "1", ATOM_AIRMONT, {
128		DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
129		DMI_MATCH(DMI_BOARD_NAME, "Default string"),
130		DMI_MATCH(DMI_PRODUCT_NAME, "Default string"),
131		DMI_MATCH(DMI_BIOS_DATE, "05/25/2017")
132	      }),
133
134	/*
135	 * The GPD win/pocket have a PCI wifi card, but its DSDT has the SDIO
136	 * mmc controller enabled and that has a child-device which _PS3
137	 * method sets a GPIO causing the PCI wifi card to turn off.
138	 * See above remark about uniqueness of the DMI match.
139	 */
140	NOT_PRESENT_ENTRY_PATH("\\_SB_.PCI0.SDHB.BRC1", ATOM_AIRMONT, {
141		DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
142		DMI_EXACT_MATCH(DMI_BOARD_NAME, "Default string"),
143		DMI_EXACT_MATCH(DMI_BOARD_SERIAL, "Default string"),
144		DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Default string"),
145	      }),
146};
147
148bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status)
149{
150	bool ret = false;
151	unsigned int i;
152
153	for (i = 0; i < ARRAY_SIZE(override_status_ids); i++) {
154		if (!x86_match_cpu(override_status_ids[i].cpu_ids))
155			continue;
156
157		if (override_status_ids[i].dmi_ids[0].matches[0].slot &&
158		    !dmi_check_system(override_status_ids[i].dmi_ids))
159			continue;
160
161		if (override_status_ids[i].path) {
162			struct acpi_buffer path = { ACPI_ALLOCATE_BUFFER, NULL };
163			bool match;
164
165			if (acpi_get_name(adev->handle, ACPI_FULL_PATHNAME, &path))
166				continue;
167
168			match = strcmp((char *)path.pointer, override_status_ids[i].path) == 0;
169			kfree(path.pointer);
170
171			if (!match)
172				continue;
173		} else {
174			if (acpi_match_device_ids(adev, override_status_ids[i].hid))
175				continue;
176
177			if (!adev->pnp.unique_id ||
178			    strcmp(adev->pnp.unique_id, override_status_ids[i].uid))
179				continue;
180		}
181
182		*status = override_status_ids[i].status;
183		ret = true;
184		break;
185	}
186
187	return ret;
188}
189
190/*
191 * AMD systems from Renoir and Lucienne *require* that the NVME controller
192 * is put into D3 over a Modern Standby / suspend-to-idle cycle.
193 *
194 * This is "typically" accomplished using the `StorageD3Enable`
195 * property in the _DSD that is checked via the `acpi_storage_d3` function
196 * but this property was introduced after many of these systems launched
197 * and most OEM systems don't have it in their BIOS.
198 *
199 * The Microsoft documentation for StorageD3Enable mentioned that Windows has
200 * a hardcoded allowlist for D3 support, which was used for these platforms.
201 *
202 * This allows quirking on Linux in a similar fashion.
203 */
204static const struct x86_cpu_id storage_d3_cpu_ids[] = {
205	X86_MATCH_VENDOR_FAM_MODEL(AMD, 23, 96, NULL),	/* Renoir */
206	X86_MATCH_VENDOR_FAM_MODEL(AMD, 23, 104, NULL),	/* Lucienne */
207	{}
208};
209
210static const struct dmi_system_id force_storage_d3_dmi[] = {
211	{
212		/*
213		 * _ADR is ambiguous between GPP1.DEV0 and GPP1.NVME
214		 * but .NVME is needed to get StorageD3Enable node
215		 * https://bugzilla.kernel.org/show_bug.cgi?id=216440
216		 */
217		.matches = {
218			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
219			DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 14 7425 2-in-1"),
220		}
221	},
222	{
223		.matches = {
224			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
225			DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 16 5625"),
226		}
227	},
228	{}
229};
230
231bool force_storage_d3(void)
232{
233	const struct dmi_system_id *dmi_id = dmi_first_match(force_storage_d3_dmi);
234
235	return dmi_id || x86_match_cpu(storage_d3_cpu_ids);
236}
237
238/*
239 * x86 ACPI boards which ship with only Android as their factory image usually
240 * declare a whole bunch of bogus I2C devices in their ACPI tables and sometimes
241 * there are issues with serdev devices on these boards too, e.g. the resource
242 * points to the wrong serdev_controller.
243 *
244 * Instantiating I2C / serdev devs for these bogus devs causes various issues,
245 * e.g. GPIO/IRQ resource conflicts because sometimes drivers do bind to them.
246 * The Android x86 kernel fork shipped on these devices has some special code
247 * to remove the bogus I2C clients (and AFAICT serdevs are ignored completely).
248 *
249 * The acpi_quirk_skip_*_enumeration() functions below are used by the I2C or
250 * serdev code to skip instantiating any I2C or serdev devs on broken boards.
251 *
252 * In case of I2C an exception is made for HIDs on the i2c_acpi_known_good_ids
253 * list. These are known to always be correct (and in case of the audio-codecs
254 * the drivers heavily rely on the codec being enumerated through ACPI).
255 *
256 * Note these boards typically do actually have I2C and serdev devices,
257 * just different ones then the ones described in their DSDT. The devices
258 * which are actually present are manually instantiated by the
259 * drivers/platform/x86/x86-android-tablets.c kernel module.
260 */
261#define ACPI_QUIRK_SKIP_I2C_CLIENTS				BIT(0)
262#define ACPI_QUIRK_UART1_TTY_UART2_SKIP				BIT(1)
263#define ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY			BIT(2)
264#define ACPI_QUIRK_USE_ACPI_AC_AND_BATTERY			BIT(3)
265
266static const struct dmi_system_id acpi_quirk_skip_dmi_ids[] = {
267	/*
268	 * 1. Devices with only the skip / don't-skip AC and battery quirks,
269	 *    sorted alphabetically.
270	 */
271	{
272		/* ECS EF20EA, AXP288 PMIC but uses separate fuel-gauge */
273		.matches = {
274			DMI_MATCH(DMI_PRODUCT_NAME, "EF20EA"),
275		},
276		.driver_data = (void *)ACPI_QUIRK_USE_ACPI_AC_AND_BATTERY
277	},
278	{
279		/* Lenovo Ideapad Miix 320, AXP288 PMIC, separate fuel-gauge */
280		.matches = {
281			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
282			DMI_MATCH(DMI_PRODUCT_NAME, "80XF"),
283			DMI_MATCH(DMI_PRODUCT_VERSION, "Lenovo MIIX 320-10ICR"),
284		},
285		.driver_data = (void *)ACPI_QUIRK_USE_ACPI_AC_AND_BATTERY
286	},
287
288	/*
289	 * 2. Devices which also have the skip i2c/serdev quirks and which
290	 *    need the x86-android-tablets module to properly work.
291	 */
292#if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
293	{
294		.matches = {
295			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
296			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "ME176C"),
297		},
298		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
299					ACPI_QUIRK_UART1_TTY_UART2_SKIP |
300					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
301	},
302	{
303		.matches = {
304			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
305			DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
306		},
307		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
308					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
309	},
310	{
311		/* Lenovo Yoga Tablet 2 1050F/L */
312		.matches = {
313			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corp."),
314			DMI_MATCH(DMI_PRODUCT_NAME, "VALLEYVIEW C0 PLATFORM"),
315			DMI_MATCH(DMI_BOARD_NAME, "BYT-T FFD8"),
316			/* Partial match on beginning of BIOS version */
317			DMI_MATCH(DMI_BIOS_VERSION, "BLADE_21"),
318		},
319		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
320					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
321	},
322	{
323		/* Lenovo Yoga Tab 3 Pro X90F */
324		.matches = {
325			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
326			DMI_MATCH(DMI_PRODUCT_NAME, "CHERRYVIEW D1 PLATFORM"),
327			DMI_MATCH(DMI_PRODUCT_VERSION, "Blade3-10A-001"),
328		},
329		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
330					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
331	},
332	{
333		/* Medion Lifetab S10346 */
334		.matches = {
335			DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
336			DMI_MATCH(DMI_BOARD_NAME, "Aptio CRB"),
337			/* Way too generic, also match on BIOS data */
338			DMI_MATCH(DMI_BIOS_DATE, "10/22/2015"),
339		},
340		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
341					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
342	},
343	{
344		/* Nextbook Ares 8 */
345		.matches = {
346			DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
347			DMI_MATCH(DMI_PRODUCT_NAME, "M890BAP"),
348		},
349		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
350					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
351	},
352	{
353		/* Whitelabel (sold as various brands) TM800A550L */
354		.matches = {
355			DMI_MATCH(DMI_BOARD_VENDOR, "AMI Corporation"),
356			DMI_MATCH(DMI_BOARD_NAME, "Aptio CRB"),
357			/* Above strings are too generic, also match on BIOS version */
358			DMI_MATCH(DMI_BIOS_VERSION, "ZY-8-BI-PX4S70VTR400-X423B-005-D"),
359		},
360		.driver_data = (void *)(ACPI_QUIRK_SKIP_I2C_CLIENTS |
361					ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY),
362	},
363#endif
364	{}
365};
366
367#if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
368static const struct acpi_device_id i2c_acpi_known_good_ids[] = {
369	{ "10EC5640", 0 }, /* RealTek ALC5640 audio codec */
370	{ "INT33F4", 0 },  /* X-Powers AXP288 PMIC */
371	{ "INT33FD", 0 },  /* Intel Crystal Cove PMIC */
372	{ "INT34D3", 0 },  /* Intel Whiskey Cove PMIC */
373	{ "NPCE69A", 0 },  /* Asus Transformer keyboard dock */
374	{}
375};
376
377bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
378{
379	const struct dmi_system_id *dmi_id;
380	long quirks;
381
382	dmi_id = dmi_first_match(acpi_quirk_skip_dmi_ids);
383	if (!dmi_id)
384		return false;
385
386	quirks = (unsigned long)dmi_id->driver_data;
387	if (!(quirks & ACPI_QUIRK_SKIP_I2C_CLIENTS))
388		return false;
389
390	return acpi_match_device_ids(adev, i2c_acpi_known_good_ids);
391}
392EXPORT_SYMBOL_GPL(acpi_quirk_skip_i2c_client_enumeration);
393
394int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
395{
396	struct acpi_device *adev = ACPI_COMPANION(controller_parent);
397	const struct dmi_system_id *dmi_id;
398	long quirks = 0;
399	u64 uid;
400	int ret;
401
402	*skip = false;
403
404	ret = acpi_dev_uid_to_integer(adev, &uid);
405	if (ret)
406		return 0;
407
408	/* to not match on PNP enumerated debug UARTs */
409	if (!dev_is_platform(controller_parent))
410		return 0;
411
412	dmi_id = dmi_first_match(acpi_quirk_skip_dmi_ids);
413	if (dmi_id)
414		quirks = (unsigned long)dmi_id->driver_data;
415
416	if (quirks & ACPI_QUIRK_UART1_TTY_UART2_SKIP) {
417		if (uid == 1)
418			return -ENODEV; /* Create tty cdev instead of serdev */
419
420		if (uid == 2)
421			*skip = true;
422	}
423
424	return 0;
425}
426EXPORT_SYMBOL_GPL(acpi_quirk_skip_serdev_enumeration);
427#endif
428
429/* Lists of PMIC ACPI HIDs with an (often better) native charger driver */
430static const struct {
431	const char *hid;
432	int hrv;
433} acpi_skip_ac_and_battery_pmic_ids[] = {
434	{ "INT33F4", -1 }, /* X-Powers AXP288 PMIC */
435	{ "INT34D3",  3 }, /* Intel Cherrytrail Whiskey Cove PMIC */
436};
437
438bool acpi_quirk_skip_acpi_ac_and_battery(void)
439{
440	const struct dmi_system_id *dmi_id;
441	long quirks = 0;
442	int i;
443
444	dmi_id = dmi_first_match(acpi_quirk_skip_dmi_ids);
445	if (dmi_id)
446		quirks = (unsigned long)dmi_id->driver_data;
447
448	if (quirks & ACPI_QUIRK_SKIP_ACPI_AC_AND_BATTERY)
449		return true;
450
451	if (quirks & ACPI_QUIRK_USE_ACPI_AC_AND_BATTERY)
452		return false;
453
454	for (i = 0; i < ARRAY_SIZE(acpi_skip_ac_and_battery_pmic_ids); i++) {
455		if (acpi_dev_present(acpi_skip_ac_and_battery_pmic_ids[i].hid, "1",
456				     acpi_skip_ac_and_battery_pmic_ids[i].hrv)) {
457			pr_info_once("found native %s PMIC, skipping ACPI AC and battery devices\n",
458				     acpi_skip_ac_and_battery_pmic_ids[i].hid);
459			return true;
460		}
461	}
462
463	return false;
464}
465EXPORT_SYMBOL_GPL(acpi_quirk_skip_acpi_ac_and_battery);