include/acpi/platform/acenv.h

   1 /******************************************************************************
   2  *
   3  * Name: acenv.h - Generation environment specific items
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   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 __ACENV_H__
  45 #define __ACENV_H__
  46
  47
  48 /*
  49  * Configuration for ACPI tools and utilities
  50  */
  51
  52 #ifdef _ACPI_DUMP_APP
  53 #ifndef MSDOS
  54 #define ACPI_DEBUG_OUTPUT
  55 #endif
  56 #define ACPI_APPLICATION
  57 #define ACPI_DISASSEMBLER
  58 #define ACPI_NO_METHOD_EXECUTION
  59 #define ACPI_USE_SYSTEM_CLIBRARY
  60 #define ACPI_ENABLE_OBJECT_CACHE
  61 #endif
  62
  63 #ifdef _ACPI_EXEC_APP
  64 #undef DEBUGGER_THREADING
  65 #define DEBUGGER_THREADING      DEBUGGER_SINGLE_THREADED
  66 #define ACPI_DEBUG_OUTPUT
  67 #define ACPI_APPLICATION
  68 #define ACPI_DEBUGGER
  69 #define ACPI_DISASSEMBLER
  70 #define ACPI_USE_SYSTEM_CLIBRARY
  71 #define ACPI_ENABLE_OBJECT_CACHE
  72 #endif
  73
  74 #ifdef _ACPI_ASL_COMPILER
  75 #define ACPI_DEBUG_OUTPUT
  76 #define ACPI_APPLICATION
  77 #define ACPI_DISASSEMBLER
  78 #define ACPI_CONSTANT_EVAL_ONLY
  79 #define ACPI_USE_SYSTEM_CLIBRARY
  80 #define ACPI_ENABLE_OBJECT_CACHE
  81 #endif
  82
  83 /*
  84  * Environment configuration.  The purpose of this file is to interface to the
  85  * local generation environment.
  86  *
  87  * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
  88  *      Otherwise, local versions of string/memory functions will be used.
  89  * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
  90  *      the standard header files may be used.
  91  *
  92  * The ACPI subsystem only uses low level C library functions that do not call
  93  * operating system services and may therefore be inlined in the code.
  94  *
  95  * It may be necessary to tailor these include files to the target
  96  * generation environment.
  97  *
  98  *
  99  * Functions and constants used from each header:
 100  *
 101  * string.h:    memcpy
 102  *              memset
 103  *              strcat
 104  *              strcmp
 105  *              strcpy
 106  *              strlen
 107  *              strncmp
 108  *              strncat
 109  *              strncpy
 110  *
 111  * stdlib.h:    strtoul
 112  *
 113  * stdarg.h:    va_list
 114  *              va_arg
 115  *              va_start
 116  *              va_end
 117  *
 118  */
 119
 120 /*! [Begin] no source code translation */
 121
 122 #if defined(__linux__)
 123 #include "aclinux.h"
 124
 125 #elif defined(_AED_EFI)
 126 #include "acefi.h"
 127
 128 #elif defined(WIN32)
 129 #include "acwin.h"
 130
 131 #elif defined(WIN64)
 132 #include "acwin64.h"
 133
 134 #elif defined(MSDOS)        /* Must appear after WIN32 and WIN64 check */
 135 #include "acdos16.h"
 136
 137 #elif defined(__FreeBSD__)
 138 #include "acfreebsd.h"
 139
 140 #elif defined(__NetBSD__)
 141 #include "acnetbsd.h"
 142
 143 #elif defined(MODESTO)
 144 #include "acmodesto.h"
 145
 146 #elif defined(NETWARE)
 147 #include "acnetware.h"
 148
 149 #else
 150
 151 /* All other environments */
 152
 153 #define ACPI_USE_STANDARD_HEADERS
 154
 155 #define COMPILER_DEPENDENT_INT64   long long
 156 #define COMPILER_DEPENDENT_UINT64  unsigned long long
 157
 158 /*
 159  * This macro is used to tag functions as "printf-like" because
 160  * some compilers can catch printf format string problems. MSVC
 161  * doesn't, so this is proprocessed away.
 162  */
 163 #define ACPI_PRINTF_LIKE_FUNC
 164
 165 #endif
 166
 167 /*
 168  * Memory allocation tracking.  Used only if
 169  * 1) This is the debug version
 170  * 2) This is NOT a 16-bit version of the code (not enough real-mode memory)
 171  */
 172 #ifdef ACPI_DEBUG_OUTPUT
 173 #if ACPI_MACHINE_WIDTH != 16
 174 #define ACPI_DBG_TRACK_ALLOCATIONS
 175 #endif
 176 #endif
 177
 178 /*! [End] no source code translation !*/
 179
 180
 181 /*
 182  * Debugger threading model
 183  * Use single threaded if the entire subsystem is contained in an application
 184  * Use multiple threaded when the subsystem is running in the kernel.
 185  *
 186  * By default the model is single threaded if ACPI_APPLICATION is set,
 187  * multi-threaded if ACPI_APPLICATION is not set.
 188  */
 189 #define DEBUGGER_SINGLE_THREADED    0
 190 #define DEBUGGER_MULTI_THREADED     1
 191
 192 #ifndef DEBUGGER_THREADING
 193 #ifdef ACPI_APPLICATION
 194 #define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
 195
 196 #else
 197 #define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
 198 #endif
 199 #endif /* !DEBUGGER_THREADING */
 200
 201
 202 /******************************************************************************
 203  *
 204  * C library configuration
 205  *
 206  *****************************************************************************/
 207
 208 #ifdef ACPI_USE_SYSTEM_CLIBRARY
 209 /*
 210  * Use the standard C library headers.
 211  * We want to keep these to a minimum.
 212  */
 213 #ifdef ACPI_USE_STANDARD_HEADERS
 214 /*
 215  * Use the standard headers from the standard locations
 216  */
 217 #include <stdarg.h>
 218 #include <stdlib.h>
 219 #include <string.h>
 220 #include <ctype.h>
 221
 222 #endif /* ACPI_USE_STANDARD_HEADERS */
 223
 224 /*
 225  * We will be linking to the standard Clib functions
 226  */
 227 #define ACPI_STRSTR(s1,s2)      strstr((s1), (s2))
 228 #define ACPI_STRCHR(s1,c)       strchr((s1), (c))
 229 #define ACPI_STRLEN(s)          (acpi_size) strlen((s))
 230 #define ACPI_STRCPY(d,s)        (void) strcpy((d), (s))
 231 #define ACPI_STRNCPY(d,s,n)     (void) strncpy((d), (s), (acpi_size)(n))
 232 #define ACPI_STRNCMP(d,s,n)     strncmp((d), (s), (acpi_size)(n))
 233 #define ACPI_STRCMP(d,s)        strcmp((d), (s))
 234 #define ACPI_STRCAT(d,s)        (void) strcat((d), (s))
 235 #define ACPI_STRNCAT(d,s,n)     strncat((d), (s), (acpi_size)(n))
 236 #define ACPI_STRTOUL(d,s,n)     strtoul((d), (s), (acpi_size)(n))
 237 #define ACPI_MEMCMP(s1,s2,n)    memcmp((s1), (s2), (acpi_size)(n))
 238 #define ACPI_MEMCPY(d,s,n)      (void) memcpy((d), (s), (acpi_size)(n))
 239 #define ACPI_MEMSET(d,s,n)      (void) memset((d), (s), (acpi_size)(n))
 240
 241 #define ACPI_TOUPPER            toupper
 242 #define ACPI_TOLOWER            tolower
 243 #define ACPI_IS_XDIGIT          isxdigit
 244 #define ACPI_IS_DIGIT           isdigit
 245 #define ACPI_IS_SPACE           isspace
 246 #define ACPI_IS_UPPER           isupper
 247 #define ACPI_IS_PRINT           isprint
 248 #define ACPI_IS_ALPHA           isalpha
 249 #define ACPI_IS_ASCII           isascii
 250
 251 #else
 252
 253 /******************************************************************************
 254  *
 255  * Not using native C library, use local implementations
 256  *
 257  *****************************************************************************/
 258
 259  /*
 260  * Use local definitions of C library macros and functions
 261  * NOTE: The function implementations may not be as efficient
 262  * as an inline or assembly code implementation provided by a
 263  * native C library.
 264  */
 265
 266 #ifndef va_arg
 267
 268 #ifndef _VALIST
 269 #define _VALIST
 270 typedef char *va_list;
 271 #endif /* _VALIST */
 272
 273 /*
 274  * Storage alignment properties
 275  */
 276 #define  _AUPBND                (sizeof (acpi_native_int) - 1)
 277 #define  _ADNBND                (sizeof (acpi_native_int) - 1)
 278
 279 /*
 280  * Variable argument list macro definitions
 281  */
 282 #define _bnd(X, bnd)            (((sizeof (X)) + (bnd)) & (~(bnd)))
 283 #define va_arg(ap, T)           (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND))))
 284 #define va_end(ap)              (void) 0
 285 #define va_start(ap, A)         (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND))))
 286
 287 #endif /* va_arg */
 288
 289
 290 #define ACPI_STRSTR(s1,s2)      acpi_ut_strstr ((s1), (s2))
 291 #define ACPI_STRCHR(s1,c)       acpi_ut_strchr ((s1), (c))
 292 #define ACPI_STRLEN(s)          (acpi_size) acpi_ut_strlen ((s))
 293 #define ACPI_STRCPY(d,s)        (void) acpi_ut_strcpy ((d), (s))
 294 #define ACPI_STRNCPY(d,s,n)     (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n))
 295 #define ACPI_STRNCMP(d,s,n)     acpi_ut_strncmp ((d), (s), (acpi_size)(n))
 296 #define ACPI_STRCMP(d,s)        acpi_ut_strcmp ((d), (s))
 297 #define ACPI_STRCAT(d,s)        (void) acpi_ut_strcat ((d), (s))
 298 #define ACPI_STRNCAT(d,s,n)     acpi_ut_strncat ((d), (s), (acpi_size)(n))
 299 #define ACPI_STRTOUL(d,s,n)     acpi_ut_strtoul ((d), (s), (acpi_size)(n))
 300 #define ACPI_MEMCMP(s1,s2,n)    acpi_ut_memcmp((s1), (s2), (acpi_size)(n))
 301 #define ACPI_MEMCPY(d,s,n)      (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n))
 302 #define ACPI_MEMSET(d,v,n)      (void) acpi_ut_memset ((d), (v), (acpi_size)(n))
 303 #define ACPI_TOUPPER            acpi_ut_to_upper
 304 #define ACPI_TOLOWER            acpi_ut_to_lower
 305
 306 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
 307
 308
 309 /******************************************************************************
 310  *
 311  * Assembly code macros
 312  *
 313  *****************************************************************************/
 314
 315 /*
 316  * Handle platform- and compiler-specific assembly language differences.
 317  * These should already have been defined by the platform includes above.
 318  *
 319  * Notes:
 320  * 1) Interrupt 3 is used to break into a debugger
 321  * 2) Interrupts are turned off during ACPI register setup
 322  */
 323
 324 /* Unrecognized compiler, use defaults */
 325
 326 #ifndef ACPI_ASM_MACROS
 327
 328 /*
 329  * Calling conventions:
 330  *
 331  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
 332  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
 333  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
 334  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
 335  */
 336 #define ACPI_SYSTEM_XFACE
 337 #define ACPI_EXTERNAL_XFACE
 338 #define ACPI_INTERNAL_XFACE
 339 #define ACPI_INTERNAL_VAR_XFACE
 340
 341 #define ACPI_ASM_MACROS
 342 #define BREAKPOINT3
 343 #define ACPI_DISABLE_IRQS()
 344 #define ACPI_ENABLE_IRQS()
 345 #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acq)
 346 #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, acq)
 347
 348 #endif /* ACPI_ASM_MACROS */
 349
 350
 351 #ifdef ACPI_APPLICATION
 352
 353 /* Don't want software interrupts within a ring3 application */
 354
 355 #undef BREAKPOINT3
 356 #define BREAKPOINT3
 357 #endif
 358
 359
 360 /******************************************************************************
 361  *
 362  * Compiler-specific information is contained in the compiler-specific
 363  * headers.
 364  *
 365  *****************************************************************************/
 366 #endif /* __ACENV_H__ */