Synchronized with UEFI Spec

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

MdePkg/Include/Protocol/DriverDiagnostics2.h

@@ -56,6 +56,9 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
 
   @retval EFI_SUCCESS           The controller specified by ControllerHandle and
                                 ChildHandle passed the diagnostic.
+  @retval EFI_ACCESS_DENIED     The request for initiating diagnostics was unable
+                                to be complete due to some underlying hardware or
+                                software state.
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
   @retval EFI_INVALID_PARAMETER Language is NULL.

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