xref: /titanic_50/usr/src/uts/intel/io/acpica/events/evxfregn.c (revision 7ff836697c120cb94bd30d5c2204eb9b74718e4c)
1 /******************************************************************************
2  *
3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
4  *                         Address Spaces.
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
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
20  * property rights.
21  *
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
28  *
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;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
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.
54  *
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
65  * make.
66  *
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
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
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.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
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
89  * PARTICULAR PURPOSE.
90  *
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
98  * LIMITED REMEDY.
99  *
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.
114  *
115  *****************************************************************************/
116 
117 #define __EVXFREGN_C__
118 
119 #include "acpi.h"
120 #include "accommon.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 "
289                 "on Device %p(%p)\n",
290                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
291                 Node, ObjDesc));
292 
293             RegionObj = HandlerObj->AddressSpace.RegionList;
294 
295             /* Walk the handler's region list */
296 
297             while (RegionObj)
298             {
299                 /*
300                  * First disassociate the handler from the region.
301                  *
302                  * NOTE: this doesn't mean that the region goes away
303                  * The region is just inaccessible as indicated to
304                  * the _REG method
305                  */
306                 AcpiEvDetachRegion (RegionObj, TRUE);
307 
308                 /*
309                  * Walk the list: Just grab the head because the
310                  * DetachRegion removed the previous head.
311                  */
312                 RegionObj = HandlerObj->AddressSpace.RegionList;
313 
314             }
315 
316             /* Remove this Handler object from the list */
317 
318             *LastObjPtr = HandlerObj->AddressSpace.Next;
319 
320             /* Now we can delete the handler object */
321 
322             AcpiUtRemoveReference (HandlerObj);
323             goto UnlockAndExit;
324         }
325 
326         /* Walk the linked list of handlers */
327 
328         LastObjPtr = &HandlerObj->AddressSpace.Next;
329         HandlerObj = HandlerObj->AddressSpace.Next;
330     }
331 
332     /* The handler does not exist */
333 
334     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
335         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
336         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
337 
338     Status = AE_NOT_EXIST;
339 
340 UnlockAndExit:
341     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
342     return_ACPI_STATUS (Status);
343 }
344 
345 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
346 
347