MdePkg/Include/Uefi/UefiBaseType.h

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