2 Defines data types and constants introduced in UEFI.
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __UEFI_BASETYPE_H__
16 #define __UEFI_BASETYPE_H__
21 // Basical data type definitions introduced in UEFI.
25 /// 128-bit buffer containing a unique identifier value.
27 typedef GUID EFI_GUID
;
29 /// Function return status for EFI API
31 typedef RETURN_STATUS EFI_STATUS
;
33 /// A collection of related interfaces.
35 typedef VOID
*EFI_HANDLE
;
37 /// Handle to an event structure.
39 typedef VOID
*EFI_EVENT
;
41 /// Task priority level.
43 typedef UINTN EFI_TPL
;
45 /// Logical block address.
47 typedef UINT64 EFI_LBA
;
48 typedef UINT64 EFI_PHYSICAL_ADDRESS
;
49 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
52 /// EFI Time Abstraction:
59 /// Nanosecond: 0 - 999,999,999
60 /// TimeZone: -1440 to 1440 or 2047
78 /// 4-byte buffer. An IPv4 internet protocol address.
85 /// 16-byte buffer. An IPv6 internet protocol address
92 /// 32-byte buffer containing a network Media Access Control address.
99 /// 16-byte buffer aligned on a 4-byte boundary.
100 /// An IPv4 or IPv6 internet protocol address.
110 // Enumeration of EFI_STATUS.
112 #define EFI_SUCCESS RETURN_SUCCESS
113 #define EFI_LOAD_ERROR RETURN_LOAD_ERROR
114 #define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
115 #define EFI_UNSUPPORTED RETURN_UNSUPPORTED
116 #define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
117 #define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
118 #define EFI_NOT_READY RETURN_NOT_READY
119 #define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
120 #define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
121 #define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
122 #define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
123 #define EFI_VOLUME_FULL RETURN_VOLUME_FULL
124 #define EFI_NO_MEDIA RETURN_NO_MEDIA
125 #define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
126 #define EFI_NOT_FOUND RETURN_NOT_FOUND
127 #define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
128 #define EFI_NO_RESPONSE RETURN_NO_RESPONSE
129 #define EFI_NO_MAPPING RETURN_NO_MAPPING
130 #define EFI_TIMEOUT RETURN_TIMEOUT
131 #define EFI_NOT_STARTED RETURN_NOT_STARTED
132 #define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
133 #define EFI_ABORTED RETURN_ABORTED
134 #define EFI_ICMP_ERROR RETURN_ICMP_ERROR
135 #define EFI_TFTP_ERROR RETURN_TFTP_ERROR
136 #define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
137 #define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
138 #define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
139 #define EFI_CRC_ERROR RETURN_CRC_ERROR
140 #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
141 #define EFI_END_OF_FILE RETURN_END_OF_FILE
142 #define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
144 #define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
145 #define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
146 #define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
147 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
151 // Define macro to encode the status code.
153 #define EFIERR(_a) ENCODE_ERROR(_a)
155 #define EFI_ERROR(A) RETURN_ERROR(A)
158 // Define macros to build data structure signatures from characters.
160 #define EFI_SIGNATURE_16(A, B) SIGNATURE_16 (A, B)
161 #define EFI_SIGNATURE_32(A, B, C, D) SIGNATURE_32 (A, B, C, D)
162 #define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) SIGNATURE_64 (A, B, C, D, E, F, G, H)
166 /// Returns the byte offset to a field within a structure
168 #define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
171 // The EFI memory allocation functions work in units of EFI_PAGEs that are
172 // 4K. This should in no way be confused with the page size of the processor.
173 // An EFI_PAGE is just the quanta of memory in EFI.
175 #define EFI_PAGE_SIZE 0x1000
176 #define EFI_PAGE_MASK 0xFFF
177 #define EFI_PAGE_SHIFT 12
179 #define EFI_SIZE_TO_PAGES(a) (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
181 #define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)
184 #define EFI_MAX_BIT MAX_BIT
185 #define EFI_MAX_ADDRESS MAX_ADDRESS
189 /// Limited buffer size for a language code recommended by RFC3066
190 /// (42 characters plus a NULL terminator)
192 #define RFC_3066_ENTRY_SIZE (42 + 1)
195 /// The size of a 3 character ISO639 language code.
197 #define ISO_639_2_ENTRY_SIZE 3