| 4b120077 |
1 | /** @file\r |
| 2 | EFI Driver Diagnostics Protocol\r |
| 3 | \r |
| 4 | Copyright (c) 2006, Intel Corporation \r |
| 5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this distribution. The full text of the license may be found at \r |
| 8 | http://opensource.org/licenses/bsd-license.php \r |
| 9 | \r |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 12 | \r |
| 4b120077 |
13 | **/\r |
| 14 | \r |
| 15 | #ifndef __EFI_DRIVER_DIAGNOSTICS2_H__\r |
| 16 | #define __EFI_DRIVER_DIAGNOSTICS2_H__\r |
| 17 | \r |
| 18 | #include <Protocol/DriverDiagnostics.h>\r |
| 19 | \r |
| 20 | #define EFI_DRIVER_DIAGNOSTICS2_PROTOCOL_GUID \\r |
| 21 | { \\r |
| 22 | 0x4d330321, 0x025f, 0x4aac, {0x90, 0xd8, 0x5e, 0xd9, 0x00, 0x17, 0x3b, 0x63 } \\r |
| 23 | }\r |
| 24 | \r |
| 25 | typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL EFI_DRIVER_DIAGNOSTICS2_PROTOCOL;\r |
| 26 | \r |
| 27 | /**\r |
| 28 | Runs diagnostics on a controller.\r |
| 29 | \r |
| 30 | @param This A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL instance.\r |
| 31 | @param ControllerHandle The handle of the controller to run diagnostics on.\r |
| 32 | @param ChildHandle The handle of the child controller to run diagnostics on\r |
| 33 | This is an optional parameter that may be NULL. It will\r |
| 34 | be NULL for device drivers. It will also be NULL for a\r |
| 35 | bus drivers that wish to run diagnostics on the bus\r |
| 36 | controller. It will not be NULL for a bus driver that\r |
| 37 | wishes to run diagnostics on one of its child controllers.\r |
| 38 | @param DiagnosticType Indicates type of diagnostics to perform on the controller\r |
| 39 | specified by ControllerHandle and ChildHandle. See\r |
| 40 | "Related Definitions" for the list of supported types.\r |
| 41 | @param Language A pointer to a three character ISO 639-2 language\r |
| 42 | identifier. This is the language in which the optional\r |
| 43 | error message should be returned in Buffer, and it must\r |
| 44 | match one of the languages specified in SupportedLanguages.\r |
| 45 | The number of languages supported by a driver is up to\r |
| 46 | the driver writer.\r |
| 47 | @param ErrorType A GUID that defines the format of the data returned in Buffer.\r |
| 48 | @param BufferSize The size, in bytes, of the data returned in Buffer.\r |
| 49 | @param Buffer A buffer that contains a Null-terminated Unicode string\r |
| 50 | plus some additional data whose format is defined by\r |
| 51 | ErrorType. Buffer is allocated by this function with\r |
| 52 | AllocatePool(), and it is the caller's responsibility\r |
| 53 | to free it with a call to FreePool().\r |
| 54 | \r |
| 55 | @retval EFI_SUCCESS The controller specified by ControllerHandle and\r |
| 56 | ChildHandle passed the diagnostic.\r |
| 57 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r |
| 58 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r |
| 59 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
| 60 | @retval EFI_INVALID_PARAMETER ErrorType is NULL.\r |
| 61 | @retval EFI_INVALID_PARAMETER BufferType is NULL.\r |
| 62 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r |
| 63 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
| 64 | running diagnostics for the controller specified\r |
| 65 | by ControllerHandle and ChildHandle.\r |
| 66 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r |
| 67 | type of diagnostic specified by DiagnosticType.\r |
| 68 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r |
| 69 | language specified by Language.\r |
| 70 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete\r |
| 71 | the diagnostics.\r |
| 72 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to return\r |
| 73 | the status information in ErrorType, BufferSize,\r |
| 74 | and Buffer.\r |
| 75 | @retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and\r |
| 76 | ChildHandle did not pass the diagnostic.\r |
| 77 | \r |
| 78 | **/\r |
| 79 | typedef\r |
| 80 | EFI_STATUS\r |
| 8b13229b |
81 | (EFIAPI *EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS)(\r |
| 4b120077 |
82 | IN EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *This,\r |
| 83 | IN EFI_HANDLE ControllerHandle,\r |
| 84 | IN EFI_HANDLE ChildHandle OPTIONAL,\r |
| 85 | IN EFI_DRIVER_DIAGNOSTIC_TYPE DiagnosticType,\r |
| 86 | IN CHAR8 *Language,\r |
| 87 | OUT EFI_GUID **ErrorType,\r |
| 88 | OUT UINTN *BufferSize,\r |
| 89 | OUT CHAR16 **Buffer\r |
| 90 | );\r |
| 91 | \r |
| 92 | \r |
| 93 | //\r |
| 94 | //\r |
| 95 | \r |
| 96 | /**\r |
| 97 | Interface structure for the Driver Diagnostics Protocol.\r |
| 98 | \r |
| 99 | @par Protocol Description:\r |
| 100 | Used to perform diagnostics on a controller that an EFI Driver is managing.\r |
| 101 | \r |
| 102 | @param RunDiagnostics Runs diagnostics on a controller.\r |
| 103 | @param SupportedLanguages A Null-terminated ASCII string that\r |
| 104 | contains one or more RFC 3066\r |
| 105 | language codes. This is the list\r |
| 106 | of language codes that this\r |
| 107 | protocol supports.\r |
| 108 | \r |
| 109 | **/\r |
| 110 | struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL {\r |
| 111 | EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS RunDiagnostics;\r |
| 112 | CHAR8 *SupportedLanguages;\r |
| 113 | };\r |
| 114 | \r |
| 115 | extern EFI_GUID gEfiDriverDiagnostics2ProtocolGuid;\r |
| 116 | \r |
| 117 | #endif\r |
projects / mirror_edk2.git / blame