BaseTypes.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. /** @file
  2. Processor or Compiler specific defines for all supported processors.
  3. This file is stand alone self consistent set of definitions.
  4. Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  5. This program and the accompanying materials
  6. are licensed and made available under the terms and conditions of the BSD License
  7. which accompanies this distribution. The full text of the license may be found at
  8. http://opensource.org/licenses/bsd-license.php
  9. THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11. **/
  12. #ifndef __BASE_TYPES_H__
  13. #define __BASE_TYPES_H__
  14. //
  15. // Include processor specific binding
  16. //
  17. #include <ProcessorBind.h>
  18. #include <stdarg.h>
  19. //
  20. // Modifiers to abstract standard types to aid in debug of problems
  21. //
  22. #define CONST const
  23. #define STATIC static
  24. #define VOID void
  25. //
  26. // Modifiers for Data Types used to self document code.
  27. // This concept is borrowed for UEFI specification.
  28. //
  29. #ifndef IN
  30. //
  31. // Some other environments use this construct, so #ifndef to prevent
  32. // multiple definition.
  33. //
  34. #define IN
  35. #define OUT
  36. #define OPTIONAL
  37. #endif
  38. //
  39. // Constants. They may exist in other build structures, so #ifndef them.
  40. //
  41. #ifndef TRUE
  42. //
  43. // BugBug: UEFI specification claims 1 and 0. We are concerned about the
  44. // compiler portability so we did it this way.
  45. //
  46. #define TRUE ((BOOLEAN)(1==1))
  47. #endif
  48. #ifndef FALSE
  49. #define FALSE ((BOOLEAN)(0==1))
  50. #endif
  51. #ifndef NULL
  52. #define NULL ((VOID *) 0)
  53. #endif
  54. //
  55. // Support for variable length argument lists using the ANSI standard.
  56. //
  57. // Since we are using the ANSI standard we used the standard naming and
  58. // did not follow the coding convention
  59. //
  60. // VA_LIST - typedef for argument list.
  61. // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
  62. // VA_END (VA_LIST Marker) - Clear Marker
  63. // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
  64. // the ... list. You must know the size and pass it in this macro.
  65. //
  66. // example:
  67. //
  68. // UINTN
  69. // ExampleVarArg (
  70. // IN UINTN NumberOfArgs,
  71. // ...
  72. // )
  73. // {
  74. // VA_LIST Marker;
  75. // UINTN Index;
  76. // UINTN Result;
  77. //
  78. // //
  79. // // Initialize the Marker
  80. // //
  81. // VA_START (Marker, NumberOfArgs);
  82. // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
  83. // //
  84. // // The ... list is a series of UINTN values, so average them up.
  85. // //
  86. // Result += VA_ARG (Marker, UINTN);
  87. // }
  88. //
  89. // VA_END (Marker);
  90. // return Result
  91. // }
  92. //
  93. #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
  94. //
  95. // Also support coding convention rules for var arg macros
  96. //
  97. #ifndef VA_START
  98. // typedef CHAR8 *VA_LIST;
  99. // #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
  100. // #define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
  101. // #define VA_END(ap) (ap = (VA_LIST) 0)
  102. // Use the native arguments for tools.
  103. #define VA_START va_start
  104. #define VA_ARG va_arg
  105. #define VA_END va_end
  106. #define VA_LIST va_list
  107. #endif
  108. #ifndef GUID_DEFINED
  109. #define GUID_DEFINED
  110. ///
  111. /// 128 bit buffer containing a unique identifier value.
  112. /// Unless otherwise specified, aligned on a 64 bit boundary.
  113. ///
  114. typedef struct {
  115. UINT32 Data1;
  116. UINT16 Data2;
  117. UINT16 Data3;
  118. UINT8 Data4[8];
  119. } GUID;
  120. #endif
  121. ///
  122. /// 4-byte buffer. An IPv4 internet protocol address.
  123. ///
  124. typedef struct {
  125. UINT8 Addr[4];
  126. } IPv4_ADDRESS;
  127. ///
  128. /// 16-byte buffer. An IPv6 internet protocol address.
  129. ///
  130. typedef struct {
  131. UINT8 Addr[16];
  132. } IPv6_ADDRESS;
  133. //
  134. // Macro that returns the byte offset of a field in a data structure.
  135. //
  136. #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
  137. ///
  138. /// _CR - returns a pointer to the structure
  139. /// from one of it's elements.
  140. ///
  141. #define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
  142. ///
  143. /// ALIGN_POINTER - aligns a pointer to the lowest boundary
  144. ///
  145. #define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
  146. ///
  147. /// ALIGN_VARIABLE - aligns a variable up to the next natural boundary for int size of a processor
  148. ///
  149. #define ALIGN_VARIABLE(Value, Adjustment) \
  150. Adjustment = 0U; \
  151. if ((UINTN) (Value) % sizeof (UINTN)) { \
  152. (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
  153. } \
  154. (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
  155. //
  156. // Return the maximum of two operands.
  157. // This macro returns the maximum of two operand specified by a and b.
  158. // Both a and b must be the same numerical types, signed or unsigned.
  159. //
  160. #define MAX(a, b) \
  161. (((a) > (b)) ? (a) : (b))
  162. //
  163. // Return the minimum of two operands.
  164. // This macro returns the minimal of two operand specified by a and b.
  165. // Both a and b must be the same numerical types, signed or unsigned.
  166. //
  167. #define MIN(a, b) \
  168. (((a) < (b)) ? (a) : (b))
  169. //
  170. // EFI Error Codes common to all execution phases
  171. //
  172. typedef UINTN RETURN_STATUS;
  173. ///
  174. /// Set the upper bit to indicate EFI Error.
  175. ///
  176. #define ENCODE_ERROR(a) ((RETURN_STATUS)(MAX_BIT | (a)))
  177. #define ENCODE_WARNING(a) ((RETURN_STATUS)(a))
  178. #define RETURN_ERROR(a) (((INTN)(RETURN_STATUS)(a)) < 0)
  179. #define RETURN_SUCCESS 0
  180. #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
  181. #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
  182. #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
  183. #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
  184. #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
  185. #define RETURN_NOT_READY ENCODE_ERROR (6)
  186. #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
  187. #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
  188. #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
  189. #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
  190. #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
  191. #define RETURN_NO_MEDIA ENCODE_ERROR (12)
  192. #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
  193. #define RETURN_NOT_FOUND ENCODE_ERROR (14)
  194. #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
  195. #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
  196. #define RETURN_NO_MAPPING ENCODE_ERROR (17)
  197. #define RETURN_TIMEOUT ENCODE_ERROR (18)
  198. #define RETURN_NOT_STARTED ENCODE_ERROR (19)
  199. #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
  200. #define RETURN_ABORTED ENCODE_ERROR (21)
  201. #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
  202. #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
  203. #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
  204. #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
  205. #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
  206. #define RETURN_CRC_ERROR ENCODE_ERROR (27)
  207. #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
  208. #define RETURN_END_OF_FILE ENCODE_ERROR (31)
  209. #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
  210. #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
  211. #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
  212. #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
  213. typedef UINT64 PHYSICAL_ADDRESS;
  214. #define BIT0 0x00000001
  215. #define BIT1 0x00000002
  216. #define BIT2 0x00000004
  217. #define BIT3 0x00000008
  218. #define BIT4 0x00000010
  219. #define BIT5 0x00000020
  220. #define BIT6 0x00000040
  221. #define BIT7 0x00000080
  222. #define BIT8 0x00000100
  223. #define BIT9 0x00000200
  224. #define BIT10 0x00000400
  225. #define BIT11 0x00000800
  226. #define BIT12 0x00001000
  227. #define BIT13 0x00002000
  228. #define BIT14 0x00004000
  229. #define BIT15 0x00008000
  230. #define BIT16 0x00010000
  231. #define BIT17 0x00020000
  232. #define BIT18 0x00040000
  233. #define BIT19 0x00080000
  234. #define BIT20 0x00100000
  235. #define BIT21 0x00200000
  236. #define BIT22 0x00400000
  237. #define BIT23 0x00800000
  238. #define BIT24 0x01000000
  239. #define BIT25 0x02000000
  240. #define BIT26 0x04000000
  241. #define BIT27 0x08000000
  242. #define BIT28 0x10000000
  243. #define BIT29 0x20000000
  244. #define BIT30 0x40000000
  245. #define BIT31 0x80000000
  246. #define BIT32 0x0000000100000000ULL
  247. #define BIT33 0x0000000200000000ULL
  248. #define BIT34 0x0000000400000000ULL
  249. #define BIT35 0x0000000800000000ULL
  250. #define BIT36 0x0000001000000000ULL
  251. #define BIT37 0x0000002000000000ULL
  252. #define BIT38 0x0000004000000000ULL
  253. #define BIT39 0x0000008000000000ULL
  254. #define BIT40 0x0000010000000000ULL
  255. #define BIT41 0x0000020000000000ULL
  256. #define BIT42 0x0000040000000000ULL
  257. #define BIT43 0x0000080000000000ULL
  258. #define BIT44 0x0000100000000000ULL
  259. #define BIT45 0x0000200000000000ULL
  260. #define BIT46 0x0000400000000000ULL
  261. #define BIT47 0x0000800000000000ULL
  262. #define BIT48 0x0001000000000000ULL
  263. #define BIT49 0x0002000000000000ULL
  264. #define BIT50 0x0004000000000000ULL
  265. #define BIT51 0x0008000000000000ULL
  266. #define BIT52 0x0010000000000000ULL
  267. #define BIT53 0x0020000000000000ULL
  268. #define BIT54 0x0040000000000000ULL
  269. #define BIT55 0x0080000000000000ULL
  270. #define BIT56 0x0100000000000000ULL
  271. #define BIT57 0x0200000000000000ULL
  272. #define BIT58 0x0400000000000000ULL
  273. #define BIT59 0x0800000000000000ULL
  274. #define BIT60 0x1000000000000000ULL
  275. #define BIT61 0x2000000000000000ULL
  276. #define BIT62 0x4000000000000000ULL
  277. #define BIT63 0x8000000000000000ULL
  278. #endif