From fbf926add92ee7c528aed264b0b71442b2caef04 Mon Sep 17 00:00:00 2001 From: eric_tian Date: Thu, 24 Sep 2009 08:56:33 +0000 Subject: [PATCH] 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 --- MdePkg/Include/Base.h | 2 +- MdePkg/Include/Guid/FileInfo.h | 4 +- MdePkg/Include/Guid/FileSystemInfo.h | 2 +- MdePkg/Include/Protocol/Bis.h | 2 +- MdePkg/Include/Protocol/ComponentName2.h | 23 +++-- MdePkg/Include/Protocol/DevicePath.h | 2 +- MdePkg/Include/Protocol/DriverDiagnostics.h | 2 +- MdePkg/Include/Protocol/HiiConfigRouting.h | 32 +++--- MdePkg/Include/Protocol/HiiFont.h | 6 +- MdePkg/Include/Protocol/SimpleTextOut.h | 14 +-- MdePkg/Include/Protocol/UnicodeCollation.h | 64 ++++++------ MdePkg/Include/Protocol/UsbIo.h | 2 +- MdePkg/Include/Uefi/UefiGpt.h | 2 +- .../Uefi/UefiInternalFormRepresentation.h | 98 +++++++++++++++---- MdePkg/Include/Uefi/UefiSpec.h | 29 +++--- 15 files changed, 175 insertions(+), 109 deletions(-) diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h index 2e2a771982..77ca849d27 100644 --- a/MdePkg/Include/Base.h +++ b/MdePkg/Include/Base.h @@ -844,7 +844,7 @@ typedef INTN RETURN_STATUS; /// -/// The Unicode string contained one or more characters that +/// The string contained one or more characters that /// the device could not render and were skipped. /// #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1) diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h index ad56b6e734..20068f7e2e 100644 --- a/MdePkg/Include/Guid/FileInfo.h +++ b/MdePkg/Include/Guid/FileInfo.h @@ -24,7 +24,7 @@ typedef struct { /// - /// Size of the EFI_FILE_INFO structure, including the Nullterminated Unicode FileName string. + /// Size of the EFI_FILE_INFO structure, including the Null-terminated FileName string. /// UINT64 Size; /// @@ -52,7 +52,7 @@ typedef struct { /// UINT64 Attribute; /// - /// The Null-terminated Unicode name of the file. + /// The Null-terminated name of the file. /// CHAR16 FileName[1]; } EFI_FILE_INFO; diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h index 255e58061f..b3f8f0b576 100644 --- a/MdePkg/Include/Guid/FileSystemInfo.h +++ b/MdePkg/Include/Guid/FileSystemInfo.h @@ -24,7 +24,7 @@ typedef struct { /// - /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated Unicode VolumeLabel string. + /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string. /// UINT64 Size; /// diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index edb22f8546..a5f25eba9a 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -364,7 +364,7 @@ EFI_STATUS @param Credentials A Signed Manifest containing verification information for the indicated data object. @param DataObject An in-memory copy of the raw data object to be verified. - @param SectionName An ASCII (not Unicode) string giving the section name in the + @param SectionName An ASCII string giving the section name in the manifest holding the verification information (in other words, hash value) that corresponds to DataObject. @param AuthorityCertificate A digital certificate whose public key must match the signer's diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h index 08efec6b8d..1d8d438d18 100644 --- a/MdePkg/Include/Protocol/ComponentName2.h +++ b/MdePkg/Include/Protocol/ComponentName2.h @@ -27,7 +27,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; /** - Retrieves a Unicode string that is the user readable name of + Retrieves a string that is the user readable name of the EFI Driver. @param This A pointer to the @@ -43,12 +43,12 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; is specified in RFC 4646 language code format. - @param DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the + @param DriverName A pointer to the string to return. + This string is the name of the driver specified by This in the language specified by Language. - @retval EFI_SUCCESS The Unicode string for the + @retval EFI_SUCCESS The string for the Driver specified by This and the language specified by Language was returned in DriverName. @@ -72,7 +72,7 @@ EFI_STATUS /** - Retrieves a Unicode string that is the user readable name of + Retrieves a string that is the user readable name of the controller that is being managed by an EFI Driver. @param This A pointer to the @@ -83,7 +83,7 @@ EFI_STATUS This handle specifies the controller whose name is to be returned. - @param ChildHandle The handle of the child controller to + @param ChildHandle The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. @@ -106,15 +106,14 @@ EFI_STATUS specified in RFC 4646 language code format. - @param ControllerName A pointer to the Unicode string to - return. This Unicode string is the - name of the controller specified by - ControllerHandle and ChildHandle in - the language specified by Language + @param ControllerName A pointer to the string to return. + This string is the name of the controller + specified by ControllerHandle and ChildHandle + in the language specified by Language from the point of view of the driver specified by This. - @retval EFI_SUCCESS The Unicode string for the user + @retval EFI_SUCCESS The string for the user readable name in the language specified by Language for the driver specified by This was diff --git a/MdePkg/Include/Protocol/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h index 579ab89205..728c20b356 100644 --- a/MdePkg/Include/Protocol/DevicePath.h +++ b/MdePkg/Include/Protocol/DevicePath.h @@ -854,7 +854,7 @@ typedef struct { typedef struct { EFI_DEVICE_PATH_PROTOCOL Header; /// - /// A NULL-terminated Unicode Path string including directory and file names. + /// A NULL-terminated Path string including directory and file names. /// CHAR16 PathName[1]; } FILEPATH_DEVICE_PATH; diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h index ee874746a9..9ca9d36ff6 100644 --- a/MdePkg/Include/Protocol/DriverDiagnostics.h +++ b/MdePkg/Include/Protocol/DriverDiagnostics.h @@ -65,7 +65,7 @@ typedef enum { the driver writer. @param ErrorType A GUID that defines the format of the data returned in Buffer. @param BufferSize The size, in bytes, of the data returned in Buffer. - @param Buffer A buffer that contains a Null-terminated Unicode string + @param Buffer A buffer that contains a Null-terminated string plus some additional data whose format is defined by ErrorType. Buffer is allocated by this function with AllocatePool(), and it is the caller's responsibility diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h index 34beb2fbb2..09fb182442 100644 --- a/MdePkg/Include/Protocol/HiiConfigRouting.h +++ b/MdePkg/Include/Protocol/HiiConfigRouting.h @@ -45,7 +45,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; They must have an additional description indicating the type of alternative configuration the string represents, "ALTCFG=". That (when converted from - Hex UNICODE to binary) is a reference to a string in the + hexadecimal (encoded as text) to binary) is a reference to a string in the associated string pack. As an example, assume that the Request string is: GUID=...&NAME=00480050&PATH=...&Fred&George&Ron&Neville A result @@ -118,7 +118,10 @@ EFI_STATUS ); /** - + This function allows the caller to request the current configuration + for the entirety of the current HII database and returns the data in + a null-terminated string. + This function allows the caller to request the current configuration for all of the current HII database. The results include both the current and alternate configurations as @@ -126,11 +129,11 @@ EFI_STATUS @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - @param Results A null-terminated Unicode string in - format which has all - values filled in for the names in the Request - string. String to be allocated by this - function. De-allocation is up to the caller. + @param Results A null-terminated string in + format which has all values filled in for the + names in the Request string. + String to be allocated by this function. + De-allocation is up to the caller. @retval EFI_SUCCESS The Results string is filled with the values corresponding to all requested @@ -168,8 +171,7 @@ EFI_STATUS @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - @param Configuration A null-terminated Unicode string in - format. + @param Configuration A null-terminated string in format. @param Progress A pointer to a string filled in with the offset of the most recent '&' before the @@ -210,15 +212,14 @@ EFI_STATUS consists of a list of formatted names. It uses the offset in the name to determine the index into the Block to start the extraction and the width of each name to determine the - number of bytes to extract. These are mapped to a UNICODE value + number of bytes to extract. These are mapped to a string using the equivalent of the C "%x" format (with optional leading spaces). The call fails if, for any (offset, width) pair in ConfigRequest, offset+value >= BlockSize. @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - @param ConfigRequest A null-terminated Unicode string in - format. + @param ConfigRequest A null-terminated string in format. @param Block Array of bytes defining the block's configuration. @@ -293,8 +294,7 @@ EFI_STATUS @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - @param ConfigResp A null-terminated Unicode string in - format. + @param ConfigResp A null-terminated string in format. @param Block A possibly null array of bytes representing the current block. Only @@ -348,8 +348,8 @@ EFI_STATUS This helper function is to be called by drivers to extract portions of a larger configuration string. - @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - @param Configuration A null-terminated Unicode string in format. + @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. + @param Configuration A null-terminated string in format. @param Guid A pointer to the GUID value to search for in the routing portion of the ConfigResp string when retrieving the requested data. If Guid is NULL, then all GUID diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h index 607964c7e2..cc095f733e 100644 --- a/MdePkg/Include/Protocol/HiiFont.h +++ b/MdePkg/Include/Protocol/HiiFont.h @@ -144,7 +144,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { will use the pixel value from Blt. This flag cannot be used if Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs are not drawn. Otherwise, - they are replaced with Unicode character 0xFFFD (REPLACEMENT + they are replaced with Unicode character code 0xFFFD (REPLACEMENT CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit line break characters will be ignored. If EFI_HII_DIRECT_TO_SCREEN is set, then the string will be written @@ -263,7 +263,7 @@ EFI_STATUS use the pixel value from Blt. This flag cannot be used if Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set, then characters which have no glyphs are not drawn. Otherwise, they - are replaced with Unicode character 0xFFFD (REPLACEMENT + are replaced with Unicode character code 0xFFFD (REPLACEMENT CHARACTER). If EFI_HII_IGNORE_LINE_BREAK is set, then explicit line break characters will be ignored. If EFI_HII_DIRECT_TO_SCREEN is set, then the string will be @@ -391,7 +391,7 @@ EFI_STATUS @retval EFI_WARN_UNKNOWN_GLYPH The glyph was unknown and was replaced with the glyph for - Unicode character 0xFFFD. + Unicode character code 0xFFFD. @retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or Height is NULL diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h index b75e52a696..f3e88ee685 100644 --- a/MdePkg/Include/Protocol/SimpleTextOut.h +++ b/MdePkg/Include/Protocol/SimpleTextOut.h @@ -165,12 +165,12 @@ EFI_STATUS ); /** - Write a Unicode string to the output device. + Write a string to the output device. @param This Protocol instance pointer. - @param String The NULL-terminated Unicode string to be displayed on the output + @param String The NULL-terminated string to be displayed on the output device(s). All output devices must also support the Unicode - drawing defined in this file. + drawing character codes defined in this file. @retval EFI_SUCCESS The string was output to the device. @retval EFI_DEVICE_ERROR The device reported an error while attempting to output @@ -178,7 +178,7 @@ EFI_STATUS @retval EFI_UNSUPPORTED The output device's mode is not currently in a defined text mode. @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the - characters in the Unicode string could not be + characters in the string could not be rendered and were skipped. **/ @@ -190,15 +190,15 @@ EFI_STATUS ); /** - Verifies that all characters in a Unicode string can be output to the + Verifies that all characters in a string can be output to the target device. @param This Protocol instance pointer. - @param String The NULL-terminated Unicode string to be examined for the output + @param String The NULL-terminated string to be examined for the output device(s). @retval EFI_SUCCESS The device(s) are capable of rendering the output string. - @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be + @retval EFI_UNSUPPORTED Some of the characters in the string cannot be rendered by one or more of the output devices mapped by the EFI handle. diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h index 4efa515d08..759af87d51 100644 --- a/MdePkg/Include/Protocol/UnicodeCollation.h +++ b/MdePkg/Include/Protocol/UnicodeCollation.h @@ -49,16 +49,15 @@ typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE; // Protocol member functions // /** - Performs a case-insensitive comparison of two Null-terminated Unicode - strings. + Performs a case-insensitive comparison of two Null-terminated strings. - @param This Protocol instance pointer. - @param Str1 A pointer to a Null-terminated Unicode string. - @param Str2 A pointer to a Null-terminated Unicode string. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. + @param Str1 A pointer to a Null-terminated string. + @param Str2 A pointer to a Null-terminated string. @retval 0 Str1 is equivalent to Str2 - @retval >_0 Str1 is lexically greater than Str2 - @retval <_0 Str1 is lexically less than Str2 + @retval >0 Str1 is lexically greater than Str2 + @retval <0 Str1 is lexically less than Str2 **/ typedef @@ -70,12 +69,12 @@ INTN ); /** - Performs a case-insensitive comparison of a Null-terminated Unicode - pattern string and a Null-terminated Unicode string. + Performs a case-insensitive comparison of a Null-terminated + pattern string and a Null-terminated string. - @param This Protocol instance pointer. - @param String A pointer to a Null-terminated Unicode string. - @param Pattern A pointer to a Null-terminated Unicode pattern string. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. + @param String A pointer to a Null-terminated string. + @param Pattern A pointer to a Null-terminated pattern string. @retval TRUE Pattern was found in String. @retval FALSE Pattern was not found in String. @@ -90,11 +89,11 @@ BOOLEAN ); /** - Converts all the Unicode characters in a Null-terminated Unicode string to - lower case Unicode characters. + Converts all the characters in a Null-terminated string to + lower case characters. - @param This Protocol instance pointer. - @param String A pointer to a Null-terminated Unicode string. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. + @param String A pointer to a Null-terminated string. **/ typedef @@ -105,11 +104,11 @@ VOID ); /** - Converts all the Unicode characters in a Null-terminated Unicode string to upper - case Unicode characters. + Converts all the characters in a Null-terminated string to upper + case characters. - @param This Protocol instance pointer. - @param String A pointer to a Null-terminated Unicode string. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. + @param String A pointer to a Null-terminated string. **/ typedef @@ -121,14 +120,14 @@ VOID /** Converts an 8.3 FAT file name in an OEM character set to a Null-terminated - Unicode string. + string. - @param This Protocol instance pointer. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. @param FatSize The size of the string Fat in bytes. @param Fat A pointer to a Null-terminated string that contains an 8.3 file name using an OEM character set. - @param String A pointer to a Null-terminated Unicode string. The string must - be preallocated to hold FatSize Unicode characters. + @param String A pointer to a Null-terminated string. The string must + be allocated in advance to hold FatSize characters. **/ typedef @@ -141,18 +140,17 @@ VOID ); /** - Converts a Null-terminated Unicode string to legal characters in a FAT + Converts a Null-terminated string to legal characters in a FAT filename using an OEM character set. - @param This Protocol instance pointer. - @param String A pointer to a Null-terminated Unicode string. The string must - be preallocated to hold FatSize Unicode characters. + @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. + @param String A pointer to a Null-terminated string. @param FatSize The size of the string Fat in bytes. - @param Fat A pointer to a Null-terminated string that contains an 8.3 file - name using an OEM character set. + @param Fat A pointer to a string that contains the converted version of + String using legal FAT characters from an OEM character set. - @retval TRUE Fat is a Long File Name - @retval FALSE Fat is an 8.3 file name + @retval TRUE One or more conversions failed and were substituted with '_' + @retval FALSE None of the conversions failed. **/ typedef @@ -166,7 +164,7 @@ BOOLEAN /// /// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive -/// comparisons of Unicode strings. +/// comparisons of strings. /// struct _EFI_UNICODE_COLLATION_PROTOCOL { EFI_UNICODE_COLLATION_STRICOLL StriColl; diff --git a/MdePkg/Include/Protocol/UsbIo.h b/MdePkg/Include/Protocol/UsbIo.h index e29f60b19c..41c186e08b 100644 --- a/MdePkg/Include/Protocol/UsbIo.h +++ b/MdePkg/Include/Protocol/UsbIo.h @@ -426,7 +426,7 @@ EFI_STATUS ); /** - Retrieves a Unicode string stored in a USB Device. + Retrieves a string stored in a USB Device. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. @param LangID The Language ID for the string being retrieved. diff --git a/MdePkg/Include/Uefi/UefiGpt.h b/MdePkg/Include/Uefi/UefiGpt.h index 5ba4f5b694..997c2c6451 100644 --- a/MdePkg/Include/Uefi/UefiGpt.h +++ b/MdePkg/Include/Uefi/UefiGpt.h @@ -125,7 +125,7 @@ typedef struct { /// UINT64 Attributes; /// - /// Unicode string. + /// Null-terminated name of the partition. /// CHAR16 PartitionName[36]; } EFI_PARTITION_ENTRY; diff --git a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h index b661587fce..80ae3f7490 100644 --- a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h +++ b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h @@ -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; diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h index 2492a461da..c8c3a6c303 100644 --- a/MdePkg/Include/Uefi/UefiSpec.h +++ b/MdePkg/Include/Uefi/UefiSpec.h @@ -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; /// -- 2.39.2