diff mbox series

[edk2,v4,2/4] EmbeddedPkg/AndroidFastboot: split android boot header

Message ID 1501579741-28866-2-git-send-email-jun.nie@linaro.org
State Superseded
Headers show
Series [edk2,v4,1/4] ArmPkg: Move IS_DEVICE_PATH_NODE for sharing | expand

Commit Message

Jun Nie Aug. 1, 2017, 9:28 a.m. UTC 
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>

---
 .../Application/AndroidFastboot/AndroidBootImg.c   | 35 +++------------
 .../AndroidFastboot/AndroidFastbootApp.h           |  1 +
 .../AndroidFastboot/Arm/BootAndroidBootImg.c       |  2 +-
 EmbeddedPkg/Include/Library/AndroidBootImgLib.h    | 50 ++++++++++++++++++++++
 4 files changed, 57 insertions(+), 31 deletions(-)
 create mode 100644 EmbeddedPkg/Include/Library/AndroidBootImgLib.h

-- 
1.9.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Comments

Leif Lindholm Aug. 1, 2017, 3:18 p.m. UTC | #1 
On Tue, Aug 01, 2017 at 05:28:59PM +0800, Jun Nie wrote:
> 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>

> ---

>  .../Application/AndroidFastboot/AndroidBootImg.c   | 35 +++------------

>  .../AndroidFastboot/AndroidFastbootApp.h           |  1 +

>  .../AndroidFastboot/Arm/BootAndroidBootImg.c       |  2 +-

>  EmbeddedPkg/Include/Library/AndroidBootImgLib.h    | 50 ++++++++++++++++++++++

>  4 files changed, 57 insertions(+), 31 deletions(-)

>  create mode 100644 EmbeddedPkg/Include/Library/AndroidBootImgLib.h

> 

> diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c

> index f3e770b..2f7f093 100644

> --- a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c

> +++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c

> @@ -14,32 +14,6 @@

>  

>  #include "AndroidFastbootApp.h"

>  

> -#define BOOT_MAGIC        "ANDROID!"

> -#define BOOT_MAGIC_LENGTH sizeof (BOOT_MAGIC) - 1

> -

> -// 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))

> -

> -// No documentation for this really - sizes of fields has been determined

> -// empirically.

> -#pragma pack(1)

> -typedef struct {

> -  CHAR8   BootMagic[BOOT_MAGIC_LENGTH];

> -  UINT32  KernelSize;

> -  UINT32  KernelAddress;

> -  UINT32  RamdiskSize;

> -  UINT32  RamdiskAddress;

> -  UINT32  SecondStageBootloaderSize;

> -  UINT32  SecondStageBootloaderAddress;

> -  UINT32  KernelTaggsAddress;

> -  UINT32  PageSize;

> -  UINT32  Reserved[2];

> -  CHAR8   ProductName[16];

> -  CHAR8   KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];

> -  UINT32  Id[32];

> -} ANDROID_BOOTIMG_HEADER;

> -#pragma pack()

> -

>  // Find the kernel and ramdisk in an Android boot.img.

>  // return EFI_INVALID_PARAMTER if the boot.img is invalid (i.e. doesn't have the

>  //  right magic value),

> @@ -64,7 +38,8 @@ ParseAndroidBootImg (

>  

>    Header = (ANDROID_BOOTIMG_HEADER *) BootImg;

>  

> -  if (AsciiStrnCmp (Header->BootMagic, BOOT_MAGIC, BOOT_MAGIC_LENGTH) != 0) {

> +  if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,

> +                    ANDROID_BOOT_MAGIC_LENGTH) != 0) {

>      return EFI_INVALID_PARAMETER;

>    }

>  

> @@ -72,7 +47,7 @@ ParseAndroidBootImg (

>      return EFI_NOT_FOUND;

>    }

>  

> -  ASSERT (IS_POWER_OF_2 (Header->PageSize));

> +  ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));


So, this change uses the macro that is now only introduced in patch
2/4, and hence this patch breaks bisect.

Could you move this change to 3/4 instead?

>  

>    *KernelSize = Header->KernelSize;

>    *Kernel = BootImgBytePtr + Header->PageSize;

> @@ -84,8 +59,8 @@ ParseAndroidBootImg (

>                   + ALIGN_VALUE (Header->KernelSize, Header->PageSize));

>    }

>  

> -  AsciiStrnCpyS (KernelArgs, BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,

> -    BOOTIMG_KERNEL_ARGS_SIZE);

