sys/contrib/dev/acpica/source/include/acconfig.h

   1 /******************************************************************************
   2  *
   3  * Name: acconfig.h - Global configuration constants
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, 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  *
  50  * Configuration options
  51  *
  52  *****************************************************************************/
  53
  54 /*
  55  * ACPI_DEBUG_OUTPUT    - This switch enables all the debug facilities of the
  56  *                        ACPI subsystem. This includes the DEBUG_PRINT output
  57  *                        statements. When disabled, all DEBUG_PRINT
  58  *                        statements are compiled out.
  59  *
  60  * ACPI_APPLICATION     - Use this switch if the subsystem is going to be run
  61  *                        at the application level.
  62  *
  63  */
  64
  65 /*
  66  * OS name, used for the _OS object. The _OS object is essentially obsolete,
  67  * but there is a large base of ASL/AML code in existing machines that check
  68  * for the string below. The use of this string usually guarantees that
  69  * the ASL will execute down the most tested code path. Also, there is some
  70  * code that will not execute the _OSI method unless _OS matches the string
  71  * below. Therefore, change this string at your own risk.
  72  */
  73 #define ACPI_OS_NAME                    "Microsoft Windows NT"
  74
  75 /* Maximum objects in the various object caches */
  76
  77 #define ACPI_MAX_STATE_CACHE_DEPTH      96          /* State objects */
  78 #define ACPI_MAX_PARSE_CACHE_DEPTH      96          /* Parse tree objects */
  79 #define ACPI_MAX_EXTPARSE_CACHE_DEPTH   96          /* Parse tree objects */
  80 #define ACPI_MAX_OBJECT_CACHE_DEPTH     96          /* Interpreter operand objects */
  81 #define ACPI_MAX_NAMESPACE_CACHE_DEPTH  96          /* Namespace objects */
  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  *
 113  * Subsystem Constants
 114  *
 115  *****************************************************************************/
 116
 117 /* Version of ACPI supported */
 118
 119 #define ACPI_CA_SUPPORT_LEVEL           5
 120
 121 /* Maximum count for a semaphore object */
 122
 123 #define ACPI_MAX_SEMAPHORE_COUNT        256
 124
 125 /* Maximum object reference count (detects object deletion issues) */
 126
 127 #define ACPI_MAX_REFERENCE_COUNT        0x800
 128
 129 /* Default page size for use in mapping memory for operation regions */
 130
 131 #define ACPI_DEFAULT_PAGE_SIZE          4096    /* Must be power of 2 */
 132
 133 /* OwnerId tracking. 8 entries allows for 255 OwnerIds */
 134
 135 #define ACPI_NUM_OWNERID_MASKS          8
 136
 137 /* Size of the root table array is increased by this increment */
 138
 139 #define ACPI_ROOT_TABLE_SIZE_INCREMENT  4
 140
 141 /* Maximum sleep allowed via Sleep() operator */
 142
 143 #define ACPI_MAX_SLEEP                  2000    /* 2000 millisec == two seconds */
 144
 145 /* Address Range lists are per-SpaceId (Memory and I/O only) */
 146
 147 #define ACPI_ADDRESS_RANGE_MAX          2
 148
 149 /* Maximum number of While() loops before abort */
 150
 151 #define ACPI_MAX_LOOP_COUNT             0x000FFFFF
 152
 153
 154 /******************************************************************************
 155  *
 156  * ACPI Specification constants (Do not change unless the specification changes)
 157  *
 158  *****************************************************************************/
 159
 160 /* Method info (in WALK_STATE), containing local variables and argumetns */
 161
 162 #define ACPI_METHOD_NUM_LOCALS          8
 163 #define ACPI_METHOD_MAX_LOCAL           7
 164
 165 #define ACPI_METHOD_NUM_ARGS            7
 166 #define ACPI_METHOD_MAX_ARG             6
 167
 168 /*
 169  * Operand Stack (in WALK_STATE), Must be large enough to contain METHOD_MAX_ARG
 170  */
 171 #define ACPI_OBJ_NUM_OPERANDS           8
 172 #define ACPI_OBJ_MAX_OPERAND            7
 173
 174 /* Number of elements in the Result Stack frame, can be an arbitrary value */
 175
 176 #define ACPI_RESULTS_FRAME_OBJ_NUM      8
 177
 178 /*
 179  * Maximal number of elements the Result Stack can contain,
 180  * it may be an arbitray value not exceeding the types of
 181  * ResultSize and ResultCount (now UINT8).
 182  */
 183 #define ACPI_RESULTS_OBJ_NUM_MAX        255
 184
 185 /* Constants used in searching for the RSDP in low memory */
 186
 187 #define ACPI_EBDA_PTR_LOCATION          0x0000040E     /* Physical Address */
 188 #define ACPI_EBDA_PTR_LENGTH            2
 189 #define ACPI_EBDA_WINDOW_SIZE           1024
 190 #define ACPI_HI_RSDP_WINDOW_BASE        0x000E0000     /* Physical Address */
 191 #define ACPI_HI_RSDP_WINDOW_SIZE        0x00020000
 192 #define ACPI_RSDP_SCAN_STEP             16
 193
 194 /* Operation regions */
 195
 196 #define ACPI_USER_REGION_BEGIN          0x80
 197
 198 /* Maximum SpaceIds for Operation Regions */
 199
 200 #define ACPI_MAX_ADDRESS_SPACE          255
 201 #define ACPI_NUM_DEFAULT_SPACES         4
 202
 203 /* Array sizes. Used for range checking also */
 204
 205 #define ACPI_MAX_MATCH_OPCODE           5
 206
 207 /* RSDP checksums */
 208
 209 #define ACPI_RSDP_CHECKSUM_LENGTH       20
 210 #define ACPI_RSDP_XCHECKSUM_LENGTH      36
 211
 212 /* SMBus, GSBus and IPMI bidirectional buffer size */
 213
 214 #define ACPI_SMBUS_BUFFER_SIZE          34
 215 #define ACPI_GSBUS_BUFFER_SIZE          34
 216 #define ACPI_IPMI_BUFFER_SIZE           66
 217
 218 /* _SxD and _SxW control methods */
 219
 220 #define ACPI_NUM_SxD_METHODS            4
 221 #define ACPI_NUM_SxW_METHODS            5
 222
 223
 224 /******************************************************************************
 225  *
 226  * Miscellaneous constants
 227  *
 228  *****************************************************************************/
 229
 230 /* UUID constants */
 231
 232 #define UUID_BUFFER_LENGTH          16 /* Length of UUID in memory */
 233 #define UUID_STRING_LENGTH          36 /* Total length of a UUID string */
 234
 235 /* Positions for required hyphens (dashes) in UUID strings */
 236
 237 #define UUID_HYPHEN1_OFFSET         8
 238 #define UUID_HYPHEN2_OFFSET         13
 239 #define UUID_HYPHEN3_OFFSET         18
 240 #define UUID_HYPHEN4_OFFSET         23
 241
 242
 243 /******************************************************************************
 244  *
 245  * ACPI AML Debugger
 246  *
 247  *****************************************************************************/
 248
 249 #define ACPI_DEBUGGER_MAX_ARGS          ACPI_METHOD_NUM_ARGS + 4 /* Max command line arguments */
 250 #define ACPI_DB_LINE_BUFFER_SIZE        512
 251
 252 #define ACPI_DEBUGGER_COMMAND_PROMPT    '-'
 253 #define ACPI_DEBUGGER_EXECUTE_PROMPT    '%'
 254
 255
 256 #endif /* _ACCONFIG_H */