1 /******************************************************************************
3 * Module Name: evrgnini- ACPI address_space (op_region) init
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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_match_pci_root_bridge(char *id);
55 static u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node);
57 /*******************************************************************************
59 * FUNCTION: acpi_ev_system_memory_region_setup
61 * PARAMETERS: Handle - Region we are interested in
62 * Function - Start or stop
63 * handler_context - Address space handler context
64 * region_context - Region specific context
68 * DESCRIPTION: Setup a system_memory operation region
70 ******************************************************************************/
73 acpi_ev_system_memory_region_setup(acpi_handle handle,
75 void *handler_context, void **region_context)
77 union acpi_operand_object *region_desc =
78 (union acpi_operand_object *)handle;
79 struct acpi_mem_space_context *local_region_context;
81 ACPI_FUNCTION_TRACE(ev_system_memory_region_setup);
83 if (function == ACPI_REGION_DEACTIVATE) {
84 if (*region_context) {
85 local_region_context =
86 (struct acpi_mem_space_context *)*region_context;
88 /* Delete a cached mapping if present */
90 if (local_region_context->mapped_length) {
91 acpi_os_unmap_memory(local_region_context->
92 mapped_logical_address,
93 local_region_context->
96 ACPI_FREE(local_region_context);
97 *region_context = NULL;
99 return_ACPI_STATUS(AE_OK);
102 /* Create a new context */
104 local_region_context =
105 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_mem_space_context));
106 if (!(local_region_context)) {
107 return_ACPI_STATUS(AE_NO_MEMORY);
110 /* Save the region length and address for use in the handler */
112 local_region_context->length = region_desc->region.length;
113 local_region_context->address = region_desc->region.address;
115 *region_context = local_region_context;
116 return_ACPI_STATUS(AE_OK);
119 /*******************************************************************************
121 * FUNCTION: acpi_ev_io_space_region_setup
123 * PARAMETERS: Handle - Region we are interested in
124 * Function - Start or stop
125 * handler_context - Address space handler context
126 * region_context - Region specific context
130 * DESCRIPTION: Setup a IO operation region
132 ******************************************************************************/
135 acpi_ev_io_space_region_setup(acpi_handle handle,
137 void *handler_context, void **region_context)
139 ACPI_FUNCTION_TRACE(ev_io_space_region_setup);
141 if (function == ACPI_REGION_DEACTIVATE) {
142 *region_context = NULL;
144 *region_context = handler_context;
147 return_ACPI_STATUS(AE_OK);
150 /*******************************************************************************
152 * FUNCTION: acpi_ev_pci_config_region_setup
154 * PARAMETERS: Handle - Region we are interested in
155 * Function - Start or stop
156 * handler_context - Address space handler context
157 * region_context - Region specific context
161 * DESCRIPTION: Setup a PCI_Config operation region
163 * MUTEX: Assumes namespace is not locked
165 ******************************************************************************/
168 acpi_ev_pci_config_region_setup(acpi_handle handle,
170 void *handler_context, void **region_context)
172 acpi_status status = AE_OK;
173 acpi_integer pci_value;
174 struct acpi_pci_id *pci_id = *region_context;
175 union acpi_operand_object *handler_obj;
176 struct acpi_namespace_node *parent_node;
177 struct acpi_namespace_node *pci_root_node;
178 struct acpi_namespace_node *pci_device_node;
179 union acpi_operand_object *region_obj =
180 (union acpi_operand_object *)handle;
182 ACPI_FUNCTION_TRACE(ev_pci_config_region_setup);
184 handler_obj = region_obj->region.handler;
187 * No installed handler. This shouldn't happen because the dispatch
188 * routine checks before we get here, but we check again just in case.
190 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
191 "Attempting to init a region %p, with no handler\n",
193 return_ACPI_STATUS(AE_NOT_EXIST);
196 *region_context = NULL;
197 if (function == ACPI_REGION_DEACTIVATE) {
201 return_ACPI_STATUS(status);
204 parent_node = acpi_ns_get_parent_node(region_obj->region.node);
207 * Get the _SEG and _BBN values from the device upon which the handler
210 * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
211 * This is the device the handler has been registered to handle.
215 * If the address_space.Node is still pointing to the root, we need
216 * to scan upward for a PCI Root bridge and re-associate the op_region
217 * handlers with that device.
219 if (handler_obj->address_space.node == acpi_gbl_root_node) {
221 /* Start search from the parent object */
223 pci_root_node = parent_node;
224 while (pci_root_node != acpi_gbl_root_node) {
226 /* Get the _HID/_CID in order to detect a root_bridge */
228 if (acpi_ev_is_pci_root_bridge(pci_root_node)) {
230 /* Install a handler for this PCI root bridge */
233 acpi_install_address_space_handler((acpi_handle) pci_root_node, ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
234 if (ACPI_FAILURE(status)) {
235 if (status == AE_SAME_HANDLER) {
237 * It is OK if the handler is already installed on the
238 * root bridge. Still need to return a context object
239 * for the new PCI_Config operation region, however.
243 ACPI_EXCEPTION((AE_INFO, status,
244 "Could not install PciConfig handler "
245 "for Root Bridge %4.4s",
246 acpi_ut_get_node_name
253 pci_root_node = acpi_ns_get_parent_node(pci_root_node);
256 /* PCI root bridge not found, use namespace root node */
258 pci_root_node = handler_obj->address_space.node;
262 * If this region is now initialized, we are done.
263 * (install_address_space_handler could have initialized it)
265 if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
266 return_ACPI_STATUS(AE_OK);
269 /* Region is still not initialized. Create a new context */
271 pci_id = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pci_id));
273 return_ACPI_STATUS(AE_NO_MEMORY);
277 * For PCI_Config space access, we need the segment, bus, device and
278 * function numbers. Acquire them here.
280 * Find the parent device object. (This allows the operation region to be
281 * within a subscope under the device, such as a control method.)
283 pci_device_node = region_obj->region.node;
284 while (pci_device_node && (pci_device_node->type != ACPI_TYPE_DEVICE)) {
285 pci_device_node = acpi_ns_get_parent_node(pci_device_node);
288 if (!pci_device_node) {
290 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
294 * Get the PCI device and function numbers from the _ADR object contained
295 * in the parent's scope.
297 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR,
298 pci_device_node, &pci_value);
301 * The default is zero, and since the allocation above zeroed the data,
302 * just do nothing on failure.
304 if (ACPI_SUCCESS(status)) {
305 pci_id->device = ACPI_HIWORD(ACPI_LODWORD(pci_value));
306 pci_id->function = ACPI_LOWORD(ACPI_LODWORD(pci_value));
309 /* The PCI segment number comes from the _SEG method */
311 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__SEG,
312 pci_root_node, &pci_value);
313 if (ACPI_SUCCESS(status)) {
314 pci_id->segment = ACPI_LOWORD(pci_value);
317 /* The PCI bus number comes from the _BBN method */
319 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__BBN,
320 pci_root_node, &pci_value);
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 acpica_device_id hid;
381 struct acpi_compatible_id_list *cid;
384 /* Get the _HID and check for a PCI Root Bridge */
386 status = acpi_ut_execute_HID(node, &hid);
387 if (ACPI_FAILURE(status)) {
391 if (acpi_ev_match_pci_root_bridge(hid.value)) {
395 /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
397 status = acpi_ut_execute_CID(node, &cid);
398 if (ACPI_FAILURE(status)) {
402 /* Check all _CIDs in the returned list */
404 for (i = 0; i < cid->count; i++) {
405 if (acpi_ev_match_pci_root_bridge(cid->id[i].value)) {
415 /*******************************************************************************
417 * FUNCTION: acpi_ev_pci_bar_region_setup
419 * PARAMETERS: Handle - Region we are interested in
420 * Function - Start or stop
421 * handler_context - Address space handler context
422 * region_context - Region specific context
426 * DESCRIPTION: Setup a pci_bAR operation region
428 * MUTEX: Assumes namespace is not locked
430 ******************************************************************************/
433 acpi_ev_pci_bar_region_setup(acpi_handle handle,
435 void *handler_context, void **region_context)
437 ACPI_FUNCTION_TRACE(ev_pci_bar_region_setup);
439 return_ACPI_STATUS(AE_OK);
442 /*******************************************************************************
444 * FUNCTION: acpi_ev_cmos_region_setup
446 * PARAMETERS: Handle - Region we are interested in
447 * Function - Start or stop
448 * handler_context - Address space handler context
449 * region_context - Region specific context
453 * DESCRIPTION: Setup a CMOS operation region
455 * MUTEX: Assumes namespace is not locked
457 ******************************************************************************/
460 acpi_ev_cmos_region_setup(acpi_handle handle,
462 void *handler_context, void **region_context)
464 ACPI_FUNCTION_TRACE(ev_cmos_region_setup);
466 return_ACPI_STATUS(AE_OK);
469 /*******************************************************************************
471 * FUNCTION: acpi_ev_default_region_setup
473 * PARAMETERS: Handle - Region we are interested in
474 * Function - Start or stop
475 * handler_context - Address space handler context
476 * region_context - Region specific context
480 * DESCRIPTION: Default region initialization
482 ******************************************************************************/
485 acpi_ev_default_region_setup(acpi_handle handle,
487 void *handler_context, void **region_context)
489 ACPI_FUNCTION_TRACE(ev_default_region_setup);
491 if (function == ACPI_REGION_DEACTIVATE) {
492 *region_context = NULL;
494 *region_context = handler_context;
497 return_ACPI_STATUS(AE_OK);
500 /*******************************************************************************
502 * FUNCTION: acpi_ev_initialize_region
504 * PARAMETERS: region_obj - Region we are initializing
505 * acpi_ns_locked - Is namespace locked?
509 * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
510 * for execution at a later time
512 * Get the appropriate address space handler for a newly
515 * This also performs address space specific initialization. For
516 * example, PCI regions must have an _ADR object that contains
517 * a PCI address in the scope of the definition. This address is
518 * required to perform an access to PCI config space.
520 * MUTEX: Interpreter should be unlocked, because we may run the _REG
521 * method for this region.
523 ******************************************************************************/
526 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
529 union acpi_operand_object *handler_obj;
530 union acpi_operand_object *obj_desc;
531 acpi_adr_space_type space_id;
532 struct acpi_namespace_node *node;
534 struct acpi_namespace_node *method_node;
535 acpi_name *reg_name_ptr = (acpi_name *) METHOD_NAME__REG;
536 union acpi_operand_object *region_obj2;
538 ACPI_FUNCTION_TRACE_U32(ev_initialize_region, acpi_ns_locked);
541 return_ACPI_STATUS(AE_BAD_PARAMETER);
544 if (region_obj->common.flags & AOPOBJ_OBJECT_INITIALIZED) {
545 return_ACPI_STATUS(AE_OK);
548 region_obj2 = acpi_ns_get_secondary_object(region_obj);
550 return_ACPI_STATUS(AE_NOT_EXIST);
553 node = acpi_ns_get_parent_node(region_obj->region.node);
554 space_id = region_obj->region.space_id;
558 region_obj->region.handler = NULL;
559 region_obj2->extra.method_REG = NULL;
560 region_obj->common.flags &= ~(AOPOBJ_SETUP_COMPLETE);
561 region_obj->common.flags |= AOPOBJ_OBJECT_INITIALIZED;
563 /* Find any "_REG" method associated with this region definition */
566 acpi_ns_search_one_scope(*reg_name_ptr, node, ACPI_TYPE_METHOD,
568 if (ACPI_SUCCESS(status)) {
570 * The _REG method is optional and there can be only one per region
571 * definition. This will be executed when the handler is attached
574 region_obj2->extra.method_REG = method_node;
578 * The following loop depends upon the root Node having no parent
579 * ie: acpi_gbl_root_node->parent_entry being set to NULL
583 /* Check to see if a handler exists */
586 obj_desc = acpi_ns_get_attached_object(node);
589 /* Can only be a handler if the object exists */
591 switch (node->type) {
592 case ACPI_TYPE_DEVICE:
594 handler_obj = obj_desc->device.handler;
597 case ACPI_TYPE_PROCESSOR:
599 handler_obj = obj_desc->processor.handler;
602 case ACPI_TYPE_THERMAL:
604 handler_obj = obj_desc->thermal_zone.handler;
608 /* Ignore other objects */
612 while (handler_obj) {
614 /* Is this handler of the correct type? */
616 if (handler_obj->address_space.space_id ==
619 /* Found correct handler */
621 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
622 "Found handler %p for region %p in obj %p\n",
628 acpi_ev_attach_region(handler_obj,
633 * Tell all users that this region is usable by
634 * running the _REG method
636 if (acpi_ns_locked) {
638 acpi_ut_release_mutex
639 (ACPI_MTX_NAMESPACE);
640 if (ACPI_FAILURE(status)) {
647 acpi_ev_execute_reg_method
650 if (acpi_ns_locked) {
652 acpi_ut_acquire_mutex
653 (ACPI_MTX_NAMESPACE);
654 if (ACPI_FAILURE(status)) {
660 return_ACPI_STATUS(AE_OK);
663 /* Try next handler in the list */
665 handler_obj = handler_obj->address_space.next;
669 /* This node does not have the handler we need; Pop up one level */
671 node = acpi_ns_get_parent_node(node);
674 /* If we get here, there is no handler for this region */
676 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
677 "No handler for RegionType %s(%X) (RegionObj %p)\n",
678 acpi_ut_get_region_name(space_id), space_id,
681 return_ACPI_STATUS(AE_NOT_EXIST);