1 /******************************************************************************
3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial prton of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EVXFREGN_C__
121 #include "acnamesp.h"
122 #include "acevents.h"
123 #include "acinterp.h"
125 #define _COMPONENT ACPI_EVENTS
126 ACPI_MODULE_NAME ("evxfregn")
129 /*******************************************************************************
131 * FUNCTION: AcpiInstallAddressSpaceHandler
133 * PARAMETERS: Device - Handle for the device
134 * SpaceId - The address space ID
135 * Handler - Address of the handler
136 * Setup - Address of the setup function
137 * Context - Value passed to the handler on each access
141 * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
143 ******************************************************************************/
146 AcpiInstallAddressSpaceHandler (
148 ACPI_ADR_SPACE_TYPE SpaceId,
149 ACPI_ADR_SPACE_HANDLER Handler,
150 ACPI_ADR_SPACE_SETUP Setup,
153 ACPI_OPERAND_OBJECT *ObjDesc;
154 ACPI_OPERAND_OBJECT *HandlerObj;
155 ACPI_NAMESPACE_NODE *Node;
157 ACPI_OBJECT_TYPE Type;
161 ACPI_FUNCTION_TRACE ("AcpiInstallAddressSpaceHandler");
164 /* Parameter validation */
168 return_ACPI_STATUS (AE_BAD_PARAMETER);
171 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
172 if (ACPI_FAILURE (Status))
174 return_ACPI_STATUS (Status);
177 /* Convert and validate the device handle */
179 Node = AcpiNsMapHandleToNode (Device);
182 Status = AE_BAD_PARAMETER;
187 * This registration is valid for only the types below
188 * and the root. This is where the default handlers
191 if ((Node->Type != ACPI_TYPE_DEVICE) &&
192 (Node->Type != ACPI_TYPE_PROCESSOR) &&
193 (Node->Type != ACPI_TYPE_THERMAL) &&
194 (Node != AcpiGbl_RootNode))
196 Status = AE_BAD_PARAMETER;
200 if (Handler == ACPI_DEFAULT_HANDLER)
202 Flags = ACPI_ADDR_HANDLER_DEFAULT_INSTALLED;
206 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
207 Handler = AcpiExSystemMemorySpaceHandler;
208 Setup = AcpiEvSystemMemoryRegionSetup;
211 case ACPI_ADR_SPACE_SYSTEM_IO:
212 Handler = AcpiExSystemIoSpaceHandler;
213 Setup = AcpiEvIoSpaceRegionSetup;
216 case ACPI_ADR_SPACE_PCI_CONFIG:
217 Handler = AcpiExPciConfigSpaceHandler;
218 Setup = AcpiEvPciConfigRegionSetup;
221 case ACPI_ADR_SPACE_CMOS:
222 Handler = AcpiExCmosSpaceHandler;
223 Setup = AcpiEvCmosRegionSetup;
226 case ACPI_ADR_SPACE_PCI_BAR_TARGET:
227 Handler = AcpiExPciBarSpaceHandler;
228 Setup = AcpiEvPciBarRegionSetup;
231 case ACPI_ADR_SPACE_DATA_TABLE:
232 Handler = AcpiExDataTableSpaceHandler;
237 Status = AE_NOT_EXIST;
243 * If the caller hasn't specified a setup routine, use the default
247 Setup = AcpiEvDefaultRegionSetup;
251 * Check for an existing internal object
253 ObjDesc = AcpiNsGetAttachedObject (Node);
258 * Make sure the handler is not already installed.
261 /* check the address handler the user requested */
263 HandlerObj = ObjDesc->Device.AddrHandler;
267 * We have an Address handler, see if user requested this
270 if(HandlerObj->AddrHandler.SpaceId == SpaceId)
272 Status = AE_ALREADY_EXISTS;
277 * Move through the linked list of handlers
279 HandlerObj = HandlerObj->AddrHandler.Next;
284 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
285 "Creating object on Device %p while installing handler\n", Node));
287 /* ObjDesc does not exist, create one */
289 if (Node->Type == ACPI_TYPE_ANY)
291 Type = ACPI_TYPE_DEVICE;
298 ObjDesc = AcpiUtCreateInternalObject (Type);
301 Status = AE_NO_MEMORY;
305 /* Init new descriptor */
307 ObjDesc->Common.Type = (UINT8) Type;
309 /* Attach the new object to the Node */
311 Status = AcpiNsAttachObject (Node, ObjDesc, Type);
312 if (ACPI_FAILURE (Status))
314 AcpiUtRemoveReference (ObjDesc);
319 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
320 "Installing address handler for region %s(%X) on Device %p(%p)\n",
321 AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
324 * Now we can install the handler
326 * At this point we know that there is no existing handler.
327 * So, we just allocate the object for the handler and link it
330 HandlerObj = AcpiUtCreateInternalObject (INTERNAL_TYPE_ADDRESS_HANDLER);
333 Status = AE_NO_MEMORY;
337 HandlerObj->AddrHandler.SpaceId = (UINT8) SpaceId;
338 HandlerObj->AddrHandler.Hflags = Flags;
339 HandlerObj->AddrHandler.Next = ObjDesc->Device.AddrHandler;
340 HandlerObj->AddrHandler.RegionList = NULL;
341 HandlerObj->AddrHandler.Node = Node;
342 HandlerObj->AddrHandler.Handler = Handler;
343 HandlerObj->AddrHandler.Context = Context;
344 HandlerObj->AddrHandler.Setup = Setup;
347 * Now walk the namespace finding all of the regions this
348 * handler will manage.
350 * We start at the device and search the branch toward
351 * the leaf nodes until either the leaf is encountered or
352 * a device is detected that has an address handler of the
355 * In either case we back up and search down the remainder
358 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Device,
359 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
360 AcpiEvAddrHandlerHelper,
364 * Place this handler 1st on the list
366 HandlerObj->Common.ReferenceCount =
367 (UINT16) (HandlerObj->Common.ReferenceCount +
368 ObjDesc->Common.ReferenceCount - 1);
369 ObjDesc->Device.AddrHandler = HandlerObj;
373 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
374 return_ACPI_STATUS (Status);
378 /*******************************************************************************
380 * FUNCTION: AcpiRemoveAddressSpaceHandler
382 * PARAMETERS: SpaceId - The address space ID
383 * Handler - Address of the handler
387 * DESCRIPTION: Install a handler for accesses on an Operation Region
389 ******************************************************************************/
392 AcpiRemoveAddressSpaceHandler (
394 ACPI_ADR_SPACE_TYPE SpaceId,
395 ACPI_ADR_SPACE_HANDLER Handler)
397 ACPI_OPERAND_OBJECT *ObjDesc;
398 ACPI_OPERAND_OBJECT *HandlerObj;
399 ACPI_OPERAND_OBJECT *RegionObj;
400 ACPI_OPERAND_OBJECT **LastObjPtr;
401 ACPI_NAMESPACE_NODE *Node;
405 ACPI_FUNCTION_TRACE ("AcpiRemoveAddressSpaceHandler");
408 /* Parameter validation */
412 return_ACPI_STATUS (AE_BAD_PARAMETER);
415 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
416 if (ACPI_FAILURE (Status))
418 return_ACPI_STATUS (Status);
421 /* Convert and validate the device handle */
423 Node = AcpiNsMapHandleToNode (Device);
426 Status = AE_BAD_PARAMETER;
430 /* Make sure the internal object exists */
432 ObjDesc = AcpiNsGetAttachedObject (Node);
435 Status = AE_NOT_EXIST;
440 * find the address handler the user requested
442 HandlerObj = ObjDesc->Device.AddrHandler;
443 LastObjPtr = &ObjDesc->Device.AddrHandler;
447 * We have a handler, see if user requested this one
449 if (HandlerObj->AddrHandler.SpaceId == SpaceId)
452 * Got it, first dereference this in the Regions
454 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
455 "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
456 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
459 RegionObj = HandlerObj->AddrHandler.RegionList;
461 /* Walk the handler's region list */
466 * First disassociate the handler from the region.
468 * NOTE: this doesn't mean that the region goes away
469 * The region is just inaccessible as indicated to
472 AcpiEvDetachRegion (RegionObj, TRUE);
475 * Walk the list, since we took the first region and it
476 * was removed from the list by the dissassociate call
477 * we just get the first item on the list again
479 RegionObj = HandlerObj->AddrHandler.RegionList;
484 * Remove this Handler object from the list
486 *LastObjPtr = HandlerObj->AddrHandler.Next;
489 * Now we can delete the handler object
491 AcpiUtRemoveReference (HandlerObj);
492 AcpiUtRemoveReference (HandlerObj);
498 * Move through the linked list of handlers
500 LastObjPtr = &HandlerObj->AddrHandler.Next;
501 HandlerObj = HandlerObj->AddrHandler.Next;
506 * The handler does not exist
508 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
509 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
510 Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
512 Status = AE_NOT_EXIST;
516 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
517 return_ACPI_STATUS (Status);