TianoCore EDK2 master
UefiBaseType.h File Reference
#include <Base.h>

Go to the source code of this file.

Data Structures

struct  EFI_TIME
 
struct  EFI_MAC_ADDRESS
 
union  EFI_IP_ADDRESS
 

Macros

#define EFIERR(_a)   ENCODE_ERROR(_a)
 
#define EFI_ERROR(A)   RETURN_ERROR(A)
 
#define EFI_PAGE_SIZE   SIZE_4KB
 
#define EFI_PAGE_MASK   0xFFF
 
#define EFI_PAGE_SHIFT   12
 
#define EFI_SIZE_TO_PAGES(Size)   (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
 
#define EFI_PAGES_TO_SIZE(Pages)   ((Pages) << EFI_PAGE_SHIFT)
 
#define EFI_IMAGE_MACHINE_IA32   0x014C
 
#define EFI_IMAGE_MACHINE_IA64   0x0200
 
#define EFI_IMAGE_MACHINE_EBC   0x0EBC
 
#define EFI_IMAGE_MACHINE_X64   0x8664
 
#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED   0x01C2
 
#define EFI_IMAGE_MACHINE_AARCH64   0xAA64
 
#define EFI_IMAGE_MACHINE_RISCV32   0x5032
 
#define EFI_IMAGE_MACHINE_RISCV64   0x5064
 
#define EFI_IMAGE_MACHINE_RISCV128   0x5128
 
#define EFI_SUCCESS   RETURN_SUCCESS
 
#define EFI_LOAD_ERROR   RETURN_LOAD_ERROR
 
#define EFI_INVALID_PARAMETER   RETURN_INVALID_PARAMETER
 
#define EFI_UNSUPPORTED   RETURN_UNSUPPORTED
 
#define EFI_BAD_BUFFER_SIZE   RETURN_BAD_BUFFER_SIZE
 
#define EFI_BUFFER_TOO_SMALL   RETURN_BUFFER_TOO_SMALL
 
#define EFI_NOT_READY   RETURN_NOT_READY
 
#define EFI_DEVICE_ERROR   RETURN_DEVICE_ERROR
 
#define EFI_WRITE_PROTECTED   RETURN_WRITE_PROTECTED
 
#define EFI_OUT_OF_RESOURCES   RETURN_OUT_OF_RESOURCES
 
#define EFI_VOLUME_CORRUPTED   RETURN_VOLUME_CORRUPTED
 
#define EFI_VOLUME_FULL   RETURN_VOLUME_FULL
 
#define EFI_NO_MEDIA   RETURN_NO_MEDIA
 
#define EFI_MEDIA_CHANGED   RETURN_MEDIA_CHANGED
 
#define EFI_NOT_FOUND   RETURN_NOT_FOUND
 
#define EFI_ACCESS_DENIED   RETURN_ACCESS_DENIED
 
#define EFI_NO_RESPONSE   RETURN_NO_RESPONSE
 
#define EFI_NO_MAPPING   RETURN_NO_MAPPING
 
#define EFI_TIMEOUT   RETURN_TIMEOUT
 
#define EFI_NOT_STARTED   RETURN_NOT_STARTED
 
#define EFI_ALREADY_STARTED   RETURN_ALREADY_STARTED
 
#define EFI_ABORTED   RETURN_ABORTED
 
#define EFI_ICMP_ERROR   RETURN_ICMP_ERROR
 
#define EFI_TFTP_ERROR   RETURN_TFTP_ERROR
 
#define EFI_PROTOCOL_ERROR   RETURN_PROTOCOL_ERROR
 
#define EFI_INCOMPATIBLE_VERSION   RETURN_INCOMPATIBLE_VERSION
 
#define EFI_SECURITY_VIOLATION   RETURN_SECURITY_VIOLATION
 
#define EFI_CRC_ERROR   RETURN_CRC_ERROR
 
#define EFI_END_OF_MEDIA   RETURN_END_OF_MEDIA
 
#define EFI_END_OF_FILE   RETURN_END_OF_FILE
 
#define EFI_INVALID_LANGUAGE   RETURN_INVALID_LANGUAGE
 
#define EFI_COMPROMISED_DATA   RETURN_COMPROMISED_DATA
 
#define EFI_HTTP_ERROR   RETURN_HTTP_ERROR
 
#define EFI_WARN_UNKNOWN_GLYPH   RETURN_WARN_UNKNOWN_GLYPH
 
#define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE
 
#define EFI_WARN_WRITE_FAILURE   RETURN_WARN_WRITE_FAILURE
 
#define EFI_WARN_BUFFER_TOO_SMALL   RETURN_WARN_BUFFER_TOO_SMALL
 
#define EFI_WARN_STALE_DATA   RETURN_WARN_STALE_DATA
 
