]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/LoadPciRom.c
ShellPkg: Update header file including style
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / LoadPciRom.c
CommitLineData
5d73d92f 1/** @file\r
2 Main file for LoadPciRom shell Debug1 function.\r
3\r
c011b6c9 4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
20cfed16 5 Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r
5d73d92f 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 "UefiShellDebug1CommandsLib.h"\r
17#include <IndustryStandard/Pci22.h>\r
18#include <IndustryStandard/Pci23.h>\r
19#include <IndustryStandard/PeImage.h>\r
20#include <Protocol/Decompress.h>\r
21\r
3737ac2b 22/**\r
23 Connects all available drives and controllers.\r
24\r
25 @retval EFI_SUCCESS The operation was successful.\r
26 @retval EFI_ABORTED The abort mechanism was received.\r
27**/\r
5d73d92f 28EFI_STATUS\r
5d73d92f 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
5d73d92f 47LoadEfiDriversFromRomImage (\r
48 VOID *RomBar,\r
49 UINTN RomSize,\r
50 CONST CHAR16 *FileName\r
51 );\r
52\r
53STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
54 {L"-nc", TypeFlag},\r
55 {NULL, TypeMax}\r
56 };\r
57\r
3737ac2b 58/**\r
59 Function for 'loadpcirom' command.\r
60\r
61 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
62 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
63**/\r
5d73d92f 64SHELL_STATUS\r
65EFIAPI\r
66ShellCommandRunLoadPciRom (\r
67 IN EFI_HANDLE ImageHandle,\r
68 IN EFI_SYSTEM_TABLE *SystemTable\r
69 )\r
70{\r
71 EFI_SHELL_FILE_INFO *FileList;\r
72 UINTN SourceSize;\r
73 UINT8 *File1Buffer;\r
74 EFI_STATUS Status;\r
75 LIST_ENTRY *Package;\r
76 CHAR16 *ProblemParam;\r
77 SHELL_STATUS ShellStatus;\r
78 BOOLEAN Connect;\r
79 CONST CHAR16 *Param;\r
80 UINTN ParamCount;\r
81 EFI_SHELL_FILE_INFO *Node;\r
82 //\r
83 // Local variable initializations\r
84 //\r
85 File1Buffer = NULL;\r
86 ShellStatus = SHELL_SUCCESS;\r
87 FileList = NULL;\r
88\r
89\r
90 //\r
91 // verify number of arguments\r
92 //\r
93 Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
94 if (EFI_ERROR(Status)) {\r
95 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
4092a8f6 96 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"loadpcirom", ProblemParam); \r
5d73d92f 97 FreePool(ProblemParam);\r
98 ShellStatus = SHELL_INVALID_PARAMETER;\r
99 } else {\r
100 ASSERT(FALSE);\r
101 }\r
102 } else {\r
3737ac2b 103 if (ShellCommandLineGetCount(Package) < 2) {\r
4092a8f6 104 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"loadpcirom"); \r
5d73d92f 105 ShellStatus = SHELL_INVALID_PARAMETER;\r
106 } else {\r
3737ac2b 107 if (ShellCommandLineGetFlag(Package, L"-nc")) {\r
5d73d92f 108 Connect = FALSE;\r
109 } else {\r
110 Connect = TRUE;\r
111 }\r
112\r
113 //\r
114 // get a list with each file specified by parameters\r
115 // if parameter is a directory then add all the files below it to the list\r
116 //\r
117 for ( ParamCount = 1, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
118 ; Param != NULL\r
119 ; ParamCount++, Param = ShellCommandLineGetRawValue(Package, ParamCount)\r
120 ){\r
121 Status = ShellOpenFileMetaArg((CHAR16*)Param, EFI_FILE_MODE_WRITE|EFI_FILE_MODE_READ, &FileList);\r
122 if (EFI_ERROR(Status)) {\r
4092a8f6 123 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellDebug1HiiHandle, L"loadpcirom", Param); \r
5d73d92f 124 ShellStatus = SHELL_ACCESS_DENIED;\r
125 break;\r
126 }\r
127 }\r
3737ac2b 128 if (ShellStatus == SHELL_SUCCESS && FileList != NULL) {\r
5d73d92f 129 //\r
130 // loop through the list and make sure we are not aborting...\r
131 //\r
132 for ( Node = (EFI_SHELL_FILE_INFO*)GetFirstNode(&FileList->Link)\r
133 ; !IsNull(&FileList->Link, &Node->Link) && !ShellGetExecutionBreakFlag()\r
134 ; Node = (EFI_SHELL_FILE_INFO*)GetNextNode(&FileList->Link, &Node->Link)\r
135 ){\r
136 if (EFI_ERROR(Node->Status)){\r
4092a8f6 137 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellDebug1HiiHandle, L"loadpcirom", Node->FullName); \r
5d73d92f 138 ShellStatus = SHELL_INVALID_PARAMETER;\r
139 continue;\r
140 }\r
141 if (FileHandleIsDirectory(Node->Handle) == EFI_SUCCESS) {\r
4092a8f6 142 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_NOT_DIR), gShellDebug1HiiHandle, L"loadpcirom", Node->FullName); \r
5d73d92f 143 ShellStatus = SHELL_INVALID_PARAMETER;\r
144 continue;\r
145 }\r
146 SourceSize = (UINTN) Node->Info->FileSize;\r
3737ac2b 147 File1Buffer = AllocateZeroPool (SourceSize);\r
20cfed16
RN
148 if (File1Buffer == NULL) {\r
149 ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellDebug1HiiHandle, L"loadpcirom");\r
150 ShellStatus = SHELL_OUT_OF_RESOURCES;\r
151 continue;\r
152 }\r
5d73d92f 153 Status = gEfiShellProtocol->ReadFile(Node->Handle, &SourceSize, File1Buffer);\r
154 if (EFI_ERROR(Status)) {\r
4092a8f6 155 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_READ_FAIL), gShellDebug1HiiHandle, L"loadpcirom", Node->FullName); \r
5d73d92f 156 ShellStatus = SHELL_INVALID_PARAMETER;\r
157 } else {\r
158 Status = LoadEfiDriversFromRomImage (\r
159 File1Buffer,\r
160 SourceSize,\r
161 Node->FullName\r
162 );\r
163\r
164 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOAD_PCI_ROM_RES), gShellDebug1HiiHandle, Node->FullName, Status);\r
165 }\r
166 FreePool(File1Buffer);\r
167 }\r
3737ac2b 168 } else if (ShellStatus == SHELL_SUCCESS) {\r
4092a8f6 169 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_FILE_NOT_SPEC), gShellDebug1HiiHandle, "loadpcirom"); \r
3737ac2b 170 ShellStatus = SHELL_NOT_FOUND;\r
5d73d92f 171 }\r
172 if (FileList != NULL && !IsListEmpty(&FileList->Link)) {\r
173 Status = ShellCloseFileMetaArg(&FileList);\r
174 }\r
175 FileList = NULL;\r
176\r
177 if (Connect) {\r
178 Status = LoadPciRomConnectAllDriversToAllControllers ();\r
179 }\r
180 }\r
181 }\r
182\r
183 return (ShellStatus);\r
184}\r
185\r
3737ac2b 186/**\r
187 Command entry point.\r
188\r
189 @param[in] RomBar The Rom Base address.\r
190 @param[in] RomSize The Rom size.\r
191 @param[in] FileName The file name.\r
192\r
193 @retval EFI_SUCCESS The command completed successfully.\r
194 @retval EFI_INVALID_PARAMETER Command usage error.\r
195 @retval EFI_UNSUPPORTED Protocols unsupported.\r
196 @retval EFI_OUT_OF_RESOURCES Out of memory.\r
197 @retval Other value Unknown error.\r
198**/\r
5d73d92f 199EFI_STATUS\r
200LoadEfiDriversFromRomImage (\r
201 VOID *RomBar,\r
202 UINTN RomSize,\r
203 CONST CHAR16 *FileName\r
204 )\r
5d73d92f 205\r
5d73d92f 206{\r
207 EFI_PCI_EXPANSION_ROM_HEADER *EfiRomHeader;\r
208 PCI_DATA_STRUCTURE *Pcir;\r
209 UINTN ImageIndex;\r
210 UINTN RomBarOffset;\r
211 UINT32 ImageSize;\r
212 UINT16 ImageOffset;\r
213 EFI_HANDLE ImageHandle;\r
214 EFI_STATUS Status;\r
3737ac2b 215 EFI_STATUS ReturnStatus;\r
5d73d92f 216 CHAR16 RomFileName[280];\r
217 EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
218 BOOLEAN SkipImage;\r
219 UINT32 DestinationSize;\r
220 UINT32 ScratchSize;\r
221 UINT8 *Scratch;\r
222 VOID *ImageBuffer;\r
223 VOID *DecompressedImageBuffer;\r
224 UINT32 ImageLength;\r
225 EFI_DECOMPRESS_PROTOCOL *Decompress;\r
94020bb4 226 UINT32 InitializationSize;\r
5d73d92f 227\r
228 ImageIndex = 0;\r
3737ac2b 229 ReturnStatus = EFI_NOT_FOUND;\r
5d73d92f 230 RomBarOffset = (UINTN) RomBar;\r
231\r
232 do {\r
233\r
234 EfiRomHeader = (EFI_PCI_EXPANSION_ROM_HEADER *) (UINTN) RomBarOffset;\r
235\r
94020bb4 236 if (EfiRomHeader->Signature != PCI_EXPANSION_ROM_HEADER_SIGNATURE) {\r
4092a8f6 237 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_CORRUPT), gShellDebug1HiiHandle, L"loadpcirom", FileName, ImageIndex); \r
5d73d92f 238// PrintToken (STRING_TOKEN (STR_LOADPCIROM_IMAGE_CORRUPT), HiiHandle, ImageIndex);\r
3737ac2b 239 return ReturnStatus;\r
5d73d92f 240 }\r
241\r
94020bb4 242 //\r
243 // If the pointer to the PCI Data Structure is invalid, no further images can be located. \r
244 // The PCI Data Structure must be DWORD aligned. \r
245 //\r
246 if (EfiRomHeader->PcirOffset == 0 ||\r
247 (EfiRomHeader->PcirOffset & 3) != 0 ||\r
248 RomBarOffset - (UINTN)RomBar + EfiRomHeader->PcirOffset + sizeof (PCI_DATA_STRUCTURE) > RomSize) {\r
249 break;\r
250 }\r
251\r
5d73d92f 252 Pcir = (PCI_DATA_STRUCTURE *) (UINTN) (RomBarOffset + EfiRomHeader->PcirOffset);\r
94020bb4 253 //\r
254 // If a valid signature is not present in the PCI Data Structure, no further images can be located.\r
255 //\r
256 if (Pcir->Signature != PCI_DATA_STRUCTURE_SIGNATURE) {\r
257 break;\r
258 }\r
5d73d92f 259 ImageSize = Pcir->ImageLength * 512;\r
94020bb4 260 if (RomBarOffset - (UINTN)RomBar + ImageSize > RomSize) {\r
261 break;\r
262 }\r
5d73d92f 263\r
264 if ((Pcir->CodeType == PCI_CODE_TYPE_EFI_IMAGE) &&\r
94020bb4 265 (EfiRomHeader->EfiSignature == EFI_PCI_EXPANSION_ROM_HEADER_EFISIGNATURE) &&\r
266 ((EfiRomHeader->EfiSubsystem == EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER) ||\r
267 (EfiRomHeader->EfiSubsystem == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER))) {\r
268\r
269 ImageOffset = EfiRomHeader->EfiImageHeaderOffset;\r
270 InitializationSize = EfiRomHeader->InitializationSize * 512;\r
5d73d92f 271\r
94020bb4 272 if (InitializationSize <= ImageSize && ImageOffset < InitializationSize) {\r
5d73d92f 273\r
274 ImageBuffer = (VOID *) (UINTN) (RomBarOffset + ImageOffset);\r
94020bb4 275 ImageLength = InitializationSize - ImageOffset;\r
5d73d92f 276 DecompressedImageBuffer = NULL;\r
277\r
278 //\r
279 // decompress here if needed\r
280 //\r
281 SkipImage = FALSE;\r
282 if (EfiRomHeader->CompressionType > EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED) {\r
283 SkipImage = TRUE;\r
284 }\r
285\r
286 if (EfiRomHeader->CompressionType == EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED) {\r
287 Status = gBS->LocateProtocol (&gEfiDecompressProtocolGuid, NULL, (VOID**)&Decompress);\r
288 ASSERT_EFI_ERROR(Status);\r
289 if (EFI_ERROR (Status)) {\r
290 SkipImage = TRUE;\r
291 } else {\r
292 SkipImage = TRUE;\r
293 Status = Decompress->GetInfo (\r
294 Decompress,\r
295 ImageBuffer,\r
296 ImageLength,\r
297 &DestinationSize,\r
298 &ScratchSize\r
299 );\r
300 if (!EFI_ERROR (Status)) {\r
3737ac2b 301 DecompressedImageBuffer = AllocateZeroPool (DestinationSize);\r
5d73d92f 302 if (ImageBuffer != NULL) {\r
3737ac2b 303 Scratch = AllocateZeroPool (ScratchSize);\r
5d73d92f 304 if (Scratch != NULL) {\r
305 Status = Decompress->Decompress (\r
306 Decompress,\r
307 ImageBuffer,\r
308 ImageLength,\r
309 DecompressedImageBuffer,\r
310 DestinationSize,\r
311 Scratch,\r
312 ScratchSize\r
313 );\r
314 if (!EFI_ERROR (Status)) {\r
315 ImageBuffer = DecompressedImageBuffer;\r
316 ImageLength = DestinationSize;\r
317 SkipImage = FALSE;\r
318 }\r
319\r
320 FreePool (Scratch);\r
321 }\r
322 }\r
323 }\r
324 }\r
325 }\r
326\r
327 if (!SkipImage) {\r
328 //\r
329 // load image and start image\r
330 //\r
331 UnicodeSPrint (RomFileName, sizeof (RomFileName), L"%s[%d]", FileName, ImageIndex);\r
332 FilePath = FileDevicePath (NULL, RomFileName);\r
333\r
334 Status = gBS->LoadImage (\r
335 TRUE,\r
336 gImageHandle,\r
337 FilePath,\r
338 ImageBuffer,\r
339 ImageLength,\r
340 &ImageHandle\r
341 );\r
342 if (EFI_ERROR (Status)) {\r
4092a8f6 343 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_LOAD_FAIL), gShellDebug1HiiHandle, L"loadpcirom", FileName, ImageIndex); \r
5d73d92f 344// PrintToken (STRING_TOKEN (STR_LOADPCIROM_LOAD_IMAGE_ERROR), HiiHandle, ImageIndex, Status);\r
345 } else {\r
346 Status = gBS->StartImage (ImageHandle, NULL, NULL);\r
347 if (EFI_ERROR (Status)) {\r
4092a8f6 348 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_LOADPCIROM_START_FAIL), gShellDebug1HiiHandle, L"loadpcirom", FileName, ImageIndex); \r
5d73d92f 349// PrintToken (STRING_TOKEN (STR_LOADPCIROM_START_IMAGE), HiiHandle, ImageIndex, Status);\r
350 } else {\r
3737ac2b 351 ReturnStatus = Status;\r
5d73d92f 352 }\r
353 }\r
354 }\r
355\r
356 if (DecompressedImageBuffer != NULL) {\r
357 FreePool (DecompressedImageBuffer);\r
358 }\r
359\r
360 }\r
361 }\r
362\r
363 RomBarOffset = RomBarOffset + ImageSize;\r
364 ImageIndex++;\r
365 } while (((Pcir->Indicator & 0x80) == 0x00) && ((RomBarOffset - (UINTN) RomBar) < RomSize));\r
366\r
3737ac2b 367 return ReturnStatus;\r
5d73d92f 368}\r
369\r
3737ac2b 370/**\r
371 Connects all available drives and controllers.\r
372\r
373 @retval EFI_SUCCESS The operation was successful.\r
374 @retval EFI_ABORTED The abort mechanism was received.\r
375**/\r
5d73d92f 376EFI_STATUS\r
377LoadPciRomConnectAllDriversToAllControllers (\r
378 VOID\r
379 )\r
5d73d92f 380{\r
381 EFI_STATUS Status;\r
5d73d92f 382 UINTN HandleCount;\r
383 EFI_HANDLE *HandleBuffer;\r
fc41b97f
RN
384 UINTN Index;\r
385\r
386 Status = gBS->LocateHandleBuffer (\r
387 AllHandles,\r
388 NULL,\r
389 NULL,\r
390 &HandleCount,\r
391 &HandleBuffer\r
392 );\r
5d73d92f 393 if (EFI_ERROR (Status)) {\r
394 return Status;\r
395 }\r
396\r
fc41b97f 397 for (Index = 0; Index < HandleCount; Index++) {\r
5d73d92f 398 if (ShellGetExecutionBreakFlag ()) {\r
399 Status = EFI_ABORTED;\r
fc41b97f 400 break;\r
5d73d92f 401 }\r
fc41b97f
RN
402 gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
403 }\r
5d73d92f 404\r
fc41b97f 405 if (HandleBuffer != NULL) {\r
5d73d92f 406 FreePool (HandleBuffer);\r
5d73d92f 407 }\r
5d73d92f 408 return Status;\r
409}\r