1/******************************************************************************
2 *
3 * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
4 *                         Address Spaces.
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2011, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions, and the following disclaimer,
17 *    without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 *    substantially similar to the "NO WARRANTY" disclaimer below
20 *    ("Disclaimer") and any redistribution must be conditioned upon
21 *    including a substantially similar Disclaimer requirement for further
22 *    binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 *    of any contributors may be used to endorse or promote products derived
25 *    from this software without specific prior written permission.
26 *
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
30 *
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
43 */
44
45#define __EVXFREGN_C__
46
47#include "acpi.h"
48#include "accommon.h"
49#include "acnamesp.h"
50#include "acevents.h"
51
52#define _COMPONENT          ACPI_EVENTS
53        ACPI_MODULE_NAME    ("evxfregn")
54
55
56/*******************************************************************************
57 *
58 * FUNCTION:    AcpiInstallAddressSpaceHandler
59 *
60 * PARAMETERS:  Device          - Handle for the device
61 *              SpaceId         - The address space ID
62 *              Handler         - Address of the handler
63 *              Setup           - Address of the setup function
64 *              Context         - Value passed to the handler on each access
65 *
66 * RETURN:      Status
67 *
68 * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
69 *
70 * NOTE: This function should only be called after AcpiEnableSubsystem has
71 * been called. This is because any _REG methods associated with the Space ID
72 * are executed here, and these methods can only be safely executed after
73 * the default handlers have been installed and the hardware has been
74 * initialized (via AcpiEnableSubsystem.)
75 *
76 ******************************************************************************/
77
78ACPI_STATUS
79AcpiInstallAddressSpaceHandler (
80    ACPI_HANDLE             Device,
81    ACPI_ADR_SPACE_TYPE     SpaceId,
82    ACPI_ADR_SPACE_HANDLER  Handler,
83    ACPI_ADR_SPACE_SETUP    Setup,
84    void                    *Context)
85{
86    ACPI_NAMESPACE_NODE     *Node;
87    ACPI_STATUS             Status;
88
89
90    ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
91
92
93    /* Parameter validation */
94
95    if (!Device)
96    {
97        return_ACPI_STATUS (AE_BAD_PARAMETER);
98    }
99
100    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
101    if (ACPI_FAILURE (Status))
102    {
103        return_ACPI_STATUS (Status);
104    }
105
106    /* Convert and validate the device handle */
107
108    Node = AcpiNsValidateHandle (Device);
109    if (!Node)
110    {
111        Status = AE_BAD_PARAMETER;
112        goto UnlockAndExit;
113    }
114
115    /* Install the handler for all Regions for this Space ID */
116
117    Status = AcpiEvInstallSpaceHandler (Node, SpaceId, Handler, Setup, Context);
118    if (ACPI_FAILURE (Status))
119    {
120        goto UnlockAndExit;
121    }
122
123    /*
124     * For the default SpaceIDs, (the IDs for which there are default region handlers
125     * installed) Only execute the _REG methods if the global initialization _REG
126     * methods have already been run (via AcpiInitializeObjects). In other words,
127     * we will defer the execution of the _REG methods for these SpaceIDs until
128     * execution of AcpiInitializeObjects. This is done because we need the handlers
129     * for the default spaces (mem/io/pci/table) to be installed before we can run
130     * any control methods (or _REG methods). There is known BIOS code that depends
131     * on this.
132     *
133     * For all other SpaceIDs, we can safely execute the _REG methods immediately.
134     * This means that for IDs like EmbeddedController, this function should be called
135     * only after AcpiEnableSubsystem has been called.
136     */
137    switch (SpaceId)
138    {
139    case ACPI_ADR_SPACE_SYSTEM_MEMORY:
140    case ACPI_ADR_SPACE_SYSTEM_IO:
141    case ACPI_ADR_SPACE_PCI_CONFIG:
142    case ACPI_ADR_SPACE_DATA_TABLE:
143
144        if (!AcpiGbl_RegMethodsExecuted)
145        {
146            /* We will defer execution of the _REG methods for this space */
147            goto UnlockAndExit;
148        }
149        break;
150
151    default:
152        break;
153    }
154
155    /* Run all _REG methods for this address space */
156
157    Status = AcpiEvExecuteRegMethods (Node, SpaceId);
158
159
160UnlockAndExit:
161    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
162    return_ACPI_STATUS (Status);
163}
164
165ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
166
167
168/*******************************************************************************
169 *
170 * FUNCTION:    AcpiRemoveAddressSpaceHandler
171 *
172 * PARAMETERS:  Device          - Handle for the device
173 *              SpaceId         - The address space ID
174 *              Handler         - Address of the handler
175 *
176 * RETURN:      Status
177 *
178 * DESCRIPTION: Remove a previously installed handler.
179 *
180 ******************************************************************************/
181
182ACPI_STATUS
183AcpiRemoveAddressSpaceHandler (
184    ACPI_HANDLE             Device,
185    ACPI_ADR_SPACE_TYPE     SpaceId,
186    ACPI_ADR_SPACE_HANDLER  Handler)
187{
188    ACPI_OPERAND_OBJECT     *ObjDesc;
189    ACPI_OPERAND_OBJECT     *HandlerObj;
190    ACPI_OPERAND_OBJECT     *RegionObj;
191    ACPI_OPERAND_OBJECT     **LastObjPtr;
192    ACPI_NAMESPACE_NODE     *Node;
193    ACPI_STATUS             Status;
194
195
196    ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
197
198
199    /* Parameter validation */
200
201    if (!Device)
202    {
203        return_ACPI_STATUS (AE_BAD_PARAMETER);
204    }
205
206    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
207    if (ACPI_FAILURE (Status))
208    {
209        return_ACPI_STATUS (Status);
210    }
211
212    /* Convert and validate the device handle */
213
214    Node = AcpiNsValidateHandle (Device);
215    if (!Node ||
216        ((Node->Type != ACPI_TYPE_DEVICE)    &&
217         (Node->Type != ACPI_TYPE_PROCESSOR) &&
218         (Node->Type != ACPI_TYPE_THERMAL)   &&
219         (Node != AcpiGbl_RootNode)))
220    {
221        Status = AE_BAD_PARAMETER;
222        goto UnlockAndExit;
223    }
224
225    /* Make sure the internal object exists */
226
227    ObjDesc = AcpiNsGetAttachedObject (Node);
228    if (!ObjDesc)
229    {
230        Status = AE_NOT_EXIST;
231        goto UnlockAndExit;
232    }
233
234    /* Find the address handler the user requested */
235
236    HandlerObj = ObjDesc->Device.Handler;
237    LastObjPtr = &ObjDesc->Device.Handler;
238    while (HandlerObj)
239    {
240        /* We have a handler, see if user requested this one */
241
242        if (HandlerObj->AddressSpace.SpaceId == SpaceId)
243        {
244            /* Handler must be the same as the installed handler */
245
246            if (HandlerObj->AddressSpace.Handler != Handler)
247            {
248                Status = AE_BAD_PARAMETER;
249                goto UnlockAndExit;
250            }
251
252            /* Matched SpaceId, first dereference this in the Regions */
253
254            ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
255                "Removing address handler %p(%p) for region %s "
256                "on Device %p(%p)\n",
257                HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
258                Node, ObjDesc));
259
260            RegionObj = HandlerObj->AddressSpace.RegionList;
261
262            /* Walk the handler's region list */
263
264            while (RegionObj)
265            {
266                /*
267                 * First disassociate the handler from the region.
268                 *
269                 * NOTE: this doesn't mean that the region goes away
270                 * The region is just inaccessible as indicated to
271                 * the _REG method
272                 */
273                AcpiEvDetachRegion (RegionObj, TRUE);
274
275                /*
276                 * Walk the list: Just grab the head because the
277                 * DetachRegion removed the previous head.
278                 */
279                RegionObj = HandlerObj->AddressSpace.RegionList;
280
281            }
282
283            /* Remove this Handler object from the list */
284
285            *LastObjPtr = HandlerObj->AddressSpace.Next;
286
287            /* Now we can delete the handler object */
288
289            AcpiUtRemoveReference (HandlerObj);
290            goto UnlockAndExit;
291        }
292
293        /* Walk the linked list of handlers */
294
295        LastObjPtr = &HandlerObj->AddressSpace.Next;
296        HandlerObj = HandlerObj->AddressSpace.Next;
297    }
298
299    /* The handler does not exist */
300
301    ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
302        "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
303        Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
304
305    Status = AE_NOT_EXIST;
306
307UnlockAndExit:
308    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
309    return_ACPI_STATUS (Status);
310}
311
312ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
313
314