MdePkg/Include/Uefi/UefiBaseType.h

   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 ///
  27 typedef GUID                      EFI_GUID;
  28 ///
  29 /// Function return status for EFI API
  30 ///
  31 typedef RETURN_STATUS             EFI_STATUS;
  32 ///
  33 /// A collection of related interfaces.
  34 ///
  35 typedef VOID                      *EFI_HANDLE;
  36 ///
  37 /// Handle to an event structure.
  38 ///
  39 typedef VOID                      *EFI_EVENT;
  40 ///
  41 /// Task priority level.
  42 ///
  43 typedef UINTN                     EFI_TPL;
  44 ///
  45 /// Logical block address.
  46 ///
  47 typedef UINT64                    EFI_LBA;
  48 typedef UINT64                    EFI_PHYSICAL_ADDRESS;
  49 typedef UINT64                    EFI_VIRTUAL_ADDRESS;
  50
  51 typedef UINT16                    STRING_REF;
  52
  53 ///
  54 /// EFI Time Abstraction:
  55 ///  Year:       1998 - 20XX
  56 ///  Month:      1 - 12
  57 ///  Day:        1 - 31
  58 ///  Hour:       0 - 23
  59 ///  Minute:     0 - 59
  60 ///  Second:     0 - 59
  61 ///  Nanosecond: 0 - 999,999,999
  62 ///  TimeZone:   -1440 to 1440 or 2047
  63 ///
  64 typedef struct {
  65   UINT16  Year;
  66   UINT8   Month;
  67   UINT8   Day;
  68   UINT8   Hour;
  69   UINT8   Minute;
  70   UINT8   Second;
  71   UINT8   Pad1;
  72   UINT32  Nanosecond;
  73   INT16   TimeZone;
  74   UINT8   Daylight;
  75   UINT8   Pad2;
  76 } EFI_TIME;
  77
  78
  79 ///
  80 /// 4-byte buffer. An IPv4 internet protocol address.
  81 ///
  82 typedef struct {
  83   UINT8 Addr[4];
  84 } EFI_IPv4_ADDRESS;
  85
  86 ///
  87 /// 16-byte buffer. An IPv6 internet protocol address
  88 ///
  89 typedef struct {
  90   UINT8 Addr[16];
  91 } EFI_IPv6_ADDRESS;
  92
  93 ///
  94 /// 32-byte buffer containing a network Media Access Control address.
  95 ///
  96 typedef struct {
  97   UINT8 Addr[32];
  98 } EFI_MAC_ADDRESS;
  99
 100 ///
 101 /// 16-byte buffer aligned on a 4-byte boundary.
 102 /// An IPv4 or IPv6 internet protocol address.
 103 ///
 104 typedef union {
 105   UINT32            Addr[4];
 106   EFI_IPv4_ADDRESS  v4;
 107   EFI_IPv6_ADDRESS  v6;
 108 } EFI_IP_ADDRESS;
 109
 110
 111 //
 112 // Enumeration of EFI_STATUS.
 113 //
 114 #define EFI_SUCCESS               RETURN_SUCCESS
 115 #define EFI_LOAD_ERROR            RETURN_LOAD_ERROR
 116 #define EFI_INVALID_PARAMETER     RETURN_INVALID_PARAMETER
 117 #define EFI_UNSUPPORTED           RETURN_UNSUPPORTED
 118 #define EFI_BAD_BUFFER_SIZE       RETURN_BAD_BUFFER_SIZE
 119 #define EFI_BUFFER_TOO_SMALL      RETURN_BUFFER_TOO_SMALL
 120 #define EFI_NOT_READY             RETURN_NOT_READY
 121 #define EFI_DEVICE_ERROR          RETURN_DEVICE_ERROR
 122 #define EFI_WRITE_PROTECTED       RETURN_WRITE_PROTECTED
 123 #define EFI_OUT_OF_RESOURCES      RETURN_OUT_OF_RESOURCES
 124 #define EFI_VOLUME_CORRUPTED      RETURN_VOLUME_CORRUPTED
 125 #define EFI_VOLUME_FULL           RETURN_VOLUME_FULL
 126 #define EFI_NO_MEDIA              RETURN_NO_MEDIA
 127 #define EFI_MEDIA_CHANGED         RETURN_MEDIA_CHANGED
 128 #define EFI_NOT_FOUND             RETURN_NOT_FOUND
 129 #define EFI_ACCESS_DENIED         RETURN_ACCESS_DENIED
 130 #define EFI_NO_RESPONSE           RETURN_NO_RESPONSE
 131 #define EFI_NO_MAPPING            RETURN_NO_MAPPING
 132 #define EFI_TIMEOUT               RETURN_TIMEOUT
 133 #define EFI_NOT_STARTED           RETURN_NOT_STARTED
 134 #define EFI_ALREADY_STARTED       RETURN_ALREADY_STARTED
 135 #define EFI_ABORTED               RETURN_ABORTED
 136 #define EFI_ICMP_ERROR            RETURN_ICMP_ERROR
 137 #define EFI_TFTP_ERROR            RETURN_TFTP_ERROR
 138 #define EFI_PROTOCOL_ERROR        RETURN_PROTOCOL_ERROR
 139 #define EFI_INCOMPATIBLE_VERSION  RETURN_INCOMPATIBLE_VERSION
 140 #define EFI_SECURITY_VIOLATION    RETURN_SECURITY_VIOLATION
 141 #define EFI_CRC_ERROR             RETURN_CRC_ERROR
 142 #define EFI_END_OF_MEDIA          RETURN_END_OF_MEDIA
 143 #define EFI_END_OF_FILE           RETURN_END_OF_FILE
 144 #define EFI_INVALID_LANGUAGE      RETURN_INVALID_LANGUAGE
 145
 146 #define EFI_WARN_UNKNOWN_GLYPH    RETURN_WARN_UNKNOWN_GLYPH
 147 #define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE
 148 #define EFI_WARN_WRITE_FAILURE    RETURN_WARN_WRITE_FAILURE
 149 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
 150
 151
 152 //
 153 // Define macro to encode the status code.
 154 //
 155 #define EFIERR(_a)                ENCODE_ERROR(_a)
 156
 157 #define EFI_ERROR(A)              RETURN_ERROR(A)
 158
 159 //
 160 // Define macros to build data structure signatures from characters.
 161 //
 162 #define EFI_SIGNATURE_16(A, B)        ((A) | (B << 8))
 163 #define EFI_SIGNATURE_32(A, B, C, D)  (EFI_SIGNATURE_16 (A, B) | (EFI_SIGNATURE_16 (C, D) << 16))
 164 #define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) \
 165     (EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))
 166
 167
 168 ///
 169 ///  Returns the byte offset to a field within a structure
 170 ///
 171 #define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
 172
 173 //
 174 // The EFI memory allocation functions work in units of EFI_PAGEs that are
 175 // 4K. This should in no way be confused with the page size of the processor.
 176 // An EFI_PAGE is just the quanta of memory in EFI.
 177 //
 178 #define EFI_PAGE_SIZE             0x1000
 179 #define EFI_PAGE_MASK             0xFFF
 180 #define EFI_PAGE_SHIFT            12
 181
 182 #define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
 183
 184 #define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)
 185
 186
 187 #define EFI_MAX_BIT               MAX_BIT
 188 #define EFI_MAX_ADDRESS           MAX_ADDRESS
 189
 190
 191 ///
 192 /// Limited buffer size for a language code recommended by RFC3066
 193 /// (42 characters plus a NULL terminator)
 194 ///
 195 #define RFC_3066_ENTRY_SIZE             (42 + 1)
 196
 197 ///
 198 /// The size of a 3 character ISO639 language code.
 199 ///
 200 #define ISO_639_2_ENTRY_SIZE            3
 201
 202
 203 #endif