String Reference Cleanup.

Signed-off-by: lzeng14
Reviewed-by: lgao4

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11762 6f19259b-4bc3-4df7-8a09-765794883524

10 files changed, 52 insertions, 53 deletions

diff --git a/MdePkg/Include/Protocol/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h
index 47518961f8..7a65f5e33a 100644
--- a/MdePkg/Include/Protocol/DevicePath.h
+++ b/MdePkg/Include/Protocol/DevicePath.h
@@ -965,7 +965,7 @@ typedef struct {
   ///

   UINT16                          StatusFlag;

   ///

-  /// ASCIIZ string that describes the boot device to a user. 

+  /// Null-terminated ASCII string that describes the boot device to a user.

   ///

   CHAR8                           String[1];

 } BBS_BBS_DEVICE_PATH;

diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h
index 18f18fb4ba..617b96ab13 100644
--- a/MdePkg/Include/Protocol/FirmwareManagement.h
+++ b/MdePkg/Include/Protocol/FirmwareManagement.h
@@ -8,7 +8,7 @@
   CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return 

   EFI_UNSUPPORTED if not supported by the driver.

   

-  Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -51,7 +51,7 @@ typedef struct {
   /// 

   UINT64                           ImageId;

   /// 

-  /// A pointer to a null-terminated Unicode string representing the firmware image name.  

+  /// A pointer to a null-terminated string representing the firmware image name.  

   /// 

   CHAR16                           *ImageIdName;

   /// 

@@ -60,7 +60,7 @@ typedef struct {
   /// 

   UINT32                           Version;

   /// 

-  /// A pointer to a null-terminated Unicode string representing the firmware image version name.

+  /// A pointer to a null-terminated string representing the firmware image version name.

   /// 

   CHAR16                           *VersionName;

   /// 

@@ -239,7 +239,7 @@ EFI_STATUS
                                      0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version comparison

                                      is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates

                                      that package version update is in progress.

-  @param[out]     PackageVersionName A pointer to a pointer to a null-terminated Unicode string representing the

+  @param[out]     PackageVersionName A pointer to a pointer to a null-terminated string representing the

                                      package version name. The buffer is allocated by this function with 

                                      AllocatePool(), and it is the caller's responsibility to free it with a call

                                      to FreePool().

@@ -330,7 +330,7 @@ EFI_STATUS
   @param[in]  VendorCode         This enables vendor to implement vendor-specific firmware image update policy.  

                                  Null indicates the caller did not specify the policy or use the default policy.

   @param[in]  Progress           A function used by the driver to report the progress of the firmware update.

-  @param[out] AbortReason        A pointer to a pointer to a null-terminated Unicode string providing more

+  @param[out] AbortReason        A pointer to a pointer to a null-terminated string providing more

                                  details for the aborted operation. The buffer is allocated by this function 

                                  with AllocatePool(), and it is the caller's responsibility to free it with a

                                  call to FreePool().

@@ -396,7 +396,7 @@ EFI_STATUS
                                        0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version

                                        comparison is to be performed using PackageVersionName. A value of

                                        0xFFFFFFFD indicates that package version update is in progress.

-  @param[out] PackageVersionName       A pointer to a pointer to a null-terminated Unicode string representing

+  @param[out] PackageVersionName       A pointer to a pointer to a null-terminated string representing

                                        the package version name. The buffer is allocated by this function with

                                        AllocatePool(), and it is the caller's responsibility to free it with a

                                        call to FreePool().

diff --git a/MdePkg/Include/Protocol/Ftp4.h b/MdePkg/Include/Protocol/Ftp4.h
index ae437a8e99..1c4a5db925 100644
--- a/MdePkg/Include/Protocol/Ftp4.h
+++ b/MdePkg/Include/Protocol/Ftp4.h
@@ -7,7 +7,7 @@
   The definitions in this file are defined in UEFI Specification 2.3, which have

   not been verified by one implementation yet.

 

-  Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>

   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

@@ -180,7 +180,7 @@ struct _EFI_FTP4_COMMAND_TOKEN {
   /// 

   EFI_EVENT                             Event; 

   /// 

-  /// Pointer to an ASCIIZ path name string. 

+  /// Pointer to a null-terminated ASCII name string. 

   /// 

   UINT8                                 *Pathname;

   /// 

diff --git a/MdePkg/Include/Protocol/HiiString.h b/MdePkg/Include/Protocol/HiiString.h
index 3deeac033a..496ffa659e 100644
--- a/MdePkg/Include/Protocol/HiiString.h
+++ b/MdePkg/Include/Protocol/HiiString.h
@@ -1,7 +1,7 @@
 /** @file

   The file provides services to manipulate string data.

   

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 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

@@ -150,9 +150,10 @@ EFI_STATUS
 

   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.

   @param  PackageList            The package list to examine.

-  @param  Languages              Points to the buffer to hold the returned string.

+  @param  Languages              Points to the buffer to hold the returned

+                                 null-terminated ASCII string.

   @param  LanguagesSize          On entry, points to the size of the buffer pointed

-                                 to by  Languages, in bytes. On  return, points to

+                                 to by Languages, in bytes. On return, points to

                                  the length of Languages, in bytes.

 

   @retval EFI_SUCCESS            The languages were returned successfully.

@@ -181,24 +182,27 @@ EFI_STATUS
 

   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.

   @param  PackageList            The package list to examine.

-  @param  FirstLanguage          Points to the primary language.

-  @param  SecondaryLanguages     Points to the buffer to hold the returned list of

+  @param  PrimaryLanguage        Points to the null-terminated ASCII string that specifies

+                                 the primary language. Languages are specified in the

+                                 format specified in Appendix M of the UEFI 2.0 specification.

+  @param  SecondaryLanguages     Points to the buffer to hold the returned null-terminated

+                                 ASCII string that describes the list of

                                  secondary languages for the specified

-                                 FirstLanguage. If there are no secondary

-                                 languages, the function  returns successfully, but

+                                 PrimaryLanguage. If there are no secondary

+                                 languages, the function returns successfully, but

                                  this is set to NULL.

   @param  SecondaryLanguagesSize On entry, points to the size of the buffer pointed

-                                 to  by SecondaryLanguages, in bytes. On return,

+                                 to by SecondaryLanguages, in bytes. On return,

                                  points to the length of SecondaryLanguages in bytes.

 

   @retval EFI_SUCCESS            Secondary languages were correctly returned.

-  @retval EFI_INVALID_PARAMETER  FirstLanguage or SecondaryLanguages or

+  @retval EFI_INVALID_PARAMETER  PrimaryLanguage or SecondaryLanguages or

                                  SecondaryLanguagesSize was NULL.

   @retval EFI_BUFFER_TOO_SMALL   The buffer specified by SecondaryLanguagesSize is

                                  too small to hold the returned information.

-                                 SecondLanguageSize is updated to hold the size of

+                                 SecondaryLanguageSize is updated to hold the size of

                                  the buffer required.

-  @retval EFI_INVALID_LANGUAGE   The language specified by FirstLanguage is not

+  @retval EFI_INVALID_LANGUAGE   The language specified by PrimaryLanguage is not

                                  present in the specified package list.

   @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                

 

@@ -208,9 +212,9 @@ EFI_STATUS
 (EFIAPI *EFI_HII_GET_2ND_LANGUAGES)(

   IN CONST  EFI_HII_STRING_PROTOCOL   *This,

   IN        EFI_HII_HANDLE            PackageList,

-  IN CONST  CHAR8                     *FirstLanguage,

-  IN OUT    CHAR8                     *SecondLanguages,

-  IN OUT    UINTN                     *SecondLanguagesSize

+  IN CONST  CHAR8                     *PrimaryLanguage,

+  IN OUT    CHAR8                     *SecondaryLanguages,

+  IN OUT    UINTN                     *SecondaryLanguagesSize

 );

 

 

@@ -230,4 +234,3 @@ extern EFI_GUID gEfiHiiStringProtocolGuid;
 

 #endif

 

-

diff --git a/MdePkg/Include/Protocol/IScsiInitiatorName.h b/MdePkg/Include/Protocol/IScsiInitiatorName.h
index f7b890e2a6..e55c51b7c6 100644
--- a/MdePkg/Include/Protocol/IScsiInitiatorName.h
+++ b/MdePkg/Include/Protocol/IScsiInitiatorName.h
@@ -2,7 +2,7 @@
   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.

   It provides the ability to get and set the iSCSI Initiator Name.                                                  

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -29,7 +29,8 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO
   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.

   @param  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the

                      variable data buffer.

-  @param  Buffer     Pointer to the buffer for data to be read.

+  @param  Buffer     Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.

+                     The maximum length is 223 characters, including the null-terminator.

 

   @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the

                                 BufferSize was sufficient to handle the iSCSI initiator name

@@ -53,7 +54,8 @@ EFI_STATUS
 

   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.

   @param  BufferSize Size of the buffer in bytes pointed to by Buffer.

-  @param  Buffer     Pointer to the buffer for data to be written.

+  @param  Buffer     Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.

+                     The maximum length is 223 characters, including the null-terminator.

 

   @retval EFI_SUCCESS           Data was successfully stored by the protocol.

   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.

@@ -83,9 +85,3 @@ extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
 

 #endif

 

-

-

-

-

-

-

diff --git a/MdePkg/Include/Protocol/Ip6Config.h b/MdePkg/Include/Protocol/Ip6Config.h
index 7195ef6e57..b2c3be9ee7 100644
--- a/MdePkg/Include/Protocol/Ip6Config.h
+++ b/MdePkg/Include/Protocol/Ip6Config.h
@@ -2,7 +2,7 @@
   This file provides a definition of the EFI IPv6 Configuration

   Protocol.

 

-Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>

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

@@ -100,7 +100,7 @@ typedef enum {
 ///

 typedef struct {

   ///

-  /// The name of the interface. It is a NULL-terminated Unicode string.

+  /// The name of the interface. It is a NULL-terminated string.

   ///

   CHAR16                Name[32];

   /// 

diff --git a/MdePkg/Include/Protocol/IpSecConfig.h b/MdePkg/Include/Protocol/IpSecConfig.h
index e305381f7e..c6e2b36beb 100644
--- a/MdePkg/Include/Protocol/IpSecConfig.h
+++ b/MdePkg/Include/Protocol/IpSecConfig.h
@@ -3,7 +3,7 @@
   The EFI_IPSEC_CONFIG_PROTOCOL provides the mechanism to set and retrieve security and 

   policy related information for the EFI IPsec protocol driver.

 

-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>

   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

@@ -331,7 +331,7 @@ typedef struct _EFI_IPSEC_SA_ID {
 ///

 typedef struct _EFI_IPSEC_SPD_DATA {

   /// 

-  /// A null-terminated name string which is used as a symbolic 

+  /// A null-terminated ASCII name string which is used as a symbolic 

   /// identifier for an IPsec Local or Remote address.

   /// 

   UINT8                           Name[MAX_PEERID_LEN];

@@ -522,7 +522,7 @@ typedef struct _EFI_IPSEC_PAD_ID {
     ///

     EFI_IP_ADDRESS_INFO   IpAddress;

     ///

-    /// Pointer to a null terminated string (8-bit ASCII character) 

+    /// Pointer to a null terminated ASCII string

     /// representing the symbolic names. A PeerId can be a DNS 

     /// name, Distinguished Name, RFC 822 email address or Key ID 

     /// (specified in section 4.4.3.1 of RFC 4301)

diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 031ef184eb..1afac6cff5 100644
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -1,7 +1,7 @@
 /** @file

   EFI Multicast Trivial File Tranfer Protocol Definition

 

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 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

@@ -313,8 +313,8 @@ EFI_STATUS
   @param  OverrideData Data that is used to override the existing parameters. If NULL,

                        the default parameters that were set in the

                        EFI_MTFTP4_PROTOCOL.Configure() function are used.

-  @param  Filename     The pointer to ASCIIZ file name string.

-  @param  ModeStr      The pointer to ASCIIZ mode string. If NULL, "octet" will be used.

+  @param  Filename     The pointer to null-terminated ASCII file name string.

+  @param  ModeStr      The pointer to null-terminated ASCII mode string. If NULL, "octet" will be used.

   @param  OptionCount  Number of option/value string pairs in OptionList.

   @param  OptionList   The pointer to array of option/value string pairs. Ignored if

                        OptionCount is zero.

@@ -542,11 +542,11 @@ struct _EFI_MTFTP4_TOKEN {
   ///

   EFI_MTFTP4_OVERRIDE_DATA    *OverrideData;

   ///

-  /// The pointer to the ASCIIZ file name string.

+  /// The pointer to the null-terminated ASCII file name string.

   ///

   UINT8                       *Filename;

   ///

-  /// The pointer to the ASCIIZ mode string. If NULL, "octet" is used.

+  /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.

   ///

   UINT8                       *ModeStr;

   ///

diff --git a/MdePkg/Include/Protocol/Mtftp6.h b/MdePkg/Include/Protocol/Mtftp6.h
index b06a6719d5..b9836607ec 100644
--- a/MdePkg/Include/Protocol/Mtftp6.h
+++ b/MdePkg/Include/Protocol/Mtftp6.h
@@ -3,7 +3,7 @@
   the EFI UDPv6 Protocol and provides basic services for client-side unicast and/or

   multicast TFTP operations.

 

-  Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>

   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

@@ -265,7 +265,7 @@ typedef struct {
   ///

   UINT8                   SupportedOptionCount;

   ///

-  /// An array of option strings that are recognized and supported by

+  /// An array of null-terminated ASCII option strings that are recognized and supported by

   /// this EFI MTFTPv6 Protocol driver implementation. The buffer is

   /// read only to the caller and the caller should NOT free the buffer.

   ///

@@ -304,8 +304,8 @@ typedef struct {
 /// EFI_MTFTP6_OPTION

 ///

 typedef struct {

-  UINT8                  *OptionStr; ///< Pointer to the ASCIIZ MTFTPv6 option string.

-  UINT8                  *ValueStr;  ///< Pointer to the ASCIIZ MTFTPv6 value string.

+  UINT8                  *OptionStr; ///< Pointer to the null-terminated ASCII MTFTPv6 option string.

+  UINT8                  *ValueStr;  ///< Pointer to the null-terminated ASCII MTFTPv6 value string.

 } EFI_MTFTP6_OPTION;

 

 /**

@@ -409,11 +409,11 @@ struct _EFI_MTFTP6_TOKEN {
   ///

   EFI_MTFTP6_OVERRIDE_DATA    *OverrideData;

   ///

-  /// Pointer to the ASCIIZ file name string.

+  /// Pointer to the null-terminated ASCII file name string.

   ///

   UINT8                       *Filename;

   ///

-  /// Pointer to the ASCIIZ mode string. If NULL, octet is used.

+  /// Pointer to the null-terminated ASCII mode string. If NULL, octet is used.

   ///

   UINT8                       *ModeStr;

   ///

@@ -534,8 +534,8 @@ EFI_STATUS
   @param[in]  OverrideData       Data that is used to override the existing parameters. If NULL, the

                                  default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()

                                  function are used.

-  @param[in]  Filename           Pointer to ASCIIZ file name string.

-  @param[in]  ModeStr            Pointer to ASCIIZ mode string. If NULL, octet will be used

+  @param[in]  Filename           Pointer to null-terminated ASCII file name string.

+  @param[in]  ModeStr            Pointer to null-terminated ASCII mode string. If NULL, octet will be used

   @param[in]  OptionCount        Number of option/value string pairs in OptionList.

   @param[in]  OptionList         Pointer to array of option/value string pairs. Ignored if

                                  OptionCount is zero.

diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h
index 1a79af6a39..f45c9ead0e 100644
--- a/MdePkg/Include/Protocol/UnicodeCollation.h
+++ b/MdePkg/Include/Protocol/UnicodeCollation.h
@@ -3,7 +3,7 @@
   This protocol is used to allow code running in the boot services environment 

   to perform lexical comparison functions on Unicode strings for given languages.

 

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 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

@@ -125,7 +125,7 @@ VOID
   @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.

+                  name using an 8-bit OEM character set.

   @param  String  A pointer to a Null-terminated string. The string must

                   be allocated in advance to hold FatSize characters.