> +  AsciiStrnCpyS (KernelArgs, ANDROID_BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,

> +    ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);

>  

>    return EFI_SUCCESS;

>  }

> diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h

> index f62660f..e4c5aa3 100644

> --- a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h

> +++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h

> @@ -15,6 +15,7 @@

>  #ifndef __ANDROID_FASTBOOT_APP_H__

>  #define __ANDROID_FASTBOOT_APP_H__

>  

> +#include <Library/AndroidBootImgLib.h>

>  #include <Library/BaseLib.h>

>  #include <Library/DebugLib.h>

>  #include <Library/MemoryAllocationLib.h>

> diff --git a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c

> index f446cce..1d9024b 100644

> --- a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c

> +++ b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c

> @@ -112,7 +112,7 @@ BootAndroidBootImg (

>    )

>  {

>    EFI_STATUS                          Status;

> -  CHAR8                               KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];

> +  CHAR8                               KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];

>    VOID                               *Kernel;

>    UINTN                               KernelSize;

>    VOID                               *Ramdisk;

> diff --git a/EmbeddedPkg/Include/Library/AndroidBootImgLib.h b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h

> new file mode 100644

> index 0000000..8116c7c

> --- /dev/null

> +++ b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h

> @@ -0,0 +1,50 @@

> +/** @file

> +

> +  Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>

> +  Copyright (c) 2017, Linaro.

> +

> +  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 __ABOOTIMG_H__

> +#define __ABOOTIMG_H__

> +

> +#include <Library/BaseLib.h>

> +#include <Library/DebugLib.h>

> +#include <Library/MemoryAllocationLib.h>

> +

> +#include <Uefi/UefiBaseType.h>

> +#include <Uefi/UefiSpec.h>

> +

> +#define ANDROID_BOOTIMG_KERNEL_ARGS_SIZE  512

> +

> +#define ANDROID_BOOT_MAGIC                "ANDROID!"

> +#define ANDROID_BOOT_MAGIC_LENGTH         (sizeof (ANDROID_BOOT_MAGIC) - 1)

> +

> +/* https://android.googlesource.com/platform/system/core/+/master/mkbootimg/bootimg.h */

> +typedef struct {

> +  UINT8   BootMagic[ANDROID_BOOT_MAGIC_LENGTH];

> +  UINT32  KernelSize;

> +  UINT32  KernelAddress;

> +  UINT32  RamdiskSize;

> +  UINT32  RamdiskAddress;

> +  UINT32  SecondStageBootloaderSize;

> +  UINT32  SecondStageBootloaderAddress;

> +  UINT32  KernelTaggsAddress;

> +  UINT32  PageSize;

> +  UINT32  Reserved[2];

> +  CHAR8   ProductName[16];

> +  CHAR8   KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];

> +  UINT32  Id[32];

> +} ANDROID_BOOTIMG_HEADER;


The original definition used
#pragma pack (1)
#pragma pack ()
around this struct definition.
I believe we should maintain that.

/
    Leif

> +

> +/* 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))

> +#endif /* __ABOOTIMG_H__ */

> -- 

> 1.9.1

> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
diff mbox series

Patch

diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
index f3e770b..2f7f093 100644
--- a/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
+++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidBootImg.c
@@ -14,32 +14,6 @@ 
 
 #include "AndroidFastbootApp.h"
 
-#define BOOT_MAGIC        "ANDROID!"
-#define BOOT_MAGIC_LENGTH sizeof (BOOT_MAGIC) - 1
-
-// 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))
-
-// No documentation for this really - sizes of fields has been determined
-// empirically.
-#pragma pack(1)
-typedef struct {
-  CHAR8   BootMagic[BOOT_MAGIC_LENGTH];
-  UINT32  KernelSize;
-  UINT32  KernelAddress;
-  UINT32  RamdiskSize;
-  UINT32  RamdiskAddress;
-  UINT32  SecondStageBootloaderSize;
-  UINT32  SecondStageBootloaderAddress;
-  UINT32  KernelTaggsAddress;
-  UINT32  PageSize;
-  UINT32  Reserved[2];
-  CHAR8   ProductName[16];
-  CHAR8   KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];
-  UINT32  Id[32];
-} ANDROID_BOOTIMG_HEADER;
-#pragma pack()
-
 // Find the kernel and ramdisk in an Android boot.img.
 // return EFI_INVALID_PARAMTER if the boot.img is invalid (i.e. doesn't have the
 //  right magic value),
