sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sync comments on data structure to follow latest UEFI spec.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9309 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian
2009-09-24 08:56:33 +00:00
parent f60515255d
commit fbf926add9
15 changed files with 175 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
MdePkg/Include/Protocol/Bis.h
View File

@@ -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

23
MdePkg/Include/Protocol/ComponentName2.h
View File

@@ -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

2
MdePkg/Include/Protocol/DevicePath.h
View File

@@ -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;

2
MdePkg/Include/Protocol/DriverDiagnostics.h
View File

@@ -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

32
MdePkg/Include/Protocol/HiiConfigRouting.h
View File

@@ -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=<StringToken>". That <StringToken> (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
<MultiConfigAltResp> 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 <MultiConfigAltResp>
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
<MulltiConfigResp> format.
@param Configuration A null-terminated string in <MulltiConfigResp> 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 <BlockName> 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
<ConfigRequest> format.
@param ConfigRequest A null-terminated string in <ConfigRequest> 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
<ConfigResp> format.
@param ConfigResp A null-terminated string in <ConfigResp> 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 <MultiConfigAltResp> format.
@param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.
@param Configuration A null-terminated string in <MultiConfigAltResp> 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

6
MdePkg/Include/Protocol/HiiFont.h
View File

@@ -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

14
MdePkg/Include/Protocol/SimpleTextOut.h
View File

@@ -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.

64
MdePkg/Include/Protocol/UnicodeCollation.h
View File

@@ -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;

2
MdePkg/Include/Protocol/UsbIo.h
View File

@@ -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.