]>
Commit | Line | Data |
---|---|---|
4ba49616 | 1 | /** @file\r |
2 | Main file for DevTree shell Driver1 function.\r | |
3 | \r | |
c011b6c9 | 4 | (C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.<BR>\r |
55b1d63d | 5 | Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r |
4ba49616 | 6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #include "UefiShellDriver1CommandsLib.h"\r | |
17 | \r | |
18 | STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r | |
19 | {L"-d", TypeFlag},\r | |
20 | {L"-l", TypeValue},\r | |
21 | {NULL, TypeMax}\r | |
22 | };\r | |
23 | \r | |
361a8267 | 24 | /**\r |
25 | Display a tree starting from this handle.\r | |
26 | \r | |
27 | @param[in] TheHandle The handle to start with.\r | |
28 | @param[in] Lang Optionally, a UEFI defined language code.\r | |
29 | @param[in] UseDevPaths TRUE to display info from DevPath as identifiers.\r | |
30 | FALSE will use component name protocol instead.\r | |
31 | @param[in] IndentCharCount How many characters to indent (allows for recursion).\r | |
32 | @param[in] HiiString The string from HII to use for output.\r | |
33 | \r | |
34 | @retval SHELL_SUCCESS The operation was successful.\r | |
35 | **/\r | |
4ba49616 | 36 | SHELL_STATUS\r |
37 | EFIAPI\r | |
38 | DoDevTreeForHandle(\r | |
39 | IN CONST EFI_HANDLE TheHandle,\r | |
40 | IN CONST CHAR8 *Lang OPTIONAL,\r | |
41 | IN CONST BOOLEAN UseDevPaths,\r | |
42 | IN CONST UINTN IndentCharCount,\r | |
43 | IN CONST CHAR16 *HiiString\r | |
44 | )\r | |
45 | {\r | |
46 | SHELL_STATUS ShellStatus;\r | |
47 | EFI_STATUS Status;\r | |
48 | CHAR16 *FormatString;\r | |
49 | CHAR16 *Name;\r | |
50 | EFI_HANDLE *ChildHandleBuffer;\r | |
51 | UINTN ChildCount;\r | |
52 | UINTN LoopVar;\r | |
53 | \r | |
54 | Status = EFI_SUCCESS;\r | |
55 | ShellStatus = SHELL_SUCCESS;\r | |
56 | Name = NULL;\r | |
57 | ChildHandleBuffer = NULL;\r | |
58 | ChildCount = 0;\r | |
59 | \r | |
55b1d63d RN |
60 | ASSERT (TheHandle != NULL);\r |
61 | ASSERT (HiiString != NULL);\r | |
bbe94d7a TS |
62 | \r |
63 | if (ShellGetExecutionBreakFlag()) {\r | |
64 | ShellStatus = SHELL_ABORTED;\r | |
65 | return ShellStatus;\r | |
66 | }\r | |
67 | \r | |
4ba49616 | 68 | //\r |
69 | // We want controller handles. they will not have LoadedImage or DriverBinding (or others...)\r | |
70 | //\r | |
71 | Status = gBS->OpenProtocol (\r | |
72 | TheHandle,\r | |
73 | &gEfiDriverBindingProtocolGuid,\r | |
74 | NULL,\r | |
75 | NULL,\r | |
76 | NULL,\r | |
77 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
78 | );\r | |
79 | if (!EFI_ERROR (Status)) {\r | |
80 | return SHELL_SUCCESS;\r | |
81 | }\r | |
82 | \r | |
83 | Status = gBS->OpenProtocol (\r | |
84 | TheHandle,\r | |
85 | &gEfiLoadedImageProtocolGuid,\r | |
86 | NULL,\r | |
87 | NULL,\r | |
88 | NULL,\r | |
89 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
90 | );\r | |
91 | if (!EFI_ERROR (Status)) {\r | |
92 | return SHELL_SUCCESS;\r | |
93 | }\r | |
94 | \r | |
55b1d63d RN |
95 | FormatString = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r |
96 | if (FormatString == NULL) {\r | |
97 | return SHELL_OUT_OF_RESOURCES;\r | |
98 | }\r | |
4ba49616 | 99 | \r |
100 | //\r | |
101 | // we generate the format string on the fly so that we can control the\r | |
102 | // number of space characters that the first (empty) string has. this\r | |
103 | // handles the indenting.\r | |
104 | //\r | |
105 | \r | |
106 | UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r | |
107 | gEfiShellProtocol->GetDeviceName((EFI_HANDLE)TheHandle, !UseDevPaths?EFI_DEVICE_NAME_USE_COMPONENT_NAME|EFI_DEVICE_NAME_USE_DEVICE_PATH:EFI_DEVICE_NAME_USE_DEVICE_PATH, (CHAR8*)Lang, &Name);\r | |
108 | //\r | |
109 | // print out the information for ourselves\r | |
110 | //\r | |
111 | ShellPrintEx(\r | |
112 | -1,\r | |
113 | -1,\r | |
114 | FormatString,\r | |
115 | L"",\r | |
116 | ConvertHandleToHandleIndex(TheHandle),\r | |
117 | Name==NULL?L"Unknown":Name);\r | |
118 | \r | |
119 | FreePool(FormatString);\r | |
120 | if (Name != NULL) {\r | |
121 | FreePool(Name);\r | |
122 | }\r | |
123 | \r | |
124 | //\r | |
125 | // recurse on each child handle with IndentCharCount + 2\r | |
126 | //\r | |
127 | ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r | |
128 | for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r | |
129 | ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r | |
bbe94d7a TS |
130 | if (ShellStatus == SHELL_ABORTED) {\r |
131 | break;\r | |
132 | }\r | |
4ba49616 | 133 | }\r |
134 | \r | |
135 | if (ChildHandleBuffer != NULL) {\r | |
136 | FreePool(ChildHandleBuffer);\r | |
137 | }\r | |
138 | \r | |
139 | return (ShellStatus);\r | |
140 | }\r | |
141 | \r | |
142 | /**\r | |
143 | Function for 'devtree' command.\r | |
144 | \r | |
145 | @param[in] ImageHandle Handle to the Image (NULL if Internal).\r | |
146 | @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r | |
147 | **/\r | |
148 | SHELL_STATUS\r | |
149 | EFIAPI\r | |
150 | ShellCommandRunDevTree (\r | |
151 | IN EFI_HANDLE ImageHandle,\r | |
152 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
153 | )\r | |
154 | {\r | |
155 | EFI_STATUS Status;\r | |
156 | LIST_ENTRY *Package;\r | |
157 | CHAR16 *ProblemParam;\r | |
158 | SHELL_STATUS ShellStatus;\r | |
159 | CHAR8 *Language;\r | |
160 | CONST CHAR16 *Lang;\r | |
161 | CHAR16 *HiiString;\r | |
162 | UINTN LoopVar;\r | |
163 | EFI_HANDLE TheHandle;\r | |
164 | BOOLEAN FlagD;\r | |
361a8267 | 165 | UINT64 Intermediate;\r |
f330ff35 | 166 | UINTN ParentControllerHandleCount;\r |
167 | EFI_HANDLE *ParentControllerHandleBuffer;\r | |
4ba49616 | 168 | \r |
169 | ShellStatus = SHELL_SUCCESS;\r | |
170 | Status = EFI_SUCCESS;\r | |
171 | Language = NULL;\r | |
172 | \r | |
173 | //\r | |
174 | // initialize the shell lib (we must be in non-auto-init...)\r | |
175 | //\r | |
176 | Status = ShellInitialize();\r | |
177 | ASSERT_EFI_ERROR(Status);\r | |
178 | \r | |
179 | Status = CommandInit();\r | |
180 | ASSERT_EFI_ERROR(Status);\r | |
181 | \r | |
182 | //\r | |
183 | // parse the command line\r | |
184 | //\r | |
185 | Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r | |
186 | if (EFI_ERROR(Status)) {\r | |
187 | if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r | |
bc280720 | 188 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"devtree", ProblemParam); \r |
4ba49616 | 189 | FreePool(ProblemParam);\r |
190 | ShellStatus = SHELL_INVALID_PARAMETER;\r | |
191 | } else {\r | |
192 | ASSERT(FALSE);\r | |
193 | }\r | |
194 | } else {\r | |
195 | if (ShellCommandLineGetCount(Package) > 2) {\r | |
bc280720 | 196 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"devtree"); \r |
4ba49616 | 197 | ShellCommandLineFreeVarList (Package);\r |
198 | return (SHELL_INVALID_PARAMETER);\r | |
199 | }\r | |
200 | Lang = ShellCommandLineGetValue(Package, L"-l");\r | |
201 | if (Lang != NULL) {\r | |
202 | Language = AllocateZeroPool(StrSize(Lang));\r | |
203 | AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r | |
204 | } else if (!ShellCommandLineGetFlag(Package, L"-l")){\r | |
205 | ASSERT(Language == NULL);\r | |
206 | // Language = AllocateZeroPool(10);\r | |
207 | // AsciiSPrint(Language, 10, "en-us");\r | |
208 | } else {\r | |
209 | ASSERT(Language == NULL);\r | |
bc280720 | 210 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"devtree", L"-l"); \r |
4ba49616 | 211 | ShellCommandLineFreeVarList (Package);\r |
212 | return (SHELL_INVALID_PARAMETER);\r | |
213 | }\r | |
214 | FlagD = ShellCommandLineGetFlag(Package, L"-d");\r | |
215 | \r | |
216 | Lang = ShellCommandLineGetRawValue(Package, 1);\r | |
217 | HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r | |
218 | \r | |
219 | if (Lang == NULL) {\r | |
220 | for (LoopVar = 1 ; ; LoopVar++){\r | |
221 | TheHandle = ConvertHandleIndexToHandle(LoopVar);\r | |
222 | if (TheHandle == NULL){\r | |
223 | break;\r | |
224 | }\r | |
f330ff35 | 225 | \r |
226 | //\r | |
227 | // Skip handles that do not have device path protocol\r | |
228 | //\r | |
229 | Status = gBS->OpenProtocol (\r | |
230 | TheHandle,\r | |
231 | &gEfiDevicePathProtocolGuid,\r | |
232 | NULL,\r | |
233 | NULL,\r | |
234 | NULL,\r | |
235 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
236 | );\r | |
237 | if (EFI_ERROR (Status)) {\r | |
238 | continue;\r | |
239 | }\r | |
240 | \r | |
241 | //\r | |
242 | // Skip handles that do have parents\r | |
243 | //\r | |
244 | ParentControllerHandleBuffer = NULL;\r | |
245 | Status = PARSE_HANDLE_DATABASE_PARENTS (\r | |
246 | TheHandle,\r | |
247 | &ParentControllerHandleCount,\r | |
248 | &ParentControllerHandleBuffer\r | |
249 | );\r | |
250 | SHELL_FREE_NON_NULL (ParentControllerHandleBuffer);\r | |
251 | if (ParentControllerHandleCount > 0) {\r | |
252 | continue;\r | |
253 | }\r | |
254 | \r | |
255 | //\r | |
256 | // Start a devtree from TheHandle that has a device path and no parents\r | |
257 | //\r | |
4ba49616 | 258 | ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r |
259 | }\r | |
260 | } else {\r | |
361a8267 | 261 | Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r |
262 | if (EFI_ERROR(Status) || ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r | |
bc280720 | 263 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"devtree", Lang); \r |
4ba49616 | 264 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
265 | } else {\r | |
361a8267 | 266 | ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r |
4ba49616 | 267 | }\r |
268 | }\r | |
269 | \r | |
270 | if (HiiString != NULL) {\r | |
271 | FreePool(HiiString);\r | |
272 | }\r | |
273 | SHELL_FREE_NON_NULL(Language);\r | |
274 | ShellCommandLineFreeVarList (Package);\r | |
275 | }\r | |
276 | \r | |
277 | return (ShellStatus);\r | |
278 | }\r |