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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the
118 * following license:
119 *
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
122 * are met:
123 * 1. Redistributions of source code must retain the above copyright
124 * notice, this list of conditions, and the following disclaimer,
125 * without modification.
126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127 * substantially similar to the "NO WARRANTY" disclaimer below
128 * ("Disclaimer") and any redistribution must be conditioned upon
129 * including a substantially similar Disclaimer requirement for further
130 * binary redistribution.
131 * 3. Neither the names of the above-listed copyright holders nor the names
132 * of any contributors may be used to endorse or promote products derived
133 * from this software without specific prior written permission.
134 *
135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 *
147 * Alternatively, you may choose to be licensed under the terms of the
148 * GNU General Public License ("GPL") version 2 as published by the Free
149 * Software Foundation.
150 *
151 *****************************************************************************/
152
153 #define EXPORT_ACPI_INTERFACES
154
155 #include "acpi.h"
156 #include "accommon.h"
157 #include "acnamesp.h"
158 #include "acevents.h"
159
160 #define _COMPONENT ACPI_EVENTS
161 ACPI_MODULE_NAME ("evxfregn")
162
163
164 /*******************************************************************************
165 *
166 * FUNCTION: AcpiInstallAddressSpaceHandlerInternal
167 *
168 * PARAMETERS: Device - Handle for the device
169 * SpaceId - The address space ID
170 * Handler - Address of the handler
171 * Setup - Address of the setup function
172 * Context - Value passed to the handler on each access
173 * Run_Reg - Run _REG methods for this address space?
174 *
175 * RETURN: Status
176 *
177 * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
178 *
179 * NOTE: This function should only be called after AcpiEnableSubsystem has
180 * been called. This is because any _REG methods associated with the Space ID
181 * are executed here, and these methods can only be safely executed after
182 * the default handlers have been installed and the hardware has been
183 * initialized (via AcpiEnableSubsystem.)
184 * To avoid this problem pass FALSE for Run_Reg and later on call
185 * AcpiExecuteRegMethods() to execute _REG.
186 *
187 ******************************************************************************/
188
189 static ACPI_STATUS
AcpiInstallAddressSpaceHandlerInternal(ACPI_HANDLE Device,ACPI_ADR_SPACE_TYPE SpaceId,ACPI_ADR_SPACE_HANDLER Handler,ACPI_ADR_SPACE_SETUP Setup,void * Context,BOOLEAN Run_Reg)190 AcpiInstallAddressSpaceHandlerInternal (
191 ACPI_HANDLE Device,
192 ACPI_ADR_SPACE_TYPE SpaceId,
193 ACPI_ADR_SPACE_HANDLER Handler,
194 ACPI_ADR_SPACE_SETUP Setup,
195 void *Context,
196 BOOLEAN Run_Reg)
197 {
198 ACPI_NAMESPACE_NODE *Node;
199 ACPI_STATUS Status;
200
201
202 ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
203
204
205 /* Parameter validation */
206
207 if (!Device)
208 {
209 return_ACPI_STATUS (AE_BAD_PARAMETER);
210 }
211
212 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
213 if (ACPI_FAILURE (Status))
214 {
215 return_ACPI_STATUS (Status);
216 }
217
218 /* Convert and validate the device handle */
219
220 Node = AcpiNsValidateHandle (Device);
221 if (!Node)
222 {
223 Status = AE_BAD_PARAMETER;
224 goto UnlockAndExit;
225 }
226
227 /* Install the handler for all Regions for this Space ID */
228
229 Status = AcpiEvInstallSpaceHandler (
230 Node, SpaceId, Handler, Setup, Context);
231 if (ACPI_FAILURE (Status))
232 {
233 goto UnlockAndExit;
234 }
235
236 /* Run all _REG methods for this address space */
237
238 if (Run_Reg)
239 {
240 AcpiEvExecuteRegMethods (Node, SpaceId, ACPI_REG_CONNECT);
241 }
242
243 UnlockAndExit:
244 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
245 return_ACPI_STATUS (Status);
246 }
247
248 ACPI_STATUS
AcpiInstallAddressSpaceHandler(ACPI_HANDLE Device,ACPI_ADR_SPACE_TYPE SpaceId,ACPI_ADR_SPACE_HANDLER Handler,ACPI_ADR_SPACE_SETUP Setup,void * Context)249 AcpiInstallAddressSpaceHandler (
250 ACPI_HANDLE Device,
251 ACPI_ADR_SPACE_TYPE SpaceId,
252 ACPI_ADR_SPACE_HANDLER Handler,
253 ACPI_ADR_SPACE_SETUP Setup,
254 void *Context)
255 {
256 return AcpiInstallAddressSpaceHandlerInternal (Device, SpaceId, Handler, Setup, Context, TRUE);
257 }
258
ACPI_EXPORT_SYMBOL(AcpiInstallAddressSpaceHandler)259 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
260
261 ACPI_STATUS
262 AcpiInstallAddressSpaceHandlerNo_Reg (
263 ACPI_HANDLE Device,
264 ACPI_ADR_SPACE_TYPE SpaceId,
265 ACPI_ADR_SPACE_HANDLER Handler,
266 ACPI_ADR_SPACE_SETUP Setup,
267 void *Context)
268 {
269 return AcpiInstallAddressSpaceHandlerInternal (Device, SpaceId, Handler, Setup, Context, FALSE);
270 }
271
ACPI_EXPORT_SYMBOL(AcpiInstallAddressSpaceHandlerNo_Reg)272 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandlerNo_Reg)
273
274
275 /*******************************************************************************
276 *
277 * FUNCTION: AcpiRemoveAddressSpaceHandler
278 *
279 * PARAMETERS: Device - Handle for the device
280 * SpaceId - The address space ID
281 * Handler - Address of the handler
282 *
283 * RETURN: Status
284 *
285 * DESCRIPTION: Remove a previously installed handler.
286 *
287 ******************************************************************************/
288
289 ACPI_STATUS
290 AcpiRemoveAddressSpaceHandler (
291 ACPI_HANDLE Device,
292 ACPI_ADR_SPACE_TYPE SpaceId,
293 ACPI_ADR_SPACE_HANDLER Handler)
294 {
295 ACPI_OPERAND_OBJECT *ObjDesc;
296 ACPI_OPERAND_OBJECT *HandlerObj;
297 ACPI_OPERAND_OBJECT *RegionObj;
298 ACPI_OPERAND_OBJECT **LastObjPtr;
299 ACPI_NAMESPACE_NODE *Node;
300 ACPI_STATUS Status;
301
302
303 ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
304
305
306 /* Parameter validation */
307
308 if (!Device)
309 {
310 return_ACPI_STATUS (AE_BAD_PARAMETER);
311 }
312
313 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
314 if (ACPI_FAILURE (Status))
315 {
316 return_ACPI_STATUS (Status);
317 }
318
319 /* Convert and validate the device handle */
320
321 Node = AcpiNsValidateHandle (Device);
322 if (!Node ||
323 ((Node->Type != ACPI_TYPE_DEVICE) &&
324 (Node->Type != ACPI_TYPE_PROCESSOR) &&
325 (Node->Type != ACPI_TYPE_THERMAL) &&
326 (Node != AcpiGbl_RootNode)))
327 {
328 Status = AE_BAD_PARAMETER;
329 goto UnlockAndExit;
330 }
331
332 /* Make sure the internal object exists */
333
334 ObjDesc = AcpiNsGetAttachedObject (Node);
335 if (!ObjDesc)
336 {
337 Status = AE_NOT_EXIST;
338 goto UnlockAndExit;
339 }
340
341 /* Find the address handler the user requested */
342
343 HandlerObj = ObjDesc->CommonNotify.Handler;
344 LastObjPtr = &ObjDesc->CommonNotify.Handler;
345 while (HandlerObj)
346 {
347 /* We have a handler, see if user requested this one */
348
349 if (HandlerObj->AddressSpace.SpaceId == SpaceId)
350 {
351 /* Handler must be the same as the installed handler */
352
353 if (HandlerObj->AddressSpace.Handler != Handler)
354 {
355 Status = AE_BAD_PARAMETER;
356 goto UnlockAndExit;
357 }
358
359 /* Matched SpaceId, first dereference this in the Regions */
360
361 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
362 "Removing address handler %p(%p) for region %s "
363 "on Device %p(%p)\n",
364 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
365 Node, ObjDesc));
366
367 RegionObj = HandlerObj->AddressSpace.RegionList;
368
369 /* Walk the handler's region list */
370
371 while (RegionObj)
372 {
373 /*
374 * First disassociate the handler from the region.
375 *
376 * NOTE: this doesn't mean that the region goes away
377 * The region is just inaccessible as indicated to
378 * the _REG method
379 */
380 AcpiEvDetachRegion (RegionObj, TRUE);
381
382 /*
383 * Walk the list: Just grab the head because the
384 * DetachRegion removed the previous head.
385 */
386 RegionObj = HandlerObj->AddressSpace.RegionList;
387 }
388
389 /* Remove this Handler object from the list */
390
391 *LastObjPtr = HandlerObj->AddressSpace.Next;
392
393 /* Now we can delete the handler object */
394
395 AcpiOsReleaseMutex (HandlerObj->AddressSpace.ContextMutex);
396 AcpiUtRemoveReference (HandlerObj);
397 goto UnlockAndExit;
398 }
399
400 /* Walk the linked list of handlers */
401
402 LastObjPtr = &HandlerObj->AddressSpace.Next;
403 HandlerObj = HandlerObj->AddressSpace.Next;
404 }
405
406 /* The handler does not exist */
407
408 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
409 "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
410 Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
411
412 Status = AE_NOT_EXIST;
413
414 UnlockAndExit:
415 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
416 return_ACPI_STATUS (Status);
417 }
418
ACPI_EXPORT_SYMBOL(AcpiRemoveAddressSpaceHandler)419 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
420
421
422 /*******************************************************************************
423 *
424 * FUNCTION: AcpiExecuteRegMethods
425 *
426 * PARAMETERS: Device - Handle for the device
427 * SpaceId - The address space ID
428 *
429 * RETURN: Status
430 *
431 * DESCRIPTION: Execute _REG for all OpRegions of a given SpaceId.
432 *
433 ******************************************************************************/
434
435 ACPI_STATUS
436 AcpiExecuteRegMethods (
437 ACPI_HANDLE Device,
438 ACPI_ADR_SPACE_TYPE SpaceId)
439 {
440 ACPI_NAMESPACE_NODE *Node;
441 ACPI_STATUS Status;
442
443
444 ACPI_FUNCTION_TRACE (AcpiExecuteRegMethods);
445
446
447 /* Parameter validation */
448
449 if (!Device)
450 {
451 return_ACPI_STATUS (AE_BAD_PARAMETER);
452 }
453
454 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
455 if (ACPI_FAILURE (Status))
456 {
457 return_ACPI_STATUS (Status);
458 }
459
460 /* Convert and validate the device handle */
461
462 Node = AcpiNsValidateHandle (Device);
463 if (Node)
464 {
465 /* Run all _REG methods for this address space */
466
467 AcpiEvExecuteRegMethods (Node, SpaceId, ACPI_REG_CONNECT);
468 }
469 else
470 {
471 Status = AE_BAD_PARAMETER;
472 }
473
474 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
475 return_ACPI_STATUS (Status);
476 }
477
478 ACPI_EXPORT_SYMBOL (AcpiExecuteRegMethods)
479
