1 /******************************************************************************
3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __EVXFREGN_C__
118 #define EXPORT_ACPI_INTERFACES
121 #include "accommon.h"
122 #include "acnamesp.h"
123 #include "acevents.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 * NOTE: This function should only be called after AcpiEnableSubsystem has
144 * been called. This is because any _REG methods associated with the Space ID
145 * are executed here, and these methods can only be safely executed after
146 * the default handlers have been installed and the hardware has been
147 * initialized (via AcpiEnableSubsystem.)
149 ******************************************************************************/
152 AcpiInstallAddressSpaceHandler (
154 ACPI_ADR_SPACE_TYPE SpaceId
,
155 ACPI_ADR_SPACE_HANDLER Handler
,
156 ACPI_ADR_SPACE_SETUP Setup
,
159 ACPI_NAMESPACE_NODE
*Node
;
163 ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler
);
166 /* Parameter validation */
170 return_ACPI_STATUS (AE_BAD_PARAMETER
);
173 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
174 if (ACPI_FAILURE (Status
))
176 return_ACPI_STATUS (Status
);
179 /* Convert and validate the device handle */
181 Node
= AcpiNsValidateHandle (Device
);
184 Status
= AE_BAD_PARAMETER
;
188 /* Install the handler for all Regions for this Space ID */
190 Status
= AcpiEvInstallSpaceHandler (Node
, SpaceId
, Handler
, Setup
, Context
);
191 if (ACPI_FAILURE (Status
))
197 * For the default SpaceIDs, (the IDs for which there are default region handlers
198 * installed) Only execute the _REG methods if the global initialization _REG
199 * methods have already been run (via AcpiInitializeObjects). In other words,
200 * we will defer the execution of the _REG methods for these SpaceIDs until
201 * execution of AcpiInitializeObjects. This is done because we need the handlers
202 * for the default spaces (mem/io/pci/table) to be installed before we can run
203 * any control methods (or _REG methods). There is known BIOS code that depends
206 * For all other SpaceIDs, we can safely execute the _REG methods immediately.
207 * This means that for IDs like EmbeddedController, this function should be called
208 * only after AcpiEnableSubsystem has been called.
212 case ACPI_ADR_SPACE_SYSTEM_MEMORY
:
213 case ACPI_ADR_SPACE_SYSTEM_IO
:
214 case ACPI_ADR_SPACE_PCI_CONFIG
:
215 case ACPI_ADR_SPACE_DATA_TABLE
:
217 if (!AcpiGbl_RegMethodsExecuted
)
219 /* We will defer execution of the _REG methods for this space */
229 /* Run all _REG methods for this address space */
231 Status
= AcpiEvExecuteRegMethods (Node
, SpaceId
);
235 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
236 return_ACPI_STATUS (Status
);
239 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler
)
242 /*******************************************************************************
244 * FUNCTION: AcpiRemoveAddressSpaceHandler
246 * PARAMETERS: Device - Handle for the device
247 * SpaceId - The address space ID
248 * Handler - Address of the handler
252 * DESCRIPTION: Remove a previously installed handler.
254 ******************************************************************************/
257 AcpiRemoveAddressSpaceHandler (
259 ACPI_ADR_SPACE_TYPE SpaceId
,
260 ACPI_ADR_SPACE_HANDLER Handler
)
262 ACPI_OPERAND_OBJECT
*ObjDesc
;
263 ACPI_OPERAND_OBJECT
*HandlerObj
;
264 ACPI_OPERAND_OBJECT
*RegionObj
;
265 ACPI_OPERAND_OBJECT
**LastObjPtr
;
266 ACPI_NAMESPACE_NODE
*Node
;
270 ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler
);
273 /* Parameter validation */
277 return_ACPI_STATUS (AE_BAD_PARAMETER
);
280 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
281 if (ACPI_FAILURE (Status
))
283 return_ACPI_STATUS (Status
);
286 /* Convert and validate the device handle */
288 Node
= AcpiNsValidateHandle (Device
);
290 ((Node
->Type
!= ACPI_TYPE_DEVICE
) &&
291 (Node
->Type
!= ACPI_TYPE_PROCESSOR
) &&
292 (Node
->Type
!= ACPI_TYPE_THERMAL
) &&
293 (Node
!= AcpiGbl_RootNode
)))
295 Status
= AE_BAD_PARAMETER
;
299 /* Make sure the internal object exists */
301 ObjDesc
= AcpiNsGetAttachedObject (Node
);
304 Status
= AE_NOT_EXIST
;
308 /* Find the address handler the user requested */
310 HandlerObj
= ObjDesc
->Device
.Handler
;
311 LastObjPtr
= &ObjDesc
->Device
.Handler
;
314 /* We have a handler, see if user requested this one */
316 if (HandlerObj
->AddressSpace
.SpaceId
== SpaceId
)
318 /* Handler must be the same as the installed handler */
320 if (HandlerObj
->AddressSpace
.Handler
!= Handler
)
322 Status
= AE_BAD_PARAMETER
;
326 /* Matched SpaceId, first dereference this in the Regions */
328 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION
,
329 "Removing address handler %p(%p) for region %s "
330 "on Device %p(%p)\n",
331 HandlerObj
, Handler
, AcpiUtGetRegionName (SpaceId
),
334 RegionObj
= HandlerObj
->AddressSpace
.RegionList
;
336 /* Walk the handler's region list */
341 * First disassociate the handler from the region.
343 * NOTE: this doesn't mean that the region goes away
344 * The region is just inaccessible as indicated to
347 AcpiEvDetachRegion (RegionObj
, TRUE
);
350 * Walk the list: Just grab the head because the
351 * DetachRegion removed the previous head.
353 RegionObj
= HandlerObj
->AddressSpace
.RegionList
;
357 /* Remove this Handler object from the list */
359 *LastObjPtr
= HandlerObj
->AddressSpace
.Next
;
361 /* Now we can delete the handler object */
363 AcpiUtRemoveReference (HandlerObj
);
367 /* Walk the linked list of handlers */
369 LastObjPtr
= &HandlerObj
->AddressSpace
.Next
;
370 HandlerObj
= HandlerObj
->AddressSpace
.Next
;
373 /* The handler does not exist */
375 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION
,
376 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
377 Handler
, AcpiUtGetRegionName (SpaceId
), SpaceId
, Node
, ObjDesc
));
379 Status
= AE_NOT_EXIST
;
382 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
383 return_ACPI_STATUS (Status
);
386 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler
)