evregion.c revision 1.1.1.5.2.1 1 1.1 jruoho /******************************************************************************
2 1.1 jruoho *
3 1.1.1.4 christos * Module Name: evregion - Operation Region support
4 1.1 jruoho *
5 1.1 jruoho *****************************************************************************/
6 1.1 jruoho
7 1.1.1.2 jruoho /*
8 1.1.1.5.2.1 skrll * Copyright (C) 2000 - 2015, Intel Corp.
9 1.1 jruoho * All rights reserved.
10 1.1 jruoho *
11 1.1.1.2 jruoho * Redistribution and use in source and binary forms, with or without
12 1.1.1.2 jruoho * modification, are permitted provided that the following conditions
13 1.1.1.2 jruoho * are met:
14 1.1.1.2 jruoho * 1. Redistributions of source code must retain the above copyright
15 1.1.1.2 jruoho * notice, this list of conditions, and the following disclaimer,
16 1.1.1.2 jruoho * without modification.
17 1.1.1.2 jruoho * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.2 jruoho * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.2 jruoho * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.2 jruoho * including a substantially similar Disclaimer requirement for further
21 1.1.1.2 jruoho * binary redistribution.
22 1.1.1.2 jruoho * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.2 jruoho * of any contributors may be used to endorse or promote products derived
24 1.1.1.2 jruoho * from this software without specific prior written permission.
25 1.1.1.2 jruoho *
26 1.1.1.2 jruoho * Alternatively, this software may be distributed under the terms of the
27 1.1.1.2 jruoho * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.2 jruoho * Software Foundation.
29 1.1.1.2 jruoho *
30 1.1.1.2 jruoho * NO WARRANTY
31 1.1.1.2 jruoho * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.2 jruoho * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.2 jruoho * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.2 jruoho * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.2 jruoho * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.2 jruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.2 jruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.2 jruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.2 jruoho * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.2 jruoho * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.2 jruoho * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.2 jruoho */
43 1.1 jruoho
44 1.1 jruoho #include "acpi.h"
45 1.1 jruoho #include "accommon.h"
46 1.1 jruoho #include "acevents.h"
47 1.1 jruoho #include "acnamesp.h"
48 1.1 jruoho #include "acinterp.h"
49 1.1 jruoho
50 1.1 jruoho #define _COMPONENT ACPI_EVENTS
51 1.1 jruoho ACPI_MODULE_NAME ("evregion")
52 1.1 jruoho
53 1.1 jruoho
54 1.1.1.4 christos extern UINT8 AcpiGbl_DefaultAddressSpaces[];
55 1.1 jruoho
56 1.1.1.4 christos /* Local prototypes */
57 1.1 jruoho
58 1.1.1.3 jruoho static void
59 1.1.1.3 jruoho AcpiEvOrphanEcRegMethod (
60 1.1.1.4 christos ACPI_NAMESPACE_NODE *EcDeviceNode);
61 1.1.1.3 jruoho
62 1.1 jruoho static ACPI_STATUS
63 1.1 jruoho AcpiEvRegRun (
64 1.1 jruoho ACPI_HANDLE ObjHandle,
65 1.1 jruoho UINT32 Level,
66 1.1 jruoho void *Context,
67 1.1 jruoho void **ReturnValue);
68 1.1 jruoho
69 1.1 jruoho
70 1.1 jruoho /*******************************************************************************
71 1.1 jruoho *
72 1.1 jruoho * FUNCTION: AcpiEvInitializeOpRegions
73 1.1 jruoho *
74 1.1 jruoho * PARAMETERS: None
75 1.1 jruoho *
76 1.1 jruoho * RETURN: Status
77 1.1 jruoho *
78 1.1 jruoho * DESCRIPTION: Execute _REG methods for all Operation Regions that have
79 1.1 jruoho * an installed default region handler.
80 1.1 jruoho *
81 1.1 jruoho ******************************************************************************/
82 1.1 jruoho
83 1.1 jruoho ACPI_STATUS
84 1.1 jruoho AcpiEvInitializeOpRegions (
85 1.1 jruoho void)
86 1.1 jruoho {
87 1.1 jruoho ACPI_STATUS Status;
88 1.1 jruoho UINT32 i;
89 1.1 jruoho
90 1.1 jruoho
91 1.1 jruoho ACPI_FUNCTION_TRACE (EvInitializeOpRegions);
92 1.1 jruoho
93 1.1 jruoho
94 1.1 jruoho Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
95 1.1 jruoho if (ACPI_FAILURE (Status))
96 1.1 jruoho {
97 1.1 jruoho return_ACPI_STATUS (Status);
98 1.1 jruoho }
99 1.1 jruoho
100 1.1 jruoho /* Run the _REG methods for OpRegions in each default address space */
101 1.1 jruoho
102 1.1 jruoho for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++)
103 1.1 jruoho {
104 1.1 jruoho /*
105 1.1 jruoho * Make sure the installed handler is the DEFAULT handler. If not the
106 1.1 jruoho * default, the _REG methods will have already been run (when the
107 1.1 jruoho * handler was installed)
108 1.1 jruoho */
109 1.1 jruoho if (AcpiEvHasDefaultHandler (AcpiGbl_RootNode,
110 1.1 jruoho AcpiGbl_DefaultAddressSpaces[i]))
111 1.1 jruoho {
112 1.1 jruoho Status = AcpiEvExecuteRegMethods (AcpiGbl_RootNode,
113 1.1 jruoho AcpiGbl_DefaultAddressSpaces[i]);
114 1.1 jruoho }
115 1.1 jruoho }
116 1.1 jruoho
117 1.1.1.2 jruoho AcpiGbl_RegMethodsExecuted = TRUE;
118 1.1.1.2 jruoho
119 1.1 jruoho (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
120 1.1 jruoho return_ACPI_STATUS (Status);
121 1.1 jruoho }
122 1.1 jruoho
123 1.1 jruoho
124 1.1 jruoho /*******************************************************************************
125 1.1 jruoho *
126 1.1 jruoho * FUNCTION: AcpiEvAddressSpaceDispatch
127 1.1 jruoho *
128 1.1 jruoho * PARAMETERS: RegionObj - Internal region object
129 1.1.1.4 christos * FieldObj - Corresponding field. Can be NULL.
130 1.1 jruoho * Function - Read or Write operation
131 1.1 jruoho * RegionOffset - Where in the region to read or write
132 1.1 jruoho * BitWidth - Field width in bits (8, 16, 32, or 64)
133 1.1 jruoho * Value - Pointer to in or out value, must be
134 1.1 jruoho * a full 64-bit integer
135 1.1 jruoho *
136 1.1 jruoho * RETURN: Status
137 1.1 jruoho *
138 1.1 jruoho * DESCRIPTION: Dispatch an address space or operation region access to
139 1.1 jruoho * a previously installed handler.
140 1.1 jruoho *
141 1.1 jruoho ******************************************************************************/
142 1.1 jruoho
143 1.1 jruoho ACPI_STATUS
144 1.1 jruoho AcpiEvAddressSpaceDispatch (
145 1.1 jruoho ACPI_OPERAND_OBJECT *RegionObj,
146 1.1.1.4 christos ACPI_OPERAND_OBJECT *FieldObj,
147 1.1 jruoho UINT32 Function,
148 1.1 jruoho UINT32 RegionOffset,
149 1.1 jruoho UINT32 BitWidth,
150 1.1 jruoho UINT64 *Value)
151 1.1 jruoho {
152 1.1 jruoho ACPI_STATUS Status;
153 1.1 jruoho ACPI_ADR_SPACE_HANDLER Handler;
154 1.1 jruoho ACPI_ADR_SPACE_SETUP RegionSetup;
155 1.1 jruoho ACPI_OPERAND_OBJECT *HandlerDesc;
156 1.1 jruoho ACPI_OPERAND_OBJECT *RegionObj2;
157 1.1 jruoho void *RegionContext = NULL;
158 1.1.1.4 christos ACPI_CONNECTION_INFO *Context;
159 1.1.1.5 christos ACPI_PHYSICAL_ADDRESS Address;
160 1.1 jruoho
161 1.1 jruoho
162 1.1 jruoho ACPI_FUNCTION_TRACE (EvAddressSpaceDispatch);
163 1.1 jruoho
164 1.1 jruoho
165 1.1 jruoho RegionObj2 = AcpiNsGetSecondaryObject (RegionObj);
166 1.1 jruoho if (!RegionObj2)
167 1.1 jruoho {
168 1.1 jruoho return_ACPI_STATUS (AE_NOT_EXIST);
169 1.1 jruoho }
170 1.1 jruoho
171 1.1 jruoho /* Ensure that there is a handler associated with this region */
172 1.1 jruoho
173 1.1 jruoho HandlerDesc = RegionObj->Region.Handler;
174 1.1 jruoho if (!HandlerDesc)
175 1.1 jruoho {
176 1.1 jruoho ACPI_ERROR ((AE_INFO,
177 1.1 jruoho "No handler for Region [%4.4s] (%p) [%s]",
178 1.1 jruoho AcpiUtGetNodeName (RegionObj->Region.Node),
179 1.1 jruoho RegionObj, AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
180 1.1 jruoho
181 1.1 jruoho return_ACPI_STATUS (AE_NOT_EXIST);
182 1.1 jruoho }
183 1.1 jruoho
184 1.1.1.4 christos Context = HandlerDesc->AddressSpace.Context;
185 1.1.1.4 christos
186 1.1 jruoho /*
187 1.1 jruoho * It may be the case that the region has never been initialized.
188 1.1 jruoho * Some types of regions require special init code
189 1.1 jruoho */
190 1.1 jruoho if (!(RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE))
191 1.1 jruoho {
192 1.1 jruoho /* This region has not been initialized yet, do it */
193 1.1 jruoho
194 1.1 jruoho RegionSetup = HandlerDesc->AddressSpace.Setup;
195 1.1 jruoho if (!RegionSetup)
196 1.1 jruoho {
197 1.1 jruoho /* No initialization routine, exit with error */
198 1.1 jruoho
199 1.1 jruoho ACPI_ERROR ((AE_INFO,
200 1.1 jruoho "No init routine for region(%p) [%s]",
201 1.1 jruoho RegionObj, AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
202 1.1 jruoho return_ACPI_STATUS (AE_NOT_EXIST);
203 1.1 jruoho }
204 1.1 jruoho
205 1.1 jruoho /*
206 1.1 jruoho * We must exit the interpreter because the region setup will
207 1.1 jruoho * potentially execute control methods (for example, the _REG method
208 1.1 jruoho * for this region)
209 1.1 jruoho */
210 1.1 jruoho AcpiExExitInterpreter ();
211 1.1 jruoho
212 1.1 jruoho Status = RegionSetup (RegionObj, ACPI_REGION_ACTIVATE,
213 1.1.1.4 christos Context, &RegionContext);
214 1.1 jruoho
215 1.1 jruoho /* Re-enter the interpreter */
216 1.1 jruoho
217 1.1 jruoho AcpiExEnterInterpreter ();
218 1.1 jruoho
219 1.1 jruoho /* Check for failure of the Region Setup */
220 1.1 jruoho
221 1.1 jruoho if (ACPI_FAILURE (Status))
222 1.1 jruoho {
223 1.1 jruoho ACPI_EXCEPTION ((AE_INFO, Status,
224 1.1 jruoho "During region initialization: [%s]",
225 1.1 jruoho AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
226 1.1 jruoho return_ACPI_STATUS (Status);
227 1.1 jruoho }
228 1.1 jruoho
229 1.1 jruoho /* Region initialization may have been completed by RegionSetup */
230 1.1 jruoho
231 1.1 jruoho if (!(RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE))
232 1.1 jruoho {
233 1.1 jruoho RegionObj->Region.Flags |= AOPOBJ_SETUP_COMPLETE;
234 1.1 jruoho
235 1.1.1.4 christos /*
236 1.1.1.4 christos * Save the returned context for use in all accesses to
237 1.1.1.4 christos * the handler for this particular region
238 1.1.1.4 christos */
239 1.1.1.4 christos if (!(RegionObj2->Extra.RegionContext))
240 1.1 jruoho {
241 1.1 jruoho RegionObj2->Extra.RegionContext = RegionContext;
242 1.1 jruoho }
243 1.1 jruoho }
244 1.1 jruoho }
245 1.1 jruoho
246 1.1 jruoho /* We have everything we need, we can invoke the address space handler */
247 1.1 jruoho
248 1.1 jruoho Handler = HandlerDesc->AddressSpace.Handler;
249 1.1.1.5 christos Address = (RegionObj->Region.Address + RegionOffset);
250 1.1 jruoho
251 1.1.1.4 christos /*
252 1.1.1.4 christos * Special handling for GenericSerialBus and GeneralPurposeIo:
253 1.1.1.4 christos * There are three extra parameters that must be passed to the
254 1.1.1.4 christos * handler via the context:
255 1.1.1.5 christos * 1) Connection buffer, a resource template from Connection() op
256 1.1.1.5 christos * 2) Length of the above buffer
257 1.1.1.5 christos * 3) Actual access length from the AccessAs() op
258 1.1.1.5 christos *
259 1.1.1.5 christos * In addition, for GeneralPurposeIo, the Address and BitWidth fields
260 1.1.1.5 christos * are defined as follows:
261 1.1.1.5 christos * 1) Address is the pin number index of the field (bit offset from
262 1.1.1.5 christos * the previous Connection)
263 1.1.1.5 christos * 2) BitWidth is the actual bit length of the field (number of pins)
264 1.1.1.4 christos */
265 1.1.1.5 christos if ((RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS) &&
266 1.1.1.4 christos Context &&
267 1.1.1.4 christos FieldObj)
268 1.1.1.4 christos {
269 1.1.1.4 christos /* Get the Connection (ResourceTemplate) buffer */
270 1.1.1.4 christos
271 1.1.1.4 christos Context->Connection = FieldObj->Field.ResourceBuffer;
272 1.1.1.4 christos Context->Length = FieldObj->Field.ResourceLength;
273 1.1.1.4 christos Context->AccessLength = FieldObj->Field.AccessLength;
274 1.1.1.4 christos }
275 1.1.1.5 christos if ((RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO) &&
276 1.1.1.5 christos Context &&
277 1.1.1.5 christos FieldObj)
278 1.1.1.5 christos {
279 1.1.1.5 christos /* Get the Connection (ResourceTemplate) buffer */
280 1.1.1.5 christos
281 1.1.1.5 christos Context->Connection = FieldObj->Field.ResourceBuffer;
282 1.1.1.5 christos Context->Length = FieldObj->Field.ResourceLength;
283 1.1.1.5 christos Context->AccessLength = FieldObj->Field.AccessLength;
284 1.1.1.5 christos Address = FieldObj->Field.PinNumberIndex;
285 1.1.1.5 christos BitWidth = FieldObj->Field.BitLength;
286 1.1.1.5 christos }
287 1.1.1.5 christos
288 1.1.1.5 christos ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
289 1.1.1.5 christos "Handler %p (@%p) Address %8.8X%8.8X [%s]\n",
290 1.1.1.5 christos &RegionObj->Region.Handler->AddressSpace, Handler,
291 1.1.1.5.2.1 skrll ACPI_FORMAT_UINT64 (Address),
292 1.1.1.5 christos AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
293 1.1.1.4 christos
294 1.1 jruoho if (!(HandlerDesc->AddressSpace.HandlerFlags &
295 1.1 jruoho ACPI_ADDR_HANDLER_DEFAULT_INSTALLED))
296 1.1 jruoho {
297 1.1 jruoho /*
298 1.1 jruoho * For handlers other than the default (supplied) handlers, we must
299 1.1 jruoho * exit the interpreter because the handler *might* block -- we don't
300 1.1 jruoho * know what it will do, so we can't hold the lock on the intepreter.
301 1.1 jruoho */
302 1.1 jruoho AcpiExExitInterpreter();
303 1.1 jruoho }
304 1.1 jruoho
305 1.1 jruoho /* Call the handler */
306 1.1 jruoho
307 1.1.1.5 christos Status = Handler (Function, Address, BitWidth, Value, Context,
308 1.1.1.5 christos RegionObj2->Extra.RegionContext);
309 1.1 jruoho
310 1.1 jruoho if (ACPI_FAILURE (Status))
311 1.1 jruoho {
312 1.1 jruoho ACPI_EXCEPTION ((AE_INFO, Status, "Returned by Handler for [%s]",
313 1.1 jruoho AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
314 1.1 jruoho }
315 1.1 jruoho
316 1.1 jruoho if (!(HandlerDesc->AddressSpace.HandlerFlags &
317 1.1 jruoho ACPI_ADDR_HANDLER_DEFAULT_INSTALLED))
318 1.1 jruoho {
319 1.1 jruoho /*
320 1.1 jruoho * We just returned from a non-default handler, we must re-enter the
321 1.1 jruoho * interpreter
322 1.1 jruoho */
323 1.1 jruoho AcpiExEnterInterpreter ();
324 1.1 jruoho }
325 1.1 jruoho
326 1.1 jruoho return_ACPI_STATUS (Status);
327 1.1 jruoho }
328 1.1 jruoho
329 1.1 jruoho
330 1.1 jruoho /*******************************************************************************
331 1.1 jruoho *
332 1.1 jruoho * FUNCTION: AcpiEvDetachRegion
333 1.1 jruoho *
334 1.1 jruoho * PARAMETERS: RegionObj - Region Object
335 1.1 jruoho * AcpiNsIsLocked - Namespace Region Already Locked?
336 1.1 jruoho *
337 1.1 jruoho * RETURN: None
338 1.1 jruoho *
339 1.1 jruoho * DESCRIPTION: Break the association between the handler and the region
340 1.1 jruoho * this is a two way association.
341 1.1 jruoho *
342 1.1 jruoho ******************************************************************************/
343 1.1 jruoho
344 1.1 jruoho void
345 1.1 jruoho AcpiEvDetachRegion(
346 1.1 jruoho ACPI_OPERAND_OBJECT *RegionObj,
347 1.1 jruoho BOOLEAN AcpiNsIsLocked)
348 1.1 jruoho {
349 1.1 jruoho ACPI_OPERAND_OBJECT *HandlerObj;
350 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc;
351 1.1.1.5 christos ACPI_OPERAND_OBJECT *StartDesc;
352 1.1 jruoho ACPI_OPERAND_OBJECT **LastObjPtr;
353 1.1 jruoho ACPI_ADR_SPACE_SETUP RegionSetup;
354 1.1 jruoho void **RegionContext;
355 1.1 jruoho ACPI_OPERAND_OBJECT *RegionObj2;
356 1.1 jruoho ACPI_STATUS Status;
357 1.1 jruoho
358 1.1 jruoho
359 1.1 jruoho ACPI_FUNCTION_TRACE (EvDetachRegion);
360 1.1 jruoho
361 1.1 jruoho
362 1.1 jruoho RegionObj2 = AcpiNsGetSecondaryObject (RegionObj);
363 1.1 jruoho if (!RegionObj2)
364 1.1 jruoho {
365 1.1 jruoho return_VOID;
366 1.1 jruoho }
367 1.1 jruoho RegionContext = &RegionObj2->Extra.RegionContext;
368 1.1 jruoho
369 1.1 jruoho /* Get the address handler from the region object */
370 1.1 jruoho
371 1.1 jruoho HandlerObj = RegionObj->Region.Handler;
372 1.1 jruoho if (!HandlerObj)
373 1.1 jruoho {
374 1.1 jruoho /* This region has no handler, all done */
375 1.1 jruoho
376 1.1 jruoho return_VOID;
377 1.1 jruoho }
378 1.1 jruoho
379 1.1 jruoho /* Find this region in the handler's list */
380 1.1 jruoho
381 1.1 jruoho ObjDesc = HandlerObj->AddressSpace.RegionList;
382 1.1.1.5 christos StartDesc = ObjDesc;
383 1.1 jruoho LastObjPtr = &HandlerObj->AddressSpace.RegionList;
384 1.1 jruoho
385 1.1 jruoho while (ObjDesc)
386 1.1 jruoho {
387 1.1 jruoho /* Is this the correct Region? */
388 1.1 jruoho
389 1.1 jruoho if (ObjDesc == RegionObj)
390 1.1 jruoho {
391 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
392 1.1 jruoho "Removing Region %p from address handler %p\n",
393 1.1 jruoho RegionObj, HandlerObj));
394 1.1 jruoho
395 1.1 jruoho /* This is it, remove it from the handler's list */
396 1.1 jruoho
397 1.1 jruoho *LastObjPtr = ObjDesc->Region.Next;
398 1.1 jruoho ObjDesc->Region.Next = NULL; /* Must clear field */
399 1.1 jruoho
400 1.1 jruoho if (AcpiNsIsLocked)
401 1.1 jruoho {
402 1.1 jruoho Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
403 1.1 jruoho if (ACPI_FAILURE (Status))
404 1.1 jruoho {
405 1.1 jruoho return_VOID;
406 1.1 jruoho }
407 1.1 jruoho }
408 1.1 jruoho
409 1.1 jruoho /* Now stop region accesses by executing the _REG method */
410 1.1 jruoho
411 1.1.1.3 jruoho Status = AcpiEvExecuteRegMethod (RegionObj, ACPI_REG_DISCONNECT);
412 1.1 jruoho if (ACPI_FAILURE (Status))
413 1.1 jruoho {
414 1.1 jruoho ACPI_EXCEPTION ((AE_INFO, Status, "from region _REG, [%s]",
415 1.1 jruoho AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
416 1.1 jruoho }
417 1.1 jruoho
418 1.1 jruoho if (AcpiNsIsLocked)
419 1.1 jruoho {
420 1.1 jruoho Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
421 1.1 jruoho if (ACPI_FAILURE (Status))
422 1.1 jruoho {
423 1.1 jruoho return_VOID;
424 1.1 jruoho }
425 1.1 jruoho }
426 1.1 jruoho
427 1.1 jruoho /*
428 1.1 jruoho * If the region has been activated, call the setup handler with
429 1.1 jruoho * the deactivate notification
430 1.1 jruoho */
431 1.1 jruoho if (RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE)
432 1.1 jruoho {
433 1.1 jruoho RegionSetup = HandlerObj->AddressSpace.Setup;
434 1.1 jruoho Status = RegionSetup (RegionObj, ACPI_REGION_DEACTIVATE,
435 1.1 jruoho HandlerObj->AddressSpace.Context, RegionContext);
436 1.1 jruoho
437 1.1.1.4 christos /*
438 1.1.1.4 christos * RegionContext should have been released by the deactivate
439 1.1.1.4 christos * operation. We don't need access to it anymore here.
440 1.1.1.4 christos */
441 1.1.1.4 christos if (RegionContext)
442 1.1.1.4 christos {
443 1.1.1.4 christos *RegionContext = NULL;
444 1.1.1.4 christos }
445 1.1.1.4 christos
446 1.1 jruoho /* Init routine may fail, Just ignore errors */
447 1.1 jruoho
448 1.1 jruoho if (ACPI_FAILURE (Status))
449 1.1 jruoho {
450 1.1 jruoho ACPI_EXCEPTION ((AE_INFO, Status,
451 1.1 jruoho "from region handler - deactivate, [%s]",
452 1.1 jruoho AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
453 1.1 jruoho }
454 1.1 jruoho
455 1.1 jruoho RegionObj->Region.Flags &= ~(AOPOBJ_SETUP_COMPLETE);
456 1.1 jruoho }
457 1.1 jruoho
458 1.1 jruoho /*
459 1.1 jruoho * Remove handler reference in the region
460 1.1 jruoho *
461 1.1 jruoho * NOTE: this doesn't mean that the region goes away, the region
462 1.1 jruoho * is just inaccessible as indicated to the _REG method
463 1.1 jruoho *
464 1.1 jruoho * If the region is on the handler's list, this must be the
465 1.1 jruoho * region's handler
466 1.1 jruoho */
467 1.1 jruoho RegionObj->Region.Handler = NULL;
468 1.1 jruoho AcpiUtRemoveReference (HandlerObj);
469 1.1 jruoho
470 1.1 jruoho return_VOID;
471 1.1 jruoho }
472 1.1 jruoho
473 1.1 jruoho /* Walk the linked list of handlers */
474 1.1 jruoho
475 1.1 jruoho LastObjPtr = &ObjDesc->Region.Next;
476 1.1 jruoho ObjDesc = ObjDesc->Region.Next;
477 1.1.1.5 christos
478 1.1.1.5 christos /* Prevent infinite loop if list is corrupted */
479 1.1.1.5 christos
480 1.1.1.5 christos if (ObjDesc == StartDesc)
481 1.1.1.5 christos {
482 1.1.1.5 christos ACPI_ERROR ((AE_INFO,
483 1.1.1.5 christos "Circular handler list in region object %p",
484 1.1.1.5 christos RegionObj));
485 1.1.1.5 christos return_VOID;
486 1.1.1.5 christos }
487 1.1 jruoho }
488 1.1 jruoho
489 1.1 jruoho /* If we get here, the region was not in the handler's region list */
490 1.1 jruoho
491 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
492 1.1 jruoho "Cannot remove region %p from address handler %p\n",
493 1.1 jruoho RegionObj, HandlerObj));
494 1.1 jruoho
495 1.1 jruoho return_VOID;
496 1.1 jruoho }
497 1.1 jruoho
498 1.1 jruoho
499 1.1 jruoho /*******************************************************************************
500 1.1 jruoho *
501 1.1 jruoho * FUNCTION: AcpiEvAttachRegion
502 1.1 jruoho *
503 1.1 jruoho * PARAMETERS: HandlerObj - Handler Object
504 1.1 jruoho * RegionObj - Region Object
505 1.1 jruoho * AcpiNsIsLocked - Namespace Region Already Locked?
506 1.1 jruoho *
507 1.1 jruoho * RETURN: None
508 1.1 jruoho *
509 1.1 jruoho * DESCRIPTION: Create the association between the handler and the region
510 1.1 jruoho * this is a two way association.
511 1.1 jruoho *
512 1.1 jruoho ******************************************************************************/
513 1.1 jruoho
514 1.1 jruoho ACPI_STATUS
515 1.1 jruoho AcpiEvAttachRegion (
516 1.1 jruoho ACPI_OPERAND_OBJECT *HandlerObj,
517 1.1 jruoho ACPI_OPERAND_OBJECT *RegionObj,
518 1.1 jruoho BOOLEAN AcpiNsIsLocked)
519 1.1 jruoho {
520 1.1 jruoho
521 1.1 jruoho ACPI_FUNCTION_TRACE (EvAttachRegion);
522 1.1 jruoho
523 1.1 jruoho
524 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
525 1.1 jruoho "Adding Region [%4.4s] %p to address handler %p [%s]\n",
526 1.1 jruoho AcpiUtGetNodeName (RegionObj->Region.Node),
527 1.1 jruoho RegionObj, HandlerObj,
528 1.1 jruoho AcpiUtGetRegionName (RegionObj->Region.SpaceId)));
529 1.1 jruoho
530 1.1 jruoho /* Link this region to the front of the handler's list */
531 1.1 jruoho
532 1.1 jruoho RegionObj->Region.Next = HandlerObj->AddressSpace.RegionList;
533 1.1 jruoho HandlerObj->AddressSpace.RegionList = RegionObj;
534 1.1 jruoho
535 1.1 jruoho /* Install the region's handler */
536 1.1 jruoho
537 1.1 jruoho if (RegionObj->Region.Handler)
538 1.1 jruoho {
539 1.1 jruoho return_ACPI_STATUS (AE_ALREADY_EXISTS);
540 1.1 jruoho }
541 1.1 jruoho
542 1.1 jruoho RegionObj->Region.Handler = HandlerObj;
543 1.1 jruoho AcpiUtAddReference (HandlerObj);
544 1.1 jruoho
545 1.1 jruoho return_ACPI_STATUS (AE_OK);
546 1.1 jruoho }
547 1.1 jruoho
548 1.1 jruoho
549 1.1 jruoho /*******************************************************************************
550 1.1 jruoho *
551 1.1.1.4 christos * FUNCTION: AcpiEvExecuteRegMethod
552 1.1 jruoho *
553 1.1.1.4 christos * PARAMETERS: RegionObj - Region object
554 1.1.1.4 christos * Function - Passed to _REG: On (1) or Off (0)
555 1.1 jruoho *
556 1.1 jruoho * RETURN: Status
557 1.1 jruoho *
558 1.1.1.4 christos * DESCRIPTION: Execute _REG method for a region
559 1.1 jruoho *
560 1.1 jruoho ******************************************************************************/
561 1.1 jruoho
562 1.1 jruoho ACPI_STATUS
563 1.1.1.4 christos AcpiEvExecuteRegMethod (
564 1.1.1.4 christos ACPI_OPERAND_OBJECT *RegionObj,
565 1.1.1.4 christos UINT32 Function)
566 1.1 jruoho {
567 1.1.1.4 christos ACPI_EVALUATE_INFO *Info;
568 1.1.1.4 christos ACPI_OPERAND_OBJECT *Args[3];
569 1.1.1.4 christos ACPI_OPERAND_OBJECT *RegionObj2;
570 1.1 jruoho ACPI_STATUS Status;
571 1.1 jruoho
572 1.1 jruoho
573 1.1.1.4 christos ACPI_FUNCTION_TRACE (EvExecuteRegMethod);
574 1.1 jruoho
575 1.1 jruoho
576 1.1.1.4 christos RegionObj2 = AcpiNsGetSecondaryObject (RegionObj);
577 1.1.1.4 christos if (!RegionObj2)
578 1.1 jruoho {
579 1.1.1.4 christos return_ACPI_STATUS (AE_NOT_EXIST);
580 1.1 jruoho }
581 1.1 jruoho
582 1.1.1.4 christos if (RegionObj2->Extra.Method_REG == NULL)
583 1.1 jruoho {
584 1.1.1.4 christos return_ACPI_STATUS (AE_OK);
585 1.1 jruoho }
586 1.1 jruoho
587 1.1.1.4 christos /* Allocate and initialize the evaluation information block */
588 1.1 jruoho
589 1.1.1.4 christos Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
590 1.1.1.4 christos if (!Info)
591 1.1 jruoho {
592 1.1.1.4 christos return_ACPI_STATUS (AE_NO_MEMORY);
593 1.1 jruoho }
594 1.1 jruoho
595 1.1.1.4 christos Info->PrefixNode = RegionObj2->Extra.Method_REG;
596 1.1.1.4 christos Info->RelativePathname = NULL;
597 1.1.1.4 christos Info->Parameters = Args;
598 1.1.1.4 christos Info->Flags = ACPI_IGNORE_RETURN_VALUE;
599 1.1 jruoho
600 1.1 jruoho /*
601 1.1.1.4 christos * The _REG method has two arguments:
602 1.1.1.4 christos *
603 1.1.1.4 christos * Arg0 - Integer:
604 1.1.1.4 christos * Operation region space ID Same value as RegionObj->Region.SpaceId
605 1.1 jruoho *
606 1.1.1.4 christos * Arg1 - Integer:
607 1.1.1.4 christos * connection status 1 for connecting the handler, 0 for disconnecting
608 1.1.1.4 christos * the handler (Passed as a parameter)
609 1.1 jruoho */
610 1.1.1.4 christos Args[0] = AcpiUtCreateIntegerObject ((UINT64) RegionObj->Region.SpaceId);
611 1.1.1.4 christos if (!Args[0])
612 1.1 jruoho {
613 1.1 jruoho Status = AE_NO_MEMORY;
614 1.1.1.4 christos goto Cleanup1;
615 1.1 jruoho }
616 1.1 jruoho
617 1.1.1.4 christos Args[1] = AcpiUtCreateIntegerObject ((UINT64) Function);
618 1.1.1.4 christos if (!Args[1])
619 1.1.1.4 christos {
620 1.1.1.4 christos Status = AE_NO_MEMORY;
621 1.1.1.4 christos goto Cleanup2;
622 1.1.1.4 christos }
623 1.1 jruoho
624 1.1.1.4 christos Args[2] = NULL; /* Terminate list */
625 1.1 jruoho
626 1.1.1.4 christos /* Execute the method, no return value */
627 1.1 jruoho
628 1.1.1.4 christos ACPI_DEBUG_EXEC (
629 1.1.1.4 christos AcpiUtDisplayInitPathname (ACPI_TYPE_METHOD, Info->PrefixNode, NULL));
630 1.1 jruoho
631 1.1.1.4 christos Status = AcpiNsEvaluate (Info);
632 1.1.1.4 christos AcpiUtRemoveReference (Args[1]);
633 1.1 jruoho
634 1.1.1.4 christos Cleanup2:
635 1.1.1.4 christos AcpiUtRemoveReference (Args[0]);
636 1.1 jruoho
637 1.1.1.4 christos Cleanup1:
638 1.1.1.4 christos ACPI_FREE (Info);
639 1.1 jruoho return_ACPI_STATUS (Status);
640 1.1 jruoho }
641 1.1 jruoho
642 1.1 jruoho
643 1.1 jruoho /*******************************************************************************
644 1.1 jruoho *
645 1.1 jruoho * FUNCTION: AcpiEvExecuteRegMethods
646 1.1 jruoho *
647 1.1 jruoho * PARAMETERS: Node - Namespace node for the device
648 1.1 jruoho * SpaceId - The address space ID
649 1.1 jruoho *
650 1.1 jruoho * RETURN: Status
651 1.1 jruoho *
652 1.1 jruoho * DESCRIPTION: Run all _REG methods for the input Space ID;
653 1.1 jruoho * Note: assumes namespace is locked, or system init time.
654 1.1 jruoho *
655 1.1 jruoho ******************************************************************************/
656 1.1 jruoho
657 1.1 jruoho ACPI_STATUS
658 1.1 jruoho AcpiEvExecuteRegMethods (
659 1.1 jruoho ACPI_NAMESPACE_NODE *Node,
660 1.1 jruoho ACPI_ADR_SPACE_TYPE SpaceId)
661 1.1 jruoho {
662 1.1 jruoho ACPI_STATUS Status;
663 1.1 jruoho
664 1.1 jruoho
665 1.1 jruoho ACPI_FUNCTION_TRACE (EvExecuteRegMethods);
666 1.1 jruoho
667 1.1 jruoho
668 1.1 jruoho /*
669 1.1 jruoho * Run all _REG methods for all Operation Regions for this space ID. This
670 1.1 jruoho * is a separate walk in order to handle any interdependencies between
671 1.1 jruoho * regions and _REG methods. (i.e. handlers must be installed for all
672 1.1 jruoho * regions of this Space ID before we can run any _REG methods)
673 1.1 jruoho */
674 1.1 jruoho Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Node, ACPI_UINT32_MAX,
675 1.1 jruoho ACPI_NS_WALK_UNLOCK, AcpiEvRegRun, NULL,
676 1.1 jruoho &SpaceId, NULL);
677 1.1 jruoho
678 1.1.1.3 jruoho /* Special case for EC: handle "orphan" _REG methods with no region */
679 1.1.1.3 jruoho
680 1.1.1.3 jruoho if (SpaceId == ACPI_ADR_SPACE_EC)
681 1.1.1.3 jruoho {
682 1.1.1.4 christos AcpiEvOrphanEcRegMethod (Node);
683 1.1.1.3 jruoho }
684 1.1.1.3 jruoho
685 1.1 jruoho return_ACPI_STATUS (Status);
686 1.1 jruoho }
687 1.1 jruoho
688 1.1 jruoho
689 1.1 jruoho /*******************************************************************************
690 1.1 jruoho *
691 1.1 jruoho * FUNCTION: AcpiEvRegRun
692 1.1 jruoho *
693 1.1 jruoho * PARAMETERS: WalkNamespace callback
694 1.1 jruoho *
695 1.1 jruoho * DESCRIPTION: Run _REG method for region objects of the requested spaceID
696 1.1 jruoho *
697 1.1 jruoho ******************************************************************************/
698 1.1 jruoho
699 1.1 jruoho static ACPI_STATUS
700 1.1 jruoho AcpiEvRegRun (
701 1.1 jruoho ACPI_HANDLE ObjHandle,
702 1.1 jruoho UINT32 Level,
703 1.1 jruoho void *Context,
704 1.1 jruoho void **ReturnValue)
705 1.1 jruoho {
706 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc;
707 1.1 jruoho ACPI_NAMESPACE_NODE *Node;
708 1.1 jruoho ACPI_ADR_SPACE_TYPE SpaceId;
709 1.1 jruoho ACPI_STATUS Status;
710 1.1 jruoho
711 1.1 jruoho
712 1.1 jruoho SpaceId = *ACPI_CAST_PTR (ACPI_ADR_SPACE_TYPE, Context);
713 1.1 jruoho
714 1.1 jruoho /* Convert and validate the device handle */
715 1.1 jruoho
716 1.1 jruoho Node = AcpiNsValidateHandle (ObjHandle);
717 1.1 jruoho if (!Node)
718 1.1 jruoho {
719 1.1 jruoho return (AE_BAD_PARAMETER);
720 1.1 jruoho }
721 1.1 jruoho
722 1.1 jruoho /*
723 1.1 jruoho * We only care about regions.and objects that are allowed to have address
724 1.1 jruoho * space handlers
725 1.1 jruoho */
726 1.1 jruoho if ((Node->Type != ACPI_TYPE_REGION) &&
727 1.1 jruoho (Node != AcpiGbl_RootNode))
728 1.1 jruoho {
729 1.1 jruoho return (AE_OK);
730 1.1 jruoho }
731 1.1 jruoho
732 1.1 jruoho /* Check for an existing internal object */
733 1.1 jruoho
734 1.1 jruoho ObjDesc = AcpiNsGetAttachedObject (Node);
735 1.1 jruoho if (!ObjDesc)
736 1.1 jruoho {
737 1.1 jruoho /* No object, just exit */
738 1.1 jruoho
739 1.1 jruoho return (AE_OK);
740 1.1 jruoho }
741 1.1 jruoho
742 1.1 jruoho /* Object is a Region */
743 1.1 jruoho
744 1.1 jruoho if (ObjDesc->Region.SpaceId != SpaceId)
745 1.1 jruoho {
746 1.1 jruoho /* This region is for a different address space, just ignore it */
747 1.1 jruoho
748 1.1 jruoho return (AE_OK);
749 1.1 jruoho }
750 1.1 jruoho
751 1.1.1.3 jruoho Status = AcpiEvExecuteRegMethod (ObjDesc, ACPI_REG_CONNECT);
752 1.1 jruoho return (Status);
753 1.1 jruoho }
754 1.1 jruoho
755 1.1.1.3 jruoho
756 1.1.1.3 jruoho /*******************************************************************************
757 1.1.1.3 jruoho *
758 1.1.1.3 jruoho * FUNCTION: AcpiEvOrphanEcRegMethod
759 1.1.1.3 jruoho *
760 1.1.1.4 christos * PARAMETERS: EcDeviceNode - Namespace node for an EC device
761 1.1.1.3 jruoho *
762 1.1.1.3 jruoho * RETURN: None
763 1.1.1.3 jruoho *
764 1.1.1.3 jruoho * DESCRIPTION: Execute an "orphan" _REG method that appears under the EC
765 1.1.1.3 jruoho * device. This is a _REG method that has no corresponding region
766 1.1.1.3 jruoho * within the EC device scope. The orphan _REG method appears to
767 1.1.1.3 jruoho * have been enabled by the description of the ECDT in the ACPI
768 1.1.1.3 jruoho * specification: "The availability of the region space can be
769 1.1.1.3 jruoho * detected by providing a _REG method object underneath the
770 1.1.1.3 jruoho * Embedded Controller device."
771 1.1.1.3 jruoho *
772 1.1.1.4 christos * To quickly access the EC device, we use the EcDeviceNode used
773 1.1.1.4 christos * during EC handler installation. Otherwise, we would need to
774 1.1.1.4 christos * perform a time consuming namespace walk, executing _HID
775 1.1.1.4 christos * methods to find the EC device.
776 1.1.1.4 christos *
777 1.1.1.4 christos * MUTEX: Assumes the namespace is locked
778 1.1.1.3 jruoho *
779 1.1.1.3 jruoho ******************************************************************************/
780 1.1.1.3 jruoho
781 1.1.1.3 jruoho static void
782 1.1.1.3 jruoho AcpiEvOrphanEcRegMethod (
783 1.1.1.4 christos ACPI_NAMESPACE_NODE *EcDeviceNode)
784 1.1.1.3 jruoho {
785 1.1.1.4 christos ACPI_HANDLE RegMethod;
786 1.1.1.4 christos ACPI_NAMESPACE_NODE *NextNode;
787 1.1.1.3 jruoho ACPI_STATUS Status;
788 1.1.1.3 jruoho ACPI_OBJECT_LIST Args;
789 1.1.1.3 jruoho ACPI_OBJECT Objects[2];
790 1.1.1.3 jruoho
791 1.1.1.3 jruoho
792 1.1.1.3 jruoho ACPI_FUNCTION_TRACE (EvOrphanEcRegMethod);
793 1.1.1.3 jruoho
794 1.1.1.3 jruoho
795 1.1.1.4 christos if (!EcDeviceNode)
796 1.1.1.3 jruoho {
797 1.1.1.3 jruoho return_VOID;
798 1.1.1.3 jruoho }
799 1.1.1.3 jruoho
800 1.1.1.3 jruoho /* Namespace is currently locked, must release */
801 1.1.1.3 jruoho
802 1.1.1.3 jruoho (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
803 1.1.1.3 jruoho
804 1.1.1.3 jruoho /* Get a handle to a _REG method immediately under the EC device */
805 1.1.1.3 jruoho
806 1.1.1.4 christos Status = AcpiGetHandle (EcDeviceNode, METHOD_NAME__REG, &RegMethod);
807 1.1.1.3 jruoho if (ACPI_FAILURE (Status))
808 1.1.1.3 jruoho {
809 1.1.1.4 christos goto Exit; /* There is no _REG method present */
810 1.1.1.3 jruoho }
811 1.1.1.3 jruoho
812 1.1.1.3 jruoho /*
813 1.1.1.3 jruoho * Execute the _REG method only if there is no Operation Region in
814 1.1.1.3 jruoho * this scope with the Embedded Controller space ID. Otherwise, it
815 1.1.1.3 jruoho * will already have been executed. Note, this allows for Regions
816 1.1.1.3 jruoho * with other space IDs to be present; but the code below will then
817 1.1.1.4 christos * execute the _REG method with the EmbeddedControl SpaceID argument.
818 1.1.1.3 jruoho */
819 1.1.1.3 jruoho NextNode = AcpiNsGetNextNode (EcDeviceNode, NULL);
820 1.1.1.3 jruoho while (NextNode)
821 1.1.1.3 jruoho {
822 1.1.1.3 jruoho if ((NextNode->Type == ACPI_TYPE_REGION) &&
823 1.1.1.3 jruoho (NextNode->Object) &&
824 1.1.1.3 jruoho (NextNode->Object->Region.SpaceId == ACPI_ADR_SPACE_EC))
825 1.1.1.3 jruoho {
826 1.1.1.4 christos goto Exit; /* Do not execute the _REG */
827 1.1.1.3 jruoho }
828 1.1.1.4 christos
829 1.1.1.3 jruoho NextNode = AcpiNsGetNextNode (EcDeviceNode, NextNode);
830 1.1.1.3 jruoho }
831 1.1.1.3 jruoho
832 1.1.1.4 christos /* Evaluate the _REG(EmbeddedControl,Connect) method */
833 1.1.1.3 jruoho
834 1.1.1.3 jruoho Args.Count = 2;
835 1.1.1.3 jruoho Args.Pointer = Objects;
836 1.1.1.3 jruoho Objects[0].Type = ACPI_TYPE_INTEGER;
837 1.1.1.3 jruoho Objects[0].Integer.Value = ACPI_ADR_SPACE_EC;
838 1.1.1.3 jruoho Objects[1].Type = ACPI_TYPE_INTEGER;
839 1.1.1.3 jruoho Objects[1].Integer.Value = ACPI_REG_CONNECT;
840 1.1.1.3 jruoho
841 1.1.1.3 jruoho Status = AcpiEvaluateObject (RegMethod, NULL, &Args, NULL);
842 1.1.1.3 jruoho
843 1.1.1.3 jruoho Exit:
844 1.1.1.3 jruoho /* We ignore all errors from above, don't care */
845 1.1.1.3 jruoho
846 1.1.1.3 jruoho Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
847 1.1.1.3 jruoho return_VOID;
848 1.1.1.3 jruoho }
849