1 /******************************************************************************
2 *
3 * Module Name: aeinstall - Installation of operation region handlers
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "aecommon.h"
153
154 #define _COMPONENT ACPI_TOOLS
155 ACPI_MODULE_NAME ("aeinstall")
156
157
158 static ACPI_STATUS
159 AeRegionInit (
160 ACPI_HANDLE RegionHandle,
161 UINT32 Function,
162 void *HandlerContext,
163 void **RegionContext);
164
165 static ACPI_STATUS
166 AeInstallEcHandler (
167 ACPI_HANDLE ObjHandle,
168 UINT32 Level,
169 void *Context,
170 void **ReturnValue);
171
172 static ACPI_STATUS
173 AeInstallPciHandler (
174 ACPI_HANDLE ObjHandle,
175 UINT32 Level,
176 void *Context,
177 void **ReturnValue);
178
179 static ACPI_STATUS
180 AeInstallGedHandler (
181 ACPI_HANDLE ObjHandle,
182 UINT32 Level,
183 void *Context,
184 void **ReturnValue);
185
186
187 BOOLEAN AcpiGbl_DisplayRegionAccess = FALSE;
188 ACPI_CONNECTION_INFO AeMyContext;
189
190
191 /*
192 * We will override some of the default region handlers, especially
193 * the SystemMemory handler, which must be implemented locally.
194 * These handlers are installed "early" - before any _REG methods
195 * are executed - since they are special in the sense that the ACPI spec
196 * declares that they must "always be available". Cannot override the
197 * DataTable region handler either -- needed for test execution.
198 *
199 * NOTE: The local region handler will simulate access to these address
200 * spaces by creating a memory buffer behind each operation region.
201 */
202 static ACPI_ADR_SPACE_TYPE DefaultSpaceIdList[] =
203 {
204 ACPI_ADR_SPACE_SYSTEM_MEMORY,
205 ACPI_ADR_SPACE_SYSTEM_IO,
206 ACPI_ADR_SPACE_PCI_CONFIG,
207 ACPI_ADR_SPACE_EC
208 };
209
210 /*
211 * We will install handlers for some of the various address space IDs.
212 * Test one user-defined address space (used by aslts).
213 */
214 #define ACPI_ADR_SPACE_USER_DEFINED1 0x80
215 #define ACPI_ADR_SPACE_USER_DEFINED2 0xE4
216
217 static ACPI_ADR_SPACE_TYPE SpaceIdList[] =
218 {
219 ACPI_ADR_SPACE_SMBUS,
220 ACPI_ADR_SPACE_CMOS,
221 ACPI_ADR_SPACE_PCI_BAR_TARGET,
222 ACPI_ADR_SPACE_IPMI,
223 ACPI_ADR_SPACE_GPIO,
224 ACPI_ADR_SPACE_GSBUS,
225 ACPI_ADR_SPACE_PLATFORM_COMM,
226 ACPI_ADR_SPACE_PLATFORM_RT,
227 ACPI_ADR_SPACE_FIXED_HARDWARE,
228 ACPI_ADR_SPACE_USER_DEFINED1,
229 ACPI_ADR_SPACE_USER_DEFINED2
230 };
231
232
233 /******************************************************************************
234 *
235 * FUNCTION: AeRegionInit
236 *
237 * PARAMETERS: Region init handler
238 *
239 * RETURN: Status
240 *
241 * DESCRIPTION: Opregion init function.
242 *
243 *****************************************************************************/
244
245 static ACPI_STATUS
AeRegionInit(ACPI_HANDLE RegionHandle,UINT32 Function,void * HandlerContext,void ** RegionContext)246 AeRegionInit (
247 ACPI_HANDLE RegionHandle,
248 UINT32 Function,
249 void *HandlerContext,
250 void **RegionContext)
251 {
252
253 if (Function == ACPI_REGION_DEACTIVATE)
254 {
255 *RegionContext = NULL;
256 }
257 else
258 {
259 *RegionContext = RegionHandle;
260 }
261
262 return (AE_OK);
263 }
264
265
266 /******************************************************************************
267 *
268 * FUNCTION: AeOverrideRegionHandlers
269 *
270 * PARAMETERS: None
271 *
272 * RETURN: None
273 *
274 * DESCRIPTION: Override the default region handlers for memory, i/o, and
275 * pci_config. Also install a handler for EC. This is part of
276 * the "install early handlers" functionality.
277 *
278 *****************************************************************************/
279
280 void
AeOverrideRegionHandlers(void)281 AeOverrideRegionHandlers (
282 void)
283 {
284 UINT32 i;
285 ACPI_STATUS Status;
286
287 /*
288 * Install handlers that will override the default handlers for some of
289 * the space IDs.
290 */
291 for (i = 0; i < ACPI_ARRAY_LENGTH (DefaultSpaceIdList); i++)
292 {
293 /* Install handler at the root object */
294
295 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT,
296 DefaultSpaceIdList[i], AeRegionHandler, AeRegionInit,
297 &AeMyContext);
298
299 if (ACPI_FAILURE (Status))
300 {
301 ACPI_EXCEPTION ((AE_INFO, Status,
302 "Could not install an OpRegion handler for %s space(%u)",
303 AcpiUtGetRegionName ((UINT8) DefaultSpaceIdList[i]),
304 DefaultSpaceIdList[i]));
305 }
306 }
307 }
308
309
310 /******************************************************************************
311 *
312 * FUNCTION: AeInstallRegionHandlers
313 *
314 * PARAMETERS: None
315 *
316 * RETURN: None
317 *
318 * DESCRIPTION: Install handlers for the address spaces other than
319 * SystemMemory, SystemIO, and PCI_CONFIG.
320 *
321 *****************************************************************************/
322
323 void
AeInstallRegionHandlers(void)324 AeInstallRegionHandlers (
325 void)
326 {
327 UINT32 i;
328 ACPI_STATUS Status;
329
330
331 /*
332 * Install handlers for some of the "device driver" address spaces
333 * such as SMBus, etc.
334 */
335 for (i = 0; i < ACPI_ARRAY_LENGTH (SpaceIdList); i++)
336 {
337 /* Install handler at the root object */
338
339 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT,
340 SpaceIdList[i], AeRegionHandler, AeRegionInit,
341 &AeMyContext);
342
343 if (ACPI_FAILURE (Status))
344 {
345 ACPI_EXCEPTION ((AE_INFO, Status,
346 "Could not install an OpRegion handler for %s space(%u)",
347 AcpiUtGetRegionName((UINT8) SpaceIdList[i]), SpaceIdList[i]));
348 return;
349 }
350 }
351 }
352
353 /*******************************************************************************
354 *
355 * FUNCTION: AeInstallGedHandler
356 *
357 * PARAMETERS: ACPI_WALK_NAMESPACE callback
358 *
359 * RETURN: Status
360 *
361 * DESCRIPTION: Walk entire namespace, install a handler for every GED
362 * device found.
363 *
364 ******************************************************************************/
365 static ACPI_STATUS
AeInstallGedHandler(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)366 AeInstallGedHandler (
367 ACPI_HANDLE ObjHandle,
368 UINT32 Level,
369 void *Context,
370 void **ReturnValue)
371 {
372
373 ACPI_BUFFER ReturnBuffer;
374 ACPI_STATUS Status;
375 ACPI_RESOURCE *ResourceList;
376 ACPI_RESOURCE_EXTENDED_IRQ *extended_irq_rsc;
377 ACPI_NAMESPACE_NODE *Node;
378 ACPI_NAMESPACE_NODE *EvtMethodNode;
379
380 ACPI_FUNCTION_ENTRY();
381
382 /* Obtain the Namespace Node of this GED object handle. */
383 Node = AcpiNsValidateHandle (ObjHandle);
384 if (!Node)
385 {
386 return (AE_BAD_PARAMETER);
387 }
388
389 /*
390 * A GED device must have one _EVT method.
391 * Obtain the _EVT method and store it in the global
392 * GED register.
393 */
394 Status = AcpiNsSearchOneScope (
395 *ACPI_CAST_PTR (ACPI_NAME, METHOD_NAME__EVT),
396 Node,
397 ACPI_TYPE_METHOD,
398 &EvtMethodNode
399 );
400 if (ACPI_FAILURE (Status))
401 {
402 AcpiOsPrintf ("Failed to obtain _EVT method for the GED device.\n");
403 return Status;
404 }
405
406 ReturnBuffer.Pointer = NULL;
407 ReturnBuffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
408
409 Status = AcpiGetCurrentResources (ObjHandle, &ReturnBuffer);
410 if (ACPI_FAILURE (Status))
411 {
412 AcpiOsPrintf ("AcpiGetCurrentResources failed: %s\n",
413 AcpiFormatException (Status));
414 return Status;
415 }
416
417 /* Traverse the _CRS resource list */
418 ResourceList = ACPI_CAST_PTR (ACPI_RESOURCE, ReturnBuffer.Pointer);
419 while (ResourceList->Type != ACPI_RESOURCE_TYPE_END_TAG) {
420
421 switch (ResourceList->Type) {
422 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ: {
423
424 /*
425 * Found an Interrupt resource. Link the interrupt resource
426 * and the _EVT method of this GED device in the GED event handler list.
427 */
428 ACPI_GED_HANDLER_INFO *GedHandler =
429 ACPI_ALLOCATE (sizeof (ACPI_SCI_HANDLER_INFO));
430 if (!GedHandler)
431 {
432 return AE_NO_MEMORY;
433 }
434
435 GedHandler->Next = AcpiGbl_GedHandlerList;
436 AcpiGbl_GedHandlerList = GedHandler;
437
438 extended_irq_rsc = &ResourceList->Data.ExtendedIrq;
439
440 GedHandler->IntId = extended_irq_rsc->Interrupts[0];
441 GedHandler->EvtMethod = EvtMethodNode;
442
443 AcpiOsPrintf ("Interrupt ID %d\n", extended_irq_rsc->Interrupts[0]);
444
445 break;
446 }
447 default:
448
449 AcpiOsPrintf ("Resource type %X\n", ResourceList->Type);
450 }
451
452 ResourceList = ACPI_NEXT_RESOURCE (ResourceList);
453 }
454
455 return AE_OK;
456 }
457
458 /*******************************************************************************
459 *
460 * FUNCTION: AeInstallDeviceHandlers
461 *
462 * PARAMETERS: None
463 *
464 * RETURN: Status
465 *
466 * DESCRIPTION: Install handlers for all EC, PCI and GED devices in the namespace
467 *
468 ******************************************************************************/
469
470 ACPI_STATUS
AeInstallDeviceHandlers(void)471 AeInstallDeviceHandlers (
472 void)
473 {
474
475 /* Find all Embedded Controller devices */
476
477 AcpiGetDevices ("PNP0C09", AeInstallEcHandler, NULL, NULL);
478
479 /* Install a PCI handler */
480
481 AcpiGetDevices ("PNP0A08", AeInstallPciHandler, NULL, NULL);
482
483 /* Install a GED handler */
484
485 AcpiGetDevices ("ACPI0013", AeInstallGedHandler, NULL, NULL);
486
487 return (AE_OK);
488 }
489
490
491 /*******************************************************************************
492 *
493 * FUNCTION: AeInstallEcHandler
494 *
495 * PARAMETERS: ACPI_WALK_NAMESPACE callback
496 *
497 * RETURN: Status
498 *
499 * DESCRIPTION: Walk entire namespace, install a handler for every EC
500 * device found.
501 *
502 ******************************************************************************/
503
504 static ACPI_STATUS
AeInstallEcHandler(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)505 AeInstallEcHandler (
506 ACPI_HANDLE ObjHandle,
507 UINT32 Level,
508 void *Context,
509 void **ReturnValue)
510 {
511 ACPI_STATUS Status;
512
513
514 /* Install the handler for this EC device */
515
516 Status = AcpiInstallAddressSpaceHandler (ObjHandle,
517 ACPI_ADR_SPACE_EC, AeRegionHandler, AeRegionInit, &AeMyContext);
518 if (ACPI_FAILURE (Status))
519 {
520 ACPI_EXCEPTION ((AE_INFO, Status,
521 "Could not install an OpRegion handler for EC device (%p)",
522 ObjHandle));
523 }
524
525 return (Status);
526 }
527
528
529 /*******************************************************************************
530 *
531 * FUNCTION: AeInstallPciHandler
532 *
533 * PARAMETERS: ACPI_WALK_NAMESPACE callback
534 *
535 * RETURN: Status
536 *
537 * DESCRIPTION: Walk entire namespace, install a handler for every PCI
538 * device found.
539 *
540 ******************************************************************************/
541
542 static ACPI_STATUS
AeInstallPciHandler(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)543 AeInstallPciHandler (
544 ACPI_HANDLE ObjHandle,
545 UINT32 Level,
546 void *Context,
547 void **ReturnValue)
548 {
549 ACPI_STATUS Status;
550
551
552 /* Install memory and I/O handlers for the PCI device */
553
554 Status = AcpiInstallAddressSpaceHandler (ObjHandle,
555 ACPI_ADR_SPACE_SYSTEM_IO, AeRegionHandler, AeRegionInit,
556 &AeMyContext);
557 if (ACPI_FAILURE (Status))
558 {
559 ACPI_EXCEPTION ((AE_INFO, Status,
560 "Could not install an OpRegion handler for PCI device (%p)",
561 ObjHandle));
562 }
563
564 Status = AcpiInstallAddressSpaceHandler (ObjHandle,
565 ACPI_ADR_SPACE_SYSTEM_MEMORY, AeRegionHandler, AeRegionInit,
566 &AeMyContext);
567 if (ACPI_FAILURE (Status))
568 {
569 ACPI_EXCEPTION ((AE_INFO, Status,
570 "Could not install an OpRegion handler for PCI device (%p)",
571 ObjHandle));
572 }
573
574 return (AE_CTRL_TERMINATE);
575 }
576
