Updates function description per UEFI2.3d. No impact is for functionality. The main changes include:

1. For LoadImage() service, EFI_ACCESS_DENIED return status is added, and EFI_SECURITY_VIOLATION return status description is updated. Meanwhile, EFI_PE32_IMAGE_PROTOCOL. LoadPeImage() in MdeModulePkg is also updated to match LoadImage() service.


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

4 files changed, 54 insertions, 6 deletions

diff --git a/MdeModulePkg/Core/Dxe/DxeMain.h b/MdeModulePkg/Core/Dxe/DxeMain.h
index 56b91b0c11..e7ec3c8561 100644
--- a/MdeModulePkg/Core/Dxe/DxeMain.h
+++ b/MdeModulePkg/Core/Dxe/DxeMain.h
@@ -2,7 +2,7 @@
   The internal header file includes the common header files, defines

   internal structure and functions used by DxeCore module.

 

-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

 which accompanies this distribution.  The full text of the license may be found at

@@ -1298,6 +1298,14 @@ CoreFreePool (
                                   protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient

                                   resources.

+  @retval EFI_LOAD_ERROR          Image was not loaded because the image format was corrupt or not

+                                  understood.

+  @retval EFI_DEVICE_ERROR        Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED       Image was not loaded because the platform policy prohibits the 

+                                  image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION  Image was loaded and an ImageHandle was created with a 

+                                  valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                  platform policy specifies that the image should not be started.

 

 **/

 EFI_STATUS

@@ -1339,7 +1347,7 @@ CoreUnloadImage (
   @param  ImageHandle             Handle of image to be started.

   @param  ExitDataSize            Pointer of the size to ExitData

   @param  ExitData                Pointer to a pointer to a data buffer that

-                                  includes a Null-terminated Unicode string,

+                                  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

diff --git a/MdeModulePkg/Core/Dxe/Image/Image.c b/MdeModulePkg/Core/Dxe/Image/Image.c
index 2ffd6af9b6..c6a7081c18 100644
--- a/MdeModulePkg/Core/Dxe/Image/Image.c
+++ b/MdeModulePkg/Core/Dxe/Image/Image.c
@@ -1,7 +1,7 @@
 /** @file

   Core image handling services to load and unload PeImage.

 

-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

 which accompanies this distribution.  The full text of the license may be found at

@@ -959,6 +959,14 @@ CoreUnloadAndCloseImage (
                                   protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient

                                   resources.

+  @retval EFI_LOAD_ERROR          Image was not loaded because the image format was corrupt or not

+                                  understood.

+  @retval EFI_DEVICE_ERROR        Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED       Image was not loaded because the platform policy prohibits the 

+                                  image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION  Image was loaded and an ImageHandle was created with a 

+                                  valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                  platform policy specifies that the image should not be started.

 

 **/

 EFI_STATUS

@@ -1265,6 +1273,14 @@ Done:
                                   protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient

                                   resources.

+  @retval EFI_LOAD_ERROR          Image was not loaded because the image format was corrupt or not

+                                  understood.

+  @retval EFI_DEVICE_ERROR        Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED       Image was not loaded because the platform policy prohibits the 

+                                  image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION  Image was loaded and an ImageHandle was created with a 

+                                  valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                  platform policy specifies that the image should not be started.

 

 **/

 EFI_STATUS

@@ -1334,6 +1350,14 @@ CoreLoadImage (
                                   protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient

                                   resources.

+  @retval EFI_LOAD_ERROR          Image was not loaded because the image format was corrupt or not

+                                  understood.

+  @retval EFI_DEVICE_ERROR        Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED       Image was not loaded because the platform policy prohibits the 

+                                  image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION  Image was loaded and an ImageHandle was created with a 

+                                  valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                  platform policy specifies that the image should not be started.

 

 **/

 EFI_STATUS

@@ -1372,7 +1396,7 @@ CoreLoadImageEx (
   @param  ImageHandle             Handle of image to be started.

   @param  ExitDataSize            Pointer of the size to ExitData

   @param  ExitData                Pointer to a pointer to a data buffer that

-                                  includes a Null-terminated Unicode string,

+                                  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

diff --git a/MdeModulePkg/Core/Dxe/Image/Image.h b/MdeModulePkg/Core/Dxe/Image/Image.h
index b71af0d33d..2d4c288704 100644
--- a/MdeModulePkg/Core/Dxe/Image/Image.h
+++ b/MdeModulePkg/Core/Dxe/Image/Image.h
@@ -1,7 +1,7 @@
 /** @file

   Data structure and functions to load and unload PeImage.

 

-Copyright (c) 2006 - 2009, 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

@@ -116,6 +116,14 @@ typedef struct {
                                   protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient

                                   resources.

+  @retval EFI_LOAD_ERROR          Image was not loaded because the image format was corrupt or not

+                                  understood.

+  @retval EFI_DEVICE_ERROR        Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED       Image was not loaded because the platform policy prohibits the 

+                                  image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION  Image was loaded and an ImageHandle was created with a 

+                                  valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                  platform policy specifies that the image should not be started.

 

 **/

 EFI_STATUS

diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
index 06c7559d38..b56dd37ad0 100644
--- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h
+++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
@@ -3,7 +3,7 @@
   Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.

   This protocol uses File Device Path to get an EFI image.

 

-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

@@ -49,6 +49,14 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
   @retval EFI_UNSUPPORTED       The image type is not supported, or the device path cannot be

                                 parsed to locate the proper protocol for loading the file.

   @retval EFI_OUT_OF_RESOURCES  The image was not loaded due to insufficient memory resources.

+  @retval EFI_LOAD_ERROR        Image was not loaded because the image format was corrupt or not

+                                understood.

+  @retval EFI_DEVICE_ERROR      Image was not loaded because the device returned a read error.

+  @retval EFI_ACCESS_DENIED     Image was not loaded because the platform policy prohibits the 

+                                image from being loaded. NULL is returned in *ImageHandle.

+  @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a 

+                                valid EFI_LOADED_IMAGE_PROTOCOL. However, the current 

+                                platform policy specifies that the image should not be started.

 **/

 typedef

 EFI_STATUS