Add the missing Guid header file.
[mirror_edk2.git] / MdePkg / Include / Base.h
CommitLineData
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 9Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
959ccb23 10All rights reserved. This program and the accompanying materials\r
11are licensed and made available under the terms and conditions of the BSD License\r
12which accompanies this distribution. The full text of the license may be found at\r
13http://opensource.org/licenses/bsd-license.php\r
14\r
15THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
16WITHOUT 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 33typedef 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 43typedef UINT64 PHYSICAL_ADDRESS;\r
44\r
62991af2 45///\r
f4ec40ab 46/// LIST_ENTRY structure definition.\r
62991af2 47///\r
959ccb23 48typedef struct _LIST_ENTRY LIST_ENTRY;\r
49\r
f4ec40ab 50///\r
51/// _LIST_ENTRY structure definition.\r
52///\r
959ccb23 53struct _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
186//\r
187// Support for variable length argument lists using the ANSI standard.\r
188// \r
3963c4bf 189// Since we are using the ANSI standard we used the standard naming and\r
190// did not follow the coding convention\r
959ccb23 191//\r
192// VA_LIST - typedef for argument list.\r
193// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
194// VA_END (VA_LIST Marker) - Clear Marker\r
3963c4bf 195// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
959ccb23 196// the ... list. You must know the size and pass it in this macro.\r
197//\r
198// example:\r
199//\r
200// UINTN\r
201// ExampleVarArg (\r
202// IN UINTN NumberOfArgs,\r
203// ...\r
204// )\r
205// {\r
206// VA_LIST Marker;\r
207// UINTN Index;\r
208// UINTN Result;\r
209//\r
210// //\r
211// // Initialize the Marker\r
212// //\r
213// VA_START (Marker, NumberOfArgs);\r
214// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
215// //\r
216// // The ... list is a series of UINTN values, so average them up.\r
217// //\r
218// Result += VA_ARG (Marker, UINTN);\r
219// }\r
220//\r
221// VA_END (Marker);\r
222// return Result\r
223// }\r
224//\r
225\r
c3d4e543
LG
226/**\r
227 Return the size of argument that has been aligned to sizeof (UINTN).\r
228\r
229 @param n The parameter size is to be aligned.\r
230\r
231 @return The aligned size\r
232**/\r
959ccb23 233#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
234\r
f4ec40ab 235///\r
236/// Pointer to the start of a variable argument list. Same as CHAR8 *.\r
237///\r
959ccb23 238typedef CHAR8 *VA_LIST;\r
959ccb23 239\r
3963c4bf 240/**\r
241 Retrieves a pointer to the beginning of a variable argument list based on \r
242 the name of the parameter that immediately precedes the variable argument list. \r
243\r
244 This function initializes Marker to point to the beginning of the variable argument \r
245 list that immediately follows Parameter. The method for computing the pointer to the \r
246 next argument in the argument list is CPU specific following the EFIAPI ABI.\r
247\r
248 @param Marker Pointer to the beginning of the variable argument list.\r
249 @param Parameter The name of the parameter that immediately precedes \r
250 the variable argument list.\r
251 \r
252 @return A pointer to the beginning of a variable argument list.\r
253\r
254**/\r
255#define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r
256\r
257/**\r
258 Returns an argument of a specified type from a variable argument list and updates \r
259 the pointer to the variable argument list to point to the next argument. \r
260\r
261 This function returns an argument of the type specified by TYPE from the beginning \r
262 of the variable argument list specified by Marker. Marker is then updated to point \r
263 to the next argument in the variable argument list. The method for computing the \r
264 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
265\r
266 @param Marker Pointer to the beginning of a variable argument list.\r
267 @param TYPE The type of argument to retrieve from the beginning \r
268 of the variable argument list.\r
269 \r
270 @return An argument of the type specified by TYPE.\r
271\r
272**/\r
273#define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r
274\r
275/**\r
276 Terminates the use of a variable argument list.\r
277\r
278 This function initializes Marker so it can no longer be used with VA_ARG(). \r
279 After this macro is used, the only way to access the variable argument list again is \r
280 by using VA_START() again.\r
281\r
282 @param Marker The variable to set to the beginning of the variable argument list.\r
283 \r
284**/\r
285#define VA_END(Marker) (Marker = (VA_LIST) 0)\r
286\r
287/**\r
288 Macro that returns the byte offset of a field in a data structure. \r
289\r
290 This function returns the offset, in bytes, of field specified by Field from the \r
291 beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r
292 the module will not compile. \r
293\r
294 @param TYPE The name of the data structure that contains the field specified by Field. \r
295 @param Field The name of the field in the data structure.\r
296 \r
297 @return Offset, in bytes, of field.\r
298 \r
299**/\r
959ccb23 300#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
301\r
3963c4bf 302/**\r
303 Macro that returns a pointer to the data structure that contains a specified field of \r
304 that data structure. This is a lightweight method to hide information by placing a \r
305 public data structure inside a larger private data structure and using a pointer to \r
306 the public data structure to retrieve a pointer to the private data structure.\r
307\r
308 This function computes the offset, in bytes, of field specified by Field from the beginning \r
309 of the data structure specified by TYPE. This offset is subtracted from Record, and is \r
310 used to return a pointer to a data structure of the type specified by TYPE.If the data type \r
311 specified by TYPE does not contain the field specified by Field, then the module will not compile. \r
312 \r
313 @param Record Pointer to the field specified by Field within a data structure of type TYPE. \r
314 @param TYPE The name of the data structure type to return. This data structure must \r
315 contain the field specified by Field. \r
316 @param Field The name of the field in the data structure specified by TYPE to which Record points.\r
317 \r
318 @return A pointer to the structure from one of it's elements.\r
319 \r
320**/\r
22ce9dc5 321#define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
959ccb23 322\r
3963c4bf 323/**\r
324 Rounds a value up to the next boundary using a specified alignment. \r
325\r
326 This function rounds Value up to the next boundary using the specified Alignment. \r
327 This aligned value is returned. \r
328\r
329 @param Value The value to round up.\r
330 @param Alignment The alignment boundary used to return the aligned value.\r
331 \r
332 @return A value up to the next boundary.\r
333 \r
334**/\r
3fef0f51 335#define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
336\r
3963c4bf 337/**\r
338 Adjust a pointer by adding the minimum offset required for it to be aligned on \r
339 a specified alignment boundary. \r
340\r
341 This function rounds the pointer specified by Pointer to the next alignment boundary \r
342 specified by Alignment. The pointer to the aligned address is returned. \r
343\r
344 @param Value The value to round up.\r
345 @param Alignment The alignment boundary to use to return an aligned pointer.\r
346 \r
347 @return Pointer to the aligned address.\r
348 \r
349**/\r
3fef0f51 350#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
959ccb23 351\r
3963c4bf 352/**\r
353 Rounds a value up to the next natural boundary for the current CPU. \r
354 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. \r
355\r
356 This function rounds the value specified by Value up to the next natural boundary for the \r
357 current CPU. This rounded value is returned. \r
358\r
359 @param Value The value to round up.\r
360\r
361 @return Rounded value specified by Value.\r
362 \r
363**/\r
3fef0f51 364#define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r
365 \r
959ccb23 366\r
3963c4bf 367/**\r
368 Return the maximum of two operands. \r
369\r
370 This macro returns the maximum of two operand specified by a and b. \r
371 Both a and b must be the same numerical types, signed or unsigned.\r
372\r
373 @param TYPE Any numerical data types.\r
374 @param a The first operand with any numerical type.\r
375 @param b The second operand. It should be the same any numerical type with a.\r
376 \r
377 @return Maximum of two operands.\r
378 \r
379**/\r
959ccb23 380#define MAX(a, b) \\r
381 (((a) > (b)) ? (a) : (b))\r
382\r
3963c4bf 383/**\r
384 Return the minimum of two operands. \r
385\r
386 This macro returns the minimal of two operand specified by a and b. \r
387 Both a and b must be the same numerical types, signed or unsigned.\r
388\r
389 @param TYPE Any numerical data types.\r
390 @param a The first operand with any numerical type.\r
391 @param b The second operand. It should be the same any numerical type with a.\r
392 \r
393 @return Minimum of two operands.\r
394 \r
395**/\r
959ccb23 396\r
959ccb23 397#define MIN(a, b) \\r
398 (((a) < (b)) ? (a) : (b))\r
399\r
959ccb23 400//\r
f4ec40ab 401// Status codes common to all execution phases\r
959ccb23 402//\r
959ccb23 403typedef INTN RETURN_STATUS;\r
404\r
f4ec40ab 405/**\r
406 Produces a RETURN_STATUS code with the highest bit set. \r
959ccb23 407\r
40731047 408 @param StatusCode The status code value to convert into a warning code. \r
f4ec40ab 409 StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
410\r
411 @return The value specified by StatusCode with the highest bit set.\r
412\r
413**/\r
414#define ENCODE_ERROR(StatusCode) (MAX_BIT | (StatusCode))\r
959ccb23 415\r
f4ec40ab 416/**\r
417 Produces a RETURN_STATUS code with the highest bit clear. \r
418\r
40731047 419 @param StatusCode The status code value to convert into a warning code. \r
f4ec40ab 420 StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
421\r
422 @return The value specified by StatusCode with the highest bit clear.\r
423\r
424**/\r
425#define ENCODE_WARNING(StatusCode) (StatusCode)\r
426\r
427/**\r
428 Returns TRUE if a specified RETURN_STATUS code is an error code. \r
429\r
430 This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r
431 \r
40731047 432 @param StatusCode The status code value to evaluate.\r
f4ec40ab 433\r
434 @retval TRUE The high bit of StatusCode is set.\r
435 @retval FALSE The high bit of StatusCode is clear.\r
436\r
437**/\r
438#define RETURN_ERROR(StatusCode) ((INTN) (StatusCode) < 0)\r
439\r
440///\r
441/// The operation completed successfully.\r
442///\r
959ccb23 443#define RETURN_SUCCESS 0\r
f4ec40ab 444\r
445///\r
446/// The image failed to load.\r
447///\r
959ccb23 448#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
f4ec40ab 449\r
450///\r
451/// The parameter was incorrect.\r
452///\r
959ccb23 453#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
f4ec40ab 454\r
455///\r
456/// The operation is not supported.\r
457///\r
959ccb23 458#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
f4ec40ab 459\r
460///\r
461/// The buffer was not the proper size for the request.\r
462///\r
959ccb23 463#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
f4ec40ab 464\r
465///\r
466/// The buffer was not large enough to hold the requested data.\r
467/// The required buffer size is returned in the appropriate\r
468/// parameter when this error occurs.\r
469///\r
959ccb23 470#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
f4ec40ab 471\r
472///\r
80619162 473/// There is no data pending upon return.\r
f4ec40ab 474///\r
959ccb23 475#define RETURN_NOT_READY ENCODE_ERROR (6)\r
f4ec40ab 476\r
477///\r
478/// The physical device reported an error while attempting the\r
479/// operation.\r
480///\r
959ccb23 481#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
f4ec40ab 482\r
483///\r
484/// The device can not be written to.\r
485///\r
959ccb23 486#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
f4ec40ab 487\r
488///\r
489/// The resource has run out.\r
490///\r
959ccb23 491#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
f4ec40ab 492\r
493///\r
80619162 494/// An inconsistency was detected on the file system causing the \r
f4ec40ab 495/// operation to fail.\r
496///\r
959ccb23 497#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
f4ec40ab 498\r
499///\r
500/// There is no more space on the file system.\r
501///\r
959ccb23 502#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
f4ec40ab 503\r
504///\r
505/// The device does not contain any medium to perform the \r
506/// operation.\r
507///\r
959ccb23 508#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
f4ec40ab 509\r
510///\r
511/// The medium in the device has changed since the last\r
512/// access.\r
513///\r
959ccb23 514#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
f4ec40ab 515\r
516///\r
517/// The item was not found.\r
518///\r
959ccb23 519#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
f4ec40ab 520\r
521///\r
522/// Access was denied.\r
523///\r
959ccb23 524#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
f4ec40ab 525\r
526///\r
527/// The server was not found or did not respond to the request.\r
528///\r
959ccb23 529#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
f4ec40ab 530\r
531///\r
532/// A mapping to the device does not exist.\r
533///\r
959ccb23 534#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
f4ec40ab 535\r
536///\r
537/// A timeout time expired.\r
538///\r
959ccb23 539#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
f4ec40ab 540\r
541///\r
542/// The protocol has not been started.\r
543///\r
959ccb23 544#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
f4ec40ab 545\r
546///\r
547/// The protocol has already been started.\r
548///\r
959ccb23 549#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
f4ec40ab 550\r
551///\r
552/// The operation was aborted.\r
553///\r
959ccb23 554#define RETURN_ABORTED ENCODE_ERROR (21)\r
f4ec40ab 555\r
556///\r
727501bb 557/// An ICMP error occurred during the network operation.\r
f4ec40ab 558///\r
959ccb23 559#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
f4ec40ab 560\r
561///\r
727501bb 562/// A TFTP error occurred during the network operation.\r
f4ec40ab 563///\r
959ccb23 564#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
f4ec40ab 565\r
566///\r
727501bb 567/// A protocol error occurred during the network operation.\r
f4ec40ab 568///\r
959ccb23 569#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
f4ec40ab 570\r
571///\r
572/// A function encountered an internal version that was\r
727501bb 573/// incompatible with a version requested by the caller.\r
f4ec40ab 574///\r
959ccb23 575#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
f4ec40ab 576\r
577///\r
578/// The function was not performed due to a security violation.\r
579///\r
959ccb23 580#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
f4ec40ab 581\r
582///\r
583/// A CRC error was detected.\r
584///\r
959ccb23 585#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
f4ec40ab 586\r
587///\r
588/// Beginning or end of media was reached.\r
589///\r
959ccb23 590#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
f4ec40ab 591\r
592///\r
593/// The end of the file was reached.\r
594///\r
959ccb23 595#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
f4ec40ab 596\r
597///\r
598/// The language specified was invalid.\r
599///\r
54cf8780 600#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r
601\r
959ccb23 602\r
f4ec40ab 603///\r
604/// The Unicode string contained one or more characters that\r
605/// the device could not render and were skipped.\r
606///\r
959ccb23 607#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
f4ec40ab 608\r
609///\r
610/// The handle was closed, but the file was not deleted.\r
611///\r
959ccb23 612#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
f4ec40ab 613\r
614///\r
615/// The handle was closed, but the data to the file was not\r
616/// flushed properly.\r
617///\r
959ccb23 618#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
f4ec40ab 619\r
620///\r
621/// The resulting buffer was too small, and the data was \r
622/// truncated to the buffer size.\r
623///\r
959ccb23 624#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
625\r
a7cc3d26 626/**\r
627 Returns a 16-bit signature built from 2 ASCII characters.\r
628 \r
3963c4bf 629 This macro returns a 16-bit value built from the two ASCII characters specified \r
630 by A and B.\r
631 \r
ee6c452c 632 @param A The first ASCII character.\r
633 @param B The second ASCII character.\r
a7cc3d26 634\r
635 @return A 16-bit value built from the two ASCII characters specified by A and B.\r
636\r
637**/\r
13c31065 638#define SIGNATURE_16(A, B) ((A) | (B << 8))\r
a7cc3d26 639\r
640/**\r
641 Returns a 32-bit signature built from 4 ASCII characters.\r
642 \r
3963c4bf 643 This macro returns a 32-bit value built from the four ASCII characters specified \r
644 by A, B, C, and D.\r
645 \r
ee6c452c 646 @param A The first ASCII character.\r
647 @param B The second ASCII character.\r
648 @param C The third ASCII character.\r
649 @param D The fourth ASCII character.\r
a7cc3d26 650\r
651 @return A 32-bit value built from the two ASCII characters specified by A, B,\r
652 C and D.\r
653\r
654**/\r
13c31065 655#define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r
a7cc3d26 656\r
657/**\r
658 Returns a 64-bit signature built from 8 ASCII characters.\r
659 \r
3963c4bf 660 This macro returns a 64-bit value built from the eight ASCII characters specified \r
661 by A, B, C, D, E, F, G,and H.\r
662 \r
ee6c452c 663 @param A The first ASCII character.\r
664 @param B The second ASCII character.\r
665 @param C The third ASCII character.\r
666 @param D The fourth ASCII character.\r
667 @param E The fifth ASCII character.\r
668 @param F The sixth ASCII character.\r
669 @param G The seventh ASCII character.\r
670 @param H The eighth ASCII character.\r
a7cc3d26 671\r
672 @return A 64-bit value built from the two ASCII characters specified by A, B,\r
673 C, D, E, F, G and H.\r
674\r
675**/\r
13c31065 676#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
677 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
678\r
959ccb23 679#endif\r
680\r