UefiBaseType.h File Reference

Defines data types and constants introduced in UEFI. More...

#include <gpxe/efi/Base.h>

Go to the source code of this file.

Data Structures

struct  EFI_TIME
 EFI Time Abstraction: Year: 1998 - 20XX Month: 1 - 12 Day: 1 - 31 Hour: 0 - 23 Minute: 0 - 59 Second: 0 - 59 Nanosecond: 0 - 999,999,999 TimeZone: -1440 to 1440 or 2047. More...
struct  EFI_IPv4_ADDRESS
 4-byte buffer. More...
struct  EFI_IPv6_ADDRESS
 16-byte buffer. More...
struct  EFI_MAC_ADDRESS
 32-byte buffer containing a network Media Access Control address. More...
union  EFI_IP_ADDRESS
 16-byte buffer aligned on a 4-byte boundary. More...

Defines

#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_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 EFIERR(_a)   ENCODE_ERROR(_a)
#define EFI_ERROR(A)   RETURN_ERROR(A)
#define EFI_SIGNATURE_16(A, B)   SIGNATURE_16 (A, B)
#define EFI_SIGNATURE_32(A, B, C, D)   SIGNATURE_32 (A, B, C, D)
#define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H)   SIGNATURE_64 (A, B, C, D, E, F, G, H)
#define EFI_FIELD_OFFSET(TYPE, Field)   ((UINTN)(&(((TYPE *) 0)->Field)))
 Returns the byte offset to a field within a structure.
#define EFI_PAGE_SIZE   0x1000
#define EFI_PAGE_MASK   0xFFF
#define EFI_PAGE_SHIFT   12
#define EFI_SIZE_TO_PAGES(a)   (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))
#define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)
#define EFI_MAX_BIT   MAX_BIT
#define EFI_MAX_ADDRESS   MAX_ADDRESS
#define RFC_3066_ENTRY_SIZE   (42 + 1)
 Limited buffer size for a language code recommended by RFC3066 (42 characters plus a NULL terminator).
#define ISO_639_2_ENTRY_SIZE   3
 The size of a 3 character ISO639 language code.

Typedefs

typedef GUID EFI_GUID
 128-bit buffer containing a unique identifier value.
typedef RETURN_STATUS EFI_STATUS
 Function return status for EFI API.
typedef VOID * EFI_HANDLE
 A collection of related interfaces.
typedef VOID * EFI_EVENT
 Handle to an event structure.
typedef UINTN EFI_TPL
 Task priority level.
typedef UINT64 EFI_LBA
 Logical block address.
typedef UINT64 EFI_PHYSICAL_ADDRESS
typedef UINT64 EFI_VIRTUAL_ADDRESS


Detailed Description

Defines data types and constants introduced in UEFI.

Copyright (c) 2006 - 2008, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which 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.

Definition in file UefiBaseType.h.


Define Documentation

#define EFI_SUCCESS   RETURN_SUCCESS

Definition at line 112 of file UefiBaseType.h.

#define EFI_LOAD_ERROR   RETURN_LOAD_ERROR

Definition at line 113 of file UefiBaseType.h.

#define EFI_INVALID_PARAMETER   RETURN_INVALID_PARAMETER

Definition at line 114 of file UefiBaseType.h.

Referenced by efi_snp_driver_start(), and efi_snp_transmit().

#define EFI_UNSUPPORTED   RETURN_UNSUPPORTED

#define EFI_BAD_BUFFER_SIZE   RETURN_BAD_BUFFER_SIZE

Definition at line 116 of file UefiBaseType.h.

#define EFI_BUFFER_TOO_SMALL   RETURN_BUFFER_TOO_SMALL

Definition at line 117 of file UefiBaseType.h.

Referenced by efi_snp_transmit().

#define EFI_NOT_READY   RETURN_NOT_READY

Definition at line 118 of file UefiBaseType.h.

Referenced by efi_snp_receive().

#define EFI_DEVICE_ERROR   RETURN_DEVICE_ERROR

Definition at line 119 of file UefiBaseType.h.

Referenced by efi_snp_driver_stop(), and efi_snp_transmit().

#define EFI_WRITE_PROTECTED   RETURN_WRITE_PROTECTED

Definition at line 120 of file UefiBaseType.h.

#define EFI_OUT_OF_RESOURCES   RETURN_OUT_OF_RESOURCES

Definition at line 121 of file UefiBaseType.h.

Referenced by efi_snp_driver_start().

#define EFI_VOLUME_CORRUPTED   RETURN_VOLUME_CORRUPTED

Definition at line 122 of file UefiBaseType.h.

#define EFI_VOLUME_FULL   RETURN_VOLUME_FULL

Definition at line 123 of file UefiBaseType.h.

#define EFI_NO_MEDIA   RETURN_NO_MEDIA

Definition at line 124 of file UefiBaseType.h.

#define EFI_MEDIA_CHANGED   RETURN_MEDIA_CHANGED

Definition at line 125 of file UefiBaseType.h.

#define EFI_NOT_FOUND   RETURN_NOT_FOUND

Definition at line 126 of file UefiBaseType.h.

#define EFI_ACCESS_DENIED   RETURN_ACCESS_DENIED

Definition at line 127 of file UefiBaseType.h.

#define EFI_NO_RESPONSE   RETURN_NO_RESPONSE

Definition at line 128 of file UefiBaseType.h.

#define EFI_NO_MAPPING   RETURN_NO_MAPPING

Definition at line 129 of file UefiBaseType.h.

