]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/acpi/bus.c
ACPI / processor_idle: Add support for Low Power Idle(LPI) states
[mirror_ubuntu-zesty-kernel.git] / drivers / acpi / bus.c
CommitLineData
1da177e4
LT
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 *
1da177e4
LT
18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19 */
20
21#include <linux/module.h>
22#include <linux/init.h>
23#include <linux/ioport.h>
d568df84 24#include <linux/kernel.h>
1da177e4
LT
25#include <linux/list.h>
26#include <linux/sched.h>
27#include <linux/pm.h>
28#include <linux/device.h>
29#include <linux/proc_fs.h>
6697c052 30#include <linux/acpi.h>
5a0e3ad6 31#include <linux/slab.h>
49a12877 32#include <linux/regulator/machine.h>
1da177e4
LT
33#ifdef CONFIG_X86
34#include <asm/mpspec.h>
35#endif
7752d5cf 36#include <linux/pci.h>
eccddd32 37#include <acpi/apei.h>
eb27cae8 38#include <linux/dmi.h>
cd51e61c 39#include <linux/suspend.h>
1da177e4 40
e60cc7a6
BH
41#include "internal.h"
42
1da177e4 43#define _COMPONENT ACPI_BUS_COMPONENT
f52fd66d 44ACPI_MODULE_NAME("bus");
1da177e4 45
4be44fcd
LB
46struct acpi_device *acpi_root;
47struct proc_dir_entry *acpi_root_dir;
1da177e4
LT
48EXPORT_SYMBOL(acpi_root_dir);
49
cce4f632 50#ifdef CONFIG_X86
73577d1d
LZ
51#ifdef CONFIG_ACPI_CUSTOM_DSDT
52static inline int set_copy_dsdt(const struct dmi_system_id *id)
53{
54 return 0;
55}
56#else
aa2110cb
LM
57static int set_copy_dsdt(const struct dmi_system_id *id)
58{
59 printk(KERN_NOTICE "%s detected - "
60 "force copy of DSDT to local memory\n", id->ident);
61 acpi_gbl_copy_dsdt_locally = 1;
62 return 0;
63}
73577d1d 64#endif
aa2110cb
LM
65
66static struct dmi_system_id dsdt_dmi_table[] __initdata = {
67 /*
100cf877 68 * Invoke DSDT corruption work-around on all Toshiba Satellite.
aa2110cb
LM
69 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
70 */
71 {
72 .callback = set_copy_dsdt,
100cf877 73 .ident = "TOSHIBA Satellite",
aa2110cb
LM
74 .matches = {
75 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
100cf877 76 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
aa2110cb 77 },
cce4f632
LM
78 },
79 {}
aa2110cb 80};
cce4f632
LM
81#else
82static struct dmi_system_id dsdt_dmi_table[] __initdata = {
83 {}
84};
85#endif
aa2110cb 86
1da177e4
LT
87/* --------------------------------------------------------------------------
88 Device Management
89 -------------------------------------------------------------------------- */
90
402ac536
BH
91acpi_status acpi_bus_get_status_handle(acpi_handle handle,
92 unsigned long long *sta)
1da177e4 93{
402ac536 94 acpi_status status;
4be44fcd 95
402ac536
BH
96 status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
97 if (ACPI_SUCCESS(status))
98 return AE_OK;
1da177e4 99
402ac536
BH
100 if (status == AE_NOT_FOUND) {
101 *sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
102 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING;
103 return AE_OK;
1da177e4 104 }
402ac536
BH
105 return status;
106}
1da177e4 107
402ac536
BH
108int acpi_bus_get_status(struct acpi_device *device)
109{
110 acpi_status status;
111 unsigned long long sta;
112
113 status = acpi_bus_get_status_handle(device->handle, &sta);
114 if (ACPI_FAILURE(status))
115 return -ENODEV;
116
25db115b 117 acpi_set_device_status(device, sta);
1da177e4
LT
118
119 if (device->status.functional && !device->status.present) {
39a0ad87
ZY
120 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]: "
121 "functional but not present;\n",
25db115b 122 device->pnp.bus_id, (u32)sta));
1da177e4
LT
123 }
124
4be44fcd 125 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]\n",
25db115b 126 device->pnp.bus_id, (u32)sta));
d550d98d 127 return 0;
1da177e4 128}
4be44fcd 129EXPORT_SYMBOL(acpi_bus_get_status);
1da177e4 130
20733939 131void acpi_bus_private_data_handler(acpi_handle handle,
8e4319c4 132 void *context)
20733939
ZR
133{
134 return;
135}
136EXPORT_SYMBOL(acpi_bus_private_data_handler);
137
72013795
LT
138int acpi_bus_attach_private_data(acpi_handle handle, void *data)
139{
140 acpi_status status;
141
142 status = acpi_attach_data(handle,
143 acpi_bus_private_data_handler, data);
144 if (ACPI_FAILURE(status)) {
145 acpi_handle_debug(handle, "Error attaching device data\n");
146 return -ENODEV;
147 }
148
149 return 0;
150}
151EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
152
20733939
ZR
153int acpi_bus_get_private_data(acpi_handle handle, void **data)
154{
6a8c0af6 155 acpi_status status;
20733939
ZR
156
157 if (!*data)
158 return -EINVAL;
159
160 status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
72013795
LT
161 if (ACPI_FAILURE(status)) {
162 acpi_handle_debug(handle, "No context for object\n");
20733939
ZR
163 return -ENODEV;
164 }
165
166 return 0;
167}
72013795
LT
168EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
169
170void acpi_bus_detach_private_data(acpi_handle handle)
171{
172 acpi_detach_data(handle, acpi_bus_private_data_handler);
173}
174EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
20733939 175
70023de8
SL
176static void acpi_print_osc_error(acpi_handle handle,
177 struct acpi_osc_context *context, char *error)
178{
179 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER};
180 int i;
181
182 if (ACPI_FAILURE(acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer)))
76c599bc 183 printk(KERN_DEBUG "%s: %s\n", context->uuid_str, error);
70023de8 184 else {
76c599bc
AL
185 printk(KERN_DEBUG "%s (%s): %s\n",
186 (char *)buffer.pointer, context->uuid_str, error);
70023de8
SL
187 kfree(buffer.pointer);
188 }
50fe763c 189 printk(KERN_DEBUG "_OSC request data:");
70023de8 190 for (i = 0; i < context->cap.length; i += sizeof(u32))
50fe763c 191 printk(" %x", *((u32 *)(context->cap.pointer + i)));
70023de8
SL
192 printk("\n");
193}
194
4b3db708 195acpi_status acpi_str_to_uuid(char *str, u8 *uuid)
70023de8
SL
196{
197 int i;
198 static int opc_map_to_uuid[16] = {6, 4, 2, 0, 11, 9, 16, 14, 19, 21,
199 24, 26, 28, 30, 32, 34};
200
201 if (strlen(str) != 36)
202 return AE_BAD_PARAMETER;
203 for (i = 0; i < 36; i++) {
204 if (i == 8 || i == 13 || i == 18 || i == 23) {
205 if (str[i] != '-')
206 return AE_BAD_PARAMETER;
207 } else if (!isxdigit(str[i]))
208 return AE_BAD_PARAMETER;
209 }
210 for (i = 0; i < 16; i++) {
965fd9e9
AS
211 uuid[i] = hex_to_bin(str[opc_map_to_uuid[i]]) << 4;
212 uuid[i] |= hex_to_bin(str[opc_map_to_uuid[i] + 1]);
70023de8
SL
213 }
214 return AE_OK;
215}
4b3db708 216EXPORT_SYMBOL_GPL(acpi_str_to_uuid);
70023de8
SL
217
218acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
219{
220 acpi_status status;
221 struct acpi_object_list input;
222 union acpi_object in_params[4];
223 union acpi_object *out_obj;
224 u8 uuid[16];
225 u32 errors;
9dc130fc 226 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
70023de8
SL
227
228 if (!context)
229 return AE_ERROR;
230 if (ACPI_FAILURE(acpi_str_to_uuid(context->uuid_str, uuid)))
231 return AE_ERROR;
232 context->ret.length = ACPI_ALLOCATE_BUFFER;
233 context->ret.pointer = NULL;
234
235 /* Setting up input parameters */
236 input.count = 4;
237 input.pointer = in_params;
238 in_params[0].type = ACPI_TYPE_BUFFER;
239 in_params[0].buffer.length = 16;
240 in_params[0].buffer.pointer = uuid;
241 in_params[1].type = ACPI_TYPE_INTEGER;
242 in_params[1].integer.value = context->rev;
243 in_params[2].type = ACPI_TYPE_INTEGER;
244 in_params[2].integer.value = context->cap.length/sizeof(u32);
245 in_params[3].type = ACPI_TYPE_BUFFER;
246 in_params[3].buffer.length = context->cap.length;
247 in_params[3].buffer.pointer = context->cap.pointer;
248
9dc130fc 249 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
70023de8
SL
250 if (ACPI_FAILURE(status))
251 return status;
252
9dc130fc 253 if (!output.length)
70023de8
SL
254 return AE_NULL_OBJECT;
255
9dc130fc
SL
256 out_obj = output.pointer;
257 if (out_obj->type != ACPI_TYPE_BUFFER
258 || out_obj->buffer.length != context->cap.length) {
70023de8
SL
259 acpi_print_osc_error(handle, context,
260 "_OSC evaluation returned wrong type");
261 status = AE_TYPE;
262 goto out_kfree;
263 }
264 /* Need to ignore the bit0 in result code */
265 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
266 if (errors) {
267 if (errors & OSC_REQUEST_ERROR)
268 acpi_print_osc_error(handle, context,
269 "_OSC request failed");
270 if (errors & OSC_INVALID_UUID_ERROR)
271 acpi_print_osc_error(handle, context,
272 "_OSC invalid UUID");
273 if (errors & OSC_INVALID_REVISION_ERROR)
274 acpi_print_osc_error(handle, context,
275 "_OSC invalid revision");
276 if (errors & OSC_CAPABILITIES_MASK_ERROR) {
b938a229 277 if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD]
70023de8
SL
278 & OSC_QUERY_ENABLE)
279 goto out_success;
280 status = AE_SUPPORT;
281 goto out_kfree;
282 }
283 status = AE_ERROR;
284 goto out_kfree;
285 }
286out_success:
9dc130fc 287 context->ret.length = out_obj->buffer.length;
e2cb5f08
AE
288 context->ret.pointer = kmemdup(out_obj->buffer.pointer,
289 context->ret.length, GFP_KERNEL);
9dc130fc
SL
290 if (!context->ret.pointer) {
291 status = AE_NO_MEMORY;
292 goto out_kfree;
293 }
9dc130fc 294 status = AE_OK;
70023de8
SL
295
296out_kfree:
9dc130fc
SL
297 kfree(output.pointer);
298 if (status != AE_OK)
299 context->ret.pointer = NULL;
70023de8
SL
300 return status;
301}
302EXPORT_SYMBOL(acpi_run_osc);
303
eccddd32 304bool osc_sb_apei_support_acked;
a36a7fec
SH
305
306/*
307 * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
308 * OSPM supports platform coordinated low power idle(LPI) states
309 */
310bool osc_pc_lpi_support_confirmed;
311EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
312
3563ff96
SL
313static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
314static void acpi_bus_osc_support(void)
315{
316 u32 capbuf[2];
317 struct acpi_osc_context context = {
318 .uuid_str = sb_uuid_str,
319 .rev = 1,
320 .cap.length = 8,
321 .cap.pointer = capbuf,
322 };
323 acpi_handle handle;
324
b938a229
BH
325 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
326 capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */
bcb2b0b2
SH
327 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR))
328 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT;
329 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR))
330 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT;
eccddd32 331
b938a229 332 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT;
a36a7fec 333 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PCLPI_SUPPORT;
c2f4191a 334
eccddd32 335 if (!ghes_disable)
b938a229 336 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
3563ff96
SL
337 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
338 return;
eccddd32
HY
339 if (ACPI_SUCCESS(acpi_run_osc(handle, &context))) {
340 u32 *capbuf_ret = context.ret.pointer;
a36a7fec 341 if (context.ret.length > OSC_SUPPORT_DWORD) {
eccddd32 342 osc_sb_apei_support_acked =
b938a229 343 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
a36a7fec
SH
344 osc_pc_lpi_support_confirmed =
345 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT;
346 }
3563ff96 347 kfree(context.ret.pointer);
eccddd32
HY
348 }
349 /* do we need to check other returned cap? Sounds no */
3563ff96
SL
350}
351
1da177e4
LT
352/* --------------------------------------------------------------------------
353 Notification Handling
354 -------------------------------------------------------------------------- */
355
1da177e4
LT
356/**
357 * acpi_bus_notify
358 * ---------------
359 * Callback for all 'system-level' device notifications (values 0x00-0x7F).
360 */
4be44fcd 361static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
1da177e4 362{
1a699476 363 struct acpi_device *adev;
6d278131 364 struct acpi_driver *driver;
1a699476 365 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
d0103387 366 bool hotplug_event = false;
02c37bd8 367
1da177e4 368 switch (type) {
1da177e4 369 case ACPI_NOTIFY_BUS_CHECK:
1a699476 370 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
d0103387 371 hotplug_event = true;
1da177e4
LT
372 break;
373
374 case ACPI_NOTIFY_DEVICE_CHECK:
1a699476 375 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
d0103387 376 hotplug_event = true;
1da177e4
LT
377 break;
378
379 case ACPI_NOTIFY_DEVICE_WAKE:
1a699476 380 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
1da177e4
LT
381 break;
382
383 case ACPI_NOTIFY_EJECT_REQUEST:
1a699476 384 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
d0103387 385 hotplug_event = true;
1da177e4
LT
386 break;
387
388 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
1a699476 389 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
1da177e4
LT
390 /* TBD: Exactly what does 'light' mean? */
391 break;
392
393 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
1a699476
RW
394 acpi_handle_err(handle, "Device cannot be configured due "
395 "to a frequency mismatch\n");
1da177e4
LT
396 break;
397
398 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
1a699476
RW
399 acpi_handle_err(handle, "Device cannot be configured due "
400 "to a bus mode mismatch\n");
1da177e4
LT
401 break;
402
403 case ACPI_NOTIFY_POWER_FAULT:
1a699476 404 acpi_handle_err(handle, "Device has suffered a power fault\n");
1da177e4
LT
405 break;
406
407 default:
f66abe92
RW
408 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
409 break;
1da177e4
LT
410 }
411
1a699476
RW
412 adev = acpi_bus_get_acpi_device(handle);
413 if (!adev)
414 goto err;
78ea4639 415
1a699476
RW
416 driver = adev->driver;
417 if (driver && driver->ops.notify &&
418 (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS))
419 driver->ops.notify(adev, type);
420
d0103387
RW
421 if (hotplug_event && ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
422 return;
423
1a699476
RW
424 acpi_bus_put_acpi_device(adev);
425 return;
426
427 err:
700b8422 428 acpi_evaluate_ost(handle, type, ost_code, NULL);
1da177e4
LT
429}
430
5894b0c4
RW
431static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
432{
433 struct acpi_device *device = data;
434
435 device->driver->ops.notify(device, event);
436}
437
438static void acpi_device_notify_fixed(void *data)
439{
440 struct acpi_device *device = data;
441
442 /* Fixed hardware devices have no handles */
443 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
444}
445
446static u32 acpi_device_fixed_event(void *data)
447{
448 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_device_notify_fixed, data);
449 return ACPI_INTERRUPT_HANDLED;
450}
451
452static int acpi_device_install_notify_handler(struct acpi_device *device)
453{
454 acpi_status status;
455
456 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
457 status =
458 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
459 acpi_device_fixed_event,
460 device);
461 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
462 status =
463 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
464 acpi_device_fixed_event,
465 device);
466 else
467 status = acpi_install_notify_handler(device->handle,
468 ACPI_DEVICE_NOTIFY,
469 acpi_device_notify,
470 device);
471
472 if (ACPI_FAILURE(status))
473 return -EINVAL;
474 return 0;
475}
476
477static void acpi_device_remove_notify_handler(struct acpi_device *device)
478{
479 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
480 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
481 acpi_device_fixed_event);
482 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
483 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
484 acpi_device_fixed_event);
485 else
486 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
487 acpi_device_notify);
488}
489
68c6b148
RW
490/* --------------------------------------------------------------------------
491 Device Matching
492 -------------------------------------------------------------------------- */
493
3b95bd16
AM
494/**
495 * acpi_get_first_physical_node - Get first physical node of an ACPI device
496 * @adev: ACPI device in question
497 *
498 * Return: First physical node of ACPI device @adev
499 */
500struct device *acpi_get_first_physical_node(struct acpi_device *adev)
e91a398c
RW
501{
502 struct mutex *physical_node_lock = &adev->physical_node_lock;
3b95bd16 503 struct device *phys_dev;
e91a398c
RW
504
505 mutex_lock(physical_node_lock);
506 if (list_empty(&adev->physical_node_list)) {
3b95bd16 507 phys_dev = NULL;
e91a398c
RW
508 } else {
509 const struct acpi_device_physical_node *node;
510
511 node = list_first_entry(&adev->physical_node_list,
512 struct acpi_device_physical_node, node);
3b95bd16
AM
513
514 phys_dev = node->dev;
e91a398c
RW
515 }
516 mutex_unlock(physical_node_lock);
3b95bd16
AM
517 return phys_dev;
518}
519
520static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
521 const struct device *dev)
522{
523 const struct device *phys_dev = acpi_get_first_physical_node(adev);
524
525 return phys_dev && phys_dev == dev ? adev : NULL;
e91a398c
RW
526}
527
3431e490
RW
528/**
529 * acpi_device_is_first_physical_node - Is given dev first physical node
530 * @adev: ACPI companion device
531 * @dev: Physical device to check
532 *
533 * Function checks if given @dev is the first physical devices attached to
534 * the ACPI companion device. This distinction is needed in some cases
535 * where the same companion device is shared between many physical devices.
536 *
537 * Note that the caller have to provide valid @adev pointer.
538 */
539bool acpi_device_is_first_physical_node(struct acpi_device *adev,
540 const struct device *dev)
541{
e91a398c 542 return !!acpi_primary_dev_companion(adev, dev);
3431e490
RW
543}
544
68c6b148
RW
545/*
546 * acpi_companion_match() - Can we match via ACPI companion device
547 * @dev: Device in question
548 *
549 * Check if the given device has an ACPI companion and if that companion has
550 * a valid list of PNP IDs, and if the device is the first (primary) physical
551 * device associated with it. Return the companion pointer if that's the case
552 * or NULL otherwise.
553 *
554 * If multiple physical devices are attached to a single ACPI companion, we need
555 * to be careful. The usage scenario for this kind of relationship is that all
556 * of the physical devices in question use resources provided by the ACPI
557 * companion. A typical case is an MFD device where all the sub-devices share
558 * the parent's ACPI companion. In such cases we can only allow the primary
559 * (first) physical device to be matched with the help of the companion's PNP
560 * IDs.
561 *
562 * Additional physical devices sharing the ACPI companion can still use
563 * resources available from it but they will be matched normally using functions
564 * provided by their bus types (and analogously for their modalias).
565 */
566struct acpi_device *acpi_companion_match(const struct device *dev)
567{
568 struct acpi_device *adev;
68c6b148
RW
569
570 adev = ACPI_COMPANION(dev);
571 if (!adev)
572 return NULL;
573
574 if (list_empty(&adev->pnp.ids))
575 return NULL;
576
e91a398c 577 return acpi_primary_dev_companion(adev, dev);
68c6b148
RW
578}
579
580/**
581 * acpi_of_match_device - Match device object using the "compatible" property.
582 * @adev: ACPI device object to match.
583 * @of_match_table: List of device IDs to match against.
584 *
585 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
586 * identifiers and a _DSD object with the "compatible" property, use that
587 * property to match against the given list of identifiers.
588 */
589static bool acpi_of_match_device(struct acpi_device *adev,
590 const struct of_device_id *of_match_table)
591{
592 const union acpi_object *of_compatible, *obj;
593 int i, nval;
594
595 if (!adev)
596 return false;
597
598 of_compatible = adev->data.of_compatible;
599 if (!of_match_table || !of_compatible)
600 return false;
601
602 if (of_compatible->type == ACPI_TYPE_PACKAGE) {
603 nval = of_compatible->package.count;
604 obj = of_compatible->package.elements;
605 } else { /* Must be ACPI_TYPE_STRING. */
606 nval = 1;
607 obj = of_compatible;
608 }
609 /* Now we can look for the driver DT compatible strings */
610 for (i = 0; i < nval; i++, obj++) {
611 const struct of_device_id *id;
612
613 for (id = of_match_table; id->compatible[0]; id++)
614 if (!strcasecmp(obj->string.pointer, id->compatible))
615 return true;
616 }
617
618 return false;
619}
620
621static bool __acpi_match_device_cls(const struct acpi_device_id *id,
622 struct acpi_hardware_id *hwid)
623{
624 int i, msk, byte_shift;
625 char buf[3];
626
627 if (!id->cls)
628 return false;
629
630 /* Apply class-code bitmask, before checking each class-code byte */
631 for (i = 1; i <= 3; i++) {
632 byte_shift = 8 * (3 - i);
633 msk = (id->cls_msk >> byte_shift) & 0xFF;
634 if (!msk)
635 continue;
636
637 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
638 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
639 return false;
640 }
641 return true;
642}
643
644static const struct acpi_device_id *__acpi_match_device(
645 struct acpi_device *device,
646 const struct acpi_device_id *ids,
647 const struct of_device_id *of_ids)
648{
649 const struct acpi_device_id *id;
650 struct acpi_hardware_id *hwid;
651
652 /*
653 * If the device is not present, it is unnecessary to load device
654 * driver for it.
655 */
656 if (!device || !device->status.present)
657 return NULL;
658
659 list_for_each_entry(hwid, &device->pnp.ids, list) {
660 /* First, check the ACPI/PNP IDs provided by the caller. */
661 for (id = ids; id->id[0] || id->cls; id++) {
662 if (id->id[0] && !strcmp((char *) id->id, hwid->id))
663 return id;
664 else if (id->cls && __acpi_match_device_cls(id, hwid))
665 return id;
666 }
667
668 /*
669 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
670 * "compatible" property if found.
671 *
672 * The id returned by the below is not valid, but the only
673 * caller passing non-NULL of_ids here is only interested in
674 * whether or not the return value is NULL.
675 */
676 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id)
677 && acpi_of_match_device(device, of_ids))
678 return id;
679 }
680 return NULL;
681}
682
683/**
684 * acpi_match_device - Match a struct device against a given list of ACPI IDs
685 * @ids: Array of struct acpi_device_id object to match against.
686 * @dev: The device structure to match.
687 *
688 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
689 * object for that handle and use that object to match against a given list of
690 * device IDs.
691 *
692 * Return a pointer to the first matching ID on success or %NULL on failure.
693 */
694const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
695 const struct device *dev)
696{
697 return __acpi_match_device(acpi_companion_match(dev), ids, NULL);
698}
699EXPORT_SYMBOL_GPL(acpi_match_device);
700
701int acpi_match_device_ids(struct acpi_device *device,
702 const struct acpi_device_id *ids)
703{
704 return __acpi_match_device(device, ids, NULL) ? 0 : -ENOENT;
705}
706EXPORT_SYMBOL(acpi_match_device_ids);
707
708bool acpi_driver_match_device(struct device *dev,
709 const struct device_driver *drv)
710{
711 if (!drv->acpi_match_table)
712 return acpi_of_match_device(ACPI_COMPANION(dev),
713 drv->of_match_table);
714
715 return !!__acpi_match_device(acpi_companion_match(dev),
716 drv->acpi_match_table, drv->of_match_table);
717}
718EXPORT_SYMBOL_GPL(acpi_driver_match_device);
719
5894b0c4
RW
720/* --------------------------------------------------------------------------
721 ACPI Driver Management
722 -------------------------------------------------------------------------- */
723
724/**
725 * acpi_bus_register_driver - register a driver with the ACPI bus
726 * @driver: driver being registered
727 *
728 * Registers a driver with the ACPI bus. Searches the namespace for all
729 * devices that match the driver's criteria and binds. Returns zero for
730 * success or a negative error status for failure.
731 */
732int acpi_bus_register_driver(struct acpi_driver *driver)
733{
734 int ret;
735
736 if (acpi_disabled)
737 return -ENODEV;
738 driver->drv.name = driver->name;
739 driver->drv.bus = &acpi_bus_type;
740 driver->drv.owner = driver->owner;
741
742 ret = driver_register(&driver->drv);
743 return ret;
744}
745
746EXPORT_SYMBOL(acpi_bus_register_driver);
747
748/**
749 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
750 * @driver: driver to unregister
751 *
752 * Unregisters a driver with the ACPI bus. Searches the namespace for all
753 * devices that match the driver's criteria and unbinds.
754 */
755void acpi_bus_unregister_driver(struct acpi_driver *driver)
756{
757 driver_unregister(&driver->drv);
758}
759
760EXPORT_SYMBOL(acpi_bus_unregister_driver);
761
762/* --------------------------------------------------------------------------
763 ACPI Bus operations
764 -------------------------------------------------------------------------- */
765
766static int acpi_bus_match(struct device *dev, struct device_driver *drv)
767{
768 struct acpi_device *acpi_dev = to_acpi_device(dev);
769 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
770
771 return acpi_dev->flags.match_driver
772 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
773}
774
775static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
776{
777 return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
778}
779
780static int acpi_device_probe(struct device *dev)
781{
782 struct acpi_device *acpi_dev = to_acpi_device(dev);
783 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
784 int ret;
785
786 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
787 return -EINVAL;
788
789 if (!acpi_drv->ops.add)
790 return -ENOSYS;
791
792 ret = acpi_drv->ops.add(acpi_dev);
793 if (ret)
794 return ret;
795
796 acpi_dev->driver = acpi_drv;
797 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
798 "Driver [%s] successfully bound to device [%s]\n",
799 acpi_drv->name, acpi_dev->pnp.bus_id));
800
801 if (acpi_drv->ops.notify) {
802 ret = acpi_device_install_notify_handler(acpi_dev);
803 if (ret) {
804 if (acpi_drv->ops.remove)
805 acpi_drv->ops.remove(acpi_dev);
806
807 acpi_dev->driver = NULL;
808 acpi_dev->driver_data = NULL;
809 return ret;
810 }
811 }
812
813 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found driver [%s] for device [%s]\n",
814 acpi_drv->name, acpi_dev->pnp.bus_id));
815 get_device(dev);
816 return 0;
817}
818
819static int acpi_device_remove(struct device * dev)
820{
821 struct acpi_device *acpi_dev = to_acpi_device(dev);
822 struct acpi_driver *acpi_drv = acpi_dev->driver;
823
824 if (acpi_drv) {
825 if (acpi_drv->ops.notify)
826 acpi_device_remove_notify_handler(acpi_dev);
827 if (acpi_drv->ops.remove)
828 acpi_drv->ops.remove(acpi_dev);
829 }
830 acpi_dev->driver = NULL;
831 acpi_dev->driver_data = NULL;
832
833 put_device(dev);
834 return 0;
835}
836
837struct bus_type acpi_bus_type = {
838 .name = "acpi",
839 .match = acpi_bus_match,
840 .probe = acpi_device_probe,
841 .remove = acpi_device_remove,
842 .uevent = acpi_device_uevent,
843};
844
1da177e4
LT
845/* --------------------------------------------------------------------------
846 Initialization/Cleanup
847 -------------------------------------------------------------------------- */
848
4be44fcd 849static int __init acpi_bus_init_irq(void)
1da177e4 850{
6a8c0af6 851 acpi_status status;
4be44fcd 852 char *message = NULL;
1da177e4 853
1da177e4 854
aafbcd16 855 /*
1da177e4
LT
856 * Let the system know what interrupt model we are using by
857 * evaluating the \_PIC object, if exists.
858 */
859
860 switch (acpi_irq_model) {
861 case ACPI_IRQ_MODEL_PIC:
862 message = "PIC";
863 break;
864 case ACPI_IRQ_MODEL_IOAPIC:
865 message = "IOAPIC";
866 break;
867 case ACPI_IRQ_MODEL_IOSAPIC:
868 message = "IOSAPIC";
869 break;
fbe61ec7
HG
870 case ACPI_IRQ_MODEL_GIC:
871 message = "GIC";
872 break;
3948ec94
JK
873 case ACPI_IRQ_MODEL_PLATFORM:
874 message = "platform specific model";
875 break;
1da177e4
LT
876 default:
877 printk(KERN_WARNING PREFIX "Unknown interrupt routing model\n");
d550d98d 878 return -ENODEV;
1da177e4
LT
879 }
880
881 printk(KERN_INFO PREFIX "Using %s for interrupt routing\n", message);
882
0db98202 883 status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1da177e4 884 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
a6fc6720 885 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PIC"));
d550d98d 886 return -ENODEV;
1da177e4
LT
887 }
888
d550d98d 889 return 0;
1da177e4
LT
890}
891
b064a8fa
RW
892/**
893 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
894 *
895 * The ACPI tables are accessible after this, but the handling of events has not
896 * been initialized and the global lock is not available yet, so AML should not
897 * be executed at this point.
898 *
899 * Doing this before switching the EFI runtime services to virtual mode allows
900 * the EfiBootServices memory to be freed slightly earlier on boot.
901 */
4be44fcd 902void __init acpi_early_init(void)
1da177e4 903{
6a8c0af6 904 acpi_status status;
1da177e4
LT
905
906 if (acpi_disabled)
d550d98d 907 return;
1da177e4 908
61686124
BM
909 printk(KERN_INFO PREFIX "Core revision %08x\n", ACPI_CA_VERSION);
910
4fc0a7e8
LZ
911 /* It's safe to verify table checksums during late stage */
912 acpi_gbl_verify_table_checksum = TRUE;
913
1da177e4
LT
914 /* enable workarounds, unless strict ACPI spec. compliance */
915 if (!acpi_strict)
916 acpi_gbl_enable_interpreter_slack = TRUE;
917
ad71860a
AS
918 acpi_gbl_permanent_mmap = 1;
919
aa2110cb
LM
920 /*
921 * If the machine falls into the DMI check table,
922 * DSDT will be copied to memory
923 */
924 dmi_check_system(dsdt_dmi_table);
925
ad71860a
AS
926 status = acpi_reallocate_root_table();
927 if (ACPI_FAILURE(status)) {
928 printk(KERN_ERR PREFIX
929 "Unable to reallocate ACPI tables\n");
930 goto error0;
931 }
932
1da177e4
LT
933 status = acpi_initialize_subsystem();
934 if (ACPI_FAILURE(status)) {
4be44fcd
LB
935 printk(KERN_ERR PREFIX
936 "Unable to initialize the ACPI Interpreter\n");
1da177e4
LT
937 goto error0;
938 }
939
fe6cbea0
LZ
940 if (acpi_gbl_group_module_level_code) {
941 status = acpi_load_tables();
942 if (ACPI_FAILURE(status)) {
943 printk(KERN_ERR PREFIX
944 "Unable to load the System Description Tables\n");
945 goto error0;
946 }
1da177e4
LT
947 }
948
1da177e4
LT
949#ifdef CONFIG_X86
950 if (!acpi_ioapic) {
1da177e4 951 /* compatible (0) means level (3) */
5f3b1a8b
AS
952 if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
953 acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
954 acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
955 }
1da177e4 956 /* Set PIC-mode SCI trigger type */
cee324b1 957 acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
5f3b1a8b 958 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1da177e4 959 } else {
1da177e4 960 /*
cee324b1 961 * now that acpi_gbl_FADT is initialized,
1da177e4
LT
962 * update it with result from INT_SRC_OVR parsing
963 */
cee324b1 964 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1da177e4
LT
965 }
966#endif
b064a8fa
RW
967 return;
968
969 error0:
970 disable_acpi();
971}
972
973/**
974 * acpi_subsystem_init - Finalize the early initialization of ACPI.
975 *
976 * Switch over the platform to the ACPI mode (if possible), initialize the
977 * handling of ACPI events, install the interrupt and global lock handlers.
978 *
979 * Doing this too early is generally unsafe, but at the same time it needs to be
980 * done before all things that really depend on ACPI. The right spot appears to
981 * be before finalizing the EFI initialization.
982 */
983void __init acpi_subsystem_init(void)
984{
985 acpi_status status;
986
987 if (acpi_disabled)
988 return;
1da177e4 989
4505a201 990 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1da177e4
LT
991 if (ACPI_FAILURE(status)) {
992 printk(KERN_ERR PREFIX "Unable to enable ACPI\n");
b064a8fa
RW
993 disable_acpi();
994 } else {
995 /*
996 * If the system is using ACPI then we can be reasonably
997 * confident that any regulators are managed by the firmware
998 * so tell the regulator core it has everything it needs to
999 * know.
1000 */
1001 regulator_has_full_constraints();
1da177e4 1002 }
1da177e4
LT
1003}
1004
4be44fcd 1005static int __init acpi_bus_init(void)
1da177e4 1006{
6a8c0af6
BH
1007 int result;
1008 acpi_status status;
1da177e4 1009
176f9c18 1010 acpi_os_initialize1();
1da177e4 1011
1da177e4
LT
1012 /*
1013 * ACPI 2.0 requires the EC driver to be loaded and work before
fe6cbea0
LZ
1014 * the EC device is found in the namespace (i.e. before
1015 * acpi_load_tables() is called).
1da177e4 1016 *
aafbcd16 1017 * This is accomplished by looking for the ECDT table, and getting
1da177e4
LT
1018 * the EC parameters out of that.
1019 */
1020 status = acpi_ec_ecdt_probe();
1021 /* Ignore result. Not having an ECDT is not fatal. */
1da177e4 1022
fe6cbea0
LZ
1023 if (!acpi_gbl_group_module_level_code) {
1024 status = acpi_load_tables();
1025 if (ACPI_FAILURE(status)) {
1026 printk(KERN_ERR PREFIX
1027 "Unable to load the System Description Tables\n");
1028 goto error1;
1029 }
1030 }
1031
1032 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1033 if (ACPI_FAILURE(status)) {
1034 printk(KERN_ERR PREFIX
1035 "Unable to start the ACPI Interpreter\n");
1036 goto error1;
1037 }
1038
1da177e4
LT
1039 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1040 if (ACPI_FAILURE(status)) {
1041 printk(KERN_ERR PREFIX "Unable to initialize ACPI objects\n");
1042 goto error1;
1043 }
1044
a2121167
SP
1045 /* Set capability bits for _OSC under processor scope */
1046 acpi_early_processor_osc();
1047
fc54ab72
LM
1048 /*
1049 * _OSC method may exist in module level code,
1050 * so it must be run after ACPI_FULL_INITIALIZATION
1051 */
1052 acpi_bus_osc_support();
1053
b1d248d9
ZR
1054 /*
1055 * _PDC control method may load dynamic SSDT tables,
1056 * and we need to install the table handler before that.
1057 */
1058 acpi_sysfs_init();
1059
78f16996
AC
1060 acpi_early_processor_set_pdc();
1061
455c8793
ZY
1062 /*
1063 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1064 * is necessary to enable it as early as possible.
1065 */
dcf15cbd 1066 acpi_ec_dsdt_probe();
455c8793 1067
1da177e4
LT
1068 printk(KERN_INFO PREFIX "Interpreter enabled\n");
1069
aafbcd16
AS
1070 /* Initialize sleep structures */
1071 acpi_sleep_init();
1072
1da177e4
LT
1073 /*
1074 * Get the system interrupt model and evaluate \_PIC.
1075 */
1076 result = acpi_bus_init_irq();
1077 if (result)
1078 goto error1;
1079
1080 /*
1081 * Register the for all standard device notifications.
1082 */
4be44fcd
LB
1083 status =
1084 acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1085 &acpi_bus_notify, NULL);
1da177e4 1086 if (ACPI_FAILURE(status)) {
4be44fcd
LB
1087 printk(KERN_ERR PREFIX
1088 "Unable to register for device notifications\n");
1da177e4
LT
1089 goto error1;
1090 }
1091
1092 /*
1093 * Create the top ACPI proc directory
1094 */
1095 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1096
1dcc3d33
RW
1097 result = bus_register(&acpi_bus_type);
1098 if (!result)
1099 return 0;
1da177e4
LT
1100
1101 /* Mimic structured exception handling */
4be44fcd 1102 error1:
1da177e4 1103 acpi_terminate();
d550d98d 1104 return -ENODEV;
1da177e4
LT
1105}
1106
99e0d2fc 1107struct kobject *acpi_kobj;
f2d4753f 1108EXPORT_SYMBOL_GPL(acpi_kobj);
1da177e4 1109
4be44fcd 1110static int __init acpi_init(void)
1da177e4 1111{
6831c6ed 1112 int result;
1da177e4 1113
1da177e4
LT
1114 if (acpi_disabled) {
1115 printk(KERN_INFO PREFIX "Interpreter disabled.\n");
d550d98d 1116 return -ENODEV;
1da177e4
LT
1117 }
1118
f62ed9e3 1119 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
99e0d2fc 1120 if (!acpi_kobj) {
96b2dd1f 1121 printk(KERN_WARNING "%s: kset create error\n", __func__);
99e0d2fc
GKH
1122 acpi_kobj = NULL;
1123 }
1da177e4 1124
0e46517d 1125 init_acpi_device_notify();
1da177e4 1126 result = acpi_bus_init();
6831c6ed 1127 if (result) {
1da177e4 1128 disable_acpi();
81d0273d 1129 return result;
6831c6ed 1130 }
81d0273d 1131
6831c6ed 1132 pci_mmcfg_late_init();
e747f274 1133 acpi_scan_init();
a5f820fe 1134 acpi_ec_init();
a25ee920 1135 acpi_debugfs_init();
9cee43e0 1136 acpi_sleep_proc_init();
201b8c65 1137 acpi_wakeup_device_init();
836d0830 1138 acpi_debugger_init();
6831c6ed 1139 return 0;
1da177e4
LT
1140}
1141
1142subsys_initcall(acpi_init);