xref: /openbmc/linux/include/acpi/acconfig.h (revision 5d0e4d78)
1 /******************************************************************************
2  *
3  * Name: acconfig.h - Global configuration constants
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2017, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef _ACCONFIG_H
45 #define _ACCONFIG_H
46 
47 /******************************************************************************
48  *
49  * Configuration options
50  *
51  *****************************************************************************/
52 
53 /*
54  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
55  *                        ACPI subsystem.  This includes the DEBUG_PRINT output
56  *                        statements.  When disabled, all DEBUG_PRINT
57  *                        statements are compiled out.
58  *
59  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
60  *                        at the application level.
61  *
62  */
63 
64 /*
65  * OS name, used for the _OS object.  The _OS object is essentially obsolete,
66  * but there is a large base of ASL/AML code in existing machines that check
67  * for the string below.  The use of this string usually guarantees that
68  * the ASL will execute down the most tested code path.  Also, there is some
69  * code that will not execute the _OSI method unless _OS matches the string
70  * below.  Therefore, change this string at your own risk.
71  */
72 #define ACPI_OS_NAME                    "Microsoft Windows NT"
73 
74 /* Maximum objects in the various object caches */
75 
76 #define ACPI_MAX_STATE_CACHE_DEPTH      96	/* State objects */
77 #define ACPI_MAX_PARSE_CACHE_DEPTH      96	/* Parse tree objects */
78 #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96	/* Parse tree objects */
79 #define ACPI_MAX_OBJECT_CACHE_DEPTH     96	/* Interpreter operand objects */
80 #define ACPI_MAX_NAMESPACE_CACHE_DEPTH  96	/* Namespace objects */
81 #define ACPI_MAX_COMMENT_CACHE_DEPTH    96	/* Comments for the -ca option */
82 
83 /*
84  * Should the subsystem abort the loading of an ACPI table if the
85  * table checksum is incorrect?
86  */
87 #ifndef ACPI_CHECKSUM_ABORT
88 #define ACPI_CHECKSUM_ABORT             FALSE
89 #endif
90 
91 /*
92  * Generate a version of ACPICA that only supports "reduced hardware"
93  * platforms (as defined in ACPI 5.0). Set to TRUE to generate a specialized
94  * version of ACPICA that ONLY supports the ACPI 5.0 "reduced hardware"
95  * model. In other words, no ACPI hardware is supported.
96  *
97  * If TRUE, this means no support for the following:
98  *      PM Event and Control registers
99  *      SCI interrupt (and handler)
100  *      Fixed Events
101  *      General Purpose Events (GPEs)
102  *      Global Lock
103  *      ACPI PM timer
104  *      FACS table (Waking vectors and Global Lock)
105  */
106 #ifndef ACPI_REDUCED_HARDWARE
107 #define ACPI_REDUCED_HARDWARE           FALSE
108 #endif
109 
110 /******************************************************************************
111  *
112  * Subsystem Constants
113  *
114  *****************************************************************************/
115 
116 /* Version of ACPI supported */
117 
118 #define ACPI_CA_SUPPORT_LEVEL           5
119 
120 /* Maximum count for a semaphore object */
121 
122 #define ACPI_MAX_SEMAPHORE_COUNT        256
123 
124 /* Maximum object reference count (detects object deletion issues) */
125 
126 #define ACPI_MAX_REFERENCE_COUNT        0x1000
127 
128 /* Default page size for use in mapping memory for operation regions */
129 
130 #define ACPI_DEFAULT_PAGE_SIZE          4096	/* Must be power of 2 */
131 
132 /* owner_id tracking. 8 entries allows for 255 owner_ids */
133 
134 #define ACPI_NUM_OWNERID_MASKS          8
135 
136 /* Size of the root table array is increased by this increment */
137 
138 #define ACPI_ROOT_TABLE_SIZE_INCREMENT  4
139 
140 /* Maximum sleep allowed via Sleep() operator */
141 
142 #define ACPI_MAX_SLEEP                  2000	/* 2000 millisec == two seconds */
143 
144 /* Address Range lists are per-space_id (Memory and I/O only) */
145 
146 #define ACPI_ADDRESS_RANGE_MAX          2
147 
148 /* Maximum number of While() loops before abort */
149 
150 #define ACPI_MAX_LOOP_COUNT             0x000FFFFF
151 
152 /******************************************************************************
153  *
154  * ACPI Specification constants (Do not change unless the specification changes)
155  *
156  *****************************************************************************/
157 
158 /* Method info (in WALK_STATE), containing local variables and argumetns */
159 
160 #define ACPI_METHOD_NUM_LOCALS          8
161 #define ACPI_METHOD_MAX_LOCAL           7
162 
163 #define ACPI_METHOD_NUM_ARGS            7
164 #define ACPI_METHOD_MAX_ARG             6
165 
166 /*
167  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
168  */
169 #define ACPI_OBJ_NUM_OPERANDS           8
170 #define ACPI_OBJ_MAX_OPERAND            7
171 
172 /* Number of elements in the Result Stack frame, can be an arbitrary value */
173 
174 #define ACPI_RESULTS_FRAME_OBJ_NUM      8
175 
176 /*
177  * Maximal number of elements the Result Stack can contain,
178  * it may be an arbitray value not exceeding the types of
179  * result_size and result_count (now u8).
180  */
181 #define ACPI_RESULTS_OBJ_NUM_MAX        255
182 
183 /* Constants used in searching for the RSDP in low memory */
184 
185 #define ACPI_EBDA_PTR_LOCATION          0x0000040E	/* Physical Address */
186 #define ACPI_EBDA_PTR_LENGTH            2
187 #define ACPI_EBDA_WINDOW_SIZE           1024
188 #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000	/* Physical Address */
189 #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
190 #define ACPI_RSDP_SCAN_STEP             16
191 
192 /* Operation regions */
193 
194 #define ACPI_USER_REGION_BEGIN          0x80
195 
196 /* Maximum space_ids for Operation Regions */
197 
198 #define ACPI_MAX_ADDRESS_SPACE          255
199 #define ACPI_NUM_DEFAULT_SPACES         4
200 
201 /* Array sizes.  Used for range checking also */
202 
203 #define ACPI_MAX_MATCH_OPCODE           5
204 
205 /* RSDP checksums */
206 
207 #define ACPI_RSDP_CHECKSUM_LENGTH       20
208 #define ACPI_RSDP_XCHECKSUM_LENGTH      36
209 
210 /* SMBus, GSBus and IPMI bidirectional buffer size */
211 
212 #define ACPI_SMBUS_BUFFER_SIZE          34
213 #define ACPI_GSBUS_BUFFER_SIZE          34
214 #define ACPI_IPMI_BUFFER_SIZE           66
215 
216 /* _sx_d and _sx_w control methods */
217 
218 #define ACPI_NUM_sx_d_METHODS           4
219 #define ACPI_NUM_sx_w_METHODS           5
220 
221 /******************************************************************************
222  *
223  * Miscellaneous constants
224  *
225  *****************************************************************************/
226 
227 /* UUID constants */
228 
229 #define UUID_BUFFER_LENGTH          16	/* Length of UUID in memory */
230 #define UUID_STRING_LENGTH          36	/* Total length of a UUID string */
231 
232 /* Positions for required hyphens (dashes) in UUID strings */
233 
234 #define UUID_HYPHEN1_OFFSET         8
235 #define UUID_HYPHEN2_OFFSET         13
236 #define UUID_HYPHEN3_OFFSET         18
237 #define UUID_HYPHEN4_OFFSET         23
238 
239 /******************************************************************************
240  *
241  * ACPI AML Debugger
242  *
243  *****************************************************************************/
244 
245 #define ACPI_DEBUGGER_MAX_ARGS          ACPI_METHOD_NUM_ARGS + 4	/* Max command line arguments */
246 #define ACPI_DB_LINE_BUFFER_SIZE        512
247 
248 #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
249 #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
250 
251 #endif				/* _ACCONFIG_H */
252