1 /******************************************************************************
3 * Module Name: evrgnini- ACPI address_space (op_region) init
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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>
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
66 * DESCRIPTION: Setup a system_memory operation region
68 ******************************************************************************/
71 acpi_ev_system_memory_region_setup(acpi_handle handle
,
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
->
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
128 * DESCRIPTION: Setup a IO operation region
130 ******************************************************************************/
133 acpi_ev_io_space_region_setup(acpi_handle handle
,
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
;
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
159 * DESCRIPTION: Setup a PCI_Config operation region
161 * MUTEX: Assumes namespace is not locked
163 ******************************************************************************/
166 acpi_ev_pci_config_region_setup(acpi_handle handle
,
168 void *handler_context
, void **region_context
)
170 acpi_status status
= AE_OK
;
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
;
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",
191 return_ACPI_STATUS(AE_NOT_EXIST
);
194 *region_context
= NULL
;
195 if (function
== ACPI_REGION_DEACTIVATE
) {
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
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.
240 ACPI_EXCEPTION((AE_INFO
, status
,
241 "Could not install PciConfig handler "
242 "for Root Bridge %4.4s",
243 acpi_ut_get_node_name
250 pci_root_node
= pci_root_node
->parent
;
253 /* PCI root bridge not found, use namespace root node */
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
));
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
) {
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 */
325 acpi_hw_derive_pci_id(pci_id
, pci_root_node
,
326 region_obj
->region
.node
);
327 if (ACPI_FAILURE(status
)) {
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
)
352 struct acpi_pnp_device_id
*hid
;
353 struct acpi_pnp_device_id_list
*cid
;
357 /* Get the _HID and check for a PCI Root Bridge */
359 status
= acpi_ut_execute_HID(node
, &hid
);
360 if (ACPI_FAILURE(status
)) {
364 match
= acpi_ut_is_pci_root_bridge(hid
->string
);
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
)) {
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
)) {
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
402 * DESCRIPTION: Setup a pci_BAR operation region
404 * MUTEX: Assumes namespace is not locked
406 ******************************************************************************/
409 acpi_ev_pci_bar_region_setup(acpi_handle handle
,
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
429 * DESCRIPTION: Setup a CMOS operation region
431 * MUTEX: Assumes namespace is not locked
433 ******************************************************************************/
436 acpi_ev_cmos_region_setup(acpi_handle handle
,
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
456 * DESCRIPTION: Default region initialization
458 ******************************************************************************/
461 acpi_ev_default_region_setup(acpi_handle handle
,
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
;
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?
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
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 ******************************************************************************/
502 acpi_ev_initialize_region(union acpi_operand_object
*region_obj
,
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
;
510 struct acpi_namespace_node
*method_node
;
511 acpi_name
*reg_name_ptr
= (acpi_name
*) METHOD_NAME__REG
;
512 union acpi_operand_object
*region_obj2
;
514 ACPI_FUNCTION_TRACE_U32(ev_initialize_region
, acpi_ns_locked
);
517 return_ACPI_STATUS(AE_BAD_PARAMETER
);
520 if (region_obj
->common
.flags
& AOPOBJ_OBJECT_INITIALIZED
) {
521 return_ACPI_STATUS(AE_OK
);
524 region_obj2
= acpi_ns_get_secondary_object(region_obj
);
526 return_ACPI_STATUS(AE_NOT_EXIST
);
529 node
= region_obj
->region
.node
->parent
;
530 space_id
= region_obj
->region
.space_id
;
534 region_obj
->region
.handler
= NULL
;
535 region_obj2
->extra
.method_REG
= NULL
;
536 region_obj
->common
.flags
&= ~(AOPOBJ_SETUP_COMPLETE
);
537 region_obj
->common
.flags
|= AOPOBJ_OBJECT_INITIALIZED
;
539 /* Find any "_REG" method associated with this region definition */
542 acpi_ns_search_one_scope(*reg_name_ptr
, node
, ACPI_TYPE_METHOD
,
544 if (ACPI_SUCCESS(status
)) {
546 * The _REG method is optional and there can be only one per region
547 * definition. This will be executed when the handler is attached
550 region_obj2
->extra
.method_REG
= method_node
;
554 * The following loop depends upon the root Node having no parent
555 * ie: acpi_gbl_root_node->parent_entry being set to NULL
559 /* Check to see if a handler exists */
562 obj_desc
= acpi_ns_get_attached_object(node
);
565 /* Can only be a handler if the object exists */
567 switch (node
->type
) {
568 case ACPI_TYPE_DEVICE
:
570 handler_obj
= obj_desc
->device
.handler
;
573 case ACPI_TYPE_PROCESSOR
:
575 handler_obj
= obj_desc
->processor
.handler
;
578 case ACPI_TYPE_THERMAL
:
580 handler_obj
= obj_desc
->thermal_zone
.handler
;
583 case ACPI_TYPE_METHOD
:
585 * If we are executing module level code, the original
586 * Node's object was replaced by this Method object and we
587 * saved the handler in the method object.
589 * See acpi_ns_exec_module_code
591 if (obj_desc
->method
.
592 info_flags
& ACPI_METHOD_MODULE_LEVEL
) {
594 obj_desc
->method
.dispatch
.handler
;
600 /* Ignore other objects */
605 while (handler_obj
) {
607 /* Is this handler of the correct type? */
609 if (handler_obj
->address_space
.space_id
==
612 /* Found correct handler */
614 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION
,
615 "Found handler %p for region %p in obj %p\n",
621 acpi_ev_attach_region(handler_obj
,
626 * Tell all users that this region is usable by
627 * running the _REG method
629 if (acpi_ns_locked
) {
631 acpi_ut_release_mutex
632 (ACPI_MTX_NAMESPACE
);
633 if (ACPI_FAILURE(status
)) {
640 acpi_ev_execute_reg_method
641 (region_obj
, ACPI_REG_CONNECT
);
643 if (acpi_ns_locked
) {
645 acpi_ut_acquire_mutex
646 (ACPI_MTX_NAMESPACE
);
647 if (ACPI_FAILURE(status
)) {
653 return_ACPI_STATUS(AE_OK
);
656 /* Try next handler in the list */
658 handler_obj
= handler_obj
->address_space
.next
;
662 /* This node does not have the handler we need; Pop up one level */
667 /* If we get here, there is no handler for this region */
669 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION
,
670 "No handler for RegionType %s(%X) (RegionObj %p)\n",
671 acpi_ut_get_region_name(space_id
), space_id
,
674 return_ACPI_STATUS(AE_NOT_EXIST
);