/**@file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
-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
+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
\r
Module Name:\r
\r
Arguments:\r
This - A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL instance.\r
ControllerHandle - The handle of the controller to run diagnostics on.\r
- 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
+ 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
- DiagnosticType - Indicates type of diagnostics to perform on the controller \r
- specified by ControllerHandle and ChildHandle. See \r
+ 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
- Language - A pointer to a three character ISO 639-2 language \r
+ Language - A pointer to a three character ISO 639-2 language\r
identifier or a Null-terminated ASCII string array indicating\r
the language. This is the language in which the optional\r
- error message should be returned in Buffer, and it must \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
- ErrorType - A GUID that defines the format of the data returned in \r
- Buffer. \r
- BufferSize - The size, in bytes, of the data returned in Buffer. \r
- Buffer - A buffer that contains a Null-terminated Unicode 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
+ The number of languages supported by a driver is up to\r
+ the driver writer.\r
+ ErrorType - A GUID that defines the format of the data returned in\r
+ Buffer.\r
+ BufferSize - The size, in bytes, of the data returned in Buffer.\r
+ Buffer - A buffer that contains a Null-terminated Unicode 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
Returns:\r
- EFI_SUCCESS - The controller specified by ControllerHandle and \r
+ EFI_SUCCESS - The controller specified by ControllerHandle and\r
ChildHandle passed the diagnostic.\r
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
- EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid \r
+ EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid\r
EFI_HANDLE.\r
EFI_INVALID_PARAMETER - Language is NULL.\r
EFI_INVALID_PARAMETER - ErrorType is NULL.\r
EFI_INVALID_PARAMETER - BufferType is NULL.\r
EFI_INVALID_PARAMETER - Buffer is NULL.\r
- EFI_UNSUPPORTED - The driver specified by This does not support \r
- running diagnostics for the controller specified \r
+ EFI_UNSUPPORTED - The driver specified by This does not support\r
+ running diagnostics for the controller specified\r
by ControllerHandle and ChildHandle.\r
- EFI_UNSUPPORTED - The driver specified by This does not support the \r
+ EFI_UNSUPPORTED - The driver specified by This does not support the\r
type of diagnostic specified by DiagnosticType.\r
- EFI_UNSUPPORTED - The driver specified by This does not support the \r
+ EFI_UNSUPPORTED - The driver specified by This does not support the\r
language specified by Language.\r
EFI_OUT_OF_RESOURCES - There are not enough resources available to complete\r
the diagnostics.\r
EFI_OUT_OF_RESOURCES - There are not enough resources available to return\r
- the status information in ErrorType, BufferSize, \r
+ the status information in ErrorType, BufferSize,\r
and Buffer.\r
- EFI_DEVICE_ERROR - The controller specified by ControllerHandle and \r
+ EFI_DEVICE_ERROR - The controller specified by ControllerHandle and\r
ChildHandle did not pass the diagnostic.\r
\r
--*/\r
projects / mirror_edk2.git / blobdiff