SpiCommon.h

Go to the documentation of this file.

 
#ifndef SPI_COMMON_LIB_H_
#define SPI_COMMON_LIB_H_
 
#include <PiDxe.h>
#include <Uefi/UefiBaseType.h>
#include <IndustryStandard/Pci30.h>
#include <Library/IoLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/SpiFlashLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseLib.h>
#include <Library/HobLib.h>
#include <Library/TimerLib.h>
#include <Guid/SpiFlashInfoGuid.h>
#include "RegsSpi.h"
 
#define WAIT_TIME    6000000    
#define WAIT_PERIOD  10         
 
typedef enum {
  FlashCycleRead,
  FlashCycleWrite,
  FlashCycleErase,
  FlashCycleReadSfdp,
  FlashCycleReadJedecId,
  FlashCycleWriteStatus,
  FlashCycleReadStatus,
  FlashCycleMax
} FLASH_CYCLE_TYPE;
 
typedef enum {
  FlashComponent0,
  FlashComponent1,
  FlashComponentMax
} FLASH_COMPONENT_NUM;
 
#define SC_SPI_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('P', 'S', 'P', 'I')
 
typedef struct {
  UINTN         Signature;
  EFI_HANDLE    Handle;
  UINT32        AcpiTmrReg;
  UINTN         PchSpiBase;
  UINT16        RegionPermission;
  UINT32        SfdpVscc0Value;
  UINT32        SfdpVscc1Value;
  UINT32        StrapBaseAddress;
  UINT8         NumberOfComponents;
  UINT16        Flags;
  UINT32        Component1StartAddr;
} SPI_INSTANCE;
 
UINT32
AcquireSpiBar0 (
  IN  UINTN  PchSpiBase
  );
 
VOID
ReleaseSpiBar0 (
  IN  UINTN  PchSpiBase
  );
 
EFI_STATUS
EFIAPI
DisableBiosWriteProtect (
  IN  UINTN  PchSpiBase,
  IN  UINT8  CpuSmmBwp
  );
 
VOID
EFIAPI
EnableBiosWriteProtect (
  IN  UINTN  PchSpiBase,
  IN  UINT8  CpuSmmBwp
  );
 
UINT8
SaveAndDisableSpiPrefetchCache (
  IN  UINTN  PchSpiBase
  );
 
VOID
SetSpiBiosControlRegister (
  IN  UINTN  PchSpiBase,
  IN  UINT8  BiosCtlValue
  );
 
EFI_STATUS
SendSpiCmd (
  IN     FLASH_REGION_TYPE  FlashRegionType,
  IN     FLASH_CYCLE_TYPE   FlashCycleType,
  IN     UINT32             Address,
  IN     UINT32             ByteCount,
  IN OUT UINT8              *Buffer
  );
 
BOOLEAN
WaitForSpiCycleComplete (
  IN     UINT32   PchSpiBar0,
  IN     BOOLEAN  ErrorCheck
  );
 
#endif