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