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   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15
  16 #ifndef __MICROCODE_FLASH_ACCESS_LIB_H__
  17 #define __MICROCODE_FLASH_ACCESS_LIB_H__
  18
  19 /**
  20   Perform microcode write opreation.
  21
  22   @param[in] FlashAddress      The address of flash device to be accessed.
  23   @param[in] Buffer            The pointer to the data buffer.
  24   @param[in] Length            The length of data buffer in bytes.
  25
  26   @retval EFI_SUCCESS           The operation returns successfully.
  27   @retval EFI_WRITE_PROTECTED   The flash device is read only.
  28   @retval EFI_UNSUPPORTED       The flash device access is unsupported.
  29   @retval EFI_INVALID_PARAMETER The input parameter is not valid.
  30 **/
  31 EFI_STATUS
  32 EFIAPI
  33 MicrocodeFlashWrite (
  34   IN EFI_PHYSICAL_ADDRESS         FlashAddress,
  35   IN VOID                         *Buffer,
  36   IN UINTN                        Length
  37   );
  38
  39 #endif