]>
Commit | Line | Data |
---|---|---|
4ba49616 | 1 | /** @file\r |
2 | Main file for DevTree shell Driver1 function.\r | |
3 | \r | |
bbe94d7a | 4 | Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>\r |
f330ff35 | 5 | Copyright (c) 2010 - 2012, 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 | |
60 | ASSERT(TheHandle != NULL);\r | |
bbe94d7a TS |
61 | \r |
62 | if (ShellGetExecutionBreakFlag()) {\r | |
63 | ShellStatus = SHELL_ABORTED;\r | |
64 | return ShellStatus;\r | |
65 | }\r | |
66 | \r | |
4ba49616 | 67 | //\r |
68 | // We want controller handles. they will not have LoadedImage or DriverBinding (or others...)\r | |
69 | //\r | |
70 | Status = gBS->OpenProtocol (\r | |
71 | TheHandle,\r | |
72 | &gEfiDriverBindingProtocolGuid,\r | |
73 | NULL,\r | |
74 | NULL,\r | |
75 | NULL,\r | |
76 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
77 | );\r | |
78 | if (!EFI_ERROR (Status)) {\r | |
79 | return SHELL_SUCCESS;\r | |
80 | }\r | |
81 | \r | |
82 | Status = gBS->OpenProtocol (\r | |
83 | TheHandle,\r | |
84 | &gEfiLoadedImageProtocolGuid,\r | |
85 | NULL,\r | |
86 | NULL,\r | |
87 | NULL,\r | |
88 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
89 | );\r | |
90 | if (!EFI_ERROR (Status)) {\r | |
91 | return SHELL_SUCCESS;\r | |
92 | }\r | |
93 | \r | |
4ba49616 | 94 | FormatString = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r |
95 | \r | |
96 | ASSERT(HiiString != NULL);\r | |
97 | ASSERT(FormatString != NULL);\r | |
98 | \r | |
99 | //\r | |
100 | // we generate the format string on the fly so that we can control the\r | |
101 | // number of space characters that the first (empty) string has. this\r | |
102 | // handles the indenting.\r | |
103 | //\r | |
104 | \r | |
105 | UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r | |
106 | 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 | |
107 | //\r | |
108 | // print out the information for ourselves\r | |
109 | //\r | |
110 | ShellPrintEx(\r | |
111 | -1,\r | |
112 | -1,\r | |
113 | FormatString,\r | |
114 | L"",\r | |
115 | ConvertHandleToHandleIndex(TheHandle),\r | |
116 | Name==NULL?L"Unknown":Name);\r | |
117 | \r | |
118 | FreePool(FormatString);\r | |
119 | if (Name != NULL) {\r | |
120 | FreePool(Name);\r | |
121 | }\r | |
122 | \r | |
123 | //\r | |
124 | // recurse on each child handle with IndentCharCount + 2\r | |
125 | //\r | |
126 | ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r | |
127 | for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r | |
128 | ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r | |
bbe94d7a TS |
129 | if (ShellStatus == SHELL_ABORTED) {\r |
130 | break;\r | |
131 | }\r | |
4ba49616 | 132 | }\r |
133 | \r | |
134 | if (ChildHandleBuffer != NULL) {\r | |
135 | FreePool(ChildHandleBuffer);\r | |
136 | }\r | |
137 | \r | |
138 | return (ShellStatus);\r | |
139 | }\r | |
140 | \r | |
141 | /**\r | |
142 | Function for 'devtree' command.\r | |
143 | \r | |
144 | @param[in] ImageHandle Handle to the Image (NULL if Internal).\r | |
145 | @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r | |
146 | **/\r | |
147 | SHELL_STATUS\r | |
148 | EFIAPI\r | |
149 | ShellCommandRunDevTree (\r | |
150 | IN EFI_HANDLE ImageHandle,\r | |
151 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
152 | )\r | |
153 | {\r | |
154 | EFI_STATUS Status;\r | |
155 | LIST_ENTRY *Package;\r | |
156 | CHAR16 *ProblemParam;\r | |
157 | SHELL_STATUS ShellStatus;\r | |
158 | CHAR8 *Language;\r | |
159 | CONST CHAR16 *Lang;\r | |
160 | CHAR16 *HiiString;\r | |
161 | UINTN LoopVar;\r | |
162 | EFI_HANDLE TheHandle;\r | |
163 | BOOLEAN FlagD;\r | |
361a8267 | 164 | UINT64 Intermediate;\r |
f330ff35 | 165 | UINTN ParentControllerHandleCount;\r |
166 | EFI_HANDLE *ParentControllerHandleBuffer;\r | |
4ba49616 | 167 | \r |
168 | ShellStatus = SHELL_SUCCESS;\r | |
169 | Status = EFI_SUCCESS;\r | |
170 | Language = NULL;\r | |
171 | \r | |
172 | //\r | |
173 | // initialize the shell lib (we must be in non-auto-init...)\r | |
174 | //\r | |
175 | Status = ShellInitialize();\r | |
176 | ASSERT_EFI_ERROR(Status);\r | |
177 | \r | |
178 | Status = CommandInit();\r | |
179 | ASSERT_EFI_ERROR(Status);\r | |
180 | \r | |
181 | //\r | |
182 | // parse the command line\r | |
183 | //\r | |
184 | Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r | |
185 | if (EFI_ERROR(Status)) {\r | |
186 | if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r | |
187 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, ProblemParam);\r | |
188 | FreePool(ProblemParam);\r | |
189 | ShellStatus = SHELL_INVALID_PARAMETER;\r | |
190 | } else {\r | |
191 | ASSERT(FALSE);\r | |
192 | }\r | |
193 | } else {\r | |
194 | if (ShellCommandLineGetCount(Package) > 2) {\r | |
195 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r | |
196 | ShellCommandLineFreeVarList (Package);\r | |
197 | return (SHELL_INVALID_PARAMETER);\r | |
198 | }\r | |
199 | Lang = ShellCommandLineGetValue(Package, L"-l");\r | |
200 | if (Lang != NULL) {\r | |
201 | Language = AllocateZeroPool(StrSize(Lang));\r | |
202 | AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r | |
203 | } else if (!ShellCommandLineGetFlag(Package, L"-l")){\r | |
204 | ASSERT(Language == NULL);\r | |
205 | // Language = AllocateZeroPool(10);\r | |
206 | // AsciiSPrint(Language, 10, "en-us");\r | |
207 | } else {\r | |
208 | ASSERT(Language == NULL);\r | |
209 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r | |
210 | ShellCommandLineFreeVarList (Package);\r | |
211 | return (SHELL_INVALID_PARAMETER);\r | |
212 | }\r | |
213 | FlagD = ShellCommandLineGetFlag(Package, L"-d");\r | |
214 | \r | |
215 | Lang = ShellCommandLineGetRawValue(Package, 1);\r | |
216 | HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r | |
217 | \r | |
218 | if (Lang == NULL) {\r | |
219 | for (LoopVar = 1 ; ; LoopVar++){\r | |
220 | TheHandle = ConvertHandleIndexToHandle(LoopVar);\r | |
221 | if (TheHandle == NULL){\r | |
222 | break;\r | |
223 | }\r | |
f330ff35 | 224 | \r |
225 | //\r | |
226 | // Skip handles that do not have device path protocol\r | |
227 | //\r | |
228 | Status = gBS->OpenProtocol (\r | |
229 | TheHandle,\r | |
230 | &gEfiDevicePathProtocolGuid,\r | |
231 | NULL,\r | |
232 | NULL,\r | |
233 | NULL,\r | |
234 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
235 | );\r | |
236 | if (EFI_ERROR (Status)) {\r | |
237 | continue;\r | |
238 | }\r | |
239 | \r | |
240 | //\r | |
241 | // Skip handles that do have parents\r | |
242 | //\r | |
243 | ParentControllerHandleBuffer = NULL;\r | |
244 | Status = PARSE_HANDLE_DATABASE_PARENTS (\r | |
245 | TheHandle,\r | |
246 | &ParentControllerHandleCount,\r | |
247 | &ParentControllerHandleBuffer\r | |
248 | );\r | |
249 | SHELL_FREE_NON_NULL (ParentControllerHandleBuffer);\r | |
250 | if (ParentControllerHandleCount > 0) {\r | |
251 | continue;\r | |
252 | }\r | |
253 | \r | |
254 | //\r | |
255 | // Start a devtree from TheHandle that has a device path and no parents\r | |
256 | //\r | |
4ba49616 | 257 | ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r |
258 | }\r | |
259 | } else {\r | |
361a8267 | 260 | Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r |
261 | if (EFI_ERROR(Status) || ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r | |
4ba49616 | 262 | ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Lang);\r |
263 | ShellStatus = SHELL_INVALID_PARAMETER;\r | |
264 | } else {\r | |
361a8267 | 265 | ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r |
4ba49616 | 266 | }\r |
267 | }\r | |
268 | \r | |
269 | if (HiiString != NULL) {\r | |
270 | FreePool(HiiString);\r | |
271 | }\r | |
272 | SHELL_FREE_NON_NULL(Language);\r | |
273 | ShellCommandLineFreeVarList (Package);\r | |
274 | }\r | |
275 | \r | |
276 | return (ShellStatus);\r | |
277 | }\r |