#define EFI_WARN_FILE_SYSTEM   RETURN_WARN_FILE_SYSTEM
 
#define EFI_NETWORK_UNREACHABLE   EFIERR(100)
 
#define EFI_HOST_UNREACHABLE   EFIERR(101)
 
#define EFI_PROTOCOL_UNREACHABLE   EFIERR(102)
 
#define EFI_PORT_UNREACHABLE   EFIERR(103)
 
#define EFI_CONNECTION_FIN   EFIERR(104)
 
#define EFI_CONNECTION_RESET   EFIERR(105)
 
#define EFI_CONNECTION_REFUSED   EFIERR(106)
 

Typedefs

typedef GUID EFI_GUID
 
typedef RETURN_STATUS EFI_STATUS
 
typedef VOIDEFI_HANDLE
 
typedef VOIDEFI_EVENT
 
typedef UINTN EFI_TPL
 
typedef UINT64 EFI_LBA
 
typedef UINT64 EFI_PHYSICAL_ADDRESS
 
typedef UINT64 EFI_VIRTUAL_ADDRESS
 
typedef IPv4_ADDRESS EFI_IPv4_ADDRESS
 
typedef IPv6_ADDRESS EFI_IPv6_ADDRESS
 

Detailed Description

Defines data types and constants introduced in UEFI.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.
Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.
Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiBaseType.h.

Macro Definition Documentation

◆ EFI_ABORTED

#define EFI_ABORTED   RETURN_ABORTED

Definition at line 132 of file UefiBaseType.h.

◆ EFI_ACCESS_DENIED

#define EFI_ACCESS_DENIED   RETURN_ACCESS_DENIED

Definition at line 126 of file UefiBaseType.h.

◆ EFI_ALREADY_STARTED

#define EFI_ALREADY_STARTED   RETURN_ALREADY_STARTED

Definition at line 131 of file UefiBaseType.h.

◆ EFI_BAD_BUFFER_SIZE

#define EFI_BAD_BUFFER_SIZE   RETURN_BAD_BUFFER_SIZE

Definition at line 115 of file UefiBaseType.h.

◆ EFI_BUFFER_TOO_SMALL

#define EFI_BUFFER_TOO_SMALL   RETURN_BUFFER_TOO_SMALL

Definition at line 116 of file UefiBaseType.h.

◆ EFI_COMPROMISED_DATA

#define EFI_COMPROMISED_DATA   RETURN_COMPROMISED_DATA

Definition at line 142 of file UefiBaseType.h.

◆ EFI_CONNECTION_FIN

#define EFI_CONNECTION_FIN   EFIERR(104)

Tcp connection status definitions

Definition at line 172 of file UefiBaseType.h.

◆ EFI_CONNECTION_REFUSED

#define EFI_CONNECTION_REFUSED   EFIERR(106)

Definition at line 174 of file UefiBaseType.h.

◆ EFI_CONNECTION_RESET

#define EFI_CONNECTION_RESET   EFIERR(105)

Definition at line 173 of file UefiBaseType.h.

◆ EFI_CRC_ERROR

#define EFI_CRC_ERROR   RETURN_CRC_ERROR

Definition at line 138 of file UefiBaseType.h.

◆ EFI_DEVICE_ERROR

#define EFI_DEVICE_ERROR   RETURN_DEVICE_ERROR

Definition at line 118 of file UefiBaseType.h.

◆ EFI_END_OF_FILE

#define EFI_END_OF_FILE   RETURN_END_OF_FILE

Definition at line 140 of file UefiBaseType.h.

◆ EFI_END_OF_MEDIA

#define EFI_END_OF_MEDIA   RETURN_END_OF_MEDIA

Definition at line 139 of file UefiBaseType.h.

◆ EFI_ERROR

#define EFI_ERROR (   A)    RETURN_ERROR(A)

Definition at line 158 of file UefiBaseType.h.

◆ EFI_HOST_UNREACHABLE

#define EFI_HOST_UNREACHABLE   EFIERR(101)

Definition at line 164 of file UefiBaseType.h.

◆ EFI_HTTP_ERROR

#define EFI_HTTP_ERROR   RETURN_HTTP_ERROR

Definition at line 143 of file UefiBaseType.h.

◆ EFI_ICMP_ERROR

#define EFI_ICMP_ERROR   RETURN_ICMP_ERROR

Definition at line 133 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_AARCH64

#define EFI_IMAGE_MACHINE_AARCH64   0xAA64

PE32+ Machine type for AARCH64 A64 images.

Definition at line 240 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_ARMTHUMB_MIXED

#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED   0x01C2

PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.

Definition at line 235 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_EBC

#define EFI_IMAGE_MACHINE_EBC   0x0EBC

PE32+ Machine type for EBC UEFI images.

Definition at line 225 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_IA32

#define EFI_IMAGE_MACHINE_IA32   0x014C

