1 /******************************************************************************
3 * Module Name: examples - Example ACPICA initialization and execution code
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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.
44 #define __EXAMPLES_C__
47 #define _COMPONENT ACPI_EXAMPLE
48 ACPI_MODULE_NAME ("examples")
51 /******************************************************************************
55 * This module contains examples of how the host OS should interface to the
58 * 1) How to use the platform/acenv.h file and how to set configuration
61 * 2) main - using the debug output mechanism and the error/warning output
64 * 3) Two examples of the ACPICA initialization sequence. The first is a
65 * initialization with no "early" ACPI table access. The second shows
66 * how to use ACPICA to obtain the tables very early during kernel
67 * initialization, even before dynamic memory is available.
69 * 4) How to invoke a control method, including argument setup and how to
70 * access the return value.
72 *****************************************************************************/
75 /* Local Prototypes */
78 InitializeFullAcpica (void);
81 InstallHandlers (void);
96 InitializeAcpiTables (
104 /******************************************************************************
108 * PARAMETERS: argc, argv
112 * DESCRIPTION: Main routine. Shows the use of the various output macros, as
113 * well as the use of the debug layer/level globals.
115 *****************************************************************************/
117 int ACPI_SYSTEM_XFACE
123 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
125 printf (ACPI_COMMON_SIGNON ("ACPI Example Code"));
127 /* Initialize the local ACPI tables (RSDP/RSDT/XSDT/FADT/DSDT/FACS) */
129 ExInitializeAcpiTables ();
131 /* Initialize the ACPICA subsystem */
133 InitializeFullAcpica ();
135 /* Example warning and error output */
137 ACPI_INFO ((AE_INFO, "Example ACPICA info message"));
138 ACPI_WARNING ((AE_INFO, "Example ACPICA warning message"));
139 ACPI_ERROR ((AE_INFO, "Example ACPICA error message"));
140 ACPI_EXCEPTION ((AE_INFO, AE_AML_OPERAND_TYPE, "Example ACPICA exception message"));
148 /******************************************************************************
150 * Example ACPICA initialization code. This shows a full initialization with
151 * no early ACPI table access.
153 *****************************************************************************/
156 InitializeFullAcpica (void)
161 /* Initialize the ACPICA subsystem */
163 Status = AcpiInitializeSubsystem ();
164 if (ACPI_FAILURE (Status))
166 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA"));
170 /* Initialize the ACPICA Table Manager and get all ACPI tables */
172 ACPI_INFO ((AE_INFO, "Loading ACPI tables"));
174 Status = AcpiInitializeTables (NULL, 16, FALSE);
175 if (ACPI_FAILURE (Status))
177 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing Table Manager"));
181 /* Create the ACPI namespace from ACPI tables */
183 Status = AcpiLoadTables ();
184 if (ACPI_FAILURE (Status))
186 ACPI_EXCEPTION ((AE_INFO, Status, "While loading ACPI tables"));
190 /* Install local handlers */
192 Status = InstallHandlers ();
193 if (ACPI_FAILURE (Status))
195 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
199 /* Initialize the ACPI hardware */
201 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
202 if (ACPI_FAILURE (Status))
204 ACPI_EXCEPTION ((AE_INFO, Status, "While enabling ACPICA"));
208 /* Complete the ACPI namespace object initialization */
210 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
211 if (ACPI_FAILURE (Status))
213 ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA objects"));
221 /******************************************************************************
223 * Example ACPICA initialization code with early ACPI table access. This shows
224 * an initialization that requires early access to ACPI tables (before
225 * kernel dynamic memory is available)
227 *****************************************************************************/
230 * The purpose of this static table array is to avoid the use of kernel
231 * dynamic memory which may not be available during early ACPI table
234 #define ACPI_MAX_INIT_TABLES 16
235 static ACPI_TABLE_DESC TableArray[ACPI_MAX_INIT_TABLES];
239 * This function would be called early in kernel initialization. After this
240 * is called, all ACPI tables are available to the host.
243 InitializeAcpiTables (
249 /* Initialize the ACPICA Table Manager and get all ACPI tables */
251 Status = AcpiInitializeTables (TableArray, ACPI_MAX_INIT_TABLES, TRUE);
257 * This function would be called after the kernel is initialized and
258 * dynamic/virtual memory is available. It completes the initialization of
259 * the ACPICA subsystem.
268 /* Initialize the ACPICA subsystem */
270 Status = AcpiInitializeSubsystem ();
271 if (ACPI_FAILURE (Status))
276 /* Copy the root table list to dynamic memory */
278 Status = AcpiReallocateRootTable ();
279 if (ACPI_FAILURE (Status))
284 /* Create the ACPI namespace from ACPI tables */
286 Status = AcpiLoadTables ();
287 if (ACPI_FAILURE (Status))
292 /* Install local handlers */
294 Status = InstallHandlers ();
295 if (ACPI_FAILURE (Status))
297 ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
301 /* Initialize the ACPI hardware */
303 Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
304 if (ACPI_FAILURE (Status))
309 /* Complete the ACPI namespace object initialization */
311 Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
312 if (ACPI_FAILURE (Status))
321 /******************************************************************************
323 * Example ACPICA handler and handler installation
325 *****************************************************************************/
334 ACPI_INFO ((AE_INFO, "Received a notify 0x%X", Value));
339 InstallHandlers (void)
344 /* Install global notify handler */
346 Status = AcpiInstallNotifyHandler (ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
347 NotifyHandler, NULL);
348 if (ACPI_FAILURE (Status))
350 ACPI_EXCEPTION ((AE_INFO, Status, "While installing Notify handler"));
358 /******************************************************************************
360 * Examples of control method execution.
362 * _OSI is a predefined method that is implemented internally within ACPICA.
364 * Shows the following elements:
366 * 1) How to setup a control method argument and argument list
367 * 2) How to setup the return value object
368 * 3) How to invoke AcpiEvaluateObject
369 * 4) How to check the returned ACPI_STATUS
370 * 5) How to analyze the return value
372 *****************************************************************************/
378 ACPI_OBJECT_LIST ArgList;
380 ACPI_BUFFER ReturnValue;
384 ACPI_INFO ((AE_INFO, "Executing _OSI reserved method"));
386 /* Setup input argument */
389 ArgList.Pointer = Arg;
391 Arg[0].Type = ACPI_TYPE_STRING;
392 Arg[0].String.Pointer = "Windows 2001";
393 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
395 /* Ask ACPICA to allocate space for the return object */
397 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
399 Status = AcpiEvaluateObject (NULL, "\\_OSI", &ArgList, &ReturnValue);
400 if (ACPI_FAILURE (Status))
402 ACPI_EXCEPTION ((AE_INFO, Status, "While executing _OSI"));
406 /* Ensure that the return object is large enough */
408 if (ReturnValue.Length < sizeof (ACPI_OBJECT))
410 AcpiOsPrintf ("Return value from _OSI method too small, %.8X\n",
415 /* Expect an integer return value from execution of _OSI */
417 Object = ReturnValue.Pointer;
418 if (Object->Type != ACPI_TYPE_INTEGER)
420 AcpiOsPrintf ("Invalid return type from _OSI, %.2X\n", Object->Type);
423 ACPI_INFO ((AE_INFO, "_OSI returned 0x%8.8X", (UINT32) Object->Integer.Value));
428 /* Free a buffer created via ACPI_ALLOCATE_BUFFER */
430 AcpiOsFree (ReturnValue.Pointer);
434 /******************************************************************************
436 * Execute an actual control method in the DSDT (MAIN)
438 *****************************************************************************/
444 ACPI_OBJECT_LIST ArgList;
446 ACPI_BUFFER ReturnValue;
450 ACPI_INFO ((AE_INFO, "Executing MAIN method"));
452 /* Setup input argument */
455 ArgList.Pointer = Arg;
457 Arg[0].Type = ACPI_TYPE_STRING;
458 Arg[0].String.Pointer = "Method [MAIN] is executing";
459 Arg[0].String.Length = strlen (Arg[0].String.Pointer);
461 /* Ask ACPICA to allocate space for the return object */
463 ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
465 Status = AcpiEvaluateObject (NULL, "\\MAIN", &ArgList, &ReturnValue);
466 if (ACPI_FAILURE (Status))
468 ACPI_EXCEPTION ((AE_INFO, Status, "While executing MAIN"));
472 if (ReturnValue.Pointer)
474 /* Obtain and validate the returned ACPI_OBJECT */
476 Object = ReturnValue.Pointer;
477 if (Object->Type == ACPI_TYPE_STRING)
479 AcpiOsPrintf ("Method [MAIN] returned: \"%s\"\n", Object->String.Pointer);
482 ACPI_FREE (ReturnValue.Pointer);