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 - 2016, 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#ifndef __ACEFI_H__
117#define __ACEFI_H__
118
119#include <stdarg.h>
120#if defined(_GNU_EFI)
121#include <stdint.h>
122#include <unistd.h>
123#endif
124
125#if defined(__x86_64__)
126#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7))
127#define USE_MS_ABI 1
128#endif
129#endif
130
131#ifdef _MSC_EXTENSIONS
132#define EFIAPI __cdecl
133#elif USE_MS_ABI
134#define EFIAPI __attribute__((ms_abi))
135#else
136#define EFIAPI
137#endif
138
139typedef uint8_t     UINT8;
140typedef uint16_t    UINT16;
141typedef int16_t     INT16;
142typedef uint32_t    UINT32;
143typedef int32_t     INT32;
144typedef uint64_t    UINT64;
145typedef int64_t     INT64;
146typedef uint8_t     BOOLEAN;
147typedef uint16_t    CHAR16;
148
149#define VOID        void
150
151#if defined(__ia64__) || defined(__x86_64__)
152
153#define ACPI_MACHINE_WIDTH          64
154
155#if defined(__x86_64__)
156
157/* for x86_64, EFI_FUNCTION_WRAPPER must be defined */
158
159#ifndef USE_MS_ABI
160#define USE_EFI_FUNCTION_WRAPPER
161#endif
162
163#ifdef _MSC_EXTENSIONS
164#pragma warning ( disable : 4731 )  /* Suppress warnings about modification of EBP */
165#endif
166
167#endif
168
169typedef uint64_t    UINTN;
170typedef int64_t     INTN;
171
172#define EFIERR(a)           (0x8000000000000000 | a)
173
174#else
175
176#define ACPI_MACHINE_WIDTH          32
177#define ACPI_USE_NATIVE_DIVIDE
178
179typedef uint32_t UINTN;
180typedef int32_t INTN;
181
182#define EFIERR(a)           (0x80000000 | a)
183
184#endif
185
186
187#ifdef USE_EFI_FUNCTION_WRAPPER
188#define __VA_NARG__(...)                        \
189  __VA_NARG_(_0, ## __VA_ARGS__, __RSEQ_N())
190#define __VA_NARG_(...)                         \
191  __VA_ARG_N(__VA_ARGS__)
192#define __VA_ARG_N(                             \
193  _0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,N,...) N
194#define __RSEQ_N()                              \
195  10, 9,  8,  7,  6,  5,  4,  3,  2,  1,  0
196
197#define __VA_ARG_NSUFFIX__(prefix,...)                  \
198  __VA_ARG_NSUFFIX_N(prefix, __VA_NARG__(__VA_ARGS__))
199#define __VA_ARG_NSUFFIX_N(prefix,nargs)        \
200  __VA_ARG_NSUFFIX_N_(prefix, nargs)
201#define __VA_ARG_NSUFFIX_N_(prefix,nargs)       \
202  prefix ## nargs
203
204/* Prototypes of EFI cdecl -> stdcall trampolines */
205
206UINT64 efi_call0(void *func);
207UINT64 efi_call1(void *func, UINT64 arg1);
208UINT64 efi_call2(void *func, UINT64 arg1, UINT64 arg2);
209UINT64 efi_call3(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3);
210UINT64 efi_call4(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
211                 UINT64 arg4);
212UINT64 efi_call5(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
213                 UINT64 arg4, UINT64 arg5);
214UINT64 efi_call6(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
215                 UINT64 arg4, UINT64 arg5, UINT64 arg6);
216UINT64 efi_call7(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
217                 UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7);
218UINT64 efi_call8(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
219                 UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
220                 UINT64 arg8);
221UINT64 efi_call9(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
222                 UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
223                 UINT64 arg8, UINT64 arg9);
224UINT64 efi_call10(void *func, UINT64 arg1, UINT64 arg2, UINT64 arg3,
225                  UINT64 arg4, UINT64 arg5, UINT64 arg6, UINT64 arg7,
226                  UINT64 arg8, UINT64 arg9, UINT64 arg10);
227
228/* Front-ends to efi_callX to avoid compiler warnings */
229
230#define _cast64_efi_call0(f) \
231  efi_call0(f)
232#define _cast64_efi_call1(f,a1) \
233  efi_call1(f, (UINT64)(a1))
234#define _cast64_efi_call2(f,a1,a2) \
235  efi_call2(f, (UINT64)(a1), (UINT64)(a2))
236#define _cast64_efi_call3(f,a1,a2,a3) \
237  efi_call3(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3))
238#define _cast64_efi_call4(f,a1,a2,a3,a4) \
239  efi_call4(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4))
240#define _cast64_efi_call5(f,a1,a2,a3,a4,a5) \
241  efi_call5(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
242            (UINT64)(a5))
243#define _cast64_efi_call6(f,a1,a2,a3,a4,a5,a6) \
244  efi_call6(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
245            (UINT64)(a5), (UINT64)(a6))
246#define _cast64_efi_call7(f,a1,a2,a3,a4,a5,a6,a7) \
247  efi_call7(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
248            (UINT64)(a5), (UINT64)(a6), (UINT64)(a7))
249#define _cast64_efi_call8(f,a1,a2,a3,a4,a5,a6,a7,a8) \
250  efi_call8(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
251            (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8))
252#define _cast64_efi_call9(f,a1,a2,a3,a4,a5,a6,a7,a8,a9) \
253  efi_call9(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
254            (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8), \
255            (UINT64)(a9))
256#define _cast64_efi_call10(f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) \
257  efi_call10(f, (UINT64)(a1), (UINT64)(a2), (UINT64)(a3), (UINT64)(a4), \
258             (UINT64)(a5), (UINT64)(a6), (UINT64)(a7), (UINT64)(a8), \
259             (UINT64)(a9), (UINT64)(a10))
260
261/* main wrapper (va_num ignored) */
262
263#define uefi_call_wrapper(func,va_num,...)                        \
264  __VA_ARG_NSUFFIX__(_cast64_efi_call, __VA_ARGS__) (func , ##__VA_ARGS__)
265
266#else
267
268#define uefi_call_wrapper(func, va_num, ...) func(__VA_ARGS__)
269
270#endif
271
272/* AED EFI definitions */
273
274#if defined(_AED_EFI)
275
276/* _int64 works for both IA32 and IA64 */
277
278#define COMPILER_DEPENDENT_INT64   __int64
279#define COMPILER_DEPENDENT_UINT64  unsigned __int64
280
281/*
282 * Calling conventions:
283 *
284 * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
285 * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
286 * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
287 * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
288 */
289#define ACPI_SYSTEM_XFACE
290#define ACPI_EXTERNAL_XFACE
291#define ACPI_INTERNAL_XFACE
292#define ACPI_INTERNAL_VAR_XFACE
293
294/* warn C4142: redefinition of type */
295
296#pragma warning(disable:4142)
297
298#endif
299
300
301/* GNU EFI definitions */
302
303#if defined(_GNU_EFI)
304
305/* Using GCC for GNU EFI */
306
307#include "acgcc.h"
308
309#undef ACPI_USE_SYSTEM_CLIBRARY
310#undef ACPI_USE_STANDARD_HEADERS
311#undef ACPI_USE_NATIVE_DIVIDE
312#define ACPI_USE_SYSTEM_INTTYPES
313
314/*
315 * Math helpers
316 */
317#define ACPI_DIV_64_BY_32(n_hi, n_lo, d32, q32, r32) \
318    do {                                             \
319        UINT64 __n = ((UINT64) n_hi) << 32 | (n_lo); \
320        (q32) = DivU64x32 ((__n), (d32), &(r32));    \
321    } while (0)
322
323#define ACPI_SHIFT_RIGHT_64(n_hi, n_lo) \
324    do {                                \
325        (n_lo) >>= 1;                   \
326        (n_lo) |= (((n_hi) & 1) << 31); \
327        (n_hi) >>= 1;                   \
328    } while (0)
329
330
331#endif
332
333struct _SIMPLE_TEXT_OUTPUT_INTERFACE;
334struct _SIMPLE_INPUT_INTERFACE;
335struct _EFI_FILE_IO_INTERFACE;
336struct _EFI_FILE_HANDLE;
337struct _EFI_BOOT_SERVICES;
338struct _EFI_SYSTEM_TABLE;
339
340extern struct _EFI_SYSTEM_TABLE         *ST;
341extern struct _EFI_BOOT_SERVICES        *BS;
342
343#define ACPI_FILE           struct _SIMPLE_TEXT_OUTPUT_INTERFACE *
344#define ACPI_FILE_OUT       ST->ConOut
345#define ACPI_FILE_ERR       ST->ConOut
346
347#endif /* __ACEFI_H__ */
348