From: Jun Nie <jun.nie@linaro.org>
To: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Haojian Zhuang <haojian.zhuang@linaro.org>,
Ard Biesheuvel <ard.biesheuvel@linaro.org>,
edk2-devel@lists.01.org, linaro-uefi@lists.linaro.org,
Shawn Guo <shawn.guo@linaro.org>,
Jason Liu <jason.liu@linaro.org>
Subject: Re: [PATCH v4 3/4] EmbeddedPkg/AndroidBoot: boot android kernel from storage
Date: Wed, 2 Aug 2017 22:03:34 +0800 [thread overview]
Message-ID: <CABymUCMcACDax0JxG0ghnxMGE+gYCDrPo5F1-z2gD6dsyVQmVw@mail.gmail.com> (raw)
In-Reply-To: <20170801155058.GD26462@bivouac.eciton.net>
2017-08-01 23:50 GMT+08:00 Leif Lindholm <leif.lindholm@linaro.org>:
> On Tue, Aug 01, 2017 at 05:29:00PM +0800, Jun Nie wrote:
>> Add an android kernel loader that could load kernel from storage
>> device. This patch is derived from Haojian's code as below link.
>> https://patches.linaro.org/patch/94683/
>>
>> This android boot image BDS add addtitional cmdline/dtb/ramfs
>> support besides kernel that is introduced by Android boot header.
>
> This is nearly there - it's a big improvement, but a few more
> comments below.
Thank you for so much comments. All are addressed in v5.
Jun
>
>> Contributed-under: TianoCore Contribution Agreement 1.0
>> Signed-off-by: Jun Nie <jun.nie@linaro.org>
>> ---
>> .../Application/AndroidBoot/AndroidBootApp.c | 140 +++++++
>> .../Application/AndroidBoot/AndroidBootApp.inf | 64 +++
>> EmbeddedPkg/Include/Library/AndroidBootImgLib.h | 17 +
>> EmbeddedPkg/Include/Protocol/AndroidBootImg.h | 47 +++
>> .../Library/AndroidBootImgLib/AndroidBootImgLib.c | 444 +++++++++++++++++++++
>> .../AndroidBootImgLib/AndroidBootImgLib.inf | 48 +++
>> 6 files changed, 760 insertions(+)
>> create mode 100644 EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.c
>> create mode 100644 EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.inf
>> create mode 100644 EmbeddedPkg/Include/Protocol/AndroidBootImg.h
>> create mode 100644 EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c
>> create mode 100644 EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.inf
>>
>> diff --git a/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.c b/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.c
>> new file mode 100644
>> index 0000000..5069819
>> --- /dev/null
>> +++ b/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.c
>> @@ -0,0 +1,140 @@
>> +/** @file
>> +
>> + Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
>> + Copyright (c) 2017, Linaro. All rights reserved.
>> +
>> + This program and the accompanying materials
>> + are licensed and made available under the terms and conditions of the BSD License
>> + which accompanies this distribution. The full text of the license may be found at
>> + http://opensource.org/licenses/bsd-license.php
>> +
>> + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
>> + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
>> +
>> +**/
>> +
>> +#include <Library/AndroidBootImgLib.h>
>> +#include <Library/BaseMemoryLib.h>
>> +#include <Library/BdsLib.h>
>> +#include <Library/DebugLib.h>
>> +#include <Library/DevicePathLib.h>
>> +#include <Library/MemoryAllocationLib.h>
>> +#include <Library/UefiBootServicesTableLib.h>
>> +
>> +#include <Protocol/BlockIo.h>
>> +#include <Protocol/DevicePathFromText.h>
>> +
>> +/* Validate the node is media hard drive type */
>> +EFI_STATUS
>> +ValidateAndroidMediaDevicePath (
>> + IN EFI_DEVICE_PATH *DevicePath
>> + )
>> +{
>> + EFI_DEVICE_PATH_PROTOCOL *Node, *NextNode;
>> +
>> + NextNode = DevicePath;
>> + while (NextNode != NULL) {
>> + Node = NextNode;
>> + if (IS_DEVICE_PATH_NODE (Node, MEDIA_DEVICE_PATH, MEDIA_HARDDRIVE_DP)) {
>> + return EFI_SUCCESS;
>> + }
>> + NextNode = NextDevicePathNode (Node);
>> + }
>> + return EFI_INVALID_PARAMETER;
>> +}
>> +
>> +EFI_STATUS
>> +EFIAPI
>> +AndroidBootAppEntryPoint (
>> + IN EFI_HANDLE ImageHandle,
>> + IN EFI_SYSTEM_TABLE *SystemTable
>> + )
>> +{
>> + EFI_STATUS Status;
>> + CHAR16 *BootPathStr;
>> + EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *EfiDevicePathFromTextProtocol;
>> + EFI_DEVICE_PATH *DevicePath;
>> + EFI_BLOCK_IO_PROTOCOL *BlockIo;
>> + UINT32 MediaId, BlockSize;
>> + VOID *Buffer;
>> + EFI_HANDLE Handle;
>> + UINTN BootImgSize;
>> +
>> + BootPathStr = (CHAR16 *)PcdGetPtr (PcdAndroidBootDevicePath);
>> + ASSERT (BootPathStr != NULL);
>> + Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL,
>> + (VOID **)&EfiDevicePathFromTextProtocol);
>> + ASSERT_EFI_ERROR(Status);
>> + DevicePath = (EFI_DEVICE_PATH *)EfiDevicePathFromTextProtocol->ConvertTextToDevicePath (BootPathStr);
>> + ASSERT (DevicePath != NULL);
>> +
>> + Status = ValidateAndroidMediaDevicePath (DevicePath);
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> +
>> + Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid,
>> + &DevicePath, &Handle);
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> +
>> + Status = gBS->OpenProtocol (
>> + Handle,
>> + &gEfiBlockIoProtocolGuid,
>> + (VOID **) &BlockIo,
>> + gImageHandle,
>> + NULL,
>> + EFI_OPEN_PROTOCOL_GET_PROTOCOL
>> + );
>> + if (EFI_ERROR (Status)) {
>> + DEBUG ((EFI_D_ERROR, "Failed to get BlockIo: %r\n", Status));
>
> BaseTools/Scripts/PatchCheck.py warns about this and other occurrences
> of EFI_D_*:
> * EFI_D_ERROR was used, but DEBUG_ERROR is now recommended
>
> Can you update all occurrences of this on added or modified lines to
> DEBUG_*?
>
>> + return Status;
>> + }
>> +
>> + MediaId = BlockIo->Media->MediaId;
>> + BlockSize = BlockIo->Media->BlockSize;
>> + Buffer = AllocatePages (EFI_SIZE_TO_PAGES (sizeof(ANDROID_BOOTIMG_HEADER)));
>> + if (Buffer == NULL) {
>> + return EFI_BUFFER_TOO_SMALL;
>> + }
>> + /* Load header of boot.img */
>> + Status = BlockIo->ReadBlocks (
>> + BlockIo,
>> + MediaId,
>> + 0,
>> + BlockSize,
>> + Buffer
>> + );
>> + Status = AndroidBootImgGetImgSize (Buffer, &BootImgSize);
>> + if (EFI_ERROR (Status)) {
>> + DEBUG ((EFI_D_ERROR, "Failed to get AndroidBootImg Size: %r\n", Status));
>> + return Status;
>> + }
>> + BootImgSize = ALIGN_VALUE (BootImgSize, BlockSize);
>> + FreePages (Buffer, EFI_SIZE_TO_PAGES (sizeof(ANDROID_BOOTIMG_HEADER)));
>> +
>> + /* Both PartitionStart and PartitionSize are counted as block size. */
>> + Buffer = AllocatePages (EFI_SIZE_TO_PAGES (BootImgSize));
>> + if (Buffer == NULL) {
>> + return EFI_BUFFER_TOO_SMALL;
>> + }
>> +
>> + /* Load header of boot.img */
>> + Status = BlockIo->ReadBlocks (
>> + BlockIo,
>> + MediaId,
>> + 0,
>> + BootImgSize,
>> + Buffer
>> + );
>> + if (EFI_ERROR (Status)) {
>> + DEBUG ((EFI_D_ERROR, "Failed to read blocks: %r\n", Status));
>> + goto EXIT;
>> + }
>> +
>> + Status = AndroidBootImgBoot (Buffer, BootImgSize);
>> +
>> +EXIT:
>> + return Status;
>> +}
>> diff --git a/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.inf b/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.inf
>> new file mode 100644
>> index 0000000..f1ee0bd
>> --- /dev/null
>> +++ b/EmbeddedPkg/Application/AndroidBoot/AndroidBootApp.inf
>> @@ -0,0 +1,64 @@
>> +#/** @file
>> +#
>> +# Copyright (c) 2013-2015, ARM Ltd. All rights reserved.<BR>
>> +# Copyright (c) 2017, Linaro. All rights reserved.
>> +#
>> +# This program and the accompanying materials
>> +# are licensed and made available under the terms and conditions of the BSD License
>> +# which accompanies this distribution. The full text of the license may be found at
>> +# http://opensource.org/licenses/bsd-license.php
>> +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
>> +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
>> +#
>> +#
>> +#**/
>> +
>> +[Defines]
>> + INF_VERSION = 0x00010019
>> + BASE_NAME = AndroidBootApp
>> + FILE_GUID = 3a738b36-b9c5-4763-abbd-6cbd4b25f9ff
>> + MODULE_TYPE = UEFI_APPLICATION
>> + VERSION_STRING = 1.0
>> + ENTRY_POINT = AndroidBootAppEntryPoint
>> +
>> +[Sources.common]
>> + AndroidBootApp.c
>> +
>> +[LibraryClasses]
>> + AndroidBootImgLib
>> + BaseLib
>> + BaseMemoryLib
>> + BdsLib
>> + DebugLib
>> + DevicePathLib
>> + DxeServicesTableLib
>> + FdtLib
>> + MemoryAllocationLib
>> + PcdLib
>> + PrintLib
>> + UefiApplicationEntryPoint
>> + UefiBootServicesTableLib
>> + UefiLib
>> + UefiRuntimeServicesTableLib
>> +
>> +[Protocols]
>> + gAndroidFastbootPlatformProtocolGuid
>> + gEfiBlockIoProtocolGuid
>> + gEfiDevicePathFromTextProtocolGuid
>> + gEfiSimpleTextOutProtocolGuid
>> + gEfiSimpleTextInProtocolGuid
>> +
>> +[Packages]
>> + EmbeddedPkg/EmbeddedPkg.dec
>> + MdeModulePkg/MdeModulePkg.dec
>> + MdePkg/MdePkg.dec
>> +
>> +[Packages.ARM, Packages.AARCH64]
>> + ArmPkg/ArmPkg.dec
>> + ArmPlatformPkg/ArmPlatformPkg.dec
>> +
>> +[Guids]
>> + gFdtTableGuid
>> +
>> +[Pcd]
>> + gEmbeddedTokenSpaceGuid.PcdAndroidBootDevicePath
>> diff --git a/EmbeddedPkg/Include/Library/AndroidBootImgLib.h b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
>> index 8116c7c..29fb3f2 100644
>> --- a/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
>> +++ b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
>> @@ -47,4 +47,21 @@ typedef struct {
>>
>> /* Check Val (unsigned) is a power of 2 (has only one bit set) */
>> #define IS_POWER_OF_2(Val) ((Val) != 0 && (((Val) & ((Val) - 1)) == 0))
>> +/* Android boot image page size is not specified, but it should be power of 2
>> + * and larger than boot header */
>> +#define IS_VALID_ANDROID_PAGE_SIZE(Val) \
>> + (IS_POWER_OF_2(Val) && (Val > sizeof(ANDROID_BOOTIMG_HEADER)))
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetImgSize (
>> + IN VOID *BootImg,
>> + OUT UINTN *ImgSize
>> + );
>> +
>> +EFI_STATUS
>> +AndroidBootImgBoot (
>> + IN VOID *Buffer,
>> + IN UINTN BufferSize
>> + );
>> +
>> #endif /* __ABOOTIMG_H__ */
>> diff --git a/EmbeddedPkg/Include/Protocol/AndroidBootImg.h b/EmbeddedPkg/Include/Protocol/AndroidBootImg.h
>> new file mode 100644
>> index 0000000..1c458d0
>> --- /dev/null
>> +++ b/EmbeddedPkg/Include/Protocol/AndroidBootImg.h
>> @@ -0,0 +1,47 @@
>> +/** @file
>> +
>> + Copyright (c) 2017, Linaro. All rights reserved.<BR>
>> +
>> + This program and the accompanying materials
>> + are licensed and made available under the terms and conditions of the BSD License
>> + which accompanies this distribution. The full text of the license may be found at
>> + http://opensource.org/licenses/bsd-license.php
>> +
>> + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
>> + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
>> +
>> +**/
>> +
>> +#ifndef __ANDROID_BOOTIMG_PROTOCOL_H__
>> +#define __ANDROID_BOOTIMG_PROTOCOL_H__
>> +
>> +//
>> +// Protocol interface structure
>> +//
>> +typedef struct _ANDROID_BOOTIMG_PROTOCOL ANDROID_BOOTIMG_PROTOCOL;
>> +
>> +//
>> +// Function Prototypes
>> +//
>> +typedef
>> +EFI_STATUS
>> +(EFIAPI *ANDROID_BOOTIMG_APPEND_KERNEL_ARGS) (
>> + IN CHAR16 *Args,
>> + IN UINTN Size
>> + );
>> +
>> +typedef
>> +EFI_STATUS
>> +(EFIAPI *ANDROID_BOOTIMG_UPDATE_DTB) (
>> + IN EFI_PHYSICAL_ADDRESS OrigDtbBase;
>> + OUT EFI_PHYSICAL_ADDRESS *NewDtbBase;
>> + );
>> +
>> +struct _ANDROID_BOOTIMG_PROTOCOL {
>> + ANDROID_BOOTIMG_APPEND_KERNEL_ARGS AppendArgs;
>> + ANDROID_BOOTIMG_UPDATE_DTB UpdateDtb;
>> +};
>> +
>> +extern EFI_GUID gAndroidBootImgProtocolGuid;
>> +
>> +#endif /* __ANDROID_BOOTIMG_PROTOCOL_H__ */
>> diff --git a/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c b/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c
>> new file mode 100644
>> index 0000000..c33a164
>> --- /dev/null
>> +++ b/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c
>> @@ -0,0 +1,444 @@
>> +/** @file
>> +
>> + Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
>> + Copyright (c) 2017, Linaro. All rights reserved.
>> +
>> + This program and the accompanying materials
>> + are licensed and made available under the terms and conditions of the BSD License
>> + which accompanies this distribution. The full text of the license may be found at
>> + http://opensource.org/licenses/bsd-license.php
>> +
>> + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
>> + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
>> +
>> +**/
>> +
>> +#include <libfdt.h>
>> +#include <Library/AndroidBootImgLib.h>
>> +#include <Library/PrintLib.h>
>> +#include <Library/UefiBootServicesTableLib.h>
>> +#include <Library/UefiLib.h>
>> +
>> +#include <Protocol/AndroidBootImg.h>
>> +#include <Protocol/LoadedImage.h>
>> +
>> +#include <libfdt.h>
>> +
>> +#define FDT_ADDITIONAL_ENTRIES_SIZE 0x400
>> +
>> +typedef struct {
>> + MEMMAP_DEVICE_PATH Node1;
>> + EFI_DEVICE_PATH_PROTOCOL End;
>> +} MEMORY_DEVICE_PATH;
>> +
>> +STATIC ANDROID_BOOTIMG_PROTOCOL *mAndroidBootImg;
>> +
>> +STATIC CONST MEMORY_DEVICE_PATH mMemoryDevicePathTemplate =
>> +{
>> + {
>> + {
>> + HARDWARE_DEVICE_PATH,
>> + HW_MEMMAP_DP,
>> + {
>> + (UINT8)(sizeof (MEMMAP_DEVICE_PATH)),
>> + (UINT8)((sizeof (MEMMAP_DEVICE_PATH)) >> 8),
>> + },
>> + }, // Header
>> + 0, // StartingAddress (set at runtime)
>> + 0 // EndingAddress (set at runtime)
>> + }, // Node1
>> + {
>> + END_DEVICE_PATH_TYPE,
>> + END_ENTIRE_DEVICE_PATH_SUBTYPE,
>> + { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 }
>> + } // End
>> +};
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetImgSize (
>> + IN VOID *BootImg,
>> + OUT UINTN *ImgSize
>> + )
>> +{
>> + ANDROID_BOOTIMG_HEADER *Header;
>> +
>> + Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
>> +
>> + if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,
>> + ANDROID_BOOT_MAGIC_LENGTH) != 0) {
>> + return EFI_INVALID_PARAMETER;
>> + }
>> +
>> + /* The page size is not specified, but it should be power of 2 at least */
>> + ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
>> +
>> + /* Get real size of abootimg */
>> + *ImgSize = ALIGN_VALUE (Header->KernelSize, Header->PageSize) +
>> + ALIGN_VALUE (Header->RamdiskSize, Header->PageSize) +
>> + ALIGN_VALUE (Header->SecondStageBootloaderSize, Header->PageSize) +
>> + Header->PageSize;
>> + return EFI_SUCCESS;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetKernelInfo (
>> + IN VOID *BootImg,
>> + OUT VOID **Kernel,
>> + OUT UINTN *KernelSize
>> + )
>> +{
>> + ANDROID_BOOTIMG_HEADER *Header;
>> +
>> + Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
>> +
>> + if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,
>> + ANDROID_BOOT_MAGIC_LENGTH) != 0) {
>> + return EFI_INVALID_PARAMETER;
>> + }
>> +
>> + if (Header->KernelSize == 0) {
>> + return EFI_NOT_FOUND;
>> + }
>> +
>> + ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
>> +
>> + *KernelSize = Header->KernelSize;
>> + *Kernel = BootImg + Header->PageSize;
>> + return EFI_SUCCESS;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetRamdiskInfo (
>> + IN VOID *BootImg,
>> + OUT VOID **Ramdisk,
>> + OUT UINTN *RamdiskSize
>> + )
>> +{
>> + ANDROID_BOOTIMG_HEADER *Header;
>> + UINT8 *BootImgBytePtr;
>> +
>> + // Cast to UINT8 so we can do pointer arithmetic
>> + BootImgBytePtr = (UINT8 *) BootImg;
>> +
>> + Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
>> +
>> + if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,
>> + ANDROID_BOOT_MAGIC_LENGTH) != 0) {
>> + return EFI_INVALID_PARAMETER;
>> + }
>> +
>> + ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
>> +
>> + *RamdiskSize = Header->RamdiskSize;
>> +
>> + if (Header->RamdiskSize != 0) {
>> + *Ramdisk = (VOID *) (BootImgBytePtr
>> + + Header->PageSize
>> + + ALIGN_VALUE (Header->KernelSize, Header->PageSize));
>> + }
>> + return EFI_SUCCESS;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetSecondBootLoaderInfo (
>> + IN VOID *BootImg,
>> + OUT VOID **Second,
>> + OUT UINTN *SecondSize
>> + )
>> +{
>> + ANDROID_BOOTIMG_HEADER *Header;
>> + UINT8 *BootImgBytePtr;
>> +
>> + // Cast to UINT8 so we can do pointer arithmetic
>> + BootImgBytePtr = (UINT8 *) BootImg;
>> +
>> + Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
>> +
>> + if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,
>> + ANDROID_BOOT_MAGIC_LENGTH) != 0) {
>> + return EFI_INVALID_PARAMETER;
>> + }
>> +
>> + ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
>> +
>> + *SecondSize = Header->SecondStageBootloaderSize;
>> +
>> + if (Header->SecondStageBootloaderSize != 0) {
>> + *Second = (VOID *) (BootImgBytePtr
>> + + Header->PageSize
>> + + ALIGN_VALUE (Header->KernelSize, Header->PageSize)
>> + + ALIGN_VALUE (Header->RamdiskSize, Header->PageSize));
>> + }
>> + return EFI_SUCCESS;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetKernelArgs (
>> + IN VOID *BootImg,
>> + OUT CHAR8 *KernelArgs
>> + )
>> +{
>> + ANDROID_BOOTIMG_HEADER *Header;
>> +
>> + Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
>> + AsciiStrnCpyS (KernelArgs, ANDROID_BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,
>> + ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);
>> +
>> + return EFI_SUCCESS;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgGetFdt (
>> + IN VOID *BootImg,
>> + IN VOID **FdtBase
>> + )
>> +{
>> + UINTN SecondLoaderSize;
>> + EFI_STATUS Status;
>> +
>> + /* Check whether FDT is located in second boot region as some vendor do so,
>> + * because second loader is never used as far as I know. */
>> + Status = AndroidBootImgGetSecondBootLoaderInfo (
>> + BootImg,
>> + FdtBase,
>> + &SecondLoaderSize
>> + );
>> + return Status;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgUpdateArgs (
>> + IN VOID *BootImg,
>> + OUT VOID *KernelArgs
>> + )
>> +{
>> + CHAR8 ImageKernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];
>> + EFI_STATUS Status;
>> +
>> + // Get kernel arguments from Android boot image
>> + Status = AndroidBootImgGetKernelArgs (BootImg, ImageKernelArgs);
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> + AsciiStrToUnicodeStrS (ImageKernelArgs, KernelArgs,
>> + ANDROID_BOOTIMG_KERNEL_ARGS_SIZE >> 1);
>> + // Append platform kernel arguments
>> + if(mAndroidBootImg->AppendArgs) {
>> + Status = mAndroidBootImg->AppendArgs (KernelArgs,
>> + ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);
>> + }
>> + return Status;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgLocateFdt (
>> + IN VOID *BootImg,
>> + IN VOID **FdtBase
>> + )
>> +{
>> + INTN Err;
>> + EFI_STATUS Status;
>> +
>> + Status = EfiGetSystemConfigurationTable (&gFdtTableGuid, FdtBase);
>> + if (!EFI_ERROR (Status)) {
>> + return EFI_SUCCESS;
>> + }
>> +
>> + Status = AndroidBootImgGetFdt (BootImg, FdtBase);
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> + Err = fdt_check_header (*FdtBase);
>> + if (Err != 0) {
>> + DEBUG ((DEBUG_ERROR, "ERROR: Device Tree header not valid (Err:%d)\n",
>> + Err));
>> + return EFI_INVALID_PARAMETER;
>> + }
>> + return EFI_SUCCESS;
>> +}
>> +
>> +
>> +EFI_STATUS
>> +AndroidBootImgUpdateFdt (
>> + IN VOID *BootImg,
>> + IN VOID *FdtBase,
>> + IN VOID *RamdiskData,
>> + IN UINTN RamdiskSize
>> + )
>> +{
>> + INTN Err, NewFdtSize, ChosenNode;
>> + EFI_STATUS Status;
>> + EFI_PHYSICAL_ADDRESS UpdatedFdtBase, NewFdtBase;
>> + struct fdt_property *Property;
>> + UINT64 RamdiskStart, RamdiskEnd;
>> + int Len;
>> +
>> + NewFdtSize = (UINTN)fdt_totalsize (FdtBase)
>> + + FDT_ADDITIONAL_ENTRIES_SIZE;
>> + Status = gBS->AllocatePages (AllocateAnyPages, EfiBootServicesData,
>> + EFI_SIZE_TO_PAGES (NewFdtSize), &UpdatedFdtBase);
>> + if (EFI_ERROR (Status)) {
>> + DEBUG ((EFI_D_WARN, "Warning: Failed to reallocate FDT, err %d.\n",
>> + Status));
>> + return Status;
>> + }
>> +
>> + // Load the Original FDT tree into the new region
>> + Err = fdt_open_into(FdtBase, (VOID*)UpdatedFdtBase, NewFdtSize);
>> + if (Err) {
>> + DEBUG ((EFI_D_ERROR, "fdt_open_into(): %a\n", fdt_strerror (Err)));
>> + Status = EFI_INVALID_PARAMETER;
>> + goto Fdt_Exit;
>> + }
>> +
>
> Could we have some helper functions here?:
>
> GetChosenNode(UpdatedFdtBase).
>
>> + ChosenNode = fdt_subnode_offset ((const void *)UpdatedFdtBase, 0, "chosen");
>> + if (ChosenNode < 0) {
>> + ChosenNode = fdt_add_subnode((void *)UpdatedFdtBase, 0, "chosen");
>> + if (ChosenNode < 0) {
>> + DEBUG ((EFI_D_ERROR, "Failed to find chosen node in fdt!\n"));
>> + goto Fdt_Exit;
>> + }
>> + }
>
> SetProperty64(UpdatedFdtBase, Chosen, "linux,initrd-start", RamdiskStart).
>
>> + Property = fdt_get_property_w((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-start", &Len);
>> + if (NULL == Property && Len == -FDT_ERR_NOTFOUND) {
>> + RamdiskStart = cpu_to_fdt64((UINT64)RamdiskData);
>> + fdt_appendprop ((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-start", &RamdiskStart, sizeof (UINT64));
>> + } else if (Property != NULL) {
>> + RamdiskStart = (UINT64)RamdiskData;
>> + fdt_setprop_u64((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-start", (uint64_t)RamdiskStart);
>
> UINT64
>
>> + } else {
>> + DEBUG ((EFI_D_ERROR, "Failed to append fdt Property initrd-start\n",
>> + fdt_strerror (Err)));
>> + Status = EFI_INVALID_PARAMETER;
>> + goto Fdt_Exit;
>> + }
>> +
>
> SetProperty64(UpdatedFdtBase, Chosen, "linux,initrd-end", RamdiskEnd).
>
>> + Property = fdt_get_property_w((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-end", &Len);
>> + if (NULL == Property && Len == -FDT_ERR_NOTFOUND) {
>> + RamdiskEnd = cpu_to_fdt64((UINT64)(RamdiskData + RamdiskSize));
>> + fdt_appendprop ((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-end", &RamdiskEnd, sizeof (UINT64));
>> + } else if (Property != NULL) {
>> + RamdiskEnd = (UINT64)(RamdiskData + RamdiskSize);
>> + fdt_setprop_u64((void *)UpdatedFdtBase, ChosenNode,
>> + "linux,initrd-end", (uint64_t)RamdiskEnd);
>
> UINT64
>
>> + } else {
>> + DEBUG ((EFI_D_ERROR, "Failed to append fdt Property initrd-end\n",
>> + fdt_strerror (Err)));
>> + Status = EFI_INVALID_PARAMETER;
>> + goto Fdt_Exit;
>> + }
>> +
>> + if ( mAndroidBootImg->UpdateDtb) {
>
> Spurious space after '('.
>
> /
> Leif
>
>> + Status = mAndroidBootImg->UpdateDtb (UpdatedFdtBase, &NewFdtBase);
>> + if (EFI_ERROR (Status)) {
>> + goto Fdt_Exit;
>> + }
>> + }
>> +
>> + Status = gBS->InstallConfigurationTable (
>> + &gFdtTableGuid,
>> + (VOID *)(UINTN)NewFdtBase
>> + );
>> + if (!EFI_ERROR (Status)) {
>> + return EFI_SUCCESS;
>> + }
>> +
>> +Fdt_Exit:
>> + gBS->FreePages (UpdatedFdtBase, EFI_SIZE_TO_PAGES (NewFdtSize));
>> + return Status;
>> +}
>> +
>> +EFI_STATUS
>> +AndroidBootImgBoot (
>> + IN VOID *Buffer,
>> + IN UINTN BufferSize
>> + )
>> +{
>> + EFI_STATUS Status;
>> + VOID *Kernel;
>> + UINTN KernelSize;
>> + MEMORY_DEVICE_PATH KernelDevicePath;
>> + EFI_HANDLE ImageHandle;
>> + VOID *NewKernelArg;
>> + EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;
>> + VOID *RamdiskData;
>> + UINTN RamdiskSize;
>> + IN VOID *FdtBase;
>> +
>> + Status = gBS->LocateProtocol (&gAndroidBootImgProtocolGuid, NULL,
>> + (VOID **) &mAndroidBootImg);
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> +
>> + Status = AndroidBootImgGetKernelInfo (
>> + Buffer,
>> + &Kernel,
>> + &KernelSize
>> + );
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> +
>> + NewKernelArg = AllocateZeroPool (ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);
>> + if (NewKernelArg == NULL) {
>> + DEBUG ((DEBUG_ERROR, "Fail to allocate memory\n"));
>> + return EFI_OUT_OF_RESOURCES;
>> + }
>> +
>> + Status = AndroidBootImgUpdateArgs (Buffer, NewKernelArg);
>> + if (EFI_ERROR (Status)) {
>> + FreePool (NewKernelArg);
>> + return Status;
>> + }
>> +
>> + Status = AndroidBootImgGetRamdiskInfo (
>> + Buffer,
>> + &RamdiskData,
>> + &RamdiskSize
>> + );
>> + if (EFI_ERROR (Status)) {
>> + return Status;
>> + }
>> +
>> + Status = AndroidBootImgLocateFdt (Buffer, &FdtBase);
>> + if (EFI_ERROR (Status)) {
>> + FreePool (NewKernelArg);
>> + return Status;
>> + }
>> +
>> + Status = AndroidBootImgUpdateFdt (Buffer, FdtBase, RamdiskData, RamdiskSize);
>> + if (EFI_ERROR (Status)) {
>> + FreePool (NewKernelArg);
>> + return Status;
>> + }
>> +
>> + KernelDevicePath = mMemoryDevicePathTemplate;
>> +
>> + KernelDevicePath.Node1.StartingAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel;
>> + KernelDevicePath.Node1.EndingAddress = (EFI_PHYSICAL_ADDRESS)(UINTN) Kernel
>> + + KernelSize;
>> +
>> + Status = gBS->LoadImage (TRUE, gImageHandle,
>> + (EFI_DEVICE_PATH *)&KernelDevicePath,
>> + (VOID*)(UINTN)Kernel, KernelSize, &ImageHandle);
>> +
>> + // Set kernel arguments
>> + Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid,
>> + (VOID **) &ImageInfo);
>> + ImageInfo->LoadOptions = NewKernelArg;
>> + ImageInfo->LoadOptionsSize = StrLen (NewKernelArg) * sizeof (CHAR16);
>> +
>> + // Before calling the image, enable the Watchdog Timer for the 5 Minute period
>> + gBS->SetWatchdogTimer (5 * 60, 0x10000, 0, NULL);
>> + // Start the image
>> + Status = gBS->StartImage (ImageHandle, NULL, NULL);
>> + // Clear the Watchdog Timer if the image returns
>> + gBS->SetWatchdogTimer (0, 0x10000, 0, NULL);
>> + return EFI_SUCCESS;
>> +}
>> diff --git a/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.inf b/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.inf
>> new file mode 100644
>> index 0000000..c92bac0
>> --- /dev/null
>> +++ b/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.inf
>> @@ -0,0 +1,48 @@
>> +#/** @file
>> +#
>> +# Copyright (c) 2013-2015, ARM Ltd. All rights reserved.<BR>
>> +# Copyright (c) 2017, Linaro. All rights reserved.
>> +#
>> +# This program and the accompanying materials
>> +# are licensed and made available under the terms and conditions of the BSD License
>> +# which accompanies this distribution. The full text of the license may be found at
>> +# http://opensource.org/licenses/bsd-license.php
>> +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
>> +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
>> +#
>> +#
>> +#**/
>> +
>> +[Defines]
>> + INF_VERSION = 0x00010019
>> + BASE_NAME = AndroidBootImgLib
>> + FILE_GUID = ed3b8739-6fa7-4cb1-8aeb-2496f8fcaefa
>> + MODULE_TYPE = BASE
>> + VERSION_STRING = 1.0
>> + LIBRARY_CLASS = AndroidBootImgLib
>> +
>> +#
>> +# The following information is for reference only and not required by the build tools.
>> +#
>> +# VALID_ARCHITECTURES = ARM AARCH64
>> +#
>> +
>> +[Sources]
>> + AndroidBootImgLib.c
>> +
>> +[LibraryClasses]
>> + DebugLib
>> + FdtLib
>> + PrintLib
>> + UefiBootServicesTableLib
>> + UefiLib
>> +
>> +[Packages]
>> + EmbeddedPkg/EmbeddedPkg.dec
>> + MdePkg/MdePkg.dec
>> +
>> +[Protocols]
>> + gAndroidBootImgProtocolGuid
>> +
>> +[Guids]
>> + gFdtTableGuid
>> --
>> 1.9.1
>>
next prev parent reply other threads:[~2017-08-02 14:01 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-01 9:28 [PATCH v4 1/4] ArmPkg: Move IS_DEVICE_PATH_NODE for sharing Jun Nie
2017-08-01 9:28 ` [PATCH v4 2/4] EmbeddedPkg/AndroidFastboot: split android boot header Jun Nie
2017-08-01 15:18 ` Leif Lindholm
2017-08-01 9:29 ` [PATCH v4 3/4] EmbeddedPkg/AndroidBoot: boot android kernel from storage Jun Nie
2017-08-01 15:50 ` Leif Lindholm
2017-08-02 14:03 ` Jun Nie [this message]
2017-08-01 9:29 ` [PATCH v4 4/4] EmbeddedPkg: add Android boot device path and guid Jun Nie
2017-08-01 16:19 ` Leif Lindholm
2017-08-02 14:02 ` Jun Nie
2017-08-01 14:59 ` [PATCH v4 1/4] ArmPkg: Move IS_DEVICE_PATH_NODE for sharing Leif Lindholm
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CABymUCMcACDax0JxG0ghnxMGE+gYCDrPo5F1-z2gD6dsyVQmVw@mail.gmail.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox