Update comments by UEFI approved Errata revision 'B'.

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

diff --git a/MdePkg/Include/Protocol/DeferredImageLoad.h b/MdePkg/Include/Protocol/DeferredImageLoad.h
index 5bd9e81429dc5d09ab8ff74582e04097109ab842..494e6b8e4e2e0bd3d4e824138f1955cd1b0a7302 100644 (file)
--- a/MdePkg/Include/Protocol/DeferredImageLoad.h
+++ b/MdePkg/Include/Protocol/DeferredImageLoad.h
@@ -41,19 +41,21 @@ typedef struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL  EFI_DEFERRED_IMAGE_LOAD_PROTOC
   of the location of the executable image rather than its actual contents.  record handle until\r
   there are no more, at which point UserInfo will point to NULL. \r
 \r
-  @param[in]  This             Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
-  @param[in]  ImageIndex       Zero-based index of the deferred index.\r
-  @param[out] ImageDevicePath  On return, points to a pointer to the device path of the image. The device path should \r
-                               not be freed by the caller. \r
-  @param[out] Image            On return, points to the first byte of the image or NULL if the image is not available. \r
-                               The image should not be freed by the caller unless LoadImage() has been called \r
-                               successfully.  \r
-  @param[out] ImageSize        On return, the size of the image, or 0 if the image is not available.\r
-  @param[out] BootOption       On return, points to TRUE if the image was intended as a boot option or FALSE if it \r
-                               was not intended as a boot option. \r
+  @param[in]  This               Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
+  @param[in]  ImageIndex         Zero-based index of the deferred index.\r
+  @param[out] ImageDevicePath    On return, points to a pointer to the device path of the image. \r
+                                 The device path should not be freed by the caller. \r
+  @param[out] Image              On return, points to the first byte of the image or NULL if the  \r
+                                 image is not available. The image should not be freed by the caller \r
+                                 unless LoadImage() has been called successfully.  \r
+  @param[out] ImageSize          On return, the size of the image, or 0 if the image is not available.\r
+  @param[out] BootOption         On return, points to TRUE if the image was intended as a boot option \r
+                                 or FALSE if it was not intended as a boot option. \r
  \r
-  @retval EFI_SUCCESS          Image information returned successfully.\r
-  @retval EFI_NOT_FOUND        ImageIndex does not refer to a valid image.\r
+  @retval EFI_SUCCESS            Image information returned successfully.\r
+  @retval EFI_NOT_FOUND          ImageIndex does not refer to a valid image.\r
+  @retval EFI_INVALID_PARAMETER  ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or \r
+                                 BootOption is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r

