]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DeferredImageLoad.h
MdePkg/Register: Fix various typos
[mirror_edk2.git] / MdePkg / Include / Protocol / DeferredImageLoad.h
index 5bd9e81429dc5d09ab8ff74582e04097109ab842..4a201af77f58f857a4d03acad305c9ac7c590675 100644 (file)
@@ -1,19 +1,13 @@
 /** @file\r
   UEFI 2.2 Deferred Image Load Protocol definition.\r
 \r
-  This protocol returns information about images whose load was denied because of security \r
-  considerations. This information can be used by the Boot Manager or another agent to reevaluate the \r
-  images when the current security profile has been changed, such as when the current user profile \r
+  This protocol returns information about images whose load was denied because of security\r
+  considerations. This information can be used by the Boot Manager or another agent to reevaluate the\r
+  images when the current security profile has been changed, such as when the current user profile\r
   changes. There can be more than one instance of this protocol installed.\r
 \r
-  Copyright (c) 2009, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -33,27 +27,29 @@ typedef struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL  EFI_DEFERRED_IMAGE_LOAD_PROTOC
 /**\r
   Returns information about a deferred image.\r
 \r
-  This function returns information about a single deferred image. The deferred images are numbered \r
-  consecutively, starting with 0.  If there is no image which corresponds to ImageIndex, then \r
-  EFI_NOT_FOUND is returned. All deferred images may be returned by iteratively calling this \r
+  This function returns information about a single deferred image. The deferred images are numbered\r
+  consecutively, starting with 0.  If there is no image which corresponds to ImageIndex, then\r
+  EFI_NOT_FOUND is returned. All deferred images may be returned by iteratively calling this\r
   function until EFI_NOT_FOUND is returned.\r
-  Image may be NULL and ImageSize set to 0 if the decision to defer execution was made because \r
+  Image may be NULL and ImageSize set to 0 if the decision to defer execution was made because\r
   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
+  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.\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
-  @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
\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