X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FDriverDiagnostics.h;h=36a2cc2826838695c8eb7effb0c1a707da52b372;hb=61f2ab909d473aaf6faa278424287685a2c502fe;hp=6c794be50d0efd1e5fdbd332a6b3f50a213614f8;hpb=3909993808a3d1dd6432bde1cb186e759e8db78d;p=mirror_edk2.git

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index 6c794be50d..36a2cc2826 100644
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -1,14 +1,14 @@
 /** @file
   EFI Driver Diagnostics Protocol
 
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         
-  All rights reserved. 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        
-  http://opensource.org/licenses/bsd-license.php                                            
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+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
+http://opensource.org/licenses/bsd-license.php.                                          
+    
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 
 **/
 
@@ -16,7 +16,7 @@
 #define __EFI_DRIVER_DIAGNOSTICS_H__
 
 ///
-/// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.
+/// The global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.
 ///
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \
   { \
@@ -26,8 +26,19 @@
 typedef struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL  EFI_DRIVER_DIAGNOSTICS_PROTOCOL;
 
 typedef enum {
+  ///
+  /// Performs standard diagnostics on the controller.
+  ///
   EfiDriverDiagnosticTypeStandard     = 0,
+  ///
+  /// This is an optional diagnostic type that performs diagnostics on the controller that may
+  /// take an extended amount of time to execute.
+  ///
   EfiDriverDiagnosticTypeExtended     = 1,
+  ///
+  /// This is an optional diagnostic type that performs diagnostics on the controller that are
+  /// suitable for a manufacturing and test environment.
+  ///
   EfiDriverDiagnosticTypeManufacturing= 2,
   EfiDriverDiagnosticTypeMaximum
 } EFI_DRIVER_DIAGNOSTIC_TYPE;
@@ -54,7 +65,7 @@ typedef enum {
                            the driver writer.
   @param  ErrorType        A GUID that defines the format of the data returned in Buffer.
   @param  BufferSize       The size, in bytes, of the data returned in Buffer.
-  @param  Buffer           A buffer that contains a Null-terminated Unicode string
+  @param  Buffer           A buffer that contains a Null-terminated string
                            plus some additional data whose format is defined by
                            ErrorType.  Buffer is allocated by this function with
                            AllocatePool(), and it is the caller's responsibility
@@ -62,8 +73,8 @@ typedef enum {
 
   @retval EFI_SUCCESS           The controller specified by ControllerHandle and
                                 ChildHandle passed the diagnostic.
-  @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 ControllerHandle is NULL.
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
   @retval EFI_INVALID_PARAMETER Language is NULL.
   @retval EFI_INVALID_PARAMETER ErrorType is NULL.
   @retval EFI_INVALID_PARAMETER BufferType is NULL.
@@ -97,24 +108,15 @@ EFI_STATUS
   OUT CHAR16                                                **Buffer
   );
 
-
-//
-//
-
-/**
-  Interface structure for the Driver Diagnostics Protocol.
-
-  @par Protocol Description:
-  Used to perform diagnostics on a controller that an EFI Driver is managing.
-
-  @param RunDiagnostics      Runs diagnostics on a controller.
-  @param SupportedLanguages  A Null-terminated ASCII string that contains one or more
-                             ISO 639-2 language codes.  This is the list of language 
-                             codes that this protocol supports.
-
-**/
+///
+/// Used to perform diagnostics on a controller that an EFI Driver is managing.
+///
 struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL {
   EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS  RunDiagnostics;
+  ///
+  /// A Null-terminated ASCII string that contains one or more ISO 639-2
+  /// language codes.  This is the list of language codes that this protocol supports.  
+  ///  
   CHAR8                                   *SupportedLanguages;
 };