2 Main file for devices shell Driver1 function.
4 (C) Copyright 2012-2014, Hewlett-Packard Development Company, L.P.
5 Copyright (c) 2010 - 2014, 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"
19 Get lots of info about a device from its handle.
21 @param[in] TheHandle The device handle to get info on.
22 @param[in, out] Type On successful return R, B, or D (root, bus, or
23 device) will be placed in this buffer.
24 @param[in, out] Cfg On successful return this buffer will be
25 TRUE if the handle has configuration, FALSE
27 @param[in, out] Diag On successful return this buffer will be
28 TRUE if the handle has disgnostics, FALSE
30 @param[in, out] Parents On successful return this buffer will be
31 contain the number of parent handles.
32 @param[in, out] Devices On successful return this buffer will be
33 contain the number of devices controlled.
34 @param[in, out] Children On successful return this buffer will be
35 contain the number of child handles.
36 @param[out] Name The pointer to a buffer that will be allocated
37 and contain the string name of the handle.
38 The caller must free this memory.
39 @param[in] Language The language code as defined by the UEFI spec.
41 @retval EFI_SUCCESS The info is there.
42 @retval EFI_INVALID_PARAMETER A parameter was invalid.
47 IN EFI_HANDLE TheHandle
,
51 IN OUT UINTN
*Parents
,
52 IN OUT UINTN
*Devices
,
53 IN OUT UINTN
*Children
,
55 IN CONST CHAR8
*Language
59 EFI_HANDLE
*HandleBuffer
;
70 return (EFI_INVALID_PARAMETER
);
83 gEfiShellProtocol
->GetDeviceName(TheHandle
, EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, Name
);
85 Status
= ParseHandleDatabaseForChildControllers(TheHandle
, Children
, NULL
);
86 // if (!EFI_ERROR(Status)) {
87 Status
= PARSE_HANDLE_DATABASE_PARENTS(TheHandle
, Parents
, NULL
);
88 if (/*!EFI_ERROR(Status) && */Parents
!= NULL
&& Children
!= NULL
) {
91 } else if (*Children
> 0) {
98 Status
= PARSE_HANDLE_DATABASE_UEFI_DRIVERS(TheHandle
, Devices
, &HandleBuffer
);
99 if (!EFI_ERROR(Status
) && Devices
!= NULL
&& HandleBuffer
!= NULL
) {
100 for (Count
= 0 ; Count
< *Devices
; Count
++) {
101 if (!EFI_ERROR(gBS
->OpenProtocol(HandleBuffer
[Count
], &gEfiDriverConfigurationProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
104 if (!EFI_ERROR(gBS
->OpenProtocol(HandleBuffer
[Count
], &gEfiDriverDiagnosticsProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
107 if (!EFI_ERROR(gBS
->OpenProtocol(HandleBuffer
[Count
], &gEfiDriverDiagnostics2ProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
111 SHELL_FREE_NON_NULL(HandleBuffer
);
117 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
124 Function for 'devices' command.
126 @param[in] ImageHandle Handle to the Image (NULL if Internal).
127 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
131 ShellCommandRunDevices (
132 IN EFI_HANDLE ImageHandle
,
133 IN EFI_SYSTEM_TABLE
*SystemTable
138 CHAR16
*ProblemParam
;
139 SHELL_STATUS ShellStatus
;
141 EFI_HANDLE
*HandleList
;
142 EFI_HANDLE
*HandleListWalker
;
153 ShellStatus
= SHELL_SUCCESS
;
158 // initialize the shell lib (we must be in non-auto-init...)
160 Status
= ShellInitialize();
161 ASSERT_EFI_ERROR(Status
);
163 Status
= CommandInit();
164 ASSERT_EFI_ERROR(Status
);
167 // parse the command line
169 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
170 if (EFI_ERROR(Status
)) {
171 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
172 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, ProblemParam
);
173 FreePool(ProblemParam
);
174 ShellStatus
= SHELL_INVALID_PARAMETER
;
180 // if more than 0 'value' parameters we have too many parameters
182 if (ShellCommandLineGetRawValue(Package
, 1) != NULL
){
184 // error for too many parameters
186 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
);
187 ShellStatus
= SHELL_INVALID_PARAMETER
;
190 // get the language if necessary
192 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
194 Language
= AllocateZeroPool(StrSize(Lang
));
195 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
196 } else if (!ShellCommandLineGetFlag(Package
, L
"-l")){
197 ASSERT(Language
== NULL
);
198 // Language = AllocateZeroPool(10);
199 // AsciiSPrint(Language, 10, "en-us");
201 ASSERT(Language
== NULL
);
202 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"-l");
203 ShellCommandLineFreeVarList (Package
);
204 return (SHELL_INVALID_PARAMETER
);
212 if (ShellCommandLineGetFlag (Package
, L
"-sfo")) {
213 ShellPrintHiiEx (-1, -1, Language
, STRING_TOKEN (STR_GEN_SFO_HEADER
), gShellDriver1HiiHandle
, L
"devices");
216 ShellPrintHiiEx (-1, -1, Language
, STRING_TOKEN (STR_DEVICES_HEADER_LINES
), gShellDriver1HiiHandle
);
220 // loop through each handle
222 HandleList
= GetHandleListByProtocol(NULL
);
223 ASSERT(HandleList
!= NULL
);
224 for (HandleListWalker
= HandleList
225 ; HandleListWalker
!= NULL
&& *HandleListWalker
!= NULL
/*&& !EFI_ERROR(Status)*/
230 // get all the info on each handle
233 Status
= GetDeviceHandleInfo(*HandleListWalker
, &Type
, &Cfg
, &Diag
, &Parents
, &Devices
, &Children
, &Name
, Language
);
234 if (Name
!= NULL
&& (Parents
!= 0 || Devices
!= 0 || Children
!= 0)) {
239 SfoFlag
?STRING_TOKEN (STR_DEVICES_ITEM_LINE_SFO
):STRING_TOKEN (STR_DEVICES_ITEM_LINE
),
240 gShellDriver1HiiHandle
,
241 ConvertHandleToHandleIndex (*HandleListWalker
),
243 Cfg
?(SfoFlag
?L
'Y':L
'X'):(SfoFlag
?L
'N':L
'-'),
244 Diag
?(SfoFlag
?L
'Y':L
'X'):(SfoFlag
?L
'N':L
'-'),
248 Name
!=NULL
?Name
:L
"<UNKNOWN>");
255 if (HandleList
!= NULL
) {
256 FreePool(HandleList
);
260 SHELL_FREE_NON_NULL(Language
);
261 ShellCommandLineFreeVarList (Package
);
263 return (ShellStatus
);