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