BaseTools/Source/C/Include/Common/UefiBaseTypes.h

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