1 /******************************************************************************
3 * Module Name: evrgnini- ACPI address_space (op_region) init
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
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>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME("evrgnini")
51 /* Local prototypes */
52 static u8
acpi_ev_match_pci_root_bridge(char *id
);
54 static u8
acpi_ev_is_pci_root_bridge(struct acpi_namespace_node
*node
);
56 /*******************************************************************************
58 * FUNCTION: acpi_ev_system_memory_region_setup
60 * PARAMETERS: Handle - Region we are interested in
61 * Function - Start or stop
62 * handler_context - Address space handler context
63 * region_context - Region specific context
67 * DESCRIPTION: Setup a system_memory operation region
69 ******************************************************************************/
72 acpi_ev_system_memory_region_setup(acpi_handle handle
,
74 void *handler_context
, void **region_context
)
76 union acpi_operand_object
*region_desc
=
77 (union acpi_operand_object
*)handle
;
78 struct acpi_mem_space_context
*local_region_context
;
80 ACPI_FUNCTION_TRACE(ev_system_memory_region_setup
);
82 if (function
== ACPI_REGION_DEACTIVATE
) {
83 if (*region_context
) {
84 local_region_context
=
85 (struct acpi_mem_space_context
*)*region_context
;
87 /* Delete a cached mapping if present */
89 if (local_region_context
->mapped_length
) {
90 acpi_os_unmap_memory(local_region_context
->
91 mapped_logical_address
,
92 local_region_context
->
95 ACPI_FREE(local_region_context
);
96 *region_context
= NULL
;
98 return_ACPI_STATUS(AE_OK
);
101 /* Create a new context */
103 local_region_context
=
104 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_mem_space_context
));
105 if (!(local_region_context
)) {
106 return_ACPI_STATUS(AE_NO_MEMORY
);
109 /* Save the region length and address for use in the handler */
111 local_region_context
->length
= region_desc
->region
.length
;
112 local_region_context
->address
= region_desc
->region
.address
;
114 *region_context
= local_region_context
;
115 return_ACPI_STATUS(AE_OK
);
118 /*******************************************************************************
120 * FUNCTION: acpi_ev_io_space_region_setup
122 * PARAMETERS: Handle - Region we are interested in
123 * Function - Start or stop
124 * handler_context - Address space handler context
125 * region_context - Region specific context
129 * DESCRIPTION: Setup a IO operation region
131 ******************************************************************************/
134 acpi_ev_io_space_region_setup(acpi_handle handle
,
136 void *handler_context
, void **region_context
)
138 ACPI_FUNCTION_TRACE(ev_io_space_region_setup
);
140 if (function
== ACPI_REGION_DEACTIVATE
) {
141 *region_context
= NULL
;
143 *region_context
= handler_context
;
146 return_ACPI_STATUS(AE_OK
);
149 /*******************************************************************************
151 * FUNCTION: acpi_ev_pci_config_region_setup
153 * PARAMETERS: Handle - Region we are interested in
154 * Function - Start or stop
155 * handler_context - Address space handler context
156 * region_context - Region specific context
160 * DESCRIPTION: Setup a PCI_Config operation region
162 * MUTEX: Assumes namespace is not locked
164 ******************************************************************************/
167 acpi_ev_pci_config_region_setup(acpi_handle handle
,
169 void *handler_context
, void **region_context
)
171 acpi_status status
= AE_OK
;
172 acpi_integer pci_value
;
173 struct acpi_pci_id
*pci_id
= *region_context
;
174 union acpi_operand_object
*handler_obj
;
175 struct acpi_namespace_node
*parent_node
;
176 struct acpi_namespace_node
*pci_root_node
;
177 struct acpi_namespace_node
*pci_device_node
;
178 union acpi_operand_object
*region_obj
=
179 (union acpi_operand_object
*)handle
;
181 ACPI_FUNCTION_TRACE(ev_pci_config_region_setup
);
183 handler_obj
= region_obj
->region
.handler
;
186 * No installed handler. This shouldn't happen because the dispatch
187 * routine checks before we get here, but we check again just in case.
189 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION
,
190 "Attempting to init a region %p, with no handler\n",
192 return_ACPI_STATUS(AE_NOT_EXIST
);
195 *region_context
= NULL
;
196 if (function
== ACPI_REGION_DEACTIVATE
) {
200 return_ACPI_STATUS(status
);
203 parent_node
= acpi_ns_get_parent_node(region_obj
->region
.node
);
206 * Get the _SEG and _BBN values from the device upon which the handler
209 * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
210 * This is the device the handler has been registered to handle.
214 * If the address_space.Node is still pointing to the root, we need
215 * to scan upward for a PCI Root bridge and re-associate the op_region
216 * handlers with that device.
218 if (handler_obj
->address_space
.node
== acpi_gbl_root_node
) {
220 /* Start search from the parent object */
222 pci_root_node
= parent_node
;
223 while (pci_root_node
!= acpi_gbl_root_node
) {
225 /* Get the _HID/_CID in order to detect a root_bridge */
227 if (acpi_ev_is_pci_root_bridge(pci_root_node
)) {
229 /* Install a handler for this PCI root bridge */
232 acpi_install_address_space_handler((acpi_handle
) pci_root_node
, ACPI_ADR_SPACE_PCI_CONFIG
, ACPI_DEFAULT_HANDLER
, NULL
, NULL
);
233 if (ACPI_FAILURE(status
)) {
234 if (status
== AE_SAME_HANDLER
) {
236 * It is OK if the handler is already installed on the root
237 * bridge. Still need to return a context object for the
238 * new PCI_Config operation region, however.
242 ACPI_EXCEPTION((AE_INFO
, status
,
243 "Could not install PciConfig handler for Root Bridge %4.4s",
244 acpi_ut_get_node_name
251 pci_root_node
= acpi_ns_get_parent_node(pci_root_node
);
254 /* PCI root bridge not found, use namespace root node */
256 pci_root_node
= handler_obj
->address_space
.node
;
260 * If this region is now initialized, we are done.
261 * (install_address_space_handler could have initialized it)
263 if (region_obj
->region
.flags
& AOPOBJ_SETUP_COMPLETE
) {
264 return_ACPI_STATUS(AE_OK
);
267 /* Region is still not initialized. Create a new context */
269 pci_id
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pci_id
));
271 return_ACPI_STATUS(AE_NO_MEMORY
);
275 * For PCI_Config space access, we need the segment, bus,
276 * device and function numbers. Acquire them here.
278 * Find the parent device object. (This allows the operation region to be
279 * within a subscope under the device, such as a control method.)
281 pci_device_node
= region_obj
->region
.node
;
282 while (pci_device_node
&& (pci_device_node
->type
!= ACPI_TYPE_DEVICE
)) {
283 pci_device_node
= acpi_ns_get_parent_node(pci_device_node
);
286 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.
295 acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR
, pci_device_node
,
299 * The default is zero, and since the allocation above zeroed
300 * the data, just do nothing on failure.
302 if (ACPI_SUCCESS(status
)) {
303 pci_id
->device
= ACPI_HIWORD(ACPI_LODWORD(pci_value
));
304 pci_id
->function
= ACPI_LOWORD(ACPI_LODWORD(pci_value
));
307 /* The PCI segment number comes from the _SEG method */
310 acpi_ut_evaluate_numeric_object(METHOD_NAME__SEG
, pci_root_node
,
312 if (ACPI_SUCCESS(status
)) {
313 pci_id
->segment
= ACPI_LOWORD(pci_value
);
316 /* The PCI bus number comes from the _BBN method */
319 acpi_ut_evaluate_numeric_object(METHOD_NAME__BBN
, pci_root_node
,
321 if (ACPI_SUCCESS(status
)) {
322 pci_id
->bus
= ACPI_LOWORD(pci_value
);
325 /* Complete this device's pci_id */
327 acpi_os_derive_pci_id(pci_root_node
, region_obj
->region
.node
, &pci_id
);
329 *region_context
= pci_id
;
330 return_ACPI_STATUS(AE_OK
);
333 /*******************************************************************************
335 * FUNCTION: acpi_ev_match_pci_root_bridge
337 * PARAMETERS: Id - The HID/CID in string format
339 * RETURN: TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
341 * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
343 ******************************************************************************/
345 static u8
acpi_ev_match_pci_root_bridge(char *id
)
349 * Check if this is a PCI root.
350 * ACPI 3.0+: check for a PCI Express root also.
352 if (!(ACPI_STRNCMP(id
,
354 sizeof(PCI_ROOT_HID_STRING
))) ||
356 PCI_EXPRESS_ROOT_HID_STRING
,
357 sizeof(PCI_EXPRESS_ROOT_HID_STRING
)))) {
364 /*******************************************************************************
366 * FUNCTION: acpi_ev_is_pci_root_bridge
368 * PARAMETERS: Node - Device node being examined
370 * RETURN: TRUE if device is a PCI/PCI-Express Root Bridge
372 * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
373 * examining the _HID and _CID for the device.
375 ******************************************************************************/
377 static u8
acpi_ev_is_pci_root_bridge(struct acpi_namespace_node
*node
)
380 struct acpi_device_id hid
;
381 struct acpi_compatible_id_list
*cid
;
385 * Get the _HID and check for a PCI Root Bridge
387 status
= acpi_ut_execute_HID(node
, &hid
);
388 if (ACPI_FAILURE(status
)) {
392 if (acpi_ev_match_pci_root_bridge(hid
.value
)) {
397 * The _HID did not match.
398 * Get the _CID and check for a PCI Root Bridge
400 status
= acpi_ut_execute_CID(node
, &cid
);
401 if (ACPI_FAILURE(status
)) {
405 /* Check all _CIDs in the returned list */
407 for (i
= 0; i
< cid
->count
; i
++) {
408 if (acpi_ev_match_pci_root_bridge(cid
->id
[i
].value
)) {
418 /*******************************************************************************
420 * FUNCTION: acpi_ev_pci_bar_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 pci_bAR operation region
431 * MUTEX: Assumes namespace is not locked
433 ******************************************************************************/
436 acpi_ev_pci_bar_region_setup(acpi_handle handle
,
438 void *handler_context
, void **region_context
)
440 ACPI_FUNCTION_TRACE(ev_pci_bar_region_setup
);
442 return_ACPI_STATUS(AE_OK
);
445 /*******************************************************************************
447 * FUNCTION: acpi_ev_cmos_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: Setup a CMOS operation region
458 * MUTEX: Assumes namespace is not locked
460 ******************************************************************************/
463 acpi_ev_cmos_region_setup(acpi_handle handle
,
465 void *handler_context
, void **region_context
)
467 ACPI_FUNCTION_TRACE(ev_cmos_region_setup
);
469 return_ACPI_STATUS(AE_OK
);
472 /*******************************************************************************
474 * FUNCTION: acpi_ev_default_region_setup
476 * PARAMETERS: Handle - Region we are interested in
477 * Function - Start or stop
478 * handler_context - Address space handler context
479 * region_context - Region specific context
483 * DESCRIPTION: Default region initialization
485 ******************************************************************************/
488 acpi_ev_default_region_setup(acpi_handle handle
,
490 void *handler_context
, void **region_context
)
492 ACPI_FUNCTION_TRACE(ev_default_region_setup
);
494 if (function
== ACPI_REGION_DEACTIVATE
) {
495 *region_context
= NULL
;
497 *region_context
= handler_context
;
500 return_ACPI_STATUS(AE_OK
);
503 /*******************************************************************************
505 * FUNCTION: acpi_ev_initialize_region
507 * PARAMETERS: region_obj - Region we are initializing
508 * acpi_ns_locked - Is namespace locked?
512 * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
513 * for execution at a later time
515 * Get the appropriate address space handler for a newly
518 * This also performs address space specific initialization. For
519 * example, PCI regions must have an _ADR object that contains
520 * a PCI address in the scope of the definition. This address is
521 * required to perform an access to PCI config space.
523 * MUTEX: Interpreter should be unlocked, because we may run the _REG
524 * method for this region.
526 ******************************************************************************/
529 acpi_ev_initialize_region(union acpi_operand_object
*region_obj
,
532 union acpi_operand_object
*handler_obj
;
533 union acpi_operand_object
*obj_desc
;
534 acpi_adr_space_type space_id
;
535 struct acpi_namespace_node
*node
;
537 struct acpi_namespace_node
*method_node
;
538 acpi_name
*reg_name_ptr
= (acpi_name
*) METHOD_NAME__REG
;
539 union acpi_operand_object
*region_obj2
;
541 ACPI_FUNCTION_TRACE_U32(ev_initialize_region
, acpi_ns_locked
);
544 return_ACPI_STATUS(AE_BAD_PARAMETER
);
547 if (region_obj
->common
.flags
& AOPOBJ_OBJECT_INITIALIZED
) {
548 return_ACPI_STATUS(AE_OK
);
551 region_obj2
= acpi_ns_get_secondary_object(region_obj
);
553 return_ACPI_STATUS(AE_NOT_EXIST
);
556 node
= acpi_ns_get_parent_node(region_obj
->region
.node
);
557 space_id
= region_obj
->region
.space_id
;
561 region_obj
->region
.handler
= NULL
;
562 region_obj2
->extra
.method_REG
= NULL
;
563 region_obj
->common
.flags
&= ~(AOPOBJ_SETUP_COMPLETE
);
564 region_obj
->common
.flags
|= AOPOBJ_OBJECT_INITIALIZED
;
566 /* Find any "_REG" method associated with this region definition */
569 acpi_ns_search_one_scope(*reg_name_ptr
, node
, ACPI_TYPE_METHOD
,
571 if (ACPI_SUCCESS(status
)) {
573 * The _REG method is optional and there can be only one per region
574 * definition. This will be executed when the handler is attached
577 region_obj2
->extra
.method_REG
= method_node
;
581 * The following loop depends upon the root Node having no parent
582 * ie: acpi_gbl_root_node->parent_entry being set to NULL
586 /* Check to see if a handler exists */
589 obj_desc
= acpi_ns_get_attached_object(node
);
592 /* Can only be a handler if the object exists */
594 switch (node
->type
) {
595 case ACPI_TYPE_DEVICE
:
597 handler_obj
= obj_desc
->device
.handler
;
600 case ACPI_TYPE_PROCESSOR
:
602 handler_obj
= obj_desc
->processor
.handler
;
605 case ACPI_TYPE_THERMAL
:
607 handler_obj
= obj_desc
->thermal_zone
.handler
;
611 /* Ignore other objects */
615 while (handler_obj
) {
617 /* Is this handler of the correct type? */
619 if (handler_obj
->address_space
.space_id
==
622 /* Found correct handler */
624 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION
,
625 "Found handler %p for region %p in obj %p\n",
631 acpi_ev_attach_region(handler_obj
,
636 * Tell all users that this region is usable by running the _REG
639 if (acpi_ns_locked
) {
641 acpi_ut_release_mutex
642 (ACPI_MTX_NAMESPACE
);
643 if (ACPI_FAILURE(status
)) {
650 acpi_ev_execute_reg_method
653 if (acpi_ns_locked
) {
655 acpi_ut_acquire_mutex
656 (ACPI_MTX_NAMESPACE
);
657 if (ACPI_FAILURE(status
)) {
663 return_ACPI_STATUS(AE_OK
);
666 /* Try next handler in the list */
668 handler_obj
= handler_obj
->address_space
.next
;
673 * This node does not have the handler we need;
676 node
= acpi_ns_get_parent_node(node
);
679 /* If we get here, there is no handler for this region */
681 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION
,
682 "No handler for RegionType %s(%X) (RegionObj %p)\n",
683 acpi_ut_get_region_name(space_id
), space_id
,
686 return_ACPI_STATUS(AE_NOT_EXIST
);