MdePkg/Include/Uefi/UefiBaseType.h

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