[mirror_edk2.git] / BaseTools / Source / C / Include / Common / UefiBaseTypes.h

/** @file\r
  Defines data types and constants introduced in UEFI.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __UEFI_BASETYPE_H__\r
#define __UEFI_BASETYPE_H__\r
\r
#include <Common/BaseTypes.h>\r
\r
//\r
// Basical data type definitions introduced in UEFI.\r
//\r
typedef struct {\r
  UINT32  Data1;\r
  UINT16  Data2;\r
  UINT16  Data3;\r
  UINT8   Data4[8];\r
} EFI_GUID;\r
\r
typedef RETURN_STATUS             EFI_STATUS;\r
typedef VOID                      *EFI_HANDLE;\r
\r
typedef VOID                      *EFI_EVENT;\r
\r
typedef UINTN                     EFI_TPL;\r
\r
\r
typedef UINT64                    EFI_LBA;\r
\r
\r
typedef UINT16                    STRING_REF;\r
\r
typedef UINT64                    EFI_PHYSICAL_ADDRESS;\r
typedef UINT64                    EFI_VIRTUAL_ADDRESS;\r
\r
//\r
// EFI Time Abstraction:\r
//  Year:       2000 - 20XX\r
//  Month:      1 - 12\r
//  Day:        1 - 31\r
//  Hour:       0 - 23\r
//  Minute:     0 - 59\r
//  Second:     0 - 59\r
//  Nanosecond: 0 - 999,999,999\r
//  TimeZone:   -1440 to 1440 or 2047\r
//\r
typedef struct {\r
  UINT16  Year;\r
  UINT8   Month;\r
  UINT8   Day;\r
  UINT8   Hour;\r
  UINT8   Minute;\r
  UINT8   Second;\r
  UINT8   Pad1;\r
  UINT32  Nanosecond;\r
  INT16   TimeZone;\r
  UINT8   Daylight;\r
  UINT8   Pad2;\r
} EFI_TIME;\r
\r
\r
//\r
// Networking Definitions\r
//\r
typedef struct {\r
  UINT8 Addr[4];\r
} EFI_IPv4_ADDRESS;\r
\r
typedef struct {\r
  UINT8 Addr[16];\r
} EFI_IPv6_ADDRESS;\r
\r
typedef struct {\r
  UINT8 Addr[32];\r
} EFI_MAC_ADDRESS;\r
\r
typedef union {\r
  UINT32            Addr[4];\r
  EFI_IPv4_ADDRESS  v4;\r
  EFI_IPv6_ADDRESS  v6;\r
} EFI_IP_ADDRESS;\r
\r
\r
//\r
// Enumeration of EFI_STATUS.\r
//\r
#define EFI_SUCCESS               RETURN_SUCCESS\r
#define EFI_LOAD_ERROR            RETURN_LOAD_ERROR\r
#define EFI_INVALID_PARAMETER     RETURN_INVALID_PARAMETER\r
#define EFI_UNSUPPORTED           RETURN_UNSUPPORTED\r
#define EFI_BAD_BUFFER_SIZE       RETURN_BAD_BUFFER_SIZE\r
#define EFI_BUFFER_TOO_SMALL      RETURN_BUFFER_TOO_SMALL\r
#define EFI_NOT_READY             RETURN_NOT_READY\r
#define EFI_DEVICE_ERROR          RETURN_DEVICE_ERROR\r
#define EFI_WRITE_PROTECTED       RETURN_WRITE_PROTECTED\r
#define EFI_OUT_OF_RESOURCES      RETURN_OUT_OF_RESOURCES\r
#define EFI_VOLUME_CORRUPTED      RETURN_VOLUME_CORRUPTED\r
#define EFI_VOLUME_FULL           RETURN_VOLUME_FULL\r
#define EFI_NO_MEDIA              RETURN_NO_MEDIA\r
#define EFI_MEDIA_CHANGED         RETURN_MEDIA_CHANGED\r
#define EFI_NOT_FOUND             RETURN_NOT_FOUND\r
#define EFI_ACCESS_DENIED         RETURN_ACCESS_DENIED\r
#define EFI_NO_RESPONSE           RETURN_NO_RESPONSE\r
#define EFI_NO_MAPPING            RETURN_NO_MAPPING\r
#define EFI_TIMEOUT               RETURN_TIMEOUT\r
#define EFI_NOT_STARTED           RETURN_NOT_STARTED\r
#define EFI_ALREADY_STARTED       RETURN_ALREADY_STARTED\r
#define EFI_ABORTED               RETURN_ABORTED\r
#define EFI_ICMP_ERROR            RETURN_ICMP_ERROR\r
#define EFI_TFTP_ERROR            RETURN_TFTP_ERROR\r
#define EFI_PROTOCOL_ERROR        RETURN_PROTOCOL_ERROR\r
#define EFI_INCOMPATIBLE_VERSION  RETURN_INCOMPATIBLE_VERSION\r
#define EFI_SECURITY_VIOLATION    RETURN_SECURITY_VIOLATION\r
#define EFI_CRC_ERROR             RETURN_CRC_ERROR\r
#define EFI_END_OF_MEDIA          RETURN_END_OF_MEDIA\r
#define EFI_END_OF_FILE           RETURN_END_OF_FILE\r
\r
#define EFI_WARN_UNKNOWN_GLYPH    RETURN_WARN_UNKNOWN_GLYPH\r
#define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE\r
#define EFI_WARN_WRITE_FAILURE    RETURN_WARN_WRITE_FAILURE\r
#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL\r
\r
\r
#define NULL_HANDLE               ((VOID *) 0)\r
\r
//\r
// Define macro to encode the status code.\r
//\r
#define EFIERR(_a)                ENCODE_ERROR(_a)\r
\r
#define EFI_ERROR(A)              RETURN_ERROR(A)\r
\r
//\r
// Define macros to build data structure signatures from characters.\r
//\r
#define SIGNATURE_16(A, B)        ((A) | (B << 8))\r
#define SIGNATURE_32(A, B, C, D)  (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r
#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
    (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
\r
\r
//\r
//  Returns the byte offset to a field within a structure\r
//\r
#define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))\r
\r
//\r
// The EFI memory allocation functions work in units of EFI_PAGEs that are\r
// 4K. This should in no way be confused with the page size of the processor.\r
// An EFI_PAGE is just the quanta of memory in EFI.\r
//\r
#define EFI_PAGE_SIZE             0x1000\r
#define EFI_PAGE_MASK             0xFFF\r
#define EFI_PAGE_SHIFT            12\r
\r
#define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))\r
\r
#define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)\r
\r
\r
#define EFI_MAX_BIT               MAX_BIT\r
\r
#endif\r
Commit	Line	Data
30fdf114 LG	1	/** @file\r
	2	Defines data types and constants introduced in UEFI.\r
	3	\r
f7496d71	4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
30fdf114	5	\r
2e351cbe	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
30fdf114	7	\r
30fdf114 LG	8	**/\r
	9	\r
	10	#ifndef __UEFI_BASETYPE_H__\r
	11	#define __UEFI_BASETYPE_H__\r
	12	\r
	13	#include <Common/BaseTypes.h>\r
	14	\r
	15	//\r
	16	// Basical data type definitions introduced in UEFI.\r
