2 Main file for Drivers shell Driver1 function.
4 (C) Copyright 2012-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2017, 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
36 GetDevicePathTextForHandle(
37 IN EFI_HANDLE TheHandle
41 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
42 EFI_DEVICE_PATH_PROTOCOL
*ImageDevicePath
;
43 EFI_DEVICE_PATH_PROTOCOL
*FinalPath
;
48 Status
= gBS
->OpenProtocol (
50 &gEfiLoadedImageProtocolGuid
,
54 EFI_OPEN_PROTOCOL_GET_PROTOCOL
56 if (!EFI_ERROR (Status
)) {
57 Status
= gBS
->OpenProtocol (
58 LoadedImage
->DeviceHandle
,
59 &gEfiDevicePathProtocolGuid
,
60 (VOID
**)&ImageDevicePath
,
63 EFI_OPEN_PROTOCOL_GET_PROTOCOL
65 if (!EFI_ERROR (Status
)) {
66 FinalPath
= AppendDevicePath (ImageDevicePath
, LoadedImage
->FilePath
);
68 LoadedImage
->DeviceHandle
,
69 &gEfiDevicePathProtocolGuid
,
75 &gEfiLoadedImageProtocolGuid
,
80 if (FinalPath
== NULL
) {
83 RetVal
= gEfiShellProtocol
->GetFilePathFromDevicePath(FinalPath
);
85 RetVal
= ConvertDevicePathToText(FinalPath
, TRUE
, TRUE
);
92 Determine if the given handle has Driver Configuration protocol.
94 @param[in] TheHandle The handle to the driver to test.
96 @retval TRUE The driver does have Driver Configuration.
97 @retval FALSE The driver does not have Driver Configuration.
101 IN CONST EFI_HANDLE TheHandle
105 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverConfigurationProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
106 if (EFI_ERROR(Status
)) {
113 Determine if the given handle has DriverDiagnostics protocol.
115 @param[in] TheHandle The handle to the driver to test.
117 @retval TRUE The driver does have Driver Diasgnostics.
118 @retval FALSE The driver does not have Driver Diagnostics.
122 IN CONST EFI_HANDLE TheHandle
126 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverDiagnostics2ProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
127 if (EFI_ERROR(Status
)) {
128 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverDiagnosticsProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
129 if (EFI_ERROR(Status
)) {
137 Finds and returns the version of the driver specified by TheHandle.
139 @param[in] TheHandle The driver handle to get the version of.
141 @return The version of the driver.
142 @retval 0xFFFFFFFF An error ocurred.
146 IN CONST EFI_HANDLE TheHandle
149 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
155 Status
= gBS
->OpenProtocol((EFI_HANDLE
)TheHandle
, &gEfiDriverBindingProtocolGuid
, (VOID
**)&DriverBinding
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
156 if (!EFI_ERROR(Status
)) {
157 RetVal
= DriverBinding
->Version
;
158 gBS
->CloseProtocol(TheHandle
, &gEfiDriverBindingProtocolGuid
, gImageHandle
, NULL
);
164 Get image name from Image Handle.
166 @param[in] Handle Image Handle
168 @return A pointer to the image name as a string.
171 GetImageNameFromHandle (
172 IN CONST EFI_HANDLE Handle
176 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
177 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
178 EFI_DEVICE_PATH_PROTOCOL
*DevPathNode
;
182 UINT32 AuthenticationStatus
;
183 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv2
;
186 DriverBinding
= NULL
;
189 Status
= gBS
->OpenProtocol (
191 &gEfiDriverBindingProtocolGuid
,
192 (VOID
**) &DriverBinding
,
195 EFI_OPEN_PROTOCOL_GET_PROTOCOL
197 if (EFI_ERROR (Status
)) {
200 Status
= gBS
->OpenProtocol (
201 DriverBinding
->ImageHandle
,
202 &gEfiLoadedImageProtocolGuid
,
203 (VOID
**)&LoadedImage
,
206 EFI_OPEN_PROTOCOL_GET_PROTOCOL
208 if (!EFI_ERROR (Status
)) {
209 DevPathNode
= LoadedImage
->FilePath
;
210 if (DevPathNode
== NULL
) {
213 while (!IsDevicePathEnd (DevPathNode
)) {
214 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*)DevPathNode
);
215 if (NameGuid
!= NULL
) {
216 Status
= gBS
->HandleProtocol (
217 LoadedImage
->DeviceHandle
,
218 &gEfiFirmwareVolume2ProtocolGuid
,
221 if (!EFI_ERROR (Status
)) {
222 Status
= Fv2
->ReadSection (
225 EFI_SECTION_USER_INTERFACE
,
229 &AuthenticationStatus
231 if (!EFI_ERROR (Status
)) {
238 // Next device path node
240 DevPathNode
= NextDevicePathNode (DevPathNode
);
242 if (ImageName
== NULL
) {
243 ImageName
= ConvertDevicePathToText (LoadedImage
->FilePath
, TRUE
, TRUE
);
250 Function for 'drivers' command.
252 @param[in] ImageHandle Handle to the Image (NULL if Internal).
253 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
257 ShellCommandRunDrivers (
258 IN EFI_HANDLE ImageHandle
,
259 IN EFI_SYSTEM_TABLE
*SystemTable
264 CHAR16
*ProblemParam
;
265 SHELL_STATUS ShellStatus
;
268 EFI_HANDLE
*HandleList
;
269 EFI_HANDLE
*HandleWalker
;
272 CHAR16 ChildCountStr
[3];
273 CHAR16 DeviceCountStr
[3];
275 CONST CHAR16
*FullDriverName
;
276 CHAR16
*TruncatedDriverName
;
278 CHAR16
*FormatString
;
279 UINT32 DriverVersion
;
280 BOOLEAN DriverConfig
;
284 ShellStatus
= SHELL_SUCCESS
;
285 Status
= EFI_SUCCESS
;
291 // initialize the shell lib (we must be in non-auto-init...)
293 Status
= ShellInitialize();
294 ASSERT_EFI_ERROR(Status
);
296 Status
= CommandInit();
297 ASSERT_EFI_ERROR(Status
);
300 // parse the command line
302 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
303 if (EFI_ERROR(Status
)) {
304 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
305 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, L
"drivers", ProblemParam
);
306 FreePool(ProblemParam
);
307 ShellStatus
= SHELL_INVALID_PARAMETER
;
312 if (ShellCommandLineGetCount(Package
) > 1) {
313 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
, L
"drivers");
314 ShellStatus
= SHELL_INVALID_PARAMETER
;
316 if (ShellCommandLineGetFlag(Package
, L
"-l")){
317 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
319 Language
= AllocateZeroPool(StrSize(Lang
));
320 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
322 ASSERT(Language
== NULL
);
323 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drivers", L
"-l");
324 ShellCommandLineFreeVarList (Package
);
325 return (SHELL_INVALID_PARAMETER
);
329 if (ShellCommandLineGetFlag (Package
, L
"-sfo")) {
331 FormatString
= HiiGetString (gShellDriver1HiiHandle
, STRING_TOKEN (STR_DRIVERS_ITEM_LINE_SFO
), Language
);
333 // print the SFO header
339 STRING_TOKEN (STR_GEN_SFO_HEADER
),
340 gShellDriver1HiiHandle
,
343 FormatString
= HiiGetString (gShellDriver1HiiHandle
, STRING_TOKEN (STR_DRIVERS_ITEM_LINE
), Language
);
345 // print the header row
351 STRING_TOKEN (STR_DRIVERS_HEADER_LINES
),
352 gShellDriver1HiiHandle
);
355 HandleList
= GetHandleListByProtocol(&gEfiDriverBindingProtocolGuid
);
356 for (HandleWalker
= HandleList
; HandleWalker
!= NULL
&& *HandleWalker
!= NULL
; HandleWalker
++){
359 Status
= ParseHandleDatabaseForChildDevices (*HandleWalker
, &ChildCount
, NULL
);
360 Status
= PARSE_HANDLE_DATABASE_DEVICES (*HandleWalker
, &DeviceCount
, NULL
);
361 Temp2
= GetDevicePathTextForHandle(*HandleWalker
);
362 DriverVersion
= ReturnDriverVersion(*HandleWalker
);
363 DriverConfig
= ReturnDriverConfig(*HandleWalker
);
364 DriverDiag
= ReturnDriverDiag (*HandleWalker
);
365 FullDriverName
= GetStringNameFromHandle(*HandleWalker
, Language
);
366 ImageName
= GetImageNameFromHandle (*HandleWalker
);
368 UnicodeValueToStringS (ChildCountStr
, sizeof (ChildCountStr
), 0, ChildCount
, 0);
369 UnicodeValueToStringS (DeviceCountStr
, sizeof (DeviceCountStr
), 0, DeviceCount
, 0);
370 TruncatedDriverName
= NULL
;
371 if (!SfoFlag
&& (FullDriverName
!= NULL
)) {
372 TruncatedDriverName
= AllocateZeroPool ((MAX_LEN_DRIVER_NAME
+ 1) * sizeof (CHAR16
));
373 StrnCpyS (TruncatedDriverName
, MAX_LEN_DRIVER_NAME
+ 1, FullDriverName
, MAX_LEN_DRIVER_NAME
);
381 ConvertHandleToHandleIndex (*HandleWalker
),
383 ChildCount
> 0 ? L
'B' : (DeviceCount
> 0 ? L
'D' : L
'?'),
384 DriverConfig
? L
'X' : L
'-',
385 DriverDiag
? L
'X' : L
'-',
386 DeviceCount
> 0 ? DeviceCountStr
: L
"-",
387 ChildCount
> 0 ? ChildCountStr
: L
"-",
389 ImageName
== NULL
? L
"" : ImageName
396 ConvertHandleToHandleIndex (*HandleWalker
),
398 ChildCount
> 0 ? L
'B' : (DeviceCount
> 0 ? L
'D' : L
'?'),
399 DriverConfig
? L
'Y' : L
'N',
400 DriverDiag
? L
'Y' : L
'N',
404 Temp2
== NULL
? L
"" : Temp2
407 if (TruncatedDriverName
!= NULL
) {
408 FreePool (TruncatedDriverName
);
413 if (ImageName
!= NULL
) {
414 FreePool (ImageName
);
417 if (ShellGetExecutionBreakFlag ()) {
418 ShellStatus
= SHELL_ABORTED
;
423 SHELL_FREE_NON_NULL(Language
);
424 ShellCommandLineFreeVarList (Package
);
425 SHELL_FREE_NON_NULL(FormatString
);
428 return (ShellStatus
);