x86/boot: Rename overlapping memcpy() to memmove()
[linux/fpc-iii.git] / drivers / acpi / acpica / evrgnini.c
blobfda869c9ad0b9984e9fc2e4e545295596e06f978
1 /******************************************************************************
3 * Module Name: evrgnini- ACPI address_space (op_region) init
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acevents.h"
47 #include "acnamesp.h"
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME("evrgnini")
52 /* Local prototypes */
53 static u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node);
55 /*******************************************************************************
57 * FUNCTION: acpi_ev_system_memory_region_setup
59 * PARAMETERS: handle - Region we are interested in
60 * function - Start or stop
61 * handler_context - Address space handler context
62 * region_context - Region specific context
64 * RETURN: Status
66 * DESCRIPTION: Setup a system_memory operation region
68 ******************************************************************************/
70 acpi_status
71 acpi_ev_system_memory_region_setup(acpi_handle handle,
72 u32 function,
73 void *handler_context, void **region_context)
75 union acpi_operand_object *region_desc =
76 (union acpi_operand_object *)handle;
77 struct acpi_mem_space_context *local_region_context;
79 ACPI_FUNCTION_TRACE(ev_system_memory_region_setup);
81 if (function == ACPI_REGION_DEACTIVATE) {
82 if (*region_context) {
83 local_region_context =
84 (struct acpi_mem_space_context *)*region_context;
86 /* Delete a cached mapping if present */
88 if (local_region_context->mapped_length) {
89 acpi_os_unmap_memory(local_region_context->
90 mapped_logical_address,
91 local_region_context->
92 mapped_length);
94 ACPI_FREE(local_region_context);
95 *region_context = NULL;
97 return_ACPI_STATUS(AE_OK);
100 /* Create a new context */
102 local_region_context =
103 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_mem_space_context));
104 if (!(local_region_context)) {
105 return_ACPI_STATUS(AE_NO_MEMORY);
108 /* Save the region length and address for use in the handler */
110 local_region_context->length = region_desc->region.length;
111 local_region_context->address = region_desc->region.address;
113 *region_context = local_region_context;
114 return_ACPI_STATUS(AE_OK);
117 /*******************************************************************************
119 * FUNCTION: acpi_ev_io_space_region_setup
121 * PARAMETERS: handle - Region we are interested in
122 * function - Start or stop
123 * handler_context - Address space handler context
124 * region_context - Region specific context
126 * RETURN: Status
128 * DESCRIPTION: Setup a IO operation region
130 ******************************************************************************/
132 acpi_status
133 acpi_ev_io_space_region_setup(acpi_handle handle,
134 u32 function,
135 void *handler_context, void **region_context)
137 ACPI_FUNCTION_TRACE(ev_io_space_region_setup);
139 if (function == ACPI_REGION_DEACTIVATE) {
140 *region_context = NULL;
141 } else {
142 *region_context = handler_context;
145 return_ACPI_STATUS(AE_OK);
148 /*******************************************************************************
150 * FUNCTION: acpi_ev_pci_config_region_setup
152 * PARAMETERS: handle - Region we are interested in
153 * function - Start or stop
154 * handler_context - Address space handler context
155 * region_context - Region specific context
157 * RETURN: Status
159 * DESCRIPTION: Setup a PCI_Config operation region
161 * MUTEX: Assumes namespace is not locked
163 ******************************************************************************/
165 acpi_status
166 acpi_ev_pci_config_region_setup(acpi_handle handle,
167 u32 function,
168 void *handler_context, void **region_context)
170 acpi_status status = AE_OK;
171 u64 pci_value;
172 struct acpi_pci_id *pci_id = *region_context;
173 union acpi_operand_object *handler_obj;
174 struct acpi_namespace_node *parent_node;
175 struct acpi_namespace_node *pci_root_node;
176 struct acpi_namespace_node *pci_device_node;
177 union acpi_operand_object *region_obj =
178 (union acpi_operand_object *)handle;
180 ACPI_FUNCTION_TRACE(ev_pci_config_region_setup);
182 handler_obj = region_obj->region.handler;
183 if (!handler_obj) {
185 * No installed handler. This shouldn't happen because the dispatch
186 * routine checks before we get here, but we check again just in case.
188 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
189 "Attempting to init a region %p, with no handler\n",
190 region_obj));
191 return_ACPI_STATUS(AE_NOT_EXIST);
194 *region_context = NULL;
195 if (function == ACPI_REGION_DEACTIVATE) {
196 if (pci_id) {
197 ACPI_FREE(pci_id);
199 return_ACPI_STATUS(status);
202 parent_node = region_obj->region.node->parent;
205 * Get the _SEG and _BBN values from the device upon which the handler
206 * is installed.
208 * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
209 * This is the device the handler has been registered to handle.
213 * If the address_space.Node is still pointing to the root, we need
214 * to scan upward for a PCI Root bridge and re-associate the op_region
215 * handlers with that device.
217 if (handler_obj->address_space.node == acpi_gbl_root_node) {
219 /* Start search from the parent object */
221 pci_root_node = parent_node;
222 while (pci_root_node != acpi_gbl_root_node) {
224 /* Get the _HID/_CID in order to detect a root_bridge */
226 if (acpi_ev_is_pci_root_bridge(pci_root_node)) {
228 /* Install a handler for this PCI root bridge */
230 status = acpi_install_address_space_handler((acpi_handle) pci_root_node, ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
231 if (ACPI_FAILURE(status)) {
232 if (status == AE_SAME_HANDLER) {
234 * It is OK if the handler is already installed on the
235 * root bridge. Still need to return a context object
236 * for the new PCI_Config operation region, however.
238 status = AE_OK;
239 } else {
240 ACPI_EXCEPTION((AE_INFO, status,
241 "Could not install PciConfig handler "
242 "for Root Bridge %4.4s",
243 acpi_ut_get_node_name
244 (pci_root_node)));
247 break;
250 pci_root_node = pci_root_node->parent;
253 /* PCI root bridge not found, use namespace root node */
254 } else {
255 pci_root_node = handler_obj->address_space.node;
259 * If this region is now initialized, we are done.
260 * (install_address_space_handler could have initialized it)
262 if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
263 return_ACPI_STATUS(AE_OK);
266 /* Region is still not initialized. Create a new context */
268 pci_id = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pci_id));
269 if (!pci_id) {
270 return_ACPI_STATUS(AE_NO_MEMORY);
274 * For PCI_Config space access, we need the segment, bus, device and
275 * function numbers. Acquire them here.
277 * Find the parent device object. (This allows the operation region to be
278 * within a subscope under the device, such as a control method.)
280 pci_device_node = region_obj->region.node;
281 while (pci_device_node && (pci_device_node->type != ACPI_TYPE_DEVICE)) {
282 pci_device_node = pci_device_node->parent;
285 if (!pci_device_node) {
286 ACPI_FREE(pci_id);
287 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
291 * Get the PCI device and function numbers from the _ADR object
292 * contained in the parent's scope.
294 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR,
295 pci_device_node, &pci_value);
298 * The default is zero, and since the allocation above zeroed the data,
299 * just do nothing on failure.
301 if (ACPI_SUCCESS(status)) {
302 pci_id->device = ACPI_HIWORD(ACPI_LODWORD(pci_value));
303 pci_id->function = ACPI_LOWORD(ACPI_LODWORD(pci_value));
306 /* The PCI segment number comes from the _SEG method */
308 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__SEG,
309 pci_root_node, &pci_value);
310 if (ACPI_SUCCESS(status)) {
311 pci_id->segment = ACPI_LOWORD(pci_value);
314 /* The PCI bus number comes from the _BBN method */
316 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__BBN,
317 pci_root_node, &pci_value);
318 if (ACPI_SUCCESS(status)) {
319 pci_id->bus = ACPI_LOWORD(pci_value);
322 /* Complete/update the PCI ID for this device */
324 status =
325 acpi_hw_derive_pci_id(pci_id, pci_root_node,
326 region_obj->region.node);
327 if (ACPI_FAILURE(status)) {
328 ACPI_FREE(pci_id);
329 return_ACPI_STATUS(status);
332 *region_context = pci_id;
333 return_ACPI_STATUS(AE_OK);
336 /*******************************************************************************
338 * FUNCTION: acpi_ev_is_pci_root_bridge
340 * PARAMETERS: node - Device node being examined
342 * RETURN: TRUE if device is a PCI/PCI-Express Root Bridge
344 * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
345 * examining the _HID and _CID for the device.
347 ******************************************************************************/
349 static u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node)
351 acpi_status status;
352 struct acpi_pnp_device_id *hid;
353 struct acpi_pnp_device_id_list *cid;
354 u32 i;
355 u8 match;
357 /* Get the _HID and check for a PCI Root Bridge */
359 status = acpi_ut_execute_HID(node, &hid);
360 if (ACPI_FAILURE(status)) {
361 return (FALSE);
364 match = acpi_ut_is_pci_root_bridge(hid->string);
365 ACPI_FREE(hid);
367 if (match) {
368 return (TRUE);
371 /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
373 status = acpi_ut_execute_CID(node, &cid);
374 if (ACPI_FAILURE(status)) {
375 return (FALSE);
378 /* Check all _CIDs in the returned list */
380 for (i = 0; i < cid->count; i++) {
381 if (acpi_ut_is_pci_root_bridge(cid->ids[i].string)) {
382 ACPI_FREE(cid);
383 return (TRUE);
387 ACPI_FREE(cid);
388 return (FALSE);
391 /*******************************************************************************
393 * FUNCTION: acpi_ev_pci_bar_region_setup
395 * PARAMETERS: handle - Region we are interested in
396 * function - Start or stop
397 * handler_context - Address space handler context
398 * region_context - Region specific context
400 * RETURN: Status
402 * DESCRIPTION: Setup a pci_BAR operation region
404 * MUTEX: Assumes namespace is not locked
406 ******************************************************************************/
408 acpi_status
409 acpi_ev_pci_bar_region_setup(acpi_handle handle,
410 u32 function,
411 void *handler_context, void **region_context)
413 ACPI_FUNCTION_TRACE(ev_pci_bar_region_setup);
415 return_ACPI_STATUS(AE_OK);
418 /*******************************************************************************
420 * FUNCTION: acpi_ev_cmos_region_setup
422 * PARAMETERS: handle - Region we are interested in
423 * function - Start or stop
424 * handler_context - Address space handler context
425 * region_context - Region specific context
427 * RETURN: Status
429 * DESCRIPTION: Setup a CMOS operation region
431 * MUTEX: Assumes namespace is not locked
433 ******************************************************************************/
435 acpi_status
436 acpi_ev_cmos_region_setup(acpi_handle handle,
437 u32 function,
438 void *handler_context, void **region_context)
440 ACPI_FUNCTION_TRACE(ev_cmos_region_setup);
442 return_ACPI_STATUS(AE_OK);
445 /*******************************************************************************
447 * FUNCTION: acpi_ev_default_region_setup
449 * PARAMETERS: handle - Region we are interested in
450 * function - Start or stop
451 * handler_context - Address space handler context
452 * region_context - Region specific context
454 * RETURN: Status
456 * DESCRIPTION: Default region initialization
458 ******************************************************************************/
460 acpi_status
461 acpi_ev_default_region_setup(acpi_handle handle,
462 u32 function,
463 void *handler_context, void **region_context)
465 ACPI_FUNCTION_TRACE(ev_default_region_setup);
467 if (function == ACPI_REGION_DEACTIVATE) {
468 *region_context = NULL;
469 } else {
470 *region_context = handler_context;
473 return_ACPI_STATUS(AE_OK);
476 /*******************************************************************************
478 * FUNCTION: acpi_ev_initialize_region
480 * PARAMETERS: region_obj - Region we are initializing
481 * acpi_ns_locked - Is namespace locked?
483 * RETURN: Status
485 * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
486 * for execution at a later time
488 * Get the appropriate address space handler for a newly
489 * created region.
491 * This also performs address space specific initialization. For
492 * example, PCI regions must have an _ADR object that contains
493 * a PCI address in the scope of the definition. This address is
494 * required to perform an access to PCI config space.
496 * MUTEX: Interpreter should be unlocked, because we may run the _REG
497 * method for this region.
499 ******************************************************************************/
501 acpi_status
502 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
503 u8 acpi_ns_locked)
505 union acpi_operand_object *handler_obj;
506 union acpi_operand_object *obj_desc;
507 acpi_adr_space_type space_id;
508 struct acpi_namespace_node *node;
509 acpi_status status;
511 ACPI_FUNCTION_TRACE_U32(ev_initialize_region, acpi_ns_locked);
513 if (!region_obj) {
514 return_ACPI_STATUS(AE_BAD_PARAMETER);
517 if (region_obj->common.flags & AOPOBJ_OBJECT_INITIALIZED) {
518 return_ACPI_STATUS(AE_OK);
521 acpi_ev_associate_reg_method(region_obj);
522 region_obj->common.flags |= AOPOBJ_OBJECT_INITIALIZED;
524 node = region_obj->region.node->parent;
525 space_id = region_obj->region.space_id;
528 * The following loop depends upon the root Node having no parent
529 * ie: acpi_gbl_root_node->Parent being set to NULL
531 while (node) {
533 /* Check to see if a handler exists */
535 handler_obj = NULL;
536 obj_desc = acpi_ns_get_attached_object(node);
537 if (obj_desc) {
539 /* Can only be a handler if the object exists */
541 switch (node->type) {
542 case ACPI_TYPE_DEVICE:
543 case ACPI_TYPE_PROCESSOR:
544 case ACPI_TYPE_THERMAL:
546 handler_obj = obj_desc->common_notify.handler;
547 break;
549 case ACPI_TYPE_METHOD:
551 * If we are executing module level code, the original
552 * Node's object was replaced by this Method object and we
553 * saved the handler in the method object.
555 * See acpi_ns_exec_module_code
557 if (obj_desc->method.
558 info_flags & ACPI_METHOD_MODULE_LEVEL) {
559 handler_obj =
560 obj_desc->method.dispatch.handler;
562 break;
564 default:
566 /* Ignore other objects */
568 break;
571 handler_obj =
572 acpi_ev_find_region_handler(space_id, handler_obj);
573 if (handler_obj) {
575 /* Found correct handler */
577 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
578 "Found handler %p for region %p in obj %p\n",
579 handler_obj, region_obj,
580 obj_desc));
582 status =
583 acpi_ev_attach_region(handler_obj,
584 region_obj,
585 acpi_ns_locked);
588 * Tell all users that this region is usable by
589 * running the _REG method
591 if (acpi_ns_locked) {
592 status =
593 acpi_ut_release_mutex
594 (ACPI_MTX_NAMESPACE);
595 if (ACPI_FAILURE(status)) {
596 return_ACPI_STATUS(status);
600 status =
601 acpi_ev_execute_reg_method(region_obj,
602 ACPI_REG_CONNECT);
604 if (acpi_ns_locked) {
605 status =
606 acpi_ut_acquire_mutex
607 (ACPI_MTX_NAMESPACE);
608 if (ACPI_FAILURE(status)) {
609 return_ACPI_STATUS(status);
613 return_ACPI_STATUS(AE_OK);
617 /* This node does not have the handler we need; Pop up one level */
619 node = node->parent;
622 /* If we get here, there is no handler for this region */
624 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
625 "No handler for RegionType %s(%X) (RegionObj %p)\n",
626 acpi_ut_get_region_name(space_id), space_id,
627 region_obj));
629 return_ACPI_STATUS(AE_NOT_EXIST);