diff --git a/MdePkg/Include/Protocol/UserCredential.h b/MdePkg/Include/Protocol/UserCredential.h
index d889c9097b20436e2603091de1271d813066080c..8716d6d8c85b41c0a5df4b5b6ef9d7de3e44c8ce 100644 (file)
--- a/MdePkg/Include/Protocol/UserCredential.h
+++ b/MdePkg/Include/Protocol/UserCredential.h
@@ -29,9 +29,10 @@ typedef struct _EFI_USER_CREDENTIAL_PROTOCOL  EFI_USER_CREDENTIAL_PROTOCOL;
 /**\r
   Enroll a user on a credential provider.\r
 \r
-  This function enrolls a user profile using this credential provider. If a user profile is successfully \r
-  enrolled, it calls the User Manager Protocol function Notify() to notify the user manager driver \r
-  that credential information has changed.\r
+  This function enrolls and deletes a user profile using this credential provider. If a user profile\r
+  is successfully enrolled, it calls the User Manager Protocol function Notify() to notify the user \r
+  manager driver that credential information has changed. If an enrolled user does exist, delete the \r
+  user on the credential provider.\r
 \r
   @param[in] This                Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
   @param[in] User                The user profile to enroll.\r
@@ -60,14 +61,16 @@ EFI_STATUS
   the user credential provider does not require a form to identify the user, then this function should \r
   return EFI_NOT_FOUND.\r
 \r
-  @param[in]  This       Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[out] Hii        On return, holds the HII database handle.\r
-  @param[out] FormSetId  On return, holds the identifier of the form set which contains\r
-                         the form used during user identification.\r
-  @param[out] FormId     On return, holds the identifier of the form used during user identification.\r
+  @param[in]  This               Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[out] Hii                On return, holds the HII database handle.\r
+  @param[out] FormSetId          On return, holds the identifier of the form set which contains\r
+                                 the form used during user identification.\r
+  @param[out] FormId             On return, holds the identifier of the form used during user \r
+                                 identification.\r
  \r
-  @retval EFI_SUCCESS    Form returned successfully.\r
-  @retval EFI_NOT_FOUND  Form not returned.\r
+  @retval EFI_SUCCESS            Form returned successfully.\r
+  @retval EFI_NOT_FOUND          Form not returned.\r
+  @retval EFI_INVALID_PARAMETER  Hii is NULL or FormSetId is NULL or FormId is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -84,16 +87,19 @@ EFI_STATUS
   This optional function returns a bitmap which is less than or equal to the number of pixels specified \r
   by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. \r
 \r
-  @param[in]     This    Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[in,out] Width   On entry, points to the desired bitmap width. If NULL then no bitmap information will \r
-                         be returned. On exit, points to the width of the bitmap returned.\r
-  @param[in,out] Height  On entry, points to the desired bitmap height. If NULL then no bitmap information will \r
-                         be returned. On exit, points to the height of the bitmap returned\r
-  @param[out]    Hii     On return, holds the HII database handle. \r
-  @param[out]    Image   On return, holds the HII image identifier. \r
+  @param[in]      This           Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[in, out] Width          On entry, points to the desired bitmap width. If NULL then no bitmap\r
+                                 information will be returned. On exit, points to the width of the  \r
+                                 bitmap returned.\r
+  @param[in, out] Height         On entry, points to the desired bitmap height. If NULL then no bitmap \r
+                                 information will be returned. On exit, points to the height of the  \r
+                                 bitmap returned\r
+  @param[out]     Hii            On return, holds the HII database handle. \r
+  @param[out]     Image          On return, holds the HII image identifier. \r
  \r
-  @retval EFI_SUCCESS    Image identifier returned successfully.\r
-  @retval EFI_NOT_FOUND  Image identifier not returned.\r
+  @retval EFI_SUCCESS            Image identifier returned successfully.\r
+  @retval EFI_NOT_FOUND          Image identifier not returned.\r
+  @retval EFI_INVALID_PARAMETER  Hii is NULL or Image is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -111,12 +117,13 @@ EFI_STATUS
   This function returns a string which describes the credential provider. If no such string exists, then \r
   EFI_NOT_FOUND is returned. \r
 \r
-  @param[in]  This       Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[out] Hii        On return, holds the HII database handle.\r
-  @param[out] String     On return, holds the HII string identifier.\r
+  @param[in]  This               Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[out] Hii                On return, holds the HII database handle.\r
+  @param[out] String             On return, holds the HII string identifier.\r
  \r
-  @retval EFI_SUCCESS    String identifier returned successfully.\r
-  @retval EFI_NOT_FOUND  String identifier not returned.\r
+  @retval EFI_SUCCESS            String identifier returned successfully.\r
+  @retval EFI_NOT_FOUND          String identifier not returned.\r
+  @retval EFI_INVALID_PARAMETER  Hii is NULL or String is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -133,14 +140,18 @@ EFI_STATUS
   function is called after the credential-related information has been submitted on a form OR after a \r
   call to Default() has returned that this credential is ready to log on.\r
 \r
-  @param[in]  This           Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[in]  User           The user profile handle of the user profile currently being considered by the user \r
-                             identity manager. If NULL, then no user profile is currently under consideration.\r
-  @param[out] Identifier     On return, points to the user identifier. \r
+  @param[in]  This               Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[in]  User               The user profile handle of the user profile currently being considered \r
+                                 by the user identity manager. If NULL, then no user profile is currently \r
+                                 under consideration.\r
+  @param[out] Identifier         On return, points to the user identifier. \r
  \r
-  @retval EFI_SUCCESS        User identifier returned successfully.\r
-  @retval EFI_NOT_READY      No user identifier can be returned.\r
-  @retval EFI_ACCESS_DENIED  The user has been locked out of this user credential.\r
+  @retval EFI_SUCCESS            User identifier returned successfully.\r
+  @retval EFI_NOT_READY          No user identifier can be returned.\r
+  @retval EFI_ACCESS_DENIED      The user has been locked out of this user credential.\r
+  @retval EFI_NOT_FOUND          User is not NULL, and the specified user handle can't be found in user \r
+                                 profile database \r
+  @retval EFI_INVALID_PARAMETER  Identifier is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -156,11 +167,12 @@ EFI_STATUS
   This function is called when a credential provider is selected by the user. If AutoLogon returns \r
   FALSE, then the user interface will be constructed by the User Identity Manager. \r
 \r
-  @param[in]  This       Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[out] AutoLogon  On return, points to the credential provider's capabilities after the credential provider \r
-                         has been selected by the user. \r
+  @param[in]  This               Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[out] AutoLogon          On return, points to the credential provider's capabilities after \r
+                                 the credential provider has been selected by the user. \r
  \r
-  @retval EFI_SUCCESS    Credential provider successfully selected.\r
+  @retval EFI_SUCCESS            Credential provider successfully selected.\r
+  @retval EFI_INVALID_PARAMETER  AutoLogon is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -189,11 +201,12 @@ EFI_STATUS
 \r
   This function reports the default login behavior regarding this credential provider.  \r
 \r
-  @param[in]  This       Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[out] AutoLogon  On return, holds whether the credential provider should be used by default to \r
-                         automatically log on the user.  \r
+  @param[in]  This               Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[out] AutoLogon          On return, holds whether the credential provider should be \r
+                                 used by default to automatically log on the user.  \r
  \r
-  @retval EFI_SUCCESS    Default information successfully returned.\r
+  @retval EFI_SUCCESS            Default information successfully returned.\r
+  @retval EFI_INVALID_PARAMETER  AutoLogon is NULL.\r
 **/\r
 typedef \r
 EFI_STATUS\r
