--- /dev/null
+/** @file\r
+ Processor or Compiler specific defines for all supported processors.\r
+\r
+ This file is stand alone self consistent set of definitions. \r
+\r
+ Copyright (c) 2006 - 2007, Intel Corporation\r
+ All rights reserved. This program and the accompanying materials \r
+ are licensed and made available under the terms and conditions of the BSD License \r
+ which accompanies this distribution. The full text of the license may be found at \r
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: BaseTypes.h\r
+\r
+**/\r
+\r
+#ifndef __BASE_TYPES_H__\r
+#define __BASE_TYPES_H__\r
+\r
+//\r
+// Include processor specific binding\r
+//\r
+#include <ProcessorBind.h>\r
+\r
+#define MEMORY_FENCE() MemoryFence ()\r
+#define BREAKPOINT() CpuBreakpoint ()\r
+#define DEADLOOP() CpuDeadLoop ()\r
+\r
+typedef struct {\r
+ UINT32 Data1;\r
+ UINT16 Data2;\r
+ UINT16 Data3;\r
+ UINT8 Data4[8];\r
+} GUID;\r
+\r
+\r
+//\r
+// Modifiers to absract standard types to aid in debug of problems\r
+//\r
+#define CONST const\r
+#define STATIC static\r
+#define VOID void\r
+\r
+//\r
+// Modifiers for Data Types used to self document code.\r
+// This concept is borrowed for UEFI specification.\r
+//\r
+#ifndef IN\r
+//\r
+// Some other envirnments use this construct, so #ifndef to prevent\r
+// mulitple definition.\r
+//\r
+#define IN\r
+#define OUT\r
+#define OPTIONAL\r
+#endif\r
+\r
+//\r
+// Constants. They may exist in other build structures, so #ifndef them.\r
+//\r
+#ifndef TRUE\r
+//\r
+// UEFI specification claims 1 and 0. We are concerned about the \r
+// complier portability so we did it this way.\r
+//\r
+#define TRUE ((BOOLEAN)(1==1))\r
+#endif\r
+\r
+#ifndef FALSE\r
+#define FALSE ((BOOLEAN)(0==1))\r
+#endif\r
+\r
+#ifndef NULL\r
+#define NULL ((VOID *) 0)\r
+#endif\r
+\r
+#define BIT0 0x00000001\r
+#define BIT1 0x00000002\r
+#define BIT2 0x00000004\r
+#define BIT3 0x00000008\r
+#define BIT4 0x00000010\r
+#define BIT5 0x00000020\r
+#define BIT6 0x00000040\r
+#define BIT7 0x00000080\r
+#define BIT8 0x00000100\r
+#define BIT9 0x00000200\r
+#define BIT10 0x00000400\r
+#define BIT11 0x00000800\r
+#define BIT12 0x00001000\r
+#define BIT13 0x00002000\r
+#define BIT14 0x00004000\r
+#define BIT15 0x00008000\r
+#define BIT16 0x00010000\r
+#define BIT17 0x00020000\r
+#define BIT18 0x00040000\r
+#define BIT19 0x00080000\r
+#define BIT20 0x00100000\r
+#define BIT21 0x00200000\r
+#define BIT22 0x00400000\r
+#define BIT23 0x00800000\r
+#define BIT24 0x01000000\r
+#define BIT25 0x02000000\r
+#define BIT26 0x04000000\r
+#define BIT27 0x08000000\r
+#define BIT28 0x10000000\r
+#define BIT29 0x20000000\r
+#define BIT30 0x40000000\r
+#define BIT31 0x80000000\r
+#define BIT32 0x0000000100000000UL\r
+#define BIT33 0x0000000200000000UL\r
+#define BIT34 0x0000000400000000UL\r
+#define BIT35 0x0000000800000000UL\r
+#define BIT36 0x0000001000000000UL\r
+#define BIT37 0x0000002000000000UL\r
+#define BIT38 0x0000004000000000UL\r
+#define BIT39 0x0000008000000000UL\r
+#define BIT40 0x0000010000000000UL\r
+#define BIT41 0x0000020000000000UL\r
+#define BIT42 0x0000040000000000UL\r
+#define BIT43 0x0000080000000000UL\r
+#define BIT44 0x0000100000000000UL\r
+#define BIT45 0x0000200000000000UL\r
+#define BIT46 0x0000400000000000UL\r
+#define BIT47 0x0000800000000000UL\r
+#define BIT48 0x0001000000000000UL\r
+#define BIT49 0x0002000000000000UL\r
+#define BIT50 0x0004000000000000UL\r
+#define BIT51 0x0008000000000000UL\r
+#define BIT52 0x0010000000000000UL\r
+#define BIT53 0x0020000000000000UL\r
+#define BIT54 0x0040000000000000UL\r
+#define BIT55 0x0080000000000000UL\r
+#define BIT56 0x0100000000000000UL\r
+#define BIT57 0x0200000000000000UL\r
+#define BIT58 0x0400000000000000UL\r
+#define BIT59 0x0800000000000000UL\r
+#define BIT60 0x1000000000000000UL\r
+#define BIT61 0x2000000000000000UL\r
+#define BIT62 0x4000000000000000UL\r
+#define BIT63 0x8000000000000000UL\r
+\r
+//\r
+// Support for variable length argument lists using the ANSI standard.\r
+// \r
+// Since we are using the ANSI standard we used the standard nameing and\r
+// did not folow the coding convention\r
+//\r
+// VA_LIST - typedef for argument list.\r
+// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
+// VA_END (VA_LIST Marker) - Clear Marker\r
+// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from\r
+// the ... list. You must know the size and pass it in this macro.\r
+//\r
+// example:\r
+//\r
+// UINTN\r
+// ExampleVarArg (\r
+// IN UINTN NumberOfArgs,\r
+// ...\r
+// )\r
+// {\r
+// VA_LIST Marker;\r
+// UINTN Index;\r
+// UINTN Result;\r
+//\r
+// //\r
+// // Initialize the Marker\r
+// //\r
+// VA_START (Marker, NumberOfArgs);\r
+// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
+// //\r
+// // The ... list is a series of UINTN values, so average them up.\r
+// //\r
+// Result += VA_ARG (Marker, UINTN);\r
+// }\r
+//\r
+// VA_END (Marker);\r
+// return Result\r
+// }\r
+//\r
+\r
+#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
+\r
+//\r
+// Also support coding convention rules for var arg macros\r
+//\r
+#ifndef VA_START\r
+\r
+typedef CHAR8 *VA_LIST;\r
+#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))\r
+#define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))\r
+#define VA_END(ap) (ap = (VA_LIST) 0)\r
+\r
+#endif\r
+\r
+//\r
+// Macro that returns the byte offset of a field in a data structure. \r
+//\r
+#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
+\r
+///\r
+/// CONTAINING_RECORD - returns a pointer to the structure\r
+/// from one of it's elements.\r
+///\r
+#define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
+\r
+///\r
+/// ALIGN_POINTER - aligns a pointer to the lowest boundry\r
+///\r
+#define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))\r
+\r
+///\r
+/// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor\r
+///\r
+#define ALIGN_VARIABLE(Value, Adjustment) \\r
+ Adjustment = 0U; \\r
+ if ((UINTN) (Value) % sizeof (UINTN)) { \\r
+ (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \\r
+ } \\r
+ (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))\r
+\r
+//\r
+// Return the maximum of two operands. \r
+// This macro returns the maximum of two operand specified by a and b. \r
+// Both a and b must be the same numerical types, signed or unsigned.\r
+//\r
+#define MAX(a, b) \\r
+ (((a) > (b)) ? (a) : (b))\r
+\r
+\r
+//\r
+// Return the minimum of two operands. \r
+// This macro returns the minimal of two operand specified by a and b. \r
+// Both a and b must be the same numerical types, signed or unsigned.\r
+//\r
+#define MIN(a, b) \\r
+ (((a) < (b)) ? (a) : (b))\r
+\r
+\r
+//\r
+// EFI Error Codes common to all execution phases\r
+//\r
+\r
+typedef INTN RETURN_STATUS;\r
+\r
+///\r
+/// Set the upper bit to indicate EFI Error.\r
+///\r
+#define ENCODE_ERROR(a) (MAX_BIT | (a))\r
+\r
+#define ENCODE_WARNING(a) (a)\r
+#define RETURN_ERROR(a) ((a) < 0)\r
+\r
+#define RETURN_SUCCESS 0\r
+#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
+#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
+#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
+#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
+#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
+#define RETURN_NOT_READY ENCODE_ERROR (6)\r
+#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
+#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
+#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
+#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
+#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
+#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
+#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
+#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
+#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
+#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
+#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
+#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
+#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
+#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
+#define RETURN_ABORTED ENCODE_ERROR (21)\r
+#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
+#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
+#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
+#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
+#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
+#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
+#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
+#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
+\r
+#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
+#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
+#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
+#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
+\r
+typedef UINT64 PHYSICAL_ADDRESS;\r
+\r
+//\r
+// LIST_ENTRY definition\r
+//\r
+typedef struct _LIST_ENTRY LIST_ENTRY;\r
+\r
+struct _LIST_ENTRY {\r
+ LIST_ENTRY *ForwardLink;\r
+ LIST_ENTRY *BackLink;\r
+};\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff