4 Defines data types and constants introduced in UEFI.
6 Copyright (c) 2006 - 2007, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __UEFI_BASETYPE_H__
18 #define __UEFI_BASETYPE_H__
23 // Basical data type definitions introduced in UEFI.
25 typedef GUID EFI_GUID
;
26 typedef RETURN_STATUS EFI_STATUS
;
27 typedef VOID
*EFI_HANDLE
;
29 typedef VOID
*EFI_EVENT
;
31 typedef UINTN EFI_TPL
;
34 typedef UINT64 EFI_LBA
;
37 typedef UINT16 EFI_HII_HANDLE
;
38 typedef UINT16 STRING_REF
;
40 typedef UINT64 EFI_PHYSICAL_ADDRESS
;
41 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
44 // EFI Time Abstraction:
51 // Nanosecond: 0 - 999,999,999
52 // TimeZone: -1440 to 1440 or 2047
69 // Enumeration of EFI_STATUS.
71 #define EFI_SUCCESS RETURN_SUCCESS
72 #define EFI_LOAD_ERROR RETURN_LOAD_ERROR
73 #define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
74 #define EFI_UNSUPPORTED RETURN_UNSUPPORTED
75 #define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
76 #define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
77 #define EFI_NOT_READY RETURN_NOT_READY
78 #define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
79 #define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
80 #define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
81 #define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
82 #define EFI_VOLUME_FULL RETURN_VOLUME_FULL
83 #define EFI_NO_MEDIA RETURN_NO_MEDIA
84 #define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
85 #define EFI_NOT_FOUND RETURN_NOT_FOUND
86 #define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
87 #define EFI_NO_RESPONSE RETURN_NO_RESPONSE
88 #define EFI_NO_MAPPING RETURN_NO_MAPPING
89 #define EFI_TIMEOUT RETURN_TIMEOUT
90 #define EFI_NOT_STARTED RETURN_NOT_STARTED
91 #define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
92 #define EFI_ABORTED RETURN_ABORTED
93 #define EFI_ICMP_ERROR RETURN_ICMP_ERROR
94 #define EFI_TFTP_ERROR RETURN_TFTP_ERROR
95 #define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
96 #define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
97 #define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
98 #define EFI_CRC_ERROR RETURN_CRC_ERROR
99 #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
100 #define EFI_END_OF_FILE RETURN_END_OF_FILE
102 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
103 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
104 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
105 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
108 #define NULL_HANDLE ((VOID *) 0)
111 // Define macro to encode the status code.
113 #define EFIERR(_a) ENCODE_ERROR(_a)
115 #define EFI_ERROR(A) RETURN_ERROR(A)
118 // Define macros to build data structure signatures from characters.
120 #define EFI_SIGNATURE_16(A, B) ((A) | (B << 8))
121 #define EFI_SIGNATURE_32(A, B, C, D) (EFI_SIGNATURE_16 (A, B) | (EFI_SIGNATURE_16 (C, D) << 16))
122 #define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) \
123 (EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))
127 // Returns the byte offset to a field within a structure
129 #define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
132 // The EFI memory allocation functions work in units of EFI_PAGEs that are
133 // 4K. This should in no way be confused with the page size of the processor.
134 // An EFI_PAGE is just the quanta of memory in EFI.
136 #define EFI_PAGE_SIZE 0x1000
137 #define EFI_PAGE_MASK 0xFFF
138 #define EFI_PAGE_SHIFT 12