EmbeddedPkg/AndroidFastboot: split android boot header

Split android boot header definition to share code among
different applications and libraries.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jun Nie <jun.nie@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
index f3e770bcc98028d7b54623ca2daf57c5514773b6..2f7f093ed87da3cfecf9af012f9683360d634885 100644 (file)
--- a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
+++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
@@ -14,32 +14,6 @@
 \r
 #include "AndroidFastbootApp.h"\r
 \r
 \r
 #include "AndroidFastbootApp.h"\r
 \r

-#define BOOT_MAGIC        "ANDROID!"\r
-#define BOOT_MAGIC_LENGTH sizeof (BOOT_MAGIC) - 1\r
-\r
-// Check Val (unsigned) is a power of 2 (has only one bit set)\r
-#define IS_POWER_OF_2(Val) (Val != 0 && ((Val & (Val - 1)) == 0))\r
-\r
-// No documentation for this really - sizes of fields has been determined\r
-// empirically.\r
-#pragma pack(1)\r
-typedef struct {\r
-  CHAR8   BootMagic[BOOT_MAGIC_LENGTH];\r
-  UINT32  KernelSize;\r
-  UINT32  KernelAddress;\r
-  UINT32  RamdiskSize;\r
-  UINT32  RamdiskAddress;\r
-  UINT32  SecondStageBootloaderSize;\r
-  UINT32  SecondStageBootloaderAddress;\r
-  UINT32  KernelTaggsAddress;\r
-  UINT32  PageSize;\r
-  UINT32  Reserved[2];\r
-  CHAR8   ProductName[16];\r
-  CHAR8   KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];\r
-  UINT32  Id[32];\r
-} ANDROID_BOOTIMG_HEADER;\r
-#pragma pack()\r
-\r

 // Find the kernel and ramdisk in an Android boot.img.\r
 // return EFI_INVALID_PARAMTER if the boot.img is invalid (i.e. doesn't have the\r
 //  right magic value),\r
 // Find the kernel and ramdisk in an Android boot.img.\r
 // return EFI_INVALID_PARAMTER if the boot.img is invalid (i.e. doesn't have the\r
 //  right magic value),\r


@@ -64,7 +38,8 @@ ParseAndroidBootImg (
 \r
   Header = (ANDROID_BOOTIMG_HEADER *) BootImg;\r
 \r
 \r
   Header = (ANDROID_BOOTIMG_HEADER *) BootImg;\r
 \r

-  if (AsciiStrnCmp (Header->BootMagic, BOOT_MAGIC, BOOT_MAGIC_LENGTH) != 0) {\r
+  if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,\r
+                    ANDROID_BOOT_MAGIC_LENGTH) != 0) {\r

     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r


@@ -72,7 +47,7 @@ ParseAndroidBootImg (
     return EFI_NOT_FOUND;\r
   }\r
 \r
     return EFI_NOT_FOUND;\r
   }\r
 \r

-  ASSERT (IS_POWER_OF_2 (Header->PageSize));\r
+  ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));\r

 \r
   *KernelSize = Header->KernelSize;\r
   *Kernel = BootImgBytePtr + Header->PageSize;\r
 \r
   *KernelSize = Header->KernelSize;\r
   *Kernel = BootImgBytePtr + Header->PageSize;\r


@@ -84,8 +59,8 @@ ParseAndroidBootImg (
                  + ALIGN_VALUE (Header->KernelSize, Header->PageSize));\r
   }\r
 \r
                  + ALIGN_VALUE (Header->KernelSize, Header->PageSize));\r
   }\r
 \r

-  AsciiStrnCpyS (KernelArgs, BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,\r
-    BOOTIMG_KERNEL_ARGS_SIZE);\r
+  AsciiStrnCpyS (KernelArgs, ANDROID_BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,\r
+    ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);\r

 \r
   return EFI_SUCCESS;\r
 }\r
 \r
   return EFI_SUCCESS;\r
 }\r

diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
index f62660feb7abd765cbe11e8add54eb5ee812117e..e4c5aa3c67bc20e61d3b6c04d6403ba4ec70e36c 100644 (file)
--- a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
+++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
@@ -15,6 +15,7 @@
 #ifndef __ANDROID_FASTBOOT_APP_H__\r
 #define __ANDROID_FASTBOOT_APP_H__\r
 \r
 #ifndef __ANDROID_FASTBOOT_APP_H__\r
 #define __ANDROID_FASTBOOT_APP_H__\r
 \r

+#include <Library/AndroidBootImgLib.h>\r

 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r

diff --git a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
index f446cce2855aa7aec91f02a00a1f0881291fb625..1d9024b1ce9ea335050eeec395ab641df2020d1a 100644 (file)
--- a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
+++ b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
@@ -112,7 +112,7 @@ BootAndroidBootImg (
   )\r
 {\r
   EFI_STATUS                          Status;\r
   )\r
 {\r
   EFI_STATUS                          Status;\r

-  CHAR8                               KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];\r
+  CHAR8                               KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];\r

   VOID                               *Kernel;\r
   UINTN                               KernelSize;\r
   VOID                               *Ramdisk;\r
   VOID                               *Kernel;\r
   UINTN                               KernelSize;\r
   VOID                               *Ramdisk;\r

diff --git a/EmbeddedPkg/Include/Library/AndroidBootImgLib.h b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
new file mode 100644 (file)
index 0000000..06da751
--- /dev/null
+++ b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
@@ -0,0 +1,58 @@
+/** @file\r
+\r
+  Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>\r
+  Copyright (c) 2017, Linaro.\r
+\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __ABOOTIMG_H__\r
+#define __ABOOTIMG_H__\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+\r
+#include <Uefi/UefiBaseType.h>\r
+#include <Uefi/UefiSpec.h>\r
+\r
+#define ANDROID_BOOTIMG_KERNEL_ARGS_SIZE  512\r
+\r
+#define ANDROID_BOOT_MAGIC                "ANDROID!"\r
+#define ANDROID_BOOT_MAGIC_LENGTH         (sizeof (ANDROID_BOOT_MAGIC) - 1)\r
+\r
+// No documentation for this really - sizes of fields has been determined\r
+// empirically.\r
+#pragma pack(1)\r
+/* https://android.googlesource.com/platform/system/core/+/master/mkbootimg/bootimg.h */\r
+typedef struct {\r
+  UINT8   BootMagic[ANDROID_BOOT_MAGIC_LENGTH];\r
+  UINT32  KernelSize;\r
+  UINT32  KernelAddress;\r
+  UINT32  RamdiskSize;\r
+  UINT32  RamdiskAddress;\r
+  UINT32  SecondStageBootloaderSize;\r
+  UINT32  SecondStageBootloaderAddress;\r
+  UINT32  KernelTaggsAddress;\r
+  UINT32  PageSize;\r
+  UINT32  Reserved[2];\r
+  CHAR8   ProductName[16];\r
+  CHAR8   KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];\r
+  UINT32  Id[32];\r
+} ANDROID_BOOTIMG_HEADER;\r
+#pragma pack ()\r
+\r
+/* Check Val (unsigned) is a power of 2 (has only one bit set) */\r
+#define IS_POWER_OF_2(Val)       ((Val) != 0 && (((Val) & ((Val) - 1)) == 0))\r
+/* Android boot image page size is not specified, but it should be power of 2\r
+ * and larger than boot header */\r
+#define IS_VALID_ANDROID_PAGE_SIZE(Val)   \\r
+             (IS_POWER_OF_2(Val) && (Val > sizeof(ANDROID_BOOTIMG_HEADER)))\r
+#endif /* __ABOOTIMG_H__ */\r