RTEMS 6.1-rc6
Loading...
Searching...
No Matches
acconfig.h
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 - 2024, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#ifndef _ACCONFIG_H
153#define _ACCONFIG_H
154
155
156/******************************************************************************
157 *
158 * Configuration options
159 *
160 *****************************************************************************/
161
162/*
163 * ACPI_DEBUG_OUTPUT - This switch enables all the debug facilities of the
164 * ACPI subsystem. This includes the DEBUG_PRINT output
165 * statements. When disabled, all DEBUG_PRINT
166 * statements are compiled out.
167 *
168 * ACPI_APPLICATION - Use this switch if the subsystem is going to be run
169 * at the application level.
170 *
171 */
172
173/*
174 * OS name, used for the _OS object. The _OS object is essentially obsolete,
175 * but there is a large base of ASL/AML code in existing machines that check
176 * for the string below. The use of this string usually guarantees that
177 * the ASL will execute down the most tested code path. Also, there is some
178 * code that will not execute the _OSI method unless _OS matches the string
179 * below. Therefore, change this string at your own risk.
180 */
181#define ACPI_OS_NAME "Microsoft Windows NT"
182
183/* Maximum objects in the various object caches */
184
185#define ACPI_MAX_STATE_CACHE_DEPTH 96 /* State objects */
186#define ACPI_MAX_PARSE_CACHE_DEPTH 96 /* Parse tree objects */
187#define ACPI_MAX_EXTPARSE_CACHE_DEPTH 96 /* Parse tree objects */
188#define ACPI_MAX_OBJECT_CACHE_DEPTH 96 /* Interpreter operand objects */
189#define ACPI_MAX_NAMESPACE_CACHE_DEPTH 96 /* Namespace objects */
190#define ACPI_MAX_COMMENT_CACHE_DEPTH 96 /* Comments for the -ca option */
191
192/*
193 * Should the subsystem abort the loading of an ACPI table if the
194 * table checksum is incorrect?
195 */
196#ifndef ACPI_CHECKSUM_ABORT
197#define ACPI_CHECKSUM_ABORT FALSE
198#endif
199
200/*
201 * Generate a version of ACPICA that only supports "reduced hardware"
202 * platforms (as defined in ACPI 5.0). Set to TRUE to generate a specialized
203 * version of ACPICA that ONLY supports the ACPI 5.0 "reduced hardware"
204 * model. In other words, no ACPI hardware is supported.
205 *
206 * If TRUE, this means no support for the following:
207 * PM Event and Control registers
208 * SCI interrupt (and handler)
209 * Fixed Events
210 * General Purpose Events (GPEs)
211 * Global Lock
212 * ACPI PM timer
213 * FACS table (Waking vectors and Global Lock)
214 */
215#ifndef ACPI_REDUCED_HARDWARE
216#define ACPI_REDUCED_HARDWARE FALSE
217#endif
218
219
220/******************************************************************************
221 *
222 * Subsystem Constants
223 *
224 *****************************************************************************/
225
226/* Version of ACPI supported */
227
228#define ACPI_CA_SUPPORT_LEVEL 5
229
230/* Maximum count for a semaphore object */
231
232#define ACPI_MAX_SEMAPHORE_COUNT 256
233
234/* Maximum object reference count (detects object deletion issues) */
235
236#define ACPI_MAX_REFERENCE_COUNT 0x4000
237
238/* Default page size for use in mapping memory for operation regions */
239
240#define ACPI_DEFAULT_PAGE_SIZE 4096 /* Must be power of 2 */
241
242/* OwnerId tracking. 128 entries allows for 4095 OwnerIds */
243
244#define ACPI_NUM_OWNERID_MASKS 128
245
246/* Size of the root table array is increased by this increment */
247
248#define ACPI_ROOT_TABLE_SIZE_INCREMENT 4
249
250/* Maximum sleep allowed via Sleep() operator */
251
252#define ACPI_MAX_SLEEP 2000 /* 2000 millisec == two seconds */
253
254/* Address Range lists are per-SpaceId (Memory and I/O only) */
255
256#define ACPI_ADDRESS_RANGE_MAX 2
257
258/* Maximum time (default 30s) of While() loops before abort */
259
260#define ACPI_MAX_LOOP_TIMEOUT 30
261
262
263/******************************************************************************
264 *
265 * ACPI Specification constants (Do not change unless the specification changes)
266 *
267 *****************************************************************************/
268
269/* Method info (in WALK_STATE), containing local variables and arguments */
270
271#define ACPI_METHOD_NUM_LOCALS 8
272#define ACPI_METHOD_MAX_LOCAL 7
273
274#define ACPI_METHOD_NUM_ARGS 7
275#define ACPI_METHOD_MAX_ARG 6
276
277/*
278 * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
279 */
280#define ACPI_OBJ_NUM_OPERANDS 8
281#define ACPI_OBJ_MAX_OPERAND 7
282
283/* Number of elements in the Result Stack frame, can be an arbitrary value */
284
285#define ACPI_RESULTS_FRAME_OBJ_NUM 8
286
287/*
288 * Maximal number of elements the Result Stack can contain,
289 * it may be an arbitrary value not exceeding the types of
290 * ResultSize and ResultCount (now UINT8).
291 */
292#define ACPI_RESULTS_OBJ_NUM_MAX 255
293
294/* Constants used in searching for the RSDP in low memory */
295
296#define ACPI_EBDA_PTR_LOCATION 0x0000040E /* Physical Address */
297#define ACPI_EBDA_PTR_LENGTH 2
298#define ACPI_EBDA_WINDOW_SIZE 1024
299#define ACPI_HI_RSDP_WINDOW_BASE 0x000E0000 /* Physical Address */
300#define ACPI_HI_RSDP_WINDOW_SIZE 0x00020000
301#define ACPI_RSDP_SCAN_STEP 16
302
303/* Operation regions */
304
305#define ACPI_USER_REGION_BEGIN 0x80
306
307/* Maximum SpaceIds for Operation Regions */
308
309#define ACPI_MAX_ADDRESS_SPACE 255
310#define ACPI_NUM_DEFAULT_SPACES 4
311
312/* Array sizes. Used for range checking also */
313
314#define ACPI_MAX_MATCH_OPCODE 5
315
316/* RSDP checksums */
317
318#define ACPI_RSDP_CHECKSUM_LENGTH 20
319#define ACPI_RSDP_XCHECKSUM_LENGTH 36
320
321/*
322 * SMBus, GSBus and IPMI buffer sizes. All have a 2-byte header,
323 * containing both Status and Length.
324 */
325#define ACPI_SERIAL_HEADER_SIZE 2 /* Common for below. Status and Length fields */
326
327#define ACPI_SMBUS_DATA_SIZE 32
328#define ACPI_SMBUS_BUFFER_SIZE ACPI_SERIAL_HEADER_SIZE + ACPI_SMBUS_DATA_SIZE
329
330#define ACPI_IPMI_DATA_SIZE 64
331#define ACPI_IPMI_BUFFER_SIZE ACPI_SERIAL_HEADER_SIZE + ACPI_IPMI_DATA_SIZE
332
333#define ACPI_MAX_GSBUS_DATA_SIZE 255
334#define ACPI_MAX_GSBUS_BUFFER_SIZE ACPI_SERIAL_HEADER_SIZE + ACPI_MAX_GSBUS_DATA_SIZE
335
336#define ACPI_PRM_INPUT_BUFFER_SIZE 26
337
338#define ACPI_FFH_INPUT_BUFFER_SIZE 256
339
340/* _SxD and _SxW control methods */
341
342#define ACPI_NUM_SxD_METHODS 4
343#define ACPI_NUM_SxW_METHODS 5
344
345
346/******************************************************************************
347 *
348 * Miscellaneous constants
349 *
350 *****************************************************************************/
351
352/* UUID constants */
353
354#define UUID_BUFFER_LENGTH 16 /* Length of UUID in memory */
355#define UUID_STRING_LENGTH 36 /* Total length of a UUID string */
356
357/* Positions for required hyphens (dashes) in UUID strings */
358
359#define UUID_HYPHEN1_OFFSET 8
360#define UUID_HYPHEN2_OFFSET 13
361#define UUID_HYPHEN3_OFFSET 18
362#define UUID_HYPHEN4_OFFSET 23
363
364
365/******************************************************************************
366 *
367 * ACPI AML Debugger
368 *
369 *****************************************************************************/
370
371#define ACPI_DEBUGGER_MAX_ARGS ACPI_METHOD_NUM_ARGS + 4 /* Max command line arguments */
372#define ACPI_DB_LINE_BUFFER_SIZE 512
373
374#define ACPI_DEBUGGER_COMMAND_PROMPT '-'
375#define ACPI_DEBUGGER_EXECUTE_PROMPT '%'
376
377
378#endif /* _ACCONFIG_H */
Generated by doxygen 1.9.6