MdePkg/Include/Uefi/UefiBaseType.h

   1 /** @file
   2   Defines data types and constants introduced in UEFI.
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation<BR>
   5   Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __UEFI_BASETYPE_H__
  17 #define __UEFI_BASETYPE_H__
  18
  19 #include <Base.h>
  20
  21 //
  22 // Basic data type definitions introduced in UEFI.
  23 //
  24
  25 ///
  26 /// 128-bit buffer containing a unique identifier value.
  27 ///
  28 typedef GUID                      EFI_GUID;
  29 ///
  30 /// Function return status for EFI API
  31 ///
  32 typedef RETURN_STATUS             EFI_STATUS;
  33 ///
  34 /// A collection of related interfaces.
  35 ///
  36 typedef VOID                      *EFI_HANDLE;
  37 ///
  38 /// Handle to an event structure.
  39 ///
  40 typedef VOID                      *EFI_EVENT;
  41 ///
  42 /// Task priority level.
  43 ///
  44 typedef UINTN                     EFI_TPL;
  45 ///
  46 /// Logical block address.
  47 ///
  48 typedef UINT64                    EFI_LBA;
  49
  50 ///
  51 /// 64-bit physical memory address.
  52 ///
  53 typedef UINT64                    EFI_PHYSICAL_ADDRESS;
  54
  55 ///
  56 /// 64-bit virtual memory address.
  57 ///
  58 typedef UINT64                    EFI_VIRTUAL_ADDRESS;
  59
  60 ///
  61 /// EFI Time Abstraction:
  62 ///  Year:       1998 - 20XX
  63 ///  Month:      1 - 12
  64 ///  Day:        1 - 31
  65 ///  Hour:       0 - 23
  66 ///  Minute:     0 - 59
  67 ///  Second:     0 - 59
  68 ///  Nanosecond: 0 - 999,999,999
  69 ///  TimeZone:   -1440 to 1440 or 2047
  70 ///
  71 typedef struct {
  72   UINT16  Year;
  73   UINT8   Month;
  74   UINT8   Day;
  75   UINT8   Hour;
  76   UINT8   Minute;
  77   UINT8   Second;
  78   UINT8   Pad1;
  79   UINT32  Nanosecond;
  80   INT16   TimeZone;
  81   UINT8   Daylight;
  82   UINT8   Pad2;
  83 } EFI_TIME;
  84
  85
  86 ///
  87 /// 4-byte buffer. An IPv4 internet protocol address.
  88 ///
  89 typedef struct {
  90   UINT8 Addr[4];
  91 } EFI_IPv4_ADDRESS;
  92
  93 ///
  94 /// 16-byte buffer. An IPv6 internet protocol address
  95 ///
  96 typedef struct {
  97   UINT8 Addr[16];
  98 } EFI_IPv6_ADDRESS;
  99
 100 ///
 101 /// 32-byte buffer containing a network Media Access Control address.
 102 ///
 103 typedef struct {
 104   UINT8 Addr[32];
 105 } EFI_MAC_ADDRESS;
 106
 107 ///
 108 /// 16-byte buffer aligned on a 4-byte boundary.
 109 /// An IPv4 or IPv6 internet protocol address.
 110 ///
 111 typedef union {
 112   UINT32            Addr[4];
 113   EFI_IPv4_ADDRESS  v4;
 114   EFI_IPv6_ADDRESS  v6;
 115 } EFI_IP_ADDRESS;
 116
 117
 118 ///
 119 /// Enumeration of EFI_STATUS.
 120 ///@{
 121 #define EFI_SUCCESS               RETURN_SUCCESS
 122 #define EFI_LOAD_ERROR            RETURN_LOAD_ERROR
 123 #define EFI_INVALID_PARAMETER     RETURN_INVALID_PARAMETER
 124 #define EFI_UNSUPPORTED           RETURN_UNSUPPORTED
 125 #define EFI_BAD_BUFFER_SIZE       RETURN_BAD_BUFFER_SIZE
 126 #define EFI_BUFFER_TOO_SMALL      RETURN_BUFFER_TOO_SMALL
 127 #define EFI_NOT_READY             RETURN_NOT_READY
 128 #define EFI_DEVICE_ERROR          RETURN_DEVICE_ERROR
 129 #define EFI_WRITE_PROTECTED       RETURN_WRITE_PROTECTED
 130 #define EFI_OUT_OF_RESOURCES      RETURN_OUT_OF_RESOURCES
 131 #define EFI_VOLUME_CORRUPTED      RETURN_VOLUME_CORRUPTED
 132 #define EFI_VOLUME_FULL           RETURN_VOLUME_FULL
 133 #define EFI_NO_MEDIA              RETURN_NO_MEDIA
 134 #define EFI_MEDIA_CHANGED         RETURN_MEDIA_CHANGED
 135 #define EFI_NOT_FOUND             RETURN_NOT_FOUND
 136 #define EFI_ACCESS_DENIED         RETURN_ACCESS_DENIED
 137 #define EFI_NO_RESPONSE           RETURN_NO_RESPONSE
 138 #define EFI_NO_MAPPING            RETURN_NO_MAPPING
 139 #define EFI_TIMEOUT               RETURN_TIMEOUT
 140 #define EFI_NOT_STARTED           RETURN_NOT_STARTED
 141 #define EFI_ALREADY_STARTED       RETURN_ALREADY_STARTED
 142 #define EFI_ABORTED               RETURN_ABORTED
 143 #define EFI_ICMP_ERROR            RETURN_ICMP_ERROR
 144 #define EFI_TFTP_ERROR            RETURN_TFTP_ERROR
 145 #define EFI_PROTOCOL_ERROR        RETURN_PROTOCOL_ERROR
 146 #define EFI_INCOMPATIBLE_VERSION  RETURN_INCOMPATIBLE_VERSION
 147 #define EFI_SECURITY_VIOLATION    RETURN_SECURITY_VIOLATION
 148 #define EFI_CRC_ERROR             RETURN_CRC_ERROR
 149 #define EFI_END_OF_MEDIA          RETURN_END_OF_MEDIA
 150 #define EFI_END_OF_FILE           RETURN_END_OF_FILE
 151 #define EFI_INVALID_LANGUAGE      RETURN_INVALID_LANGUAGE
 152
 153 #define EFI_WARN_UNKNOWN_GLYPH    RETURN_WARN_UNKNOWN_GLYPH
 154 #define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE
 155 #define EFI_WARN_WRITE_FAILURE    RETURN_WARN_WRITE_FAILURE
 156 #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
 157 ///@}
 158
 159 ///
 160 /// Define macro to encode the status code.
 161 ///
 162 #define EFIERR(_a)                ENCODE_ERROR(_a)
 163
 164 #define EFI_ERROR(A)              RETURN_ERROR(A)
 165
 166 ///
 167 /// ICMP error definitions
 168 ///@{
 169 #define EFI_NETWORK_UNREACHABLE   EFIERR(100)
 170 #define EFI_HOST_UNREACHABLE      EFIERR(101)
 171 #define EFI_PROTOCOL_UNREACHABLE  EFIERR(102)
 172 #define EFI_PORT_UNREACHABLE      EFIERR(103)
 173 ///@}
 174
 175 ///
 176 /// Tcp connection status definitions
 177 ///@{
 178 #define EFI_CONNECTION_FIN        EFIERR(104)
 179 #define EFI_CONNECTION_RESET      EFIERR(105)
 180 #define EFI_CONNECTION_REFUSED    EFIERR(106)
 181 ///@}
 182
 183 //
 184 // The EFI memory allocation functions work in units of EFI_PAGEs that are
 185 // 4K. This should in no way be confused with the page size of the processor.
 186 // An EFI_PAGE is just the quanta of memory in EFI.
 187 //
 188 #define EFI_PAGE_SIZE             0x1000
 189 #define EFI_PAGE_MASK             0xFFF
 190 #define EFI_PAGE_SHIFT            12
 191
 192 #define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
 193
 194 #define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)
 195
 196 ///
 197 /// PE32+ Machine type for IA32 UEFI images
 198 ///
 199 #define EFI_IMAGE_MACHINE_IA32            0x014C
 200
 201 ///
 202 /// PE32+ Machine type for IA64 UEFI images
 203 ///
 204 #define EFI_IMAGE_MACHINE_IA64            0x0200
 205
 206 ///
 207 /// PE32+ Machine type for EBC UEFI images
 208 ///
 209 #define EFI_IMAGE_MACHINE_EBC             0x0EBC
 210
 211 ///
 212 /// PE32+ Machine type for X64 UEFI images
 213 ///
 214 #define EFI_IMAGE_MACHINE_X64             0x8664
 215
 216 ///
 217 /// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images
 218 ///
 219 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED  0x01C2
 220
 221
 222 #if   defined (MDE_CPU_IA32)
 223
 224 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
 225   (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
 226
 227 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
 228
 229 #elif defined (MDE_CPU_IPF)
 230
 231 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
 232   (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
 233
 234 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
 235
 236 #elif defined (MDE_CPU_X64)
 237
 238 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
 239   (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
 240
 241 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
 242
 243 #elif defined (MDE_CPU_ARM)
 244
 245 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
 246   (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
 247
 248 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
 249
 250 #elif defined (MDE_CPU_EBC)
 251
 252 ///
 253 /// This is just to make sure you can cross compile with the EBC compiler.
 254 /// It does not make sense to have a PE loader coded in EBC.
 255 ///
 256 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
 257
 258 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
 259
 260 #else
 261 #error Unknown Processor Type
 262 #endif
 263
 264 #endif