@@ -217,10 +230,10 @@ EFI_STATUS
                                 information. \r
  \r
   @retval EFI_SUCCESS           Information returned successfully.\r
-  @retval EFI_ACCESS_DENIED     The information about the specified user cannot be accessed by the \r
-                                current user.\r
   @retval EFI_BUFFER_TOO_SMALL  The size specified by InfoSize is too small to hold all of the user \r
                                 information. The size required is returned in *InfoSize.\r
+  @retval EFI_NOT_FOUND         The specified UserInfo does not refer to a valid user info handle.\r
+  @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.                                \r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -232,19 +245,20 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Enumerate all of the enrolled users on the platform.\r
+  Enumerate all of the user information records on the credential provider.\r
 \r
   This function returns the next user information record. To retrieve the first user information record \r
   handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information \r
   record handle until there are no more, at which point UserInfo will point to NULL. \r
 \r
-  @param[in]     This      Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
-  @param[in,out] UserInfo  On entry, points to the previous user information handle or NULL to start \r
-                           enumeration. On exit, points to the next user information handle or NULL if there is \r
-                           no more user information.\r
+  @param[in]     This            Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.\r
+  @param[in,out] UserInfo        On entry, points to the previous user information handle or NULL to  \r
+                                 start enumeration. On exit, points to the next user information handle \r
+                                 or NULL if there is no more user information.\r
  \r
-  @retval EFI_SUCCESS      User information returned.\r
-  @retval EFI_NOT_FOUND    No more user information found.\r
+  @retval EFI_SUCCESS            User information returned.\r
+  @retval EFI_NOT_FOUND          No more user information found.\r
+  @retval EFI_INVALID_PARAMETER  UserInfo is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r