PE32+ Machine type for IA32 UEFI images.

Definition at line 215 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_IA64

#define EFI_IMAGE_MACHINE_IA64   0x0200

PE32+ Machine type for IA64 UEFI images.

Definition at line 220 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_RISCV128

#define EFI_IMAGE_MACHINE_RISCV128   0x5128

Definition at line 247 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_RISCV32

#define EFI_IMAGE_MACHINE_RISCV32   0x5032

PE32+ Machine type for RISC-V 32/64/128

Definition at line 245 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_RISCV64

#define EFI_IMAGE_MACHINE_RISCV64   0x5064

Definition at line 246 of file UefiBaseType.h.

◆ EFI_IMAGE_MACHINE_X64

#define EFI_IMAGE_MACHINE_X64   0x8664

PE32+ Machine type for X64 UEFI images.

Definition at line 230 of file UefiBaseType.h.

◆ EFI_INCOMPATIBLE_VERSION

#define EFI_INCOMPATIBLE_VERSION   RETURN_INCOMPATIBLE_VERSION

Definition at line 136 of file UefiBaseType.h.

◆ EFI_INVALID_LANGUAGE

#define EFI_INVALID_LANGUAGE   RETURN_INVALID_LANGUAGE

Definition at line 141 of file UefiBaseType.h.

◆ EFI_INVALID_PARAMETER

#define EFI_INVALID_PARAMETER   RETURN_INVALID_PARAMETER

Definition at line 113 of file UefiBaseType.h.

◆ EFI_LOAD_ERROR

#define EFI_LOAD_ERROR   RETURN_LOAD_ERROR

Definition at line 112 of file UefiBaseType.h.

◆ EFI_MEDIA_CHANGED

#define EFI_MEDIA_CHANGED   RETURN_MEDIA_CHANGED

Definition at line 124 of file UefiBaseType.h.

◆ EFI_NETWORK_UNREACHABLE

#define EFI_NETWORK_UNREACHABLE   EFIERR(100)

ICMP error definitions

Definition at line 163 of file UefiBaseType.h.

◆ EFI_NO_MAPPING

#define EFI_NO_MAPPING   RETURN_NO_MAPPING

Definition at line 128 of file UefiBaseType.h.

◆ EFI_NO_MEDIA

#define EFI_NO_MEDIA   RETURN_NO_MEDIA

Definition at line 123 of file UefiBaseType.h.

◆ EFI_NO_RESPONSE

#define EFI_NO_RESPONSE   RETURN_NO_RESPONSE

Definition at line 127 of file UefiBaseType.h.

◆ EFI_NOT_FOUND

#define EFI_NOT_FOUND   RETURN_NOT_FOUND

Definition at line 125 of file UefiBaseType.h.

◆ EFI_NOT_READY

#define EFI_NOT_READY   RETURN_NOT_READY

Definition at line 117 of file UefiBaseType.h.

◆ EFI_NOT_STARTED

#define EFI_NOT_STARTED   RETURN_NOT_STARTED

Definition at line 130 of file UefiBaseType.h.

◆ EFI_OUT_OF_RESOURCES

#define EFI_OUT_OF_RESOURCES   RETURN_OUT_OF_RESOURCES

Definition at line 120 of file UefiBaseType.h.

◆ EFI_PAGE_MASK

#define EFI_PAGE_MASK   0xFFF

Definition at line 183 of file UefiBaseType.h.

◆ EFI_PAGE_SHIFT

#define EFI_PAGE_SHIFT   12

Definition at line 184 of file UefiBaseType.h.

◆ EFI_PAGE_SIZE

#define EFI_PAGE_SIZE   SIZE_4KB

Definition at line 182 of file UefiBaseType.h.

◆ EFI_PAGES_TO_SIZE

#define EFI_PAGES_TO_SIZE (   Pages)    ((Pages) << EFI_PAGE_SHIFT)

Macro that converts a number of EFI_PAGEs to a size in bytes.

Parameters
PagesThe number of EFI_PAGES. This parameter is assumed to be type UINTN. Passing in a parameter that is larger than UINTN may produce unexpected results.
Returns
The number of bytes associated with the number of EFI_PAGEs specified by Pages.

Definition at line 210 of file UefiBaseType.h.

◆ EFI_PORT_UNREACHABLE

#define EFI_PORT_UNREACHABLE   EFIERR(103)

Definition at line 166 of file UefiBaseType.h.

◆ EFI_PROTOCOL_ERROR

#define EFI_PROTOCOL_ERROR   RETURN_PROTOCOL_ERROR

Definition at line 135 of file UefiBaseType.h.

◆ EFI_PROTOCOL_UNREACHABLE

#define EFI_PROTOCOL_UNREACHABLE   EFIERR(102)

Definition at line 165 of file UefiBaseType.h.

