2 Main file for Drivers shell Driver1 function.
4 (C) Copyright 2012-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2015, 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 #define MAX_LEN_DRIVER_NAME 35
20 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
27 Get a device path (in text format) for a given handle.
29 @param[in] TheHandle The handle to get the device path for.
31 @retval NULL An error occured.
32 @return A pointer to the driver path as a string. The callee must
37 GetDevicePathTextForHandle(
38 IN EFI_HANDLE TheHandle
42 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
43 EFI_DEVICE_PATH_PROTOCOL
*ImageDevicePath
;
44 EFI_DEVICE_PATH_PROTOCOL
*FinalPath
;
49 Status
= gBS
->OpenProtocol (
51 &gEfiLoadedImageProtocolGuid
,
55 EFI_OPEN_PROTOCOL_GET_PROTOCOL
57 if (!EFI_ERROR (Status
)) {
58 Status
= gBS
->OpenProtocol (
59 LoadedImage
->DeviceHandle
,
60 &gEfiDevicePathProtocolGuid
,
61 (VOID
**)&ImageDevicePath
,
64 EFI_OPEN_PROTOCOL_GET_PROTOCOL
66 if (!EFI_ERROR (Status
)) {
67 FinalPath
= AppendDevicePath (ImageDevicePath
, LoadedImage
->FilePath
);
69 LoadedImage
->DeviceHandle
,
70 &gEfiDevicePathProtocolGuid
,
76 &gEfiLoadedImageProtocolGuid
,
81 if (FinalPath
== NULL
) {
84 RetVal
= gEfiShellProtocol
->GetFilePathFromDevicePath(FinalPath
);
86 RetVal
= ConvertDevicePathToText(FinalPath
, TRUE
, TRUE
);
93 Determine if the given handle has Driver Configuration protocol.
95 @param[in] TheHandle The handle to the driver to test.
97 @retval TRUE The driver does have Driver Configuration.
98 @retval FALSE The driver does not have Driver Configuration.
103 IN CONST EFI_HANDLE TheHandle
107 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverConfigurationProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
108 if (EFI_ERROR(Status
)) {
115 Determine if the given handle has DriverDiagnostics protocol.
117 @param[in] TheHandle The handle to the driver to test.
119 @retval TRUE The driver does have Driver Diasgnostics.
120 @retval FALSE The driver does not have Driver Diagnostics.
125 IN CONST EFI_HANDLE TheHandle
129 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverDiagnostics2ProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
130 if (EFI_ERROR(Status
)) {
131 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverDiagnosticsProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
132 if (EFI_ERROR(Status
)) {
140 Finds and returns the version of the driver specified by TheHandle.
142 @param[in] TheHandle The driver handle to get the version of.
144 @return The version of the driver.
145 @retval 0xFFFFFFFF An error ocurred.
150 IN CONST EFI_HANDLE TheHandle
153 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
159 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverBindingProtocolGuid
, (VOID
**)&DriverBinding
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
160 if (!EFI_ERROR(Status
)) {
161 RetVal
= DriverBinding
->Version
;
162 gBS
->CloseProtocol(TheHandle
, &gEfiDriverBindingProtocolGuid
, gImageHandle
, NULL
);
168 Function for 'drivers' command.
170 @param[in] ImageHandle Handle to the Image (NULL if Internal).
171 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
175 ShellCommandRunDrivers (
176 IN EFI_HANDLE ImageHandle
,
177 IN EFI_SYSTEM_TABLE
*SystemTable
182 CHAR16
*ProblemParam
;
183 SHELL_STATUS ShellStatus
;
186 EFI_HANDLE
*HandleList
;
187 EFI_HANDLE
*HandleWalker
;
191 CONST CHAR16
*FullDriverName
;
192 CHAR16
*TruncatedDriverName
;
193 CHAR16
*FormatString
;
194 UINT32 DriverVersion
;
195 BOOLEAN DriverConfig
;
199 ShellStatus
= SHELL_SUCCESS
;
200 Status
= EFI_SUCCESS
;
206 // initialize the shell lib (we must be in non-auto-init...)
208 Status
= ShellInitialize();
209 ASSERT_EFI_ERROR(Status
);
211 Status
= CommandInit();
212 ASSERT_EFI_ERROR(Status
);
215 // parse the command line
217 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
218 if (EFI_ERROR(Status
)) {
219 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
220 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, L
"drivers", ProblemParam
);
221 FreePool(ProblemParam
);
222 ShellStatus
= SHELL_INVALID_PARAMETER
;
227 if (ShellCommandLineGetCount(Package
) > 1) {
228 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
, L
"drivers");
229 ShellStatus
= SHELL_INVALID_PARAMETER
;
231 if (ShellCommandLineGetFlag(Package
, L
"-l")){
232 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
234 Language
= AllocateZeroPool(StrSize(Lang
));
235 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
237 ASSERT(Language
== NULL
);
238 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drivers", L
"-l");
239 ShellCommandLineFreeVarList (Package
);
240 return (SHELL_INVALID_PARAMETER
);
244 if (ShellCommandLineGetFlag (Package
, L
"-sfo")) {
246 FormatString
= HiiGetString (gShellDriver1HiiHandle
, STRING_TOKEN (STR_DRIVERS_ITEM_LINE_SFO
), Language
);
248 // print the SFO header
254 STRING_TOKEN (STR_GEN_SFO_HEADER
),
255 gShellDriver1HiiHandle
,
258 FormatString
= HiiGetString (gShellDriver1HiiHandle
, STRING_TOKEN (STR_DRIVERS_ITEM_LINE
), Language
);
260 // print the header row
266 STRING_TOKEN (STR_DRIVERS_HEADER_LINES
),
267 gShellDriver1HiiHandle
);
270 HandleList
= GetHandleListByProtocol(&gEfiDriverBindingProtocolGuid
);
271 for (HandleWalker
= HandleList
; HandleWalker
!= NULL
&& *HandleWalker
!= NULL
; HandleWalker
++){
274 Status
= ParseHandleDatabaseForChildDevices (*HandleWalker
, &ChildCount
, NULL
);
275 Status
= PARSE_HANDLE_DATABASE_DEVICES (*HandleWalker
, &DeviceCount
, NULL
);
276 Temp2
= GetDevicePathTextForHandle(*HandleWalker
);
277 DriverVersion
= ReturnDriverVersion(*HandleWalker
);
278 DriverConfig
= ReturnDriverConfig(*HandleWalker
);
279 DriverDiag
= ReturnDriverDiag (*HandleWalker
);
280 FullDriverName
= GetStringNameFromHandle(*HandleWalker
, Language
);
282 TruncatedDriverName
= NULL
;
283 if (!SfoFlag
&& (FullDriverName
!= NULL
)) {
284 TruncatedDriverName
= AllocateZeroPool ((MAX_LEN_DRIVER_NAME
+ 1) * sizeof (CHAR16
));
285 StrnCpyS (TruncatedDriverName
, MAX_LEN_DRIVER_NAME
+ 1, FullDriverName
, MAX_LEN_DRIVER_NAME
);
292 ConvertHandleToHandleIndex(*HandleWalker
),
294 ChildCount
> 0?L
'B':(DeviceCount
> 0?L
'D':L
'?'),
295 DriverConfig
?L
'Y':L
'N',
296 DriverDiag
?L
'Y':L
'N',
299 SfoFlag
?FullDriverName
:TruncatedDriverName
,
300 Temp2
==NULL
?L
"":Temp2
302 if (TruncatedDriverName
!= NULL
) {
303 FreePool (TruncatedDriverName
);
309 if (ShellGetExecutionBreakFlag ()) {
310 ShellStatus
= SHELL_ABORTED
;
315 SHELL_FREE_NON_NULL(Language
);
316 ShellCommandLineFreeVarList (Package
);
317 SHELL_FREE_NON_NULL(FormatString
);
320 return (ShellStatus
);