text: /** @file
    Platform Flash Access library.
  
    Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
    This program and the accompanying materials
    are licensed and made available under the terms and conditions of the BSD License
    which accompanies this distribution.  The full text of the license may be found at
    http://opensource.org/licenses/bsd-license.php
  
    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  
  **/
  #include <Uefi.h>
  
  #include <PiDxe.h>
  
  #include <Library/BaseLib.h>
  #include <Library/BaseMemoryLib.h>
  #include <Library/DebugLib.h>
  #include <Library/PcdLib.h>
  #include <Library/PlatformFlashAccessLib.h>
  //#include <Library/FlashDeviceLib.h>
  #include <Library/MemoryAllocationLib.h>
  #include <Protocol/Spi.h>
  #include <Library/CacheMaintenanceLib.h>
  #include "PchAccess.h"
  #include <Library/IoLib.h>
  #include <Library/UefiLib.h>
  #include <Library/UefiBootServicesTableLib.h>
  #include <Library/PrintLib.h>
  
  //#define SECTOR_SIZE_64KB  0x10000      // Common 64kBytes sector size
  //#define ALINGED_SIZE  SECTOR_SIZE_64KB
  
  #define BLOCK_SIZE 0x1000
  #define ALINGED_SIZE BLOCK_SIZE
  
  #define R_PCH_LPC_BIOS_CNTL                       0xDC
  #define B_PCH_LPC_BIOS_CNTL_SMM_BWP               0x20            ///< SMM BIOS write protect disable
  
  //
  // Prefix Opcode Index on the host SPI controller
  //
  typedef enum {
    SPI_WREN,             // Prefix Opcode 0: Write Enable
    SPI_EWSR,             // Prefix Opcode 1: Enable Write Status Register
  } PREFIX_OPCODE_INDEX;
  //
  // Opcode Menu Index on the host SPI controller
  //
  typedef enum {
    SPI_READ_ID,        // Opcode 0: READ ID, Read cycle with address
    SPI_READ,           // Opcode 1: READ, Read cycle with address
    SPI_RDSR,           // Opcode 2: Read Status Register, No address
    SPI_WRDI_SFDP,      // Opcode 3: Write Disable or Discovery Parameters, No address
    SPI_SERASE,         // Opcode 4: Sector Erase (4KB), Write cycle with address
    SPI_BERASE,         // Opcode 5: Block Erase (32KB), Write cycle with address
    SPI_PROG,           // Opcode 6: Byte Program, Write cycle with address
    SPI_WRSR,           // Opcode 7: Write Status Register, No address
  } SPI_OPCODE_INDEX;
  
  STATIC EFI_PHYSICAL_ADDRESS     mInternalFdAddress;
  
  EFI_SPI_PROTOCOL  *mSpiProtocol;
  
  /**
    Read NumBytes bytes of data from the address specified by
    PAddress into Buffer.
  
    @param[in]      Address       The starting physical address of the read.
    @param[in,out]  NumBytes      On input, the number of bytes to read. On output, the number
                                  of bytes actually read.
    @param[out]     Buffer        The destination data buffer for the read.
  
    @retval         EFI_SUCCESS       Opertion is successful.
    @retval         EFI_DEVICE_ERROR  If there is any device errors.
  
  **/
  EFI_STATUS
  EFIAPI
  SpiFlashRead (
    IN     UINTN     Address,
    IN OUT UINT32    *NumBytes,
       OUT UINT8     *Buffer
    )
  {
    EFI_STATUS    Status = EFI_SUCCESS;
    UINTN         Offset = 0;
  
    ASSERT ((NumBytes != NULL) && (Buffer != NULL));
  
  
    //if (Address >= (UINTN)PcdGet32 (PcdGbeRomBase) && Address < (UINTN)PcdGet32 (PcdPDRRomBase)) {
      Offset = Address - (UINTN)PcdGet32 (PcdFlashChipBase);
  
      Status = mSpiProtocol->Execute (
                                 mSpiProtocol,
                                 1, //SPI_READ,
                                 0, //SPI_WREN,
                                 TRUE,
                                 TRUE,
                                 FALSE,
                                 Offset,
                                 BLOCK_SIZE,
                                 Buffer,
                                 EnumSpiRegionAll
                                 );
      return Status;
  }
  
  /**
    Write NumBytes bytes of data from Buffer to the address specified by
    PAddresss.
  
    @param[in]      Address         The starting physical address of the write.
    @param[in,out]  NumBytes        On input, the number of bytes to write. On output,
                                    the actual number of bytes written.
    @param[in]      Buffer          The source data buffer for the write.
  
    @retval         EFI_SUCCESS       Opertion is successful.
    @retval         EFI_DEVICE_ERROR  If there is any device errors.
  
  **/
  EFI_STATUS
  EFIAPI
  SpiFlashWrite (
    IN     UINTN     Address,
    IN OUT UINT32    *NumBytes,
    IN     UINT8     *Buffer
    )
  {
    EFI_STATUS                Status;
    UINTN                     Offset;
    UINT32                    Length;
    UINT32                    RemainingBytes;
  
    ASSERT ((NumBytes != NULL) && (Buffer != NULL));
    ASSERT (Address >= (UINTN)PcdGet32 (PcdFlashChipBase));
  
    Offset    = Address - (UINTN)PcdGet32 (PcdFlashChipBase);
  
    ASSERT ((*NumBytes + Offset) <= (UINTN)PcdGet32 (PcdFlashChipSize));
  
    Status = EFI_SUCCESS;
    RemainingBytes = *NumBytes;
  
    while (RemainingBytes > 0) {
      if (RemainingBytes > SIZE_4KB) {
        Length = SIZE_4KB;
      } else {
        Length = RemainingBytes;
      }
      Status = mSpiProtocol->Execute (
                               mSpiProtocol,
                               SPI_PROG,
                               SPI_WREN,
                               TRUE,
                               TRUE,
                               TRUE,
                               (UINT32) Offset,
                               Length,
                               Buffer,
                               EnumSpiRegionAll
                               );
      if (EFI_ERROR (Status)) {
        break;
      }
      RemainingBytes -= Length;
      Offset += Length;
      Buffer += Length;
    }
  
    //
    // Actual number of bytes written
    //
    *NumBytes -= RemainingBytes;
  
    return Status;
  }
  
  
  EFI_STATUS
  InternalReadBlock (
    IN  EFI_PHYSICAL_ADDRESS  BaseAddress,
    OUT VOID                  *ReadBuffer
    )
  {
    EFI_STATUS    Status;
    UINT32        BlockSize;
  
    BlockSize = BLOCK_SIZE;
  
    Status = SpiFlashRead ((UINTN) BaseAddress, &BlockSize, ReadBuffer);
  
    return Status;
  }
  
  /**
    Erase the block starting at Address.
  
    @param[in]  Address         The starting physical address of the block to be erased.
                                This library assume that caller garantee that the PAddress
                                is at the starting address of this block.
    @param[in]  NumBytes        On input, the number of bytes of the logical block to be erased.
                                On output, the actual number of bytes erased.
  
    @retval     EFI_SUCCESS.      Opertion is successful.
    @retval     EFI_DEVICE_ERROR  If there is any device errors.
  
  **/
  EFI_STATUS
  EFIAPI
  SpiFlashBlockErase (
    IN UINTN    Address,
    IN UINTN    *NumBytes
    )
  {
    EFI_STATUS          Status;
    UINTN               Offset;
    UINTN               RemainingBytes;
  
    ASSERT (NumBytes != NULL);
    ASSERT (Address >= (UINTN)PcdGet32 (PcdFlashChipBase));
  
    Offset    = Address - (UINTN)PcdGet32 (PcdFlashChipBase);
  
    ASSERT ((*NumBytes % SIZE_4KB) == 0);
    ASSERT ((*NumBytes + Offset) <= (UINTN)PcdGet32 (PcdFlashChipSize));
  
    Status = EFI_SUCCESS;
    RemainingBytes = *NumBytes;
  
    //
    // To adjust the Offset with Bios/Gbe
    //
  //  if (Address >= (UINTN)PcdGet32 (PcdFlashChipBase)) {
  //    Offset = Address - (UINTN)PcdGet32 (PcdFlashChipBase);
  
      while (RemainingBytes > 0) {
        Status = mSpiProtocol->Execute (
                                 mSpiProtocol,
                                 SPI_SERASE,
                                 SPI_WREN,
                                 FALSE,
                                 TRUE,
                                 FALSE,
                                 (UINT32) Offset,
                                 0,
                                 NULL,
                                 EnumSpiRegionAll
                                 );
        if (EFI_ERROR (Status)) {
          break;
        }
        RemainingBytes -= SIZE_4KB;
        Offset         += SIZE_4KB;
      }
  //  }
  
    //
    // Actual number of bytes erased
    //
    *NumBytes -= RemainingBytes;
  
    return Status;
  }
  
  /**
  
  Routine Description:
  
    Erase the whole block.
  
  Arguments:
  
    BaseAddress  - Base address of the block to be erased.
  
  Returns:
  
    EFI_SUCCESS - The command completed successfully.
    Other       - Device error or wirte-locked, operation failed.
  
  **/
  EFI_STATUS
  InternalEraseBlock (
    IN  EFI_PHYSICAL_ADDRESS BaseAddress
    )
  {
    EFI_STATUS                              Status;
    UINTN                                   NumBytes;
  
    NumBytes = BLOCK_SIZE;
  
    Status = SpiFlashBlockErase ((UINTN) BaseAddress, &NumBytes);
  
    return Status;
  }
  
  EFI_STATUS
  InternalCompareBlock (
    IN  EFI_PHYSICAL_ADDRESS        BaseAddress,
    IN  UINT8                       *Buffer
    )
  {
    EFI_STATUS                              Status;
    VOID                                    *CompareBuffer;
    UINT32                                  NumBytes;
    INTN                                    CompareResult;
  
    NumBytes = BLOCK_SIZE;
    CompareBuffer = AllocatePool (NumBytes);
    if (CompareBuffer == NULL) {
      Status = EFI_OUT_OF_RESOURCES;
      goto Done;
    }
  
    Status = SpiFlashRead ((UINTN) BaseAddress, &NumBytes, CompareBuffer);
    if (EFI_ERROR (Status)) {
      goto Done;
    }
    CompareResult = CompareMem (CompareBuffer, Buffer, BLOCK_SIZE);
    if (CompareResult != 0) {
      Status = EFI_VOLUME_CORRUPTED;
    }
  
  Done:
    if (CompareBuffer != NULL) {
      FreePool (CompareBuffer);
    }
  
    return Status;
  }
  
  /**
  
  Routine Description:
  
    Write a block of data.
  
  Arguments:
  
    BaseAddress  - Base address of the block.
    Buffer       - Data buffer.
    BufferSize   - Size of the buffer.
  
  Returns:
  
    EFI_SUCCESS           - The command completed successfully.
    EFI_INVALID_PARAMETER - Invalid parameter, can not proceed.
    Other                 - Device error or wirte-locked, operation failed.
  
  **/
  EFI_STATUS
  InternalWriteBlock (
    IN  EFI_PHYSICAL_ADDRESS        BaseAddress,
    IN  UINT8                       *Buffer,
    IN  UINT32                      BufferSize
    )
  {
    EFI_STATUS                              Status;
  
    Status = SpiFlashWrite ((UINTN) BaseAddress, &BufferSize, Buffer);
  
    if (EFI_ERROR (Status)) {
      DEBUG((DEBUG_ERROR, "\nFlash write error."));
      return Status;
    }
  
    WriteBackInvalidateDataCacheRange ((VOID *) (UINTN) BaseAddress, BLOCK_SIZE);
  
    Status = InternalCompareBlock (BaseAddress, Buffer);
    if (EFI_ERROR (Status)) {
      DEBUG((DEBUG_ERROR, "\nError when writing to BaseAddress %x with different at offset %x.", BaseAddress, Status));
    } else {
      DEBUG((DEBUG_INFO, "\nVerified data written to Block at %x is correct.", BaseAddress));
    }
  
    return Status;
  
  }
  
  /**
    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
    )
  {
    EFI_STATUS            Status = EFI_SUCCESS;
    UINTN               Index;
    EFI_PHYSICAL_ADDRESS  Address;
    UINTN                 CountOfBlocks;
    EFI_TPL               OldTpl;
    BOOLEAN               FlashError;
    UINT8                 *Buf;
    UINTN                 LpcBaseAddress;
    UINT8                 Data8Or;
    UINT8                 Data8And;
    UINT8                 BiosCntl;
  
    Index             = 0;
    Address           = 0;
    CountOfBlocks     = 0;
    FlashError        = FALSE;
    Buf               = Buffer;
  
    DEBUG((DEBUG_INFO | DEBUG_ERROR, "PerformFlashWrite - 0x%x(%x) - 0x%x\n", (UINTN)FlashAddress, (UINTN)FlashAddressType, Length));
    if (FlashAddressType == FlashAddressTypeRelativeAddress) {
      FlashAddress = FlashAddress + mInternalFdAddress;
    }
  
    CountOfBlocks = (UINTN) (Length / BLOCK_SIZE);
    Address = FlashAddress;
  
    LpcBaseAddress = MmPciAddress (0,
                      DEFAULT_PCI_BUS_NUMBER_PCH,
                      PCI_DEVICE_NUMBER_PCH_LPC,
                      PCI_FUNCTION_NUMBER_PCH_LPC,
                      0
                      );
    BiosCntl = MmioRead8 (LpcBaseAddress + R_PCH_LPC_BIOS_CNTL);
    if ((BiosCntl & B_PCH_LPC_BIOS_CNTL_SMM_BWP) == B_PCH_LPC_BIOS_CNTL_SMM_BWP) {
      ///
      /// Clear SMM_BWP bit (D31:F0:RegDCh[5])
      ///
      Data8And  = (UINT8) ~B_PCH_LPC_BIOS_CNTL_SMM_BWP;
      Data8Or   = 0x00;
  
      MmioAndThenOr8 (
        LpcBaseAddress + R_PCH_LPC_BIOS_CNTL,
        Data8And,
        Data8Or
        );
      DEBUG((DEBUG_INFO, "PerformFlashWrite Clear SMM_BWP bit\n"));
    }
  
      //
      // Raise TPL to TPL_NOTIFY to block any event handler,
      // while still allowing RaiseTPL(TPL_NOTIFY) within
      // output driver during Print()
      //
      OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
      for (Index = 0; Index < CountOfBlocks; Index++) {
        if (Progress != NULL) {
          Progress (StartPercentage + ((Index * (EndPercentage - StartPercentage)) / CountOfBlocks));
        }
        //
        // Handle block based on address and contents.
        //
        if (!EFI_ERROR (InternalCompareBlock (Address, Buf))) {
          DEBUG((DEBUG_INFO, "Skipping block at 0x%lx (already programmed)\n", Address));
        } else {
          //
          // Make updating process uninterruptable,
          // so that the flash memory area is not accessed by other entities
          // which may interfere with the updating process
          //
          Status  = InternalEraseBlock (Address);
          if (EFI_ERROR(Status)) {
            gBS->RestoreTPL (OldTpl);
            FlashError = TRUE;
            goto Done;
          }
          Status = InternalWriteBlock (
                    Address,
                    Buf,
                    (UINT32)(Length > BLOCK_SIZE ? BLOCK_SIZE : Length)
                    );
          if (EFI_ERROR(Status)) {
            gBS->RestoreTPL (OldTpl);
            FlashError = TRUE;
            goto Done;
          }
        }
  
        //
        // Move to next block to update.
        //
        Address += BLOCK_SIZE;
        Buf += BLOCK_SIZE;
        if (Length > BLOCK_SIZE) {
          Length -= BLOCK_SIZE;
        } else {
          Length = 0;
        }
      }
      gBS->RestoreTPL (OldTpl);
  
  Done:
    if ((BiosCntl & B_PCH_LPC_BIOS_CNTL_SMM_BWP) == B_PCH_LPC_BIOS_CNTL_SMM_BWP) {
      //
      // Restore original control setting
      //
      MmioWrite8 (LpcBaseAddress + R_PCH_LPC_BIOS_CNTL, BiosCntl);
    }
  
    if (Progress != NULL) {
      Progress (EndPercentage);
    }
  
    return EFI_SUCCESS;
  }
  
  /**
    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
    )
  {
    return PerformFlashWriteWithProgress (
             FirmwareType,
             FlashAddress,
             FlashAddressType,
             Buffer,
             Length,
             NULL,
             0,
             0
             );
  }
  
  /**
    Perform microcode write operation.
  
    @param[in] FlashAddress      The address of flash device to be accessed.
    @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
  MicrocodeFlashWrite (
    IN EFI_PHYSICAL_ADDRESS         FlashAddress,
    IN VOID                         *Buffer,
    IN UINTN                        Length
    )
  {
    EFI_PHYSICAL_ADDRESS         AlignedFlashAddress;
    VOID                         *AlignedBuffer;
    UINTN                        AlignedLength;
    UINTN                        OffsetHead;
    UINTN                        OffsetTail;
    EFI_STATUS                   Status;
  
    DEBUG((DEBUG_INFO, "MicrocodeFlashWrite - 0x%x - 0x%x\n", (UINTN)FlashAddress, Length));
  
    //
    // Need make buffer 64K aligned to support ERASE
    //
    // [Aligned]    FlashAddress    [Aligned]
    // |              |                     |
    // V              V                     V
    // +--------------+========+------------+
    // | OffsetHeader | Length | OffsetTail |
    // +--------------+========+------------+
    // ^
    // |<-----------AlignedLength----------->
    // |
    // AlignedFlashAddress
    //
    OffsetHead = FlashAddress & (ALINGED_SIZE - 1);
    OffsetTail = (FlashAddress + Length) & (ALINGED_SIZE - 1);
    if (OffsetTail != 0) {
      OffsetTail = ALINGED_SIZE - OffsetTail;
    }
  
    if ((OffsetHead != 0) || (OffsetTail != 0)) {
      AlignedFlashAddress = FlashAddress - OffsetHead;
      AlignedLength = Length + OffsetHead + OffsetTail;
  
      AlignedBuffer = AllocatePool(AlignedLength);
      if (AlignedBuffer == NULL) {
        return EFI_OUT_OF_RESOURCES;
      }
      //
      // Save original buffer
      //
      if (OffsetHead != 0) {
        CopyMem((UINT8 *)AlignedBuffer, (VOID *)(UINTN)AlignedFlashAddress, OffsetHead);
      }
      if (OffsetTail != 0) {
        CopyMem((UINT8 *)AlignedBuffer + OffsetHead + Length, (VOID *)(UINTN)(AlignedFlashAddress + OffsetHead + Length), OffsetTail);
      }
      //
      // Override new buffer
      //
      CopyMem((UINT8 *)AlignedBuffer + OffsetHead, Buffer, Length);
    } else {
      AlignedFlashAddress = FlashAddress;
      AlignedBuffer = Buffer;
      AlignedLength = Length;
    }
  
    Status = PerformFlashWrite(
               PlatformFirmwareTypeSystemFirmware,
               AlignedFlashAddress,
               FlashAddressTypeAbsoluteAddress,
               AlignedBuffer,
               AlignedLength
               );
    if ((OffsetHead != 0) || (OffsetTail != 0)) {
      FreePool (AlignedBuffer);
    }
    return Status;
  }
  
  /**
    Platform Flash Access Lib Constructor.
  **/
  EFI_STATUS
  EFIAPI
  PerformFlashAccessLibConstructor (
    VOID
    )
  {
    EFI_STATUS Status;
    mInternalFdAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)PcdGet32(PcdFlashAreaBaseAddress);
    DEBUG((DEBUG_INFO, "PcdFlashAreaBaseAddress - 0x%x\n", mInternalFdAddress));
  
    Status = gBS->LocateProtocol (
                    &gEfiSpiProtocolGuid,
                    NULL,
                    (VOID **) &mSpiProtocol
                    );
    ASSERT_EFI_ERROR(Status);
  
    return EFI_SUCCESS;
  }
  