xref: /titanic_44/usr/src/uts/intel/io/acpica/events/evxfregn.c (revision 5c066ec28ea93f3a7c93082611a61747f255290a)
1 /******************************************************************************
2  *
3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
4  *                         Address Spaces.
5  *              $Revision: 1.71 $
6  *
7  *****************************************************************************/
8 
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp.
14  * All rights reserved.
15  *
16  * 2. License
17  *
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
21  * property rights.
22  *
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
29  *
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;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45  * Redistribution of source code of any substantial portion 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.
55  *
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
66  * make.
67  *
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
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
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.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
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
90  * PARTICULAR PURPOSE.
91  *
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
99  * LIMITED REMEDY.
100  *
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.
115  *
116  *****************************************************************************/
117 
118 #define __EVXFREGN_C__
119 
120 #include "acpi.h"
121 #include "acnamesp.h"
122 #include "acevents.h"
123 
124 #define _COMPONENT          ACPI_EVENTS
125         ACPI_MODULE_NAME    ("evxfregn")
126 
127 
128 /*******************************************************************************
129  *
130  * FUNCTION:    AcpiInstallAddressSpaceHandler
131  *
132  * PARAMETERS:  Device          - Handle for the device
133  *              SpaceId         - The address space ID
134  *              Handler         - Address of the handler
135  *              Setup           - Address of the setup function
136  *              Context         - Value passed to the handler on each access
137  *
138  * RETURN:      Status
139  *
140  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
141  *
142  ******************************************************************************/
143 
144 ACPI_STATUS
145 AcpiInstallAddressSpaceHandler (
146     ACPI_HANDLE             Device,
147     ACPI_ADR_SPACE_TYPE     SpaceId,
148     ACPI_ADR_SPACE_HANDLER  Handler,
149     ACPI_ADR_SPACE_SETUP    Setup,
150     void                    *Context)
151 {
152     ACPI_NAMESPACE_NODE     *Node;
153     ACPI_STATUS             Status;
154 
155 
156     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
157 
158 
159     /* Parameter validation */
160 
161     if (!Device)
162     {
163         return_ACPI_STATUS (AE_BAD_PARAMETER);
164     }
165 
166     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
167     if (ACPI_FAILURE (Status))
168     {
169         return_ACPI_STATUS (Status);
170     }
171 
172     /* Convert and validate the device handle */
173 
174     Node = AcpiNsMapHandleToNode (Device);
175     if (!Node)
176     {
177         Status = AE_BAD_PARAMETER;
178         goto UnlockAndExit;
179     }
180 
181     /* Install the handler for all Regions for this Space ID */
182 
183     Status = AcpiEvInstallSpaceHandler (Node, SpaceId, Handler, Setup, Context);
184     if (ACPI_FAILURE (Status))
185     {
186         goto UnlockAndExit;
187     }
188 
189     /* Run all _REG methods for this address space */
190 
191     Status = AcpiEvExecuteRegMethods (Node, SpaceId);
192 
193 UnlockAndExit:
194     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
195     return_ACPI_STATUS (Status);
196 }
197 
198 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
199 
200 
201 /*******************************************************************************
202  *
203  * FUNCTION:    AcpiRemoveAddressSpaceHandler
204  *
205  * PARAMETERS:  Device          - Handle for the device
206  *              SpaceId         - The address space ID
207  *              Handler         - Address of the handler
208  *
209  * RETURN:      Status
210  *
211  * DESCRIPTION: Remove a previously installed handler.
212  *
213  ******************************************************************************/
214 
215 ACPI_STATUS
216 AcpiRemoveAddressSpaceHandler (
217     ACPI_HANDLE             Device,
218     ACPI_ADR_SPACE_TYPE     SpaceId,
219     ACPI_ADR_SPACE_HANDLER  Handler)
220 {
221     ACPI_OPERAND_OBJECT     *ObjDesc;
222     ACPI_OPERAND_OBJECT     *HandlerObj;
223     ACPI_OPERAND_OBJECT     *RegionObj;
224     ACPI_OPERAND_OBJECT     **LastObjPtr;
225     ACPI_NAMESPACE_NODE     *Node;
226     ACPI_STATUS             Status;
227 
228 
229     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
230 
231 
232     /* Parameter validation */
233 
234     if (!Device)
235     {
236         return_ACPI_STATUS (AE_BAD_PARAMETER);
237     }
238 
239     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
240     if (ACPI_FAILURE (Status))
241     {
242         return_ACPI_STATUS (Status);
243     }
244 
245     /* Convert and validate the device handle */
246 
247     Node = AcpiNsMapHandleToNode (Device);
248     if (!Node ||
249         ((Node->Type != ACPI_TYPE_DEVICE)    &&
250          (Node->Type != ACPI_TYPE_PROCESSOR) &&
251          (Node->Type != ACPI_TYPE_THERMAL)   &&
252          (Node != AcpiGbl_RootNode)))
253     {
254         Status = AE_BAD_PARAMETER;
255         goto UnlockAndExit;
256     }
257 
258     /* Make sure the internal object exists */
259 
260     ObjDesc = AcpiNsGetAttachedObject (Node);
261     if (!ObjDesc)
262     {
263         Status = AE_NOT_EXIST;
264         goto UnlockAndExit;
265     }
266 
267     /* Find the address handler the user requested */
268 
269     HandlerObj = ObjDesc->Device.Handler;
270     LastObjPtr = &ObjDesc->Device.Handler;
271     while (HandlerObj)
272     {
273         /* We have a handler, see if user requested this one */
274 
275         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
276         {
277             /* Handler must be the same as the installed handler */
278 
279             if (HandlerObj->AddressSpace.Handler != Handler)
280             {
281                 Status = AE_BAD_PARAMETER;
282                 goto UnlockAndExit;
283             }
284 
285             /* Matched SpaceId, first dereference this in the Regions */
286 
287             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
288                 "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
289                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
290                 Node, ObjDesc));
291 
292             RegionObj = HandlerObj->AddressSpace.RegionList;
293 
294             /* Walk the handler's region list */
295 
296             while (RegionObj)
297             {
298                 /*
299                  * First disassociate the handler from the region.
300                  *
301                  * NOTE: this doesn't mean that the region goes away
302                  * The region is just inaccessible as indicated to
303                  * the _REG method
304                  */
305                 AcpiEvDetachRegion (RegionObj, TRUE);
306 
307                 /*
308                  * Walk the list: Just grab the head because the
309                  * DetachRegion removed the previous head.
310                  */
311                 RegionObj = HandlerObj->AddressSpace.RegionList;
312 
313             }
314 
315             /* Remove this Handler object from the list */
316 
317             *LastObjPtr = HandlerObj->AddressSpace.Next;
318 
319             /* Now we can delete the handler object */
320 
321             AcpiUtRemoveReference (HandlerObj);
322             goto UnlockAndExit;
323         }
324 
325         /* Walk the linked list of handlers */
326 
327         LastObjPtr = &HandlerObj->AddressSpace.Next;
328         HandlerObj = HandlerObj->AddressSpace.Next;
329     }
330 
331     /* The handler does not exist */
332 
333     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
334         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
335         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
336 
337     Status = AE_NOT_EXIST;
338 
339 UnlockAndExit:
340     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
341     return_ACPI_STATUS (Status);
342 }
343 
344 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
345 
346