You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
de527ff606
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
64 lines
1.7 KiB
C
64 lines
1.7 KiB
C
/** @file
|
|
|
|
Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
|
|
Copyright (c) 2017, Linaro.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#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)
|
|
|
|
// No documentation for this really - sizes of fields has been determined
|
|
// empirically.
|
|
#pragma pack(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;
|
|
#pragma pack ()
|
|
|
|
/* 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
|
|
);
|