diff --git a/MdePkg/Include/Protocol/UserManager.h b/MdePkg/Include/Protocol/UserManager.h
index edd07221ad78835c66abb01ec977c75250752963..35d7e4dbb3761f1f68f08ea40751caf0b6db6be3 100644 (file)
--- a/MdePkg/Include/Protocol/UserManager.h
+++ b/MdePkg/Include/Protocol/UserManager.h
@@ -410,7 +410,7 @@ EFI_STATUS
   with the user information record handle following UserInfo and continues until either the \r
   information is found or there are no more user profiles.\r
   A match occurs when the Info.InfoType field matches the user information record type and the \r
-  user information record data matches the portion of Info passed the EFI_USER_INFO header.\r
+  user information record data matches the portion of Info.\r
 \r
   @param[in]     This      Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
   @param[in,out] User      On entry, points to the previously returned user profile handle or NULL to start \r
@@ -421,14 +421,16 @@ EFI_STATUS
                            information record or NULL if not found. Can be NULL, in which case only one user \r
                            information record per user can be returned. \r
   @param[in]     Info      Points to the buffer containing the user information to be compared to the user \r
-                           information record. If NULL, then only the user information record type is compared. \r
+                           information record. If the user information record data is empty, then only the user \r
+                           information record type is compared. \r
                            If InfoSize is 0, then the user information record must be empty.\r
 \r
   @param[in]     InfoSize  The size of Info, in bytes. \r
 \r
-  @retval EFI_SUCCESS      User information was found. User points to the user profile handle and \r
-                           UserInfo points to the user information handle.\r
-  @retval EFI_NOT_FOUND    User information was not found. User points to NULL and UserInfo points to NULL.\r
+  @retval EFI_SUCCESS           User information was found. User points to the user profile handle and UserInfo\r
+                                points to the user information handle.\r
+  @retval EFI_NOT_FOUND         User information was not found. User points to NULL and UserInfo points to NULL.\r
+  @retval EFI_INVALID_PARAMETER User is NULL. Or Info is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -489,6 +491,9 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED     The information about the specified user cannot be accessed by the current user.\r
   @retval EFI_BUFFER_TOO_SMALL  The number of bytes specified by *InfoSize is too small to hold \r
                                 the returned data. The actual size required is returned in *InfoSize.\r
+  @retval EFI_NOT_FOUND         User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+                                user info handle.\r
+  @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.\r
 **/  \r
 typedef\r
 EFI_STATUS\r
@@ -524,6 +529,9 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED       The record is exclusive.\r
   @retval EFI_SECURITY_VIOLATION  The current user does not have permission to change the specified \r
                                   user profile or user information record.\r
+  @retval EFI_NOT_FOUND           User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+                                  user info handle.\r
+  @retval EFI_INVALID_PARAMETER   UserInfo is NULL or Info is NULL. \r
 **/  \r
 typedef\r
 EFI_STATUS\r
@@ -563,15 +571,13 @@ EFI_STATUS
   handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information \r
   record handle until there are no more, at which point UserInfo will point to NULL. \r
 \r
-  Note: in-consistency between code and the UEFI 2.3 specification that the type of the User parameter\r
-  is EFI_USER_PROFILE_HANDLE. It should be spec error and wait for spec update.\r
-\r
-  @param[in]     This      Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
-  @param[in]     User      Handle of the user whose information will be deleted.\r
-  @param[in,out] UserInfo  Handle of the user information to remove.\r
+  @param[in]     This           Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
+  @param[in]     User           Handle of the user whose information will be deleted.\r
+  @param[in,out] UserInfo       Handle of the user information to remove.\r
 \r
-  @retval EFI_SUCCESS      User information returned.\r
-  @retval EFI_NOT_FOUND    No more user information found.\r
+  @retval EFI_SUCCESS           User information returned.\r
+  @retval EFI_NOT_FOUND         No more user information found.\r
+  @retval EFI_INVALID_PARAMETER UserInfo is NULL.\r
 **/ \r
 typedef\r
 EFI_STATUS\r