#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"

Data Structures
struct	SPI_INSTANCE

Macros
#define	WAIT_TIME 6000000
	Wait Time = 6 seconds = 6000000 microseconds.

#define	WAIT_PERIOD 10
	Wait Period = 10 microseconds.

#define	SC_SPI_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'S', 'P', 'I')

Enumerations
enum	FLASH_CYCLE_TYPE { FlashCycleRead , FlashCycleWrite , FlashCycleErase , FlashCycleReadSfdp , FlashCycleReadJedecId , FlashCycleWriteStatus , FlashCycleReadStatus , FlashCycleMax }

enum	FLASH_COMPONENT_NUM { FlashComponent0 , FlashComponent1 , FlashComponentMax }

Functions
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)

Detailed Description

Header file for the SPI flash module.

Copyright (c) 2017 - 2021, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SpiCommon.h.

Macro Definition Documentation

◆ SC_SPI_PRIVATE_DATA_SIGNATURE

#define SC_SPI_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'S', 'P', 'I')

Private data structure definitions for the driver

Definition at line 60 of file SpiCommon.h.

◆ WAIT_PERIOD

#define WAIT_PERIOD 10

Wait Period = 10 microseconds.

Definition at line 32 of file SpiCommon.h.

◆ WAIT_TIME

#define WAIT_TIME 6000000

Wait Time = 6 seconds = 6000000 microseconds.

Maximum time allowed while waiting the SPI cycle to complete Wait Time = 6 seconds = 6000000 microseconds Wait Period = 10 microseconds

Definition at line 31 of file SpiCommon.h.

Enumeration Type Documentation

◆ FLASH_COMPONENT_NUM

enum FLASH_COMPONENT_NUM

Flash Component Number

Definition at line 51 of file SpiCommon.h.

◆ FLASH_CYCLE_TYPE

enum FLASH_CYCLE_TYPE

Flash cycle Type

Definition at line 37 of file SpiCommon.h.

Function Documentation

◆ AcquireSpiBar0()

UINT32 AcquireSpiBar0 ( IN UINTN PchSpiBase )

Acquire SPI MMIO BAR

Parameters

[in] PchSpiBase PCH SPI PCI Base Address

Return values

Return SPI BAR Address

Acquire SPI MMIO BAR.

Parameters

[in] PchSpiBase PCH SPI PCI Base Address

Return values

Return SPI BAR Address

Definition at line 18 of file PchSpi.c.

◆ DisableBiosWriteProtect()

EFI_STATUS EFIAPI DisableBiosWriteProtect	(	IN UINTN	PchSpiBase,
		IN UINT8	CpuSmmBwp
	)

This function is a hook for Spi to disable BIOS Write Protect

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	CpuSmmBwp	Need to disable CPU SMM Bios write protection or not

Return values

EFI_SUCCESS	The protocol instance was properly initialized
EFI_ACCESS_DENIED	The BIOS Region can only be updated in SMM phase

This function is a hook for Spi to disable BIOS Write Protect.

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	CpuSmmBwp	Need to disable CPU SMM Bios write protection or not

Return values

EFI_SUCCESS	The protocol instance was properly initialized
EFI_ACCESS_DENIED	The BIOS Region can only be updated in SMM phase

Definition at line 83 of file PchSpi.c.

◆ EnableBiosWriteProtect()

VOID EFIAPI EnableBiosWriteProtect	(	IN UINTN	PchSpiBase,
		IN UINT8	CpuSmmBwp
	)

This function is a hook for Spi to enable BIOS Write Protect

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	CpuSmmBwp	Need to disable CPU SMM Bios write protection or not

Return values

None

This function is a hook for Spi to enable BIOS Write Protect.

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	CpuSmmBwp	Need to disable CPU SMM Bios write protection or not

Definition at line 114 of file PchSpi.c.

◆ ReleaseSpiBar0()

VOID ReleaseSpiBar0 ( IN UINTN PchSpiBase )

Release SPI MMIO BAR. Do nothing.

Parameters

[in] PchSpiBase PCH SPI PCI Base Address

Return values

None

Release SPI MMIO BAR. Do nothing.

Parameters

[in] PchSpiBase PCH SPI PCI Base Address

Definition at line 32 of file PchSpi.c.

◆ SaveAndDisableSpiPrefetchCache()

UINT8 SaveAndDisableSpiPrefetchCache ( IN UINTN PchSpiBase )

This function disables SPI Prefetching and caching, and returns previous BIOS Control Register value before disabling.

