MdePkg: Add UEFI2.5 Ramdisk device path definition

[mirror_edk2.git] / MdePkg / Include / Protocol / DriverDiagnostics.h

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index f3683f3304053298364c76d01964719f72789a7b..916e4a5d629392bd86f51e696973c0bf159253ff 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -1,14 +1,14 @@
 /** @file\r
   EFI Driver Diagnostics Protocol\r
 \r
 /** @file\r
   EFI Driver Diagnostics Protocol\r
 \r

-  Copyright (c) 2006 - 2008, 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) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -16,7 +16,7 @@
 #define __EFI_DRIVER_DIAGNOSTICS_H__\r
 \r
 ///\r
 #define __EFI_DRIVER_DIAGNOSTICS_H__\r
 \r
 ///\r

-/// Global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.\r
+/// The global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.\r

 ///\r
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
   { \\r
 ///\r
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
   { \\r


@@ -40,6 +40,12 @@ typedef enum {
   /// suitable for a manufacturing and test environment.\r
   ///\r
   EfiDriverDiagnosticTypeManufacturing= 2,\r
   /// suitable for a manufacturing and test environment.\r
   ///\r
   EfiDriverDiagnosticTypeManufacturing= 2,\r

+  ///\r
+  /// This is an optional diagnostic type that would only be used in the situation where an \r
+  /// EFI_NOT_READY had been returned by a previous call to RunDiagnostics()\r
+  /// and there is a desire to cancel the current running diagnostics operation.\r
+  ///\r
+  EfiDriverDiagnosticTypeCancel       = 3,\r

   EfiDriverDiagnosticTypeMaximum\r
 } EFI_DRIVER_DIAGNOSTIC_TYPE;\r
 \r
   EfiDriverDiagnosticTypeMaximum\r
 } EFI_DRIVER_DIAGNOSTIC_TYPE;\r
 \r


@@ -65,7 +71,7 @@ typedef enum {
                            the driver writer.\r
   @param  ErrorType        A GUID that defines the format of the data returned in Buffer.\r
   @param  BufferSize       The size, in bytes, of the data returned in Buffer.\r
                            the driver writer.\r
   @param  ErrorType        A GUID that defines the format of the data returned in Buffer.\r
   @param  BufferSize       The size, in bytes, of the data returned in Buffer.\r

-  @param  Buffer           A buffer that contains a Null-terminated Unicode string\r
+  @param  Buffer           A buffer that contains a Null-terminated string\r

                            plus some additional data whose format is defined by\r
                            ErrorType.  Buffer is allocated by this function with\r
                            AllocatePool(), and it is the caller's responsibility\r
                            plus some additional data whose format is defined by\r
                            ErrorType.  Buffer is allocated by this function with\r
                            AllocatePool(), and it is the caller's responsibility\r


@@ -73,8 +79,8 @@ typedef enum {
 \r
   @retval EFI_SUCCESS           The controller specified by ControllerHandle and\r
                                 ChildHandle passed the diagnostic.\r
 \r
   @retval EFI_SUCCESS           The controller specified by ControllerHandle and\r
                                 ChildHandle passed the diagnostic.\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 ControllerHandle is NULL.\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
   @retval EFI_INVALID_PARAMETER ErrorType is NULL.\r
   @retval EFI_INVALID_PARAMETER BufferType is NULL.\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
   @retval EFI_INVALID_PARAMETER ErrorType is NULL.\r
   @retval EFI_INVALID_PARAMETER BufferType is NULL.\r


@@ -114,7 +120,7 @@ EFI_STATUS
 struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL {\r
   EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS  RunDiagnostics;\r
   ///\r
 struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL {\r
   EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS  RunDiagnostics;\r
   ///\r

-  /// A Null-terminated ASCII string that contains one or more RFC 3066\r
+  /// A Null-terminated ASCII string that contains one or more ISO 639-2\r

   /// language codes.  This is the list of language codes that this protocol supports.  \r
   ///  \r
   CHAR8                                   *SupportedLanguages;\r
   /// language codes.  This is the list of language codes that this protocol supports.  \r
   ///  \r
   CHAR8                                   *SupportedLanguages;\r