#define EFI_TIMEOUT   RETURN_TIMEOUT

Definition at line 130 of file UefiBaseType.h.

#define EFI_NOT_STARTED   RETURN_NOT_STARTED

Definition at line 131 of file UefiBaseType.h.

#define EFI_ALREADY_STARTED   RETURN_ALREADY_STARTED

Definition at line 132 of file UefiBaseType.h.

#define EFI_ABORTED   RETURN_ABORTED

Definition at line 133 of file UefiBaseType.h.

#define EFI_ICMP_ERROR   RETURN_ICMP_ERROR

Definition at line 134 of file UefiBaseType.h.

#define EFI_TFTP_ERROR   RETURN_TFTP_ERROR

Definition at line 135 of file UefiBaseType.h.

#define EFI_PROTOCOL_ERROR   RETURN_PROTOCOL_ERROR

Definition at line 136 of file UefiBaseType.h.

#define EFI_INCOMPATIBLE_VERSION   RETURN_INCOMPATIBLE_VERSION

Definition at line 137 of file UefiBaseType.h.

#define EFI_SECURITY_VIOLATION   RETURN_SECURITY_VIOLATION

Definition at line 138 of file UefiBaseType.h.

#define EFI_CRC_ERROR   RETURN_CRC_ERROR

Definition at line 139 of file UefiBaseType.h.

#define EFI_END_OF_MEDIA   RETURN_END_OF_MEDIA

Definition at line 140 of file UefiBaseType.h.

#define EFI_END_OF_FILE   RETURN_END_OF_FILE

Definition at line 141 of file UefiBaseType.h.

#define EFI_INVALID_LANGUAGE   RETURN_INVALID_LANGUAGE

Definition at line 142 of file UefiBaseType.h.

#define EFI_WARN_UNKNOWN_GLYPH   RETURN_WARN_UNKNOWN_GLYPH

Definition at line 144 of file UefiBaseType.h.

#define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE

Definition at line 145 of file UefiBaseType.h.

#define EFI_WARN_WRITE_FAILURE   RETURN_WARN_WRITE_FAILURE

Definition at line 146 of file UefiBaseType.h.

#define EFI_WARN_BUFFER_TOO_SMALL   RETURN_WARN_BUFFER_TOO_SMALL

Definition at line 147 of file UefiBaseType.h.

#define EFIERR ( _a   )     ENCODE_ERROR(_a)

Definition at line 153 of file UefiBaseType.h.

#define EFI_ERROR (  )     RETURN_ERROR(A)

Definition at line 155 of file UefiBaseType.h.

#define EFI_SIGNATURE_16 ( A,
 )     SIGNATURE_16 (A, B)

Definition at line 160 of file UefiBaseType.h.

#define EFI_SIGNATURE_32 ( A,
B,
C,
 )     SIGNATURE_32 (A, B, C, D)

Definition at line 161 of file UefiBaseType.h.

#define EFI_SIGNATURE_64 ( A,
B,
C,
D,
E,
F,
G,
 )     SIGNATURE_64 (A, B, C, D, E, F, G, H)

Definition at line 162 of file UefiBaseType.h.

#define EFI_FIELD_OFFSET ( TYPE,
Field   )     ((UINTN)(&(((TYPE *) 0)->Field)))

Returns the byte offset to a field within a structure.

Definition at line 168 of file UefiBaseType.h.

#define EFI_PAGE_SIZE   0x1000

Definition at line 175 of file UefiBaseType.h.

Referenced by efi_urealloc().

#define EFI_PAGE_MASK   0xFFF

Definition at line 176 of file UefiBaseType.h.

#define EFI_PAGE_SHIFT   12

Definition at line 177 of file UefiBaseType.h.

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

Definition at line 179 of file UefiBaseType.h.

Referenced by efi_urealloc().

#define EFI_PAGES_TO_SIZE (  )     ( (a) << EFI_PAGE_SHIFT)

Definition at line 181 of file UefiBaseType.h.

#define EFI_MAX_BIT   MAX_BIT

Definition at line 184 of file UefiBaseType.h.

#define EFI_MAX_ADDRESS   MAX_ADDRESS

Definition at line 185 of file UefiBaseType.h.

#define RFC_3066_ENTRY_SIZE   (42 + 1)

Limited buffer size for a language code recommended by RFC3066 (42 characters plus a NULL terminator).

Definition at line 192 of file UefiBaseType.h.

#define ISO_639_2_ENTRY_SIZE   3

The size of a 3 character ISO639 language code.

Definition at line 197 of file UefiBaseType.h.


Typedef Documentation

typedef GUID EFI_GUID

128-bit buffer containing a unique identifier value.

Definition at line 27 of file UefiBaseType.h.

Function return status for EFI API.

Definition at line 31 of file UefiBaseType.h.

typedef VOID* EFI_HANDLE

A collection of related interfaces.

Definition at line 35 of file UefiBaseType.h.

typedef VOID* EFI_EVENT

Handle to an event structure.

Definition at line 39 of file UefiBaseType.h.

typedef UINTN EFI_TPL

Task priority level.

Definition at line 43 of file UefiBaseType.h.

typedef UINT64 EFI_LBA

Logical block address.

Definition at line 47 of file UefiBaseType.h.

Definition at line 48 of file UefiBaseType.h.

Definition at line 49 of file UefiBaseType.h.


Generated on Tue Apr 6 20:01:49 2010 for gPXE by  doxygen 1.5.7.1