Parameters

[in] PchSpiBase PCH SPI PCI Base Address

Return values

Previous BIOS Control Register value

Definition at line 139 of file PchSpi.c.

◆ SendSpiCmd()

EFI_STATUS SendSpiCmd	(	IN FLASH_REGION_TYPE	FlashRegionType,
		IN FLASH_CYCLE_TYPE	FlashCycleType,
		IN UINT32	Address,
		IN UINT32	ByteCount,
		IN OUT UINT8 *	Buffer
	)

This function sends the programmed SPI command to the slave device.

Parameters

[in]	SpiRegionType	The SPI Region type for flash cycle which is listed in the Descriptor
[in]	FlashCycleType	The Flash SPI cycle type list in HSFC (Hardware Sequencing Flash Control Register) register
[in]	Address	The Flash Linear Address must fall within a region for which BIOS has access permissions.
[in]	ByteCount	Number of bytes in the data portion of the SPI cycle.
[in,out]	Buffer	Pointer to caller-allocated buffer containing the data received or sent during the SPI cycle.

Return values

EFI_SUCCESS	SPI command completes successfully.
EFI_DEVICE_ERROR	Device error, the command aborts abnormally.
EFI_ACCESS_DENIED	Some unrecognized command encountered in hardware sequencing mode
EFI_INVALID_PARAMETER	The parameters specified are not valid.

This function sends the programmed SPI command to the slave device.

Parameters

[in]	FlashRegionType	The SPI Region type for flash cycle which is listed in the Descriptor
[in]	FlashCycleType	The Flash SPI cycle type list in HSFC (Hardware Sequencing Flash Control Register) register
[in]	Address	The Flash Linear Address must fall within a region for which BIOS has access permissions.
[in]	ByteCount	Number of bytes in the data portion of the SPI cycle.
[in,out]	Buffer	Pointer to caller-allocated buffer containing the data received or sent during the SPI cycle.

Return values

EFI_SUCCESS	SPI command completes successfully.
EFI_DEVICE_ERROR	Device error, the command aborts abnormally.
EFI_ACCESS_DENIED	Some unrecognized command encountered in hardware sequencing mode
EFI_INVALID_PARAMETER	The parameters specified are not valid.

Restore the settings for SPI Prefetching and Caching and enable BIOS Write Protect

Definition at line 419 of file SpiFlashLib.c.

◆ SetSpiBiosControlRegister()

VOID SetSpiBiosControlRegister	(	IN UINTN	PchSpiBase,
		IN UINT8	BiosCtlValue
	)

This function updates BIOS Control Register with the given value.

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	BiosCtlValue	BIOS Control Register Value to be updated

Return values

None

This function updates BIOS Control Register with the given value.

Parameters

[in]	PchSpiBase	PCH SPI PCI Base Address
[in]	BiosCtlValue	BIOS Control Register Value to be updated

Definition at line 164 of file PchSpi.c.

◆ WaitForSpiCycleComplete()

BOOLEAN WaitForSpiCycleComplete	(	IN UINT32	ScSpiBar0,
		IN BOOLEAN	ErrorCheck
	)

Wait execution cycle to complete on the SPI interface.

Parameters

[in]	PchSpiBar0	Spi MMIO base address
[in]	ErrorCheck	TRUE if the SpiCycle needs to do the error check

Return values

TRUE	SPI cycle completed on the interface.
FALSE	Time out while waiting the SPI cycle to complete. It's not safe to program the next command on the SPI interface.

Wait execution cycle to complete on the SPI interface.

Parameters

[in]	ScSpiBar0	Spi MMIO base address
[in]	ErrorCheck	TRUE if the SpiCycle needs to do the error check

Return values

TRUE	SPI cycle completed on the interface.
FALSE	Time out while waiting the SPI cycle to complete. It's not safe to program the next command on the SPI interface.

Definition at line 774 of file SpiFlashLib.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ SC_SPI_PRIVATE_DATA_SIGNATURE

◆ WAIT_PERIOD

◆ WAIT_TIME

Enumeration Type Documentation

◆ FLASH_COMPONENT_NUM

◆ FLASH_CYCLE_TYPE

Function Documentation

◆ AcquireSpiBar0()

◆ DisableBiosWriteProtect()

◆ EnableBiosWriteProtect()

◆ ReleaseSpiBar0()

◆ SaveAndDisableSpiPrefetchCache()

◆ SendSpiCmd()

◆ SetSpiBiosControlRegister()

◆ WaitForSpiCycleComplete()