Subversion Repositories Kolibri OS

Rev

Rev 1498 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Name: actypes.h - Common data types for the entire ACPI subsystem
  4.  *
  5.  *****************************************************************************/
  6.  
  7. /******************************************************************************
  8.  *
  9.  * 1. Copyright Notice
  10.  *
  11.  * Some or all of this work - Copyright (c) 1999 - 2011, 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. #ifndef __ACTYPES_H__
  117. #define __ACTYPES_H__
  118.  
  119. /* acpisrc:StructDefs -- for acpisrc conversion */
  120.  
  121. /*
  122.  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
  123.  * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
  124.  * 12/2006.
  125.  */
  126. #ifndef ACPI_MACHINE_WIDTH
  127. #error ACPI_MACHINE_WIDTH not defined
  128. #endif
  129.  
  130. /*! [Begin] no source code translation */
  131.  
  132. /*
  133.  * Data type ranges
  134.  * Note: These macros are designed to be compiler independent as well as
  135.  * working around problems that some 32-bit compilers have with 64-bit
  136.  * constants.
  137.  */
  138. #define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
  139. #define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
  140. #define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
  141. #define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
  142. #define ACPI_ASCII_MAX                  0x7F
  143.  
  144.  
  145. /*
  146.  * Architecture-specific ACPICA Subsystem Data Types
  147.  *
  148.  * The goal of these types is to provide source code portability across
  149.  * 16-bit, 32-bit, and 64-bit targets.
  150.  *
  151.  * 1) The following types are of fixed size for all targets (16/32/64):
  152.  *
  153.  * BOOLEAN      Logical boolean
  154.  *
  155.  * UINT8        8-bit  (1 byte) unsigned value
  156.  * UINT16       16-bit (2 byte) unsigned value
  157.  * UINT32       32-bit (4 byte) unsigned value
  158.  * UINT64       64-bit (8 byte) unsigned value
  159.  *
  160.  * INT16        16-bit (2 byte) signed value
  161.  * INT32        32-bit (4 byte) signed value
  162.  * INT64        64-bit (8 byte) signed value
  163.  *
  164.  * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
  165.  * compiler-dependent header(s) and were introduced because there is no common
  166.  * 64-bit integer type across the various compilation models, as shown in
  167.  * the table below.
  168.  *
  169.  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
  170.  * char      8    8     8     8     8    8
  171.  * short     16   16    16    16    16   16
  172.  * _int32         32
  173.  * int       32   64    32    32    16   16
  174.  * long      64   64    32    32    32   32
  175.  * long long            64    64
  176.  * pointer   64   64    64    32    32   32
  177.  *
  178.  * Note: ILP64 and LP32 are currently not supported.
  179.  *
  180.  *
  181.  * 2) These types represent the native word size of the target mode of the
  182.  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
  183.  * usually used for memory allocation, efficient loop counters, and array
  184.  * indexes. The types are similar to the size_t type in the C library and are
  185.  * required because there is no C type that consistently represents the native
  186.  * data width. ACPI_SIZE is needed because there is no guarantee that a
  187.  * kernel-level C library is present.
  188.  *
  189.  * ACPI_SIZE        16/32/64-bit unsigned value
  190.  * ACPI_NATIVE_INT  16/32/64-bit signed value
  191.  */
  192.  
  193. /*******************************************************************************
  194.  *
  195.  * Common types for all compilers, all targets
  196.  *
  197.  ******************************************************************************/
  198.  
  199. typedef unsigned char                   BOOLEAN;
  200. typedef unsigned char                   UINT8;
  201. typedef unsigned short                  UINT16;
  202. typedef COMPILER_DEPENDENT_UINT64       UINT64;
  203. typedef COMPILER_DEPENDENT_INT64        INT64;
  204.  
  205. /*! [End] no source code translation !*/
  206.  
  207. /*
  208.  * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
  209.  * across operating systems or even the various UNIX systems. Since ACPICA
  210.  * only needs the thread ID as a unique thread identifier, we use a UINT64
  211.  * as the only common data type - it will accommodate any type of pointer or
  212.  * any type of integer. It is up to the host-dependent OSL to cast the
  213.  * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
  214.  */
  215. #define ACPI_THREAD_ID                  UINT64
  216.  
  217.  
  218. /*******************************************************************************
  219.  *
  220.  * Types specific to 64-bit targets
  221.  *
  222.  ******************************************************************************/
  223.  
  224. #if ACPI_MACHINE_WIDTH == 64
  225.  
  226. /*! [Begin] no source code translation (keep the typedefs as-is) */
  227.  
  228. typedef unsigned int                    UINT32;
  229. typedef int                             INT32;
  230.  
  231. /*! [End] no source code translation !*/
  232.  
  233.  
  234. typedef INT64                           ACPI_NATIVE_INT;
  235. typedef UINT64                          ACPI_SIZE;
  236. typedef UINT64                          ACPI_IO_ADDRESS;
  237. typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
  238.  
  239. #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
  240. #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
  241. #define ACPI_USE_NATIVE_DIVIDE          /* Has native 64-bit integer support */
  242.  
  243. /*
  244.  * In the case of the Itanium Processor Family (IPF), the hardware does not
  245.  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
  246.  * to indicate that special precautions must be taken to avoid alignment faults.
  247.  * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
  248.  *
  249.  * Note: EM64T and other X86-64 processors support misaligned transfers,
  250.  * so there is no need to define this flag.
  251.  */
  252. #if defined (__IA64__) || defined (__ia64__)
  253. #define ACPI_MISALIGNMENT_NOT_SUPPORTED
  254. #endif
  255.  
  256.  
  257. /*******************************************************************************
  258.  *
  259.  * Types specific to 32-bit targets
  260.  *
  261.  ******************************************************************************/
  262.  
  263. #elif ACPI_MACHINE_WIDTH == 32
  264.  
  265. /*! [Begin] no source code translation (keep the typedefs as-is) */
  266.  
  267. typedef unsigned int                    UINT32;
  268. typedef int                             INT32;
  269.  
  270. /*! [End] no source code translation !*/
  271.  
  272.  
  273. typedef INT32                           ACPI_NATIVE_INT;
  274. typedef UINT32                          ACPI_SIZE;
  275. typedef UINT32                          ACPI_IO_ADDRESS;
  276. typedef UINT32                          ACPI_PHYSICAL_ADDRESS;
  277.  
  278. #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
  279. #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
  280.  
  281. #else
  282.  
  283. /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
  284.  
  285. #error unknown ACPI_MACHINE_WIDTH
  286. #endif
  287.  
  288.  
  289. /*******************************************************************************
  290.  *
  291.  * OS-dependent types
  292.  *
  293.  * If the defaults below are not appropriate for the host system, they can
  294.  * be defined in the OS-specific header, and this will take precedence.
  295.  *
  296.  ******************************************************************************/
  297.  
  298. /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
  299.  
  300. #ifndef ACPI_CPU_FLAGS
  301. #define ACPI_CPU_FLAGS                  ACPI_SIZE
  302. #endif
  303.  
  304. /* Object returned from AcpiOsCreateCache */
  305.  
  306. #ifndef ACPI_CACHE_T
  307. #ifdef ACPI_USE_LOCAL_CACHE
  308. #define ACPI_CACHE_T                    ACPI_MEMORY_LIST
  309. #else
  310. #define ACPI_CACHE_T                    void *
  311. #endif
  312. #endif
  313.  
  314. /*
  315.  * Synchronization objects - Mutexes, Semaphores, and SpinLocks
  316.  */
  317. #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
  318. /*
  319.  * These macros are used if the host OS does not support a mutex object.
  320.  * Map the OSL Mutex interfaces to binary semaphores.
  321.  */
  322. #define ACPI_MUTEX                      ACPI_SEMAPHORE
  323. #define AcpiOsCreateMutex(OutHandle)    AcpiOsCreateSemaphore (1, 1, OutHandle)
  324. #define AcpiOsDeleteMutex(Handle)       (void) AcpiOsDeleteSemaphore (Handle)
  325. #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
  326. #define AcpiOsReleaseMutex(Handle)      (void) AcpiOsSignalSemaphore (Handle, 1)
  327. #endif
  328.  
  329. /* Configurable types for synchronization objects */
  330.  
  331. #ifndef ACPI_SPINLOCK
  332. #define ACPI_SPINLOCK                   void *
  333. #endif
  334.  
  335. #ifndef ACPI_SEMAPHORE
  336. #define ACPI_SEMAPHORE                  void *
  337. #endif
  338.  
  339. #ifndef ACPI_MUTEX
  340. #define ACPI_MUTEX                      void *
  341. #endif
  342.  
  343.  
  344. /*******************************************************************************
  345.  *
  346.  * Compiler-dependent types
  347.  *
  348.  * If the defaults below are not appropriate for the host compiler, they can
  349.  * be defined in the compiler-specific header, and this will take precedence.
  350.  *
  351.  ******************************************************************************/
  352.  
  353. /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
  354.  
  355. #ifndef ACPI_UINTPTR_T
  356. #define ACPI_UINTPTR_T                  void *
  357. #endif
  358.  
  359. /*
  360.  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
  361.  * some compilers can catch printf format string problems
  362.  */
  363. #ifndef ACPI_PRINTF_LIKE
  364. #define ACPI_PRINTF_LIKE(c)
  365. #endif
  366.  
  367. /*
  368.  * Some compilers complain about unused variables. Sometimes we don't want to
  369.  * use all the variables (for example, _AcpiModuleName). This allows us
  370.  * to to tell the compiler in a per-variable manner that a variable
  371.  * is unused
  372.  */
  373. #ifndef ACPI_UNUSED_VAR
  374. #define ACPI_UNUSED_VAR
  375. #endif
  376.  
  377. /*
  378.  * All ACPICA functions that are available to the rest of the kernel are
  379.  * tagged with this macro which can be defined as appropriate for the host.
  380.  */
  381. #ifndef ACPI_EXPORT_SYMBOL
  382. #define ACPI_EXPORT_SYMBOL(Symbol)
  383. #endif
  384.  
  385.  
  386. /******************************************************************************
  387.  *
  388.  * ACPI Specification constants (Do not change unless the specification changes)
  389.  *
  390.  *****************************************************************************/
  391.  
  392. /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
  393.  
  394. #define ACPI_MAX_GPE_BLOCKS             2
  395.  
  396. /* Default ACPI register widths */
  397.  
  398. #define ACPI_GPE_REGISTER_WIDTH         8
  399. #define ACPI_PM1_REGISTER_WIDTH         16
  400. #define ACPI_PM2_REGISTER_WIDTH         8
  401. #define ACPI_PM_TIMER_WIDTH             32
  402.  
  403. /* Names within the namespace are 4 bytes long */
  404.  
  405. #define ACPI_NAME_SIZE                  4
  406. #define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
  407. #define ACPI_PATH_SEPARATOR             '.'
  408.  
  409. /* Sizes for ACPI table headers */
  410.  
  411. #define ACPI_OEM_ID_SIZE                6
  412. #define ACPI_OEM_TABLE_ID_SIZE          8
  413.  
  414. /* ACPI/PNP hardware IDs */
  415.  
  416. #define PCI_ROOT_HID_STRING             "PNP0A03"
  417. #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
  418.  
  419. /* PM Timer ticks per second (HZ) */
  420.  
  421. #define PM_TIMER_FREQUENCY              3579545
  422.  
  423.  
  424. /*******************************************************************************
  425.  *
  426.  * Independent types
  427.  *
  428.  ******************************************************************************/
  429.  
  430. /* Logical defines and NULL */
  431.  
  432. #ifdef FALSE
  433. #undef FALSE
  434. #endif
  435. #define FALSE                           (1 == 0)
  436.  
  437. #ifdef TRUE
  438. #undef TRUE
  439. #endif
  440. #define TRUE                            (1 == 1)
  441.  
  442. #ifndef NULL
  443. #define NULL                            (void *) 0
  444. #endif
  445.  
  446.  
  447. /*
  448.  * Miscellaneous types
  449.  */
  450. typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
  451. typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
  452. typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
  453. typedef void *                          ACPI_HANDLE;    /* Actually a ptr to a NS Node */
  454.  
  455.  
  456. /* Owner IDs are used to track namespace nodes for selective deletion */
  457.  
  458. typedef UINT8                           ACPI_OWNER_ID;
  459. #define ACPI_OWNER_ID_MAX               0xFF
  460.  
  461.  
  462. #define ACPI_INTEGER_BIT_SIZE           64
  463. #define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
  464. #define ACPI_MAX64_DECIMAL_DIGITS       20
  465. #define ACPI_MAX32_DECIMAL_DIGITS       10
  466. #define ACPI_MAX16_DECIMAL_DIGITS        5
  467. #define ACPI_MAX8_DECIMAL_DIGITS         3
  468.  
  469. /*
  470.  * Constants with special meanings
  471.  */
  472. #define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR)
  473. #define ACPI_WAIT_FOREVER               0xFFFF  /* UINT16, as per ACPI spec */
  474. #define ACPI_DO_NOT_WAIT                0
  475.  
  476. /*
  477.  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
  478.  * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
  479.  * pertains to the ACPI integer type only, not to other integers used in the
  480.  * implementation of the ACPICA subsystem.
  481.  *
  482.  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
  483.  * code base. It remains here for compatibility with device drivers that use
  484.  * the type. However, it will be removed in the future.
  485.  */
  486. typedef UINT64                          ACPI_INTEGER;
  487. #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
  488.  
  489.  
  490. /*******************************************************************************
  491.  *
  492.  * Commonly used macros
  493.  *
  494.  ******************************************************************************/
  495.  
  496. /* Data manipulation */
  497.  
  498. #define ACPI_LOBYTE(Integer)            ((UINT8)   (UINT16)(Integer))
  499. #define ACPI_HIBYTE(Integer)            ((UINT8) (((UINT16)(Integer)) >> 8))
  500. #define ACPI_LOWORD(Integer)            ((UINT16)  (UINT32)(Integer))
  501. #define ACPI_HIWORD(Integer)            ((UINT16)(((UINT32)(Integer)) >> 16))
  502. #define ACPI_LODWORD(Integer64)         ((UINT32)  (UINT64)(Integer64))
  503. #define ACPI_HIDWORD(Integer64)         ((UINT32)(((UINT64)(Integer64)) >> 32))
  504.  
  505. #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
  506. #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
  507. #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
  508. #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
  509.  
  510. /* Size calculation */
  511.  
  512. #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
  513.  
  514. /* Pointer manipulation */
  515.  
  516. #define ACPI_CAST_PTR(t, p)             ((t *) (ACPI_UINTPTR_T) (p))
  517. #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (ACPI_UINTPTR_T) (p))
  518. #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
  519. #define ACPI_PTR_DIFF(a, b)             (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b)))
  520.  
  521. /* Pointer/Integer type conversions */
  522.  
  523. #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
  524. #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
  525. #define ACPI_OFFSET(d, f)               (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
  526. #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
  527. #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
  528.  
  529. #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
  530. #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
  531. #else
  532. #define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
  533. #endif
  534.  
  535.  
  536. /*******************************************************************************
  537.  *
  538.  * Miscellaneous constants
  539.  *
  540.  ******************************************************************************/
  541.  
  542. /*
  543.  * Initialization sequence
  544.  */
  545. #define ACPI_FULL_INITIALIZATION        0x00
  546. #define ACPI_NO_ADDRESS_SPACE_INIT      0x01
  547. #define ACPI_NO_HARDWARE_INIT           0x02
  548. #define ACPI_NO_EVENT_INIT              0x04
  549. #define ACPI_NO_HANDLER_INIT            0x08
  550. #define ACPI_NO_ACPI_ENABLE             0x10
  551. #define ACPI_NO_DEVICE_INIT             0x20
  552. #define ACPI_NO_OBJECT_INIT             0x40
  553.  
  554. /*
  555.  * Initialization state
  556.  */
  557. #define ACPI_SUBSYSTEM_INITIALIZE       0x01
  558. #define ACPI_INITIALIZED_OK             0x02
  559.  
  560. /*
  561.  * Power state values
  562.  */
  563. #define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
  564.  
  565. #define ACPI_STATE_S0                   (UINT8) 0
  566. #define ACPI_STATE_S1                   (UINT8) 1
  567. #define ACPI_STATE_S2                   (UINT8) 2
  568. #define ACPI_STATE_S3                   (UINT8) 3
  569. #define ACPI_STATE_S4                   (UINT8) 4
  570. #define ACPI_STATE_S5                   (UINT8) 5
  571. #define ACPI_S_STATES_MAX               ACPI_STATE_S5
  572. #define ACPI_S_STATE_COUNT              6
  573.  
  574. #define ACPI_STATE_D0                   (UINT8) 0
  575. #define ACPI_STATE_D1                   (UINT8) 1
  576. #define ACPI_STATE_D2                   (UINT8) 2
  577. #define ACPI_STATE_D3                   (UINT8) 3
  578. #define ACPI_D_STATES_MAX               ACPI_STATE_D3
  579. #define ACPI_D_STATE_COUNT              4
  580.  
  581. #define ACPI_STATE_C0                   (UINT8) 0
  582. #define ACPI_STATE_C1                   (UINT8) 1
  583. #define ACPI_STATE_C2                   (UINT8) 2
  584. #define ACPI_STATE_C3                   (UINT8) 3
  585. #define ACPI_C_STATES_MAX               ACPI_STATE_C3
  586. #define ACPI_C_STATE_COUNT              4
  587.  
  588. /*
  589.  * Sleep type invalid value
  590.  */
  591. #define ACPI_SLEEP_TYPE_MAX             0x7
  592. #define ACPI_SLEEP_TYPE_INVALID         0xFF
  593.  
  594. /*
  595.  * Standard notify values
  596.  */
  597. #define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0x00
  598. #define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 0x01
  599. #define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 0x02
  600. #define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 0x03
  601. #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 0x04
  602. #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 0x05
  603. #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 0x06
  604. #define ACPI_NOTIFY_POWER_FAULT         (UINT8) 0x07
  605. #define ACPI_NOTIFY_CAPABILITIES_CHECK  (UINT8) 0x08
  606. #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (UINT8) 0x09
  607. #define ACPI_NOTIFY_RESERVED            (UINT8) 0x0A
  608. #define ACPI_NOTIFY_LOCALITY_UPDATE     (UINT8) 0x0B
  609.  
  610. #define ACPI_NOTIFY_MAX                 0x0B
  611.  
  612. /*
  613.  * Types associated with ACPI names and objects. The first group of
  614.  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
  615.  * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
  616.  * only add to the first group if the spec changes.
  617.  *
  618.  * NOTE: Types must be kept in sync with the global AcpiNsProperties
  619.  * and AcpiNsTypeNames arrays.
  620.  */
  621. typedef UINT32                          ACPI_OBJECT_TYPE;
  622.  
  623. #define ACPI_TYPE_ANY                   0x00
  624. #define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
  625. #define ACPI_TYPE_STRING                0x02
  626. #define ACPI_TYPE_BUFFER                0x03
  627. #define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
  628. #define ACPI_TYPE_FIELD_UNIT            0x05
  629. #define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
  630. #define ACPI_TYPE_EVENT                 0x07
  631. #define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
  632. #define ACPI_TYPE_MUTEX                 0x09
  633. #define ACPI_TYPE_REGION                0x0A
  634. #define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
  635. #define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
  636. #define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
  637. #define ACPI_TYPE_BUFFER_FIELD          0x0E
  638. #define ACPI_TYPE_DDB_HANDLE            0x0F
  639. #define ACPI_TYPE_DEBUG_OBJECT          0x10
  640.  
  641. #define ACPI_TYPE_EXTERNAL_MAX          0x10
  642.  
  643. /*
  644.  * These are object types that do not map directly to the ACPI
  645.  * ObjectType() operator. They are used for various internal purposes only.
  646.  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
  647.  * internal types must move upwards. (There is code that depends on these
  648.  * values being contiguous with the external types above.)
  649.  */
  650. #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
  651. #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
  652. #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
  653. #define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
  654. #define ACPI_TYPE_LOCAL_ALIAS           0x15
  655. #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
  656. #define ACPI_TYPE_LOCAL_NOTIFY          0x17
  657. #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
  658. #define ACPI_TYPE_LOCAL_RESOURCE        0x19
  659. #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
  660. #define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
  661.  
  662. #define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
  663.  
  664. /*
  665.  * These are special object types that never appear in
  666.  * a Namespace node, only in an ACPI_OPERAND_OBJECT
  667.  */
  668. #define ACPI_TYPE_LOCAL_EXTRA           0x1C
  669. #define ACPI_TYPE_LOCAL_DATA            0x1D
  670.  
  671. #define ACPI_TYPE_LOCAL_MAX             0x1D
  672.  
  673. /* All types above here are invalid */
  674.  
  675. #define ACPI_TYPE_INVALID               0x1E
  676. #define ACPI_TYPE_NOT_FOUND             0xFF
  677.  
  678. #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
  679.  
  680.  
  681. /*
  682.  * All I/O
  683.  */
  684. #define ACPI_READ                       0
  685. #define ACPI_WRITE                      1
  686. #define ACPI_IO_MASK                    1
  687.  
  688. /*
  689.  * Event Types: Fixed & General Purpose
  690.  */
  691. typedef UINT32                          ACPI_EVENT_TYPE;
  692.  
  693. /*
  694.  * Fixed events
  695.  */
  696. #define ACPI_EVENT_PMTIMER              0
  697. #define ACPI_EVENT_GLOBAL               1
  698. #define ACPI_EVENT_POWER_BUTTON         2
  699. #define ACPI_EVENT_SLEEP_BUTTON         3
  700. #define ACPI_EVENT_RTC                  4
  701. #define ACPI_EVENT_MAX                  4
  702. #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
  703.  
  704. /*
  705.  * Event Status - Per event
  706.  * -------------
  707.  * The encoding of ACPI_EVENT_STATUS is illustrated below.
  708.  * Note that a set bit (1) indicates the property is TRUE
  709.  * (e.g. if bit 0 is set then the event is enabled).
  710.  * +-------------+-+-+-+
  711.  * |   Bits 31:3 |2|1|0|
  712.  * +-------------+-+-+-+
  713.  *          |     | | |
  714.  *          |     | | +- Enabled?
  715.  *          |     | +--- Enabled for wake?
  716.  *          |     +----- Set?
  717.  *          +----------- <Reserved>
  718.  */
  719. typedef UINT32                          ACPI_EVENT_STATUS;
  720.  
  721. #define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
  722. #define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
  723. #define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
  724. #define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
  725.  
  726. /*
  727.  * General Purpose Events (GPE)
  728.  */
  729. #define ACPI_GPE_INVALID                0xFF
  730. #define ACPI_GPE_MAX                    0xFF
  731. #define ACPI_NUM_GPE                    256
  732.  
  733. /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
  734.  
  735. #define ACPI_GPE_ENABLE                 0
  736. #define ACPI_GPE_DISABLE                1
  737. #define ACPI_GPE_CONDITIONAL_ENABLE     2
  738.  
  739. /*
  740.  * GPE info flags - Per GPE
  741.  * +-------+-+-+---+
  742.  * |  7:4  |3|2|1:0|
  743.  * +-------+-+-+---+
  744.  *     |    | |  |
  745.  *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
  746.  *     |    | +----- Interrupt type: edge or level triggered
  747.  *     |    +------- Is a Wake GPE
  748.  *     +------------ <Reserved>
  749.  */
  750. #define ACPI_GPE_DISPATCH_NONE          (UINT8) 0x00
  751. #define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x01
  752. #define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x02
  753. #define ACPI_GPE_DISPATCH_NOTIFY        (UINT8) 0x03
  754. #define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x03
  755.  
  756. #define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x04
  757. #define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
  758. #define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x04
  759.  
  760. #define ACPI_GPE_CAN_WAKE               (UINT8) 0x08
  761.  
  762. /*
  763.  * Flags for GPE and Lock interfaces
  764.  */
  765. #define ACPI_NOT_ISR                    0x1
  766. #define ACPI_ISR                        0x0
  767.  
  768.  
  769. /* Notify types */
  770.  
  771. #define ACPI_SYSTEM_NOTIFY              0x1
  772. #define ACPI_DEVICE_NOTIFY              0x2
  773. #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
  774. #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
  775.  
  776. #define ACPI_MAX_SYS_NOTIFY             0x7f
  777.  
  778.  
  779. /* Address Space (Operation Region) Types */
  780.  
  781. typedef UINT8                           ACPI_ADR_SPACE_TYPE;
  782.  
  783. #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
  784. #define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
  785. #define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
  786. #define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
  787. #define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
  788. #define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
  789. #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
  790. #define ACPI_ADR_SPACE_IPMI             (ACPI_ADR_SPACE_TYPE) 7
  791.  
  792. #define ACPI_NUM_PREDEFINED_REGIONS     8
  793.  
  794. /*
  795.  * Special Address Spaces
  796.  *
  797.  * Note: A Data Table region is a special type of operation region
  798.  * that has its own AML opcode. However, internally, the AML
  799.  * interpreter simply creates an operation region with an an address
  800.  * space type of ACPI_ADR_SPACE_DATA_TABLE.
  801.  */
  802. #define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
  803. #define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 0x7F
  804.  
  805. /* Values for _REG connection code */
  806.  
  807. #define ACPI_REG_DISCONNECT             0
  808. #define ACPI_REG_CONNECT                1
  809.  
  810. /*
  811.  * BitRegister IDs
  812.  *
  813.  * These values are intended to be used by the hardware interfaces
  814.  * and are mapped to individual bitfields defined within the ACPI
  815.  * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
  816.  * for this mapping.
  817.  */
  818.  
  819. /* PM1 Status register */
  820.  
  821. #define ACPI_BITREG_TIMER_STATUS                0x00
  822. #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
  823. #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
  824. #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
  825. #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
  826. #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
  827. #define ACPI_BITREG_WAKE_STATUS                 0x06
  828. #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
  829.  
  830. /* PM1 Enable register */
  831.  
  832. #define ACPI_BITREG_TIMER_ENABLE                0x08
  833. #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
  834. #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
  835. #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
  836. #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
  837. #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
  838.  
  839. /* PM1 Control register */
  840.  
  841. #define ACPI_BITREG_SCI_ENABLE                  0x0E
  842. #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
  843. #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
  844. #define ACPI_BITREG_SLEEP_TYPE                  0x11
  845. #define ACPI_BITREG_SLEEP_ENABLE                0x12
  846.  
  847. /* PM2 Control register */
  848.  
  849. #define ACPI_BITREG_ARB_DISABLE                 0x13
  850.  
  851. #define ACPI_BITREG_MAX                         0x13
  852. #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
  853.  
  854.  
  855. /* Status register values. A 1 clears a status bit. 0 = no effect */
  856.  
  857. #define ACPI_CLEAR_STATUS                       1
  858.  
  859. /* Enable and Control register values */
  860.  
  861. #define ACPI_ENABLE_EVENT                       1
  862. #define ACPI_DISABLE_EVENT                      0
  863.  
  864.  
  865. /*
  866.  * External ACPI object definition
  867.  */
  868.  
  869. /*
  870.  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
  871.  * or an unresolved named reference.
  872.  */
  873. typedef union acpi_object
  874. {
  875.     ACPI_OBJECT_TYPE                Type;   /* See definition of AcpiNsType for values */
  876.     struct
  877.     {
  878.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_INTEGER */
  879.         UINT64                          Value;      /* The actual number */
  880.     } Integer;
  881.  
  882.     struct
  883.     {
  884.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_STRING */
  885.         UINT32                          Length;     /* # of bytes in string, excluding trailing null */
  886.         char                            *Pointer;   /* points to the string value */
  887.     } String;
  888.  
  889.     struct
  890.     {
  891.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_BUFFER */
  892.         UINT32                          Length;     /* # of bytes in buffer */
  893.         UINT8                           *Pointer;   /* points to the buffer */
  894.     } Buffer;
  895.  
  896.     struct
  897.     {
  898.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PACKAGE */
  899.         UINT32                          Count;      /* # of elements in package */
  900.         union acpi_object               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
  901.     } Package;
  902.  
  903.     struct
  904.     {
  905.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_LOCAL_REFERENCE */
  906.         ACPI_OBJECT_TYPE                ActualType; /* Type associated with the Handle */
  907.         ACPI_HANDLE                     Handle;     /* object reference */
  908.     } Reference;
  909.  
  910.     struct
  911.     {
  912.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PROCESSOR */
  913.         UINT32                          ProcId;
  914.         ACPI_IO_ADDRESS                 PblkAddress;
  915.         UINT32                          PblkLength;
  916.     } Processor;
  917.  
  918.     struct
  919.     {
  920.         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_POWER */
  921.         UINT32                          SystemLevel;
  922.         UINT32                          ResourceOrder;
  923.     } PowerResource;
  924.  
  925. } ACPI_OBJECT;
  926.  
  927.  
  928. /*
  929.  * List of objects, used as a parameter list for control method evaluation
  930.  */
  931. typedef struct acpi_object_list
  932. {
  933.     UINT32                          Count;
  934.     ACPI_OBJECT                     *Pointer;
  935.  
  936. } ACPI_OBJECT_LIST;
  937.  
  938.  
  939. /*
  940.  * Miscellaneous common Data Structures used by the interfaces
  941.  */
  942. #define ACPI_NO_BUFFER              0
  943. #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
  944. #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
  945.  
  946. typedef struct acpi_buffer
  947. {
  948.     ACPI_SIZE                       Length;         /* Length in bytes of the buffer */
  949.     void                            *Pointer;       /* pointer to buffer */
  950.  
  951. } ACPI_BUFFER;
  952.  
  953.  
  954. /*
  955.  * NameType for AcpiGetName
  956.  */
  957. #define ACPI_FULL_PATHNAME              0
  958. #define ACPI_SINGLE_NAME                1
  959. #define ACPI_NAME_TYPE_MAX              1
  960.  
  961.  
  962. /*
  963.  * Predefined Namespace items
  964.  */
  965. typedef struct acpi_predefined_names
  966. {
  967.     char                            *Name;
  968.     UINT8                           Type;
  969.     char                            *Val;
  970.  
  971. } ACPI_PREDEFINED_NAMES;
  972.  
  973.  
  974. /*
  975.  * Structure and flags for AcpiGetSystemInfo
  976.  */
  977. #define ACPI_SYS_MODE_UNKNOWN           0x0000
  978. #define ACPI_SYS_MODE_ACPI              0x0001
  979. #define ACPI_SYS_MODE_LEGACY            0x0002
  980. #define ACPI_SYS_MODES_MASK             0x0003
  981.  
  982.  
  983. /*
  984.  * System info returned by AcpiGetSystemInfo()
  985.  */
  986. typedef struct acpi_system_info
  987. {
  988.     UINT32                          AcpiCaVersion;
  989.     UINT32                          Flags;
  990.     UINT32                          TimerResolution;
  991.     UINT32                          Reserved1;
  992.     UINT32                          Reserved2;
  993.     UINT32                          DebugLevel;
  994.     UINT32                          DebugLayer;
  995.  
  996. } ACPI_SYSTEM_INFO;
  997.  
  998.  
  999. /*
  1000.  * System statistics returned by AcpiGetStatistics()
  1001.  */
  1002. typedef struct acpi_statistics
  1003. {
  1004.     UINT32                          SciCount;
  1005.     UINT32                          GpeCount;
  1006.     UINT32                          FixedEventCount[ACPI_NUM_FIXED_EVENTS];
  1007.     UINT32                          MethodCount;
  1008.  
  1009. } ACPI_STATISTICS;
  1010.  
  1011.  
  1012. /* Table Event Types */
  1013.  
  1014. #define ACPI_TABLE_EVENT_LOAD           0x0
  1015. #define ACPI_TABLE_EVENT_UNLOAD         0x1
  1016. #define ACPI_NUM_TABLE_EVENTS           2
  1017.  
  1018.  
  1019. /*
  1020.  * Types specific to the OS service interfaces
  1021.  */
  1022. typedef UINT32
  1023. (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
  1024.     void                            *Context);
  1025.  
  1026. typedef void
  1027. (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
  1028.     void                            *Context);
  1029.  
  1030. /*
  1031.  * Various handlers and callback procedures
  1032.  */
  1033. typedef
  1034. void (*ACPI_GBL_EVENT_HANDLER) (
  1035.     UINT32                          EventType,
  1036.     ACPI_HANDLE                     Device,
  1037.     UINT32                          EventNumber,
  1038.     void                            *Context);
  1039.  
  1040. #define ACPI_EVENT_TYPE_GPE         0
  1041. #define ACPI_EVENT_TYPE_FIXED       1
  1042.  
  1043. typedef
  1044. UINT32 (*ACPI_EVENT_HANDLER) (
  1045.     void                            *Context);
  1046.  
  1047. typedef
  1048. UINT32 (*ACPI_GPE_HANDLER) (
  1049.     ACPI_HANDLE                     GpeDevice,
  1050.     UINT32                          GpeNumber,
  1051.     void                            *Context);
  1052.  
  1053. typedef
  1054. void (*ACPI_NOTIFY_HANDLER) (
  1055.     ACPI_HANDLE                     Device,
  1056.     UINT32                          Value,
  1057.     void                            *Context);
  1058.  
  1059. typedef
  1060. void (*ACPI_OBJECT_HANDLER) (
  1061.     ACPI_HANDLE                     Object,
  1062.     void                            *Data);
  1063.  
  1064. typedef
  1065. ACPI_STATUS (*ACPI_INIT_HANDLER) (
  1066.     ACPI_HANDLE                     Object,
  1067.     UINT32                          Function);
  1068.  
  1069. #define ACPI_INIT_DEVICE_INI        1
  1070.  
  1071. typedef
  1072. ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
  1073.     ACPI_STATUS                     AmlStatus,
  1074.     ACPI_NAME                       Name,
  1075.     UINT16                          Opcode,
  1076.     UINT32                          AmlOffset,
  1077.     void                            *Context);
  1078.  
  1079. /* Table Event handler (Load, LoadTable, etc.) and types */
  1080.  
  1081. typedef
  1082. ACPI_STATUS (*ACPI_TABLE_HANDLER) (
  1083.     UINT32                          Event,
  1084.     void                            *Table,
  1085.     void                            *Context);
  1086.  
  1087. #define ACPI_TABLE_LOAD             0x0
  1088. #define ACPI_TABLE_UNLOAD           0x1
  1089. #define ACPI_NUM_TABLE_EVENTS       2
  1090.  
  1091.  
  1092. /* Address Spaces (For Operation Regions) */
  1093.  
  1094. typedef
  1095. ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
  1096.     UINT32                          Function,
  1097.     ACPI_PHYSICAL_ADDRESS           Address,
  1098.     UINT32                          BitWidth,
  1099.     UINT64                          *Value,
  1100.     void                            *HandlerContext,
  1101.     void                            *RegionContext);
  1102.  
  1103. #define ACPI_DEFAULT_HANDLER            NULL
  1104.  
  1105. typedef
  1106. ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
  1107.     ACPI_HANDLE                     RegionHandle,
  1108.     UINT32                          Function,
  1109.     void                            *HandlerContext,
  1110.     void                            **RegionContext);
  1111.  
  1112. #define ACPI_REGION_ACTIVATE    0
  1113. #define ACPI_REGION_DEACTIVATE  1
  1114.  
  1115. typedef
  1116. ACPI_STATUS (*ACPI_WALK_CALLBACK) (
  1117.     ACPI_HANDLE                     Object,
  1118.     UINT32                          NestingLevel,
  1119.     void                            *Context,
  1120.     void                            **ReturnValue);
  1121.  
  1122. typedef
  1123. UINT32 (*ACPI_INTERFACE_HANDLER) (
  1124.     ACPI_STRING                     InterfaceName,
  1125.     UINT32                          Supported);
  1126.  
  1127.  
  1128. /* Interrupt handler return values */
  1129.  
  1130. #define ACPI_INTERRUPT_NOT_HANDLED      0x00
  1131. #define ACPI_INTERRUPT_HANDLED          0x01
  1132.  
  1133. /* GPE handler return values */
  1134.  
  1135. #define ACPI_REENABLE_GPE               0x80
  1136.  
  1137.  
  1138. /* Length of 32-bit EISAID values when converted back to a string */
  1139.  
  1140. #define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
  1141.  
  1142. /* Length of UUID (string) values */
  1143.  
  1144. #define ACPI_UUID_LENGTH                16
  1145.  
  1146.  
  1147. /* Structures used for device/processor HID, UID, CID */
  1148.  
  1149. typedef struct acpi_device_id
  1150. {
  1151.     UINT32                          Length;             /* Length of string + null */
  1152.     char                            *String;
  1153.  
  1154. } ACPI_DEVICE_ID;
  1155.  
  1156. typedef struct acpi_device_id_list
  1157. {
  1158.     UINT32                          Count;              /* Number of IDs in Ids array */
  1159.     UINT32                          ListSize;           /* Size of list, including ID strings */
  1160.     ACPI_DEVICE_ID                  Ids[1];             /* ID array */
  1161.  
  1162. } ACPI_DEVICE_ID_LIST;
  1163.  
  1164. /*
  1165.  * Structure returned from AcpiGetObjectInfo.
  1166.  * Optimized for both 32- and 64-bit builds
  1167.  */
  1168. typedef struct acpi_device_info
  1169. {
  1170.     UINT32                          InfoSize;           /* Size of info, including ID strings */
  1171.     UINT32                          Name;               /* ACPI object Name */
  1172.     ACPI_OBJECT_TYPE                Type;               /* ACPI object Type */
  1173.     UINT8                           ParamCount;         /* If a method, required parameter count */
  1174.     UINT8                           Valid;              /* Indicates which optional fields are valid */
  1175.     UINT8                           Flags;              /* Miscellaneous info */
  1176.     UINT8                           HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
  1177.     UINT8                           LowestDstates[5];   /* _SxW values: 0xFF indicates not valid */
  1178.     UINT32                          CurrentStatus;      /* _STA value */
  1179.     UINT64                          Address;            /* _ADR value */
  1180.     ACPI_DEVICE_ID                  HardwareId;         /* _HID value */
  1181.     ACPI_DEVICE_ID                  UniqueId;           /* _UID value */
  1182.     ACPI_DEVICE_ID_LIST             CompatibleIdList;   /* _CID list <must be last> */
  1183.  
  1184. } ACPI_DEVICE_INFO;
  1185.  
  1186. /* Values for Flags field above (AcpiGetObjectInfo) */
  1187.  
  1188. #define ACPI_PCI_ROOT_BRIDGE            0x01
  1189.  
  1190. /* Flags for Valid field above (AcpiGetObjectInfo) */
  1191.  
  1192. #define ACPI_VALID_STA                  0x01
  1193. #define ACPI_VALID_ADR                  0x02
  1194. #define ACPI_VALID_HID                  0x04
  1195. #define ACPI_VALID_UID                  0x08
  1196. #define ACPI_VALID_CID                  0x10
  1197. #define ACPI_VALID_SXDS                 0x20
  1198. #define ACPI_VALID_SXWS                 0x40
  1199.  
  1200. /* Flags for _STA method */
  1201.  
  1202. #define ACPI_STA_DEVICE_PRESENT         0x01
  1203. #define ACPI_STA_DEVICE_ENABLED         0x02
  1204. #define ACPI_STA_DEVICE_UI              0x04
  1205. #define ACPI_STA_DEVICE_FUNCTIONING     0x08
  1206. #define ACPI_STA_DEVICE_OK              0x08 /* Synonym */
  1207. #define ACPI_STA_BATTERY_PRESENT        0x10
  1208.  
  1209.  
  1210. /* Context structs for address space handlers */
  1211.  
  1212. typedef struct acpi_pci_id
  1213. {
  1214.     UINT16                          Segment;
  1215.     UINT16                          Bus;
  1216.     UINT16                          Device;
  1217.     UINT16                          Function;
  1218.  
  1219. } ACPI_PCI_ID;
  1220.  
  1221. typedef struct acpi_mem_space_context
  1222. {
  1223.     UINT32                          Length;
  1224.     ACPI_PHYSICAL_ADDRESS           Address;
  1225.     ACPI_PHYSICAL_ADDRESS           MappedPhysicalAddress;
  1226.     UINT8                           *MappedLogicalAddress;
  1227.     ACPI_SIZE                       MappedLength;
  1228.  
  1229. } ACPI_MEM_SPACE_CONTEXT;
  1230.  
  1231.  
  1232. /*
  1233.  * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
  1234.  */
  1235. typedef struct acpi_memory_list
  1236. {
  1237.     char                            *ListName;
  1238.     void                            *ListHead;
  1239.     UINT16                          ObjectSize;
  1240.     UINT16                          MaxDepth;
  1241.     UINT16                          CurrentDepth;
  1242.     UINT16                          LinkOffset;
  1243.  
  1244. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  1245.  
  1246.     /* Statistics for debug memory tracking only */
  1247.  
  1248.     UINT32                          TotalAllocated;
  1249.     UINT32                          TotalFreed;
  1250.     UINT32                          MaxOccupied;
  1251.     UINT32                          TotalSize;
  1252.     UINT32                          CurrentTotalSize;
  1253.     UINT32                          Requests;
  1254.     UINT32                          Hits;
  1255. #endif
  1256.  
  1257. } ACPI_MEMORY_LIST;
  1258.  
  1259.  
  1260. #endif /* __ACTYPES_H__ */
  1261.