2 Main file for DrvDiag shell Driver1 function.
4 Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiShellDriver1CommandsLib.h"
17 STATIC CONST EFI_GUID
*DiagGuidList
[] = {&gEfiDriverDiagnosticsProtocolGuid
, &gEfiDriverDiagnostics2ProtocolGuid
, NULL
};
19 // We need 1 more item on the list...
22 TestModeStandard
= EfiDriverDiagnosticTypeStandard
,
23 TestModeExtended
= EfiDriverDiagnosticTypeExtended
,
24 TestModeManufacturing
= EfiDriverDiagnosticTypeManufacturing
,
30 Do the diagnostics call for some set of handles.
32 @param[in] Mode The type of diagnostic test to run.
33 @param[in] Lang The language code to use.
34 @param[in] AllChilds Should the test be on all children.
35 @param[in] DriverHandle The driver handle to test with.
36 @param[in] ControllerHandle The specific controller handle to test.
37 @param[in] ChildHandle The specific child handle to test.
39 @retval EFI_SUCCESS The operation was successful.
40 @retval EFI_INVALID_PARAMETER A parameter had an invalid value.
41 @retval EFI_NOT_FOUND No diagnostic handle could be found.
46 IN CONST DRV_DIAG_TEST_MODE Mode
,
48 IN CONST BOOLEAN AllChilds
,
49 IN CONST EFI_HANDLE DriverHandle
,
50 IN CONST EFI_HANDLE ControllerHandle
,
51 IN CONST EFI_HANDLE ChildHandle
54 EFI_DRIVER_DIAGNOSTICS_PROTOCOL
*DriverDiagnostics
;
55 EFI_DRIVER_DIAGNOSTICS2_PROTOCOL
*DriverDiagnostics2
;
56 EFI_HANDLE
*DriverHandleList
;
57 EFI_HANDLE
*ControllerHandleList
;
58 EFI_HANDLE
*ChildHandleList
;
60 UINTN DriverHandleListCount
;
61 UINTN ControllerHandleListCount
;
62 UINTN ChildHandleListCount
;
63 UINTN DriverHandleListLoop
;
64 UINTN ControllerHandleListLoop
;
65 UINTN ChildHandleListLoop
;
76 if ((ChildHandle
!= NULL
&& AllChilds
) || (Mode
>= TestModeMax
)){
77 return (EFI_INVALID_PARAMETER
);
80 DriverDiagnostics
= NULL
;
81 DriverDiagnostics2
= NULL
;
83 Status2
= EFI_SUCCESS
;
84 DriverHandleList
= NULL
;
85 ControllerHandleList
= NULL
;
86 ChildHandleList
= NULL
;
90 DriverHandleListCount
= 0;
91 ControllerHandleListCount
= 0;
92 ChildHandleListCount
= 0;
94 if (DriverHandle
!= NULL
) {
95 DriverHandleList
= AllocateZeroPool(2*sizeof(EFI_HANDLE
));
96 ASSERT(DriverHandleList
!=NULL
);
97 DriverHandleList
[0] = DriverHandle
;
98 DriverHandleListCount
= 1;
100 DriverHandleList
= GetHandleListByProtocolList(DiagGuidList
);
101 if (DriverHandleList
== NULL
) {
102 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROTOCOL_NF
), gShellDriver1HiiHandle
, L
"gEfiDriverDiagnosticsProtocolGuid", &gEfiDriverDiagnosticsProtocolGuid
);
103 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROTOCOL_NF
), gShellDriver1HiiHandle
, L
"gEfiDriverDiagnostics2ProtocolGuid", &gEfiDriverDiagnostics2ProtocolGuid
);
104 return (EFI_NOT_FOUND
);
106 for (Walker
= DriverHandleList
; Walker
!= NULL
&& *Walker
!= NULL
; DriverHandleListCount
++, Walker
++);
109 if (ControllerHandle
!= NULL
) {
110 ControllerHandleList
= AllocateZeroPool(2*sizeof(EFI_HANDLE
));
111 ASSERT(ControllerHandleList
!=NULL
);
112 ControllerHandleList
[0] = ControllerHandle
;
113 ControllerHandleListCount
= 1;
115 ControllerHandleList
= NULL
;
118 if (ChildHandle
!= NULL
) {
119 ChildHandleList
= AllocateZeroPool(2*sizeof(EFI_HANDLE
));
120 ASSERT(ChildHandleList
!=NULL
);
121 ChildHandleList
[0] = ChildHandle
;
122 ChildHandleListCount
= 1;
123 } else if (AllChilds
) {
124 ChildHandleList
= NULL
;
126 // This gets handled in the loop below.
129 ChildHandleList
= NULL
;
132 if (Mode
== TestModeList
) {
133 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_HEADER
), gShellDriver1HiiHandle
);
135 for (DriverHandleListLoop
= 0
136 ; DriverHandleListLoop
< DriverHandleListCount
137 ; DriverHandleListLoop
++
139 if (Mode
== TestModeList
) {
140 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_DRIVER_HEADER
), gShellDriver1HiiHandle
, ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]));
142 if (ControllerHandle
== NULL
) {
143 PARSE_HANDLE_DATABASE_DEVICES(DriverHandleList
[DriverHandleListLoop
], &ControllerHandleListCount
, &ControllerHandleList
);
145 if (ControllerHandleListCount
== 0) {
146 if (Mode
== TestModeList
) {
147 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_DRIVER_NO_HANDLES
), gShellDriver1HiiHandle
);
150 if (Mode
== TestModeList
) {
151 ShellPrintEx(-1, -1, L
"\r\n");
153 for (ControllerHandleListLoop
= 0
154 ; ControllerHandleListLoop
< ControllerHandleListCount
155 ; ControllerHandleListLoop
++
158 ASSERT(ChildHandleList
== NULL
);
159 PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(
160 DriverHandleList
[DriverHandleListLoop
],
161 ControllerHandleList
[ControllerHandleListLoop
],
162 &ChildHandleListCount
,
165 for (ChildHandleListLoop
= 0
166 ; (ChildHandleListLoop
< ChildHandleListCount
|| ChildHandleList
== NULL
)
167 ; ChildHandleListLoop
++
170 if (Mode
!= TestModeList
) {
171 if (Lang
== NULL
|| Lang
[2] == '-') {
173 // Get the protocol pointer and call the function
175 Status
= gBS
->OpenProtocol(
176 DriverHandleList
[DriverHandleListLoop
],
177 &gEfiDriverDiagnostics2ProtocolGuid
,
178 (VOID
**)&DriverDiagnostics2
,
181 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
182 if (!EFI_ERROR(Status
) && (DriverDiagnostics2
!= NULL
)) {
183 Language
= GetBestLanguageForDriver(DriverDiagnostics2
->SupportedLanguages
, Lang
, FALSE
);
185 Status
= DriverDiagnostics2
->RunDiagnostics(
187 ControllerHandleList
[ControllerHandleListLoop
],
188 ChildHandleList
== NULL
?NULL
:ChildHandleList
[ChildHandleListLoop
],
189 (EFI_DRIVER_DIAGNOSTIC_TYPE
)Mode
,
197 if (!Found
&& (Lang
== NULL
||(Lang
!=NULL
&&(Lang
[2]!='-')))){
198 Status
= gBS
->OpenProtocol(
199 DriverHandleList
[DriverHandleListLoop
],
200 &gEfiDriverDiagnosticsProtocolGuid
,
201 (VOID
**)&DriverDiagnostics
,
204 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
205 if (!EFI_ERROR(Status
)) {
206 Language
= GetBestLanguageForDriver(DriverDiagnostics
->SupportedLanguages
, Lang
, FALSE
);
207 Status
= DriverDiagnostics
->RunDiagnostics(
209 ControllerHandleList
[ControllerHandleListLoop
],
210 ChildHandleList
== NULL
?NULL
:ChildHandleList
[ChildHandleListLoop
],
211 (EFI_DRIVER_DIAGNOSTIC_TYPE
)Mode
,
219 if (EFI_ERROR(Status
)) {
222 HandleIndex1
= ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]);
223 HandleIndex2
= ConvertHandleToHandleIndex(ControllerHandleList
[ControllerHandleListLoop
]);
228 STRING_TOKEN (STR_3P_RESULT
),
229 gShellDriver1HiiHandle
,
233 ChildHandleList
== NULL
?0:ConvertHandleToHandleIndex(ChildHandleList
[ChildHandleListLoop
]),
235 if (OutBuffer
!=NULL
) {
239 if (ErrorType
!=NULL
) {
244 HandleIndex1
= ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]);
245 HandleIndex2
= ConvertHandleToHandleIndex(ControllerHandleList
[ControllerHandleListLoop
]);
247 // Print out the information that this set can be tested
253 STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE
),
254 gShellDriver1HiiHandle
,
257 ChildHandleList
== NULL
?0:ConvertHandleToHandleIndex(ChildHandleList
[ChildHandleListLoop
])
262 // If we are doing a single pass with NULL child jump out after a single loop
264 if (ChildHandleList
== NULL
) {
269 SHELL_FREE_NON_NULL(ChildHandleList
);
270 ChildHandleList
= NULL
;
271 ChildHandleListCount
= 0;
274 if (ControllerHandle
== NULL
) {
275 SHELL_FREE_NON_NULL(ControllerHandleList
);
276 ControllerHandleList
= NULL
;
277 ControllerHandleListCount
= 0;
282 if (DriverHandleList
!= NULL
) {
283 FreePool(DriverHandleList
);
285 if (ControllerHandleList
!= NULL
) {
286 FreePool(ControllerHandleList
);
288 if (ChildHandleList
!= NULL
) {
289 FreePool(ChildHandleList
);
295 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
305 Function for 'drvdiag' command.
307 @param[in] ImageHandle Handle to the Image (NULL if Internal).
308 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
312 ShellCommandRunDrvDiag (
313 IN EFI_HANDLE ImageHandle
,
314 IN EFI_SYSTEM_TABLE
*SystemTable
319 CHAR16
*ProblemParam
;
320 SHELL_STATUS ShellStatus
;
321 DRV_DIAG_TEST_MODE Mode
;
323 CONST CHAR16
*DriverHandleStr
;
324 CONST CHAR16
*ControllerHandleStr
;
325 CONST CHAR16
*ChildHandleStr
;
332 ShellStatus
= SHELL_SUCCESS
;
337 // initialize the shell lib (we must be in non-auto-init...)
339 Status
= ShellInitialize();
340 ASSERT_EFI_ERROR(Status
);
342 Status
= CommandInit();
343 ASSERT_EFI_ERROR(Status
);
346 // parse the command line
348 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
349 if (EFI_ERROR(Status
)) {
350 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
351 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, ProblemParam
);
352 FreePool(ProblemParam
);
353 ShellStatus
= SHELL_INVALID_PARAMETER
;
359 // if more than 3 'value' parameters (plus the name one) or we have any 2 mode flags
361 if ((ShellCommandLineGetCount(Package
) > 4)
362 ||(ShellCommandLineGetFlag(Package
, L
"-s") && ShellCommandLineGetFlag(Package
, L
"-e"))
363 ||(ShellCommandLineGetFlag(Package
, L
"-s") && ShellCommandLineGetFlag(Package
, L
"-m"))
364 ||(ShellCommandLineGetFlag(Package
, L
"-e") && ShellCommandLineGetFlag(Package
, L
"-m"))
367 // error for too many parameters
369 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
);
370 ShellStatus
= SHELL_INVALID_PARAMETER
;
371 } else if ((ShellCommandLineGetFlag(Package
, L
"-s"))
372 || (ShellCommandLineGetFlag(Package
, L
"-e"))
373 || (ShellCommandLineGetFlag(Package
, L
"-m"))
376 // Run the apropriate test
378 if (ShellCommandLineGetFlag(Package
, L
"-s")) {
379 Mode
= TestModeStandard
;
380 } else if (ShellCommandLineGetFlag(Package
, L
"-e")) {
381 Mode
= TestModeExtended
;
382 } else if (ShellCommandLineGetFlag(Package
, L
"-m")) {
383 Mode
= TestModeManufacturing
;
389 // Do a listing of what's available to test
394 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
395 if (ShellCommandLineGetFlag(Package
, L
"-l") && Lang
== NULL
) {
396 ASSERT(Language
== NULL
);
397 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"-l");
398 ShellCommandLineFreeVarList (Package
);
399 return (SHELL_INVALID_PARAMETER
);
400 } else if (Lang
!= NULL
) {
401 Language
= AllocateZeroPool(StrSize(Lang
));
402 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
405 DriverHandleStr
= ShellCommandLineGetRawValue(Package
, 1);
406 ControllerHandleStr
= ShellCommandLineGetRawValue(Package
, 2);
407 ChildHandleStr
= ShellCommandLineGetRawValue(Package
, 3);
409 if (DriverHandleStr
== NULL
) {
412 ShellConvertStringToUint64(DriverHandleStr
, &Intermediate
, TRUE
, FALSE
);
413 Handle1
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
415 if (ControllerHandleStr
== NULL
) {
418 ShellConvertStringToUint64(ControllerHandleStr
, &Intermediate
, TRUE
, FALSE
);
419 Handle2
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
421 if (ChildHandleStr
== NULL
) {
424 ShellConvertStringToUint64(ChildHandleStr
, &Intermediate
, TRUE
, FALSE
);
425 Handle3
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
428 Status
= DoDiagnostics (
431 ShellCommandLineGetFlag(Package
, L
"-c"),
437 SHELL_FREE_NON_NULL(Language
);
438 ShellCommandLineFreeVarList (Package
);
441 if (ShellStatus
== SHELL_SUCCESS
) {
442 if (Status
== EFI_SECURITY_VIOLATION
) {
443 ShellStatus
= SHELL_SECURITY_VIOLATION
;
444 } else if (Status
== EFI_INVALID_PARAMETER
) {
445 ShellStatus
= SHELL_INVALID_PARAMETER
;
446 } else if (Status
== EFI_NOT_FOUND
) {
447 ShellStatus
= SHELL_NOT_FOUND
;
448 } else if (EFI_ERROR(Status
)) {
449 ShellStatus
= SHELL_NOT_FOUND
;
453 return (ShellStatus
);