2 Main file for DrvDiag shell Driver1 function.
4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "UefiShellDriver1CommandsLib.h"
18 STATIC CONST EFI_GUID
*DiagGuidList
[] = {&gEfiDriverDiagnosticsProtocolGuid
, &gEfiDriverDiagnostics2ProtocolGuid
, NULL
};
20 // We need 1 more item on the list...
23 TestModeStandard
= EfiDriverDiagnosticTypeStandard
,
24 TestModeExtended
= EfiDriverDiagnosticTypeExtended
,
25 TestModeManufacturing
= EfiDriverDiagnosticTypeManufacturing
,
31 Do the diagnostics call for some set of handles.
33 @param[in] Mode The type of diagnostic test to run.
34 @param[in] Lang The language code to use.
35 @param[in] AllChilds Should the test be on all children.
36 @param[in] DriverHandle The driver handle to test with.
37 @param[in] ControllerHandle The specific controller handle to test.
38 @param[in] ChildHandle The specific child handle to test.
40 @retval EFI_SUCCESS The operation was successful.
41 @retval EFI_INVALID_PARAMETER A parameter had an invalid value.
42 @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 if (DriverHandleList
== NULL
) {
97 return EFI_OUT_OF_RESOURCES
;
99 DriverHandleList
[0] = DriverHandle
;
100 DriverHandleListCount
= 1;
102 DriverHandleList
= GetHandleListByProtocolList(DiagGuidList
);
103 if (DriverHandleList
== NULL
) {
104 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROTOCOL_NF
), gShellDriver1HiiHandle
, L
"drvdiag", L
"gEfiDriverDiagnosticsProtocolGuid", &gEfiDriverDiagnosticsProtocolGuid
);
105 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROTOCOL_NF
), gShellDriver1HiiHandle
, L
"drvdiag", L
"gEfiDriverDiagnostics2ProtocolGuid", &gEfiDriverDiagnostics2ProtocolGuid
);
106 return (EFI_NOT_FOUND
);
108 for (Walker
= DriverHandleList
; Walker
!= NULL
&& *Walker
!= NULL
; DriverHandleListCount
++, Walker
++);
111 if (ControllerHandle
!= NULL
) {
112 ControllerHandleList
= AllocateZeroPool(2*sizeof(EFI_HANDLE
));
113 if (ControllerHandleList
== NULL
) {
114 SHELL_FREE_NON_NULL (DriverHandleList
);
115 return EFI_OUT_OF_RESOURCES
;
117 ControllerHandleList
[0] = ControllerHandle
;
118 ControllerHandleListCount
= 1;
120 ControllerHandleList
= NULL
;
123 if (ChildHandle
!= NULL
) {
124 ChildHandleList
= AllocateZeroPool(2*sizeof(EFI_HANDLE
));
125 if (ChildHandleList
== NULL
) {
126 SHELL_FREE_NON_NULL (ControllerHandleList
);
127 SHELL_FREE_NON_NULL (DriverHandleList
);
128 return EFI_OUT_OF_RESOURCES
;
130 ChildHandleList
[0] = ChildHandle
;
131 ChildHandleListCount
= 1;
132 } else if (AllChilds
) {
133 ChildHandleList
= NULL
;
135 // This gets handled in the loop below.
138 ChildHandleList
= NULL
;
141 if (Mode
== TestModeList
) {
142 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_HEADER
), gShellDriver1HiiHandle
);
144 for (DriverHandleListLoop
= 0
145 ; DriverHandleListLoop
< DriverHandleListCount
146 ; DriverHandleListLoop
++
148 if (Mode
== TestModeList
) {
149 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_DRIVER_HEADER
), gShellDriver1HiiHandle
, ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]));
151 if (ControllerHandle
== NULL
) {
152 PARSE_HANDLE_DATABASE_DEVICES(DriverHandleList
[DriverHandleListLoop
], &ControllerHandleListCount
, &ControllerHandleList
);
154 if (ControllerHandleListCount
== 0) {
155 if (Mode
== TestModeList
) {
156 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVDIAG_DRIVER_NO_HANDLES
), gShellDriver1HiiHandle
);
159 if (Mode
== TestModeList
) {
160 ShellPrintEx(-1, -1, L
"\r\n");
162 for (ControllerHandleListLoop
= 0
163 ; ControllerHandleListLoop
< ControllerHandleListCount
164 ; ControllerHandleListLoop
++
167 ASSERT(ChildHandleList
== NULL
);
168 PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(
169 DriverHandleList
[DriverHandleListLoop
],
170 ControllerHandleList
[ControllerHandleListLoop
],
171 &ChildHandleListCount
,
174 for (ChildHandleListLoop
= 0
175 ; (ChildHandleListLoop
< ChildHandleListCount
|| ChildHandleList
== NULL
)
176 ; ChildHandleListLoop
++
179 if (Mode
!= TestModeList
) {
180 if (Lang
== NULL
|| Lang
[2] == '-') {
182 // Get the protocol pointer and call the function
184 Status
= gBS
->OpenProtocol(
185 DriverHandleList
[DriverHandleListLoop
],
186 &gEfiDriverDiagnostics2ProtocolGuid
,
187 (VOID
**)&DriverDiagnostics2
,
190 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
191 if (!EFI_ERROR(Status
) && (DriverDiagnostics2
!= NULL
)) {
192 Language
= GetBestLanguageForDriver(DriverDiagnostics2
->SupportedLanguages
, Lang
, FALSE
);
194 Status
= DriverDiagnostics2
->RunDiagnostics(
196 ControllerHandleList
[ControllerHandleListLoop
],
197 ChildHandleList
== NULL
?NULL
:ChildHandleList
[ChildHandleListLoop
],
198 (EFI_DRIVER_DIAGNOSTIC_TYPE
)Mode
,
206 if (!Found
&& (Lang
== NULL
||(Lang
!=NULL
&&(Lang
[2]!='-')))){
207 Status
= gBS
->OpenProtocol(
208 DriverHandleList
[DriverHandleListLoop
],
209 &gEfiDriverDiagnosticsProtocolGuid
,
210 (VOID
**)&DriverDiagnostics
,
213 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
214 if (!EFI_ERROR(Status
)) {
215 Language
= GetBestLanguageForDriver(DriverDiagnostics
->SupportedLanguages
, Lang
, FALSE
);
216 Status
= DriverDiagnostics
->RunDiagnostics(
218 ControllerHandleList
[ControllerHandleListLoop
],
219 ChildHandleList
== NULL
?NULL
:ChildHandleList
[ChildHandleListLoop
],
220 (EFI_DRIVER_DIAGNOSTIC_TYPE
)Mode
,
228 if (EFI_ERROR(Status
)) {
231 HandleIndex1
= ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]);
232 HandleIndex2
= ConvertHandleToHandleIndex(ControllerHandleList
[ControllerHandleListLoop
]);
237 STRING_TOKEN (STR_3P_RESULT
),
238 gShellDriver1HiiHandle
,
242 ChildHandleList
== NULL
?0:ConvertHandleToHandleIndex(ChildHandleList
[ChildHandleListLoop
]),
244 if (OutBuffer
!=NULL
) {
248 if (ErrorType
!=NULL
) {
253 HandleIndex1
= ConvertHandleToHandleIndex(DriverHandleList
[DriverHandleListLoop
]);
254 HandleIndex2
= ConvertHandleToHandleIndex(ControllerHandleList
[ControllerHandleListLoop
]);
256 // Print out the information that this set can be tested
262 STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE
),
263 gShellDriver1HiiHandle
,
266 ChildHandleList
== NULL
?0:ConvertHandleToHandleIndex(ChildHandleList
[ChildHandleListLoop
])
271 // If we are doing a single pass with NULL child jump out after a single loop
273 if (ChildHandleList
== NULL
) {
278 SHELL_FREE_NON_NULL(ChildHandleList
);
279 ChildHandleList
= NULL
;
280 ChildHandleListCount
= 0;
283 if (ControllerHandle
== NULL
) {
284 SHELL_FREE_NON_NULL(ControllerHandleList
);
285 ControllerHandleList
= NULL
;
286 ControllerHandleListCount
= 0;
291 if (DriverHandleList
!= NULL
) {
292 FreePool(DriverHandleList
);
294 if (ControllerHandleList
!= NULL
) {
295 FreePool(ControllerHandleList
);
297 if (ChildHandleList
!= NULL
) {
298 FreePool(ChildHandleList
);
304 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
314 Function for 'drvdiag' command.
316 @param[in] ImageHandle Handle to the Image (NULL if Internal).
317 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
321 ShellCommandRunDrvDiag (
322 IN EFI_HANDLE ImageHandle
,
323 IN EFI_SYSTEM_TABLE
*SystemTable
328 CHAR16
*ProblemParam
;
329 SHELL_STATUS ShellStatus
;
330 DRV_DIAG_TEST_MODE Mode
;
332 CONST CHAR16
*DriverHandleStr
;
333 CONST CHAR16
*ControllerHandleStr
;
334 CONST CHAR16
*ChildHandleStr
;
341 ShellStatus
= SHELL_SUCCESS
;
346 // initialize the shell lib (we must be in non-auto-init...)
348 Status
= ShellInitialize();
349 ASSERT_EFI_ERROR(Status
);
351 Status
= CommandInit();
352 ASSERT_EFI_ERROR(Status
);
355 // parse the command line
357 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
358 if (EFI_ERROR(Status
)) {
359 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
360 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, L
"drvdiag", ProblemParam
);
361 FreePool(ProblemParam
);
362 ShellStatus
= SHELL_INVALID_PARAMETER
;
368 // if more than 3 'value' parameters (plus the name one) or we have any 2 mode flags
370 if ((ShellCommandLineGetCount(Package
) > 4)
371 ||(ShellCommandLineGetFlag(Package
, L
"-s") && ShellCommandLineGetFlag(Package
, L
"-e"))
372 ||(ShellCommandLineGetFlag(Package
, L
"-s") && ShellCommandLineGetFlag(Package
, L
"-m"))
373 ||(ShellCommandLineGetFlag(Package
, L
"-e") && ShellCommandLineGetFlag(Package
, L
"-m"))
376 // error for too many parameters
378 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
, L
"drvdiag");
379 ShellStatus
= SHELL_INVALID_PARAMETER
;
380 } else if ((ShellCommandLineGetFlag(Package
, L
"-s"))
381 || (ShellCommandLineGetFlag(Package
, L
"-e"))
382 || (ShellCommandLineGetFlag(Package
, L
"-m"))
385 // Run the appropriate test
387 if (ShellCommandLineGetFlag(Package
, L
"-s")) {
388 Mode
= TestModeStandard
;
389 } else if (ShellCommandLineGetFlag(Package
, L
"-e")) {
390 Mode
= TestModeExtended
;
391 } else if (ShellCommandLineGetFlag(Package
, L
"-m")) {
392 Mode
= TestModeManufacturing
;
398 // Do a listing of what's available to test
403 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
404 if (ShellCommandLineGetFlag(Package
, L
"-l") && Lang
== NULL
) {
405 ASSERT(Language
== NULL
);
406 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drvdiag", L
"-l");
407 ShellCommandLineFreeVarList (Package
);
408 return (SHELL_INVALID_PARAMETER
);
409 } else if (Lang
!= NULL
) {
410 Language
= AllocateZeroPool(StrSize(Lang
));
411 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
414 DriverHandleStr
= ShellCommandLineGetRawValue(Package
, 1);
415 ControllerHandleStr
= ShellCommandLineGetRawValue(Package
, 2);
416 ChildHandleStr
= ShellCommandLineGetRawValue(Package
, 3);
418 if (DriverHandleStr
== NULL
) {
421 ShellConvertStringToUint64(DriverHandleStr
, &Intermediate
, TRUE
, FALSE
);
422 Handle1
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
424 if (ControllerHandleStr
== NULL
) {
427 ShellConvertStringToUint64(ControllerHandleStr
, &Intermediate
, TRUE
, FALSE
);
428 Handle2
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
430 if (ChildHandleStr
== NULL
) {
433 ShellConvertStringToUint64(ChildHandleStr
, &Intermediate
, TRUE
, FALSE
);
434 Handle3
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
437 Status
= DoDiagnostics (
440 ShellCommandLineGetFlag(Package
, L
"-c"),
446 SHELL_FREE_NON_NULL(Language
);
447 ShellCommandLineFreeVarList (Package
);
450 if (ShellStatus
== SHELL_SUCCESS
) {
451 if (Status
== EFI_SECURITY_VIOLATION
) {
452 ShellStatus
= SHELL_SECURITY_VIOLATION
;
453 } else if (Status
== EFI_INVALID_PARAMETER
) {
454 ShellStatus
= SHELL_INVALID_PARAMETER
;
455 } else if (Status
== EFI_NOT_FOUND
) {
456 ShellStatus
= SHELL_NOT_FOUND
;
457 } else if (EFI_ERROR(Status
)) {
458 ShellStatus
= SHELL_NOT_FOUND
;
462 return (ShellStatus
);