1 /******************************************************************************
3 * Module Name: examples - Example ACPICA initialization and execution code
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include "examples.h"
154 #define _COMPONENT ACPI_EXAMPLE
155 ACPI_MODULE_NAME ("examples")
158 /******************************************************************************
160 * ACPICA Example Code
162 * This module contains examples of how the host OS should interface to the
165 * 1) How to use the platform/acenv.h file and how to set configuration
168 * 2) main - using the debug output mechanism and the error/warning output
171 * 3) Two examples of the ACPICA initialization sequence. The first is a
172 * initialization with no "early" ACPI table access. The second shows
173 * how to use ACPICA to obtain the tables very early during kernel
174 * initialization, even before dynamic memory is available.
176 * 4) How to invoke a control method, including argument setup and how to
177 * access the return value.
179 *****************************************************************************/
182 /* Local Prototypes */
185 InitializeFullAcpica (void);
188 InstallHandlers (void);
199 ACPI_PHYSICAL_ADDRESS Address,
202 void *HandlerContext,
203 void *RegionContext);
207 ACPI_HANDLE RegionHandle,
209 void *HandlerContext,
210 void **RegionContext);
216 InitializeAcpiTables (
224 /******************************************************************************
228 * PARAMETERS: argc, argv
232 * DESCRIPTION: Main routine. Shows the use of the various output macros, as
233 * well as the use of the debug layer/level globals.
235 *****************************************************************************/
237 int ACPI_SYSTEM_XFACE
243 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
245 printf (ACPI_COMMON_SIGNON ("ACPI Example Code"));
247 /* Initialize the local ACPI tables (RSDP/RSDT/XSDT/FADT/DSDT/FACS) */
249 ExInitializeAcpiTables ();
251 /* Initialize the ACPICA subsystem */
253 InitializeFullAcpica ();
255 /* Example warning and error output */
257 ACPI_INFO (("Example ACPICA info message"));
258 ACPI_WARNING ((AE_INFO, "Example ACPICA warning message"));
259 ACPI_ERROR ((AE_INFO, "Example ACPICA error message"));
260 ACPI_EXCEPTION ((AE_INFO, AE_AML_OPERAND_TYPE,
261 "Example ACPICA exception message"));
263 ExecuteOSI (NULL, 0);
269 /******************************************************************************
271 * Example ACPICA initialization code. This shows a full initialization with
272 * no early ACPI table access.
274 *****************************************************************************/
277 InitializeFullAcpica (void)
282 /* Initialize the ACPICA subsystem */
284 Status = AcpiInitializeSubsystem ();
285 if (ACPI_FAILURE (Status))
287 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA"));
291 /* Initialize the ACPICA Table Manager and get all ACPI tables */
293 ACPI_INFO (("Loading ACPI tables"));
295 Status = AcpiInitializeTables (NULL, 16, FALSE);
296 if (ACPI_FAILURE (Status))
298 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing Table Manager"));
302 /* Install local handlers */
304 Status = InstallHandlers ();
305 if (ACPI_FAILURE (Status))
307 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
311 /* Initialize the ACPI hardware */
313 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
314 if (ACPI_FAILURE (Status))
316 ACPI_EXCEPTION ((AE_INFO, Status, "While enabling ACPICA"));
320 /* Create the ACPI namespace from ACPI tables */
322 Status = AcpiLoadTables ();
323 if (ACPI_FAILURE (Status))
325 ACPI_EXCEPTION ((AE_INFO, Status, "While loading ACPI tables"));
329 /* Complete the ACPI namespace object initialization */
331 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
332 if (ACPI_FAILURE (Status))
334 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA objects"));
342 /******************************************************************************
344 * Example ACPICA initialization code with early ACPI table access. This shows
345 * an initialization that requires early access to ACPI tables (before
346 * kernel dynamic memory is available)
348 *****************************************************************************/
351 * The purpose of this static table array is to avoid the use of kernel
352 * dynamic memory which may not be available during early ACPI table
355 #define ACPI_MAX_INIT_TABLES 16
356 static ACPI_TABLE_DESC TableArray[ACPI_MAX_INIT_TABLES];
360 * This function would be called early in kernel initialization. After this
361 * is called, all ACPI tables are available to the host.
364 InitializeAcpiTables (
370 /* Initialize the ACPICA Table Manager and get all ACPI tables */
372 Status = AcpiInitializeTables (TableArray, ACPI_MAX_INIT_TABLES, TRUE);
378 * This function would be called after the kernel is initialized and
379 * dynamic/virtual memory is available. It completes the initialization of
380 * the ACPICA subsystem.
389 /* Initialize the ACPICA subsystem */
391 Status = AcpiInitializeSubsystem ();
392 if (ACPI_FAILURE (Status))
397 /* Copy the root table list to dynamic memory */
399 Status = AcpiReallocateRootTable ();
400 if (ACPI_FAILURE (Status))
405 /* Install local handlers */
407 Status = InstallHandlers ();
408 if (ACPI_FAILURE (Status))
410 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
414 /* Initialize the ACPI hardware */
416 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
417 if (ACPI_FAILURE (Status))
422 /* Create the ACPI namespace from ACPI tables */
424 Status = AcpiLoadTables ();
425 if (ACPI_FAILURE (Status))
430 /* Complete the ACPI namespace object initialization */
432 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
433 if (ACPI_FAILURE (Status))
442 /******************************************************************************
444 * Example ACPICA handler and handler installation
446 *****************************************************************************/
455 ACPI_INFO (("Received a notify 0x%X", Value));
461 ACPI_HANDLE RegionHandle,
463 void *HandlerContext,
464 void **RegionContext)
467 if (Function == ACPI_REGION_DEACTIVATE)
469 *RegionContext = NULL;
473 *RegionContext = RegionHandle;
483 ACPI_PHYSICAL_ADDRESS Address,
486 void *HandlerContext,
490 ACPI_INFO (("Received a region access"));
497 InstallHandlers (void)
502 /* Install global notify handler */
504 Status = AcpiInstallNotifyHandler (ACPI_ROOT_OBJECT,
505 ACPI_SYSTEM_NOTIFY, NotifyHandler, NULL);
506 if (ACPI_FAILURE (Status))
508 ACPI_EXCEPTION ((AE_INFO, Status, "While installing Notify handler"));
512 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT,
513 ACPI_ADR_SPACE_SYSTEM_MEMORY, RegionHandler, RegionInit, NULL);
514 if (ACPI_FAILURE (Status))
516 ACPI_EXCEPTION ((AE_INFO, Status, "While installing an OpRegion handler"));
524 /******************************************************************************
526 * Examples of control method execution.
528 * _OSI is a predefined method that is implemented internally within ACPICA.
530 * Shows the following elements:
532 * 1) How to setup a control method argument and argument list
533 * 2) How to setup the return value object
534 * 3) How to invoke AcpiEvaluateObject
535 * 4) How to check the returned ACPI_STATUS
536 * 5) How to analyze the return value
538 *****************************************************************************/
543 UINT64 ExpectedResult)
546 ACPI_OBJECT_LIST ArgList;
548 ACPI_BUFFER ReturnValue;
552 ACPI_INFO (("Executing _OSI reserved method"));
554 /* Setup input argument */
557 ArgList.Pointer = Arg;
559 Arg[0].Type = ACPI_TYPE_STRING;
560 Arg[0].String.Pointer = "Windows 2001";
561 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
563 /* Ask ACPICA to allocate space for the return object */
565 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
567 Status = AcpiEvaluateObject (NULL, "\\_OSI", &ArgList, &ReturnValue);
568 if (ACPI_FAILURE (Status))
570 ACPI_EXCEPTION ((AE_INFO, Status, "While executing _OSI"));
574 /* Ensure that the return object is large enough */
576 if (ReturnValue.Length < sizeof (ACPI_OBJECT))
578 AcpiOsPrintf ("Return value from _OSI method too small, %.8X\n",
583 /* Expect an integer return value from execution of _OSI */
585 Object = ReturnValue.Pointer;
586 if (Object->Type != ACPI_TYPE_INTEGER)
588 AcpiOsPrintf ("Invalid return type from _OSI, %.2X\n", Object->Type);
591 ACPI_INFO (("_OSI returned 0x%8.8X",
592 (UINT32) Object->Integer.Value));
597 /* Free a buffer created via ACPI_ALLOCATE_BUFFER */
599 AcpiOsFree (ReturnValue.Pointer);
604 /******************************************************************************
606 * Execute an actual control method in the DSDT (MAIN)
608 *****************************************************************************/
614 ACPI_OBJECT_LIST ArgList;
616 ACPI_BUFFER ReturnValue;
620 ACPI_INFO (("Executing MAIN method"));
622 /* Setup input argument */
625 ArgList.Pointer = Arg;
627 Arg[0].Type = ACPI_TYPE_STRING;
628 Arg[0].String.Pointer = "Method [MAIN] is executing";
629 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
631 /* Ask ACPICA to allocate space for the return object */
633 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
635 Status = AcpiEvaluateObject (NULL, "\\MAIN", &ArgList, &ReturnValue);
636 if (ACPI_FAILURE (Status))
638 ACPI_EXCEPTION ((AE_INFO, Status, "While executing MAIN"));
642 if (ReturnValue.Pointer)
644 /* Obtain and validate the returned ACPI_OBJECT */
646 Object = ReturnValue.Pointer;
647 if (Object->Type == ACPI_TYPE_STRING)
649 AcpiOsPrintf ("Method [MAIN] returned: \"%s\"\n",
650 Object->String.Pointer);
653 ACPI_FREE (ReturnValue.Pointer);