Synchronized with UEFI Spec

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

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics2.h b/MdePkg/Include/Protocol/DriverDiagnostics2.h
index a3798b1e543cae51871a133130d3159cd27c9d3b..b56997d1536360daa5082d0d77a7246d91b34ced 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics2.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics2.h
@@ -56,6 +56,9 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
 \r
   @retval EFI_SUCCESS           The controller specified by ControllerHandle and\r
                                 ChildHandle passed the diagnostic.\r
+  @retval EFI_ACCESS_DENIED     The request for initiating diagnostics was unable\r
+                                to be complete due to some underlying hardware or\r
+                                software state.\r
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index bbf59e254f47d601bdc6993ceb24a019ffd1dd2b..fff7688875782317dce982ffd7e19567283eac7c 100644 (file)
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -32,24 +32,22 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
   ChildHandle is NULL the driver is requesting information from\r
   the platform about the ControllerHandle that is being started.\r
   Information returned from Query may lead to the drivers Start()\r
-  function failing. If the UEFI driver is a bus driver and\r
-  producing a ChildHandle the driver must call Query after the\r
-  child handle has been created and an EFI_DEVICE_PATH_PROTOCOL\r
-  has been placed on that handle, but before any time consuming\r
-  operation is performed. If information return by Query may lead\r
-  the driver to decide to not create the ChildHandle. The driver\r
-  must then cleanup and remove the ChildHandle from the system.\r
-  The UEFI driver repeatedly calls Query, processes the\r
-  information returned by the platform, and calls Response passing\r
-  in the arguments returned from Query. The Instance value passed\r
-  into Response must be the same value returned from the\r
-  corresponding call to Query. The UEFI driver must continuously\r
-  call Query and Response until EFI_NOT_FOUND is returned by\r
-  Query. The only value of Instance that has meaning to the UEFI\r
-  driver is zero. An Instance value of zero means return the first\r
-  ParameterBlock in the set of unprocessed parameter blocks. If a\r
-  ParameterBlock has been processed via a Query and corresponding\r
-  Response call it must not be returned again via a Query call.\r
+  function failing.\r
+  If the UEFI driver is a bus driver and producing a ChildHandle\r
+  the driver must call Query after the child handle has been created\r
+  and an EFI_DEVICE_PATH_PROTOCOL has been placed on that handle,\r
+  but before any time consuming operation is performed. If information\r
+  return by Query may lead the driver to decide to not create the\r
+  ChildHandle. The driver must then cleanup and remove the ChildHandle\r
+  from the system.\r
+  The UEFI driver repeatedly calls Query, processes the information\r
+  returned by the platform, and calls Response passing in the\r
+  arguments returned from Query. The Instance value passed into\r
+  Response must be the same value passed into the corresponding\r
+  call to Query.\r
+  An Instance value of zero means return the first ParameterBlock\r
+  in the set of unprocessed parameter blocks. The driver should\r
+  increment the Instance value by one for each successive call to Query.\r
 \r
   @param This                 A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
   \r
@@ -66,18 +64,16 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
                               options for one of its child controllers.\r
   \r
   \r
-  @param Instance             Pointer to the Instance value. On output the\r
-                              instance associated with the parameter data\r
-                              return. On input zero means return the first\r
-                              query data or pass in a valid instance\r
-                              number returned from a previous call to\r
-                              Query.\r
-\r
-  @param ParameterTypeGuid    An EFI_GUID that defines the\r
-                              contents of ParameterBlock. UEFI\r
-                              drivers must use the\r
-                              ParameterTypeGuid to determine how\r
-                              to parser the ParameterBlock.\r
+  @param Instance             Pointer to the Instance value. Zero means\r
+                              return the first query data. The caller should\r
+                              increment this value by one each time to retrieve\r
+                              successive data.\r
+\r
+  @param ParameterTypeGuid    An EFI_GUID that defines the contents\r
+                              of ParameterBlock. UEFI drivers must\r
+                              use the ParameterTypeGuid to determine\r
+                              how to parse the ParameterBlock. The caller\r
+                              should not attempt to free ParameterTypeGuid.\r
 \r
   @param ParameterBlock       The platform returns a pointer to the\r
                               ParameterBlock structure which\r
@@ -127,10 +123,10 @@ EFI_STATUS
   IN CONST  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL *This,\r
   IN CONST  EFI_HANDLE  ControllerHandle,\r
   IN CONST  EFI_HANDLE  ChildHandle OPTIONAL,\r
-  IN OUT    UINTN       *Instance,\r
-  IN OUT    EFI_GUID    **ParameterTypeGuid,\r
-  IN OUT    VOID        **ParameterBlock,\r
-  IN OUT    UINTN       *ParameterBlockSize\r
+  IN CONST  UINTN       *Instance,\r
+  OUT       EFI_GUID    **ParameterTypeGuid,\r
+  OUT       VOID        **ParameterBlock,\r
+  OUT       UINTN       *ParameterBlockSize\r
 );\r
 \r
 typedef enum {\r
@@ -221,6 +217,8 @@ typedef enum {
                             Instance Instance data returned from\r
                             Query().\r
 \r
+  @param Instance           Instance data passed to Query().\r
+\r
   @param ParameterTypeGuid  ParameterTypeGuid returned from Query.\r
 \r
   @param ParameterBlock     ParameterBlock returned from Query.\r