mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
8b7617151e
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>
92 lines
3.8 KiB
C
92 lines
3.8 KiB
C
/** @file
|
|
Platform flash device access library.
|
|
|
|
Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/FirmwareManagement.h>
|
|
|
|
typedef enum {
|
|
FlashAddressTypeRelativeAddress,
|
|
FlashAddressTypeAbsoluteAddress,
|
|
} FLASH_ADDRESS_TYPE;
|
|
|
|
//
|
|
// Type 0 ~ 0x7FFFFFFF is defined in this library.
|
|
// Type 0x80000000 ~ 0xFFFFFFFF is reserved for OEM.
|
|
//
|
|
typedef enum {
|
|
PlatformFirmwareTypeSystemFirmware,
|
|
PlatformFirmwareTypeNvRam,
|
|
} PLATFORM_FIRMWARE_TYPE;
|
|
|
|
/**
|
|
Perform flash write operation.
|
|
|
|
@param[in] FirmwareType The type of firmware.
|
|
@param[in] FlashAddress The address of flash device to be accessed.
|
|
@param[in] FlashAddressType The type of flash device address.
|
|
@param[in] Buffer The pointer to the data buffer.
|
|
@param[in] Length The length of data buffer in bytes.
|
|
|
|
@retval EFI_SUCCESS The operation returns successfully.
|
|
@retval EFI_WRITE_PROTECTED The flash device is read only.
|
|
@retval EFI_UNSUPPORTED The flash device access is unsupported.
|
|
@retval EFI_INVALID_PARAMETER The input parameter is not valid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PerformFlashWrite (
|
|
IN PLATFORM_FIRMWARE_TYPE FirmwareType,
|
|
IN EFI_PHYSICAL_ADDRESS FlashAddress,
|
|
IN FLASH_ADDRESS_TYPE FlashAddressType,
|
|
IN VOID *Buffer,
|
|
IN UINTN Length
|
|
);
|
|
|
|
/**
|
|
Perform flash write operation with progress indicator. The start and end
|
|
completion percentage values are passed into this function. If the requested
|
|
flash write operation is broken up, then completion percentage between the
|
|
start and end values may be passed to the provided Progress function. The
|
|
caller of this function is required to call the Progress function for the
|
|
start and end completion percentage values. This allows the Progress,
|
|
StartPercentage, and EndPercentage parameters to be ignored if the requested
|
|
flash write operation can not be broken up
|
|
|
|
@param[in] FirmwareType The type of firmware.
|
|
@param[in] FlashAddress The address of flash device to be accessed.
|
|
@param[in] FlashAddressType The type of flash device address.
|
|
@param[in] Buffer The pointer to the data buffer.
|
|
@param[in] Length The length of data buffer in bytes.
|
|
@param[in] Progress A function used report the progress of the
|
|
firmware update. This is an optional parameter
|
|
that may be NULL.
|
|
@param[in] StartPercentage The start completion percentage value that may
|
|
be used to report progress during the flash
|
|
write operation.
|
|
@param[in] EndPercentage The end completion percentage value that may
|
|
be used to report progress during the flash
|
|
write operation.
|
|
|
|
@retval EFI_SUCCESS The operation returns successfully.
|
|
@retval EFI_WRITE_PROTECTED The flash device is read only.
|
|
@retval EFI_UNSUPPORTED The flash device access is unsupported.
|
|
@retval EFI_INVALID_PARAMETER The input parameter is not valid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PerformFlashWriteWithProgress (
|
|
IN PLATFORM_FIRMWARE_TYPE FirmwareType,
|
|
IN EFI_PHYSICAL_ADDRESS FlashAddress,
|
|
IN FLASH_ADDRESS_TYPE FlashAddressType,
|
|
IN VOID *Buffer,
|
|
IN UINTN Length,
|
|
IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress OPTIONAL,
|
|
IN UINTN StartPercentage,
|
|
IN UINTN EndPercentage
|
|
);
|