@@ -64,7 +38,8 @@  ParseAndroidBootImg (
 
   Header = (ANDROID_BOOTIMG_HEADER *) BootImg;
 
-  if (AsciiStrnCmp (Header->BootMagic, BOOT_MAGIC, BOOT_MAGIC_LENGTH) != 0) {
+  if (AsciiStrnCmp ((CONST CHAR8 *)Header->BootMagic, ANDROID_BOOT_MAGIC,
+                    ANDROID_BOOT_MAGIC_LENGTH) != 0) {
     return EFI_INVALID_PARAMETER;
   }
 
@@ -72,7 +47,7 @@  ParseAndroidBootImg (
     return EFI_NOT_FOUND;
   }
 
-  ASSERT (IS_POWER_OF_2 (Header->PageSize));
+  ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
 
   *KernelSize = Header->KernelSize;
   *Kernel = BootImgBytePtr + Header->PageSize;
@@ -84,8 +59,8 @@  ParseAndroidBootImg (
                  + ALIGN_VALUE (Header->KernelSize, Header->PageSize));
   }
 
-  AsciiStrnCpyS (KernelArgs, BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,
-    BOOTIMG_KERNEL_ARGS_SIZE);
+  AsciiStrnCpyS (KernelArgs, ANDROID_BOOTIMG_KERNEL_ARGS_SIZE, Header->KernelArgs,
+    ANDROID_BOOTIMG_KERNEL_ARGS_SIZE);
 
   return EFI_SUCCESS;
 }
diff --git a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
index f62660f..e4c5aa3 100644
--- a/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
+++ b/EmbeddedPkg/Application/AndroidFastboot/AndroidFastbootApp.h
@@ -15,6 +15,7 @@ 
 #ifndef __ANDROID_FASTBOOT_APP_H__
 #define __ANDROID_FASTBOOT_APP_H__
 
+#include <Library/AndroidBootImgLib.h>
 #include <Library/BaseLib.h>
 #include <Library/DebugLib.h>
 #include <Library/MemoryAllocationLib.h>
diff --git a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
index f446cce..1d9024b 100644
--- a/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
+++ b/EmbeddedPkg/Application/AndroidFastboot/Arm/BootAndroidBootImg.c
@@ -112,7 +112,7 @@  BootAndroidBootImg (
   )
 {
   EFI_STATUS                          Status;
-  CHAR8                               KernelArgs[BOOTIMG_KERNEL_ARGS_SIZE];
+  CHAR8                               KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];
   VOID                               *Kernel;
   UINTN                               KernelSize;
   VOID                               *Ramdisk;
diff --git a/EmbeddedPkg/Include/Library/AndroidBootImgLib.h b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
new file mode 100644
index 0000000..8116c7c
--- /dev/null
+++ b/EmbeddedPkg/Include/Library/AndroidBootImgLib.h
@@ -0,0 +1,50 @@ 
+/** @file
+
+  Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
+  Copyright (c) 2017, Linaro.
+
+  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 __ABOOTIMG_H__
+#define __ABOOTIMG_H__
+
+#include <Library/BaseLib.h>
+#include <Library/DebugLib.h>
+#include <Library/MemoryAllocationLib.h>
+
+#include <Uefi/UefiBaseType.h>
+#include <Uefi/UefiSpec.h>
+
+#define ANDROID_BOOTIMG_KERNEL_ARGS_SIZE  512
+
+#define ANDROID_BOOT_MAGIC                "ANDROID!"
+#define ANDROID_BOOT_MAGIC_LENGTH         (sizeof (ANDROID_BOOT_MAGIC) - 1)
+
+/* https://android.googlesource.com/platform/system/core/+/master/mkbootimg/bootimg.h */
+typedef struct {
+  UINT8   BootMagic[ANDROID_BOOT_MAGIC_LENGTH];
+  UINT32  KernelSize;
+  UINT32  KernelAddress;
+  UINT32  RamdiskSize;
+  UINT32  RamdiskAddress;
+  UINT32  SecondStageBootloaderSize;
+  UINT32  SecondStageBootloaderAddress;
+  UINT32  KernelTaggsAddress;
+  UINT32  PageSize;
+  UINT32  Reserved[2];
+  CHAR8   ProductName[16];
+  CHAR8   KernelArgs[ANDROID_BOOTIMG_KERNEL_ARGS_SIZE];
+  UINT32  Id[32];
+} ANDROID_BOOTIMG_HEADER;
+
+/* 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))
+#endif /* __ABOOTIMG_H__ */