Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:23:41

0001 /******************************************************************************
0002  *
0003  * Name: acconfig.h - Global configuration constants
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151 
0152 #ifndef _ACCONFIG_H
0153 #define _ACCONFIG_H
0154 
0155 
0156 /******************************************************************************
0157  *
0158  * Configuration options
0159  *
0160  *****************************************************************************/
0161 
0162 /*
0163  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
0164  *                        ACPI subsystem. This includes the DEBUG_PRINT output
0165  *                        statements. When disabled, all DEBUG_PRINT
0166  *                        statements are compiled out.
0167  *
0168  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
0169  *                        at the application level.
0170  *
0171  */
0172 
0173 /*
0174  * OS name, used for the _OS object. The _OS object is essentially obsolete,
0175  * but there is a large base of ASL/AML code in existing machines that check
0176  * for the string below. The use of this string usually guarantees that
0177  * the ASL will execute down the most tested code path. Also, there is some
0178  * code that will not execute the _OSI method unless _OS matches the string
0179  * below. Therefore, change this string at your own risk.
0180  */
0181 #define ACPI_OS_NAME                    "Microsoft Windows NT"
0182 
0183 /* Maximum objects in the various object caches */
0184 
0185 #define ACPI_MAX_STATE_CACHE_DEPTH      96          /* State objects */
0186 #define ACPI_MAX_PARSE_CACHE_DEPTH      96          /* Parse tree objects */
0187 #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96          /* Parse tree objects */
0188 #define ACPI_MAX_OBJECT_CACHE_DEPTH     96          /* Interpreter operand objects */
0189 #define ACPI_MAX_NAMESPACE_CACHE_DEPTH  96          /* Namespace objects */
0190 #define ACPI_MAX_COMMENT_CACHE_DEPTH    96          /* Comments for the -ca option */
0191 
0192 /*
0193  * Should the subsystem abort the loading of an ACPI table if the
0194  * table checksum is incorrect?
0195  */
0196 #ifndef ACPI_CHECKSUM_ABORT
0197 #define ACPI_CHECKSUM_ABORT             FALSE
0198 #endif
0199 
0200 /*
0201  * Generate a version of ACPICA that only supports "reduced hardware"
0202  * platforms (as defined in ACPI 5.0). Set to TRUE to generate a specialized
0203  * version of ACPICA that ONLY supports the ACPI 5.0 "reduced hardware"
0204  * model. In other words, no ACPI hardware is supported.
0205  *
0206  * If TRUE, this means no support for the following:
0207  *      PM Event and Control registers
0208  *      SCI interrupt (and handler)
0209  *      Fixed Events
0210  *      General Purpose Events (GPEs)
0211  *      Global Lock
0212  *      ACPI PM timer
0213  *      FACS table (Waking vectors and Global Lock)
0214  */
0215 #ifndef ACPI_REDUCED_HARDWARE
0216 #define ACPI_REDUCED_HARDWARE           FALSE
0217 #endif
0218 
0219 
0220 /******************************************************************************
0221  *
0222  * Subsystem Constants
0223  *
0224  *****************************************************************************/
0225 
0226 /* Version of ACPI supported */
0227 
0228 #define ACPI_CA_SUPPORT_LEVEL           5
0229 
0230 /* Maximum count for a semaphore object */
0231 
0232 #define ACPI_MAX_SEMAPHORE_COUNT        256
0233 
0234 /* Maximum object reference count (detects object deletion issues) */
0235 
0236 #define ACPI_MAX_REFERENCE_COUNT        0x4000
0237 
0238 /* Default page size for use in mapping memory for operation regions */
0239 
0240 #define ACPI_DEFAULT_PAGE_SIZE          4096    /* Must be power of 2 */
0241 
0242 /* OwnerId tracking. 128 entries allows for 4095 OwnerIds */
0243 
0244 #define ACPI_NUM_OWNERID_MASKS          128
0245 
0246 /* Size of the root table array is increased by this increment */
0247 
0248 #define ACPI_ROOT_TABLE_SIZE_INCREMENT  4
0249 
0250 /* Maximum sleep allowed via Sleep() operator */
0251 
0252 #define ACPI_MAX_SLEEP                  2000    /* 2000 millisec == two seconds */
0253 
0254 /* Address Range lists are per-SpaceId (Memory and I/O only) */
0255 
0256 #define ACPI_ADDRESS_RANGE_MAX          2
0257 
0258 /* Maximum time (default 30s) of While() loops before abort */
0259 
0260 #define ACPI_MAX_LOOP_TIMEOUT           30
0261 
0262 
0263 /******************************************************************************
0264  *
0265  * ACPI Specification constants (Do not change unless the specification changes)
0266  *
0267  *****************************************************************************/
0268 
0269 /* Method info (in WALK_STATE), containing local variables and arguments */
0270 
0271 #define ACPI_METHOD_NUM_LOCALS          8
0272 #define ACPI_METHOD_MAX_LOCAL           7
0273 
0274 #define ACPI_METHOD_NUM_ARGS            7
0275 #define ACPI_METHOD_MAX_ARG             6
0276 
0277 /*
0278  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
0279  */
0280 #define ACPI_OBJ_NUM_OPERANDS           8
0281 #define ACPI_OBJ_MAX_OPERAND            7
0282 
0283 /* Number of elements in the Result Stack frame, can be an arbitrary value */
0284 
0285 #define ACPI_RESULTS_FRAME_OBJ_NUM      8
0286 
0287 /*
0288  * Maximal number of elements the Result Stack can contain,
0289  * it may be an arbitrary value not exceeding the types of
0290  * ResultSize and ResultCount (now UINT8).
0291  */
0292 #define ACPI_RESULTS_OBJ_NUM_MAX        255
0293 
0294 /* Constants used in searching for the RSDP in low memory */
0295 
0296 #define ACPI_EBDA_PTR_LOCATION          0x0000040E     /* Physical Address */
0297 #define ACPI_EBDA_PTR_LENGTH            2
0298 #define ACPI_EBDA_WINDOW_SIZE           1024
0299 #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000     /* Physical Address */
0300 #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
0301 #define ACPI_RSDP_SCAN_STEP             16
0302 
0303 /* Operation regions */
0304 
0305 #define ACPI_USER_REGION_BEGIN          0x80
0306 
0307 /* Maximum SpaceIds for Operation Regions */
0308 
0309 #define ACPI_MAX_ADDRESS_SPACE          255
0310 #define ACPI_NUM_DEFAULT_SPACES         4
0311 
0312 /* Array sizes. Used for range checking also */
0313 
0314 #define ACPI_MAX_MATCH_OPCODE           5
0315 
0316 /* RSDP checksums */
0317 
0318 #define ACPI_RSDP_CHECKSUM_LENGTH       20
0319 #define ACPI_RSDP_XCHECKSUM_LENGTH      36
0320 
0321 /*
0322  * SMBus, GSBus and IPMI buffer sizes. All have a 2-byte header,
0323  * containing both Status and Length.
0324  */
0325 #define ACPI_SERIAL_HEADER_SIZE         2   /* Common for below. Status and Length fields */
0326 
0327 #define ACPI_SMBUS_DATA_SIZE            32
0328 #define ACPI_SMBUS_BUFFER_SIZE          ACPI_SERIAL_HEADER_SIZE + ACPI_SMBUS_DATA_SIZE
0329 
0330 #define ACPI_IPMI_DATA_SIZE             64
0331 #define ACPI_IPMI_BUFFER_SIZE           ACPI_SERIAL_HEADER_SIZE + ACPI_IPMI_DATA_SIZE
0332 
0333 #define ACPI_MAX_GSBUS_DATA_SIZE        255
0334 #define ACPI_MAX_GSBUS_BUFFER_SIZE      ACPI_SERIAL_HEADER_SIZE + ACPI_MAX_GSBUS_DATA_SIZE
0335 
0336 #define ACPI_PRM_INPUT_BUFFER_SIZE      26
0337 
0338 #define ACPI_FFH_INPUT_BUFFER_SIZE      256
0339 
0340 /* _SxD and _SxW control methods */
0341 
0342 #define ACPI_NUM_SxD_METHODS            4
0343 #define ACPI_NUM_SxW_METHODS            5
0344 
0345 
0346 /******************************************************************************
0347  *
0348  * Miscellaneous constants
0349  *
0350  *****************************************************************************/
0351 
0352 /* UUID constants */
0353 
0354 #define UUID_BUFFER_LENGTH          16 /* Length of UUID in memory */
0355 #define UUID_STRING_LENGTH          36 /* Total length of a UUID string */
0356 
0357 /* Positions for required hyphens (dashes) in UUID strings */
0358 
0359 #define UUID_HYPHEN1_OFFSET         8
0360 #define UUID_HYPHEN2_OFFSET         13
0361 #define UUID_HYPHEN3_OFFSET         18
0362 #define UUID_HYPHEN4_OFFSET         23
0363 
0364 
0365 /******************************************************************************
0366  *
0367  * ACPI AML Debugger
0368  *
0369  *****************************************************************************/
0370 
0371 #define ACPI_DEBUGGER_MAX_ARGS          ACPI_METHOD_NUM_ARGS + 4 /* Max command line arguments */
0372 #define ACPI_DB_LINE_BUFFER_SIZE        512
0373 
0374 #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
0375 #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
0376 
0377 
0378 #endif /* _ACCONFIG_H */