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