actypes.h revision 114237
1177633Sdfr/****************************************************************************** 2177633Sdfr * 3177633Sdfr * Name: actypes.h - Common data types for the entire ACPI subsystem 4177633Sdfr * $Revision: 253 $ 5177633Sdfr * 6177685Sdfr *****************************************************************************/ 7177633Sdfr 8177633Sdfr/****************************************************************************** 9177633Sdfr * 10177633Sdfr * 1. Copyright Notice 11177633Sdfr * 12177633Sdfr * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 13177633Sdfr * All rights reserved. 14177633Sdfr * 15177633Sdfr * 2. License 16177633Sdfr * 17177633Sdfr * 2.1. This is your license from Intel Corp. under its intellectual property 18177633Sdfr * rights. You may have additional license terms from the party that provided 19177633Sdfr * you this software, covering your right to use that party's intellectual 20177633Sdfr * property rights. 21177633Sdfr * 22177633Sdfr * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23177633Sdfr * copy of the source code appearing in this file ("Covered Code") an 24177633Sdfr * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25177633Sdfr * base code distributed originally by Intel ("Original Intel Code") to copy, 26177633Sdfr * make derivatives, distribute, use and display any portion of the Covered 27177633Sdfr * Code in any form, with the right to sublicense such rights; and 28177633Sdfr * 29177633Sdfr * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30177633Sdfr * license (with the right to sublicense), under only those claims of Intel 31177633Sdfr * patents that are infringed by the Original Intel Code, to make, use, sell, 32177633Sdfr * offer to sell, and import the Covered Code and derivative works thereof 33177633Sdfr * solely to the minimum extent necessary to exercise the above copyright 34177633Sdfr * license, and in no event shall the patent license extend to any additions 35177633Sdfr * to or modifications of the Original Intel Code. No other license or right 36177633Sdfr * is granted directly or by implication, estoppel or otherwise; 37177633Sdfr * 38177633Sdfr * The above copyright and patent license is granted only if the following 39177633Sdfr * conditions are met: 40177633Sdfr * 41177633Sdfr * 3. Conditions 42177633Sdfr * 43177633Sdfr * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44177633Sdfr * Redistribution of source code of any substantial portion of the Covered 45177633Sdfr * Code or modification with rights to further distribute source must include 46177633Sdfr * the above Copyright Notice, the above License, this list of Conditions, 47177633Sdfr * and the following Disclaimer and Export Compliance provision. In addition, 48177633Sdfr * Licensee must cause all Covered Code to which Licensee contributes to 49177633Sdfr * contain a file documenting the changes Licensee made to create that Covered 50177633Sdfr * Code and the date of any change. Licensee must include in that file the 51177633Sdfr * documentation of any changes made by any predecessor Licensee. Licensee 52177633Sdfr * must include a prominent statement that the modification is derived, 53177633Sdfr * directly or indirectly, from Original Intel Code. 54177633Sdfr * 55177633Sdfr * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56177633Sdfr * Redistribution of source code of any substantial portion of the Covered 57177633Sdfr * Code or modification without rights to further distribute source must 58177633Sdfr * include the following Disclaimer and Export Compliance provision in the 59177633Sdfr * documentation and/or other materials provided with distribution. In 60177633Sdfr * addition, Licensee may not authorize further sublicense of source of any 61177633Sdfr * portion of the Covered Code, and must include terms to the effect that the 62177633Sdfr * license from Licensee to its licensee is limited to the intellectual 63177633Sdfr * property embodied in the software Licensee provides to its licensee, and 64177633Sdfr * not to intellectual property embodied in modifications its licensee may 65177633Sdfr * make. 66177633Sdfr * 67177633Sdfr * 3.3. Redistribution of Executable. Redistribution in executable form of any 68177633Sdfr * substantial portion of the Covered Code or modification must reproduce the 69177633Sdfr * above Copyright Notice, and the following Disclaimer and Export Compliance 70177633Sdfr * provision in the documentation and/or other materials provided with the 71177633Sdfr * distribution. 72177633Sdfr * 73177633Sdfr * 3.4. Intel retains all right, title, and interest in and to the Original 74177633Sdfr * Intel Code. 75177633Sdfr * 76177633Sdfr * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77177633Sdfr * Intel shall be used in advertising or otherwise to promote the sale, use or 78177633Sdfr * other dealings in products derived from or relating to the Covered Code 79177633Sdfr * without prior written authorization from Intel. 80177633Sdfr * 81177633Sdfr * 4. Disclaimer and Export Compliance 82177633Sdfr * 83177633Sdfr * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84177633Sdfr * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85177633Sdfr * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86177633Sdfr * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87177633Sdfr * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88177633Sdfr * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89177633Sdfr * PARTICULAR PURPOSE. 90177633Sdfr * 91177633Sdfr * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92177633Sdfr * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93177633Sdfr * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94177633Sdfr * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95177633Sdfr * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96177633Sdfr * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97177633Sdfr * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98177633Sdfr * LIMITED REMEDY. 99177633Sdfr * 100177633Sdfr * 4.3. Licensee shall not export, either directly or indirectly, any of this 101177633Sdfr * software or system incorporating such software without first obtaining any 102177633Sdfr * required license or other approval from the U. S. Department of Commerce or 103177633Sdfr * any other agency or department of the United States Government. In the 104177633Sdfr * event Licensee exports any such software from the United States or 105177633Sdfr * re-exports any such software from a foreign destination, Licensee shall 106177633Sdfr * ensure that the distribution and export/re-export of the software is in 107177633Sdfr * compliance with all laws, regulations, orders, or other restrictions of the 108177633Sdfr * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109177633Sdfr * any of its subsidiaries will export/re-export any technical data, process, 110177633Sdfr * software, or service, directly or indirectly, to any country for which the 111177633Sdfr * United States government or any agency thereof requires an export license, 112177633Sdfr * other governmental approval, or letter of assurance, without first obtaining 113177633Sdfr * such license, approval or letter. 114177633Sdfr * 115177633Sdfr *****************************************************************************/ 116177633Sdfr 117177633Sdfr#ifndef __ACTYPES_H__ 118177633Sdfr#define __ACTYPES_H__ 119177633Sdfr 120177633Sdfr/*! [Begin] no source code translation (keep the typedefs) */ 121177633Sdfr 122177633Sdfr 123177633Sdfr 124177633Sdfr/* 125177633Sdfr * Data type ranges 126177633Sdfr */ 127177633Sdfr#define ACPI_UINT8_MAX (UINT8) 0xFF 128177633Sdfr#define ACPI_UINT16_MAX (UINT16) 0xFFFF 129177633Sdfr#define ACPI_UINT32_MAX (UINT32) 0xFFFFFFFF 130177633Sdfr#define ACPI_UINT64_MAX (UINT64) 0xFFFFFFFFFFFFFFFF 131177633Sdfr#define ACPI_ASCII_MAX 0x7F 132177633Sdfr 133177633Sdfr 134177633Sdfr#ifdef DEFINE_ALTERNATE_TYPES 135177633Sdfr/* 136177633Sdfr * Types used only in translated source, defined here to enable 137177633Sdfr * cross-platform compilation only. 138177633Sdfr */ 139177633Sdfrtypedef int s32; 140177633Sdfrtypedef unsigned char u8; 141177633Sdfrtypedef unsigned short u16; 142177633Sdfrtypedef unsigned int u32; 143177633Sdfrtypedef COMPILER_DEPENDENT_UINT64 u64; 144177633Sdfr 145177633Sdfr#endif 146177633Sdfr 147177633Sdfr 148177633Sdfr/* 149177633Sdfr * Data types - Fixed across all compilation models (16/32/64) 150177633Sdfr * 151177633Sdfr * BOOLEAN Logical Boolean. 152177633Sdfr * INT8 8-bit (1 byte) signed value 153177633Sdfr * UINT8 8-bit (1 byte) unsigned value 154177633Sdfr * INT16 16-bit (2 byte) signed value 155177633Sdfr * UINT16 16-bit (2 byte) unsigned value 156177633Sdfr * INT32 32-bit (4 byte) signed value 157177633Sdfr * UINT32 32-bit (4 byte) unsigned value 158177633Sdfr * INT64 64-bit (8 byte) signed value 159177633Sdfr * UINT64 64-bit (8 byte) unsigned value 160177633Sdfr * ACPI_NATIVE_INT 32-bit on IA-32, 64-bit on IA-64 signed value 161177633Sdfr * ACPI_NATIVE_UINT 32-bit on IA-32, 64-bit on IA-64 unsigned value 162177633Sdfr */ 163177633Sdfr 164177633Sdfr#ifndef ACPI_MACHINE_WIDTH 165177633Sdfr#error ACPI_MACHINE_WIDTH not defined 166177633Sdfr#endif 167177633Sdfr 168177633Sdfr#if ACPI_MACHINE_WIDTH == 64 169177633Sdfr 170177633Sdfr/*! [Begin] no source code translation (keep the typedefs) */ 171177633Sdfr 172177633Sdfr/* 173177633Sdfr * 64-bit type definitions 174177633Sdfr */ 175177633Sdfrtypedef unsigned char UINT8; 176177633Sdfrtypedef unsigned char BOOLEAN; 177177633Sdfrtypedef unsigned short UINT16; 178177633Sdfrtypedef int INT32; 179177633Sdfrtypedef unsigned int UINT32; 180177633Sdfrtypedef COMPILER_DEPENDENT_INT64 INT64; 181177633Sdfrtypedef COMPILER_DEPENDENT_UINT64 UINT64; 182177633Sdfr 183177633Sdfr/*! [End] no source code translation !*/ 184177633Sdfr 185177633Sdfrtypedef INT64 ACPI_NATIVE_INT; 186177633Sdfrtypedef UINT64 ACPI_NATIVE_UINT; 187177633Sdfr 188177633Sdfrtypedef UINT64 ACPI_TABLE_PTR; 189177633Sdfrtypedef UINT64 ACPI_IO_ADDRESS; 190177633Sdfrtypedef UINT64 ACPI_PHYSICAL_ADDRESS; 191177633Sdfrtypedef UINT64 ACPI_SIZE; 192177633Sdfr 193177633Sdfr#define ALIGNED_ADDRESS_BOUNDARY 0x00000008 /* No hardware alignment support in IA64 */ 194177633Sdfr#define ACPI_USE_NATIVE_DIVIDE /* Native 64-bit integer support */ 195177633Sdfr#define ACPI_MAX_PTR ACPI_UINT64_MAX 196177633Sdfr#define ACPI_SIZE_MAX ACPI_UINT64_MAX 197177633Sdfr 198177633Sdfr 199177633Sdfr#elif ACPI_MACHINE_WIDTH == 16 200177633Sdfr 201177633Sdfr/*! [Begin] no source code translation (keep the typedefs) */ 202177633Sdfr 203177633Sdfr/* 204177633Sdfr * 16-bit type definitions 205177633Sdfr */ 206177633Sdfrtypedef unsigned char UINT8; 207177633Sdfrtypedef unsigned char BOOLEAN; 208177633Sdfrtypedef unsigned int UINT16; 209177633Sdfrtypedef long INT32; 210177633Sdfrtypedef int INT16; 211177633Sdfrtypedef unsigned long UINT32; 212177633Sdfr 213177633Sdfrtypedef struct 214177633Sdfr{ 215177633Sdfr UINT32 Lo; 216177633Sdfr UINT32 Hi; 217177633Sdfr 218177633Sdfr} UINT64; 219177633Sdfr 220177633Sdfr/*! [End] no source code translation !*/ 221177633Sdfr 222177633Sdfrtypedef UINT16 ACPI_NATIVE_UINT; 223177633Sdfrtypedef INT16 ACPI_NATIVE_INT; 224177633Sdfr 225177633Sdfrtypedef UINT32 ACPI_TABLE_PTR; 226177633Sdfrtypedef UINT32 ACPI_IO_ADDRESS; 227177633Sdfrtypedef char *ACPI_PHYSICAL_ADDRESS; 228177633Sdfrtypedef UINT16 ACPI_SIZE; 229177633Sdfr 230177633Sdfr#define ALIGNED_ADDRESS_BOUNDARY 0x00000002 231177633Sdfr#define _HW_ALIGNMENT_SUPPORT 232177633Sdfr#define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */ 233177633Sdfr#define ACPI_MAX_PTR ACPI_UINT16_MAX 234177633Sdfr#define ACPI_SIZE_MAX ACPI_UINT16_MAX 235177633Sdfr 236177633Sdfr/* 237177633Sdfr * (16-bit only) internal integers must be 32-bits, so 238177633Sdfr * 64-bit integers cannot be supported 239177633Sdfr */ 240177633Sdfr#define ACPI_NO_INTEGER64_SUPPORT 241177633Sdfr 242177633Sdfr 243177633Sdfr#elif ACPI_MACHINE_WIDTH == 32 244177633Sdfr 245177633Sdfr/*! [Begin] no source code translation (keep the typedefs) */ 246177633Sdfr 247177633Sdfr/* 248177633Sdfr * 32-bit type definitions (default) 249177633Sdfr */ 250177633Sdfrtypedef unsigned char UINT8; 251177633Sdfrtypedef unsigned char BOOLEAN; 252177633Sdfrtypedef unsigned short UINT16; 253177633Sdfrtypedef int INT32; 254177633Sdfrtypedef unsigned int UINT32; 255177633Sdfrtypedef COMPILER_DEPENDENT_INT64 INT64; 256177633Sdfrtypedef COMPILER_DEPENDENT_UINT64 UINT64; 257177633Sdfr 258177633Sdfr/*! [End] no source code translation !*/ 259177633Sdfr 260177633Sdfrtypedef INT32 ACPI_NATIVE_INT; 261177633Sdfrtypedef UINT32 ACPI_NATIVE_UINT; 262177633Sdfr 263177633Sdfrtypedef UINT64 ACPI_TABLE_PTR; 264177633Sdfrtypedef UINT32 ACPI_IO_ADDRESS; 265177633Sdfrtypedef UINT64 ACPI_PHYSICAL_ADDRESS; 266177633Sdfrtypedef UINT32 ACPI_SIZE; 267177633Sdfr 268177633Sdfr#define ALIGNED_ADDRESS_BOUNDARY 0x00000004 269177633Sdfr#define _HW_ALIGNMENT_SUPPORT 270177633Sdfr#define ACPI_MAX_PTR ACPI_UINT32_MAX 271177633Sdfr#define ACPI_SIZE_MAX ACPI_UINT32_MAX 272177633Sdfr 273177633Sdfr#else 274177633Sdfr#error unknown ACPI_MACHINE_WIDTH 275177633Sdfr#endif 276177633Sdfr 277177633Sdfr 278177633Sdfr/* 279177633Sdfr * Miscellaneous common types 280177633Sdfr */ 281177633Sdfrtypedef UINT32 UINT32_BIT; 282177633Sdfrtypedef ACPI_NATIVE_UINT ACPI_PTRDIFF; 283177633Sdfr 284177633Sdfr/* 285177633Sdfr * Pointer overlays to avoid lots of typecasting for 286177633Sdfr * code that accepts both physical and logical pointers. 287177633Sdfr */ 288177633Sdfrtypedef union acpi_pointers 289177633Sdfr{ 290177633Sdfr ACPI_PHYSICAL_ADDRESS Physical; 291177633Sdfr void *Logical; 292177633Sdfr ACPI_TABLE_PTR Value; 293177633Sdfr 294177633Sdfr} ACPI_POINTERS; 295177633Sdfr 296177633Sdfrtypedef struct acpi_pointer 297177633Sdfr{ 298177633Sdfr UINT32 PointerType; 299177633Sdfr union acpi_pointers Pointer; 300177633Sdfr 301177633Sdfr} ACPI_POINTER; 302177633Sdfr 303177633Sdfr/* PointerTypes for above */ 304177633Sdfr 305177633Sdfr#define ACPI_PHYSICAL_POINTER 0x01 306177633Sdfr#define ACPI_LOGICAL_POINTER 0x02 307177633Sdfr 308177633Sdfr/* Processor mode */ 309177633Sdfr 310177633Sdfr#define ACPI_PHYSICAL_ADDRESSING 0x04 311177633Sdfr#define ACPI_LOGICAL_ADDRESSING 0x08 312177633Sdfr#define ACPI_MEMORY_MODE 0x0C 313177633Sdfr 314177633Sdfr#define ACPI_PHYSMODE_PHYSPTR ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER 315177633Sdfr#define ACPI_LOGMODE_PHYSPTR ACPI_LOGICAL_ADDRESSING | ACPI_PHYSICAL_POINTER 316177633Sdfr#define ACPI_LOGMODE_LOGPTR ACPI_LOGICAL_ADDRESSING | ACPI_LOGICAL_POINTER 317177633Sdfr 318177633Sdfr 319177633Sdfr/* 320177633Sdfr * Useful defines 321177633Sdfr */ 322177633Sdfr#ifdef FALSE 323177633Sdfr#undef FALSE 324177633Sdfr#endif 325177633Sdfr#define FALSE (1 == 0) 326177633Sdfr 327177633Sdfr#ifdef TRUE 328177633Sdfr#undef TRUE 329177633Sdfr#endif 330177633Sdfr#define TRUE (1 == 1) 331177633Sdfr 332177633Sdfr#ifndef NULL 333177633Sdfr#define NULL (void *) 0 334177633Sdfr#endif 335177633Sdfr 336177633Sdfr 337177633Sdfr/* 338177633Sdfr * Local datatypes 339177633Sdfr */ 340177633Sdfrtypedef UINT32 ACPI_STATUS; /* All ACPI Exceptions */ 341177633Sdfrtypedef UINT32 ACPI_NAME; /* 4-byte ACPI name */ 342177633Sdfrtypedef char * ACPI_STRING; /* Null terminated ASCII string */ 343177633Sdfrtypedef void * ACPI_HANDLE; /* Actually a ptr to an Node */ 344177633Sdfr 345177633Sdfrtypedef struct uint64_struct 346177633Sdfr{ 347177633Sdfr UINT32 Lo; 348177633Sdfr UINT32 Hi; 349177633Sdfr 350177633Sdfr} UINT64_STRUCT; 351177633Sdfr 352177633Sdfrtypedef union uint64_overlay 353177633Sdfr{ 354177633Sdfr UINT64 Full; 355177633Sdfr UINT64_STRUCT Part; 356177633Sdfr 357177633Sdfr} UINT64_OVERLAY; 358177633Sdfr 359177633Sdfrtypedef struct uint32_struct 360177633Sdfr{ 361177633Sdfr UINT32 Lo; 362177633Sdfr UINT32 Hi; 363177633Sdfr 364177633Sdfr} UINT32_STRUCT; 365177633Sdfr 366177633Sdfr 367177633Sdfr/* 368177633Sdfr * Acpi integer width. In ACPI version 1, integers are 369177633Sdfr * 32 bits. In ACPI version 2, integers are 64 bits. 370177633Sdfr * Note that this pertains to the ACPI integer type only, not 371177633Sdfr * other integers used in the implementation of the ACPI CA 372177633Sdfr * subsystem. 373177633Sdfr */ 374177633Sdfr#ifdef ACPI_NO_INTEGER64_SUPPORT 375177633Sdfr 376177633Sdfr/* 32-bit integers only, no 64-bit support */ 377177633Sdfr 378177633Sdfrtypedef UINT32 ACPI_INTEGER; 379177633Sdfr#define ACPI_INTEGER_MAX ACPI_UINT32_MAX 380177633Sdfr#define ACPI_INTEGER_BIT_SIZE 32 381177633Sdfr#define ACPI_MAX_BCD_VALUE 99999999 382177633Sdfr#define ACPI_MAX_BCD_DIGITS 8 383177633Sdfr#define ACPI_MAX_DECIMAL_DIGITS 10 384177633Sdfr 385177633Sdfr#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */ 386177633Sdfr 387177633Sdfr 388177633Sdfr#else 389177633Sdfr 390177633Sdfr/* 64-bit integers */ 391177633Sdfr 392177633Sdfrtypedef UINT64 ACPI_INTEGER; 393177633Sdfr#define ACPI_INTEGER_MAX ACPI_UINT64_MAX 394177633Sdfr#define ACPI_INTEGER_BIT_SIZE 64 395177633Sdfr#define ACPI_MAX_BCD_VALUE 9999999999999999 396177633Sdfr#define ACPI_MAX_BCD_DIGITS 16 397177633Sdfr#define ACPI_MAX_DECIMAL_DIGITS 19 398177633Sdfr 399177633Sdfr#if ACPI_MACHINE_WIDTH == 64 400177633Sdfr#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */ 401177633Sdfr#endif 402177633Sdfr#endif 403177633Sdfr 404177633Sdfr 405177633Sdfr/* 406177633Sdfr * Constants with special meanings 407177633Sdfr */ 408177633Sdfr#define ACPI_ROOT_OBJECT (ACPI_HANDLE) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR) 409177633Sdfr 410177633Sdfr 411177633Sdfr/* 412177633Sdfr * Initialization sequence 413177633Sdfr */ 414177633Sdfr#define ACPI_FULL_INITIALIZATION 0x00 415177633Sdfr#define ACPI_NO_ADDRESS_SPACE_INIT 0x01 416177633Sdfr#define ACPI_NO_HARDWARE_INIT 0x02 417177633Sdfr#define ACPI_NO_EVENT_INIT 0x04 418177633Sdfr#define ACPI_NO_HANDLER_INIT 0x08 419177633Sdfr#define ACPI_NO_ACPI_ENABLE 0x10 420177633Sdfr#define ACPI_NO_DEVICE_INIT 0x20 421177633Sdfr#define ACPI_NO_OBJECT_INIT 0x40 422177633Sdfr 423177633Sdfr/* 424177633Sdfr * Initialization state 425177633Sdfr */ 426177633Sdfr#define ACPI_INITIALIZED_OK 0x01 427177633Sdfr 428177633Sdfr/* 429177633Sdfr * Power state values 430177633Sdfr */ 431177633Sdfr 432177633Sdfr#define ACPI_STATE_UNKNOWN (UINT8) 0xFF 433177633Sdfr 434177633Sdfr#define ACPI_STATE_S0 (UINT8) 0 435177633Sdfr#define ACPI_STATE_S1 (UINT8) 1 436177633Sdfr#define ACPI_STATE_S2 (UINT8) 2 437177633Sdfr#define ACPI_STATE_S3 (UINT8) 3 438177633Sdfr#define ACPI_STATE_S4 (UINT8) 4 439177633Sdfr#define ACPI_STATE_S5 (UINT8) 5 440177633Sdfr#define ACPI_S_STATES_MAX ACPI_STATE_S5 441177633Sdfr#define ACPI_S_STATE_COUNT 6 442177633Sdfr 443177633Sdfr#define ACPI_STATE_D0 (UINT8) 0 444177633Sdfr#define ACPI_STATE_D1 (UINT8) 1 445177633Sdfr#define ACPI_STATE_D2 (UINT8) 2 446177633Sdfr#define ACPI_STATE_D3 (UINT8) 3 447177633Sdfr#define ACPI_D_STATES_MAX ACPI_STATE_D3 448177633Sdfr#define ACPI_D_STATE_COUNT 4 449177633Sdfr 450177633Sdfr#define ACPI_STATE_C0 (UINT8) 0 451177633Sdfr#define ACPI_STATE_C1 (UINT8) 1 452177633Sdfr#define ACPI_STATE_C2 (UINT8) 2 453177633Sdfr#define ACPI_STATE_C3 (UINT8) 3 454177633Sdfr#define ACPI_C_STATES_MAX ACPI_STATE_C3 455#define ACPI_C_STATE_COUNT 4 456 457/* 458 * Sleep type invalid value 459 */ 460#define ACPI_SLEEP_TYPE_MAX 0x7 461#define ACPI_SLEEP_TYPE_INVALID 0xFF 462 463/* 464 * Standard notify values 465 */ 466#define ACPI_NOTIFY_BUS_CHECK (UINT8) 0 467#define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 1 468#define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 2 469#define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 3 470#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 4 471#define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 5 472#define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 6 473#define ACPI_NOTIFY_POWER_FAULT (UINT8) 7 474 475 476/* 477 * Table types. These values are passed to the table related APIs 478 */ 479typedef UINT32 ACPI_TABLE_TYPE; 480 481#define ACPI_TABLE_RSDP (ACPI_TABLE_TYPE) 0 482#define ACPI_TABLE_DSDT (ACPI_TABLE_TYPE) 1 483#define ACPI_TABLE_FADT (ACPI_TABLE_TYPE) 2 484#define ACPI_TABLE_FACS (ACPI_TABLE_TYPE) 3 485#define ACPI_TABLE_PSDT (ACPI_TABLE_TYPE) 4 486#define ACPI_TABLE_SSDT (ACPI_TABLE_TYPE) 5 487#define ACPI_TABLE_XSDT (ACPI_TABLE_TYPE) 6 488#define ACPI_TABLE_MAX 6 489#define NUM_ACPI_TABLES (ACPI_TABLE_MAX+1) 490 491 492/* 493 * Types associated with ACPI names and objects. The first group of 494 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition 495 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore, 496 * only add to the first group if the spec changes. 497 * 498 * Types must be kept in sync with the global AcpiNsProperties 499 * and AcpiNsTypeNames arrays. 500 */ 501typedef UINT32 ACPI_OBJECT_TYPE; 502 503#define ACPI_TYPE_ANY 0x00 504#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */ 505#define ACPI_TYPE_STRING 0x02 506#define ACPI_TYPE_BUFFER 0x03 507#define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */ 508#define ACPI_TYPE_FIELD_UNIT 0x05 509#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */ 510#define ACPI_TYPE_EVENT 0x07 511#define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */ 512#define ACPI_TYPE_MUTEX 0x09 513#define ACPI_TYPE_REGION 0x0A 514#define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */ 515#define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */ 516#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */ 517#define ACPI_TYPE_BUFFER_FIELD 0x0E 518#define ACPI_TYPE_DDB_HANDLE 0x0F 519#define ACPI_TYPE_DEBUG_OBJECT 0x10 520 521#define ACPI_TYPE_EXTERNAL_MAX 0x10 522 523/* 524 * These are object types that do not map directly to the ACPI 525 * ObjectType() operator. They are used for various internal purposes only. 526 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these 527 * internal types must move upwards. (There is code that depends on these 528 * values being contiguous with the external types above.) 529 */ 530#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11 531#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12 532#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13 533#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */ 534#define ACPI_TYPE_LOCAL_ALIAS 0x15 535#define ACPI_TYPE_LOCAL_NOTIFY 0x16 536#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x17 537#define ACPI_TYPE_LOCAL_RESOURCE 0x18 538#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x19 539#define ACPI_TYPE_LOCAL_SCOPE 0x1A /* 1 Name, multiple ObjectList Nodes */ 540 541#define ACPI_TYPE_NS_NODE_MAX 0x1A /* Last typecode used within a NS Node */ 542 543/* 544 * These are special object types that never appear in 545 * a Namespace node, only in an ACPI_OPERAND_OBJECT 546 */ 547#define ACPI_TYPE_LOCAL_EXTRA 0x1B 548#define ACPI_TYPE_LOCAL_DATA 0x1C 549 550#define ACPI_TYPE_LOCAL_MAX 0x1C 551 552/* All types above here are invalid */ 553 554#define ACPI_TYPE_INVALID 0x1D 555#define ACPI_TYPE_NOT_FOUND 0xFF 556 557 558/* 559 * Bitmapped ACPI types. Used internally only 560 */ 561#define ACPI_BTYPE_ANY 0x00000000 562#define ACPI_BTYPE_INTEGER 0x00000001 563#define ACPI_BTYPE_STRING 0x00000002 564#define ACPI_BTYPE_BUFFER 0x00000004 565#define ACPI_BTYPE_PACKAGE 0x00000008 566#define ACPI_BTYPE_FIELD_UNIT 0x00000010 567#define ACPI_BTYPE_DEVICE 0x00000020 568#define ACPI_BTYPE_EVENT 0x00000040 569#define ACPI_BTYPE_METHOD 0x00000080 570#define ACPI_BTYPE_MUTEX 0x00000100 571#define ACPI_BTYPE_REGION 0x00000200 572#define ACPI_BTYPE_POWER 0x00000400 573#define ACPI_BTYPE_PROCESSOR 0x00000800 574#define ACPI_BTYPE_THERMAL 0x00001000 575#define ACPI_BTYPE_BUFFER_FIELD 0x00002000 576#define ACPI_BTYPE_DDB_HANDLE 0x00004000 577#define ACPI_BTYPE_DEBUG_OBJECT 0x00008000 578#define ACPI_BTYPE_REFERENCE 0x00010000 579#define ACPI_BTYPE_RESOURCE 0x00020000 580 581#define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER) 582 583#define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE) 584#define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE) 585#define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR) 586#define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */ 587#define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF 588 589/* 590 * All I/O 591 */ 592#define ACPI_READ 0 593#define ACPI_WRITE 1 594#define ACPI_IO_MASK 1 595 596 597/* 598 * AcpiEvent Types: Fixed & General Purpose 599 */ 600typedef UINT32 ACPI_EVENT_TYPE; 601 602#define ACPI_EVENT_FIXED 0 603#define ACPI_EVENT_GPE 1 604 605/* 606 * Fixed events 607 */ 608#define ACPI_EVENT_PMTIMER 0 609#define ACPI_EVENT_GLOBAL 1 610#define ACPI_EVENT_POWER_BUTTON 2 611#define ACPI_EVENT_SLEEP_BUTTON 3 612#define ACPI_EVENT_RTC 4 613#define ACPI_EVENT_MAX 4 614#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1 615 616#define ACPI_GPE_INVALID 0xFF 617#define ACPI_GPE_MAX 0xFF 618#define ACPI_NUM_GPE 256 619 620#define ACPI_EVENT_LEVEL_TRIGGERED 1 621#define ACPI_EVENT_EDGE_TRIGGERED 2 622 623/* 624 * GPEs 625 */ 626#define ACPI_EVENT_WAKE_ENABLE 0x1 627#define ACPI_EVENT_WAKE_DISABLE 0x1 628 629 630/* 631 * AcpiEvent Status: 632 * ------------- 633 * The encoding of ACPI_EVENT_STATUS is illustrated below. 634 * Note that a set bit (1) indicates the property is TRUE 635 * (e.g. if bit 0 is set then the event is enabled). 636 * +-------------+-+-+-+ 637 * | Bits 31:3 |2|1|0| 638 * +-------------+-+-+-+ 639 * | | | | 640 * | | | +- Enabled? 641 * | | +--- Enabled for wake? 642 * | +----- Set? 643 * +----------- <Reserved> 644 */ 645typedef UINT32 ACPI_EVENT_STATUS; 646 647#define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00 648#define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01 649#define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02 650#define ACPI_EVENT_FLAG_SET (ACPI_EVENT_STATUS) 0x04 651 652 653/* Notify types */ 654 655#define ACPI_SYSTEM_NOTIFY 0 656#define ACPI_DEVICE_NOTIFY 1 657#define ACPI_MAX_NOTIFY_HANDLER_TYPE 1 658 659#define ACPI_MAX_SYS_NOTIFY 0x7f 660 661 662/* Address Space (Operation Region) Types */ 663 664typedef UINT8 ACPI_ADR_SPACE_TYPE; 665 666#define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0 667#define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1 668#define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2 669#define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3 670#define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4 671#define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5 672#define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6 673#define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 7 674#define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 127 675 676 677/* 678 * BitRegister IDs 679 * These are bitfields defined within the full ACPI registers 680 */ 681#define ACPI_BITREG_TIMER_STATUS 0x00 682#define ACPI_BITREG_BUS_MASTER_STATUS 0x01 683#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02 684#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03 685#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04 686#define ACPI_BITREG_RT_CLOCK_STATUS 0x05 687#define ACPI_BITREG_WAKE_STATUS 0x06 688 689#define ACPI_BITREG_TIMER_ENABLE 0x07 690#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x08 691#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x09 692#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0A 693#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0B 694#define ACPI_BITREG_WAKE_ENABLE 0x0C 695 696#define ACPI_BITREG_SCI_ENABLE 0x0D 697#define ACPI_BITREG_BUS_MASTER_RLD 0x0E 698#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x0F 699#define ACPI_BITREG_SLEEP_TYPE_A 0x10 700#define ACPI_BITREG_SLEEP_TYPE_B 0x11 701#define ACPI_BITREG_SLEEP_ENABLE 0x12 702 703#define ACPI_BITREG_ARB_DISABLE 0x13 704 705#define ACPI_BITREG_MAX 0x13 706#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1 707 708 709/* 710 * External ACPI object definition 711 */ 712typedef union acpi_object 713{ 714 ACPI_OBJECT_TYPE Type; /* See definition of AcpiNsType for values */ 715 struct 716 { 717 ACPI_OBJECT_TYPE Type; 718 ACPI_INTEGER Value; /* The actual number */ 719 } Integer; 720 721 struct 722 { 723 ACPI_OBJECT_TYPE Type; 724 UINT32 Length; /* # of bytes in string, excluding trailing null */ 725 char *Pointer; /* points to the string value */ 726 } String; 727 728 struct 729 { 730 ACPI_OBJECT_TYPE Type; 731 UINT32 Length; /* # of bytes in buffer */ 732 UINT8 *Pointer; /* points to the buffer */ 733 } Buffer; 734 735 struct 736 { 737 ACPI_OBJECT_TYPE Type; 738 UINT32 Fill1; 739 ACPI_HANDLE Handle; /* object reference */ 740 } Reference; 741 742 struct 743 { 744 ACPI_OBJECT_TYPE Type; 745 UINT32 Count; /* # of elements in package */ 746 union acpi_object *Elements; /* Pointer to an array of ACPI_OBJECTs */ 747 } Package; 748 749 struct 750 { 751 ACPI_OBJECT_TYPE Type; 752 UINT32 ProcId; 753 ACPI_IO_ADDRESS PblkAddress; 754 UINT32 PblkLength; 755 } Processor; 756 757 struct 758 { 759 ACPI_OBJECT_TYPE Type; 760 UINT32 SystemLevel; 761 UINT32 ResourceOrder; 762 } PowerResource; 763 764} ACPI_OBJECT; 765 766 767/* 768 * List of objects, used as a parameter list for control method evaluation 769 */ 770typedef struct acpi_object_list 771{ 772 UINT32 Count; 773 ACPI_OBJECT *Pointer; 774 775} ACPI_OBJECT_LIST; 776 777 778/* 779 * Miscellaneous common Data Structures used by the interfaces 780 */ 781#define ACPI_NO_BUFFER 0 782#define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1) 783#define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2) 784 785typedef struct acpi_buffer 786{ 787 ACPI_SIZE Length; /* Length in bytes of the buffer */ 788 void *Pointer; /* pointer to buffer */ 789 790} ACPI_BUFFER; 791 792 793/* 794 * NameType for AcpiGetName 795 */ 796#define ACPI_FULL_PATHNAME 0 797#define ACPI_SINGLE_NAME 1 798#define ACPI_NAME_TYPE_MAX 1 799 800 801/* 802 * Structure and flags for AcpiGetSystemInfo 803 */ 804#define ACPI_SYS_MODE_UNKNOWN 0x0000 805#define ACPI_SYS_MODE_ACPI 0x0001 806#define ACPI_SYS_MODE_LEGACY 0x0002 807#define ACPI_SYS_MODES_MASK 0x0003 808 809 810/* 811 * ACPI Table Info. One per ACPI table _type_ 812 */ 813typedef struct acpi_table_info 814{ 815 UINT32 Count; 816 817} ACPI_TABLE_INFO; 818 819 820/* 821 * System info returned by AcpiGetSystemInfo() 822 */ 823typedef struct acpi_system_info 824{ 825 UINT32 AcpiCaVersion; 826 UINT32 Flags; 827 UINT32 TimerResolution; 828 UINT32 Reserved1; 829 UINT32 Reserved2; 830 UINT32 DebugLevel; 831 UINT32 DebugLayer; 832 UINT32 NumTableTypes; 833 ACPI_TABLE_INFO TableInfo [NUM_ACPI_TABLES]; 834 835} ACPI_SYSTEM_INFO; 836 837 838/* 839 * Various handlers and callback procedures 840 */ 841typedef 842UINT32 (*ACPI_EVENT_HANDLER) ( 843 void *Context); 844 845typedef 846void (*ACPI_GPE_HANDLER) ( 847 void *Context); 848 849typedef 850void (*ACPI_NOTIFY_HANDLER) ( 851 ACPI_HANDLE Device, 852 UINT32 Value, 853 void *Context); 854 855typedef 856void (*ACPI_OBJECT_HANDLER) ( 857 ACPI_HANDLE Object, 858 UINT32 Function, 859 void *Data); 860 861typedef 862ACPI_STATUS (*ACPI_INIT_HANDLER) ( 863 ACPI_HANDLE Object, 864 UINT32 Function); 865 866#define ACPI_INIT_DEVICE_INI 1 867 868 869/* Address Spaces (Operation Regions */ 870 871typedef 872ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) ( 873 UINT32 Function, 874 ACPI_PHYSICAL_ADDRESS Address, 875 UINT32 BitWidth, 876 ACPI_INTEGER *Value, 877 void *HandlerContext, 878 void *RegionContext); 879 880#define ACPI_DEFAULT_HANDLER NULL 881 882 883typedef 884ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) ( 885 ACPI_HANDLE RegionHandle, 886 UINT32 Function, 887 void *HandlerContext, 888 void **RegionContext); 889 890#define ACPI_REGION_ACTIVATE 0 891#define ACPI_REGION_DEACTIVATE 1 892 893typedef 894ACPI_STATUS (*ACPI_WALK_CALLBACK) ( 895 ACPI_HANDLE ObjHandle, 896 UINT32 NestingLevel, 897 void *Context, 898 void **ReturnValue); 899 900 901/* Interrupt handler return values */ 902 903#define ACPI_INTERRUPT_NOT_HANDLED 0x00 904#define ACPI_INTERRUPT_HANDLED 0x01 905 906 907/* Structure and flags for AcpiGetDeviceInfo */ 908 909#define ACPI_VALID_HID 0x1 910#define ACPI_VALID_UID 0x2 911#define ACPI_VALID_ADR 0x4 912#define ACPI_VALID_STA 0x8 913 914 915#define ACPI_COMMON_OBJ_INFO \ 916 ACPI_OBJECT_TYPE Type; /* ACPI object type */ \ 917 ACPI_NAME Name /* ACPI object Name */ 918 919 920typedef struct acpi_obj_info_header 921{ 922 ACPI_COMMON_OBJ_INFO; 923 924} ACPI_OBJ_INFO_HEADER; 925 926 927typedef struct acpi_device_info 928{ 929 ACPI_COMMON_OBJ_INFO; 930 931 UINT32 Valid; /* Are the next bits legit? */ 932 char HardwareId[9]; /* _HID value if any */ 933 char UniqueId[9]; /* _UID value if any */ 934 ACPI_INTEGER Address; /* _ADR value if any */ 935 UINT32 CurrentStatus; /* _STA value */ 936 937} ACPI_DEVICE_INFO; 938 939 940/* Context structs for address space handlers */ 941 942typedef struct acpi_pci_id 943{ 944 UINT16 Segment; 945 UINT16 Bus; 946 UINT16 Device; 947 UINT16 Function; 948 949} ACPI_PCI_ID; 950 951 952typedef struct acpi_mem_space_context 953{ 954 UINT32 Length; 955 ACPI_PHYSICAL_ADDRESS Address; 956 ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress; 957 UINT8 *MappedLogicalAddress; 958 ACPI_SIZE MappedLength; 959 960} ACPI_MEM_SPACE_CONTEXT; 961 962 963/* 964 * Definitions for Resource Attributes 965 */ 966 967/* 968 * Memory Attributes 969 */ 970#define ACPI_READ_ONLY_MEMORY (UINT8) 0x00 971#define ACPI_READ_WRITE_MEMORY (UINT8) 0x01 972 973#define ACPI_NON_CACHEABLE_MEMORY (UINT8) 0x00 974#define ACPI_CACHABLE_MEMORY (UINT8) 0x01 975#define ACPI_WRITE_COMBINING_MEMORY (UINT8) 0x02 976#define ACPI_PREFETCHABLE_MEMORY (UINT8) 0x03 977 978/* 979 * IO Attributes 980 * The ISA IO ranges are: n000-n0FFh, n400-n4FFh, n800-n8FFh, nC00-nCFFh. 981 * The non-ISA IO ranges are: n100-n3FFh, n500-n7FFh, n900-nBFFh, nCD0-nFFFh. 982 */ 983#define ACPI_NON_ISA_ONLY_RANGES (UINT8) 0x01 984#define ACPI_ISA_ONLY_RANGES (UINT8) 0x02 985#define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES) 986 987#define ACPI_SPARSE_TRANSLATION (UINT8) 0x03 988 989/* 990 * IO Port Descriptor Decode 991 */ 992#define ACPI_DECODE_10 (UINT8) 0x00 /* 10-bit IO address decode */ 993#define ACPI_DECODE_16 (UINT8) 0x01 /* 16-bit IO address decode */ 994 995/* 996 * IRQ Attributes 997 */ 998#define ACPI_EDGE_SENSITIVE (UINT8) 0x00 999#define ACPI_LEVEL_SENSITIVE (UINT8) 0x01 1000 1001#define ACPI_ACTIVE_HIGH (UINT8) 0x00 1002#define ACPI_ACTIVE_LOW (UINT8) 0x01 1003 1004#define ACPI_EXCLUSIVE (UINT8) 0x00 1005#define ACPI_SHARED (UINT8) 0x01 1006 1007/* 1008 * DMA Attributes 1009 */ 1010#define ACPI_COMPATIBILITY (UINT8) 0x00 1011#define ACPI_TYPE_A (UINT8) 0x01 1012#define ACPI_TYPE_B (UINT8) 0x02 1013#define ACPI_TYPE_F (UINT8) 0x03 1014 1015#define ACPI_NOT_BUS_MASTER (UINT8) 0x00 1016#define ACPI_BUS_MASTER (UINT8) 0x01 1017 1018#define ACPI_TRANSFER_8 (UINT8) 0x00 1019#define ACPI_TRANSFER_8_16 (UINT8) 0x01 1020#define ACPI_TRANSFER_16 (UINT8) 0x02 1021 1022/* 1023 * Start Dependent Functions Priority definitions 1024 */ 1025#define ACPI_GOOD_CONFIGURATION (UINT8) 0x00 1026#define ACPI_ACCEPTABLE_CONFIGURATION (UINT8) 0x01 1027#define ACPI_SUB_OPTIMAL_CONFIGURATION (UINT8) 0x02 1028 1029/* 1030 * 16, 32 and 64-bit Address Descriptor resource types 1031 */ 1032#define ACPI_MEMORY_RANGE (UINT8) 0x00 1033#define ACPI_IO_RANGE (UINT8) 0x01 1034#define ACPI_BUS_NUMBER_RANGE (UINT8) 0x02 1035 1036#define ACPI_ADDRESS_NOT_FIXED (UINT8) 0x00 1037#define ACPI_ADDRESS_FIXED (UINT8) 0x01 1038 1039#define ACPI_POS_DECODE (UINT8) 0x00 1040#define ACPI_SUB_DECODE (UINT8) 0x01 1041 1042#define ACPI_PRODUCER (UINT8) 0x00 1043#define ACPI_CONSUMER (UINT8) 0x01 1044 1045 1046/* 1047 * Structures used to describe device resources 1048 */ 1049typedef struct acpi_resource_irq 1050{ 1051 UINT32 EdgeLevel; 1052 UINT32 ActiveHighLow; 1053 UINT32 SharedExclusive; 1054 UINT32 NumberOfInterrupts; 1055 UINT32 Interrupts[1]; 1056 1057} ACPI_RESOURCE_IRQ; 1058 1059typedef struct ACPI_RESOURCE_DMA 1060{ 1061 UINT32 Type; 1062 UINT32 BusMaster; 1063 UINT32 Transfer; 1064 UINT32 NumberOfChannels; 1065 UINT32 Channels[1]; 1066 1067} ACPI_RESOURCE_DMA; 1068 1069typedef struct acpi_resource_start_dpf 1070{ 1071 UINT32 CompatibilityPriority; 1072 UINT32 PerformanceRobustness; 1073 1074} ACPI_RESOURCE_START_DPF; 1075 1076/* 1077 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not 1078 * needed because it has no fields 1079 */ 1080 1081typedef struct acpi_resource_io 1082{ 1083 UINT32 IoDecode; 1084 UINT32 MinBaseAddress; 1085 UINT32 MaxBaseAddress; 1086 UINT32 Alignment; 1087 UINT32 RangeLength; 1088 1089} ACPI_RESOURCE_IO; 1090 1091typedef struct acpi_resource_fixed_io 1092{ 1093 UINT32 BaseAddress; 1094 UINT32 RangeLength; 1095 1096} ACPI_RESOURCE_FIXED_IO; 1097 1098typedef struct acpi_resource_vendor 1099{ 1100 UINT32 Length; 1101 UINT8 Reserved[1]; 1102 1103} ACPI_RESOURCE_VENDOR; 1104 1105typedef struct acpi_resource_end_tag 1106{ 1107 UINT8 Checksum; 1108 1109} ACPI_RESOURCE_END_TAG; 1110 1111typedef struct acpi_resource_mem24 1112{ 1113 UINT32 ReadWriteAttribute; 1114 UINT32 MinBaseAddress; 1115 UINT32 MaxBaseAddress; 1116 UINT32 Alignment; 1117 UINT32 RangeLength; 1118 1119} ACPI_RESOURCE_MEM24; 1120 1121typedef struct acpi_resource_mem32 1122{ 1123 UINT32 ReadWriteAttribute; 1124 UINT32 MinBaseAddress; 1125 UINT32 MaxBaseAddress; 1126 UINT32 Alignment; 1127 UINT32 RangeLength; 1128 1129} ACPI_RESOURCE_MEM32; 1130 1131typedef struct acpi_resource_fixed_mem32 1132{ 1133 UINT32 ReadWriteAttribute; 1134 UINT32 RangeBaseAddress; 1135 UINT32 RangeLength; 1136 1137} ACPI_RESOURCE_FIXED_MEM32; 1138 1139typedef struct acpi_memory_attribute 1140{ 1141 UINT16 CacheAttribute; 1142 UINT16 ReadWriteAttribute; 1143 1144} ACPI_MEMORY_ATTRIBUTE; 1145 1146typedef struct acpi_io_attribute 1147{ 1148 UINT16 RangeAttribute; 1149 UINT16 TranslationAttribute; 1150 1151} ACPI_IO_ATTRIBUTE; 1152 1153typedef struct acpi_bus_attribute 1154{ 1155 UINT16 Reserved1; 1156 UINT16 Reserved2; 1157 1158} ACPI_BUS_ATTRIBUTE; 1159 1160typedef union acpi_resource_attribute 1161{ 1162 ACPI_MEMORY_ATTRIBUTE Memory; 1163 ACPI_IO_ATTRIBUTE Io; 1164 ACPI_BUS_ATTRIBUTE Bus; 1165 1166} ACPI_RESOURCE_ATTRIBUTE; 1167 1168typedef struct acpi_resource_source 1169{ 1170 UINT32 Index; 1171 UINT32 StringLength; 1172 char *StringPtr; 1173 1174} ACPI_RESOURCE_SOURCE; 1175 1176typedef struct acpi_resource_address16 1177{ 1178 UINT32 ResourceType; 1179 UINT32 ProducerConsumer; 1180 UINT32 Decode; 1181 UINT32 MinAddressFixed; 1182 UINT32 MaxAddressFixed; 1183 ACPI_RESOURCE_ATTRIBUTE Attribute; 1184 UINT32 Granularity; 1185 UINT32 MinAddressRange; 1186 UINT32 MaxAddressRange; 1187 UINT32 AddressTranslationOffset; 1188 UINT32 AddressLength; 1189 ACPI_RESOURCE_SOURCE ResourceSource; 1190 1191} ACPI_RESOURCE_ADDRESS16; 1192 1193typedef struct acpi_resource_address32 1194{ 1195 UINT32 ResourceType; 1196 UINT32 ProducerConsumer; 1197 UINT32 Decode; 1198 UINT32 MinAddressFixed; 1199 UINT32 MaxAddressFixed; 1200 ACPI_RESOURCE_ATTRIBUTE Attribute; 1201 UINT32 Granularity; 1202 UINT32 MinAddressRange; 1203 UINT32 MaxAddressRange; 1204 UINT32 AddressTranslationOffset; 1205 UINT32 AddressLength; 1206 ACPI_RESOURCE_SOURCE ResourceSource; 1207 1208} ACPI_RESOURCE_ADDRESS32; 1209 1210typedef struct acpi_resource_address64 1211{ 1212 UINT32 ResourceType; 1213 UINT32 ProducerConsumer; 1214 UINT32 Decode; 1215 UINT32 MinAddressFixed; 1216 UINT32 MaxAddressFixed; 1217 ACPI_RESOURCE_ATTRIBUTE Attribute; 1218 UINT64 Granularity; 1219 UINT64 MinAddressRange; 1220 UINT64 MaxAddressRange; 1221 UINT64 AddressTranslationOffset; 1222 UINT64 AddressLength; 1223 ACPI_RESOURCE_SOURCE ResourceSource; 1224 1225} ACPI_RESOURCE_ADDRESS64; 1226 1227typedef struct acpi_resource_ext_irq 1228{ 1229 UINT32 ProducerConsumer; 1230 UINT32 EdgeLevel; 1231 UINT32 ActiveHighLow; 1232 UINT32 SharedExclusive; 1233 UINT32 NumberOfInterrupts; 1234 ACPI_RESOURCE_SOURCE ResourceSource; 1235 UINT32 Interrupts[1]; 1236 1237} ACPI_RESOURCE_EXT_IRQ; 1238 1239 1240/* ACPI_RESOURCE_TYPEs */ 1241 1242#define ACPI_RSTYPE_IRQ 0 1243#define ACPI_RSTYPE_DMA 1 1244#define ACPI_RSTYPE_START_DPF 2 1245#define ACPI_RSTYPE_END_DPF 3 1246#define ACPI_RSTYPE_IO 4 1247#define ACPI_RSTYPE_FIXED_IO 5 1248#define ACPI_RSTYPE_VENDOR 6 1249#define ACPI_RSTYPE_END_TAG 7 1250#define ACPI_RSTYPE_MEM24 8 1251#define ACPI_RSTYPE_MEM32 9 1252#define ACPI_RSTYPE_FIXED_MEM32 10 1253#define ACPI_RSTYPE_ADDRESS16 11 1254#define ACPI_RSTYPE_ADDRESS32 12 1255#define ACPI_RSTYPE_ADDRESS64 13 1256#define ACPI_RSTYPE_EXT_IRQ 14 1257 1258typedef UINT32 ACPI_RESOURCE_TYPE; 1259 1260typedef union acpi_resource_data 1261{ 1262 ACPI_RESOURCE_IRQ Irq; 1263 ACPI_RESOURCE_DMA Dma; 1264 ACPI_RESOURCE_START_DPF StartDpf; 1265 ACPI_RESOURCE_IO Io; 1266 ACPI_RESOURCE_FIXED_IO FixedIo; 1267 ACPI_RESOURCE_VENDOR VendorSpecific; 1268 ACPI_RESOURCE_END_TAG EndTag; 1269 ACPI_RESOURCE_MEM24 Memory24; 1270 ACPI_RESOURCE_MEM32 Memory32; 1271 ACPI_RESOURCE_FIXED_MEM32 FixedMemory32; 1272 ACPI_RESOURCE_ADDRESS16 Address16; 1273 ACPI_RESOURCE_ADDRESS32 Address32; 1274 ACPI_RESOURCE_ADDRESS64 Address64; 1275 ACPI_RESOURCE_EXT_IRQ ExtendedIrq; 1276 1277} ACPI_RESOURCE_DATA; 1278 1279typedef struct acpi_resource 1280{ 1281 ACPI_RESOURCE_TYPE Id; 1282 UINT32 Length; 1283 ACPI_RESOURCE_DATA Data; 1284 1285} ACPI_RESOURCE; 1286 1287#define ACPI_RESOURCE_LENGTH 12 1288#define ACPI_RESOURCE_LENGTH_NO_DATA 8 /* Id + Length fields */ 1289 1290#define ACPI_SIZEOF_RESOURCE(Type) (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (Type)) 1291 1292#define ACPI_NEXT_RESOURCE(Res) (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length) 1293 1294#ifdef _HW_ALIGNMENT_SUPPORT 1295#define ACPI_ALIGN_RESOURCE_SIZE(Length) (Length) 1296#else 1297#define ACPI_ALIGN_RESOURCE_SIZE(Length) ACPI_ROUND_UP_TO_NATIVE_WORD(Length) 1298#endif 1299 1300/* 1301 * END: of definitions for Resource Attributes 1302 */ 1303 1304 1305typedef struct acpi_pci_routing_table 1306{ 1307 UINT32 Length; 1308 UINT32 Pin; 1309 ACPI_INTEGER Address; /* here for 64-bit alignment */ 1310 UINT32 SourceIndex; 1311 char Source[4]; /* pad to 64 bits so sizeof() works in all cases */ 1312 1313} ACPI_PCI_ROUTING_TABLE; 1314 1315/* 1316 * END: of definitions for PCI Routing tables 1317 */ 1318 1319 1320#endif /* __ACTYPES_H__ */ 1321