#include <Base.h>

Include dependency graph for UefiBaseType.h:

This graph shows which files directly or indirectly include this file:

Classes
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_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 VOID *	EFI_HANDLE

typedef VOID *	EFI_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.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Macro Definition Documentation

◆ EFI_ABORTED

#define EFI_ABORTED RETURN_ABORTED

◆ EFI_ACCESS_DENIED

#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED

◆ EFI_ALREADY_STARTED

#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED

◆ EFI_BAD_BUFFER_SIZE

#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE

◆ EFI_BUFFER_TOO_SMALL

#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL

◆ EFI_COMPROMISED_DATA

#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA

◆ EFI_CONNECTION_FIN

#define EFI_CONNECTION_FIN EFIERR(104)

Tcp connection status definitions

◆ EFI_CONNECTION_REFUSED

#define EFI_CONNECTION_REFUSED EFIERR(106)

◆ EFI_CONNECTION_RESET

#define EFI_CONNECTION_RESET EFIERR(105)

◆ EFI_CRC_ERROR

#define EFI_CRC_ERROR RETURN_CRC_ERROR

◆ EFI_DEVICE_ERROR

#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR

◆ EFI_END_OF_FILE

#define EFI_END_OF_FILE RETURN_END_OF_FILE

◆ EFI_END_OF_MEDIA

#define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA

◆ EFI_ERROR

#define EFI_ERROR ( A ) RETURN_ERROR(A)

◆ EFI_HOST_UNREACHABLE

#define EFI_HOST_UNREACHABLE EFIERR(101)

◆ EFI_HTTP_ERROR

#define EFI_HTTP_ERROR RETURN_HTTP_ERROR

◆ EFI_ICMP_ERROR

#define EFI_ICMP_ERROR RETURN_ICMP_ERROR

◆ EFI_IMAGE_MACHINE_AARCH64

#define EFI_IMAGE_MACHINE_AARCH64 0xAA64

PE32+ Machine type for AARCH64 A64 images.

◆ EFI_IMAGE_MACHINE_ARMTHUMB_MIXED

#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2

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

◆ EFI_IMAGE_MACHINE_EBC

#define EFI_IMAGE_MACHINE_EBC 0x0EBC

PE32+ Machine type for EBC UEFI images.

◆ EFI_IMAGE_MACHINE_IA32

#define EFI_IMAGE_MACHINE_IA32 0x014C

PE32+ Machine type for IA32 UEFI images.

◆ EFI_IMAGE_MACHINE_IA64

#define EFI_IMAGE_MACHINE_IA64 0x0200

PE32+ Machine type for IA64 UEFI images.

◆ EFI_IMAGE_MACHINE_X64

#define EFI_IMAGE_MACHINE_X64 0x8664

PE32+ Machine type for X64 UEFI images.

◆ EFI_INCOMPATIBLE_VERSION

#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION

◆ EFI_INVALID_LANGUAGE

#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE

◆ EFI_INVALID_PARAMETER

#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER

◆ EFI_LOAD_ERROR

#define EFI_LOAD_ERROR RETURN_LOAD_ERROR

◆ EFI_MEDIA_CHANGED

#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED

◆ EFI_NETWORK_UNREACHABLE

#define EFI_NETWORK_UNREACHABLE EFIERR(100)

ICMP error definitions

◆ EFI_NO_MAPPING

#define EFI_NO_MAPPING RETURN_NO_MAPPING

◆ EFI_NO_MEDIA

#define EFI_NO_MEDIA RETURN_NO_MEDIA

◆ EFI_NO_RESPONSE

#define EFI_NO_RESPONSE RETURN_NO_RESPONSE

◆ EFI_NOT_FOUND

#define EFI_NOT_FOUND RETURN_NOT_FOUND

◆ EFI_NOT_READY

#define EFI_NOT_READY RETURN_NOT_READY

◆ EFI_NOT_STARTED

#define EFI_NOT_STARTED RETURN_NOT_STARTED

◆ EFI_OUT_OF_RESOURCES

#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES

◆ EFI_PAGE_MASK

#define EFI_PAGE_MASK 0xFFF

◆ EFI_PAGE_SHIFT

#define EFI_PAGE_SHIFT 12

◆ EFI_PAGE_SIZE

#define EFI_PAGE_SIZE SIZE_4KB

◆ 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

Pages The 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.

◆ EFI_PORT_UNREACHABLE

#define EFI_PORT_UNREACHABLE EFIERR(103)

◆ EFI_PROTOCOL_ERROR

#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR

◆ EFI_PROTOCOL_UNREACHABLE

#define EFI_PROTOCOL_UNREACHABLE EFIERR(102)

◆ EFI_SECURITY_VIOLATION

#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION

◆ 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

Size	A 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.

◆ EFI_SUCCESS

#define EFI_SUCCESS RETURN_SUCCESS

Enumeration of EFI_STATUS.

◆ EFI_TFTP_ERROR

#define EFI_TFTP_ERROR RETURN_TFTP_ERROR

◆ EFI_TIMEOUT

#define EFI_TIMEOUT RETURN_TIMEOUT

◆ EFI_UNSUPPORTED

#define EFI_UNSUPPORTED RETURN_UNSUPPORTED

◆ EFI_VOLUME_CORRUPTED

#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED

◆ EFI_VOLUME_FULL

#define EFI_VOLUME_FULL RETURN_VOLUME_FULL

◆ EFI_WARN_BUFFER_TOO_SMALL

#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL

◆ EFI_WARN_DELETE_FAILURE

#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE

◆ EFI_WARN_FILE_SYSTEM

#define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM

◆ EFI_WARN_STALE_DATA

#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA

◆ EFI_WARN_UNKNOWN_GLYPH

#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH

◆ EFI_WARN_WRITE_FAILURE

#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE

◆ EFI_WRITE_PROTECTED

#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED

◆ EFIERR

#define EFIERR ( _a ) ENCODE_ERROR(_a)

Define macro to encode the status code.

Typedef Documentation

◆ EFI_EVENT

typedef VOID* EFI_EVENT

Handle to an event structure.

◆ EFI_GUID

typedef GUID EFI_GUID

128-bit buffer containing a unique identifier value.

◆ EFI_HANDLE

typedef VOID* EFI_HANDLE

A collection of related interfaces.

◆ EFI_IPv4_ADDRESS

typedef IPv4_ADDRESS EFI_IPv4_ADDRESS

4-byte buffer. An IPv4 internet protocol address.

◆ EFI_IPv6_ADDRESS

typedef IPv6_ADDRESS EFI_IPv6_ADDRESS

16-byte buffer. An IPv6 internet protocol address.

◆ EFI_LBA

typedef UINT64 EFI_LBA

Logical block address.

◆ EFI_PHYSICAL_ADDRESS

typedef UINT64 EFI_PHYSICAL_ADDRESS

64-bit physical memory address.

◆ EFI_STATUS

typedef RETURN_STATUS EFI_STATUS

Function return status for EFI API.

◆ EFI_TPL

typedef UINTN EFI_TPL

Task priority level.

◆ EFI_VIRTUAL_ADDRESS

typedef UINT64 EFI_VIRTUAL_ADDRESS

64-bit virtual memory address.

Classes

Macros

Typedefs