◆ EFI_SECURITY_VIOLATION

#define EFI_SECURITY_VIOLATION   RETURN_SECURITY_VIOLATION

Definition at line 137 of file UefiBaseType.h.

◆ EFI_SIZE_TO_PAGES

#define EFI_SIZE_TO_PAGES (   Size)    (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))

Macro that converts a size, in bytes, to a number of EFI_PAGESs.

Parameters
SizeA size in bytes. This parameter is assumed to be type UINTN. Passing in a parameter that is larger than UINTN may produce unexpected results.
Returns
The number of EFI_PAGESs associated with the number of bytes specified by Size.

Definition at line 197 of file UefiBaseType.h.

◆ EFI_SUCCESS

#define EFI_SUCCESS   RETURN_SUCCESS

Enumeration of EFI_STATUS.

Definition at line 111 of file UefiBaseType.h.

◆ EFI_TFTP_ERROR

#define EFI_TFTP_ERROR   RETURN_TFTP_ERROR

Definition at line 134 of file UefiBaseType.h.

◆ EFI_TIMEOUT

#define EFI_TIMEOUT   RETURN_TIMEOUT

Definition at line 129 of file UefiBaseType.h.

◆ EFI_UNSUPPORTED

#define EFI_UNSUPPORTED   RETURN_UNSUPPORTED

Definition at line 114 of file UefiBaseType.h.

◆ EFI_VOLUME_CORRUPTED

#define EFI_VOLUME_CORRUPTED   RETURN_VOLUME_CORRUPTED

Definition at line 121 of file UefiBaseType.h.

◆ EFI_VOLUME_FULL

#define EFI_VOLUME_FULL   RETURN_VOLUME_FULL

Definition at line 122 of file UefiBaseType.h.

◆ EFI_WARN_BUFFER_TOO_SMALL

#define EFI_WARN_BUFFER_TOO_SMALL   RETURN_WARN_BUFFER_TOO_SMALL

Definition at line 148 of file UefiBaseType.h.

◆ EFI_WARN_DELETE_FAILURE

#define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE

Definition at line 146 of file UefiBaseType.h.

◆ EFI_WARN_FILE_SYSTEM

#define EFI_WARN_FILE_SYSTEM   RETURN_WARN_FILE_SYSTEM

Definition at line 150 of file UefiBaseType.h.

◆ EFI_WARN_STALE_DATA

#define EFI_WARN_STALE_DATA   RETURN_WARN_STALE_DATA

Definition at line 149 of file UefiBaseType.h.

◆ EFI_WARN_UNKNOWN_GLYPH

#define EFI_WARN_UNKNOWN_GLYPH   RETURN_WARN_UNKNOWN_GLYPH

Definition at line 145 of file UefiBaseType.h.

◆ EFI_WARN_WRITE_FAILURE

#define EFI_WARN_WRITE_FAILURE   RETURN_WARN_WRITE_FAILURE

Definition at line 147 of file UefiBaseType.h.

◆ EFI_WRITE_PROTECTED

#define EFI_WRITE_PROTECTED   RETURN_WRITE_PROTECTED

Definition at line 119 of file UefiBaseType.h.

◆ EFIERR

#define EFIERR (   _a)    ENCODE_ERROR(_a)

Define macro to encode the status code.

Definition at line 156 of file UefiBaseType.h.

Typedef Documentation

◆ EFI_EVENT

typedef VOID* EFI_EVENT

Handle to an event structure.

Definition at line 36 of file UefiBaseType.h.

◆ EFI_GUID

typedef GUID EFI_GUID

128-bit buffer containing a unique identifier value.

Definition at line 24 of file UefiBaseType.h.

◆ EFI_HANDLE

typedef VOID* EFI_HANDLE

A collection of related interfaces.

Definition at line 32 of file UefiBaseType.h.

◆ EFI_IPv4_ADDRESS

4-byte buffer. An IPv4 internet protocol address.

Definition at line 84 of file UefiBaseType.h.

◆ EFI_IPv6_ADDRESS

16-byte buffer. An IPv6 internet protocol address.

Definition at line 89 of file UefiBaseType.h.

◆ EFI_LBA

typedef UINT64 EFI_LBA

Logical block address.

Definition at line 44 of file UefiBaseType.h.

◆ EFI_PHYSICAL_ADDRESS

64-bit physical memory address.

Definition at line 49 of file UefiBaseType.h.

◆ EFI_STATUS

typedef RETURN_STATUS EFI_STATUS

Function return status for EFI API.

Definition at line 28 of file UefiBaseType.h.

◆ EFI_TPL

typedef UINTN EFI_TPL

Task priority level.

Definition at line 40 of file UefiBaseType.h.

◆ EFI_VIRTUAL_ADDRESS

64-bit virtual memory address.

Definition at line 54 of file UefiBaseType.h.