IntelSiliconPkg/Include/Library/MicrocodeFlashAccessLib.h

   1 /** @file
   2   Microcode flash device access library.
   3
   4   Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9
  10 #ifndef __MICROCODE_FLASH_ACCESS_LIB_H__
  11 #define __MICROCODE_FLASH_ACCESS_LIB_H__
  12
  13 /**
  14   Perform microcode write opreation.
  15
  16   @param[in] FlashAddress      The address of flash device to be accessed.
  17   @param[in] Buffer            The pointer to the data buffer.
  18   @param[in] Length            The length of data buffer in bytes.
  19
  20   @retval EFI_SUCCESS           The operation returns successfully.
  21   @retval EFI_WRITE_PROTECTED   The flash device is read only.
  22   @retval EFI_UNSUPPORTED       The flash device access is unsupported.
  23   @retval EFI_INVALID_PARAMETER The input parameter is not valid.
  24 **/
  25 EFI_STATUS
  26 EFIAPI
  27 MicrocodeFlashWrite (
  28   IN EFI_PHYSICAL_ADDRESS         FlashAddress,
  29   IN VOID                         *Buffer,
  30   IN UINTN                        Length
  31   );
  32
  33 #endif