xref: /openbmc/linux/drivers/acpi/bus.c (revision f6723b56)
1 /*
2  *  acpi_bus.c - ACPI Bus Driver ($Revision: 80 $)
3  *
4  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
5  *
6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or (at
11  *  your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful, but
14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  *  General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License along
19  *  with this program; if not, write to the Free Software Foundation, Inc.,
20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
21  *
22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  */
24 
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/ioport.h>
28 #include <linux/kernel.h>
29 #include <linux/list.h>
30 #include <linux/sched.h>
31 #include <linux/pm.h>
32 #include <linux/device.h>
33 #include <linux/proc_fs.h>
34 #include <linux/acpi.h>
35 #include <linux/slab.h>
36 #include <linux/regulator/machine.h>
37 #ifdef CONFIG_X86
38 #include <asm/mpspec.h>
39 #endif
40 #include <linux/pci.h>
41 #include <acpi/apei.h>
42 #include <linux/dmi.h>
43 #include <linux/suspend.h>
44 
45 #include "internal.h"
46 
47 #define _COMPONENT		ACPI_BUS_COMPONENT
48 ACPI_MODULE_NAME("bus");
49 
50 struct acpi_device *acpi_root;
51 struct proc_dir_entry *acpi_root_dir;
52 EXPORT_SYMBOL(acpi_root_dir);
53 
54 #ifdef CONFIG_X86
55 static int set_copy_dsdt(const struct dmi_system_id *id)
56 {
57 	printk(KERN_NOTICE "%s detected - "
58 		"force copy of DSDT to local memory\n", id->ident);
59 	acpi_gbl_copy_dsdt_locally = 1;
60 	return 0;
61 }
62 
63 static struct dmi_system_id dsdt_dmi_table[] __initdata = {
64 	/*
65 	 * Invoke DSDT corruption work-around on all Toshiba Satellite.
66 	 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
67 	 */
68 	{
69 	 .callback = set_copy_dsdt,
70 	 .ident = "TOSHIBA Satellite",
71 	 .matches = {
72 		DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
73 		DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
74 		},
75 	},
76 	{}
77 };
78 #else
79 static struct dmi_system_id dsdt_dmi_table[] __initdata = {
80 	{}
81 };
82 #endif
83 
84 /* --------------------------------------------------------------------------
85                                 Device Management
86    -------------------------------------------------------------------------- */
87 
88 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
89 				       unsigned long long *sta)
90 {
91 	acpi_status status;
92 
93 	status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
94 	if (ACPI_SUCCESS(status))
95 		return AE_OK;
96 
97 	if (status == AE_NOT_FOUND) {
98 		*sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
99 		       ACPI_STA_DEVICE_UI      | ACPI_STA_DEVICE_FUNCTIONING;
100 		return AE_OK;
101 	}
102 	return status;
103 }
104 
105 int acpi_bus_get_status(struct acpi_device *device)
106 {
107 	acpi_status status;
108 	unsigned long long sta;
109 
110 	status = acpi_bus_get_status_handle(device->handle, &sta);
111 	if (ACPI_FAILURE(status))
112 		return -ENODEV;
113 
114 	acpi_set_device_status(device, sta);
115 
116 	if (device->status.functional && !device->status.present) {
117 		ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]: "
118 		       "functional but not present;\n",
119 			device->pnp.bus_id, (u32)sta));
120 	}
121 
122 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]\n",
123 			  device->pnp.bus_id, (u32)sta));
124 	return 0;
125 }
126 EXPORT_SYMBOL(acpi_bus_get_status);
127 
128 void acpi_bus_private_data_handler(acpi_handle handle,
129 				   void *context)
130 {
131 	return;
132 }
133 EXPORT_SYMBOL(acpi_bus_private_data_handler);
134 
135 int acpi_bus_get_private_data(acpi_handle handle, void **data)
136 {
137 	acpi_status status;
138 
139 	if (!*data)
140 		return -EINVAL;
141 
142 	status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
143 	if (ACPI_FAILURE(status) || !*data) {
144 		ACPI_DEBUG_PRINT((ACPI_DB_INFO, "No context for object [%p]\n",
145 				handle));
146 		return -ENODEV;
147 	}
148 
149 	return 0;
150 }
151 EXPORT_SYMBOL(acpi_bus_get_private_data);
152 
153 void acpi_bus_no_hotplug(acpi_handle handle)
154 {
155 	struct acpi_device *adev = NULL;
156 
157 	acpi_bus_get_device(handle, &adev);
158 	if (adev)
159 		adev->flags.no_hotplug = true;
160 }
161 EXPORT_SYMBOL_GPL(acpi_bus_no_hotplug);
162 
163 static void acpi_print_osc_error(acpi_handle handle,
164 	struct acpi_osc_context *context, char *error)
165 {
166 	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER};
167 	int i;
168 
169 	if (ACPI_FAILURE(acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer)))
170 		printk(KERN_DEBUG "%s\n", error);
171 	else {
172 		printk(KERN_DEBUG "%s:%s\n", (char *)buffer.pointer, error);
173 		kfree(buffer.pointer);
174 	}
175 	printk(KERN_DEBUG"_OSC request data:");
176 	for (i = 0; i < context->cap.length; i += sizeof(u32))
177 		printk("%x ", *((u32 *)(context->cap.pointer + i)));
178 	printk("\n");
179 }
180 
181 acpi_status acpi_str_to_uuid(char *str, u8 *uuid)
182 {
183 	int i;
184 	static int opc_map_to_uuid[16] = {6, 4, 2, 0, 11, 9, 16, 14, 19, 21,
185 		24, 26, 28, 30, 32, 34};
186 
187 	if (strlen(str) != 36)
188 		return AE_BAD_PARAMETER;
189 	for (i = 0; i < 36; i++) {
190 		if (i == 8 || i == 13 || i == 18 || i == 23) {
191 			if (str[i] != '-')
192 				return AE_BAD_PARAMETER;
193 		} else if (!isxdigit(str[i]))
194 			return AE_BAD_PARAMETER;
195 	}
196 	for (i = 0; i < 16; i++) {
197 		uuid[i] = hex_to_bin(str[opc_map_to_uuid[i]]) << 4;
198 		uuid[i] |= hex_to_bin(str[opc_map_to_uuid[i] + 1]);
199 	}
200 	return AE_OK;
201 }
202 EXPORT_SYMBOL_GPL(acpi_str_to_uuid);
203 
204 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
205 {
206 	acpi_status status;
207 	struct acpi_object_list input;
208 	union acpi_object in_params[4];
209 	union acpi_object *out_obj;
210 	u8 uuid[16];
211 	u32 errors;
212 	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
213 
214 	if (!context)
215 		return AE_ERROR;
216 	if (ACPI_FAILURE(acpi_str_to_uuid(context->uuid_str, uuid)))
217 		return AE_ERROR;
218 	context->ret.length = ACPI_ALLOCATE_BUFFER;
219 	context->ret.pointer = NULL;
220 
221 	/* Setting up input parameters */
222 	input.count = 4;
223 	input.pointer = in_params;
224 	in_params[0].type 		= ACPI_TYPE_BUFFER;
225 	in_params[0].buffer.length 	= 16;
226 	in_params[0].buffer.pointer	= uuid;
227 	in_params[1].type 		= ACPI_TYPE_INTEGER;
228 	in_params[1].integer.value 	= context->rev;
229 	in_params[2].type 		= ACPI_TYPE_INTEGER;
230 	in_params[2].integer.value	= context->cap.length/sizeof(u32);
231 	in_params[3].type		= ACPI_TYPE_BUFFER;
232 	in_params[3].buffer.length 	= context->cap.length;
233 	in_params[3].buffer.pointer 	= context->cap.pointer;
234 
235 	status = acpi_evaluate_object(handle, "_OSC", &input, &output);
236 	if (ACPI_FAILURE(status))
237 		return status;
238 
239 	if (!output.length)
240 		return AE_NULL_OBJECT;
241 
242 	out_obj = output.pointer;
243 	if (out_obj->type != ACPI_TYPE_BUFFER
244 		|| out_obj->buffer.length != context->cap.length) {
245 		acpi_print_osc_error(handle, context,
246 			"_OSC evaluation returned wrong type");
247 		status = AE_TYPE;
248 		goto out_kfree;
249 	}
250 	/* Need to ignore the bit0 in result code */
251 	errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
252 	if (errors) {
253 		if (errors & OSC_REQUEST_ERROR)
254 			acpi_print_osc_error(handle, context,
255 				"_OSC request failed");
256 		if (errors & OSC_INVALID_UUID_ERROR)
257 			acpi_print_osc_error(handle, context,
258 				"_OSC invalid UUID");
259 		if (errors & OSC_INVALID_REVISION_ERROR)
260 			acpi_print_osc_error(handle, context,
261 				"_OSC invalid revision");
262 		if (errors & OSC_CAPABILITIES_MASK_ERROR) {
263 			if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD]
264 			    & OSC_QUERY_ENABLE)
265 				goto out_success;
266 			status = AE_SUPPORT;
267 			goto out_kfree;
268 		}
269 		status = AE_ERROR;
270 		goto out_kfree;
271 	}
272 out_success:
273 	context->ret.length = out_obj->buffer.length;
274 	context->ret.pointer = kmemdup(out_obj->buffer.pointer,
275 				       context->ret.length, GFP_KERNEL);
276 	if (!context->ret.pointer) {
277 		status =  AE_NO_MEMORY;
278 		goto out_kfree;
279 	}
280 	status =  AE_OK;
281 
282 out_kfree:
283 	kfree(output.pointer);
284 	if (status != AE_OK)
285 		context->ret.pointer = NULL;
286 	return status;
287 }
288 EXPORT_SYMBOL(acpi_run_osc);
289 
290 bool osc_sb_apei_support_acked;
291 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
292 static void acpi_bus_osc_support(void)
293 {
294 	u32 capbuf[2];
295 	struct acpi_osc_context context = {
296 		.uuid_str = sb_uuid_str,
297 		.rev = 1,
298 		.cap.length = 8,
299 		.cap.pointer = capbuf,
300 	};
301 	acpi_handle handle;
302 
303 	capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
304 	capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */
305 #if defined(CONFIG_ACPI_PROCESSOR_AGGREGATOR) ||\
306 			defined(CONFIG_ACPI_PROCESSOR_AGGREGATOR_MODULE)
307 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT;
308 #endif
309 
310 #if defined(CONFIG_ACPI_PROCESSOR) || defined(CONFIG_ACPI_PROCESSOR_MODULE)
311 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT;
312 #endif
313 
314 #ifdef ACPI_HOTPLUG_OST
315 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT;
316 #endif
317 
318 	if (!ghes_disable)
319 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
320 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
321 		return;
322 	if (ACPI_SUCCESS(acpi_run_osc(handle, &context))) {
323 		u32 *capbuf_ret = context.ret.pointer;
324 		if (context.ret.length > OSC_SUPPORT_DWORD)
325 			osc_sb_apei_support_acked =
326 				capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
327 		kfree(context.ret.pointer);
328 	}
329 	/* do we need to check other returned cap? Sounds no */
330 }
331 
332 /* --------------------------------------------------------------------------
333                              Notification Handling
334    -------------------------------------------------------------------------- */
335 
336 /**
337  * acpi_bus_notify
338  * ---------------
339  * Callback for all 'system-level' device notifications (values 0x00-0x7F).
340  */
341 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
342 {
343 	struct acpi_device *device = NULL;
344 	struct acpi_driver *driver;
345 
346 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Notification %#02x to handle %p\n",
347 			  type, handle));
348 
349 	switch (type) {
350 
351 	case ACPI_NOTIFY_BUS_CHECK:
352 		/* TBD */
353 		break;
354 
355 	case ACPI_NOTIFY_DEVICE_CHECK:
356 		/* TBD */
357 		break;
358 
359 	case ACPI_NOTIFY_DEVICE_WAKE:
360 		/* TBD */
361 		break;
362 
363 	case ACPI_NOTIFY_EJECT_REQUEST:
364 		/* TBD */
365 		break;
366 
367 	case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
368 		/* TBD: Exactly what does 'light' mean? */
369 		break;
370 
371 	case ACPI_NOTIFY_FREQUENCY_MISMATCH:
372 		/* TBD */
373 		break;
374 
375 	case ACPI_NOTIFY_BUS_MODE_MISMATCH:
376 		/* TBD */
377 		break;
378 
379 	case ACPI_NOTIFY_POWER_FAULT:
380 		/* TBD */
381 		break;
382 
383 	default:
384 		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
385 				  "Received unknown/unsupported notification [%08x]\n",
386 				  type));
387 		break;
388 	}
389 
390 	acpi_bus_get_device(handle, &device);
391 	if (device) {
392 		driver = device->driver;
393 		if (driver && driver->ops.notify &&
394 		    (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS))
395 			driver->ops.notify(device, type);
396 	}
397 }
398 
399 /* --------------------------------------------------------------------------
400                              Initialization/Cleanup
401    -------------------------------------------------------------------------- */
402 
403 static int __init acpi_bus_init_irq(void)
404 {
405 	acpi_status status;
406 	char *message = NULL;
407 
408 
409 	/*
410 	 * Let the system know what interrupt model we are using by
411 	 * evaluating the \_PIC object, if exists.
412 	 */
413 
414 	switch (acpi_irq_model) {
415 	case ACPI_IRQ_MODEL_PIC:
416 		message = "PIC";
417 		break;
418 	case ACPI_IRQ_MODEL_IOAPIC:
419 		message = "IOAPIC";
420 		break;
421 	case ACPI_IRQ_MODEL_IOSAPIC:
422 		message = "IOSAPIC";
423 		break;
424 	case ACPI_IRQ_MODEL_PLATFORM:
425 		message = "platform specific model";
426 		break;
427 	default:
428 		printk(KERN_WARNING PREFIX "Unknown interrupt routing model\n");
429 		return -ENODEV;
430 	}
431 
432 	printk(KERN_INFO PREFIX "Using %s for interrupt routing\n", message);
433 
434 	status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
435 	if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
436 		ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PIC"));
437 		return -ENODEV;
438 	}
439 
440 	return 0;
441 }
442 
443 u8 acpi_gbl_permanent_mmap;
444 
445 
446 void __init acpi_early_init(void)
447 {
448 	acpi_status status;
449 
450 	if (acpi_disabled)
451 		return;
452 
453 	printk(KERN_INFO PREFIX "Core revision %08x\n", ACPI_CA_VERSION);
454 
455 	/* enable workarounds, unless strict ACPI spec. compliance */
456 	if (!acpi_strict)
457 		acpi_gbl_enable_interpreter_slack = TRUE;
458 
459 	acpi_gbl_permanent_mmap = 1;
460 
461 	/*
462 	 * If the machine falls into the DMI check table,
463 	 * DSDT will be copied to memory
464 	 */
465 	dmi_check_system(dsdt_dmi_table);
466 
467 	status = acpi_reallocate_root_table();
468 	if (ACPI_FAILURE(status)) {
469 		printk(KERN_ERR PREFIX
470 		       "Unable to reallocate ACPI tables\n");
471 		goto error0;
472 	}
473 
474 	status = acpi_initialize_subsystem();
475 	if (ACPI_FAILURE(status)) {
476 		printk(KERN_ERR PREFIX
477 		       "Unable to initialize the ACPI Interpreter\n");
478 		goto error0;
479 	}
480 
481 	status = acpi_load_tables();
482 	if (ACPI_FAILURE(status)) {
483 		printk(KERN_ERR PREFIX
484 		       "Unable to load the System Description Tables\n");
485 		goto error0;
486 	}
487 
488 #ifdef CONFIG_X86
489 	if (!acpi_ioapic) {
490 		/* compatible (0) means level (3) */
491 		if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
492 			acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
493 			acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
494 		}
495 		/* Set PIC-mode SCI trigger type */
496 		acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
497 					 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
498 	} else {
499 		/*
500 		 * now that acpi_gbl_FADT is initialized,
501 		 * update it with result from INT_SRC_OVR parsing
502 		 */
503 		acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
504 	}
505 #endif
506 
507 	status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
508 	if (ACPI_FAILURE(status)) {
509 		printk(KERN_ERR PREFIX "Unable to enable ACPI\n");
510 		goto error0;
511 	}
512 
513 	/*
514 	 * If the system is using ACPI then we can be reasonably
515 	 * confident that any regulators are managed by the firmware
516 	 * so tell the regulator core it has everything it needs to
517 	 * know.
518 	 */
519 	regulator_has_full_constraints();
520 
521 	return;
522 
523       error0:
524 	disable_acpi();
525 	return;
526 }
527 
528 static int __init acpi_bus_init(void)
529 {
530 	int result;
531 	acpi_status status;
532 
533 	acpi_os_initialize1();
534 
535 	status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
536 	if (ACPI_FAILURE(status)) {
537 		printk(KERN_ERR PREFIX
538 		       "Unable to start the ACPI Interpreter\n");
539 		goto error1;
540 	}
541 
542 	/*
543 	 * ACPI 2.0 requires the EC driver to be loaded and work before
544 	 * the EC device is found in the namespace (i.e. before acpi_initialize_objects()
545 	 * is called).
546 	 *
547 	 * This is accomplished by looking for the ECDT table, and getting
548 	 * the EC parameters out of that.
549 	 */
550 	status = acpi_ec_ecdt_probe();
551 	/* Ignore result. Not having an ECDT is not fatal. */
552 
553 	status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
554 	if (ACPI_FAILURE(status)) {
555 		printk(KERN_ERR PREFIX "Unable to initialize ACPI objects\n");
556 		goto error1;
557 	}
558 
559 	/*
560 	 * _OSC method may exist in module level code,
561 	 * so it must be run after ACPI_FULL_INITIALIZATION
562 	 */
563 	acpi_bus_osc_support();
564 
565 	/*
566 	 * _PDC control method may load dynamic SSDT tables,
567 	 * and we need to install the table handler before that.
568 	 */
569 	acpi_sysfs_init();
570 
571 	acpi_early_processor_set_pdc();
572 
573 	/*
574 	 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
575 	 * is necessary to enable it as early as possible.
576 	 */
577 	acpi_boot_ec_enable();
578 
579 	printk(KERN_INFO PREFIX "Interpreter enabled\n");
580 
581 	/* Initialize sleep structures */
582 	acpi_sleep_init();
583 
584 	/*
585 	 * Get the system interrupt model and evaluate \_PIC.
586 	 */
587 	result = acpi_bus_init_irq();
588 	if (result)
589 		goto error1;
590 
591 	/*
592 	 * Register the for all standard device notifications.
593 	 */
594 	status =
595 	    acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
596 					&acpi_bus_notify, NULL);
597 	if (ACPI_FAILURE(status)) {
598 		printk(KERN_ERR PREFIX
599 		       "Unable to register for device notifications\n");
600 		goto error1;
601 	}
602 
603 	/*
604 	 * Create the top ACPI proc directory
605 	 */
606 	acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
607 
608 	return 0;
609 
610 	/* Mimic structured exception handling */
611       error1:
612 	acpi_terminate();
613 	return -ENODEV;
614 }
615 
616 struct kobject *acpi_kobj;
617 EXPORT_SYMBOL_GPL(acpi_kobj);
618 
619 static int __init acpi_init(void)
620 {
621 	int result;
622 
623 	if (acpi_disabled) {
624 		printk(KERN_INFO PREFIX "Interpreter disabled.\n");
625 		return -ENODEV;
626 	}
627 
628 	acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
629 	if (!acpi_kobj) {
630 		printk(KERN_WARNING "%s: kset create error\n", __func__);
631 		acpi_kobj = NULL;
632 	}
633 
634 	init_acpi_device_notify();
635 	result = acpi_bus_init();
636 	if (result) {
637 		disable_acpi();
638 		return result;
639 	}
640 
641 	pci_mmcfg_late_init();
642 	acpi_scan_init();
643 	acpi_ec_init();
644 	acpi_debugfs_init();
645 	acpi_sleep_proc_init();
646 	acpi_wakeup_device_init();
647 	return 0;
648 }
649 
650 subsys_initcall(acpi_init);
651