]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/LoadPciRom.c
Enhance the error handling.
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / LoadPciRom.c
CommitLineData
5d73d92f 1/** @file\r
2 Main file for LoadPciRom shell Debug1 function.\r
3\r
3737ac2b 4 Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
5d73d92f 5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "UefiShellDebug1CommandsLib.h"\r
16#include <IndustryStandard/Pci22.h>\r
17#include <IndustryStandard/Pci23.h>\r
18#include <IndustryStandard/PeImage.h>\r
19#include <Protocol/Decompress.h>\r
20\r
3737ac2b 21/**\r
22 Connects all available drives and controllers.\r
23\r
24 @retval EFI_SUCCESS The operation was successful.\r
25 @retval EFI_ABORTED The abort mechanism was received.\r
26**/\r
5d73d92f 27EFI_STATUS\r
28EFIAPI\r
29LoadPciRomConnectAllDriversToAllControllers (\r
30 VOID\r
31 );\r
32\r
3737ac2b 33/**\r
34 Command entry point.\r
5d73d92f 35\r
3737ac2b 36 @param[in] RomBar The Rom Base address.\r
37 @param[in] RomSize The Rom size.\r
38 @param[in] FileName The file name.\r
39\r
40 @retval EFI_SUCCESS The command completed successfully.\r
41 @retval EFI_INVALID_PARAMETER Command usage error.\r
42 @retval EFI_UNSUPPORTED Protocols unsupported.\r
43 @retval EFI_OUT_OF_RESOURCES Out of memory.\r
44 @retval Other value Unknown error.\r
45**/\r
5d73d92f 46EFI_STATUS\r
47EFIAPI\r
48LoadEfiDriversFromRomImage (\r
49 VOID *RomBar,\r
50 UINTN RomSize,\r
51 CONST CHAR16 *FileName\r
52 );\r
53\r
54STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
55 {L"-nc", TypeFlag},\r
56 {NULL, TypeMax}\r
57 };\r
58\r
3737ac2b 59/**\r
60 Function for 'loadpcirom' command.\r
61\r
62 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
63 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
64**/\r
5d73d92f 65SHELL_STATUS\r
66EFIAPI\r
67ShellCommandRunLoadPciRom (\r
68 IN EFI_HANDLE ImageHandle,\r
69 IN EFI_SYSTEM_TABLE *SystemTable\r
70 )\r
71{\r
72 EFI_SHELL_FILE_INFO *FileList;\r
73 UINTN SourceSize;\r
74 UINT8 *File1Buffer;\r
75 EFI_STATUS Status;\r
76 LIST_ENTRY *Package;\r
77 CHAR16 *ProblemParam;\r
78 SHELL_STATUS ShellStatus;\r
79 BOOLEAN Connect;\r
80 CONST CHAR16 *Param;\r
81 UINTN ParamCount;\r
82 EFI_SHELL_FILE_INFO *Node;\r
83 //\r
84 // Local variable initializations\r
85 //\r
86 File1Buffer = NULL;\r
87 ShellStatus = SHELL_SUCCESS;\r
88 FileList = NULL;\r
89\r
90\r
91 //\r
92 // verify number of arguments\r
93 //\r
94 Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
95 if (EFI_ERROR(Status)) {\r
96 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
97 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, ProblemParam);\r
98 FreePool(ProblemParam);\r
99 ShellStatus = SHELL_INVALID_PARAMETER;\r
100 } else {\r
101 ASSERT(FALSE);\r
102 }\r
103 } else {\r
3737ac2b 104 if (ShellCommandLineGetCount(Package) < 2) {\r
5d73d92f 105 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle);\r
106 ShellStatus = SHELL_INVALID_PARAMETER;\r
107 } else {\r
3737ac2b 108 if (ShellCommandLineGetFlag(Package, L"-nc")) {\r
5d73d92f 109 Connect = FALSE;\r
110 } else {\r
111 Connect = TRUE;\r
112 }\r
113\r
114 //\r
115 // get a list with each file specified by parameters\r
116 // if parameter is a directory then add all the files below it to the list\r
117 //\r
118 for ( ParamCount = 1, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
119 ; Param != NULL\r
120 ; ParamCount++, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
121 ){\r
122 Status = ShellOpenFileMetaArg((CHAR16*)Param, EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ, &FileList);\r
123 if (EFI_ERROR(Status)) {\r
3737ac2b 124 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_OPEN_FAIL), gShellDebug1HiiHandle, Param, Status);\r
5d73d92f 125 ShellStatus = SHELL_ACCESS_DENIED;\r
126 break;\r
127 }\r
128 }\r
3737ac2b 129 if (ShellStatus == SHELL_SUCCESS && FileList != NULL) {\r
5d73d92f 130 //\r
131 // loop through the list and make sure we are not aborting...\r
132 //\r
133 for ( Node = (EFI_SHELL_FILE_INFO*)GetFirstNode(&FileList->Link)\r
134 ; !IsNull(&FileList->Link, &Node->Link) && !ShellGetExecutionBreakFlag()\r
135 ; Node = (EFI_SHELL_FILE_INFO*)GetNextNode(&FileList->Link, &Node->Link)\r
136 ){\r
137 if (EFI_ERROR(Node->Status)){\r
138 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_OPEN_FAIL), gShellDebug1HiiHandle, Node->FullName);\r
139 ShellStatus = SHELL_INVALID_PARAMETER;\r
140 continue;\r
141 }\r
142 if (FileHandleIsDirectory(Node->Handle) == EFI_SUCCESS) {\r
143 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_NOT_DIR), gShellDebug1HiiHandle, Node->FullName);\r
144 ShellStatus = SHELL_INVALID_PARAMETER;\r
145 continue;\r
146 }\r
147 SourceSize = (UINTN) Node->Info->FileSize;\r
3737ac2b 148 File1Buffer = AllocateZeroPool (SourceSize);\r
5d73d92f 149 ASSERT(File1Buffer != NULL);\r
150 Status = gEfiShellProtocol->ReadFile(Node->Handle, &SourceSize, File1Buffer);\r
151 if (EFI_ERROR(Status)) {\r
152 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_READ_FAIL), gShellDebug1HiiHandle, Node->FullName);\r
153 ShellStatus = SHELL_INVALID_PARAMETER;\r
154 } else {\r
155 Status = LoadEfiDriversFromRomImage (\r
156 File1Buffer,\r
157 SourceSize,\r
158 Node->FullName\r
159 );\r
160\r
161 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOAD_PCI_ROM_RES), gShellDebug1HiiHandle, Node->FullName, Status);\r
162 }\r
163 FreePool(File1Buffer);\r
164 }\r
3737ac2b 165 } else if (ShellStatus == SHELL_SUCCESS) {\r
166 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_NOT_SPEC), gShellDebug1HiiHandle);\r
167 ShellStatus = SHELL_NOT_FOUND;\r
5d73d92f 168 }\r
169 if (FileList != NULL && !IsListEmpty(&FileList->Link)) {\r
170 Status = ShellCloseFileMetaArg(&FileList);\r
171 }\r
172 FileList = NULL;\r
173\r
174 if (Connect) {\r
175 Status = LoadPciRomConnectAllDriversToAllControllers ();\r
176 }\r
177 }\r
178 }\r
179\r
180 return (ShellStatus);\r
181}\r
182\r
3737ac2b 183/**\r
184 Command entry point.\r
185\r
186 @param[in] RomBar The Rom Base address.\r
187 @param[in] RomSize The Rom size.\r
188 @param[in] FileName The file name.\r
189\r
190 @retval EFI_SUCCESS The command completed successfully.\r
191 @retval EFI_INVALID_PARAMETER Command usage error.\r
192 @retval EFI_UNSUPPORTED Protocols unsupported.\r
193 @retval EFI_OUT_OF_RESOURCES Out of memory.\r
194 @retval Other value Unknown error.\r
195**/\r
5d73d92f 196EFI_STATUS\r
3737ac2b 197EFIAPI\r
5d73d92f 198LoadEfiDriversFromRomImage (\r
199 VOID *RomBar,\r
200 UINTN RomSize,\r
201 CONST CHAR16 *FileName\r
202 )\r
5d73d92f 203\r
5d73d92f 204{\r
205 EFI_PCI_EXPANSION_ROM_HEADER *EfiRomHeader;\r
206 PCI_DATA_STRUCTURE *Pcir;\r
207 UINTN ImageIndex;\r
208 UINTN RomBarOffset;\r
209 UINT32 ImageSize;\r
210 UINT16 ImageOffset;\r
211 EFI_HANDLE ImageHandle;\r
212 EFI_STATUS Status;\r
3737ac2b 213 EFI_STATUS ReturnStatus;\r
5d73d92f 214 CHAR16 RomFileName[280];\r
215 EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
216 BOOLEAN SkipImage;\r
217 UINT32 DestinationSize;\r
218 UINT32 ScratchSize;\r
219 UINT8 *Scratch;\r
220 VOID *ImageBuffer;\r
221 VOID *DecompressedImageBuffer;\r
222 UINT32 ImageLength;\r
223 EFI_DECOMPRESS_PROTOCOL *Decompress;\r
224\r
225 ImageIndex = 0;\r
3737ac2b 226 ReturnStatus = EFI_NOT_FOUND;\r
5d73d92f 227 RomBarOffset = (UINTN) RomBar;\r
228\r
229 do {\r
230\r
231 EfiRomHeader = (EFI_PCI_EXPANSION_ROM_HEADER *) (UINTN) RomBarOffset;\r
232\r
233 if (EfiRomHeader->Signature != 0xaa55) {\r
234 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_CORRUPT), gShellDebug1HiiHandle, FileName, ImageIndex);\r
235// PrintToken (STRING_TOKEN (STR_LOADPCIROM_IMAGE_CORRUPT), HiiHandle, ImageIndex);\r
3737ac2b 236 return ReturnStatus;\r
5d73d92f 237 }\r
238\r
239 Pcir = (PCI_DATA_STRUCTURE *) (UINTN) (RomBarOffset + EfiRomHeader->PcirOffset);\r
240 ImageSize = Pcir->ImageLength * 512;\r
241\r
242 if ((Pcir->CodeType == PCI_CODE_TYPE_EFI_IMAGE) &&\r
243 (EfiRomHeader->EfiSignature == EFI_PCI_EXPANSION_ROM_HEADER_EFISIGNATURE)\r
244 ) {\r
245\r
246 if ((EfiRomHeader->EfiSubsystem == EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER) ||\r
247 (EfiRomHeader->EfiSubsystem == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER)\r
248 ) {\r
249 ImageOffset = EfiRomHeader->EfiImageHeaderOffset;\r
250 ImageSize = EfiRomHeader->InitializationSize * 512;\r
251\r
252 ImageBuffer = (VOID *) (UINTN) (RomBarOffset + ImageOffset);\r
253 ImageLength = ImageSize - ImageOffset;\r
254 DecompressedImageBuffer = NULL;\r
255\r
256 //\r
257 // decompress here if needed\r
258 //\r
259 SkipImage = FALSE;\r
260 if (EfiRomHeader->CompressionType > EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED) {\r
261 SkipImage = TRUE;\r
262 }\r
263\r
264 if (EfiRomHeader->CompressionType == EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED) {\r
265 Status = gBS->LocateProtocol (&gEfiDecompressProtocolGuid, NULL, (VOID**)&Decompress);\r
266 ASSERT_EFI_ERROR(Status);\r
267 if (EFI_ERROR (Status)) {\r
268 SkipImage = TRUE;\r
269 } else {\r
270 SkipImage = TRUE;\r
271 Status = Decompress->GetInfo (\r
272 Decompress,\r
273 ImageBuffer,\r
274 ImageLength,\r
275 &DestinationSize,\r
276 &ScratchSize\r
277 );\r
278 if (!EFI_ERROR (Status)) {\r
3737ac2b 279 DecompressedImageBuffer = AllocateZeroPool (DestinationSize);\r
5d73d92f 280 if (ImageBuffer != NULL) {\r
3737ac2b 281 Scratch = AllocateZeroPool (ScratchSize);\r
5d73d92f 282 if (Scratch != NULL) {\r
283 Status = Decompress->Decompress (\r
284 Decompress,\r
285 ImageBuffer,\r
286 ImageLength,\r
287 DecompressedImageBuffer,\r
288 DestinationSize,\r
289 Scratch,\r
290 ScratchSize\r
291 );\r
292 if (!EFI_ERROR (Status)) {\r
293 ImageBuffer = DecompressedImageBuffer;\r
294 ImageLength = DestinationSize;\r
295 SkipImage = FALSE;\r
296 }\r
297\r
298 FreePool (Scratch);\r
299 }\r
300 }\r
301 }\r
302 }\r
303 }\r
304\r
305 if (!SkipImage) {\r
306 //\r
307 // load image and start image\r
308 //\r
309 UnicodeSPrint (RomFileName, sizeof (RomFileName), L"%s[%d]", FileName, ImageIndex);\r
310 FilePath = FileDevicePath (NULL, RomFileName);\r
311\r
312 Status = gBS->LoadImage (\r
313 TRUE,\r
314 gImageHandle,\r
315 FilePath,\r
316 ImageBuffer,\r
317 ImageLength,\r
318 &ImageHandle\r
319 );\r
320 if (EFI_ERROR (Status)) {\r
321 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_LOAD_FAIL), gShellDebug1HiiHandle, FileName, ImageIndex, Status);\r
322// PrintToken (STRING_TOKEN (STR_LOADPCIROM_LOAD_IMAGE_ERROR), HiiHandle, ImageIndex, Status);\r
323 } else {\r
324 Status = gBS->StartImage (ImageHandle, NULL, NULL);\r
325 if (EFI_ERROR (Status)) {\r
326 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_START_FAIL), gShellDebug1HiiHandle, FileName, ImageIndex, Status);\r
327// PrintToken (STRING_TOKEN (STR_LOADPCIROM_START_IMAGE), HiiHandle, ImageIndex, Status);\r
328 } else {\r
3737ac2b 329 ReturnStatus = Status;\r
5d73d92f 330 }\r
331 }\r
332 }\r
333\r
334 if (DecompressedImageBuffer != NULL) {\r
335 FreePool (DecompressedImageBuffer);\r
336 }\r
337\r
338 }\r
339 }\r
340\r
341 RomBarOffset = RomBarOffset + ImageSize;\r
342 ImageIndex++;\r
343 } while (((Pcir->Indicator & 0x80) == 0x00) && ((RomBarOffset - (UINTN) RomBar) < RomSize));\r
344\r
3737ac2b 345 return ReturnStatus;\r
5d73d92f 346}\r
347\r
3737ac2b 348/**\r
349 Connects all available drives and controllers.\r
350\r
351 @retval EFI_SUCCESS The operation was successful.\r
352 @retval EFI_ABORTED The abort mechanism was received.\r
353**/\r
5d73d92f 354EFI_STATUS\r
3737ac2b 355EFIAPI\r
5d73d92f 356LoadPciRomConnectAllDriversToAllControllers (\r
357 VOID\r
358 )\r
359\r
360{\r
361 EFI_STATUS Status;\r
362 UINTN AllHandleCount;\r
363 EFI_HANDLE *AllHandleBuffer;\r
364 UINTN Index;\r
365 UINTN HandleCount;\r
366 EFI_HANDLE *HandleBuffer;\r
367 UINTN *HandleType;\r
368 UINTN HandleIndex;\r
369 BOOLEAN Parent;\r
370 BOOLEAN Device;\r
371\r
372 Status = gBS->LocateHandleBuffer(\r
373 AllHandles,\r
374 NULL,\r
375 NULL,\r
376 &AllHandleCount,\r
377 &AllHandleBuffer\r
378 );\r
379 if (EFI_ERROR (Status)) {\r
380 return Status;\r
381 }\r
382\r
383 for (Index = 0; Index < AllHandleCount; Index++) {\r
384 if (ShellGetExecutionBreakFlag ()) {\r
385 Status = EFI_ABORTED;\r
386 goto Done;\r
387 }\r
388 //\r
389 // Scan the handle database\r
390 //\r
391 Status = ParseHandleDatabaseByRelationshipWithType(\r
392 NULL,\r
393 AllHandleBuffer[Index],\r
394 &HandleCount,\r
395 &HandleBuffer,\r
396 &HandleType\r
397 );\r
398/*\r
399 Status = LibScanHandleDatabase (\r
400 NULL,\r
401 NULL,\r
402 AllHandleBuffer[Index],\r
403 NULL,\r
404 &HandleCount,\r
405 &HandleBuffer,\r
406 &HandleType\r
407 );\r
408*/\r
409 if (EFI_ERROR (Status)) {\r
410 goto Done;\r
411 }\r
412\r
413 Device = TRUE;\r
414 if ((HandleType[Index] & HR_DRIVER_BINDING_HANDLE) != 0) {\r
415 Device = FALSE;\r
416 }\r
417\r
418 if ((HandleType[Index] & HR_IMAGE_HANDLE) != 0) {\r
419 Device = FALSE;\r
420 }\r
421\r
422 if (Device) {\r
423 Parent = FALSE;\r
424 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
425 if ((HandleType[HandleIndex] & HR_PARENT_HANDLE) != 0) {\r
426 Parent = TRUE;\r
427 }\r
428 }\r
429\r
430 if (!Parent) {\r
431 if ((HandleType[Index] & HR_DEVICE_HANDLE) != 0) {\r
432 Status = gBS->ConnectController (\r
433 AllHandleBuffer[Index],\r
434 NULL,\r
435 NULL,\r
436 TRUE\r
437 );\r
438 }\r
439 }\r
440 }\r
441\r
442 FreePool (HandleBuffer);\r
443 FreePool (HandleType);\r
444 }\r
445\r
446Done:\r
447 FreePool (AllHandleBuffer);\r
448 return Status;\r
449}\r