MdePkg: Apply uncrustify changes

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

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics2.h b/MdePkg/Include/Protocol/DriverDiagnostics2.h
index a3798b1e543cae51871a133130d3159cd27c9d3b..54fb9f6b954287039977ede8390144ac76842110 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics2.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics2.h
@@ -1,14 +1,8 @@
 /** @file\r
   UEFI Driver Diagnostics2 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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -21,8 +15,8 @@
   { \\r
     0x4d330321, 0x025f, 0x4aac, {0x90, 0xd8, 0x5e, 0xd9, 0x00, 0x17, 0x3b, 0x63 } \\r
   }\r
-  \r
-typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOCOL;\r
+\r
+typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL EFI_DRIVER_DIAGNOSTICS2_PROTOCOL;\r
 \r
 /**\r
   Runs diagnostics on a controller.\r
@@ -31,11 +25,11 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
   @param  ControllerHandle The handle of the controller to run diagnostics on.\r
   @param  ChildHandle      The handle of the child controller to run diagnostics on\r
                            This is an optional parameter that may be NULL.  It will\r
-                           be NULL for device drivers.  It will also be NULL for a\r
+                           be NULL for device drivers.  It will also be NULL for\r
                            bus drivers that wish to run diagnostics on the bus\r
                            controller.  It will not be NULL for a bus driver that\r
                            wishes to run diagnostics on one of its child controllers.\r
-  @param  DiagnosticType   Indicates type of diagnostics to perform on the controller\r
+  @param  DiagnosticType   Indicates the type of diagnostics to perform on the controller\r
                            specified by ControllerHandle and ChildHandle.   See\r
                            "Related Definitions" for the list of supported types.\r
   @param  Language         A pointer to a Null-terminated ASCII string\r
@@ -45,7 +39,7 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
                            languages specified in SupportedLanguages.\r
                            The number of languages supported by a\r
                            driver is up to the driver writer. Language\r
-                           is specified in RFC 3066 language code format.\r
+                           is specified in RFC 4646 language code format.\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
@@ -56,7 +50,10 @@ 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_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\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 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
@@ -95,14 +92,14 @@ EFI_STATUS
 /// Used to perform diagnostics on a controller that an EFI Driver is managing.\r
 ///\r
 struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL {\r
-  EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS RunDiagnostics;\r
+  EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS    RunDiagnostics;\r
+  ///\r
+  /// A Null-terminated ASCII string that contains one or more RFC 4646\r
+  /// language codes.  This is the list of language codes that this protocol supports.\r
   ///\r
-  /// A Null-terminated ASCII string that contains one or more RFC 3066\r
-  /// language codes.  This is the list of language codes that this protocol supports.  \r
-  ///    \r
-  CHAR8                                   *SupportedLanguages;\r
+  CHAR8                                      *SupportedLanguages;\r
 };\r
 \r
-extern EFI_GUID gEfiDriverDiagnostics2ProtocolGuid;\r
+extern EFI_GUID  gEfiDriverDiagnostics2ProtocolGuid;\r
 \r
 #endif\r