xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acconfig.h (revision dd51520e127b452179a2ce4ea3bd8dee949f9afe)
1 /******************************************************************************
2  *
3  * Name: acconfig.h - Global configuration constants
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2009, 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 _ACCONFIG_H
117 #define _ACCONFIG_H
118 
119 
120 /******************************************************************************
121  *
122  * Configuration options
123  *
124  *****************************************************************************/
125 
126 /*
127  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
128  *                        ACPI subsystem.  This includes the DEBUG_PRINT output
129  *                        statements.  When disabled, all DEBUG_PRINT
130  *                        statements are compiled out.
131  *
132  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
133  *                        at the application level.
134  *
135  */
136 
137 /*
138  * OS name, used for the _OS object.  The _OS object is essentially obsolete,
139  * but there is a large base of ASL/AML code in existing machines that check
140  * for the string below.  The use of this string usually guarantees that
141  * the ASL will execute down the most tested code path.  Also, there is some
142  * code that will not execute the _OSI method unless _OS matches the string
143  * below.  Therefore, change this string at your own risk.
144  */
145 #define ACPI_OS_NAME                    "Microsoft Windows NT"
146 
147 /* Maximum objects in the various object caches */
148 
149 #define ACPI_MAX_STATE_CACHE_DEPTH      96          /* State objects */
150 #define ACPI_MAX_PARSE_CACHE_DEPTH      96          /* Parse tree objects */
151 #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96          /* Parse tree objects */
152 #define ACPI_MAX_OBJECT_CACHE_DEPTH     96          /* Interpreter operand objects */
153 #define ACPI_MAX_NAMESPACE_CACHE_DEPTH  96          /* Namespace objects */
154 
155 /*
156  * Should the subsystem abort the loading of an ACPI table if the
157  * table checksum is incorrect?
158  */
159 #define ACPI_CHECKSUM_ABORT             FALSE
160 
161 
162 /******************************************************************************
163  *
164  * Subsystem Constants
165  *
166  *****************************************************************************/
167 
168 /* Version of ACPI supported */
169 
170 #define ACPI_CA_SUPPORT_LEVEL           3
171 
172 /* Maximum count for a semaphore object */
173 
174 #define ACPI_MAX_SEMAPHORE_COUNT        256
175 
176 /* Maximum object reference count (detects object deletion issues) */
177 
178 #define ACPI_MAX_REFERENCE_COUNT        0x800
179 
180 /* Default page size for use in mapping memory for operation regions */
181 
182 #define ACPI_DEFAULT_PAGE_SIZE          4096    /* Must be power of 2 */
183 
184 /* OwnerId tracking. 8 entries allows for 255 OwnerIds */
185 
186 #define ACPI_NUM_OWNERID_MASKS          8
187 
188 /* Size of the root table array is increased by this increment */
189 
190 #define ACPI_ROOT_TABLE_SIZE_INCREMENT  4
191 
192 /* Maximum number of While() loop iterations before forced abort */
193 
194 #define ACPI_MAX_LOOP_ITERATIONS        0xFFFF
195 
196 
197 /******************************************************************************
198  *
199  * ACPI Specification constants (Do not change unless the specification changes)
200  *
201  *****************************************************************************/
202 
203 /* Method info (in WALK_STATE), containing local variables and argumetns */
204 
205 #define ACPI_METHOD_NUM_LOCALS          8
206 #define ACPI_METHOD_MAX_LOCAL           7
207 
208 #define ACPI_METHOD_NUM_ARGS            7
209 #define ACPI_METHOD_MAX_ARG             6
210 
211 /*
212  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
213  */
214 #define ACPI_OBJ_NUM_OPERANDS           8
215 #define ACPI_OBJ_MAX_OPERAND            7
216 
217 /* Number of elements in the Result Stack frame, can be an arbitrary value */
218 
219 #define ACPI_RESULTS_FRAME_OBJ_NUM      8
220 
221 /*
222  * Maximal number of elements the Result Stack can contain,
223  * it may be an arbitray value not exceeding the types of
224  * ResultSize and ResultCount (now UINT8).
225  */
226 #define ACPI_RESULTS_OBJ_NUM_MAX        255
227 
228 /* Constants used in searching for the RSDP in low memory */
229 
230 #define ACPI_EBDA_PTR_LOCATION          0x0000040E     /* Physical Address */
231 #define ACPI_EBDA_PTR_LENGTH            2
232 #define ACPI_EBDA_WINDOW_SIZE           1024
233 #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000     /* Physical Address */
234 #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
235 #define ACPI_RSDP_SCAN_STEP             16
236 
237 /* Operation regions */
238 
239 #define ACPI_NUM_PREDEFINED_REGIONS     9
240 #define ACPI_USER_REGION_BEGIN          0x80
241 
242 /* Maximum SpaceIds for Operation Regions */
243 
244 #define ACPI_MAX_ADDRESS_SPACE          255
245 
246 /* Array sizes.  Used for range checking also */
247 
248 #define ACPI_MAX_MATCH_OPCODE           5
249 
250 /* RSDP checksums */
251 
252 #define ACPI_RSDP_CHECKSUM_LENGTH       20
253 #define ACPI_RSDP_XCHECKSUM_LENGTH      36
254 
255 /* SMBus and IPMI bidirectional buffer size */
256 
257 #define ACPI_SMBUS_BUFFER_SIZE          34
258 #define ACPI_IPMI_BUFFER_SIZE           66
259 
260 /* _SxD and _SxW control methods */
261 
262 #define ACPI_NUM_SxD_METHODS            4
263 #define ACPI_NUM_SxW_METHODS            5
264 
265 
266 /******************************************************************************
267  *
268  * ACPI AML Debugger
269  *
270  *****************************************************************************/
271 
272 #define ACPI_DEBUGGER_MAX_ARGS          8  /* Must be max method args + 1 */
273 
274 #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
275 #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
276 
277 
278 #endif /* _ACCONFIG_H */
279 
280