]> git.proxmox.com Git - mirror_edk2.git/blame - EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
EmbeddedPkg: Install FDT if UpdateDtb is not present
[mirror_edk2.git] / EmbeddedPkg / Library / AndroidBootImgLib / AndroidBootImgLib.c
CommitLineData
fa74dd22
JN		 1/** @file\r
2\r
3 Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>\r
4 Copyright (c) 2017, Linaro. All rights reserved.\r
5\r
878b807a 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
fa74dd22
JN		 7\r
8**/\r
9\r
10#include <libfdt.h>\r
11#include <Library/AndroidBootImgLib.h>\r
12#include <Library/PrintLib.h>\r
13#include <Library/UefiBootServicesTableLib.h>\r
14#include <Library/UefiLib.h>\r
15\r
16#include <Protocol/AndroidBootImg.h>\r
17#include <Protocol/LoadedImage.h>\r
18\r
fa74dd22
JN		 19#define FDT_ADDITIONAL_ENTRIES_SIZE 0x400\r
20\r
21typedef struct {\r
22 MEMMAP_DEVICE_PATH Node1;\r
23 EFI_DEVICE_PATH_PROTOCOL End;\r
24} MEMORY_DEVICE_PATH;\r
25\r
26STATIC ANDROID_BOOTIMG_PROTOCOL *mAndroidBootImg;\r
27\r
28STATIC CONST MEMORY_DEVICE_PATH mMemoryDevicePathTemplate =\r
29{\r
30 {\r
31 {\r
32 HARDWARE_DEVICE_PATH,\r
33 HW_MEMMAP_DP,\r
34 {\r
35 (UINT8)(sizeof (MEMMAP_DEVICE_PATH)),\r
36 (UINT8)((sizeof (MEMMAP_DEVICE_PATH)) >> 8),\r
37 },\r
38 }, // Header\r
39 0, // StartingAddress (set at runtime)\r
40 0 // EndingAddress (set at runtime)\r
41 }, // Node1\r
42 {\r
43 END_DEVICE_PATH_TYPE,\r
44 END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
45 { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 }\r
46 } // End\r
47};\r
48\r
49EFI_STATUS\r
50AndroidBootImgGetImgSize (\r
51 IN VOID *BootImg,\r
52 OUT UINTN *ImgSize\r
53 )\r
54{\r
55 ANDROID_BOOTIMG_HEADER *Header;\r
56\r
57 Header = (ANDROID_BOOTIMG_HEADER *) BootImg;\r
58\r
59 if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,\r
60 ANDROID_BOOT_MAGIC_LENGTH) != 0) {\r
61 return EFI_INVALID_PARAMETER;\r
62 }\r
63\r
64 /* The page size is not specified, but it should be power of 2 at least */\r
65 ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));\r
66\r
67 /* Get real size of abootimg */\r
68 *ImgSize = ALIGN_VALUE (Header->KernelSize, Header->PageSize) +\r
69 ALIGN_VALUE (Header->RamdiskSize, Header->PageSize) +\r
70 ALIGN_VALUE (Header->SecondStageBootloaderSize, Header->PageSize) +\r
71 Header->PageSize;\r
72 return EFI_SUCCESS;\r
73}\r
74\r
75EFI_STATUS\r
76AndroidBootImgGetKernelInfo (\r
77 IN VOID *BootImg,\r
78 OUT VOID **Kernel,\r
79 OUT UINTN *KernelSize\r
80 )\r
81{\r
82 ANDROID_BOOTIMG_HEADER *Header;\r
83\r
84 Header = (ANDROID_BOOTIMG_HEADER *) BootImg;\r
85\r
86 if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,\r
87 ANDROID_BOOT_MAGIC_LENGTH) != 0) {\r
88 return EFI_INVALID_PARAMETER;\r
89 }\r
90\r
91 if (Header->KernelSize == 0) {\r
92 return EFI_NOT_FOUND;\r
93 }\r
94\r
95 ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));\r
96\r
97 *KernelSize = Header->KernelSize;\r
e43d0884 98 *Kernel = (VOID *)((UINTN)BootImg + Header->PageSize);\r
fa74dd22
JN		 99 return EFI_SUCCESS;\r
100}\r
101\r
102EFI_STATUS\r
103AndroidBootImgGetRamdiskInfo (\r
104 IN VOID *BootImg,\r
105 OUT VOID **Ramdisk,\r
106 OUT UINTN *RamdiskSize\r
107 )\r
108{\r
109 ANDROID_BOOTIMG_HEADER *Header;\r
110\r
111 Header = (ANDROID_BOOTIMG_HEADER *)BootImg;\r
112\r
113 if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,\r
114 ANDROID_BOOT_MAGIC_LENGTH) != 0) {\r
115 return EFI_INVALID_PARAMETER;\r
116 }\r
117\r
118 ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));\r
119\r
120 *RamdiskSize = Header->RamdiskSize;\r
121\r
122 if (Header->RamdiskSize != 0) {\r
123 *Ramdisk = (VOID *)((INTN)BootImg\r
124 + Header->PageSize\r
125 + ALIGN_VALUE (Header->KernelSize, Header->PageSize));\r
126 }\r
127 return EFI_SUCCESS;\r
128}\r
129\r
130EFI_STATUS\r
131AndroidBootImgGetSecondBootLoaderInfo (\r
132 IN VOID *BootImg,\r
133 OUT VOID **Second,\r
134 OUT UINTN *SecondSize\r
135 )\r
136{\r
137 ANDROID_BOOTIMG_HEADER *Header;\r
138\r
139 Header = (ANDROID_BOOTIMG_HEADER *)BootImg;\r
140\r
141 if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,\r
142 ANDROID_BOOT_MAGIC_LENGTH) != 0) {\r
143 return EFI_INVALID_PARAMETER;\r
144 }\r
145\r
146 ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));\r
147\r
148 *SecondSize = Header->SecondStageBootloaderSize;\r
149\r
150 if (Header->SecondStageBootloaderSize != 0) {\r
151 *Second = (VOID *)((UINTN)BootImg\r
152 + Header->PageSize\r
153 + ALIGN_VALUE (Header->KernelSize, Header->PageSize)\r
154 + ALIGN_VALUE (Header->RamdiskSize, Header->PageSize));\r
155 }\r
156 return EFI_SUCCESS;\r
157}\r
158\r
159EFI_STATUS\r
160AndroidBootImgGetKernelArgs (\r
161 IN VOID *BootImg,\r
162 OUT CHAR8 *KernelArgs\r
163 )\r
164{\r
165 ANDROID_BOOTIMG_HEADER *Header;\r
166\r
167 Header = (ANDROID_BOOTIMG_HEADER *) BootImg;\r
168 AsciiStrnCpyS (KernelArgs, ANDROID_BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,\r
169 ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);\r
170\r
171 return EFI_SUCCESS;\r
172}\r
173\r
174EFI_STATUS\r
175AndroidBootImgGetFdt (\r
176 IN VOID *BootImg,\r
177 IN VOID **FdtBase\r
178 )\r
179{\r
180 UINTN SecondLoaderSize;\r
181 EFI_STATUS Status;\r
182\r
183 /* Check whether FDT is located in second boot region as some vendor do so,\r
184 * because second loader is never used as far as I know. */\r
185 Status = AndroidBootImgGetSecondBootLoaderInfo (\r
186 BootImg,\r
187 FdtBase,\r
188 &SecondLoaderSize\r
189 );\r
190 return Status;\r
191}\r
192\r
193EFI_STATUS\r
194AndroidBootImgUpdateArgs (\r
195 IN VOID *BootImg,\r
196 OUT VOID *KernelArgs\r
197 )\r
198{\r
199 CHAR8 ImageKernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];\r
200 EFI_STATUS Status;\r
201\r
202 // Get kernel arguments from Android boot image\r
203 Status = AndroidBootImgGetKernelArgs (BootImg, ImageKernelArgs);\r
204 if (EFI_ERROR (Status)) {\r
205 return Status;\r
206 }\r
207 AsciiStrToUnicodeStrS (ImageKernelArgs, KernelArgs,\r
208 ANDROID_BOOTIMG_KERNEL_ARGS_SIZE >> 1);\r
209 // Append platform kernel arguments\r
210 if(mAndroidBootImg->AppendArgs) {\r
211 Status = mAndroidBootImg->AppendArgs (KernelArgs,\r
212 ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);\r
213 }\r
214 return Status;\r
215}\r
216\r
217EFI_STATUS\r
218AndroidBootImgLocateFdt (\r
219 IN VOID *BootImg,\r
220 IN VOID **FdtBase\r
221 )\r
222{\r
223 INTN Err;\r
224 EFI_STATUS Status;\r
225\r
226 Status = EfiGetSystemConfigurationTable (&gFdtTableGuid, FdtBase);\r
227 if (!EFI_ERROR (Status)) {\r
228 return EFI_SUCCESS;\r
229 }\r
230\r
231 Status = AndroidBootImgGetFdt (BootImg, FdtBase);\r
232 if (EFI_ERROR (Status)) {\r
233 return Status;\r
234 }\r
235 Err = fdt_check_header (*FdtBase);\r
236 if (Err != 0) {\r
237 DEBUG ((DEBUG_ERROR, "ERROR: Device Tree header not valid (Err:%d)\n",\r
238 Err));\r
239 return EFI_INVALID_PARAMETER;\r
240 }\r
241 return EFI_SUCCESS;\r
242}\r
243\r
244INTN\r
245AndroidBootImgGetChosenNode (\r
246 IN INTN UpdatedFdtBase\r
247 )\r
248{\r
249 INTN ChosenNode;\r
250\r
251 ChosenNode = fdt_subnode_offset ((CONST VOID *)UpdatedFdtBase, 0, "chosen");\r
252 if (ChosenNode < 0) {\r
253 ChosenNode = fdt_add_subnode((VOID *)UpdatedFdtBase, 0, "chosen");\r
254 if (ChosenNode < 0) {\r
255 DEBUG ((DEBUG_ERROR, "Fail to find fdt node chosen!\n"));\r
256 return 0;\r
257 }\r
258 }\r
259 return ChosenNode;\r
260}\r
261\r
262EFI_STATUS\r
263AndroidBootImgSetProperty64 (\r
264 IN INTN UpdatedFdtBase,\r
265 IN INTN ChosenNode,\r
266 IN CHAR8 *PropertyName,\r
267 IN UINT64 Val\r
268 )\r
269{\r
270 INTN Err;\r
271 struct fdt_property *Property;\r
272 int Len;\r
273\r
274 Property = fdt_get_property_w((VOID *)UpdatedFdtBase, ChosenNode,\r
275 PropertyName, &Len);\r
276 if (NULL == Property && Len == -FDT_ERR_NOTFOUND) {\r
277 Val = cpu_to_fdt64(Val);\r
278 Err = fdt_appendprop ((VOID *)UpdatedFdtBase, ChosenNode,\r
279 PropertyName, &Val, sizeof (UINT64));\r
280 if (Err) {\r
281 DEBUG ((DEBUG_ERROR, "fdt_appendprop() fail: %a\n", fdt_strerror (Err)));\r
282 return EFI_INVALID_PARAMETER;\r
283 }\r
284 } else if (Property != NULL) {\r
285 Err = fdt_setprop_u64((VOID *)UpdatedFdtBase, ChosenNode,\r
286 PropertyName, Val);\r
287 if (Err) {\r
288 DEBUG ((DEBUG_ERROR, "fdt_setprop_u64() fail: %a\n", fdt_strerror (Err)));\r
289 return EFI_INVALID_PARAMETER;\r
290 }\r
291 } else {\r
292 DEBUG ((DEBUG_ERROR, "Failed to set fdt Property %a\n", PropertyName));\r
293 return EFI_INVALID_PARAMETER;\r
294 }\r
295 return EFI_SUCCESS;\r
296}\r
297\r
298EFI_STATUS\r
299AndroidBootImgUpdateFdt (\r
300 IN VOID *BootImg,\r
301 IN VOID *FdtBase,\r
302 IN VOID *RamdiskData,\r
303 IN UINTN RamdiskSize\r
304 )\r
305{\r
306 INTN ChosenNode, Err, NewFdtSize;\r
307 EFI_STATUS Status;\r
308 EFI_PHYSICAL_ADDRESS UpdatedFdtBase, NewFdtBase;\r
309\r
310 NewFdtSize = (UINTN)fdt_totalsize (FdtBase)\r
311 + FDT_ADDITIONAL_ENTRIES_SIZE;\r
312 Status = gBS->AllocatePages (AllocateAnyPages, EfiBootServicesData,\r
313 EFI_SIZE_TO_PAGES (NewFdtSize), &UpdatedFdtBase);\r
314 if (EFI_ERROR (Status)) {\r
315 DEBUG ((DEBUG_WARN, "Warning: Failed to reallocate FDT, err %d.\n",\r
316 Status));\r
317 return Status;\r
318 }\r
319\r
320 // Load the Original FDT tree into the new region\r
321 Err = fdt_open_into(FdtBase, (VOID*)(INTN)UpdatedFdtBase, NewFdtSize);\r
322 if (Err) {\r
323 DEBUG ((DEBUG_ERROR, "fdt_open_into(): %a\n", fdt_strerror (Err)));\r
324 Status = EFI_INVALID_PARAMETER;\r
325 goto Fdt_Exit;\r
326 }\r
327\r
328 ChosenNode = AndroidBootImgGetChosenNode(UpdatedFdtBase);\r
329 if (!ChosenNode) {\r
330 goto Fdt_Exit;\r
331 }\r
332\r
333 Status = AndroidBootImgSetProperty64 (UpdatedFdtBase, ChosenNode,\r
334 "linux,initrd-start",\r
335 (UINTN)RamdiskData);\r
336 if (EFI_ERROR (Status)) {\r
337 goto Fdt_Exit;\r
338 }\r
339\r
340 Status = AndroidBootImgSetProperty64 (UpdatedFdtBase, ChosenNode,\r
341 "linux,initrd-end",\r
e43d0884 342 (UINTN)RamdiskData + RamdiskSize);\r
fa74dd22
JN		 343 if (EFI_ERROR (Status)) {\r
344 goto Fdt_Exit;\r
345 }\r
346\r
347 if (mAndroidBootImg->UpdateDtb) {\r
348 Status = mAndroidBootImg->UpdateDtb (UpdatedFdtBase, &NewFdtBase);\r
349 if (EFI_ERROR (Status)) {\r
350 goto Fdt_Exit;\r
351 }\r
c0cd26f4
JB		 352 } else {\r
353 NewFdtBase = UpdatedFdtBase;\r
fa74dd22 354 }\r
c0cd26f4
JB		 355 Status = gBS->InstallConfigurationTable (\r
356 &gFdtTableGuid,\r
357 (VOID *)(UINTN)NewFdtBase\r
358 );\r
fa74dd22 359\r
fa74dd22
JN		 360 if (!EFI_ERROR (Status)) {\r
361 return EFI_SUCCESS;\r
362 }\r
363\r
364Fdt_Exit:\r
365 gBS->FreePages (UpdatedFdtBase, EFI_SIZE_TO_PAGES (NewFdtSize));\r
366 return Status;\r
367}\r
368\r
369EFI_STATUS\r
370AndroidBootImgBoot (\r
371 IN VOID *Buffer,\r
372 IN UINTN BufferSize\r
373 )\r
374{\r
375 EFI_STATUS Status;\r
376 VOID *Kernel;\r
377 UINTN KernelSize;\r
378 MEMORY_DEVICE_PATH KernelDevicePath;\r
379 EFI_HANDLE ImageHandle;\r
380 VOID *NewKernelArg;\r
381 EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;\r
382 VOID *RamdiskData;\r
383 UINTN RamdiskSize;\r
384 IN VOID *FdtBase;\r
385\r
f2a7e24e
JB		 386 NewKernelArg = NULL;\r
387 ImageHandle = NULL;\r
388\r
fa74dd22
JN		 389 Status = gBS->LocateProtocol (&gAndroidBootImgProtocolGuid, NULL,\r
390 (VOID **) &mAndroidBootImg);\r
391 if (EFI_ERROR (Status)) {\r
f2a7e24e 392 goto Exit;\r
fa74dd22
JN		 393 }\r
394\r
395 Status = AndroidBootImgGetKernelInfo (\r
396 Buffer,\r
397 &Kernel,\r
398 &KernelSize\r
399 );\r
400 if (EFI_ERROR (Status)) {\r
f2a7e24e 401 goto Exit;\r
fa74dd22
JN		 402 }\r
403\r
404 NewKernelArg = AllocateZeroPool (ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);\r
405 if (NewKernelArg == NULL) {\r
406 DEBUG ((DEBUG_ERROR, "Fail to allocate memory\n"));\r
f2a7e24e
JB		 407 Status = EFI_OUT_OF_RESOURCES;\r
408 goto Exit;\r
fa74dd22
JN		 409 }\r
410\r
411 Status = AndroidBootImgUpdateArgs (Buffer, NewKernelArg);\r
412 if (EFI_ERROR (Status)) {\r
f2a7e24e 413 goto Exit;\r
fa74dd22
JN		 414 }\r
415\r
416 Status = AndroidBootImgGetRamdiskInfo (\r
417 Buffer,\r
418 &RamdiskData,\r
419 &RamdiskSize\r
420 );\r
421 if (EFI_ERROR (Status)) {\r
f2a7e24e 422 goto Exit;\r
fa74dd22
JN		 423 }\r
424\r
425 Status = AndroidBootImgLocateFdt (Buffer, &FdtBase);\r
426 if (EFI_ERROR (Status)) {\r
f2a7e24e 427 goto Exit;\r
fa74dd22
JN		 428 }\r
429\r
430 Status = AndroidBootImgUpdateFdt (Buffer, FdtBase, RamdiskData, RamdiskSize);\r
431 if (EFI_ERROR (Status)) {\r
f2a7e24e 432 goto Exit;\r
fa74dd22
JN		 433 }\r
434\r
435 KernelDevicePath = mMemoryDevicePathTemplate;\r
436\r
437 KernelDevicePath.Node1.StartingAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel;\r
438 KernelDevicePath.Node1.EndingAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel\r
439 + KernelSize;\r
440\r
441 Status = gBS->LoadImage (TRUE, gImageHandle,\r
442 (EFI_DEVICE_PATH *)&KernelDevicePath,\r
443 (VOID*)(UINTN)Kernel, KernelSize, &ImageHandle);\r
82e0c422 444 if (EFI_ERROR (Status)) {\r
f2a7e24e 445 goto Exit;\r
82e0c422 446 }\r
fa74dd22
JN		 447\r
448 // Set kernel arguments\r
449 Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid,\r
450 (VOID **) &ImageInfo);\r
f2a7e24e
JB		 451 if (EFI_ERROR (Status)) {\r
452 goto Exit;\r
453 }\r
fa74dd22
JN		 454 ImageInfo->LoadOptions = NewKernelArg;\r
455 ImageInfo->LoadOptionsSize = StrLen (NewKernelArg) * sizeof (CHAR16);\r
456\r
457 // Before calling the image, enable the Watchdog Timer for the 5 Minute period\r
458 gBS->SetWatchdogTimer (5 * 60, 0x10000, 0, NULL);\r
459 // Start the image\r
460 Status = gBS->StartImage (ImageHandle, NULL, NULL);\r
461 // Clear the Watchdog Timer if the image returns\r
462 gBS->SetWatchdogTimer (0, 0x10000, 0, NULL);\r
f2a7e24e
JB		 463\r
464Exit:\r
465 //Unload image as it will not be used anymore\r
466 if (ImageHandle != NULL) {\r
467 gBS->UnloadImage (ImageHandle);\r
468 ImageHandle = NULL;\r
469 }\r
470 if (EFI_ERROR (Status)) {\r
471 if (NewKernelArg != NULL) {\r
472 FreePool (NewKernelArg);\r
473 NewKernelArg = NULL;\r
474 }\r
475 }\r
476 return Status;\r
fa74dd22 477}\r
EFI Development Kit II mirror for PVE