f7496d71	17	//\r
30fdf114 LG	18	typedef struct {\r
	19	UINT32 Data1;\r
	20	UINT16 Data2;\r
	21	UINT16 Data3;\r
	22	UINT8 Data4[8];\r
	23	} EFI_GUID;\r
	24	\r
	25	typedef RETURN_STATUS EFI_STATUS;\r
	26	typedef VOID *EFI_HANDLE;\r
	27	\r
	28	typedef VOID *EFI_EVENT;\r
	29	\r
	30	typedef UINTN EFI_TPL;\r
	31	\r
	32	\r
	33	typedef UINT64 EFI_LBA;\r
	34	\r
	35	\r
	36	typedef UINT16 STRING_REF;\r
	37	\r
	38	typedef UINT64 EFI_PHYSICAL_ADDRESS;\r
	39	typedef UINT64 EFI_VIRTUAL_ADDRESS;\r
	40	\r
	41	//\r
	42	// EFI Time Abstraction:\r
	43	// Year: 2000 - 20XX\r
	44	// Month: 1 - 12\r
	45	// Day: 1 - 31\r
	46	// Hour: 0 - 23\r
	47	// Minute: 0 - 59\r
	48	// Second: 0 - 59\r
	49	// Nanosecond: 0 - 999,999,999\r
	50	// TimeZone: -1440 to 1440 or 2047\r
	51	//\r
	52	typedef struct {\r
	53	UINT16 Year;\r
	54	UINT8 Month;\r
	55	UINT8 Day;\r
	56	UINT8 Hour;\r
	57	UINT8 Minute;\r
	58	UINT8 Second;\r
	59	UINT8 Pad1;\r
	60	UINT32 Nanosecond;\r
	61	INT16 TimeZone;\r
	62	UINT8 Daylight;\r
	63	UINT8 Pad2;\r
	64	} EFI_TIME;\r
	65	\r
	66	\r
	67	//\r
	68	// Networking Definitions\r
	69	//\r
	70	typedef struct {\r
	71	UINT8 Addr[4];\r
	72	} EFI_IPv4_ADDRESS;\r
	73	\r
	74	typedef struct {\r
	75	UINT8 Addr[16];\r
	76	} EFI_IPv6_ADDRESS;\r
	77	\r
	78	typedef struct {\r
	79	UINT8 Addr[32];\r
	80	} EFI_MAC_ADDRESS;\r
	81	\r
