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