xref: /onnv-gate/usr/src/uts/intel/sys/acpi/acconfig.h (revision 11225:eb6056029d84)
10Sstevel@tonic-gate /******************************************************************************
20Sstevel@tonic-gate  *
30Sstevel@tonic-gate  * Name: acconfig.h - Global configuration constants
40Sstevel@tonic-gate  *
50Sstevel@tonic-gate  *****************************************************************************/
60Sstevel@tonic-gate 
70Sstevel@tonic-gate /******************************************************************************
80Sstevel@tonic-gate  *
90Sstevel@tonic-gate  * 1. Copyright Notice
100Sstevel@tonic-gate  *
119980SDana.Myers@Sun.COM  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
120Sstevel@tonic-gate  * All rights reserved.
130Sstevel@tonic-gate  *
140Sstevel@tonic-gate  * 2. License
150Sstevel@tonic-gate  *
160Sstevel@tonic-gate  * 2.1. This is your license from Intel Corp. under its intellectual property
170Sstevel@tonic-gate  * rights.  You may have additional license terms from the party that provided
180Sstevel@tonic-gate  * you this software, covering your right to use that party's intellectual
190Sstevel@tonic-gate  * property rights.
200Sstevel@tonic-gate  *
210Sstevel@tonic-gate  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
220Sstevel@tonic-gate  * copy of the source code appearing in this file ("Covered Code") an
230Sstevel@tonic-gate  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
240Sstevel@tonic-gate  * base code distributed originally by Intel ("Original Intel Code") to copy,
250Sstevel@tonic-gate  * make derivatives, distribute, use and display any portion of the Covered
260Sstevel@tonic-gate  * Code in any form, with the right to sublicense such rights; and
270Sstevel@tonic-gate  *
280Sstevel@tonic-gate  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
290Sstevel@tonic-gate  * license (with the right to sublicense), under only those claims of Intel
300Sstevel@tonic-gate  * patents that are infringed by the Original Intel Code, to make, use, sell,
310Sstevel@tonic-gate  * offer to sell, and import the Covered Code and derivative works thereof
320Sstevel@tonic-gate  * solely to the minimum extent necessary to exercise the above copyright
330Sstevel@tonic-gate  * license, and in no event shall the patent license extend to any additions
340Sstevel@tonic-gate  * to or modifications of the Original Intel Code.  No other license or right
350Sstevel@tonic-gate  * is granted directly or by implication, estoppel or otherwise;
360Sstevel@tonic-gate  *
370Sstevel@tonic-gate  * The above copyright and patent license is granted only if the following
380Sstevel@tonic-gate  * conditions are met:
390Sstevel@tonic-gate  *
400Sstevel@tonic-gate  * 3. Conditions
410Sstevel@tonic-gate  *
420Sstevel@tonic-gate  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
430Sstevel@tonic-gate  * Redistribution of source code of any substantial portion of the Covered
440Sstevel@tonic-gate  * Code or modification with rights to further distribute source must include
450Sstevel@tonic-gate  * the above Copyright Notice, the above License, this list of Conditions,
460Sstevel@tonic-gate  * and the following Disclaimer and Export Compliance provision.  In addition,
470Sstevel@tonic-gate  * Licensee must cause all Covered Code to which Licensee contributes to
480Sstevel@tonic-gate  * contain a file documenting the changes Licensee made to create that Covered
490Sstevel@tonic-gate  * Code and the date of any change.  Licensee must include in that file the
500Sstevel@tonic-gate  * documentation of any changes made by any predecessor Licensee.  Licensee
510Sstevel@tonic-gate  * must include a prominent statement that the modification is derived,
520Sstevel@tonic-gate  * directly or indirectly, from Original Intel Code.
530Sstevel@tonic-gate  *
540Sstevel@tonic-gate  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
550Sstevel@tonic-gate  * Redistribution of source code of any substantial portion of the Covered
560Sstevel@tonic-gate  * Code or modification without rights to further distribute source must
570Sstevel@tonic-gate  * include the following Disclaimer and Export Compliance provision in the
580Sstevel@tonic-gate  * documentation and/or other materials provided with distribution.  In
590Sstevel@tonic-gate  * addition, Licensee may not authorize further sublicense of source of any
600Sstevel@tonic-gate  * portion of the Covered Code, and must include terms to the effect that the
610Sstevel@tonic-gate  * license from Licensee to its licensee is limited to the intellectual
620Sstevel@tonic-gate  * property embodied in the software Licensee provides to its licensee, and
630Sstevel@tonic-gate  * not to intellectual property embodied in modifications its licensee may
640Sstevel@tonic-gate  * make.
650Sstevel@tonic-gate  *
660Sstevel@tonic-gate  * 3.3. Redistribution of Executable. Redistribution in executable form of any
670Sstevel@tonic-gate  * substantial portion of the Covered Code or modification must reproduce the
680Sstevel@tonic-gate  * above Copyright Notice, and the following Disclaimer and Export Compliance
690Sstevel@tonic-gate  * provision in the documentation and/or other materials provided with the
700Sstevel@tonic-gate  * distribution.
710Sstevel@tonic-gate  *
720Sstevel@tonic-gate  * 3.4. Intel retains all right, title, and interest in and to the Original
730Sstevel@tonic-gate  * Intel Code.
740Sstevel@tonic-gate  *
750Sstevel@tonic-gate  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
760Sstevel@tonic-gate  * Intel shall be used in advertising or otherwise to promote the sale, use or
770Sstevel@tonic-gate  * other dealings in products derived from or relating to the Covered Code
780Sstevel@tonic-gate  * without prior written authorization from Intel.
790Sstevel@tonic-gate  *
800Sstevel@tonic-gate  * 4. Disclaimer and Export Compliance
810Sstevel@tonic-gate  *
820Sstevel@tonic-gate  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
830Sstevel@tonic-gate  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
840Sstevel@tonic-gate  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
850Sstevel@tonic-gate  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
860Sstevel@tonic-gate  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
870Sstevel@tonic-gate  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
880Sstevel@tonic-gate  * PARTICULAR PURPOSE.
890Sstevel@tonic-gate  *
900Sstevel@tonic-gate  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
910Sstevel@tonic-gate  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
920Sstevel@tonic-gate  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
930Sstevel@tonic-gate  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
940Sstevel@tonic-gate  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
950Sstevel@tonic-gate  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
960Sstevel@tonic-gate  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
970Sstevel@tonic-gate  * LIMITED REMEDY.
980Sstevel@tonic-gate  *
990Sstevel@tonic-gate  * 4.3. Licensee shall not export, either directly or indirectly, any of this
1000Sstevel@tonic-gate  * software or system incorporating such software without first obtaining any
1010Sstevel@tonic-gate  * required license or other approval from the U. S. Department of Commerce or
1020Sstevel@tonic-gate  * any other agency or department of the United States Government.  In the
1030Sstevel@tonic-gate  * event Licensee exports any such software from the United States or
1040Sstevel@tonic-gate  * re-exports any such software from a foreign destination, Licensee shall
1050Sstevel@tonic-gate  * ensure that the distribution and export/re-export of the software is in
1060Sstevel@tonic-gate  * compliance with all laws, regulations, orders, or other restrictions of the
1070Sstevel@tonic-gate  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1080Sstevel@tonic-gate  * any of its subsidiaries will export/re-export any technical data, process,
1090Sstevel@tonic-gate  * software, or service, directly or indirectly, to any country for which the
1100Sstevel@tonic-gate  * United States government or any agency thereof requires an export license,
1110Sstevel@tonic-gate  * other governmental approval, or letter of assurance, without first obtaining
1120Sstevel@tonic-gate  * such license, approval or letter.
1130Sstevel@tonic-gate  *
1140Sstevel@tonic-gate  *****************************************************************************/
1150Sstevel@tonic-gate 
1160Sstevel@tonic-gate #ifndef _ACCONFIG_H
1170Sstevel@tonic-gate #define _ACCONFIG_H
1180Sstevel@tonic-gate 
1190Sstevel@tonic-gate 
1200Sstevel@tonic-gate /******************************************************************************
1210Sstevel@tonic-gate  *
1220Sstevel@tonic-gate  * Configuration options
1230Sstevel@tonic-gate  *
1240Sstevel@tonic-gate  *****************************************************************************/
1250Sstevel@tonic-gate 
1260Sstevel@tonic-gate /*
1270Sstevel@tonic-gate  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
1280Sstevel@tonic-gate  *                        ACPI subsystem.  This includes the DEBUG_PRINT output
1290Sstevel@tonic-gate  *                        statements.  When disabled, all DEBUG_PRINT
1300Sstevel@tonic-gate  *                        statements are compiled out.
1310Sstevel@tonic-gate  *
1320Sstevel@tonic-gate  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
1330Sstevel@tonic-gate  *                        at the application level.
1340Sstevel@tonic-gate  *
1350Sstevel@tonic-gate  */
1360Sstevel@tonic-gate 
1370Sstevel@tonic-gate /*
1380Sstevel@tonic-gate  * OS name, used for the _OS object.  The _OS object is essentially obsolete,
1390Sstevel@tonic-gate  * but there is a large base of ASL/AML code in existing machines that check
1400Sstevel@tonic-gate  * for the string below.  The use of this string usually guarantees that
1410Sstevel@tonic-gate  * the ASL will execute down the most tested code path.  Also, there is some
1420Sstevel@tonic-gate  * code that will not execute the _OSI method unless _OS matches the string
1430Sstevel@tonic-gate  * below.  Therefore, change this string at your own risk.
1440Sstevel@tonic-gate  */
1450Sstevel@tonic-gate #define ACPI_OS_NAME                    "Microsoft Windows NT"
1460Sstevel@tonic-gate 
1470Sstevel@tonic-gate /* Maximum objects in the various object caches */
1480Sstevel@tonic-gate 
149347Smyers #define ACPI_MAX_STATE_CACHE_DEPTH      96          /* State objects */
1500Sstevel@tonic-gate #define ACPI_MAX_PARSE_CACHE_DEPTH      96          /* Parse tree objects */
151347Smyers #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96          /* Parse tree objects */
152347Smyers #define ACPI_MAX_OBJECT_CACHE_DEPTH     96          /* Interpreter operand objects */
1532623Smyers #define ACPI_MAX_NAMESPACE_CACHE_DEPTH  96          /* Namespace objects */
1540Sstevel@tonic-gate 
1550Sstevel@tonic-gate /*
1561560Smyers  * Should the subsystem abort the loading of an ACPI table if the
1570Sstevel@tonic-gate  * table checksum is incorrect?
1580Sstevel@tonic-gate  */
1590Sstevel@tonic-gate #define ACPI_CHECKSUM_ABORT             FALSE
1600Sstevel@tonic-gate 
1610Sstevel@tonic-gate 
1620Sstevel@tonic-gate /******************************************************************************
1630Sstevel@tonic-gate  *
1640Sstevel@tonic-gate  * Subsystem Constants
1650Sstevel@tonic-gate  *
1660Sstevel@tonic-gate  *****************************************************************************/
1670Sstevel@tonic-gate 
1680Sstevel@tonic-gate /* Version of ACPI supported */
1690Sstevel@tonic-gate 
1700Sstevel@tonic-gate #define ACPI_CA_SUPPORT_LEVEL           3
1710Sstevel@tonic-gate 
1720Sstevel@tonic-gate /* Maximum count for a semaphore object */
1730Sstevel@tonic-gate 
1740Sstevel@tonic-gate #define ACPI_MAX_SEMAPHORE_COUNT        256
1750Sstevel@tonic-gate 
1762623Smyers /* Maximum object reference count (detects object deletion issues) */
1770Sstevel@tonic-gate 
1782623Smyers #define ACPI_MAX_REFERENCE_COUNT        0x800
1790Sstevel@tonic-gate 
180*11225SDana.Myers@Sun.COM /* Default page size for use in mapping memory for operation regions */
1810Sstevel@tonic-gate 
182*11225SDana.Myers@Sun.COM #define ACPI_DEFAULT_PAGE_SIZE          4096    /* Must be power of 2 */
1830Sstevel@tonic-gate 
1841560Smyers /* OwnerId tracking. 8 entries allows for 255 OwnerIds */
1851560Smyers 
1861560Smyers #define ACPI_NUM_OWNERID_MASKS          8
1871560Smyers 
1887851SDana.Myers@Sun.COM /* Size of the root table array is increased by this increment */
1897851SDana.Myers@Sun.COM 
1907851SDana.Myers@Sun.COM #define ACPI_ROOT_TABLE_SIZE_INCREMENT  4
1917851SDana.Myers@Sun.COM 
1929980SDana.Myers@Sun.COM /* Maximum number of While() loop iterations before forced abort */
1939980SDana.Myers@Sun.COM 
1949980SDana.Myers@Sun.COM #define ACPI_MAX_LOOP_ITERATIONS        0xFFFF
1959980SDana.Myers@Sun.COM 
1960Sstevel@tonic-gate 
1970Sstevel@tonic-gate /******************************************************************************
1980Sstevel@tonic-gate  *
1990Sstevel@tonic-gate  * ACPI Specification constants (Do not change unless the specification changes)
2000Sstevel@tonic-gate  *
2010Sstevel@tonic-gate  *****************************************************************************/
2020Sstevel@tonic-gate 
2030Sstevel@tonic-gate /* Method info (in WALK_STATE), containing local variables and argumetns */
2040Sstevel@tonic-gate 
2050Sstevel@tonic-gate #define ACPI_METHOD_NUM_LOCALS          8
2060Sstevel@tonic-gate #define ACPI_METHOD_MAX_LOCAL           7
2070Sstevel@tonic-gate 
2080Sstevel@tonic-gate #define ACPI_METHOD_NUM_ARGS            7
2090Sstevel@tonic-gate #define ACPI_METHOD_MAX_ARG             6
2100Sstevel@tonic-gate 
2110Sstevel@tonic-gate /*
2120Sstevel@tonic-gate  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
2130Sstevel@tonic-gate  */
2140Sstevel@tonic-gate #define ACPI_OBJ_NUM_OPERANDS           8
2150Sstevel@tonic-gate #define ACPI_OBJ_MAX_OPERAND            7
2160Sstevel@tonic-gate 
2177851SDana.Myers@Sun.COM /* Number of elements in the Result Stack frame, can be an arbitrary value */
2187851SDana.Myers@Sun.COM 
2197851SDana.Myers@Sun.COM #define ACPI_RESULTS_FRAME_OBJ_NUM      8
2207851SDana.Myers@Sun.COM 
2217851SDana.Myers@Sun.COM /*
2227851SDana.Myers@Sun.COM  * Maximal number of elements the Result Stack can contain,
2237851SDana.Myers@Sun.COM  * it may be an arbitray value not exceeding the types of
2247851SDana.Myers@Sun.COM  * ResultSize and ResultCount (now UINT8).
2257851SDana.Myers@Sun.COM  */
2267851SDana.Myers@Sun.COM #define ACPI_RESULTS_OBJ_NUM_MAX        255
2277851SDana.Myers@Sun.COM 
2280Sstevel@tonic-gate /* Constants used in searching for the RSDP in low memory */
2290Sstevel@tonic-gate 
2300Sstevel@tonic-gate #define ACPI_EBDA_PTR_LOCATION          0x0000040E     /* Physical Address */
2310Sstevel@tonic-gate #define ACPI_EBDA_PTR_LENGTH            2
2320Sstevel@tonic-gate #define ACPI_EBDA_WINDOW_SIZE           1024
2330Sstevel@tonic-gate #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000     /* Physical Address */
2340Sstevel@tonic-gate #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
2350Sstevel@tonic-gate #define ACPI_RSDP_SCAN_STEP             16
2360Sstevel@tonic-gate 
2370Sstevel@tonic-gate /* Operation regions */
2380Sstevel@tonic-gate 
239*11225SDana.Myers@Sun.COM #define ACPI_NUM_PREDEFINED_REGIONS     9
2400Sstevel@tonic-gate #define ACPI_USER_REGION_BEGIN          0x80
2410Sstevel@tonic-gate 
2420Sstevel@tonic-gate /* Maximum SpaceIds for Operation Regions */
2430Sstevel@tonic-gate 
2440Sstevel@tonic-gate #define ACPI_MAX_ADDRESS_SPACE          255
2450Sstevel@tonic-gate 
2460Sstevel@tonic-gate /* Array sizes.  Used for range checking also */
2470Sstevel@tonic-gate 
2482623Smyers #define ACPI_MAX_MATCH_OPCODE           5
2490Sstevel@tonic-gate 
2500Sstevel@tonic-gate /* RSDP checksums */
2510Sstevel@tonic-gate 
2520Sstevel@tonic-gate #define ACPI_RSDP_CHECKSUM_LENGTH       20
2530Sstevel@tonic-gate #define ACPI_RSDP_XCHECKSUM_LENGTH      36
2540Sstevel@tonic-gate 
255*11225SDana.Myers@Sun.COM /* SMBus and IPMI bidirectional buffer size */
2560Sstevel@tonic-gate 
2570Sstevel@tonic-gate #define ACPI_SMBUS_BUFFER_SIZE          34
258*11225SDana.Myers@Sun.COM #define ACPI_IPMI_BUFFER_SIZE           66
259*11225SDana.Myers@Sun.COM 
260*11225SDana.Myers@Sun.COM /* _SxD and _SxW control methods */
261*11225SDana.Myers@Sun.COM 
262*11225SDana.Myers@Sun.COM #define ACPI_NUM_SxD_METHODS            4
263*11225SDana.Myers@Sun.COM #define ACPI_NUM_SxW_METHODS            5
2640Sstevel@tonic-gate 
2650Sstevel@tonic-gate 
2660Sstevel@tonic-gate /******************************************************************************
2670Sstevel@tonic-gate  *
2680Sstevel@tonic-gate  * ACPI AML Debugger
2690Sstevel@tonic-gate  *
2700Sstevel@tonic-gate  *****************************************************************************/
2710Sstevel@tonic-gate 
2720Sstevel@tonic-gate #define ACPI_DEBUGGER_MAX_ARGS          8  /* Must be max method args + 1 */
2730Sstevel@tonic-gate 
2740Sstevel@tonic-gate #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
2750Sstevel@tonic-gate #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
2760Sstevel@tonic-gate 
2770Sstevel@tonic-gate 
2780Sstevel@tonic-gate #endif /* _ACCONFIG_H */
2790Sstevel@tonic-gate 
280