xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acconfig.h (revision a07094369b21309434206d9b3601d162693466fc)
1 /******************************************************************************
2  *
3  * Name: acconfig.h - Global configuration constants
4  *       $Revision: 1.193 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government.  In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 
117 #ifndef _ACCONFIG_H
118 #define _ACCONFIG_H
119 
120 
121 /******************************************************************************
122  *
123  * Configuration options
124  *
125  *****************************************************************************/
126 
127 /*
128  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
129  *                        ACPI subsystem.  This includes the DEBUG_PRINT output
130  *                        statements.  When disabled, all DEBUG_PRINT
131  *                        statements are compiled out.
132  *
133  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
134  *                        at the application level.
135  *
136  */
137 
138 /* Current ACPICA subsystem version in YYYYMMDD format */
139 
140 #define ACPI_CA_VERSION                 0x20050930
141 
142 /*
143  * OS name, used for the _OS object.  The _OS object is essentially obsolete,
144  * but there is a large base of ASL/AML code in existing machines that check
145  * for the string below.  The use of this string usually guarantees that
146  * the ASL will execute down the most tested code path.  Also, there is some
147  * code that will not execute the _OSI method unless _OS matches the string
148  * below.  Therefore, change this string at your own risk.
149  */
150 #define ACPI_OS_NAME                    "Microsoft Windows NT"
151 
152 /* Maximum objects in the various object caches */
153 
154 #define ACPI_MAX_STATE_CACHE_DEPTH      96          /* State objects */
155 #define ACPI_MAX_PARSE_CACHE_DEPTH      96          /* Parse tree objects */
156 #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96          /* Parse tree objects */
157 #define ACPI_MAX_OBJECT_CACHE_DEPTH     96          /* Interpreter operand objects */
158 
159 /*
160  * Should the subystem abort the loading of an ACPI table if the
161  * table checksum is incorrect?
162  */
163 #define ACPI_CHECKSUM_ABORT             FALSE
164 
165 
166 /******************************************************************************
167  *
168  * Subsystem Constants
169  *
170  *****************************************************************************/
171 
172 /* Version of ACPI supported */
173 
174 #define ACPI_CA_SUPPORT_LEVEL           3
175 
176 /* String size constants */
177 
178 #define ACPI_MAX_STRING_LENGTH          512
179 #define ACPI_PATHNAME_MAX               256         /* A full namespace pathname */
180 
181 /* Maximum count for a semaphore object */
182 
183 #define ACPI_MAX_SEMAPHORE_COUNT        256
184 
185 /* Max reference count (for debug only) */
186 
187 #define ACPI_MAX_REFERENCE_COUNT        0x400
188 
189 /* Size of cached memory mapping for system memory operation region */
190 
191 #define ACPI_SYSMEM_REGION_WINDOW_SIZE  4096
192 
193 
194 /******************************************************************************
195  *
196  * ACPI Specification constants (Do not change unless the specification changes)
197  *
198  *****************************************************************************/
199 
200 /* Number of distinct GPE register blocks and register width */
201 
202 #define ACPI_MAX_GPE_BLOCKS             2
203 #define ACPI_GPE_REGISTER_WIDTH         8
204 
205 /* Method info (in WALK_STATE), containing local variables and argumetns */
206 
207 #define ACPI_METHOD_NUM_LOCALS          8
208 #define ACPI_METHOD_MAX_LOCAL           7
209 
210 #define ACPI_METHOD_NUM_ARGS            7
211 #define ACPI_METHOD_MAX_ARG             6
212 
213 /* Maximum length of resulting string when converting from a buffer */
214 
215 #define ACPI_MAX_STRING_CONVERSION      200
216 
217 /* Length of _HID, _UID, and _CID values */
218 
219 #define ACPI_DEVICE_ID_LENGTH           0x09
220 #define ACPI_MAX_CID_LENGTH             48
221 
222 /*
223  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
224  */
225 #define ACPI_OBJ_NUM_OPERANDS           8
226 #define ACPI_OBJ_MAX_OPERAND            7
227 
228 /* Names within the namespace are 4 bytes long */
229 
230 #define ACPI_NAME_SIZE                  4
231 #define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
232 #define ACPI_PATH_SEPARATOR             '.'
233 
234 /* Constants used in searching for the RSDP in low memory */
235 
236 #define ACPI_EBDA_PTR_LOCATION          0x0000040E     /* Physical Address */
237 #define ACPI_EBDA_PTR_LENGTH            2
238 #define ACPI_EBDA_WINDOW_SIZE           1024
239 #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000     /* Physical Address */
240 #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
241 #define ACPI_RSDP_SCAN_STEP             16
242 
243 /* Operation regions */
244 
245 #define ACPI_NUM_PREDEFINED_REGIONS     8
246 #define ACPI_USER_REGION_BEGIN          0x80
247 
248 /* Maximum SpaceIds for Operation Regions */
249 
250 #define ACPI_MAX_ADDRESS_SPACE          255
251 
252 /* Array sizes.  Used for range checking also */
253 
254 #define ACPI_NUM_ACCESS_TYPES           6
255 #define ACPI_NUM_UPDATE_RULES           3
256 #define ACPI_NUM_LOCK_RULES             2
257 #define ACPI_NUM_MATCH_OPS              6
258 #define ACPI_NUM_OPCODES                256
259 #define ACPI_NUM_FIELD_NAMES            2
260 
261 /* RSDP checksums */
262 
263 #define ACPI_RSDP_CHECKSUM_LENGTH       20
264 #define ACPI_RSDP_XCHECKSUM_LENGTH      36
265 
266 /* SMBus bidirectional buffer size */
267 
268 #define ACPI_SMBUS_BUFFER_SIZE          34
269 
270 /* Number of strings associated with the _OSI reserved method */
271 
272 #define ACPI_NUM_OSI_STRINGS            10
273 
274 
275 /******************************************************************************
276  *
277  * ACPI AML Debugger
278  *
279  *****************************************************************************/
280 
281 #define ACPI_DEBUGGER_MAX_ARGS          8  /* Must be max method args + 1 */
282 
283 #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
284 #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
285 
286 
287 #endif /* _ACCONFIG_H */
288 
289