projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 959ccb23 | 1 | /** @file\r |
| 959ccb23 | 2 | Root include file for Mde Package Base type modules\r |
| 3 | \r | |
| 4 | This is the include file for any module of type base. Base modules only use \r | |
| 5 | types defined via this include file and can be ported easily to any \r | |
| 6 | environment. There are a set of base libraries in the Mde Package that can\r | |
| 7 | be used to implement base modules.\r | |
| 8 | \r | |
| 3963c4bf | 9 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r |
| 959ccb23 | 10 | All rights reserved. This program and the accompanying materials\r |
| 11 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 12 | which accompanies this distribution. The full text of the license may be found at\r | |
| 13 | http://opensource.org/licenses/bsd-license.php\r | |
| 14 | \r | |
| 15 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 16 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 17 | \r | |
| 18 | **/\r | |
| 19 | \r | |
| 20 | \r | |
| 21 | #ifndef __BASE_H__\r | |
| 22 | #define __BASE_H__\r | |
| 23 | \r | |
| 24 | //\r | |
| 25 | // Include processor specific binding\r | |
| 26 | //\r | |
| 27 | #include <ProcessorBind.h>\r | |
| 28 | \r | |
| f4ec40ab | 29 | ///\r |
| 30 | /// 128 bit buffer containing a unique identifier value. \r | |
| 31 | /// Unless otherwise specified, aligned on a 64 bit boundary.\r | |
| 32 | ///\r | |
| 959ccb23 | 33 | typedef struct {\r |
| 34 | UINT32 Data1;\r | |
| 35 | UINT16 Data2;\r | |
| 36 | UINT16 Data3;\r | |
| 37 | UINT8 Data4[8];\r | |
| 38 | } GUID;\r | |
| 39 | \r | |
| 3963c4bf | 40 | //\r |
| 41 | // 8-bytes unsigned value that represents a physical system address.\r | |
| 42 | //\r | |
| 959ccb23 | 43 | typedef UINT64 PHYSICAL_ADDRESS;\r |
| 44 | \r | |
| 62991af2 | 45 | ///\r |
| f4ec40ab | 46 | /// LIST_ENTRY structure definition.\r |
| 62991af2 | 47 | ///\r |
| 959ccb23 | 48 | typedef struct _LIST_ENTRY LIST_ENTRY;\r |
| 49 | \r | |
| f4ec40ab | 50 | ///\r |
| 51 | /// _LIST_ENTRY structure definition.\r | |
| 52 | ///\r | |
| 959ccb23 | 53 | struct _LIST_ENTRY {\r |
| 54 | LIST_ENTRY *ForwardLink;\r | |
| 55 | LIST_ENTRY *BackLink;\r | |
| 56 | };\r | |
| 57 | \r | |
| 58 | //\r | |
| 3963c4bf | 59 | // Modifiers to abstract standard types to aid in debug of problems\r |
| 959ccb23 | 60 | //\r |
| f4ec40ab | 61 | \r |
| 62 | ///\r | |
| 63 | /// Datum is read-only\r | |
| 64 | ///\r | |
| 959ccb23 | 65 | #define CONST const\r |
| f4ec40ab | 66 | \r |
| 67 | ///\r | |
| 68 | /// Datum is scoped to the current file or function\r | |
| 69 | ///\r | |
| 959ccb23 | 70 | #define STATIC static\r |
| f4ec40ab | 71 | \r |
| 72 | ///\r | |
| f7e994ab | 73 | /// Undeclared type\r |
| f4ec40ab | 74 | ///\r |
| 959ccb23 | 75 | #define VOID void\r |
| 76 | \r | |
| 77 | //\r | |
| 78 | // Modifiers for Data Types used to self document code.\r | |
| 79 | // This concept is borrowed for UEFI specification.\r | |
| 80 | //\r | |
| f4ec40ab | 81 | \r |
| 82 | ///\r | |
| 83 | /// Datum is passed to the function\r | |
| 84 | ///\r | |
| 959ccb23 | 85 | #define IN\r |
| f4ec40ab | 86 | \r |
| 87 | ///\r | |
| 88 | /// Datum is returned from the function\r | |
| 89 | ///\r | |
| 959ccb23 | 90 | #define OUT\r |
| f4ec40ab | 91 | \r |
| 92 | ///\r | |
| 93 | /// Passing the datum to the function is optional, and a NULL\r | |
| 94 | /// be passed if the value is not supplied.\r | |
| 95 | ///\r | |
| 959ccb23 | 96 | #define OPTIONAL\r |
| 959ccb23 | 97 | \r |
| 959ccb23 | 98 | //\r |
| 99 | // UEFI specification claims 1 and 0. We are concerned about the \r | |
| 100 | // complier portability so we did it this way.\r | |
| 101 | //\r | |
| f4ec40ab | 102 | \r |
| 103 | ///\r | |
| 104 | /// Boolean true value. UEFI Specification defines this value to be 1,\r | |
| 105 | /// but this form is more portable.\r | |
| 106 | ///\r | |
| 959ccb23 | 107 | #define TRUE ((BOOLEAN)(1==1))\r |
| f4ec40ab | 108 | \r |
| 109 | ///\r | |
| 110 | /// Boolean false value. UEFI Specification defines this value to be 0,\r | |
| 111 | /// but this form is more portable.\r | |
| 112 | ///\r | |
| 959ccb23 | 113 | #define FALSE ((BOOLEAN)(0==1))\r |
| 959ccb23 | 114 | \r |
| f4ec40ab | 115 | ///\r |
| 116 | /// NULL pointer (VOID *)\r | |
| 117 | ///\r | |
| 959ccb23 | 118 | #define NULL ((VOID *) 0)\r |
| 959ccb23 | 119 | \r |
| 3963c4bf | 120 | \r |
| 959ccb23 | 121 | #define BIT0 0x00000001\r |
| 122 | #define BIT1 0x00000002\r | |
| 123 | #define BIT2 0x00000004\r | |
| 124 | #define BIT3 0x00000008\r | |
| 125 | #define BIT4 0x00000010\r | |
| 126 | #define BIT5 0x00000020\r | |
| 127 | #define BIT6 0x00000040\r | |
| 128 | #define BIT7 0x00000080\r | |
| 129 | #define BIT8 0x00000100\r | |
| 130 | #define BIT9 0x00000200\r | |
| 131 | #define BIT10 0x00000400\r | |
| 132 | #define BIT11 0x00000800\r | |
| 133 | #define BIT12 0x00001000\r | |
| 134 | #define BIT13 0x00002000\r | |
| 135 | #define BIT14 0x00004000\r | |
| 136 | #define BIT15 0x00008000\r | |
| 137 | #define BIT16 0x00010000\r | |
| 138 | #define BIT17 0x00020000\r | |
| 139 | #define BIT18 0x00040000\r | |
| 140 | #define BIT19 0x00080000\r | |
| 141 | #define BIT20 0x00100000\r | |
| 142 | #define BIT21 0x00200000\r | |
| 143 | #define BIT22 0x00400000\r | |
| 144 | #define BIT23 0x00800000\r | |
| 145 | #define BIT24 0x01000000\r | |
| 146 | #define BIT25 0x02000000\r | |
| 147 | #define BIT26 0x04000000\r | |
| 148 | #define BIT27 0x08000000\r | |
| 149 | #define BIT28 0x10000000\r | |
| 150 | #define BIT29 0x20000000\r | |
| 151 | #define BIT30 0x40000000\r | |
| 152 | #define BIT31 0x80000000\r | |
| 4d24730c | 153 | #define BIT32 0x0000000100000000ULL\r |
| 154 | #define BIT33 0x0000000200000000ULL\r | |
| 155 | #define BIT34 0x0000000400000000ULL\r | |
| 156 | #define BIT35 0x0000000800000000ULL\r | |
| 157 | #define BIT36 0x0000001000000000ULL\r | |
| 158 | #define BIT37 0x0000002000000000ULL\r | |
| 159 | #define BIT38 0x0000004000000000ULL\r | |
| 160 | #define BIT39 0x0000008000000000ULL\r | |
| 161 | #define BIT40 0x0000010000000000ULL\r | |
| 162 | #define BIT41 0x0000020000000000ULL\r | |
| 163 | #define BIT42 0x0000040000000000ULL\r | |
| 164 | #define BIT43 0x0000080000000000ULL\r | |
| 165 | #define BIT44 0x0000100000000000ULL\r | |
| 166 | #define BIT45 0x0000200000000000ULL\r | |
| 167 | #define BIT46 0x0000400000000000ULL\r | |
| 168 | #define BIT47 0x0000800000000000ULL\r | |
| 169 | #define BIT48 0x0001000000000000ULL\r | |
| 170 | #define BIT49 0x0002000000000000ULL\r | |
| 171 | #define BIT50 0x0004000000000000ULL\r | |
| 172 | #define BIT51 0x0008000000000000ULL\r | |
| 173 | #define BIT52 0x0010000000000000ULL\r | |
| 174 | #define BIT53 0x0020000000000000ULL\r | |
| 175 | #define BIT54 0x0040000000000000ULL\r | |
| 176 | #define BIT55 0x0080000000000000ULL\r | |
| 177 | #define BIT56 0x0100000000000000ULL\r | |
| 178 | #define BIT57 0x0200000000000000ULL\r | |
| 179 | #define BIT58 0x0400000000000000ULL\r | |
| 180 | #define BIT59 0x0800000000000000ULL\r | |
| 181 | #define BIT60 0x1000000000000000ULL\r | |
| 182 | #define BIT61 0x2000000000000000ULL\r | |
| 183 | #define BIT62 0x4000000000000000ULL\r | |
| 184 | #define BIT63 0x8000000000000000ULL\r | |
| 959ccb23 | 185 | \r |
| 2e121e9a | 186 | #define SIZE_1KB 0x00000400\r |
| 187 | #define SIZE_2KB 0x00000800\r | |
| 188 | #define SIZE_4KB 0x00001000\r | |
| 189 | #define SIZE_8KB 0x00002000\r | |
| 190 | #define SIZE_16KB 0x00004000\r | |
| 191 | #define SIZE_32KB 0x00008000\r | |
| 192 | #define SIZE_64KB 0x00010000\r | |
| 193 | #define SIZE_128KB 0x00020000\r | |
| 194 | #define SIZE_256KB 0x00040000\r | |
| 195 | #define SIZE_512KB 0x00080000\r | |
| 196 | #define SIZE_1MB 0x00100000\r | |
| 197 | #define SIZE_2MB 0x00200000\r | |
| 198 | #define SIZE_4MB 0x00400000\r | |
| 199 | #define SIZE_8MB 0x00800000\r | |
| 200 | #define SIZE_16MB 0x01000000\r | |
| 201 | #define SIZE_32MB 0x02000000\r | |
| 202 | #define SIZE_64MB 0x04000000\r | |
| 203 | #define SIZE_128MB 0x08000000\r | |
| 204 | #define SIZE_256MB 0x10000000\r | |
| 205 | #define SIZE_512MB 0x20000000\r | |
| 206 | #define SIZE_1GB 0x40000000\r | |
| 207 | #define SIZE_2GB 0x80000000\r | |
| 208 | #define SIZE_4GB 0x0000000100000000ULL\r | |
| 209 | #define SIZE_8GB 0x0000000200000000ULL\r | |
| 210 | #define SIZE_16GB 0x0000000400000000ULL\r | |
| 211 | #define SIZE_32GB 0x0000000800000000ULL\r | |
| 212 | #define SIZE_64GB 0x0000001000000000ULL\r | |
| 213 | #define SIZE_128GB 0x0000002000000000ULL\r | |
| 214 | #define SIZE_256GB 0x0000004000000000ULL\r | |
| 215 | #define SIZE_512GB 0x0000008000000000ULL\r | |
| 216 | #define SIZE_1TB 0x0000010000000000ULL\r | |
| 217 | #define SIZE_2TB 0x0000020000000000ULL\r | |
| 218 | #define SIZE_4TB 0x0000040000000000ULL\r | |
| 219 | #define SIZE_8TB 0x0000080000000000ULL\r | |
| 220 | #define SIZE_16TB 0x0000100000000000ULL\r | |
| 221 | #define SIZE_32TB 0x0000200000000000ULL\r | |
| 222 | #define SIZE_64TB 0x0000400000000000ULL\r | |
| 223 | #define SIZE_128TB 0x0000800000000000ULL\r | |
| 224 | #define SIZE_256TB 0x0001000000000000ULL\r | |
| 225 | #define SIZE_512TB 0x0002000000000000ULL\r | |
| 226 | #define SIZE_1PB 0x0004000000000000ULL\r | |
| 227 | #define SIZE_2PB 0x0008000000000000ULL\r | |
| 228 | #define SIZE_4PB 0x0010000000000000ULL\r | |
| 229 | #define SIZE_8PB 0x0020000000000000ULL\r | |
| 230 | #define SIZE_16PB 0x0040000000000000ULL\r | |
| 231 | #define SIZE_32PB 0x0080000000000000ULL\r | |
| 232 | #define SIZE_64PB 0x0100000000000000ULL\r | |
| 233 | #define SIZE_128PB 0x0200000000000000ULL\r | |
| 234 | #define SIZE_256PB 0x0400000000000000ULL\r | |
| 235 | #define SIZE_512PB 0x0800000000000000ULL\r | |
| 236 | #define SIZE_1EB 0x1000000000000000ULL\r | |
| 237 | #define SIZE_2EB 0x2000000000000000ULL\r | |
| 238 | #define SIZE_4EB 0x4000000000000000ULL\r | |
| 239 | #define SIZE_8EB 0x8000000000000000ULL\r | |
| 240 | \r | |
| 241 | #define BASE_1KB 0x00000400\r | |
| 242 | #define BASE_2KB 0x00000800\r | |
| 243 | #define BASE_4KB 0x00001000\r | |
| 244 | #define BASE_8KB 0x00002000\r | |
| 245 | #define BASE_16KB 0x00004000\r | |
| 246 | #define BASE_32KB 0x00008000\r | |
| 247 | #define BASE_64KB 0x00010000\r | |
| 248 | #define BASE_128KB 0x00020000\r | |
| 249 | #define BASE_256KB 0x00040000\r | |
| 250 | #define BASE_512KB 0x00080000\r | |
| 251 | #define BASE_1MB 0x00100000\r | |
| 252 | #define BASE_2MB 0x00200000\r | |
| 253 | #define BASE_4MB 0x00400000\r | |
| 254 | #define BASE_8MB 0x00800000\r | |
| 255 | #define BASE_16MB 0x01000000\r | |
| 256 | #define BASE_32MB 0x02000000\r | |
| 257 | #define BASE_64MB 0x04000000\r | |
| 258 | #define BASE_128MB 0x08000000\r | |
| 259 | #define BASE_256MB 0x10000000\r | |
| 260 | #define BASE_512MB 0x20000000\r | |
| 261 | #define BASE_1GB 0x40000000\r | |
| 262 | #define BASE_2GB 0x80000000\r | |
| 263 | #define BASE_4GB 0x0000000100000000ULL\r | |
| 264 | #define BASE_8GB 0x0000000200000000ULL\r | |
| 265 | #define BASE_16GB 0x0000000400000000ULL\r | |
| 266 | #define BASE_32GB 0x0000000800000000ULL\r | |
| 267 | #define BASE_64GB 0x0000001000000000ULL\r | |
| 268 | #define BASE_128GB 0x0000002000000000ULL\r | |
| 269 | #define BASE_256GB 0x0000004000000000ULL\r | |
| 270 | #define BASE_512GB 0x0000008000000000ULL\r | |
| 271 | #define BASE_1TB 0x0000010000000000ULL\r | |
| 272 | #define BASE_2TB 0x0000020000000000ULL\r | |
| 273 | #define BASE_4TB 0x0000040000000000ULL\r | |
| 274 | #define BASE_8TB 0x0000080000000000ULL\r | |
| 275 | #define BASE_16TB 0x0000100000000000ULL\r | |
| 276 | #define BASE_32TB 0x0000200000000000ULL\r | |
| 277 | #define BASE_64TB 0x0000400000000000ULL\r | |
| 278 | #define BASE_128TB 0x0000800000000000ULL\r | |
| 279 | #define BASE_256TB 0x0001000000000000ULL\r | |
| 280 | #define BASE_512TB 0x0002000000000000ULL\r | |
| 281 | #define BASE_1PB 0x0004000000000000ULL\r | |
| 282 | #define BASE_2PB 0x0008000000000000ULL\r | |
| 283 | #define BASE_4PB 0x0010000000000000ULL\r | |
| 284 | #define BASE_8PB 0x0020000000000000ULL\r | |
| 285 | #define BASE_16PB 0x0040000000000000ULL\r | |
| 286 | #define BASE_32PB 0x0080000000000000ULL\r | |
| 287 | #define BASE_64PB 0x0100000000000000ULL\r | |
| 288 | #define BASE_128PB 0x0200000000000000ULL\r | |
| 289 | #define BASE_256PB 0x0400000000000000ULL\r | |
| 290 | #define BASE_512PB 0x0800000000000000ULL\r | |
| 291 | #define BASE_1EB 0x1000000000000000ULL\r | |
| 292 | #define BASE_2EB 0x2000000000000000ULL\r | |
| 293 | #define BASE_4EB 0x4000000000000000ULL\r | |
| 294 | #define BASE_8EB 0x8000000000000000ULL\r | |
| 295 | \r | |
| 959ccb23 | 296 | //\r |
| 297 | // Support for variable length argument lists using the ANSI standard.\r | |
| 298 | // \r | |
| 3963c4bf | 299 | // Since we are using the ANSI standard we used the standard naming and\r |
| 300 | // did not follow the coding convention\r | |
| 959ccb23 | 301 | //\r |
| 302 | // VA_LIST - typedef for argument list.\r | |
| 303 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
| 304 | // VA_END (VA_LIST Marker) - Clear Marker\r | |
| 3963c4bf | 305 | // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r |
| 959ccb23 | 306 | // the ... list. You must know the size and pass it in this macro.\r |
| 307 | //\r | |
| 308 | // example:\r | |
| 309 | //\r | |
| 310 | // UINTN\r | |
| 311 | // ExampleVarArg (\r | |
| 312 | // IN UINTN NumberOfArgs,\r | |
| 313 | // ...\r | |
| 314 | // )\r | |
| 315 | // {\r | |
| 316 | // VA_LIST Marker;\r | |
| 317 | // UINTN Index;\r | |
| 318 | // UINTN Result;\r | |
| 319 | //\r | |
| 320 | // //\r | |
| 321 | // // Initialize the Marker\r | |
| 322 | // //\r | |
| 323 | // VA_START (Marker, NumberOfArgs);\r | |
| 324 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
| 325 | // //\r | |
| 326 | // // The ... list is a series of UINTN values, so average them up.\r | |
| 327 | // //\r | |
| 328 | // Result += VA_ARG (Marker, UINTN);\r | |
| 329 | // }\r | |
| 330 | //\r | |
| 331 | // VA_END (Marker);\r | |
| 332 | // return Result\r | |
| 333 | // }\r | |
| 334 | //\r | |
| 0dcec411 | 335 | \r |
| 130a2eec | 336 | #if defined(__GNUC__)\r |
| 337 | //\r | |
| 0dcec411 | 338 | // Use GCC builtin macros for variable argument lists.\r |
| 130a2eec | 339 | //\r |
| 340 | typedef __builtin_va_list VA_LIST;\r | |
| 341 | \r | |
| 342 | #define VA_START(Marker, Parameter) __builtin_va_start(Marker, Parameter)\r | |
| 959ccb23 | 343 | \r |
| 130a2eec | 344 | #define VA_ARG(Marker, TYPE) __builtin_va_arg(Marker, TYPE)\r |
| 345 | \r | |
| 346 | #define VA_END(Marker) __builtin_va_end(Marker)\r | |
| 347 | \r | |
| 348 | #else\r | |
| c3d4e543 LG |
349 | /**\r |
| 350 | Return the size of argument that has been aligned to sizeof (UINTN).\r | |
| 351 | \r | |
| 352 | @param n The parameter size is to be aligned.\r | |
| 353 | \r | |
| 354 | @return The aligned size\r | |
| 355 | **/\r | |
| 959ccb23 | 356 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r |
| 357 | \r | |
| f4ec40ab | 358 | ///\r |
| 359 | /// Pointer to the start of a variable argument list. Same as CHAR8 *.\r | |
| 360 | ///\r | |
| 959ccb23 | 361 | typedef CHAR8 *VA_LIST;\r |
| 959ccb23 | 362 | \r |
| 3963c4bf | 363 | /**\r |
| 364 | Retrieves a pointer to the beginning of a variable argument list based on \r | |
| 365 | the name of the parameter that immediately precedes the variable argument list. \r | |
| 366 | \r | |
| 367 | This function initializes Marker to point to the beginning of the variable argument \r | |
| 368 | list that immediately follows Parameter. The method for computing the pointer to the \r | |
| 369 | next argument in the argument list is CPU specific following the EFIAPI ABI.\r | |
| 370 | \r | |
| 371 | @param Marker Pointer to the beginning of the variable argument list.\r | |
| 372 | @param Parameter The name of the parameter that immediately precedes \r | |
| 373 | the variable argument list.\r | |
| 374 | \r | |
| 375 | @return A pointer to the beginning of a variable argument list.\r | |
| 376 | \r | |
| 377 | **/\r | |
| 378 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r | |
| 379 | \r | |
| 380 | /**\r | |
| 381 | Returns an argument of a specified type from a variable argument list and updates \r | |
| 382 | the pointer to the variable argument list to point to the next argument. \r | |
| 383 | \r | |
| 384 | This function returns an argument of the type specified by TYPE from the beginning \r | |
| 385 | of the variable argument list specified by Marker. Marker is then updated to point \r | |
| 386 | to the next argument in the variable argument list. The method for computing the \r | |
| 387 | pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r | |
| 388 | \r | |
| 389 | @param Marker Pointer to the beginning of a variable argument list.\r | |
| 390 | @param TYPE The type of argument to retrieve from the beginning \r | |
| 391 | of the variable argument list.\r | |
| 392 | \r | |
| 393 | @return An argument of the type specified by TYPE.\r | |
| 394 | \r | |
| 395 | **/\r | |
| 396 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r | |
| 397 | \r | |
| 398 | /**\r | |
| 399 | Terminates the use of a variable argument list.\r | |
| 400 | \r | |
| 401 | This function initializes Marker so it can no longer be used with VA_ARG(). \r | |
| 402 | After this macro is used, the only way to access the variable argument list again is \r | |
| 403 | by using VA_START() again.\r | |
| 404 | \r | |
| 405 | @param Marker The variable to set to the beginning of the variable argument list.\r | |
| 406 | \r | |
| 407 | **/\r | |
| 408 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r | |
| 409 | \r | |
| 130a2eec | 410 | #endif\r |
| 411 | \r | |
| 3963c4bf | 412 | /**\r |
| 413 | Macro that returns the byte offset of a field in a data structure. \r | |
| 414 | \r | |
| 415 | This function returns the offset, in bytes, of field specified by Field from the \r | |
| 416 | beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r | |
| 417 | the module will not compile. \r | |
| 418 | \r | |
| 419 | @param TYPE The name of the data structure that contains the field specified by Field. \r | |
| 420 | @param Field The name of the field in the data structure.\r | |
| 421 | \r | |
| 422 | @return Offset, in bytes, of field.\r | |
| 423 | \r | |
| 424 | **/\r | |
| 959ccb23 | 425 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r |
| 426 | \r | |
| 3963c4bf | 427 | /**\r |
| 428 | Macro that returns a pointer to the data structure that contains a specified field of \r | |
| 429 | that data structure. This is a lightweight method to hide information by placing a \r | |
| 430 | public data structure inside a larger private data structure and using a pointer to \r | |
| 431 | the public data structure to retrieve a pointer to the private data structure.\r | |
| 432 | \r | |
| 433 | This function computes the offset, in bytes, of field specified by Field from the beginning \r | |
| 434 | of the data structure specified by TYPE. This offset is subtracted from Record, and is \r | |
| 435 | used to return a pointer to a data structure of the type specified by TYPE.If the data type \r | |
| 436 | specified by TYPE does not contain the field specified by Field, then the module will not compile. \r | |
| 437 | \r | |
| 438 | @param Record Pointer to the field specified by Field within a data structure of type TYPE. \r | |
| 439 | @param TYPE The name of the data structure type to return. This data structure must \r | |
| 440 | contain the field specified by Field. \r | |
| 441 | @param Field The name of the field in the data structure specified by TYPE to which Record points.\r | |
| 442 | \r | |
| 443 | @return A pointer to the structure from one of it's elements.\r | |
| 444 | \r | |
| 445 | **/\r | |
| 22ce9dc5 | 446 | #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r |
| 959ccb23 | 447 | \r |
| 3963c4bf | 448 | /**\r |
| 449 | Rounds a value up to the next boundary using a specified alignment. \r | |
| 450 | \r | |
| 451 | This function rounds Value up to the next boundary using the specified Alignment. \r | |
| 452 | This aligned value is returned. \r | |
| 453 | \r | |
| 454 | @param Value The value to round up.\r | |
| 455 | @param Alignment The alignment boundary used to return the aligned value.\r | |
| 456 | \r | |
| 457 | @return A value up to the next boundary.\r | |
| 458 | \r | |
| 459 | **/\r | |
| 3fef0f51 | 460 | #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r |
| 461 | \r | |
| 3963c4bf | 462 | /**\r |
| 463 | Adjust a pointer by adding the minimum offset required for it to be aligned on \r | |
| 464 | a specified alignment boundary. \r | |
| 465 | \r | |
| 466 | This function rounds the pointer specified by Pointer to the next alignment boundary \r | |
| 467 | specified by Alignment. The pointer to the aligned address is returned. \r | |
| 468 | \r | |
| 469 | @param Value The value to round up.\r | |
| 470 | @param Alignment The alignment boundary to use to return an aligned pointer.\r | |
| 471 | \r | |
| 472 | @return Pointer to the aligned address.\r | |
| 473 | \r | |
| 474 | **/\r | |
| 3fef0f51 | 475 | #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r |
| 959ccb23 | 476 | \r |
| 3963c4bf | 477 | /**\r |
| 478 | Rounds a value up to the next natural boundary for the current CPU. \r | |
| 479 | This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. \r | |
| 480 | \r | |
| 481 | This function rounds the value specified by Value up to the next natural boundary for the \r | |
| 482 | current CPU. This rounded value is returned. \r | |
| 483 | \r | |
| 484 | @param Value The value to round up.\r | |
| 485 | \r | |
| 486 | @return Rounded value specified by Value.\r | |
| 487 | \r | |
| 488 | **/\r | |
| 3fef0f51 | 489 | #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r |
| 490 | \r | |
| 959ccb23 | 491 | \r |
| 3963c4bf | 492 | /**\r |
| 493 | Return the maximum of two operands. \r | |
| 494 | \r | |
| 495 | This macro returns the maximum of two operand specified by a and b. \r | |
| 496 | Both a and b must be the same numerical types, signed or unsigned.\r | |
| 497 | \r | |
| 498 | @param TYPE Any numerical data types.\r | |
| 499 | @param a The first operand with any numerical type.\r | |
| 500 | @param b The second operand. It should be the same any numerical type with a.\r | |
| 501 | \r | |
| 502 | @return Maximum of two operands.\r | |
| 503 | \r | |
| 504 | **/\r | |
| 959ccb23 | 505 | #define MAX(a, b) \\r |
| 506 | (((a) > (b)) ? (a) : (b))\r | |
| 507 | \r | |
| 3963c4bf | 508 | /**\r |
| 509 | Return the minimum of two operands. \r | |
| 510 | \r | |
| 511 | This macro returns the minimal of two operand specified by a and b. \r | |
| 512 | Both a and b must be the same numerical types, signed or unsigned.\r | |
| 513 | \r | |
| 514 | @param TYPE Any numerical data types.\r | |
| 515 | @param a The first operand with any numerical type.\r | |
| 516 | @param b The second operand. It should be the same any numerical type with a.\r | |
| 517 | \r | |
| 518 | @return Minimum of two operands.\r | |
| 519 | \r | |
| 520 | **/\r | |
| 959ccb23 | 521 | \r |
| 959ccb23 | 522 | #define MIN(a, b) \\r |
| 523 | (((a) < (b)) ? (a) : (b))\r | |
| 524 | \r | |
| 959ccb23 | 525 | //\r |
| f4ec40ab | 526 | // Status codes common to all execution phases\r |
| 959ccb23 | 527 | //\r |
| 959ccb23 | 528 | typedef INTN RETURN_STATUS;\r |
| 529 | \r | |
| f4ec40ab | 530 | /**\r |
| 531 | Produces a RETURN_STATUS code with the highest bit set. \r | |
| 959ccb23 | 532 | \r |
| 40731047 | 533 | @param StatusCode The status code value to convert into a warning code. \r |
| f4ec40ab | 534 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
| 535 | \r | |
| 536 | @return The value specified by StatusCode with the highest bit set.\r | |
| 537 | \r | |
| 538 | **/\r | |
| 262ffea8 | 539 | #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r |
| 959ccb23 | 540 | \r |
| f4ec40ab | 541 | /**\r |
| 542 | Produces a RETURN_STATUS code with the highest bit clear. \r | |
| 543 | \r | |
| 40731047 | 544 | @param StatusCode The status code value to convert into a warning code. \r |
| f4ec40ab | 545 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
| 546 | \r | |
| 547 | @return The value specified by StatusCode with the highest bit clear.\r | |
| 548 | \r | |
| 549 | **/\r | |
| 262ffea8 | 550 | #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r |
| f4ec40ab | 551 | \r |
| 552 | /**\r | |
| 553 | Returns TRUE if a specified RETURN_STATUS code is an error code. \r | |
| 554 | \r | |
| 555 | This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r | |
| 556 | \r | |
| 40731047 | 557 | @param StatusCode The status code value to evaluate.\r |
| f4ec40ab | 558 | \r |
| 559 | @retval TRUE The high bit of StatusCode is set.\r | |
| 560 | @retval FALSE The high bit of StatusCode is clear.\r | |
| 561 | \r | |
| 562 | **/\r | |
| 262ffea8 | 563 | #define RETURN_ERROR(StatusCode) (((RETURN_STATUS)(StatusCode)) < 0)\r |
| f4ec40ab | 564 | \r |
| 565 | ///\r | |
| 566 | /// The operation completed successfully.\r | |
| 567 | ///\r | |
| 959ccb23 | 568 | #define RETURN_SUCCESS 0\r |
| f4ec40ab | 569 | \r |
| 570 | ///\r | |
| 571 | /// The image failed to load.\r | |
| 572 | ///\r | |
| 959ccb23 | 573 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r |
| f4ec40ab | 574 | \r |
| 575 | ///\r | |
| 576 | /// The parameter was incorrect.\r | |
| 577 | ///\r | |
| 959ccb23 | 578 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r |
| f4ec40ab | 579 | \r |
| 580 | ///\r | |
| 581 | /// The operation is not supported.\r | |
| 582 | ///\r | |
| 959ccb23 | 583 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r |
| f4ec40ab | 584 | \r |
| 585 | ///\r | |
| 586 | /// The buffer was not the proper size for the request.\r | |
| 587 | ///\r | |
| 959ccb23 | 588 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r |
| f4ec40ab | 589 | \r |
| 590 | ///\r | |
| 591 | /// The buffer was not large enough to hold the requested data.\r | |
| 592 | /// The required buffer size is returned in the appropriate\r | |
| 593 | /// parameter when this error occurs.\r | |
| 594 | ///\r | |
| 959ccb23 | 595 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r |
| f4ec40ab | 596 | \r |
| 597 | ///\r | |
| 80619162 | 598 | /// There is no data pending upon return.\r |
| f4ec40ab | 599 | ///\r |
| 959ccb23 | 600 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r |
| f4ec40ab | 601 | \r |
| 602 | ///\r | |
| 603 | /// The physical device reported an error while attempting the\r | |
| 604 | /// operation.\r | |
| 605 | ///\r | |
| 959ccb23 | 606 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r |
| f4ec40ab | 607 | \r |
| 608 | ///\r | |
| 609 | /// The device can not be written to.\r | |
| 610 | ///\r | |
| 959ccb23 | 611 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r |
| f4ec40ab | 612 | \r |
| 613 | ///\r | |
| 614 | /// The resource has run out.\r | |
| 615 | ///\r | |
| 959ccb23 | 616 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r |
| f4ec40ab | 617 | \r |
| 618 | ///\r | |
| 80619162 | 619 | /// An inconsistency was detected on the file system causing the \r |
| f4ec40ab | 620 | /// operation to fail.\r |
| 621 | ///\r | |
| 959ccb23 | 622 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r |
| f4ec40ab | 623 | \r |
| 624 | ///\r | |
| 625 | /// There is no more space on the file system.\r | |
| 626 | ///\r | |
| 959ccb23 | 627 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r |
| f4ec40ab | 628 | \r |
| 629 | ///\r | |
| 630 | /// The device does not contain any medium to perform the \r | |
| 631 | /// operation.\r | |
| 632 | ///\r | |
| 959ccb23 | 633 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r |
| f4ec40ab | 634 | \r |
| 635 | ///\r | |
| 636 | /// The medium in the device has changed since the last\r | |
| 637 | /// access.\r | |
| 638 | ///\r | |
| 959ccb23 | 639 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r |
| f4ec40ab | 640 | \r |
| 641 | ///\r | |
| 642 | /// The item was not found.\r | |
| 643 | ///\r | |
| 959ccb23 | 644 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r |
| f4ec40ab | 645 | \r |
| 646 | ///\r | |
| 647 | /// Access was denied.\r | |
| 648 | ///\r | |
| 959ccb23 | 649 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r |
| f4ec40ab | 650 | \r |
| 651 | ///\r | |
| 652 | /// The server was not found or did not respond to the request.\r | |
| 653 | ///\r | |
| 959ccb23 | 654 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r |
| f4ec40ab | 655 | \r |
| 656 | ///\r | |
| 657 | /// A mapping to the device does not exist.\r | |
| 658 | ///\r | |
| 959ccb23 | 659 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r |
| f4ec40ab | 660 | \r |
| 661 | ///\r | |
| 662 | /// A timeout time expired.\r | |
| 663 | ///\r | |
| 959ccb23 | 664 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r |
| f4ec40ab | 665 | \r |
| 666 | ///\r | |
| 667 | /// The protocol has not been started.\r | |
| 668 | ///\r | |
| 959ccb23 | 669 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r |
| f4ec40ab | 670 | \r |
| 671 | ///\r | |
| 672 | /// The protocol has already been started.\r | |
| 673 | ///\r | |
| 959ccb23 | 674 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r |
| f4ec40ab | 675 | \r |
| 676 | ///\r | |
| 677 | /// The operation was aborted.\r | |
| 678 | ///\r | |
| 959ccb23 | 679 | #define RETURN_ABORTED ENCODE_ERROR (21)\r |
| f4ec40ab | 680 | \r |
| 681 | ///\r | |
| 727501bb | 682 | /// An ICMP error occurred during the network operation.\r |
| f4ec40ab | 683 | ///\r |
| 959ccb23 | 684 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r |
| f4ec40ab | 685 | \r |
| 686 | ///\r | |
| 727501bb | 687 | /// A TFTP error occurred during the network operation.\r |
| f4ec40ab | 688 | ///\r |
| 959ccb23 | 689 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r |
| f4ec40ab | 690 | \r |
| 691 | ///\r | |
| 727501bb | 692 | /// A protocol error occurred during the network operation.\r |
| f4ec40ab | 693 | ///\r |
| 959ccb23 | 694 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r |
| f4ec40ab | 695 | \r |
| 696 | ///\r | |
| 697 | /// A function encountered an internal version that was\r | |
| 727501bb | 698 | /// incompatible with a version requested by the caller.\r |
| f4ec40ab | 699 | ///\r |
| 959ccb23 | 700 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r |
| f4ec40ab | 701 | \r |
| 702 | ///\r | |
| 703 | /// The function was not performed due to a security violation.\r | |
| 704 | ///\r | |
| 959ccb23 | 705 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r |
| f4ec40ab | 706 | \r |
| 707 | ///\r | |
| 708 | /// A CRC error was detected.\r | |
| 709 | ///\r | |
| 959ccb23 | 710 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r |
| f4ec40ab | 711 | \r |
| 712 | ///\r | |
| 713 | /// Beginning or end of media was reached.\r | |
| 714 | ///\r | |
| 959ccb23 | 715 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r |
| f4ec40ab | 716 | \r |
| 717 | ///\r | |
| 718 | /// The end of the file was reached.\r | |
| 719 | ///\r | |
| 959ccb23 | 720 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r |
| f4ec40ab | 721 | \r |
| 722 | ///\r | |
| 723 | /// The language specified was invalid.\r | |
| 724 | ///\r | |
| 54cf8780 | 725 | #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r |
| 726 | \r | |
| 959ccb23 | 727 | \r |
| f4ec40ab | 728 | ///\r |
| 729 | /// The Unicode string contained one or more characters that\r | |
| 730 | /// the device could not render and were skipped.\r | |
| 731 | ///\r | |
| 959ccb23 | 732 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r |
| f4ec40ab | 733 | \r |
| 734 | ///\r | |
| 735 | /// The handle was closed, but the file was not deleted.\r | |
| 736 | ///\r | |
| 959ccb23 | 737 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r |
| f4ec40ab | 738 | \r |
| 739 | ///\r | |
| 740 | /// The handle was closed, but the data to the file was not\r | |
| 741 | /// flushed properly.\r | |
| 742 | ///\r | |
| 959ccb23 | 743 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r |
| f4ec40ab | 744 | \r |
| 745 | ///\r | |
| 746 | /// The resulting buffer was too small, and the data was \r | |
| 747 | /// truncated to the buffer size.\r | |
| 748 | ///\r | |
| 959ccb23 | 749 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r |
| 750 | \r | |
| a7cc3d26 | 751 | /**\r |
| 752 | Returns a 16-bit signature built from 2 ASCII characters.\r | |
| 753 | \r | |
| 3963c4bf | 754 | This macro returns a 16-bit value built from the two ASCII characters specified \r |
| 755 | by A and B.\r | |
| 756 | \r | |
| ee6c452c | 757 | @param A The first ASCII character.\r |
| 758 | @param B The second ASCII character.\r | |
| a7cc3d26 | 759 | \r |
| 760 | @return A 16-bit value built from the two ASCII characters specified by A and B.\r | |
| 761 | \r | |
| 762 | **/\r | |
| 13c31065 | 763 | #define SIGNATURE_16(A, B) ((A) | (B << 8))\r |
| a7cc3d26 | 764 | \r |
| 765 | /**\r | |
| 766 | Returns a 32-bit signature built from 4 ASCII characters.\r | |
| 767 | \r | |
| 3963c4bf | 768 | This macro returns a 32-bit value built from the four ASCII characters specified \r |
| 769 | by A, B, C, and D.\r | |
| 770 | \r | |
| ee6c452c | 771 | @param A The first ASCII character.\r |
| 772 | @param B The second ASCII character.\r | |
| 773 | @param C The third ASCII character.\r | |
| 774 | @param D The fourth ASCII character.\r | |
| a7cc3d26 | 775 | \r |
| 776 | @return A 32-bit value built from the two ASCII characters specified by A, B,\r | |
| 777 | C and D.\r | |
| 778 | \r | |
| 779 | **/\r | |
| 13c31065 | 780 | #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r |
| a7cc3d26 | 781 | \r |
| 782 | /**\r | |
| 783 | Returns a 64-bit signature built from 8 ASCII characters.\r | |
| 784 | \r | |
| 3963c4bf | 785 | This macro returns a 64-bit value built from the eight ASCII characters specified \r |
| 786 | by A, B, C, D, E, F, G,and H.\r | |
| 787 | \r | |
| ee6c452c | 788 | @param A The first ASCII character.\r |
| 789 | @param B The second ASCII character.\r | |
| 790 | @param C The third ASCII character.\r | |
| 791 | @param D The fourth ASCII character.\r | |
| 792 | @param E The fifth ASCII character.\r | |
| 793 | @param F The sixth ASCII character.\r | |
| 794 | @param G The seventh ASCII character.\r | |
| 795 | @param H The eighth ASCII character.\r | |
| a7cc3d26 | 796 | \r |
| 797 | @return A 64-bit value built from the two ASCII characters specified by A, B,\r | |
| 798 | C, D, E, F, G and H.\r | |
| 799 | \r | |
| 800 | **/\r | |
| 13c31065 | 801 | #define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r |
| 802 | (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r | |
| 803 | \r | |
| 959ccb23 | 804 | #endif\r |
| 805 | \r |