drivers/acpi/tools/examples/examples.c

   1 /******************************************************************************
   2  *
   3  * Module Name: examples - Example ACPICA initialization and execution code
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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 #include "examples.h"
 117
 118 #define _COMPONENT          ACPI_EXAMPLE
 119         ACPI_MODULE_NAME    ("examples")
 120
 121
 122 /******************************************************************************
 123  *
 124  * ACPICA Example Code
 125  *
 126  * This module contains examples of how the host OS should interface to the
 127  * ACPICA subsystem.
 128  *
 129  * 1) How to use the platform/acenv.h file and how to set configuration
 130  *      options.
 131  *
 132  * 2) main - using the debug output mechanism and the error/warning output
 133  *      macros.
 134  *
 135  * 3) Two examples of the ACPICA initialization sequence. The first is a
 136  *      initialization with no "early" ACPI table access. The second shows
 137  *      how to use ACPICA to obtain the tables very early during kernel
 138  *      initialization, even before dynamic memory is available.
 139  *
 140  * 4) How to invoke a control method, including argument setup and how to
 141  *      access the return value.
 142  *
 143  *****************************************************************************/
 144
 145
 146 /* Local Prototypes */
 147
 148 static ACPI_STATUS
 149 InitializeFullAcpica (void);
 150
 151 static ACPI_STATUS
 152 InstallHandlers (void);
 153
 154 static void
 155 NotifyHandler (
 156     ACPI_HANDLE             Device,
 157     UINT32                  Value,
 158     void                    *Context);
 159
 160 static ACPI_STATUS
 161 RegionHandler (
 162     UINT32                  Function,
 163     ACPI_PHYSICAL_ADDRESS   Address,
 164     UINT32                  BitWidth,
 165     UINT64                  *Value,
 166     void                    *HandlerContext,
 167     void                    *RegionContext);
 168
 169 static ACPI_STATUS
 170 RegionInit (
 171     ACPI_HANDLE             RegionHandle,
 172     UINT32                  Function,
 173     void                    *HandlerContext,
 174     void                    **RegionContext);
 175
 176 static void
 177 ExecuteMAIN (void);
 178
 179 static void
 180 ExecuteOSI (void);
 181
 182 ACPI_STATUS
 183 InitializeAcpiTables (
 184     void);
 185
 186 ACPI_STATUS
 187 InitializeAcpi (
 188     void);
 189
 190
 191 /******************************************************************************
 192  *
 193  * FUNCTION:    main
 194  *
 195  * PARAMETERS:  argc, argv
 196  *
 197  * RETURN:      Status
 198  *
 199  * DESCRIPTION: Main routine. Shows the use of the various output macros, as
 200  *              well as the use of the debug layer/level globals.
 201  *
 202  *****************************************************************************/
 203
 204 int ACPI_SYSTEM_XFACE
 205 main (
 206     int                     argc,
 207     char                    **argv)
 208 {
 209
 210     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 211
 212     printf (ACPI_COMMON_SIGNON ("ACPI Example Code"));
 213
 214     /* Initialize the local ACPI tables (RSDP/RSDT/XSDT/FADT/DSDT/FACS) */
 215
 216     ExInitializeAcpiTables ();
 217
 218     /* Initialize the ACPICA subsystem */
 219
 220     InitializeFullAcpica ();
 221
 222     /* Example warning and error output */
 223
 224     ACPI_INFO        ((AE_INFO, "Example ACPICA info message"));
 225     ACPI_WARNING     ((AE_INFO, "Example ACPICA warning message"));
 226     ACPI_ERROR       ((AE_INFO, "Example ACPICA error message"));
 227     ACPI_EXCEPTION   ((AE_INFO, AE_AML_OPERAND_TYPE, "Example ACPICA exception message"));
 228
 229     ExecuteOSI ();
 230     ExecuteMAIN ();
 231     return (0);
 232 }
 233
 234
 235 /******************************************************************************
 236  *
 237  * Example ACPICA initialization code. This shows a full initialization with
 238  * no early ACPI table access.
 239  *
 240  *****************************************************************************/
 241
 242 static ACPI_STATUS
 243 InitializeFullAcpica (void)
 244 {
 245     ACPI_STATUS             Status;
 246
 247
 248     /* Initialize the ACPICA subsystem */
 249
 250     Status = AcpiInitializeSubsystem ();
 251     if (ACPI_FAILURE (Status))
 252     {
 253         ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA"));
 254         return (Status);
 255     }
 256
 257     /* Initialize the ACPICA Table Manager and get all ACPI tables */
 258
 259     ACPI_INFO ((AE_INFO, "Loading ACPI tables"));
 260
 261     Status = AcpiInitializeTables (NULL, 16, FALSE);
 262     if (ACPI_FAILURE (Status))
 263     {
 264         ACPI_EXCEPTION ((AE_INFO, Status, "While initializing Table Manager"));
 265         return (Status);
 266     }
 267
 268     /* Create the ACPI namespace from ACPI tables */
 269
 270     Status = AcpiLoadTables ();
 271     if (ACPI_FAILURE (Status))
 272     {
 273         ACPI_EXCEPTION ((AE_INFO, Status, "While loading ACPI tables"));
 274         return (Status);
 275     }
 276
 277     /* Install local handlers */
 278
 279     Status = InstallHandlers ();
 280     if (ACPI_FAILURE (Status))
 281     {
 282         ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
 283         return (Status);
 284     }
 285
 286     /* Initialize the ACPI hardware */
 287
 288     Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
 289     if (ACPI_FAILURE (Status))
 290     {
 291         ACPI_EXCEPTION ((AE_INFO, Status, "While enabling ACPICA"));
 292         return (Status);
 293     }
 294
 295     /* Complete the ACPI namespace object initialization */
 296
 297     Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
 298     if (ACPI_FAILURE (Status))
 299     {
 300         ACPI_EXCEPTION ((AE_INFO, Status, "While initializing ACPICA objects"));
 301         return (Status);
 302     }
 303
 304     return (AE_OK);
 305 }
 306
 307
 308 /******************************************************************************
 309  *
 310  * Example ACPICA initialization code with early ACPI table access. This shows
 311  * an initialization that requires early access to ACPI tables (before
 312  * kernel dynamic memory is available)
 313  *
 314  *****************************************************************************/
 315
 316 /*
 317  * The purpose of this static table array is to avoid the use of kernel
 318  * dynamic memory which may not be available during early ACPI table
 319  * access.
 320  */
 321 #define ACPI_MAX_INIT_TABLES    16
 322 static ACPI_TABLE_DESC      TableArray[ACPI_MAX_INIT_TABLES];
 323
 324
 325 /*
 326  * This function would be called early in kernel initialization. After this
 327  * is called, all ACPI tables are available to the host.
 328  */
 329 ACPI_STATUS
 330 InitializeAcpiTables (
 331     void)
 332 {
 333     ACPI_STATUS             Status;
 334
 335
 336     /* Initialize the ACPICA Table Manager and get all ACPI tables */
 337
 338     Status = AcpiInitializeTables (TableArray, ACPI_MAX_INIT_TABLES, TRUE);
 339     return (Status);
 340 }
 341
 342
 343 /*
 344  * This function would be called after the kernel is initialized and
 345  * dynamic/virtual memory is available. It completes the initialization of
 346  * the ACPICA subsystem.
 347  */
 348 ACPI_STATUS
 349 InitializeAcpi (
 350     void)
 351 {
 352     ACPI_STATUS             Status;
 353
 354
 355     /* Initialize the ACPICA subsystem */
 356
 357     Status = AcpiInitializeSubsystem ();
 358     if (ACPI_FAILURE (Status))
 359     {
 360         return (Status);
 361     }
 362
 363     /* Copy the root table list to dynamic memory */
 364
 365     Status = AcpiReallocateRootTable ();
 366     if (ACPI_FAILURE (Status))
 367     {
 368         return (Status);
 369     }
 370
 371     /* Create the ACPI namespace from ACPI tables */
 372
 373     Status = AcpiLoadTables ();
 374     if (ACPI_FAILURE (Status))
 375     {
 376         return (Status);
 377     }
 378
 379     /* Install local handlers */
 380
 381     Status = InstallHandlers ();
 382     if (ACPI_FAILURE (Status))
 383     {
 384         ACPI_EXCEPTION ((AE_INFO, Status, "While installing handlers"));
 385         return (Status);
 386     }
 387
 388     /* Initialize the ACPI hardware */
 389
 390     Status = AcpiEnableSubsystem (ACPI_FULL_INITIALIZATION);
 391     if (ACPI_FAILURE (Status))
 392     {
 393         return (Status);
 394     }
 395
 396     /* Complete the ACPI namespace object initialization */
 397
 398     Status = AcpiInitializeObjects (ACPI_FULL_INITIALIZATION);
 399     if (ACPI_FAILURE (Status))
 400     {
 401         return (Status);
 402     }
 403
 404     return (AE_OK);
 405 }
 406
 407
 408 /******************************************************************************
 409  *
 410  * Example ACPICA handler and handler installation
 411  *
 412  *****************************************************************************/
 413
 414 static void
 415 NotifyHandler (
 416     ACPI_HANDLE                 Device,
 417     UINT32                      Value,
 418     void                        *Context)
 419 {
 420
 421     ACPI_INFO ((AE_INFO, "Received a notify 0x%X", Value));
 422 }
 423
 424
 425 static ACPI_STATUS
 426 RegionInit (
 427     ACPI_HANDLE                 RegionHandle,
 428     UINT32                      Function,
 429     void                        *HandlerContext,
 430     void                        **RegionContext)
 431 {
 432
 433     if (Function == ACPI_REGION_DEACTIVATE)
 434     {
 435         *RegionContext = NULL;
 436     }
 437     else
 438     {
 439         *RegionContext = RegionHandle;
 440     }
 441
 442     return (AE_OK);
 443 }
 444
 445
 446 static ACPI_STATUS
 447 RegionHandler (
 448     UINT32                      Function,
 449     ACPI_PHYSICAL_ADDRESS       Address,
 450     UINT32                      BitWidth,
 451     UINT64                      *Value,
 452     void                        *HandlerContext,
 453     void                        *RegionContext)
 454 {
 455
 456     ACPI_INFO ((AE_INFO, "Received a region access"));
 457
 458     return (AE_OK);
 459 }
 460
 461
 462 static ACPI_STATUS
 463 InstallHandlers (void)
 464 {
 465     ACPI_STATUS             Status;
 466
 467
 468     /* Install global notify handler */
 469
 470     Status = AcpiInstallNotifyHandler (ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
 471                                         NotifyHandler, NULL);
 472     if (ACPI_FAILURE (Status))
 473     {
 474         ACPI_EXCEPTION ((AE_INFO, Status, "While installing Notify handler"));
 475         return (Status);
 476     }
 477
 478     Status = AcpiInstallAddressSpaceHandler (ACPI_ROOT_OBJECT, ACPI_ADR_SPACE_SYSTEM_MEMORY,
 479         RegionHandler, RegionInit, NULL);
 480     if (ACPI_FAILURE (Status))
 481     {
 482         ACPI_EXCEPTION ((AE_INFO, Status, "While installing an OpRegion handler"));
 483         return (Status);
 484     }
 485
 486     return (AE_OK);
 487 }
 488
 489
 490 /******************************************************************************
 491  *
 492  * Examples of control method execution.
 493  *
 494  * _OSI is a predefined method that is implemented internally within ACPICA.
 495  *
 496  * Shows the following elements:
 497  *
 498  * 1) How to setup a control method argument and argument list
 499  * 2) How to setup the return value object
 500  * 3) How to invoke AcpiEvaluateObject
 501  * 4) How to check the returned ACPI_STATUS
 502  * 5) How to analyze the return value
 503  *
 504  *****************************************************************************/
 505
 506 static void
 507 ExecuteOSI (void)
 508 {
 509     ACPI_STATUS             Status;
 510     ACPI_OBJECT_LIST        ArgList;
 511     ACPI_OBJECT             Arg[1];
 512     ACPI_BUFFER             ReturnValue;
 513     ACPI_OBJECT             *Object;
 514
 515
 516     ACPI_INFO ((AE_INFO, "Executing _OSI reserved method"));
 517
 518     /* Setup input argument */
 519
 520     ArgList.Count = 1;
 521     ArgList.Pointer = Arg;
 522
 523     Arg[0].Type = ACPI_TYPE_STRING;
 524     Arg[0].String.Pointer = "Windows 2001";
 525     Arg[0].String.Length = strlen (Arg[0].String.Pointer);
 526
 527     /* Ask ACPICA to allocate space for the return object */
 528
 529     ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
 530
 531     Status = AcpiEvaluateObject (NULL, "\\_OSI", &ArgList, &ReturnValue);
 532     if (ACPI_FAILURE (Status))
 533     {
 534         ACPI_EXCEPTION ((AE_INFO, Status, "While executing _OSI"));
 535         return;
 536     }
 537
 538     /* Ensure that the return object is large enough */
 539
 540     if (ReturnValue.Length < sizeof (ACPI_OBJECT))
 541     {
 542         AcpiOsPrintf ("Return value from _OSI method too small, %.8X\n",
 543             ReturnValue.Length);
 544         goto ErrorExit;
 545     }
 546
 547     /* Expect an integer return value from execution of _OSI */
 548
 549     Object = ReturnValue.Pointer;
 550     if (Object->Type != ACPI_TYPE_INTEGER)
 551     {
 552         AcpiOsPrintf ("Invalid return type from _OSI, %.2X\n", Object->Type);
 553     }
 554
 555     ACPI_INFO ((AE_INFO, "_OSI returned 0x%8.8X", (UINT32) Object->Integer.Value));
 556
 557
 558 ErrorExit:
 559
 560     /* Free a buffer created via ACPI_ALLOCATE_BUFFER */
 561
 562     AcpiOsFree (ReturnValue.Pointer);
 563 }
 564
 565
 566 /******************************************************************************
 567  *
 568  * Execute an actual control method in the DSDT (MAIN)
 569  *
 570  *****************************************************************************/
 571
 572 static void
 573 ExecuteMAIN (void)
 574 {
 575     ACPI_STATUS             Status;
 576     ACPI_OBJECT_LIST        ArgList;
 577     ACPI_OBJECT             Arg[1];
 578     ACPI_BUFFER             ReturnValue;
 579     ACPI_OBJECT             *Object;
 580
 581
 582     ACPI_INFO ((AE_INFO, "Executing MAIN method"));
 583
 584     /* Setup input argument */
 585
 586     ArgList.Count = 1;
 587     ArgList.Pointer = Arg;
 588
 589     Arg[0].Type = ACPI_TYPE_STRING;
 590     Arg[0].String.Pointer = "Method [MAIN] is executing";
 591     Arg[0].String.Length = strlen (Arg[0].String.Pointer);
 592
 593     /* Ask ACPICA to allocate space for the return object */
 594
 595     ReturnValue.Length = ACPI_ALLOCATE_BUFFER;
 596
 597     Status = AcpiEvaluateObject (NULL, "\\MAIN", &ArgList, &ReturnValue);
 598     if (ACPI_FAILURE (Status))
 599     {
 600         ACPI_EXCEPTION ((AE_INFO, Status, "While executing MAIN"));
 601         return;
 602     }
 603
 604     if (ReturnValue.Pointer)
 605     {
 606         /* Obtain and validate the returned ACPI_OBJECT */
 607
 608         Object = ReturnValue.Pointer;
 609         if (Object->Type == ACPI_TYPE_STRING)
 610         {
 611             AcpiOsPrintf ("Method [MAIN] returned: \"%s\"\n", Object->String.Pointer);
 612         }
 613
 614         ACPI_FREE (ReturnValue.Pointer);
 615     }
 616 }