sync comments on data structure to follow latest UEFI spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9309 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -125,7 +125,7 @@ typedef struct {
|
||||
///
|
||||
UINT64 Attributes;
|
||||
///
|
||||
/// Unicode string.
|
||||
/// Null-terminated name of the partition.
|
||||
///
|
||||
CHAR16 PartitionName[36];
|
||||
} EFI_PARTITION_ENTRY;
|
||||
|
@@ -83,28 +83,69 @@ typedef struct {
|
||||
|
||||
//
|
||||
// Definitions for Simplified Font Package
|
||||
// Section 27.3.2
|
||||
//
|
||||
|
||||
//
|
||||
// Contents of EFI_NARROW_GLYPH.Attributes
|
||||
//
|
||||
///
|
||||
/// Contents of EFI_NARROW_GLYPH.Attributes
|
||||
///@{
|
||||
#define EFI_GLYPH_NON_SPACING 0x01
|
||||
#define EFI_GLYPH_WIDE 0x02
|
||||
#define EFI_GLYPH_HEIGHT 19
|
||||
#define EFI_GLYPH_WIDTH 8
|
||||
///@}
|
||||
|
||||
///
|
||||
/// The EFI_NARROW_GLYPH has a preferred dimension (w x h) of 8 x 19 pixels.
|
||||
///
|
||||
typedef struct {
|
||||
///
|
||||
/// The Unicode representation of the glyph. The term weight is the
|
||||
/// technical term for a character code.
|
||||
///
|
||||
CHAR16 UnicodeWeight;
|
||||
///
|
||||
/// The data element containing the glyph definitions.
|
||||
///
|
||||
UINT8 Attributes;
|
||||
///
|
||||
/// The column major glyph representation of the character. Bits
|
||||
/// with values of one indicate that the corresponding pixel is to be
|
||||
/// on when normally displayed; those with zero are off.
|
||||
///
|
||||
UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];
|
||||
} EFI_NARROW_GLYPH;
|
||||
|
||||
///
|
||||
/// The EFI_WIDE_GLYPH has a preferred dimension (w x h) of 16 x 19 pixels, which is large enough
|
||||
/// to accommodate logographic characters.
|
||||
///
|
||||
typedef struct {
|
||||
///
|
||||
/// The Unicode representation of the glyph. The term weight is the
|
||||
/// technical term for a character code.
|
||||
///
|
||||
CHAR16 UnicodeWeight;
|
||||
///
|
||||
/// The data element containing the glyph definitions.
|
||||
///
|
||||
UINT8 Attributes;
|
||||
///
|
||||
/// The column major glyph representation of the character. Bits
|
||||
/// with values of one indicate that the corresponding pixel is to be
|
||||
/// on when normally displayed; those with zero are off.
|
||||
///
|
||||
UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];
|
||||
///
|
||||
/// The column major glyph representation of the character. Bits
|
||||
/// with values of one indicate that the corresponding pixel is to be
|
||||
/// on when normally displayed; those with zero are off.
|
||||
///
|
||||
UINT8 GlyphCol2[EFI_GLYPH_HEIGHT];
|
||||
///
|
||||
/// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the
|
||||
/// sizeof (EFI_NARROW_GLYPH). The contents of Pad must
|
||||
/// be zero.
|
||||
///
|
||||
UINT8 Pad[3];
|
||||
} EFI_WIDE_GLYPH;
|
||||
|
||||
@@ -1230,25 +1271,28 @@ typedef struct _EFI_IFR_TO_BOOLEAN {
|
||||
EFI_IFR_OP_HEADER Header;
|
||||
} EFI_IFR_TO_BOOLEAN;
|
||||
|
||||
//
|
||||
// For EFI_IFR_TO_STRING, when converting from
|
||||
// unsigned integers, these flags control the format:
|
||||
// 0 = unsigned decimal
|
||||
// 1 = signed decimal
|
||||
// 2 = hexadecimal (lower-case alpha)
|
||||
// 3 = hexadecimal (upper-case alpha)
|
||||
//
|
||||
///
|
||||
/// For EFI_IFR_TO_STRING, when converting from
|
||||
/// unsigned integers, these flags control the format:
|
||||
/// 0 = unsigned decimal
|
||||
/// 1 = signed decimal
|
||||
/// 2 = hexadecimal (lower-case alpha)
|
||||
/// 3 = hexadecimal (upper-case alpha)
|
||||
///@{
|
||||
#define EFI_IFR_STRING_UNSIGNED_DEC 0
|
||||
#define EFI_IFR_STRING_SIGNED_DEC 1
|
||||
#define EFI_IFR_STRING_LOWERCASE_HEX 2
|
||||
#define EFI_IFR_STRING_UPPERCASE_HEX 3
|
||||
//
|
||||
// When converting from a buffer, these flags control the format:
|
||||
// 0 = ASCII
|
||||
// 8 = Unicode
|
||||
//
|
||||
///@}
|
||||
|
||||
///
|
||||
/// When converting from a buffer, these flags control the format:
|
||||
/// 0 = ASCII
|
||||
/// 8 = Unicode
|
||||
///@{
|
||||
#define EFI_IFR_STRING_ASCII 0
|
||||
#define EFI_IFR_STRING_UNICODE 8
|
||||
///@}
|
||||
|
||||
typedef struct _EFI_IFR_TO_STRING {
|
||||
EFI_IFR_OP_HEADER Header;
|
||||
@@ -1596,11 +1640,31 @@ typedef enum {
|
||||
} EFI_KEY;
|
||||
|
||||
typedef struct {
|
||||
///
|
||||
/// Used to describe a physical key on a keyboard.
|
||||
///
|
||||
EFI_KEY Key;
|
||||
///
|
||||
/// Unicode character code for the Key.
|
||||
///
|
||||
CHAR16 Unicode;
|
||||
///
|
||||
/// Unicode character code for the key with the shift key being held down.
|
||||
///
|
||||
CHAR16 ShiftedUnicode;
|
||||
///
|
||||
/// Unicode character code for the key with the Alt-GR being held down.
|
||||
///
|
||||
CHAR16 AltGrUnicode;
|
||||
///
|
||||
/// Unicode character code for the key with the Alt-GR and shift keys being held down.
|
||||
///
|
||||
CHAR16 ShiftedAltGrUnicode;
|
||||
///
|
||||
/// Modifier keys are defined to allow for special functionality that is not necessarily
|
||||
/// accomplished by a printable character. Many of these modifier keys are flags to toggle
|
||||
/// certain state bits on and off inside of a keyboard driver.
|
||||
///
|
||||
UINT16 Modifier;
|
||||
UINT16 AffectedAttribute;
|
||||
} EFI_KEY_DESCRIPTOR;
|
||||
|
@@ -592,8 +592,8 @@ VOID
|
||||
/**
|
||||
Returns the value of a variable.
|
||||
|
||||
@param VariableName A Null-terminated Unicode string that is the name of the
|
||||
vendor's variable.
|
||||
@param VariableName A Null-terminated string that is the name of the vendor's
|
||||
variable.
|
||||
@param VendorGuid A unique identifier for the vendor.
|
||||
@param Attributes If not NULL, a pointer to the memory location to return the
|
||||
attributes bitmask for the variable.
|
||||
@@ -628,7 +628,7 @@ EFI_STATUS
|
||||
@param VariableNameSize The size of the VariableName buffer.
|
||||
@param VariableName On input, supplies the last VariableName that was returned
|
||||
by GetNextVariableName(). On output, returns the Nullterminated
|
||||
Unicode string of the current variable.
|
||||
string of the current variable.
|
||||
@param VendorGuid On input, supplies the last VendorGuid that was returned by
|
||||
GetNextVariableName(). On output, returns the
|
||||
VendorGuid of the current variable.
|
||||
@@ -841,7 +841,7 @@ EFI_STATUS
|
||||
@param ImageHandle Handle of image to be started.
|
||||
@param ExitDataSize Pointer to the size, in bytes, of ExitData.
|
||||
@param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
|
||||
Unicode string, optionally followed by additional binary data.
|
||||
string, optionally followed by additional binary data.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
|
||||
has already been initialized with StartImage
|
||||
@@ -859,11 +859,16 @@ EFI_STATUS
|
||||
/**
|
||||
Terminates a loaded EFI image and returns control to boot services.
|
||||
|
||||
@param ImageHandle Handle that identifies the image.
|
||||
@param ImageHandle Handle that identifies the image. This parameter is passed to the
|
||||
image on entry.
|
||||
@param ExitStatus The image's exit code.
|
||||
@param ExitDataSize The size, in bytes, of ExitData.
|
||||
@param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
|
||||
optionally followed by additional binary data.
|
||||
@param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
|
||||
@param ExitData Pointer to a data buffer that includes a Null-terminated string,
|
||||
optionally followed by additional binary data. The string is a
|
||||
description that the caller may use to further indicate the reason
|
||||
for the image's exit. ExitData is only valid if ExitStatus
|
||||
is something other than EFI_SUCCESS. The ExitData buffer
|
||||
must be allocated by calling AllocatePool().
|
||||
|
||||
@retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
|
||||
@retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
|
||||
@@ -933,7 +938,7 @@ EFI_STATUS
|
||||
@param Timeout The number of seconds to set the watchdog timer to.
|
||||
@param WatchdogCode The numeric code to log on a watchdog timer timeout event.
|
||||
@param DataSize The size, in bytes, of WatchdogData.
|
||||
@param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
|
||||
@param WatchdogData A data buffer that includes a Null-terminated string, optionally
|
||||
followed by additional binary data.
|
||||
|
||||
@retval EFI_SUCCESS The timeout has been set.
|
||||
@@ -985,7 +990,7 @@ typedef enum {
|
||||
@param DataSize The size, in bytes, of WatchdogData.
|
||||
@param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
|
||||
EfiResetShutdown the data buffer starts with a Null-terminated
|
||||
Unicode string, optionally followed by additional binary data.
|
||||
string, optionally followed by additional binary data.
|
||||
|
||||
**/
|
||||
typedef
|
||||
@@ -1900,8 +1905,8 @@ typedef struct {
|
||||
///
|
||||
EFI_TABLE_HEADER Hdr;
|
||||
///
|
||||
/// A pointer to a null terminated Unicode string that identifies
|
||||
/// the vendor that produces the system firmware for the platform.
|
||||
/// A pointer to a null terminated string that identifies the vendor
|
||||
/// that produces the system firmware for the platform.
|
||||
///
|
||||
CHAR16 *FirmwareVendor;
|
||||
///
|
||||
|
Reference in New Issue
Block a user