iPXE
Main Page
Related Pages
Modules
+
Data Structures
Data Structures
Data Structure Index
+
Data Fields
+
All
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Functions
_
b
d
i
p
s
t
u
v
x
+
Variables
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Enumerator
+
Files
File List
+
Globals
+
All
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Functions
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Variables
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
+
Typedefs
_
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
v
w
x
+
Enumerations
_
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
v
w
x
y
+
Enumerator
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
+
Macros
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
include
ipxe
efi
Base.h
Go to the documentation of this file.
1
/** @file
2
Root include file for Mde Package Base type modules
3
4
This is the include file for any module of type base. Base modules only use
5
types defined via this include file and can be ported easily to any
6
environment. There are a set of base libraries in the Mde Package that can
7
be used to implement base modules.
8
9
Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
10
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
11
SPDX-License-Identifier: BSD-2-Clause-Patent
12
13
**/
14
15
#ifndef __BASE_H__
16
#define __BASE_H__
17
18
FILE_LICENCE
( BSD2_PATENT );
19
20
//
21
// Include processor specific binding
22
//
23
#include <
ipxe/efi/ProcessorBind.h
>
24
25
#if defined (_MSC_EXTENSIONS)
26
//
27
// Disable warning when last field of data structure is a zero sized array.
28
//
29
#pragma warning ( disable : 4200 )
30
#endif
31
32
//
33
// The Microsoft* C compiler can removed references to unreferenced data items
34
// if the /OPT:REF linker option is used. We defined a macro as this is a
35
// a non standard extension
36
//
37
#if defined (_MSC_VER) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)
38
///
39
/// Remove global variable from the linked image if there are no references to
40
/// it after all compiler and linker optimizations have been performed.
41
///
42
///
43
#define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
44
#else
45
///
46
/// Remove the global variable from the linked image if there are no references
47
/// to it after all compiler and linker optimizations have been performed.
48
///
49
///
50
#define GLOBAL_REMOVE_IF_UNREFERENCED
51
#endif
52
53
//
54
// Should be used in combination with NORETURN to avoid 'noreturn' returns
55
// warnings.
56
//
57
#ifndef UNREACHABLE
58
#ifdef __GNUC__
59
///
60
/// Signal compilers and analyzers that this call is not reachable. It is
61
/// up to the compiler to remove any code past that point.
62
///
63
#define UNREACHABLE() __builtin_unreachable ()
64
#elif defined (__has_builtin) && defined (__has_feature)
65
#if __has_builtin (__builtin_unreachable)
66
///
67
/// Signal compilers and analyzers that this call is not reachable. It is
68
/// up to the compiler to remove any code past that point.
69
///
70
#define UNREACHABLE() __builtin_unreachable ()
71
#endif
72
#endif
73
74
#ifndef UNREACHABLE
75
///
76
/// Signal compilers and analyzers that this call is not reachable. It is
77
/// up to the compiler to remove any code past that point.
78
///
79
#define UNREACHABLE()
80
#endif
81
#endif
82
83
//
84
// Signaling compilers and analyzers that a certain function cannot return may
85
// remove all following code and thus lead to better optimization and less
86
// false positives.
87
//
88
#ifndef NORETURN
89
#if defined (__GNUC__) || defined (__clang__)
90
///
91
/// Signal compilers and analyzers that the function cannot return.
92
/// It is up to the compiler to remove any code past a call to functions
93
/// flagged with this attribute.
94
///
95
#define NORETURN __attribute__((noreturn))
96
#elif defined (_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
97
///
98
/// Signal compilers and analyzers that the function cannot return.
99
/// It is up to the compiler to remove any code past a call to functions
100
/// flagged with this attribute.
101
///
102
#define NORETURN __declspec(noreturn)
103
#else
104
///
105
/// Signal compilers and analyzers that the function cannot return.
106
/// It is up to the compiler to remove any code past a call to functions
107
/// flagged with this attribute.
108
///
109
#define NORETURN
110
#endif
111
#endif
112
113
//
114
// Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
115
// returns warnings.
116
//
117
#ifndef ANALYZER_UNREACHABLE
118
#ifdef __clang_analyzer__
119
#if __has_builtin (__builtin_unreachable)
120
///
121
/// Signal the analyzer that this call is not reachable.
122
/// This excludes compilers.
123
///
124
#define ANALYZER_UNREACHABLE() __builtin_unreachable ()
125
#endif
126
#endif
127
128
#ifndef ANALYZER_UNREACHABLE
129
///
130
/// Signal the analyzer that this call is not reachable.
131
/// This excludes compilers.
132
///
133
#define ANALYZER_UNREACHABLE()
134
#endif
135
#endif
136
137
//
138
// Static Analyzers may issue errors about potential NULL-dereferences when
139
// dereferencing a pointer, that has been checked before, outside of a
140
// NULL-check. This may lead to false positives, such as when using ASSERT()
141
// for verification.
142
//
143
#ifndef ANALYZER_NORETURN
144
#ifdef __has_feature
145
#if __has_feature (attribute_analyzer_noreturn)
146
///
147
/// Signal analyzers that the function cannot return.
148
/// This excludes compilers.
149
///
150
#define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
151
#endif
152
#endif
153
154
#ifndef ANALYZER_NORETURN
155
///
156
/// Signal the analyzer that the function cannot return.
157
/// This excludes compilers.
158
///
159
#define ANALYZER_NORETURN
160
#endif
161
#endif
162
163
///
164
/// Tell the code optimizer that the function will return twice.
165
/// This prevents wrong optimizations which can cause bugs.
166
///
167
#ifndef RETURNS_TWICE
168
#if defined (__GNUC__) || defined (__clang__)
169
///
170
/// Tell the code optimizer that the function will return twice.
171
/// This prevents wrong optimizations which can cause bugs.
172
///
173
#define RETURNS_TWICE __attribute__((returns_twice))
174
#else
175
///
176
/// Tell the code optimizer that the function will return twice.
177
/// This prevents wrong optimizations which can cause bugs.
178
///
179
#define RETURNS_TWICE
180
#endif
181
#endif
182
183
//
184
// For symbol name in assembly code, an extra "_" is sometimes necessary
185
//
186
187
///
188
/// Private worker functions for ASM_PFX()
189
///
190
#define _CONCATENATE(a, b) __CONCATENATE(a, b)
191
#define __CONCATENATE(a, b) a ## b
192
193
///
194
/// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
195
/// on symbols in assembly language.
196
///
197
#define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
198
199
#ifdef __APPLE__
200
//
201
// Apple extension that is used by the linker to optimize code size
202
// with assembly functions. Put at the end of your .S files
203
//
204
#define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
205
#else
206
#define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
207
#endif
208
209
#define PACKED
210
211
///
212
/// 128 bit buffer containing a unique identifier value.
213
/// Unless otherwise specified, aligned on a 64 bit boundary.
214
///
215
typedef
struct
{
216
UINT32
Data1
;
217
UINT16
Data2
;
218
UINT16
Data3
;
219
UINT8
Data4[8];
220
}
GUID
;
221
222
///
223
/// 4-byte buffer. An IPv4 internet protocol address.
224
///
225
typedef
struct
{
226
UINT8
Addr[4];
227
}
IPv4_ADDRESS
;
228
229
///
230
/// 16-byte buffer. An IPv6 internet protocol address.
231
///
232
typedef
struct
{
233
UINT8
Addr[16];
234
}
IPv6_ADDRESS
;
235
236
//
237
// 8-bytes unsigned value that represents a physical system address.
238
//
239
typedef
UINT64
PHYSICAL_ADDRESS
;
240
241
///
242
/// LIST_ENTRY structure definition.
243
///
244
typedef
struct
_LIST_ENTRY
LIST_ENTRY
;
245
246
///
247
/// _LIST_ENTRY structure definition.
248
///
249
struct
_LIST_ENTRY
{
250
LIST_ENTRY
*
ForwardLink
;
251
LIST_ENTRY
*
BackLink
;
252
};
253
254
//
255
// Modifiers to abstract standard types to aid in debug of problems
256
//
257
258
///
259
/// Datum is read-only.
260
///
261
#define CONST const
262
263
///
264
/// Datum is scoped to the current file or function.
265
///
266
#define STATIC static
267
268
///
269
/// Undeclared type.
270
///
271
#define VOID void
272
273
//
274
// Modifiers for Data Types used to self document code.
275
// This concept is borrowed for UEFI specification.
276
//
277
278
///
279
/// Datum is passed to the function.
280
///
281
#define IN
282
283
///
284
/// Datum is returned from the function.
285
///
286
#define OUT
287
288
///
289
/// Passing the datum to the function is optional, and a NULL
290
/// is passed if the value is not supplied.
291
///
292
#define OPTIONAL
293
294
//
295
// UEFI specification claims 1 and 0. We are concerned about the
296
// compiler portability so we did it this way.
297
//
298
299
///
300
/// Boolean true value. UEFI Specification defines this value to be 1,
301
/// but this form is more portable.
302
///
303
#define TRUE ((BOOLEAN)(1==1))
304
305
///
306
/// Boolean false value. UEFI Specification defines this value to be 0,
307
/// but this form is more portable.
308
///
309
#define FALSE ((BOOLEAN)(0==1))
310
311
///
312
/// NULL pointer (VOID *)
313
///
314
#if defined (__cplusplus)
315
#if defined (_MSC_EXTENSIONS)
316
#define NULL nullptr
317
#else
318
#define NULL __null
319
#endif
320
#else
321
#define NULL ((VOID *) 0)
322
#endif
323
324
//
325
// Null character
326
//
327
#define CHAR_NULL 0x0000
328
329
///
330
/// Maximum values for common UEFI Data Types
331
///
332
#define MAX_INT8 ((INT8)0x7F)
333
#define MAX_UINT8 ((UINT8)0xFF)
334
#define MAX_INT16 ((INT16)0x7FFF)
335
#define MAX_UINT16 ((UINT16)0xFFFF)
336
#define MAX_INT32 ((INT32)0x7FFFFFFF)
337
#define MAX_UINT32 ((UINT32)0xFFFFFFFF)
338
#define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
339
#define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
340
341
///
342
/// Minimum values for the signed UEFI Data Types
343
///
344
#define MIN_INT8 (((INT8) -127) - 1)
345
#define MIN_INT16 (((INT16) -32767) - 1)
346
#define MIN_INT32 (((INT32) -2147483647) - 1)
347
#define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)
348
349
#define BIT0 0x00000001
350
#define BIT1 0x00000002
351
#define BIT2 0x00000004
352
#define BIT3 0x00000008
353
#define BIT4 0x00000010
354
#define BIT5 0x00000020
355
#define BIT6 0x00000040
356
#define BIT7 0x00000080
357
#define BIT8 0x00000100
358
#define BIT9 0x00000200
359
#define BIT10 0x00000400
360
#define BIT11 0x00000800
361
#define BIT12 0x00001000
362
#define BIT13 0x00002000
363
#define BIT14 0x00004000
364
#define BIT15 0x00008000
365
#define BIT16 0x00010000
366
#define BIT17 0x00020000
367
#define BIT18 0x00040000
368
#define BIT19 0x00080000
369
#define BIT20 0x00100000
370
#define BIT21 0x00200000
371
#define BIT22 0x00400000
372
#define BIT23 0x00800000
373
#define BIT24 0x01000000
374
#define BIT25 0x02000000
375
#define BIT26 0x04000000
376
#define BIT27 0x08000000
377
#define BIT28 0x10000000
378
#define BIT29 0x20000000
379
#define BIT30 0x40000000
380
#define BIT31 0x80000000
381
#define BIT32 0x0000000100000000ULL
382
#define BIT33 0x0000000200000000ULL
383
#define BIT34 0x0000000400000000ULL
384
#define BIT35 0x0000000800000000ULL
385
#define BIT36 0x0000001000000000ULL
386
#define BIT37 0x0000002000000000ULL
387
#define BIT38 0x0000004000000000ULL
388
#define BIT39 0x0000008000000000ULL
389
#define BIT40 0x0000010000000000ULL
390
#define BIT41 0x0000020000000000ULL
391
#define BIT42 0x0000040000000000ULL
392
#define BIT43 0x0000080000000000ULL
393
#define BIT44 0x0000100000000000ULL
394
#define BIT45 0x0000200000000000ULL
395
#define BIT46 0x0000400000000000ULL
396
#define BIT47 0x0000800000000000ULL
397
#define BIT48 0x0001000000000000ULL
398
#define BIT49 0x0002000000000000ULL
399
#define BIT50 0x0004000000000000ULL
400
#define BIT51 0x0008000000000000ULL
401
#define BIT52 0x0010000000000000ULL
402
#define BIT53 0x0020000000000000ULL
403
#define BIT54 0x0040000000000000ULL
404
#define BIT55 0x0080000000000000ULL
405
#define BIT56 0x0100000000000000ULL
406
#define BIT57 0x0200000000000000ULL
407
#define BIT58 0x0400000000000000ULL
408
#define BIT59 0x0800000000000000ULL
409
#define BIT60 0x1000000000000000ULL
410
#define BIT61 0x2000000000000000ULL
411
#define BIT62 0x4000000000000000ULL
412
#define BIT63 0x8000000000000000ULL
413
414
#define SIZE_1KB 0x00000400
415
#define SIZE_2KB 0x00000800
416
#define SIZE_4KB 0x00001000
417
#define SIZE_8KB 0x00002000
418
#define SIZE_16KB 0x00004000
419
#define SIZE_32KB 0x00008000
420
#define SIZE_64KB 0x00010000
421
#define SIZE_128KB 0x00020000
422
#define SIZE_256KB 0x00040000
423
#define SIZE_512KB 0x00080000
424
#define SIZE_1MB 0x00100000
425
#define SIZE_2MB 0x00200000
426
#define SIZE_4MB 0x00400000
427
#define SIZE_8MB 0x00800000
428
#define SIZE_16MB 0x01000000
429
#define SIZE_32MB 0x02000000
430
#define SIZE_64MB 0x04000000
431
#define SIZE_128MB 0x08000000
432
#define SIZE_256MB 0x10000000
433
#define SIZE_512MB 0x20000000
434
#define SIZE_1GB 0x40000000
435
#define SIZE_2GB 0x80000000
436
#define SIZE_4GB 0x0000000100000000ULL
437
#define SIZE_8GB 0x0000000200000000ULL
438
#define SIZE_16GB 0x0000000400000000ULL
439
#define SIZE_32GB 0x0000000800000000ULL
440
#define SIZE_64GB 0x0000001000000000ULL
441
#define SIZE_128GB 0x0000002000000000ULL
442
#define SIZE_256GB 0x0000004000000000ULL
443
#define SIZE_512GB 0x0000008000000000ULL
444
#define SIZE_1TB 0x0000010000000000ULL
445
#define SIZE_2TB 0x0000020000000000ULL
446
#define SIZE_4TB 0x0000040000000000ULL
447
#define SIZE_8TB 0x0000080000000000ULL
448
#define SIZE_16TB 0x0000100000000000ULL
449
#define SIZE_32TB 0x0000200000000000ULL
450
#define SIZE_64TB 0x0000400000000000ULL
451
#define SIZE_128TB 0x0000800000000000ULL
452
#define SIZE_256TB 0x0001000000000000ULL
453
#define SIZE_512TB 0x0002000000000000ULL
454
#define SIZE_1PB 0x0004000000000000ULL
455
#define SIZE_2PB 0x0008000000000000ULL
456
#define SIZE_4PB 0x0010000000000000ULL
457
#define SIZE_8PB 0x0020000000000000ULL
458
#define SIZE_16PB 0x0040000000000000ULL
459
#define SIZE_32PB 0x0080000000000000ULL
460
#define SIZE_64PB 0x0100000000000000ULL
461
#define SIZE_128PB 0x0200000000000000ULL
462
#define SIZE_256PB 0x0400000000000000ULL
463
#define SIZE_512PB 0x0800000000000000ULL
464
#define SIZE_1EB 0x1000000000000000ULL
465
#define SIZE_2EB 0x2000000000000000ULL
466
#define SIZE_4EB 0x4000000000000000ULL
467
#define SIZE_8EB 0x8000000000000000ULL
468
469
#define BASE_1KB 0x00000400
470
#define BASE_2KB 0x00000800
471
#define BASE_4KB 0x00001000
472
#define BASE_8KB 0x00002000
473
#define BASE_16KB 0x00004000
474
#define BASE_32KB 0x00008000
475
#define BASE_64KB 0x00010000
476
#define BASE_128KB 0x00020000
477
#define BASE_256KB 0x00040000
478
#define BASE_512KB 0x00080000
479
#define BASE_1MB 0x00100000
480
#define BASE_2MB 0x00200000
481
#define BASE_4MB 0x00400000
482
#define BASE_8MB 0x00800000
483
#define BASE_16MB 0x01000000
484
#define BASE_32MB 0x02000000
485
#define BASE_64MB 0x04000000
486
#define BASE_128MB 0x08000000
487
#define BASE_256MB 0x10000000
488
#define BASE_512MB 0x20000000
489
#define BASE_1GB 0x40000000
490
#define BASE_2GB 0x80000000
491
#define BASE_4GB 0x0000000100000000ULL
492
#define BASE_8GB 0x0000000200000000ULL
493
#define BASE_16GB 0x0000000400000000ULL
494
#define BASE_32GB 0x0000000800000000ULL
495
#define BASE_64GB 0x0000001000000000ULL
496
#define BASE_128GB 0x0000002000000000ULL
497
#define BASE_256GB 0x0000004000000000ULL
498
#define BASE_512GB 0x0000008000000000ULL
499
#define BASE_1TB 0x0000010000000000ULL
500
#define BASE_2TB 0x0000020000000000ULL
501
#define BASE_4TB 0x0000040000000000ULL
502
#define BASE_8TB 0x0000080000000000ULL
503
#define BASE_16TB 0x0000100000000000ULL
504
#define BASE_32TB 0x0000200000000000ULL
505
#define BASE_64TB 0x0000400000000000ULL
506
#define BASE_128TB 0x0000800000000000ULL
507
#define BASE_256TB 0x0001000000000000ULL
508
#define BASE_512TB 0x0002000000000000ULL
509
#define BASE_1PB 0x0004000000000000ULL
510
#define BASE_2PB 0x0008000000000000ULL
511
#define BASE_4PB 0x0010000000000000ULL
512
#define BASE_8PB 0x0020000000000000ULL
513
#define BASE_16PB 0x0040000000000000ULL
514
#define BASE_32PB 0x0080000000000000ULL
515
#define BASE_64PB 0x0100000000000000ULL
516
#define BASE_128PB 0x0200000000000000ULL
517
#define BASE_256PB 0x0400000000000000ULL
518
#define BASE_512PB 0x0800000000000000ULL
519
#define BASE_1EB 0x1000000000000000ULL
520
#define BASE_2EB 0x2000000000000000ULL
521
#define BASE_4EB 0x4000000000000000ULL
522
#define BASE_8EB 0x8000000000000000ULL
523
524
//
525
// Support for variable argument lists in freestanding edk2 modules.
526
//
527
// For modules that use the ISO C library interfaces for variable
528
// argument lists, refer to "StdLib/Include/stdarg.h".
529
//
530
// VA_LIST - typedef for argument list.
531
// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
532
// VA_END (VA_LIST Marker) - Clear Marker
533
// VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from
534
// the ... list. You must know the type and pass it in this macro. Type
535
// must be compatible with the type of the actual next argument (as promoted
536
// according to the default argument promotions.)
537
// VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
538
//
539
// Example:
540
//
541
// UINTN
542
// EFIAPI
543
// ExampleVarArg (
544
// IN UINTN NumberOfArgs,
545
// ...
546
// )
547
// {
548
// VA_LIST Marker;
549
// UINTN Index;
550
// UINTN Result;
551
//
552
// //
553
// // Initialize the Marker
554
// //
555
// VA_START (Marker, NumberOfArgs);
556
// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
557
// //
558
// // The ... list is a series of UINTN values, so sum them up.
559
// //
560
// Result += VA_ARG (Marker, UINTN);
561
// }
562
//
563
// VA_END (Marker);
564
// return Result;
565
// }
566
//
567
// Notes:
568
// - Functions that call VA_START() / VA_END() must have a variable
569
// argument list and must be declared EFIAPI.
570
// - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.
571
// - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.
572
//
573
574
/**
575
Return the size of argument that has been aligned to sizeof (UINTN).
576
577
@param n The parameter size to be aligned.
578
579
@return The aligned size.
580
**/
581
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
582
583
#if defined (_M_ARM) || defined (_M_ARM64)
584
//
585
// MSFT ARM variable argument list support.
586
//
587
588
typedef
char
*
VA_LIST
;
589
590
#define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)
591
#define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))
592
#define VA_END(Marker) (Marker = (VA_LIST) 0)
593
#define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
594
595
#elif defined (__GNUC__) || defined (__clang__)
596
597
#if defined (MDE_CPU_X64) && !defined (NO_MSABI_VA_FUNCS)
598
//
599
// X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
600
//
601
///
602
/// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
603
///
604
605
///
606
/// Variable used to traverse the list of arguments. This type can vary by
607
/// implementation and could be an array or structure.
608
///
609
typedef
__builtin_ms_va_list
VA_LIST
;
610
611
#define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
612
613
#define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
614
615
#define VA_END(Marker) __builtin_ms_va_end (Marker)
616
617
#define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
618
619
#else
620
//
621
// Use GCC built-in macros for variable argument lists.
622
//
623
624
///
625
/// Variable used to traverse the list of arguments. This type can vary by
626
/// implementation and could be an array or structure.
627
///
628
typedef
__builtin_va_list
VA_LIST
;
629
630
#define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
631
632
#define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
633
634
#define VA_END(Marker) __builtin_va_end (Marker)
635
636
#define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
637
638
#endif
639
640
#else
641
///
642
/// Variable used to traverse the list of arguments. This type can vary by
643
/// implementation and could be an array or structure.
644
///
645
typedef
CHAR8
*
VA_LIST
;
646
647
/**
648
Retrieves a pointer to the beginning of a variable argument list, based on
649
the name of the parameter that immediately precedes the variable argument list.
650
651
This function initializes Marker to point to the beginning of the variable
652
argument list that immediately follows Parameter. The method for computing the
653
pointer to the next argument in the argument list is CPU-specific following the
654
EFIAPI ABI.
655
656
@param Marker The VA_LIST used to traverse the list of arguments.
657
@param Parameter The name of the parameter that immediately precedes
658
the variable argument list.
659
660
@return A pointer to the beginning of a variable argument list.
661
662
**/
663
#define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
664
665
/**
666
Returns an argument of a specified type from a variable argument list and updates
667
the pointer to the variable argument list to point to the next argument.
668
669
This function returns an argument of the type specified by TYPE from the beginning
670
of the variable argument list specified by Marker. Marker is then updated to point
671
to the next argument in the variable argument list. The method for computing the
672
pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
673
674
@param Marker VA_LIST used to traverse the list of arguments.
675
@param TYPE The type of argument to retrieve from the beginning
676
of the variable argument list.
677
678
@return An argument of the type specified by TYPE.
679
680
**/
681
#define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
682
683
/**
684
Terminates the use of a variable argument list.
685
686
This function initializes Marker so it can no longer be used with VA_ARG().
687
After this macro is used, the only way to access the variable argument list is
688
by using VA_START() again.
689
690
@param Marker VA_LIST used to traverse the list of arguments.
691
692
**/
693
#define VA_END(Marker) (Marker = (VA_LIST) 0)
694
695
/**
696
Initializes a VA_LIST as a copy of an existing VA_LIST.
697
698
This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
699
followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
700
the present state of Start.
701
702
@param Dest VA_LIST used to traverse the list of arguments.
703
@param Start VA_LIST used to traverse the list of arguments.
704
705
**/
706
#define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
707
708
#endif
709
710
///
711
/// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
712
///
713
typedef
UINTN
*
BASE_LIST
;
714
715
/**
716
Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
717
718
@param TYPE The date type to determine the size of.
719
720
@return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
721
**/
722
#define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
723
724
/**
725
Returns an argument of a specified type from a variable argument list and updates
726
the pointer to the variable argument list to point to the next argument.
727
728
This function returns an argument of the type specified by TYPE from the beginning
729
of the variable argument list specified by Marker. Marker is then updated to point
730
to the next argument in the variable argument list. The method for computing the
731
pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
732
733
@param Marker The pointer to the beginning of a variable argument list.
734
@param TYPE The type of argument to retrieve from the beginning
735
of the variable argument list.
736
737
@return An argument of the type specified by TYPE.
738
739
**/
740
#define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
741
742
/**
743
The macro that returns the byte offset of a field in a data structure.
744
745
This function returns the offset, in bytes, of field specified by Field from the
746
beginning of the data structure specified by TYPE. If TYPE does not contain Field,
747
the module will not compile.
748
749
@param TYPE The name of the data structure that contains the field specified by Field.
750
@param Field The name of the field in the data structure.
751
752
@return Offset, in bytes, of field.
753
754
**/
755
#if (defined (__GNUC__) && __GNUC__ >= 4) || defined (__clang__)
756
#define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
757
#endif
758
759
#ifndef OFFSET_OF
760
#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
761
#endif
762
763
/**
764
Returns the alignment requirement of a type.
765
766
@param TYPE The name of the type to retrieve the alignment requirement of.
767
768
@return Alignment requirement, in Bytes, of TYPE.
769
**/
770
#if defined (__cplusplus)
771
//
772
// Standard C++ operator.
773
//
774
#define ALIGNOF(TYPE) alignof (TYPE)
775
#elif defined (__GNUC__) || defined (__clang__) || (defined (_MSC_VER) && _MSC_VER >= 1900)
776
//
777
// All supported versions of GCC and Clang, as well as MSVC 2015 and later,
778
// support the standard operator _Alignof.
779
//
780
#define ALIGNOF(TYPE) _Alignof (TYPE)
781
#elif defined (_MSC_EXTENSIONS)
782
//
783
// Earlier versions of MSVC, at least MSVC 2008 and later, support the vendor
784
// extension __alignof.
785
//
786
#define ALIGNOF(TYPE) __alignof (TYPE)
787
#else
788
//
789
// For compilers that do not support inbuilt alignof operators, use OFFSET_OF.
790
// CHAR8 is known to have both a size and an alignment requirement of 1 Byte.
791
// As such, A must be located exactly at the offset equal to its alignment
792
// requirement.
793
//
794
#define ALIGNOF(TYPE) OFFSET_OF (struct { CHAR8 C; TYPE A; }, A)
795
#endif
796
797
/**
798
Portable definition for compile time assertions.
799
Equivalent to C11 static_assert macro from assert.h.
800
801
@param Expression Boolean expression.
802
@param Message Raised compiler diagnostic message when expression is false.
803
804
**/
805
#ifdef MDE_CPU_EBC
806
#define STATIC_ASSERT(Expression, Message)
807
#elif defined (_MSC_EXTENSIONS) || defined (__cplusplus)
808
#define STATIC_ASSERT static_assert
809
#else
810
#define STATIC_ASSERT _Static_assert
811
#endif
812
813
//
814
// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
815
// Section 2.3.1 of the UEFI 2.3 Specification.
816
//
817
818
STATIC_ASSERT
(
sizeof
(
BOOLEAN
) == 1,
"sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements"
);
819
STATIC_ASSERT
(
sizeof
(
INT8
) == 1,
"sizeof (INT8) does not meet UEFI Specification Data Type requirements"
);
820
STATIC_ASSERT
(
sizeof
(
UINT8
) == 1,
"sizeof (UINT8) does not meet UEFI Specification Data Type requirements"
);
821
STATIC_ASSERT
(
sizeof
(
INT16
) == 2,
"sizeof (INT16) does not meet UEFI Specification Data Type requirements"
);
822
STATIC_ASSERT
(
sizeof
(
UINT16
) == 2,
"sizeof (UINT16) does not meet UEFI Specification Data Type requirements"
);
823
STATIC_ASSERT
(
sizeof
(
INT32
) == 4,
"sizeof (INT32) does not meet UEFI Specification Data Type requirements"
);
824
STATIC_ASSERT
(
sizeof
(
UINT32
) == 4,
"sizeof (UINT32) does not meet UEFI Specification Data Type requirements"
);
825
STATIC_ASSERT
(
sizeof
(
INT64
) == 8,
"sizeof (INT64) does not meet UEFI Specification Data Type requirements"
);
826
STATIC_ASSERT
(
sizeof
(
UINT64
) == 8,
"sizeof (UINT64) does not meet UEFI Specification Data Type requirements"
);
827
STATIC_ASSERT
(
sizeof
(
CHAR8
) == 1,
"sizeof (CHAR8) does not meet UEFI Specification Data Type requirements"
);
828
STATIC_ASSERT
(
sizeof
(
CHAR16
) == 2,
"sizeof (CHAR16) does not meet UEFI Specification Data Type requirements"
);
829
STATIC_ASSERT
(
sizeof
(L
'A'
) == 2,
"sizeof (L'A') does not meet UEFI Specification Data Type requirements"
);
830
STATIC_ASSERT
(
sizeof
(L
"A"
) == 4,
"sizeof (L\"A\") does not meet UEFI Specification Data Type requirements"
);
831
832
STATIC_ASSERT
(
ALIGNOF
(
BOOLEAN
) ==
sizeof
(
BOOLEAN
),
"Alignment of BOOLEAN does not meet UEFI Specification Data Type requirements"
);
833
STATIC_ASSERT
(
ALIGNOF
(
INT8
) ==
sizeof
(
INT8
),
"Alignment of INT8 does not meet UEFI Specification Data Type requirements"
);
834
STATIC_ASSERT
(
ALIGNOF
(
UINT8
) ==
sizeof
(
UINT8
),
"Alignment of INT16 does not meet UEFI Specification Data Type requirements"
);
835
STATIC_ASSERT
(
ALIGNOF
(
INT16
) ==
sizeof
(
INT16
),
"Alignment of INT16 does not meet UEFI Specification Data Type requirements"
);
836
STATIC_ASSERT
(
ALIGNOF
(
UINT16
) ==
sizeof
(
UINT16
),
"Alignment of UINT16 does not meet UEFI Specification Data Type requirements"
);
837
STATIC_ASSERT
(
ALIGNOF
(
INT32
) ==
sizeof
(
INT32
),
"Alignment of INT32 does not meet UEFI Specification Data Type requirements"
);
838
STATIC_ASSERT
(
ALIGNOF
(
UINT32
) ==
sizeof
(
UINT32
),
"Alignment of UINT32 does not meet UEFI Specification Data Type requirements"
);
839
STATIC_ASSERT
(
ALIGNOF
(
INT64
) ==
sizeof
(
INT64
),
"Alignment of INT64 does not meet UEFI Specification Data Type requirements"
);
840
STATIC_ASSERT
(
ALIGNOF
(
UINT64
) ==
sizeof
(
UINT64
),
"Alignment of UINT64 does not meet UEFI Specification Data Type requirements"
);
841
STATIC_ASSERT
(
ALIGNOF
(
CHAR8
) ==
sizeof
(
CHAR8
),
"Alignment of CHAR8 does not meet UEFI Specification Data Type requirements"
);
842
STATIC_ASSERT
(
ALIGNOF
(
CHAR16
) ==
sizeof
(
CHAR16
),
"Alignment of CHAR16 does not meet UEFI Specification Data Type requirements"
);
843
STATIC_ASSERT
(
ALIGNOF
(
INTN
) ==
sizeof
(
INTN
),
"Alignment of INTN does not meet UEFI Specification Data Type requirements"
);
844
STATIC_ASSERT
(
ALIGNOF
(
UINTN
) ==
sizeof
(
UINTN
),
"Alignment of UINTN does not meet UEFI Specification Data Type requirements"
);
845
STATIC_ASSERT
(
ALIGNOF
(
VOID
*) ==
sizeof
(
VOID
*),
"Alignment of VOID * does not meet UEFI Specification Data Type requirements"
);
846
847
//
848
// The following three enum types are used to verify that the compiler
849
// configuration for enum types is compliant with Section 2.3.1 of the
850
// UEFI 2.3.1 Errata C Specification. These enum types and enum values
851
// are not intended to be used. A prefix of '__' is used avoid
852
// conflicts with other types.
853
//
854
typedef
enum
{
855
__VerifyUint8EnumValue
= 0xff
856
}
__VERIFY_UINT8_ENUM_SIZE
;
857
858
typedef
enum
{
859
__VerifyUint16EnumValue
= 0xffff
860
}
__VERIFY_UINT16_ENUM_SIZE
;
861
862
typedef
enum
{
863
__VerifyInt32EnumValue
= 0x7fffffff
864
}
__VERIFY_INT32_ENUM_SIZE
;
865
866
STATIC_ASSERT
(
sizeof
(
__VERIFY_UINT8_ENUM_SIZE
) == 4,
"Size of enum does not meet UEFI Specification Data Type requirements"
);
867
STATIC_ASSERT
(
sizeof
(
__VERIFY_UINT16_ENUM_SIZE
) == 4,
"Size of enum does not meet UEFI Specification Data Type requirements"
);
868
STATIC_ASSERT
(
sizeof
(
__VERIFY_INT32_ENUM_SIZE
) == 4,
"Size of enum does not meet UEFI Specification Data Type requirements"
);
869
870
STATIC_ASSERT
(
ALIGNOF
(
__VERIFY_UINT8_ENUM_SIZE
) ==
sizeof
(
__VERIFY_UINT8_ENUM_SIZE
),
"Alignment of enum does not meet UEFI Specification Data Type requirements"
);
871
STATIC_ASSERT
(
ALIGNOF
(
__VERIFY_UINT16_ENUM_SIZE
) ==
sizeof
(
__VERIFY_UINT16_ENUM_SIZE
),
"Alignment of enum does not meet UEFI Specification Data Type requirements"
);
872
STATIC_ASSERT
(
ALIGNOF
(
__VERIFY_INT32_ENUM_SIZE
) ==
sizeof
(
__VERIFY_INT32_ENUM_SIZE
),
"Alignment of enum does not meet UEFI Specification Data Type requirements"
);
873
874
/**
875
Macro that returns a pointer to the data structure that contains a specified field of
876
that data structure. This is a lightweight method to hide information by placing a
877
public data structure inside a larger private data structure and using a pointer to
878
the public data structure to retrieve a pointer to the private data structure.
879
880
This function computes the offset, in bytes, of field specified by Field from the beginning
881
of the data structure specified by TYPE. This offset is subtracted from Record, and is
882
used to return a pointer to a data structure of the type specified by TYPE. If the data type
883
specified by TYPE does not contain the field specified by Field, then the module will not compile.
884
885
@param Record Pointer to the field specified by Field within a data structure of type TYPE.
886
@param TYPE The name of the data structure type to return. This data structure must
887
contain the field specified by Field.
888
@param Field The name of the field in the data structure specified by TYPE to which Record points.
889
890
@return A pointer to the structure from one of it's elements.
891
892
**/
893
#define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))
894
895
/**
896
Checks whether a value is a power of two.
897
898
@param Value The value to check.
899
900
@retval TRUE Value is a power of two.
901
@retval FALSE Value is not a power of two.
902
**/
903
#define IS_POW2(Value) ((Value) != 0U && ((Value) & ((Value) - 1U)) == 0U)
904
905
/**
906
Checks whether a value is aligned by a specified alignment.
907
908
@param Value The value to check.
909
@param Alignment The alignment boundary used to check against.
910
911
@retval TRUE Value is aligned by Alignment.
912
@retval FALSE Value is not aligned by Alignment.
913
**/
914
#define IS_ALIGNED(Value, Alignment) (((Value) & ((Alignment) - 1U)) == 0U)
915
916
/**
917
Checks whether a pointer or address is aligned by a specified alignment.
918
919
@param Address The pointer or address to check.
920
@param Alignment The alignment boundary used to check against.
921
922
@retval TRUE Address is aligned by Alignment.
923
@retval FALSE Address is not aligned by Alignment.
924
**/
925
#define ADDRESS_IS_ALIGNED(Address, Alignment) IS_ALIGNED ((UINTN) (Address), Alignment)
926
927
/**
928
Determines the addend to add to a value to round it up to the next boundary of
929
a specified alignment.
930
931
@param Value The value to round up.
932
@param Alignment The alignment boundary used to return the addend.
933
934
@return Addend to round Value up to alignment boundary Alignment.
935
**/
936
#define ALIGN_VALUE_ADDEND(Value, Alignment) (((Alignment) - (Value)) & ((Alignment) - 1U))
937
938
/**
939
Rounds a value up to the next boundary using a specified alignment.
940
941
This function rounds Value up to the next boundary using the specified Alignment.
942
This aligned value is returned.
943
944
@param Value The value to round up.
945
@param Alignment The alignment boundary used to return the aligned value.
946
947
@return A value up to the next boundary.
948
949
**/
950
#define ALIGN_VALUE(Value, Alignment) ((Value) + ALIGN_VALUE_ADDEND (Value, Alignment))
951
952
/**
953
Adjust a pointer by adding the minimum offset required for it to be aligned on
954
a specified alignment boundary.
955
956
This function rounds the pointer specified by Pointer to the next alignment boundary
957
specified by Alignment. The pointer to the aligned address is returned.
958
959
@param Pointer The pointer to round up.
960
@param Alignment The alignment boundary to use to return an aligned pointer.
961
962
@return Pointer to the aligned address.
963
964
**/
965
#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
966
967
/**
968
Rounds a value up to the next natural boundary for the current CPU.
969
This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
970
971
This function rounds the value specified by Value up to the next natural boundary for the
972
current CPU. This rounded value is returned.
973
974
@param Value The value to round up.
975
976
@return Rounded value specified by Value.
977
978
**/
979
#define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
980
981
/**
982
Return the maximum of two operands.
983
984
This macro returns the maximum of two operand specified by a and b.
985
Both a and b must be the same numerical types, signed or unsigned.
986
987
@param a The first operand with any numerical type.
988
@param b The second operand. Can be any numerical type as long as is
989
the same type as a.
990
991
@return Maximum of two operands.
992
993
**/
994
#define MAX(a, b) \
995
(((a) > (b)) ? (a) : (b))
996
997
/**
998
Return the minimum of two operands.
999
1000
This macro returns the minimal of two operand specified by a and b.
1001
Both a and b must be the same numerical types, signed or unsigned.
1002
1003
@param a The first operand with any numerical type.
1004
@param b The second operand. It should be the same any numerical type with a.
1005
1006
@return Minimum of two operands.
1007
1008
**/
1009
#define MIN(a, b) \
1010
(((a) < (b)) ? (a) : (b))
1011
1012
/**
1013
Return the absolute value of a signed operand.
1014
1015
This macro returns the absolute value of the signed operand specified by a.
1016
1017
@param a The signed operand.
1018
1019
@return The absolute value of the signed operand.
1020
1021
**/
1022
#define ABS(a) \
1023
(((a) < 0) ? (-(a)) : (a))
1024
1025
//
1026
// Status codes common to all execution phases
1027
//
1028
typedef
UINTN
RETURN_STATUS
;
1029
1030
/**
1031
Produces a RETURN_STATUS code with the highest bit set.
1032
1033
@param StatusCode The status code value to convert into a warning code.
1034
StatusCode must be in the range 0x00000000..0x7FFFFFFF.
1035
1036
@return The value specified by StatusCode with the highest bit set.
1037
1038
**/
1039
#define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
1040
1041
/**
1042
Produces a RETURN_STATUS code with the highest bit clear.
1043
1044
@param StatusCode The status code value to convert into a warning code.
1045
StatusCode must be in the range 0x00000000..0x7FFFFFFF.
1046
1047
@return The value specified by StatusCode with the highest bit clear.
1048
1049
**/
1050
#define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
1051
1052
/**
1053
Returns TRUE if a specified RETURN_STATUS code is an error code.
1054
1055
This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
1056
1057
@param StatusCode The status code value to evaluate.
1058
1059
@retval TRUE The high bit of StatusCode is set.
1060
@retval FALSE The high bit of StatusCode is clear.
1061
1062
**/
1063
#define RETURN_ERROR(StatusCode) (((RETURN_STATUS)(StatusCode)) >= MAX_BIT)
1064
1065
///
1066
/// The operation completed successfully.
1067
///
1068
#define RETURN_SUCCESS (RETURN_STATUS)(0)
1069
1070
///
1071
/// The image failed to load.
1072
///
1073
#define RETURN_LOAD_ERROR ENCODE_ERROR (1)
1074
1075
///
1076
/// The parameter was incorrect.
1077
///
1078
#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
1079
1080
///
1081
/// The operation is not supported.
1082
///
1083
#define RETURN_UNSUPPORTED ENCODE_ERROR (3)
1084
1085
///
1086
/// The buffer was not the proper size for the request.
1087
///
1088
#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
1089
1090
///
1091
/// The buffer was not large enough to hold the requested data.
1092
/// The required buffer size is returned in the appropriate
1093
/// parameter when this error occurs.
1094
///
1095
#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
1096
1097
///
1098
/// There is no data pending upon return.
1099
///
1100
#define RETURN_NOT_READY ENCODE_ERROR (6)
1101
1102
///
1103
/// The physical device reported an error while attempting the
1104
/// operation.
1105
///
1106
#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
1107
1108
///
1109
/// The device can not be written to.
1110
///
1111
#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
1112
1113
///
1114
/// The resource has run out.
1115
///
1116
#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
1117
1118
///
1119
/// An inconsistency was detected on the file system causing the
1120
/// operation to fail.
1121
///
1122
#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
1123
1124
///
1125
/// There is no more space on the file system.
1126
///
1127
#define RETURN_VOLUME_FULL ENCODE_ERROR (11)
1128
1129
///
1130
/// The device does not contain any medium to perform the
1131
/// operation.
1132
///
1133
#define RETURN_NO_MEDIA ENCODE_ERROR (12)
1134
1135
///
1136
/// The medium in the device has changed since the last
1137
/// access.
1138
///
1139
#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
1140
1141
///
1142
/// The item was not found.
1143
///
1144
#define RETURN_NOT_FOUND ENCODE_ERROR (14)
1145
1146
///
1147
/// Access was denied.
1148
///
1149
#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
1150
1151
///
1152
/// The server was not found or did not respond to the request.
1153
///
1154
#define RETURN_NO_RESPONSE ENCODE_ERROR (16)
1155
1156
///
1157
/// A mapping to the device does not exist.
1158
///
1159
#define RETURN_NO_MAPPING ENCODE_ERROR (17)
1160
1161
///
1162
/// A timeout time expired.
1163
///
1164
#define RETURN_TIMEOUT ENCODE_ERROR (18)
1165
1166
///
1167
/// The protocol has not been started.
1168
///
1169
#define RETURN_NOT_STARTED ENCODE_ERROR (19)
1170
1171
///
1172
/// The protocol has already been started.
1173
///
1174
#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
1175
1176
///
1177
/// The operation was aborted.
1178
///
1179
#define RETURN_ABORTED ENCODE_ERROR (21)
1180
1181
///
1182
/// An ICMP error occurred during the network operation.
1183
///
1184
#define RETURN_ICMP_ERROR ENCODE_ERROR (22)
1185
1186
///
1187
/// A TFTP error occurred during the network operation.
1188
///
1189
#define RETURN_TFTP_ERROR ENCODE_ERROR (23)
1190
1191
///
1192
/// A protocol error occurred during the network operation.
1193
///
1194
#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
1195
1196
///
1197
/// A function encountered an internal version that was
1198
/// incompatible with a version requested by the caller.
1199
///
1200
#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
1201
1202
///
1203
/// The function was not performed due to a security violation.
1204
///
1205
#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
1206
1207
///
1208
/// A CRC error was detected.
1209
///
1210
#define RETURN_CRC_ERROR ENCODE_ERROR (27)
1211
1212
///
1213
/// The beginning or end of media was reached.
1214
///
1215
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
1216
1217
///
1218
/// The end of the file was reached.
1219
///
1220
#define RETURN_END_OF_FILE ENCODE_ERROR (31)
1221
1222
///
1223
/// The language specified was invalid.
1224
///
1225
#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
1226
1227
///
1228
/// The security status of the data is unknown or compromised
1229
/// and the data must be updated or replaced to restore a valid
1230
/// security status.
1231
///
1232
#define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
1233
1234
///
1235
/// There is an address conflict address allocation.
1236
///
1237
#define RETURN_IP_ADDRESS_CONFLICT ENCODE_ERROR (34)
1238
1239
///
1240
/// A HTTP error occurred during the network operation.
1241
///
1242
#define RETURN_HTTP_ERROR ENCODE_ERROR (35)
1243
1244
///
1245
/// The string contained one or more characters that
1246
/// the device could not render and were skipped.
1247
///
1248
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
1249
1250
///
1251
/// The handle was closed, but the file was not deleted.
1252
///
1253
#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
1254
1255
///
1256
/// The handle was closed, but the data to the file was not
1257
/// flushed properly.
1258
///
1259
#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
1260
1261
///
1262
/// The resulting buffer was too small, and the data was
1263
/// truncated to the buffer size.
1264
///
1265
#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
1266
1267
///
1268
/// The data has not been updated within the timeframe set by
1269
/// local policy for this type of data.
1270
///
1271
#define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
1272
1273
///
1274
/// The resulting buffer contains UEFI-compliant file system.
1275
///
1276
#define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
1277
1278
///
1279
/// The operation will be processed across a system reset.
1280
///
1281
#define RETURN_WARN_RESET_REQUIRED ENCODE_WARNING (7)
1282
1283
/**
1284
Returns a 16-bit signature built from 2 ASCII characters.
1285
1286
This macro returns a 16-bit value built from the two ASCII characters specified
1287
by A and B.
1288
1289
@param A The first ASCII character.
1290
@param B The second ASCII character.
1291
1292
@return A 16-bit value built from the two ASCII characters specified by A and B.
1293
1294
**/
1295
#define SIGNATURE_16(A, B) ((A) | (B << 8))
1296
1297
/**
1298
Returns a 32-bit signature built from 4 ASCII characters.
1299
1300
This macro returns a 32-bit value built from the four ASCII characters specified
1301
by A, B, C, and D.
1302
1303
@param A The first ASCII character.
1304
@param B The second ASCII character.
1305
@param C The third ASCII character.
1306
@param D The fourth ASCII character.
1307
1308
@return A 32-bit value built from the two ASCII characters specified by A, B,
1309
C and D.
1310
1311
**/
1312
#define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
1313
1314
/**
1315
Returns a 64-bit signature built from 8 ASCII characters.
1316
1317
This macro returns a 64-bit value built from the eight ASCII characters specified
1318
by A, B, C, D, E, F, G,and H.
1319
1320
@param A The first ASCII character.
1321
@param B The second ASCII character.
1322
@param C The third ASCII character.
1323
@param D The fourth ASCII character.
1324
@param E The fifth ASCII character.
1325
@param F The sixth ASCII character.
1326
@param G The seventh ASCII character.
1327
@param H The eighth ASCII character.
1328
1329
@return A 64-bit value built from the two ASCII characters specified by A, B,
1330
C, D, E, F, G and H.
1331
1332
**/
1333
#define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1334
(SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
1335
1336
#if defined (_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
1337
void
*
1338
_ReturnAddress (
1339
void
1340
);
1341
1342
#pragma intrinsic(_ReturnAddress)
1343
1344
/**
1345
Get the return address of the calling function.
1346
1347
Based on intrinsic function _ReturnAddress that provides the address of
1348
the instruction in the calling function that will be executed after
1349
control returns to the caller.
1350
1351
@param L Return Level.
1352
1353
@return The return address of the calling function or 0 if L != 0.
1354
1355
**/
1356
#define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
1357
#elif defined (__GNUC__) || defined (__clang__)
1358
1359
/**
1360
Get the return address of the calling function.
1361
1362
Based on built-in Function __builtin_return_address that returns
1363
the return address of the current function, or of one of its callers.
1364
1365
@param L Return Level.
1366
1367
@return The return address of the calling function.
1368
1369
**/
1370
#define RETURN_ADDRESS(L) __builtin_return_address (L)
1371
#else
1372
1373
/**
1374
Get the return address of the calling function.
1375
1376
@param L Return Level.
1377
1378
@return 0 as compilers don't support this feature.
1379
1380
**/
1381
#define RETURN_ADDRESS(L) ((VOID *) 0)
1382
#endif
1383
1384
/**
1385
Return the number of elements in an array.
1386
1387
@param Array An object of array type. Array is only used as an argument to
1388
the sizeof operator, therefore Array is never evaluated. The
1389
caller is responsible for ensuring that Array's type is not
1390
incomplete; that is, Array must have known constant size.
1391
1392
@return The number of elements in Array. The result has type UINTN.
1393
1394
**/
1395
#define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
1396
1397
#endif
INT32
int INT32
Definition:
ProcessorBind.h:99
GUID::Data3
UINT16 Data3
Definition:
Base.h:218
PHYSICAL_ADDRESS
UINT64 PHYSICAL_ADDRESS
Definition:
Base.h:239
__VERIFY_UINT16_ENUM_SIZE
__VERIFY_UINT16_ENUM_SIZE
Definition:
Base.h:858
GUID
128 bit buffer containing a unique identifier value.
Definition:
Base.h:215
_LIST_ENTRY::ForwardLink
LIST_ENTRY * ForwardLink
Definition:
Base.h:250
BOOLEAN
unsigned char BOOLEAN
Definition:
ProcessorBind.h:103
INTN
INT64 INTN
Signed value of native width.
Definition:
ProcessorBind.h:120
BASE_LIST
UINTN * BASE_LIST
Pointer to the start of a variable argument list stored in a memory buffer.
Definition:
Base.h:713
UINT32
unsigned int UINT32
Definition:
ProcessorBind.h:98
CHAR16
unsigned short CHAR16
Definition:
ProcessorBind.h:101
FILE_LICENCE
FILE_LICENCE(BSD2_PATENT)
UINT8
unsigned char UINT8
Definition:
ProcessorBind.h:104
__VerifyUint16EnumValue
Definition:
Base.h:859
INT64
long long INT64
Definition:
ProcessorBind.h:97
IPv6_ADDRESS
16-byte buffer.
Definition:
Base.h:232
STATIC_ASSERT
#define STATIC_ASSERT
Portable definition for compile time assertions.
Definition:
Base.h:810
__VERIFY_UINT8_ENUM_SIZE
__VERIFY_UINT8_ENUM_SIZE
Definition:
Base.h:854
IPv4_ADDRESS
4-byte buffer.
Definition:
Base.h:225
INT16
short INT16
Definition:
ProcessorBind.h:102
UINT16
unsigned short UINT16
Definition:
ProcessorBind.h:100
__VERIFY_INT32_ENUM_SIZE
__VERIFY_INT32_ENUM_SIZE
Definition:
Base.h:862
UINTN
UINT64 UINTN
Unsigned value of native width.
Definition:
ProcessorBind.h:114
VOID
#define VOID
Undeclared type.
Definition:
Base.h:271
UINT64
unsigned long long UINT64
Definition:
ProcessorBind.h:96
_LIST_ENTRY
_LIST_ENTRY structure definition.
Definition:
Base.h:249
__VerifyInt32EnumValue
Definition:
Base.h:863
CHAR8
char CHAR8
Definition:
ProcessorBind.h:105
GUID::Data1
UINT32 Data1
Definition:
Base.h:216
RETURN_STATUS
UINTN RETURN_STATUS
Definition:
Base.h:1028
GUID::Data2
UINT16 Data2
Definition:
Base.h:217
ProcessorBind.h
_LIST_ENTRY::BackLink
LIST_ENTRY * BackLink
Definition:
Base.h:251
__VerifyUint8EnumValue
Definition:
Base.h:855
VA_LIST
CHAR8 * VA_LIST
Variable used to traverse the list of arguments.
Definition:
Base.h:645
INT8
signed char INT8
Definition:
ProcessorBind.h:106
ALIGNOF
#define ALIGNOF(TYPE)
Returns the alignment requirement of a type.
Definition:
Base.h:794
Generated by
1.8.15