Fix the comments in the core interface to follow the UEFI Spec regarding how to check...

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

/** @file\r
  EFI Driver Diagnostics Protocol\r
\r
Copyright (c) 2006 - 2011, 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
#ifndef __EFI_DRIVER_DIAGNOSTICS_H__\r
#define __EFI_DRIVER_DIAGNOSTICS_H__\r
\r
///\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
    0x0784924f, 0xe296, 0x11d4, {0x9a, 0x49, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
  }\r
\r
typedef struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL  EFI_DRIVER_DIAGNOSTICS_PROTOCOL;\r
\r
typedef enum {\r
  ///\r
  /// Performs standard diagnostics on the controller.\r
  ///\r
  EfiDriverDiagnosticTypeStandard     = 0,\r
  ///\r
  /// This is an optional diagnostic type that performs diagnostics on the controller that may\r
  /// take an extended amount of time to execute.\r
  ///\r
  EfiDriverDiagnosticTypeExtended     = 1,\r
  ///\r
  /// This is an optional diagnostic type that performs diagnostics on the controller that are\r
  /// suitable for a manufacturing and test environment.\r
  ///\r
  EfiDriverDiagnosticTypeManufacturing= 2,\r
  EfiDriverDiagnosticTypeMaximum\r
} EFI_DRIVER_DIAGNOSTIC_TYPE;\r
\r
/**\r
  Runs diagnostics on a controller.\r
\r
  @param  This             A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL instance.\r
  @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
                           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
                           specified by ControllerHandle and ChildHandle.   See\r
                           "Related Definitions" for the list of supported types.\r
  @param  Language         A pointer to a three character ISO 639-2 language\r
                           identifier.  This is the language in which the optional\r
                           error message should be returned in Buffer, and it must\r
                           match one of the languages specified in SupportedLanguages.\r
                           The number of languages supported by a driver is up to\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 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
                           to free it with a call to FreePool().\r
\r
  @retval EFI_SUCCESS           The controller specified by ControllerHandle and\r
                                ChildHandle passed the diagnostic.\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 Buffer is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                running diagnostics for the controller specified\r
                                by ControllerHandle and ChildHandle.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the\r
                                type of diagnostic specified by DiagnosticType.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the\r
                                language specified by Language.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to complete\r
                                the diagnostics.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to return\r
                                the status information in ErrorType, BufferSize,\r
                                and Buffer.\r
  @retval EFI_DEVICE_ERROR      The controller specified by ControllerHandle and\r
                                ChildHandle did not pass the diagnostic.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS)(\r
  IN EFI_DRIVER_DIAGNOSTICS_PROTOCOL                        *This,\r
  IN  EFI_HANDLE                                            ControllerHandle,\r
  IN  EFI_HANDLE                                            ChildHandle  OPTIONAL,\r
  IN  EFI_DRIVER_DIAGNOSTIC_TYPE                            DiagnosticType,\r
  IN  CHAR8                                                 *Language,\r
  OUT EFI_GUID                                              **ErrorType,\r
  OUT UINTN                                                 *BufferSize,\r
  OUT CHAR16                                                **Buffer\r
  );\r
\r
///\r
/// Used to perform diagnostics on a controller that an EFI Driver is managing.\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 4646\r
  /// language codes.  This is the list of language codes that this protocol supports.  \r
  ///  \r
  CHAR8                                   *SupportedLanguages;\r
};\r
\r
extern EFI_GUID gEfiDriverDiagnosticsProtocolGuid;\r
\r
#endif\r