1 /******************************************************************************
3 * Module Name: examples - Example ACPICA initialization and execution code
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
46 #define _COMPONENT ACPI_EXAMPLE
47 ACPI_MODULE_NAME ("examples")
50 /******************************************************************************
54 * This module contains examples of how the host OS should interface to the
57 * 1) How to use the platform/acenv.h file and how to set configuration
60 * 2) main - using the debug output mechanism and the error/warning output
63 * 3) Two examples of the ACPICA initialization sequence. The first is a
64 * initialization with no "early" ACPI table access. The second shows
65 * how to use ACPICA to obtain the tables very early during kernel
66 * initialization, even before dynamic memory is available.
68 * 4) How to invoke a control method, including argument setup and how to
69 * access the return value.
71 *****************************************************************************/
74 /* Local Prototypes */
77 InitializeFullAcpica (void);
80 InstallHandlers (void);
91 ACPI_PHYSICAL_ADDRESS Address,
99 ACPI_HANDLE RegionHandle,
101 void *HandlerContext,
102 void **RegionContext);
111 InitializeAcpiTables (
119 /******************************************************************************
123 * PARAMETERS: argc, argv
127 * DESCRIPTION: Main routine. Shows the use of the various output macros, as
128 * well as the use of the debug layer/level globals.
130 *****************************************************************************/
132 int ACPI_SYSTEM_XFACE
138 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
140 printf (ACPI_COMMON_SIGNON ("ACPI Example Code"));
142 /* Initialize the local ACPI tables (RSDP/RSDT/XSDT/FADT/DSDT/FACS) */
144 ExInitializeAcpiTables ();
146 /* Initialize the ACPICA subsystem */
148 InitializeFullAcpica ();
150 /* Example warning and error output */
152 ACPI_INFO ((AE_INFO, "Example ACPICA info message"));
153 ACPI_WARNING ((AE_INFO, "Example ACPICA warning message"));
154 ACPI_ERROR ((AE_INFO, "Example ACPICA error message"));
155 ACPI_EXCEPTION ((AE_INFO, AE_AML_OPERAND_TYPE, "Example ACPICA exception message"));
163 /******************************************************************************
165 * Example ACPICA initialization code. This shows a full initialization with
166 * no early ACPI table access.
168 *****************************************************************************/
171 InitializeFullAcpica (void)
176 /* Initialize the ACPICA subsystem */
178 Status = AcpiInitializeSubsystem ();
179 if (ACPI_FAILURE (Status))
181 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA"));
185 /* Initialize the ACPICA Table Manager and get all ACPI tables */
187 ACPI_INFO ((AE_INFO, "Loading ACPI tables"));
189 Status = AcpiInitializeTables (NULL, 16, FALSE);
190 if (ACPI_FAILURE (Status))
192 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing Table Manager"));
196 /* Create the ACPI namespace from ACPI tables */
198 Status = AcpiLoadTables ();
199 if (ACPI_FAILURE (Status))
201 ACPI_EXCEPTION ((AE_INFO, Status, "While loading ACPI tables"));
205 /* Install local handlers */
207 Status = InstallHandlers ();
208 if (ACPI_FAILURE (Status))
210 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
214 /* Initialize the ACPI hardware */
216 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
217 if (ACPI_FAILURE (Status))
219 ACPI_EXCEPTION ((AE_INFO, Status, "While enabling ACPICA"));
223 /* Complete the ACPI namespace object initialization */
225 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
226 if (ACPI_FAILURE (Status))
228 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA objects"));
236 /******************************************************************************
238 * Example ACPICA initialization code with early ACPI table access. This shows
239 * an initialization that requires early access to ACPI tables (before
240 * kernel dynamic memory is available)
242 *****************************************************************************/
245 * The purpose of this static table array is to avoid the use of kernel
246 * dynamic memory which may not be available during early ACPI table
249 #define ACPI_MAX_INIT_TABLES 16
250 static ACPI_TABLE_DESC TableArray[ACPI_MAX_INIT_TABLES];
254 * This function would be called early in kernel initialization. After this
255 * is called, all ACPI tables are available to the host.
258 InitializeAcpiTables (
264 /* Initialize the ACPICA Table Manager and get all ACPI tables */
266 Status = AcpiInitializeTables (TableArray, ACPI_MAX_INIT_TABLES, TRUE);
272 * This function would be called after the kernel is initialized and
273 * dynamic/virtual memory is available. It completes the initialization of
274 * the ACPICA subsystem.
283 /* Initialize the ACPICA subsystem */
285 Status = AcpiInitializeSubsystem ();
286 if (ACPI_FAILURE (Status))
291 /* Copy the root table list to dynamic memory */
293 Status = AcpiReallocateRootTable ();
294 if (ACPI_FAILURE (Status))
299 /* Create the ACPI namespace from ACPI tables */
301 Status = AcpiLoadTables ();
302 if (ACPI_FAILURE (Status))
307 /* Install local handlers */
309 Status = InstallHandlers ();
310 if (ACPI_FAILURE (Status))
312 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
316 /* Initialize the ACPI hardware */
318 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
319 if (ACPI_FAILURE (Status))
324 /* Complete the ACPI namespace object initialization */
326 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
327 if (ACPI_FAILURE (Status))
336 /******************************************************************************
338 * Example ACPICA handler and handler installation
340 *****************************************************************************/
349 ACPI_INFO ((AE_INFO, "Received a notify 0x%X", Value));
355 ACPI_HANDLE RegionHandle,
357 void *HandlerContext,
358 void **RegionContext)
361 if (Function == ACPI_REGION_DEACTIVATE)
363 *RegionContext = NULL;
367 *RegionContext = RegionHandle;
377 ACPI_PHYSICAL_ADDRESS Address,
380 void *HandlerContext,
384 ACPI_INFO ((AE_INFO, "Received a region access"));
391 InstallHandlers (void)
396 /* Install global notify handler */
398 Status = AcpiInstallNotifyHandler (ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
399 NotifyHandler, NULL);
400 if (ACPI_FAILURE (Status))
402 ACPI_EXCEPTION ((AE_INFO, Status, "While installing Notify handler"));
406 Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT, ACPI_ADR_SPACE_SYSTEM_MEMORY,
407 RegionHandler, RegionInit, NULL);
408 if (ACPI_FAILURE (Status))
410 ACPI_EXCEPTION ((AE_INFO, Status, "While installing an OpRegion handler"));
418 /******************************************************************************
420 * Examples of control method execution.
422 * _OSI is a predefined method that is implemented internally within ACPICA.
424 * Shows the following elements:
426 * 1) How to setup a control method argument and argument list
427 * 2) How to setup the return value object
428 * 3) How to invoke AcpiEvaluateObject
429 * 4) How to check the returned ACPI_STATUS
430 * 5) How to analyze the return value
432 *****************************************************************************/
438 ACPI_OBJECT_LIST ArgList;
440 ACPI_BUFFER ReturnValue;
444 ACPI_INFO ((AE_INFO, "Executing _OSI reserved method"));
446 /* Setup input argument */
449 ArgList.Pointer = Arg;
451 Arg[0].Type = ACPI_TYPE_STRING;
452 Arg[0].String.Pointer = "Windows 2001";
453 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
455 /* Ask ACPICA to allocate space for the return object */
457 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
459 Status = AcpiEvaluateObject (NULL, "\\_OSI", &ArgList, &ReturnValue);
460 if (ACPI_FAILURE (Status))
462 ACPI_EXCEPTION ((AE_INFO, Status, "While executing _OSI"));
466 /* Ensure that the return object is large enough */
468 if (ReturnValue.Length < sizeof (ACPI_OBJECT))
470 AcpiOsPrintf ("Return value from _OSI method too small, %.8X\n",
475 /* Expect an integer return value from execution of _OSI */
477 Object = ReturnValue.Pointer;
478 if (Object->Type != ACPI_TYPE_INTEGER)
480 AcpiOsPrintf ("Invalid return type from _OSI, %.2X\n", Object->Type);
483 ACPI_INFO ((AE_INFO, "_OSI returned 0x%8.8X", (UINT32) Object->Integer.Value));
488 /* Free a buffer created via ACPI_ALLOCATE_BUFFER */
490 AcpiOsFree (ReturnValue.Pointer);
494 /******************************************************************************
496 * Execute an actual control method in the DSDT (MAIN)
498 *****************************************************************************/
504 ACPI_OBJECT_LIST ArgList;
506 ACPI_BUFFER ReturnValue;
510 ACPI_INFO ((AE_INFO, "Executing MAIN method"));
512 /* Setup input argument */
515 ArgList.Pointer = Arg;
517 Arg[0].Type = ACPI_TYPE_STRING;
518 Arg[0].String.Pointer = "Method [MAIN] is executing";
519 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
521 /* Ask ACPICA to allocate space for the return object */
523 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
525 Status = AcpiEvaluateObject (NULL, "\\MAIN", &ArgList, &ReturnValue);
526 if (ACPI_FAILURE (Status))
528 ACPI_EXCEPTION ((AE_INFO, Status, "While executing MAIN"));
532 if (ReturnValue.Pointer)
534 /* Obtain and validate the returned ACPI_OBJECT */
536 Object = ReturnValue.Pointer;
537 if (Object->Type == ACPI_TYPE_STRING)
539 AcpiOsPrintf ("Method [MAIN] returned: \"%s\"\n", Object->String.Pointer);
542 ACPI_FREE (ReturnValue.Pointer);