UefiBaseType.h revision a86fda431ee08ec5e7829f956f567ba47cccde62 
1/** @file
2  Defines data types and constants introduced in UEFI.
3
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
9
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.
12
13**/
14
15#ifndef __UEFI_BASETYPE_H__
16#define __UEFI_BASETYPE_H__
17
18#include "Base.h"
19
20//
21// Basical data type definitions introduced in UEFI.
22//
23
24///
25/// 128-bit buffer containing a unique identifier value.
26///
27typedef GUID                      EFI_GUID;
28///
29/// Function return status for EFI API
30///
31typedef RETURN_STATUS             EFI_STATUS;
32///
33/// A collection of related interfaces.
34///
35typedef VOID                      *EFI_HANDLE;
36///
37/// Handle to an event structure.
38///
39typedef VOID                      *EFI_EVENT;
40///
41/// Task priority level.
42///
43typedef UINTN                     EFI_TPL;
44///
45/// Logical block address.
46///
47typedef UINT64                    EFI_LBA;
48typedef UINT64                    EFI_PHYSICAL_ADDRESS;
49typedef UINT64                    EFI_VIRTUAL_ADDRESS;
50
51///
52/// EFI Time Abstraction:
53///  Year:       1998 - 20XX
54///  Month:      1 - 12
55///  Day:        1 - 31
56///  Hour:       0 - 23
57///  Minute:     0 - 59
58///  Second:     0 - 59
59///  Nanosecond: 0 - 999,999,999
60///  TimeZone:   -1440 to 1440 or 2047
61///
62typedef struct {
63  UINT16  Year;
64  UINT8   Month;
65  UINT8   Day;
66  UINT8   Hour;
67  UINT8   Minute;
68  UINT8   Second;
69  UINT8   Pad1;
70  UINT32  Nanosecond;
71  INT16   TimeZone;
72  UINT8   Daylight;
73  UINT8   Pad2;
74} EFI_TIME;
75
76
77///
78/// 4-byte buffer. An IPv4 internet protocol address.
79///
80typedef struct {
81  UINT8 Addr[4];
82} EFI_IPv4_ADDRESS;
83
84///
85/// 16-byte buffer. An IPv6 internet protocol address
86///
87typedef struct {
88  UINT8 Addr[16];
89} EFI_IPv6_ADDRESS;
90
91///
92/// 32-byte buffer containing a network Media Access Control address.
93///
94typedef struct {
95  UINT8 Addr[32];
96} EFI_MAC_ADDRESS;
97
98///
99/// 16-byte buffer aligned on a 4-byte boundary.
100/// An IPv4 or IPv6 internet protocol address.
101///
102typedef union {
103  UINT32            Addr[4];
104  EFI_IPv4_ADDRESS  v4;
105  EFI_IPv6_ADDRESS  v6;
106} EFI_IP_ADDRESS;
107
108
109//
110// Enumeration of EFI_STATUS.
111//
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
143
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
148
149
150//
151// Define macro to encode the status code.
152//
153#define EFIERR(_a)                ENCODE_ERROR(_a)
154
155#define EFI_ERROR(A)              RETURN_ERROR(A)
156
157//
158// Define macros to build data structure signatures from characters.
159//
160#define EFI_SIGNATURE_16(A, B)        ((A) | (B << 8))
161#define EFI_SIGNATURE_32(A, B, C, D)  (EFI_SIGNATURE_16 (A, B) | (EFI_SIGNATURE_16 (C, D) << 16))
162#define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) \
163    (EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))
164
165
166///
167///  Returns the byte offset to a field within a structure
168///
169#define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
170
171//
172// The EFI memory allocation functions work in units of EFI_PAGEs that are
173// 4K. This should in no way be confused with the page size of the processor.
174// An EFI_PAGE is just the quanta of memory in EFI.
175//
176#define EFI_PAGE_SIZE             0x1000
177#define EFI_PAGE_MASK             0xFFF
178#define EFI_PAGE_SHIFT            12
179
180#define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
181
182#define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)
183
184
185#define EFI_MAX_BIT               MAX_BIT
186#define EFI_MAX_ADDRESS           MAX_ADDRESS
187
188
189///
190/// Limited buffer size for a language code recommended by RFC3066
191/// (42 characters plus a NULL terminator)
192///
193#define RFC_3066_ENTRY_SIZE             (42 + 1)
194
195///
196/// The size of a 3 character ISO639 language code.
197///
198#define ISO_639_2_ENTRY_SIZE            3
199
200
201#endif
202