/** @file | |
Processor or Compiler specific defines for all supported processors. | |
This file is stand alone self consistent set of definitions. | |
Copyright (c) 2006, Intel Corporation | |
All rights reserved. This program and the accompanying materials | |
are licensed and made available under the terms and conditions of the BSD License | |
which accompanies this distribution. The full text of the license may be found at | |
http://opensource.org/licenses/bsd-license.php | |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
Module Name: BaseTypes.h | |
**/ | |
#ifndef __BASE_TYPES_H__ | |
#define __BASE_TYPES_H__ | |
// | |
// Include processor specific binding | |
// | |
#include <ProcessorBind.h> | |
#define MEMORY_FENCE() MemoryFence () | |
#define BREAKPOINT() CpuBreakpoint () | |
#define DEADLOOP() CpuDeadLoop () | |
typedef struct { | |
UINT32 Data1; | |
UINT16 Data2; | |
UINT16 Data3; | |
UINT8 Data4[8]; | |
} GUID; | |
// | |
// Modifiers to absract standard types to aid in debug of problems | |
// | |
#define CONST const | |
#define STATIC static | |
#define VOID void | |
// | |
// Modifiers for Data Types used to self document code. | |
// This concept is borrowed for UEFI specification. | |
// | |
#ifndef IN | |
// | |
// Some other envirnments use this construct, so #ifndef to prevent | |
// mulitple definition. | |
// | |
#define IN | |
#define OUT | |
#define OPTIONAL | |
#endif | |
// | |
// Constants. They may exist in other build structures, so #ifndef them. | |
// | |
#ifndef TRUE | |
// | |
// BugBug: UEFI specification claims 1 and 0. We are concerned about the | |
// complier portability so we did it this way. | |
// | |
#define TRUE ((BOOLEAN)(1==1)) | |
#endif | |
#ifndef FALSE | |
#define FALSE ((BOOLEAN)(0==1)) | |
#endif | |
#ifndef NULL | |
#define NULL ((VOID *) 0) | |
#endif | |
// | |
// Support for variable length argument lists using the ANSI standard. | |
// | |
// Since we are using the ANSI standard we used the standard nameing and | |
// did not folow the coding convention | |
// | |
// VA_LIST - typedef for argument list. | |
// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use. | |
// VA_END (VA_LIST Marker) - Clear Marker | |
// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from | |
// the ... list. You must know the size and pass it in this macro. | |
// | |
// example: | |
// | |
// UINTN | |
// ExampleVarArg ( | |
// IN UINTN NumberOfArgs, | |
// ... | |
// ) | |
// { | |
// VA_LIST Marker; | |
// UINTN Index; | |
// UINTN Result; | |
// | |
// // | |
// // Initialize the Marker | |
// // | |
// VA_START (Marker, NumberOfArgs); | |
// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) { | |
// // | |
// // The ... list is a series of UINTN values, so average them up. | |
// // | |
// Result += VA_ARG (Marker, UINTN); | |
// } | |
// | |
// VA_END (Marker); | |
// return Result | |
// } | |
// | |
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1)) | |
// | |
// Also support coding convention rules for var arg macros | |
// | |
#ifndef VA_START | |
typedef CHAR8 *VA_LIST; | |
#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v)) | |
#define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t))) | |
#define VA_END(ap) (ap = (VA_LIST) 0) | |
#endif | |
/// | |
/// CONTAINING_RECORD - returns a pointer to the structure | |
/// from one of it's elements. | |
/// | |
#define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field))) | |
/// | |
/// ALIGN_POINTER - aligns a pointer to the lowest boundry | |
/// | |
#define ALIGN_POINTER(p, s) ((VOID *) ((p) + (((s) - ((UINTN) (p))) & ((s) - 1)))) | |
/// | |
/// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor | |
/// | |
#define ALIGN_VARIABLE(Value, Adjustment) \ | |
Adjustment = 0U; \ | |
if ((UINTN) (Value) % sizeof (UINTN)) { \ | |
(Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \ | |
} \ | |
(Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment)) | |
// | |
// EFI Error Codes common to all execution phases | |
// | |
typedef INTN RETURN_STATUS; | |
/// | |
/// Set the upper bit to indicate EFI Error. | |
/// | |
#define ENCODE_ERROR(a) (MAX_BIT | (a)) | |
#define ENCODE_WARNING(a) (a) | |
#define RETURN_ERROR(a) ((a) < 0) | |
#define RETURN_SUCCESS 0 | |
#define RETURN_LOAD_ERROR ENCODE_ERROR (1) | |
#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2) | |
#define RETURN_UNSUPPORTED ENCODE_ERROR (3) | |
#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4) | |
#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5) | |
#define RETURN_NOT_READY ENCODE_ERROR (6) | |
#define RETURN_DEVICE_ERROR ENCODE_ERROR (7) | |
#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8) | |
#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9) | |
#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10) | |
#define RETURN_VOLUME_FULL ENCODE_ERROR (11) | |
#define RETURN_NO_MEDIA ENCODE_ERROR (12) | |
#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13) | |
#define RETURN_NOT_FOUND ENCODE_ERROR (14) | |
#define RETURN_ACCESS_DENIED ENCODE_ERROR (15) | |
#define RETURN_NO_RESPONSE ENCODE_ERROR (16) | |
#define RETURN_NO_MAPPING ENCODE_ERROR (17) | |
#define RETURN_TIMEOUT ENCODE_ERROR (18) | |
#define RETURN_NOT_STARTED ENCODE_ERROR (19) | |
#define RETURN_ALREADY_STARTED ENCODE_ERROR (20) | |
#define RETURN_ABORTED ENCODE_ERROR (21) | |
#define RETURN_ICMP_ERROR ENCODE_ERROR (22) | |
#define RETURN_TFTP_ERROR ENCODE_ERROR (23) | |
#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24) | |
#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25) | |
#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26) | |
#define RETURN_CRC_ERROR ENCODE_ERROR (27) | |
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28) | |
#define RETURN_END_OF_FILE ENCODE_ERROR (31) | |
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1) | |
#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2) | |
#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3) | |
#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4) | |
typedef UINT64 PHYSICAL_ADDRESS; | |
#endif |