xref: /DragonStub/inc/aarch64/efibind.h (revision f412fd2a1a248b546b7085648dece8d908077fab)
1 /*
2  * Copright (C) 2014 - 2015 Linaro Ltd.
3  * Author: Ard Biesheuvel <ard.biesheuvel@linaro.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice and this list of conditions, without modification.
10  * 2. The name of the author may not be used to endorse or promote products
11  *    derived from this software without specific prior written permission.
12  *
13  * Alternatively, this software may be distributed under the terms of the
14  * GNU General Public License as published by the Free Software Foundation;
15  * either version 2 of the License, or (at your option) any later version.
16  */
17 
18 #if !defined(_MSC_VER) && (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L )) && !defined(__cplusplus)
19 
20 // ANSI C 1999/2000 stdint.h integer width declarations
21 
22 typedef unsigned long       uint64_t;
23 typedef long                int64_t;
24 typedef unsigned int        uint32_t;
25 typedef int                 int32_t;
26 typedef unsigned short      uint16_t;
27 typedef short               int16_t;
28 typedef unsigned char       uint8_t;
29 typedef signed char         int8_t;   // unqualified 'char' is unsigned on ARM
30 typedef uint64_t            uintptr_t;
31 typedef int64_t             intptr_t;
32 
33 #else
34 #include <stdint.h>
35 #endif
36 
37 //
38 // Basic EFI types of various widths
39 //
40 
41 #include <stddef.h>
42 
43 typedef wchar_t CHAR16;
44 #define WCHAR CHAR16
45 
46 typedef uint64_t   UINT64;
47 typedef int64_t    INT64;
48 
49 typedef uint32_t   UINT32;
50 typedef int32_t    INT32;
51 
52 typedef uint16_t   UINT16;
53 typedef int16_t    INT16;
54 
55 typedef uint8_t    UINT8;
56 typedef char       CHAR8;
57 typedef int8_t     INT8;
58 
59 #undef VOID
60 typedef void       VOID;
61 
62 typedef int64_t    INTN;
63 typedef uint64_t   UINTN;
64 
65 #define EFIERR(a)           (0x8000000000000000 | a)
66 #define EFI_ERROR_MASK      0x8000000000000000
67 #define EFIERR_OEM(a)       (0xc000000000000000 | a)
68 
69 #define BAD_POINTER         0xFBFBFBFBFBFBFBFB
70 #define MAX_ADDRESS         0xFFFFFFFFFFFFFFFF
71 
72 #define BREAKPOINT()        while (TRUE);    // Make it hang on Bios[Dbg]32
73 
74 //
75 // Pointers must be aligned to these address to function
76 //
77 
78 #define MIN_ALIGNMENT_SIZE  8
79 
80 #define ALIGN_VARIABLE(Value ,Adjustment) \
81             (UINTN)Adjustment = 0; \
82             if((UINTN)Value % MIN_ALIGNMENT_SIZE) \
83                 (UINTN)Adjustment = MIN_ALIGNMENT_SIZE - ((UINTN)Value % MIN_ALIGNMENT_SIZE); \
84             Value = (UINTN)Value + (UINTN)Adjustment
85 
86 
87 //
88 // Define macros to build data structure signatures from characters.
89 //
90 
91 #define EFI_SIGNATURE_16(A,B)             ((A) | (B<<8))
92 #define EFI_SIGNATURE_32(A,B,C,D)         (EFI_SIGNATURE_16(A,B)     | (EFI_SIGNATURE_16(C,D)     << 16))
93 #define EFI_SIGNATURE_64(A,B,C,D,E,F,G,H) (EFI_SIGNATURE_32(A,B,C,D) | ((UINT64)(EFI_SIGNATURE_32(E,F,G,H)) << 32))
94 
95 //
96 // EFIAPI - prototype calling convention for EFI function pointers
97 // BOOTSERVICE - prototype for implementation of a boot service interface
98 // RUNTIMESERVICE - prototype for implementation of a runtime service interface
99 // RUNTIMEFUNCTION - prototype for implementation of a runtime function that is not a service
100 // RUNTIME_CODE - pragma macro for declaring runtime code
101 //
102 
103 #ifndef EFIAPI          // Forces EFI calling conventions reguardless of compiler options
104 #define EFIAPI          // Substitute expresion to force C calling convention
105 #endif
106 
107 #define BOOTSERVICE
108 #define RUNTIMESERVICE
109 #define RUNTIMEFUNCTION
110 
111 
112 #define RUNTIME_CODE(a)         alloc_text("rtcode", a)
113 #define BEGIN_RUNTIME_DATA()    data_seg("rtdata")
114 #define END_RUNTIME_DATA()      data_seg("")
115 
116 #define VOLATILE                volatile
117 
118 #define MEMORY_FENCE            __sync_synchronize
119 
120 //
121 // When build similiar to FW, then link everything together as
122 // one big module. For the MSVC toolchain, we simply tell the
123 // linker what our driver init function is using /ENTRY.
124 //
125 #if defined(_MSC_EXTENSIONS)
126 #define EFI_DRIVER_ENTRY_POINT(InitFunction) \
127     __pragma(comment(linker, "/ENTRY:" # InitFunction))
128 #else
129 #define EFI_DRIVER_ENTRY_POINT(InitFunction)    \
130     UINTN                                       \
131     InitializeDriver (                          \
132         VOID    *ImageHandle,                   \
133         VOID    *SystemTable                    \
134         )                                       \
135     {                                           \
136         return InitFunction(ImageHandle,        \
137                 SystemTable);                   \
138     }                                           \
139                                                 \
140     EFI_STATUS efi_main(                        \
141         EFI_HANDLE image,                       \
142         EFI_SYSTEM_TABLE *systab                \
143         ) __attribute__((weak,                  \
144                 alias ("InitializeDriver")));
145 #endif
146 
147 #define LOAD_INTERNAL_DRIVER(_if, type, name, entry)    \
148         (_if)->LoadInternal(type, name, entry)
149 
150 
151 //
152 // Some compilers don't support the forward reference construct:
153 //  typedef struct XXXXX
154 //
155 // The following macro provide a workaround for such cases.
156 
157 #define INTERFACE_DECL(x) struct x
158 
159 #define uefi_call_wrapper(func, va_num, ...) func(__VA_ARGS__)
160 #define EFI_FUNCTION
161