include/acpi/platform/acenv.h

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