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(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L ) 19 20 // ANSI C 1999/2000 stdint.h integer width declarations 21 22 typedef unsigned long long uint64_t; 23 typedef long 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 31 #else 32 #include <stdint.h> 33 #endif 34 35 /* 36 * This prevents GCC from emitting GOT based relocations, and use R_ARM_REL32 37 * relative relocations instead, which are more suitable for static binaries. 38 */ 39 #pragma GCC visibility push (hidden) 40 41 // 42 // Basic EFI types of various widths 43 // 44 45 #ifndef __WCHAR_TYPE__ 46 # define __WCHAR_TYPE__ short 47 #endif 48 49 typedef uint64_t UINT64; 50 typedef int64_t INT64; 51 52 typedef uint32_t UINT32; 53 typedef int32_t INT32; 54 55 typedef uint16_t UINT16; 56 typedef int16_t INT16; 57 typedef uint8_t UINT8; 58 typedef int8_t INT8; 59 typedef __WCHAR_TYPE__ WCHAR; 60 61 #undef VOID 62 #define VOID void 63 64 typedef int32_t INTN; 65 typedef uint32_t UINTN; 66 67 #define EFIERR(a) (0x80000000 | a) 68 #define EFI_ERROR_MASK 0x80000000 69 #define EFIERR_OEM(a) (0xc0000000 | a) 70 71 #define BAD_POINTER 0xFBFBFBFB 72 #define MAX_ADDRESS 0xFFFFFFFF 73 74 #define BREAKPOINT() while (TRUE); 75 76 // 77 // Pointers must be aligned to these address to function 78 // 79 80 #define MIN_ALIGNMENT_SIZE 4 81 82 #define ALIGN_VARIABLE(Value ,Adjustment) \ 83 (UINTN)Adjustment = 0; \ 84 if((UINTN)Value % MIN_ALIGNMENT_SIZE) \ 85 (UINTN)Adjustment = MIN_ALIGNMENT_SIZE - ((UINTN)Value % MIN_ALIGNMENT_SIZE); \ 86 Value = (UINTN)Value + (UINTN)Adjustment 87 88 89 // 90 // Define macros to build data structure signatures from characters. 91 // 92 93 #define EFI_SIGNATURE_16(A,B) ((A) | (B<<8)) 94 #define EFI_SIGNATURE_32(A,B,C,D) (EFI_SIGNATURE_16(A,B) | (EFI_SIGNATURE_16(C,D) << 16)) 95 #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)) 96 97 // 98 // EFIAPI - prototype calling convention for EFI function pointers 99 // BOOTSERVICE - prototype for implementation of a boot service interface 100 // RUNTIMESERVICE - prototype for implementation of a runtime service interface 101 // RUNTIMEFUNCTION - prototype for implementation of a runtime function that is not a service 102 // RUNTIME_CODE - pragma macro for declaring runtime code 103 // 104 105 #ifndef EFIAPI // Forces EFI calling conventions reguardless of compiler options 106 #define EFIAPI // Substitute expresion to force C calling convention 107 #endif 108 109 #define BOOTSERVICE 110 #define RUNTIMESERVICE 111 #define RUNTIMEFUNCTION 112 113 114 #define RUNTIME_CODE(a) alloc_text("rtcode", a) 115 #define BEGIN_RUNTIME_DATA() data_seg("rtdata") 116 #define END_RUNTIME_DATA() data_seg("") 117 118 #define VOLATILE volatile 119 120 #define MEMORY_FENCE __sync_synchronize 121 122 // 123 // When build similiar to FW, then link everything together as 124 // one big module. 125 // 126 127 #define EFI_DRIVER_ENTRY_POINT(InitFunction) \ 128 UINTN \ 129 InitializeDriver ( \ 130 VOID *ImageHandle, \ 131 VOID *SystemTable \ 132 ) \ 133 { \ 134 return InitFunction(ImageHandle, \ 135 SystemTable); \ 136 } \ 137 \ 138 EFI_STATUS efi_main( \ 139 EFI_HANDLE image, \ 140 EFI_SYSTEM_TABLE *systab \ 141 ) __attribute__((weak, \ 142 alias ("InitializeDriver"))); 143 144 #define LOAD_INTERNAL_DRIVER(_if, type, name, entry) \ 145 (_if)->LoadInternal(type, name, entry) 146 147 148 // 149 // Some compilers don't support the forward reference construct: 150 // typedef struct XXXXX 151 // 152 // The following macro provide a workaround for such cases. 153 154 #define INTERFACE_DECL(x) struct x 155 156 #define uefi_call_wrapper(func, va_num, ...) func(__VA_ARGS__) 157 #define EFI_FUNCTION 158 159 static inline UINT64 DivU64x32(UINT64 Dividend, UINTN Divisor, UINTN *Remainder) 160 { 161 /* 162 * GCC turns a division into a multiplication and shift with precalculated 163 * constants if the divisor is constant and the dividend fits into a 32 bit 164 * variable. Otherwise, it will turn this into calls into the 32-bit div 165 * library functions. 166 */ 167 if (Remainder) 168 *Remainder = Dividend % Divisor; 169 Dividend = Dividend / Divisor; 170 return Dividend; 171 } 172