2 Main file for OpenInfo shell Driver1 function.
4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2011, 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 CHAR16 StringHandProt
[] = L
"HandProt ";
19 STATIC CONST CHAR16 StringGetProt
[] = L
"GetProt ";
20 STATIC CONST CHAR16 StringTestProt
[] = L
"TestProt ";
21 STATIC CONST CHAR16 StringChild
[] = L
"Child ";
22 STATIC CONST CHAR16 StringDriver
[] = L
"Driver ";
23 STATIC CONST CHAR16 StringExclusive
[] = L
"Exclusive";
24 STATIC CONST CHAR16 StringDriverEx
[] = L
"DriverEx ";
25 STATIC CONST CHAR16 StringUnknown
[] = L
"Unknown ";
28 Open the database and print out all the info about TheHandle.
30 @param[in] TheHandle The handle to print info on.
32 @retval EFI_SUCCESS The operation was successful.
33 @retval EFI_INVALID_PARAMETER TheHandle was NULL.
37 TraverseHandleDatabase (
38 IN CONST EFI_HANDLE TheHandle
42 EFI_GUID
**ProtocolGuidArray
;
45 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
48 CONST CHAR16
*OpenTypeString
;
52 UINTN ControllerIndex
;
54 if (TheHandle
== NULL
) {
55 return (EFI_INVALID_PARAMETER
);
59 // Retrieve the list of all the protocols on the handle
61 Status
= gBS
->ProtocolsPerHandle (
66 ASSERT_EFI_ERROR(Status
);
67 if (!EFI_ERROR (Status
)) {
69 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
71 // print out the human readable name for this one.
73 TempString
= GetStringNameFromGuid(ProtocolGuidArray
[ProtocolIndex
], NULL
);
74 if (TempString
== NULL
) {
77 ShellPrintEx(-1, -1, L
"%H%s%N\r\n", TempString
);
81 // Retrieve the list of agents that have opened each protocol
83 Status
= gBS
->OpenProtocolInformation (
85 ProtocolGuidArray
[ProtocolIndex
],
89 ASSERT_EFI_ERROR(Status
);
90 if (!EFI_ERROR (Status
)) {
91 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
92 switch (OpenInfo
[OpenInfoIndex
].Attributes
) {
93 case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
: OpenTypeString
= StringHandProt
; break;
94 case EFI_OPEN_PROTOCOL_GET_PROTOCOL
: OpenTypeString
= StringGetProt
; break;
95 case EFI_OPEN_PROTOCOL_TEST_PROTOCOL
: OpenTypeString
= StringTestProt
; break;
96 case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
: OpenTypeString
= StringChild
; break;
97 case EFI_OPEN_PROTOCOL_BY_DRIVER
: OpenTypeString
= StringDriver
; break;
98 case EFI_OPEN_PROTOCOL_EXCLUSIVE
: OpenTypeString
= StringExclusive
; break;
99 case EFI_OPEN_PROTOCOL_BY_DRIVER
|EFI_OPEN_PROTOCOL_EXCLUSIVE
:
100 OpenTypeString
= StringDriverEx
; break;
101 default: OpenTypeString
= StringUnknown
; break;
103 HandleIndex
= ConvertHandleToHandleIndex(OpenInfo
[OpenInfoIndex
].AgentHandle
);
104 Name
= GetStringNameFromHandle(OpenInfo
[OpenInfoIndex
].AgentHandle
, NULL
);
105 ControllerIndex
= ConvertHandleToHandleIndex(OpenInfo
[OpenInfoIndex
].ControllerHandle
);
106 if (ControllerIndex
!= 0) {
111 STRING_TOKEN(STR_OPENINFO_LINE
),
112 gShellDriver1HiiHandle
,
115 OpenInfo
[OpenInfoIndex
].OpenCount
,
124 STRING_TOKEN(STR_OPENINFO_MIN_LINE
),
125 gShellDriver1HiiHandle
,
127 OpenInfo
[OpenInfoIndex
].OpenCount
,
136 FreePool (ProtocolGuidArray
);
143 Function for 'openinfo' command.
145 @param[in] ImageHandle Handle to the Image (NULL if Internal).
146 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
150 ShellCommandRunOpenInfo (
151 IN EFI_HANDLE ImageHandle
,
152 IN EFI_SYSTEM_TABLE
*SystemTable
157 CHAR16
*ProblemParam
;
158 SHELL_STATUS ShellStatus
;
159 EFI_HANDLE TheHandle
;
160 CONST CHAR16
*Param1
;
163 ShellStatus
= SHELL_SUCCESS
;
166 // initialize the shell lib (we must be in non-auto-init...)
168 Status
= ShellInitialize();
169 ASSERT_EFI_ERROR(Status
);
171 Status
= CommandInit();
172 ASSERT_EFI_ERROR(Status
);
175 // parse the command line
177 Status
= ShellCommandLineParse (EmptyParamList
, &Package
, &ProblemParam
, TRUE
);
178 if (EFI_ERROR(Status
)) {
179 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
180 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, L
"openinfo", ProblemParam
);
181 FreePool(ProblemParam
);
182 ShellStatus
= SHELL_INVALID_PARAMETER
;
187 if (ShellCommandLineGetCount(Package
) > 2){
189 // error for too many parameters
191 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
, L
"openinfo");
192 ShellStatus
= SHELL_INVALID_PARAMETER
;
193 } else if (ShellCommandLineGetCount(Package
) == 0) {
194 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellDriver1HiiHandle
, L
"openinfo");
195 ShellStatus
= SHELL_INVALID_PARAMETER
;
197 Param1
= ShellCommandLineGetRawValue(Package
, 1);
198 Status
= ShellConvertStringToUint64(Param1
, &Intermediate
, TRUE
, FALSE
);
199 if (EFI_ERROR(Status
) || Param1
== NULL
|| ConvertHandleIndexToHandle((UINTN
)Intermediate
) == NULL
){
200 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, L
"openinfo", Param1
);
201 ShellStatus
= SHELL_INVALID_PARAMETER
;
203 TheHandle
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
204 ASSERT(TheHandle
!= NULL
);
205 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_OPENINFO_HEADER_LINE
), gShellDriver1HiiHandle
, (UINTN
)Intermediate
, TheHandle
);
207 Status
= TraverseHandleDatabase (TheHandle
);
208 if (!EFI_ERROR(Status
)) {
210 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, L
"openinfo", Param1
);
211 ShellStatus
= SHELL_NOT_FOUND
;
216 return (ShellStatus
);