1 /******************************************************************************
3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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__
122 #include "acnamesp.h"
123 #include "acevents.h"
125 #include "acinterp.h"
127 #define _COMPONENT ACPI_EVENTS
128 MODULE_NAME ("evxfregn")
131 /*******************************************************************************
133 * FUNCTION: AcpiInstallAddressSpaceHandler
135 * PARAMETERS: Device - Handle for the device
136 * SpaceId - The address space ID
137 * Handler - Address of the handler
138 * Setup - Address of the setup function
139 * Context - Value passed to the handler on each access
143 * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
145 ******************************************************************************/
148 AcpiInstallAddressSpaceHandler (
150 ACPI_ADR_SPACE_TYPE SpaceId,
151 ACPI_ADR_SPACE_HANDLER Handler,
152 ACPI_ADR_SPACE_SETUP Setup,
155 ACPI_OPERAND_OBJECT *ObjDesc;
156 ACPI_OPERAND_OBJECT *HandlerObj;
157 ACPI_NAMESPACE_NODE *Node;
158 ACPI_STATUS Status = AE_OK;
159 ACPI_OBJECT_TYPE8 Type;
163 FUNCTION_TRACE ("AcpiInstallAddressSpaceHandler");
166 /* Parameter validation */
169 ((!Handler) && (Handler != ACPI_DEFAULT_HANDLER)) ||
170 (SpaceId > ACPI_MAX_ADDRESS_SPACE))
172 return_ACPI_STATUS (AE_BAD_PARAMETER);
175 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
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 = 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;
232 Status = AE_NOT_EXIST;
239 * If the caller hasn't specified a setup routine, use the default
243 Setup = AcpiEvDefaultRegionSetup;
247 * Check for an existing internal object
249 ObjDesc = AcpiNsGetAttachedObject (Node);
254 * Make sure the handler is not already installed.
257 /* check the address handler the user requested */
259 HandlerObj = ObjDesc->Device.AddrHandler;
263 * We have an Address handler, see if user requested this
266 if(HandlerObj->AddrHandler.SpaceId == SpaceId)
268 Status = AE_ALREADY_EXISTS;
273 * Move through the linked list of handlers
275 HandlerObj = HandlerObj->AddrHandler.Next;
281 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
282 "Creating object on Device %p while installing handler\n", Node));
284 /* ObjDesc does not exist, create one */
286 if (Node->Type == ACPI_TYPE_ANY)
288 Type = ACPI_TYPE_DEVICE;
295 ObjDesc = AcpiUtCreateInternalObject (Type);
298 Status = AE_NO_MEMORY;
302 /* Init new descriptor */
304 ObjDesc->Common.Type = (UINT8) Type;
306 /* Attach the new object to the Node */
308 Status = AcpiNsAttachObject (Node, ObjDesc, (UINT8) Type);
309 if (ACPI_FAILURE (Status))
311 AcpiUtRemoveReference (ObjDesc);
316 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
317 "Installing address handler for region %s(%X) on Device %p(%p)\n",
318 AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
321 * Now we can install the handler
323 * At this point we know that there is no existing handler.
324 * So, we just allocate the object for the handler and link it
327 HandlerObj = AcpiUtCreateInternalObject (INTERNAL_TYPE_ADDRESS_HANDLER);
330 Status = AE_NO_MEMORY;
334 HandlerObj->AddrHandler.SpaceId = (UINT8) SpaceId;
335 HandlerObj->AddrHandler.Hflags = Flags;
336 HandlerObj->AddrHandler.Next = ObjDesc->Device.AddrHandler;
337 HandlerObj->AddrHandler.RegionList = NULL;
338 HandlerObj->AddrHandler.Node = Node;
339 HandlerObj->AddrHandler.Handler = Handler;
340 HandlerObj->AddrHandler.Context = Context;
341 HandlerObj->AddrHandler.Setup = Setup;
344 * Now walk the namespace finding all of the regions this
345 * handler will manage.
347 * We start at the device and search the branch toward
348 * the leaf nodes until either the leaf is encountered or
349 * a device is detected that has an address handler of the
352 * In either case we back up and search down the remainder
355 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Device,
356 ACPI_UINT32_MAX, NS_WALK_UNLOCK,
357 AcpiEvAddrHandlerHelper,
361 * Place this handler 1st on the list
363 HandlerObj->Common.ReferenceCount =
364 (UINT16) (HandlerObj->Common.ReferenceCount +
365 ObjDesc->Common.ReferenceCount - 1);
366 ObjDesc->Device.AddrHandler = HandlerObj;
370 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
371 return_ACPI_STATUS (Status);
375 /*******************************************************************************
377 * FUNCTION: AcpiRemoveAddressSpaceHandler
379 * PARAMETERS: SpaceId - The address space ID
380 * Handler - Address of the handler
384 * DESCRIPTION: Install a handler for accesses on an Operation Region
386 ******************************************************************************/
389 AcpiRemoveAddressSpaceHandler (
391 ACPI_ADR_SPACE_TYPE SpaceId,
392 ACPI_ADR_SPACE_HANDLER Handler)
394 ACPI_OPERAND_OBJECT *ObjDesc;
395 ACPI_OPERAND_OBJECT *HandlerObj;
396 ACPI_OPERAND_OBJECT *RegionObj;
397 ACPI_OPERAND_OBJECT **LastObjPtr;
398 ACPI_NAMESPACE_NODE *Node;
399 ACPI_STATUS Status = AE_OK;
402 FUNCTION_TRACE ("AcpiRemoveAddressSpaceHandler");
405 /* Parameter validation */
408 ((!Handler) && (Handler != ACPI_DEFAULT_HANDLER)) ||
409 (SpaceId > ACPI_MAX_ADDRESS_SPACE))
411 return_ACPI_STATUS (AE_BAD_PARAMETER);
414 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
416 /* Convert and validate the device handle */
418 Node = AcpiNsMapHandleToNode (Device);
421 Status = AE_BAD_PARAMETER;
426 /* Make sure the internal object exists */
428 ObjDesc = AcpiNsGetAttachedObject (Node);
431 Status = AE_NOT_EXIST;
436 * find the address handler the user requested
438 HandlerObj = ObjDesc->Device.AddrHandler;
439 LastObjPtr = &ObjDesc->Device.AddrHandler;
443 * We have a handler, see if user requested this one
445 if (HandlerObj->AddrHandler.SpaceId == SpaceId)
448 * Got it, first dereference this in the Regions
450 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
451 "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
452 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
455 RegionObj = HandlerObj->AddrHandler.RegionList;
457 /* Walk the handler's region list */
462 * First disassociate the handler from the region.
464 * NOTE: this doesn't mean that the region goes away
465 * The region is just inaccessible as indicated to
468 AcpiEvDisassociateRegionFromHandler(RegionObj, TRUE);
471 * Walk the list, since we took the first region and it
472 * was removed from the list by the dissassociate call
473 * we just get the first item on the list again
475 RegionObj = HandlerObj->AddrHandler.RegionList;
480 * Remove this Handler object from the list
482 *LastObjPtr = HandlerObj->AddrHandler.Next;
485 * Now we can delete the handler object
487 AcpiUtRemoveReference (HandlerObj);
488 AcpiUtRemoveReference (HandlerObj);
494 * Move through the linked list of handlers
496 LastObjPtr = &HandlerObj->AddrHandler.Next;
497 HandlerObj = HandlerObj->AddrHandler.Next;
502 * The handler does not exist
504 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
505 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
506 Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
508 Status = AE_NOT_EXIST;
512 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
513 return_ACPI_STATUS (Status);