sys/contrib/dev/acpica/source/include/platform/acefi.h

   1 /******************************************************************************
   2  *
   3  * Name: acefi.h - OS specific defines, etc.
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #ifndef __ACEFI_H__
 153 #define __ACEFI_H__
 154
 155 /*
 156  * Single threaded environment where Mutex/Event/Sleep are fake. This model is
 157  * sufficient for pre-boot AcpiExec.
 158  */
 159 #ifndef DEBUGGER_THREADING
 160 #define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
 161 #endif /* !DEBUGGER_THREADING */
 162
 163 /* EDK2 EFI environemnt */
 164
 165 #if defined(_EDK2_EFI)
 166
 167 #ifdef USE_STDLIB
 168 #define ACPI_USE_STANDARD_HEADERS
 169 #define ACPI_USE_SYSTEM_CLIBRARY
 170 #define ACPI_USE_NATIVE_DIVIDE
 171 #define ACPI_USE_NATIVE_MATH64
 172 #endif
 173
 174 #endif
 175
 176 #if defined(__x86_64__)
 177 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7))
 178 #define USE_MS_ABI 1
 179 #endif
 180 #endif
 181
 182 #ifdef _MSC_EXTENSIONS
 183 #define ACPI_EFI_API __cdecl
 184 #elif USE_MS_ABI
 185 #define ACPI_EFI_API __attribute__((ms_abi))
 186 #else
 187 #define ACPI_EFI_API
 188 #endif
 189
 190 #define VOID        void
 191
 192 #if defined(__ia64__) || defined(__x86_64__)
 193
 194 #define ACPI_MACHINE_WIDTH          64
 195
 196 #if defined(__x86_64__)
 197
 198 /* for x86_64, EFI_FUNCTION_WRAPPER must be defined */
 199
 200 #ifndef USE_MS_ABI
 201 #define USE_EFI_FUNCTION_WRAPPER
 202 #endif
 203
 204 #ifdef _MSC_EXTENSIONS
 205 #pragma warning ( disable : 4731 )  /* Suppress warnings about modification of EBP */
 206 #endif
 207
 208 #endif
 209
 210 #ifndef USE_STDLIB
 211 #define UINTN       uint64_t
 212 #define INTN        int64_t
 213 #endif
 214
 215 #define ACPI_EFI_ERR(a)             (0x8000000000000000 | a)
 216
 217 #else
 218
 219 #define ACPI_MACHINE_WIDTH          32
 220
 221 #ifndef USE_STDLIB
 222 #define UINTN       uint32_t
 223 #define INTN        int32_t
 224 #endif
 225
 226 #define ACPI_EFI_ERR(a)             (0x80000000 | a)
 227
 228 #endif
 229
 230 #define CHAR16      uint16_t
 231
 232 #ifdef USE_EFI_FUNCTION_WRAPPER
 233 #define __VA_NARG__(...)                        \
 234   __VA_NARG_(_0, ## __VA_ARGS__, __RSEQ_N())
 235 #define __VA_NARG_(...)                         \
 236   __VA_ARG_N(__VA_ARGS__)
 237 #define __VA_ARG_N(                             \
 238   _0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,N,...) N
 239 #define __RSEQ_N()                              \
 240   10, 9,  8,  7,  6,  5,  4,  3,  2,  1,  0
 241
 242 #define __VA_ARG_NSUFFIX__(prefix,...)                  \
 243   __VA_ARG_NSUFFIX_N(prefix, __VA_NARG__(__VA_ARGS__))
 244 #define __VA_ARG_NSUFFIX_N(prefix,nargs)        \
 245   __VA_ARG_NSUFFIX_N_(prefix, nargs)
 246 #define __VA_ARG_NSUFFIX_N_(prefix,nargs)       \
 247   prefix ## nargs
 248
 249 /* Prototypes of EFI cdecl -> stdcall trampolines */
 250
 251 UINT64 efi_call0(void *func);
 252 UINT64 efi_call1(void *func, UINT64 arg1);
 253 UINT64 efi_call2(void *func, UINT64 arg1, UINT64 arg2);
 254 UINT64 efi_call3(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3);
 255 UINT64 efi_call4(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 256                  UINT64 arg4);
 257 UINT64 efi_call5(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 258                  UINT64 arg4, UINT64 arg5);
 259 UINT64 efi_call6(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 260                  UINT64 arg4, UINT64 arg5, UINT64 arg6);
 261 UINT64 efi_call7(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 262                  UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7);
 263 UINT64 efi_call8(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 264                  UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
 265                  UINT64 arg8);
 266 UINT64 efi_call9(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 267                  UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
 268                  UINT64 arg8, UINT64 arg9);
 269 UINT64 efi_call10(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
 270                   UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
 271                   UINT64 arg8, UINT64 arg9, UINT64 arg10);
 272
 273 /* Front-ends to efi_callX to avoid compiler warnings */
 274
 275 #define _cast64_efi_call0(f) \
 276   efi_call0(f)
 277 #define _cast64_efi_call1(f,a1) \
 278   efi_call1(f, (UINT64)(a1))
 279 #define _cast64_efi_call2(f,a1,a2) \
 280   efi_call2(f, (UINT64)(a1), (UINT64)(a2))
 281 #define _cast64_efi_call3(f,a1,a2,a3) \
 282   efi_call3(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3))
 283 #define _cast64_efi_call4(f,a1,a2,a3,a4) \
 284   efi_call4(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4))
 285 #define _cast64_efi_call5(f,a1,a2,a3,a4,a5) \
 286   efi_call5(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 287             (UINT64)(a5))
 288 #define _cast64_efi_call6(f,a1,a2,a3,a4,a5,a6) \
 289   efi_call6(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 290             (UINT64)(a5), (UINT64)(a6))
 291 #define _cast64_efi_call7(f,a1,a2,a3,a4,a5,a6,a7) \
 292   efi_call7(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 293             (UINT64)(a5), (UINT64)(a6), (UINT64)(a7))
 294 #define _cast64_efi_call8(f,a1,a2,a3,a4,a5,a6,a7,a8) \
 295   efi_call8(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 296             (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8))
 297 #define _cast64_efi_call9(f,a1,a2,a3,a4,a5,a6,a7,a8,a9) \
 298   efi_call9(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 299             (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8), \
 300             (UINT64)(a9))
 301 #define _cast64_efi_call10(f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) \
 302   efi_call10(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
 303              (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8), \
 304              (UINT64)(a9), (UINT64)(a10))
 305
 306 /* main wrapper (va_num ignored) */
 307
 308 #define uefi_call_wrapper(func,va_num,...)                        \
 309   __VA_ARG_NSUFFIX__(_cast64_efi_call, __VA_ARGS__) (func , ##__VA_ARGS__)
 310
 311 #else
 312
 313 #define uefi_call_wrapper(func, va_num, ...) func(__VA_ARGS__)
 314
 315 #endif
 316
 317 /* AED EFI definitions */
 318
 319 #if defined(_AED_EFI)
 320
 321 /* _int64 works for both IA32 and IA64 */
 322
 323 #define COMPILER_DEPENDENT_INT64   __int64
 324 #define COMPILER_DEPENDENT_UINT64  unsigned __int64
 325
 326 /*
 327  * Calling conventions:
 328  *
 329  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
 330  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
 331  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
 332  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
 333  */
 334 #define ACPI_SYSTEM_XFACE
 335 #define ACPI_EXTERNAL_XFACE
 336 #define ACPI_INTERNAL_XFACE
 337 #define ACPI_INTERNAL_VAR_XFACE
 338
 339 /* warn C4142: redefinition of type */
 340
 341 #pragma warning(disable:4142)
 342
 343 #endif
 344
 345
 346 /* EFI math64 definitions */
 347
 348 #if defined(_GNU_EFI) || defined(_EDK2_EFI)
 349 /*
 350  * Math helpers, GNU EFI provided a platform independent 64-bit math
 351  * support.
 352  */
 353 #ifndef ACPI_DIV_64_BY_32
 354 #define ACPI_DIV_64_BY_32(n_hi, n_lo, d32, q32, r32)         \
 355     do {                                                     \
 356         UINT64 __n = ((UINT64) n_hi) << 32 | (n_lo);         \
 357         (q32) = (UINT32) DivU64x32 ((__n), (d32), &(r32));   \
 358     } while (0)
 359 #endif
 360
 361 #ifndef ACPI_MUL_64_BY_32
 362 #define ACPI_MUL_64_BY_32(n_hi, n_lo, m32, p32, c32) \
 363     do {                                             \
 364         UINT64 __n = ((UINT64) n_hi) << 32 | (n_lo); \
 365         UINT64 __p = MultU64x32 (__n, (m32));        \
 366         (p32) = (UINT32) __p;                        \
 367         (c32) = (UINT32) (__p >> 32);                \
 368     } while (0)
 369 #endif
 370
 371 #ifndef ACPI_SHIFT_LEFT_64_by_32
 372 #define ACPI_SHIFT_LEFT_64_BY_32(n_hi, n_lo, s32)    \
 373     do {                                             \
 374         UINT64 __n = ((UINT64) n_hi) << 32 | (n_lo); \
 375         UINT64 __r = LShiftU64 (__n, (s32));         \
 376         (n_lo) = (UINT32) __r;                       \
 377         (n_hi) = (UINT32) (__r >> 32);               \
 378     } while (0)
 379 #endif
 380
 381 #ifndef ACPI_SHIFT_RIGHT_64_BY_32
 382 #define ACPI_SHIFT_RIGHT_64_BY_32(n_hi, n_lo, s32)   \
 383     do {                                             \
 384         UINT64 __n = ((UINT64) n_hi) << 32 | (n_lo); \
 385         UINT64 __r = RShiftU64 (__n, (s32));         \
 386         (n_lo) = (UINT32) __r;                       \
 387         (n_hi) = (UINT32) (__r >> 32);               \
 388     } while (0)
 389 #endif
 390
 391 #ifndef ACPI_SHIFT_RIGHT_64
 392 #define ACPI_SHIFT_RIGHT_64(n_hi, n_lo) \
 393     do {                                \
 394         (n_lo) >>= 1;                   \
 395         (n_lo) |= (((n_hi) & 1) << 31); \
 396         (n_hi) >>= 1;                   \
 397     } while (0)
 398 #endif
 399 #endif
 400
 401 struct _ACPI_SIMPLE_TEXT_OUTPUT_INTERFACE;
 402 struct _ACPI_SIMPLE_INPUT_INTERFACE;
 403 struct _ACPI_EFI_FILE_IO_INTERFACE;
 404 struct _ACPI_EFI_FILE_HANDLE;
 405 struct _ACPI_EFI_BOOT_SERVICES;
 406 struct _ACPI_EFI_RUNTIME_SERVICES;
 407 struct _ACPI_EFI_SYSTEM_TABLE;
 408 struct _ACPI_EFI_PCI_IO;
 409
 410 extern struct _ACPI_EFI_SYSTEM_TABLE        *ST;
 411 extern struct _ACPI_EFI_BOOT_SERVICES       *BS;
 412 extern struct _ACPI_EFI_RUNTIME_SERVICES    *RT;
 413
 414 #ifndef USE_STDLIB
 415 typedef union acpi_efi_file ACPI_EFI_FILE;
 416 #define FILE                ACPI_EFI_FILE
 417
 418 extern FILE                 *stdin;
 419 extern FILE                 *stdout;
 420 extern FILE                 *stderr;
 421 #endif
 422
 423 #endif /* __ACEFI_H__ */