UefiPayloadPkg: Apply uncrustify changes

[mirror_edk2.git] / UefiPayloadPkg / Include / Library / FlashDeviceLib.h

/** @file\r
  Flash device library class header file.\r
\r
  Copyright (c) 2017 - 2021, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef FLASHDEVICE_LIB_H_\r
#define FLASHDEVICE_LIB_H_\r
\r
/**\r
  Read NumBytes bytes of data from the address specified by\r
  PAddress into Buffer.\r
\r
  @param[in]      PAddress    The starting physical address of the read.\r
  @param[in,out]  NumBytes    On input, the number of bytes to read. On output, the number\r
                              of bytes actually read.\r
  @param[out]     Buffer      The destination data buffer for the read.\r
\r
  @retval EFI_SUCCESS.        Opertion is successful.\r
  @retval EFI_DEVICE_ERROR    If there is any device errors.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibFvbFlashDeviceRead (\r
  IN      UINTN  PAddress,\r
  IN  OUT UINTN  *NumBytes,\r
  OUT UINT8      *Buffer\r
  );\r
\r
/**\r
  Write NumBytes bytes of data from Buffer to the address specified by\r
  PAddresss.\r
\r
  @param[in]      PAddress The starting physical address of the write.\r
  @param[in,out]  NumBytes On input, the number of bytes to write. On output,\r
                           the actual number of bytes written.\r
  @param[in]      Buffer   The source data buffer for the write.\r
\r
  @retval EFI_SUCCESS.            Opertion is successful.\r
  @retval EFI_DEVICE_ERROR        If there is any device errors.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibFvbFlashDeviceWrite (\r
  IN        UINTN  PAddress,\r
  IN OUT    UINTN  *NumBytes,\r
  IN        UINT8  *Buffer\r
  );\r
\r
/**\r
  Erase the block starting at PAddress.\r
\r
  @param[in]  PAddress The starting physical address of the region to be erased.\r
  @param[in]  LbaLength   The length of the region to be erased. This parameter is necessary\r
                       as the physical block size on a flash device could be different than\r
                       the logical block size of Firmware Volume Block protocol. Erase on\r
                       flash chip is always performed block by block. Therefore, the ERASE\r
                       operation to a logical block is converted a number of ERASE operation\r
                       (or a partial erase) on the hardware.\r
\r
  @retval EFI_SUCCESS.            Opertion is successful.\r
  @retval EFI_DEVICE_ERROR        If there is any device errors.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibFvbFlashDeviceBlockErase (\r
  IN    UINTN  PAddress,\r
  IN    UINTN  LbaLength\r
  );\r
\r
/**\r
  Lock or unlock the block starting at PAddress.\r
\r
  @param[in]  PAddress The starting physical address of region to be (un)locked.\r
  @param[in]  LbaLength   The length of the region to be (un)locked. This parameter is necessary\r
                       as the physical block size on a flash device could be different than\r
                       the logical block size of Firmware Volume Block protocol. (Un)Lock on\r
                       flash chip is always performed block by block. Therefore, the (Un)Lock\r
                       operation to a logical block is converted a number of (Un)Lock operation\r
                       (or a partial erase) on the hardware.\r
  @param[in]  Lock     TRUE to lock. FALSE to unlock.\r
\r
  @retval EFI_SUCCESS. Opertion is successful.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibFvbFlashDeviceBlockLock (\r
  IN    UINTN    PAddress,\r
  IN    UINTN    LbaLength,\r
  IN    BOOLEAN  Lock\r
  );\r
\r
PHYSICAL_ADDRESS\r
EFIAPI\r
LibFvbFlashDeviceMemoryMap (\r
  );\r
\r
#endif\r