82	typedef union {\r
83	UINT32 Addr[4];\r
84	EFI_IPv4_ADDRESS v4;\r
85	EFI_IPv6_ADDRESS v6;\r
86	} EFI_IP_ADDRESS;\r
87	\r
88	\r
89	//\r
90	// Enumeration of EFI_STATUS.\r
f7496d71 LG	91	//\r
	92	#define EFI_SUCCESS RETURN_SUCCESS\r
	93	#define EFI_LOAD_ERROR RETURN_LOAD_ERROR\r
	94	#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER\r
	95	#define EFI_UNSUPPORTED RETURN_UNSUPPORTED\r
	96	#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE\r
	97	#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL\r
	98	#define EFI_NOT_READY RETURN_NOT_READY\r
	99	#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR\r
	100	#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED\r
	101	#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES\r
	102	#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED\r
	103	#define EFI_VOLUME_FULL RETURN_VOLUME_FULL\r
	104	#define EFI_NO_MEDIA RETURN_NO_MEDIA\r
	105	#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED\r
	106	#define EFI_NOT_FOUND RETURN_NOT_FOUND\r
	107	#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED\r
	108	#define EFI_NO_RESPONSE RETURN_NO_RESPONSE\r
	109	#define EFI_NO_MAPPING RETURN_NO_MAPPING\r
	110	#define EFI_TIMEOUT RETURN_TIMEOUT\r
	111	#define EFI_NOT_STARTED RETURN_NOT_STARTED\r
	112	#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED\r
	113	#define EFI_ABORTED RETURN_ABORTED\r
	114	#define EFI_ICMP_ERROR RETURN_ICMP_ERROR\r
	115	#define EFI_TFTP_ERROR RETURN_TFTP_ERROR\r
	116	#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR\r
	117	#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION\r
	118	#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION\r
	119	#define EFI_CRC_ERROR RETURN_CRC_ERROR\r
30fdf114 LG	120	#define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA\r
	121	#define EFI_END_OF_FILE RETURN_END_OF_FILE\r
	122	\r
f7496d71 LG	123	#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH\r
	124	#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE\r
	125	#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE\r
30fdf114 LG	126	#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL\r
	127	\r
	128	\r
	129	#define NULL_HANDLE ((VOID *) 0)\r
	130	\r
	131	//\r
	132	// Define macro to encode the status code.\r
f7496d71	133	//\r
30fdf114 LG	134	#define EFIERR(_a) ENCODE_ERROR(_a)\r
	135	\r
	136	#define EFI_ERROR(A) RETURN_ERROR(A)\r
	137	\r
	138	//\r
	139	// Define macros to build data structure signatures from characters.\r
	140	//\r
2bc3256c LG	141	#define SIGNATURE_16(A, B) ((A) \| (B << 8))\r
	142	#define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) \| (SIGNATURE_16 (C, D) << 16))\r
	143	#define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
	144	(SIGNATURE_32 (A, B, C, D) \| ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
30fdf114 LG	145	\r
	146	\r
	147	//\r
	148	// Returns the byte offset to a field within a structure\r
	149	//\r
	150	#define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))\r
	151	\r
	152	//\r
	153	// The EFI memory allocation functions work in units of EFI_PAGEs that are\r
	154	// 4K. This should in no way be confused with the page size of the processor.\r
	155	// An EFI_PAGE is just the quanta of memory in EFI.\r
	156	//\r
	157	#define EFI_PAGE_SIZE 0x1000\r
	158	#define EFI_PAGE_MASK 0xFFF\r
	159	#define EFI_PAGE_SHIFT 12\r
	160	\r
	161	#define EFI_SIZE_TO_PAGES(a) (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))\r
	162	\r
	163	#define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)\r
	164	\r
	165	\r
	166	#define EFI_MAX_BIT MAX_BIT\r
30fdf114 LG	167	\r
30fdf114 LG	168	#endif\r