Ftftx CACHE Driver

Overview

Data Structures
struct	_flash_prefetch_speculation_status
	FTFx prefetch speculation status. More...
struct	_ftfx_cache_config
	FTFx cache driver state information. More...

Typedefs
typedef struct _flash_prefetch_speculation_status	ftfx_prefetch_speculation_status_t
	FTFx prefetch speculation status.
typedef struct _ftfx_cache_config	ftfx_cache_config_t
	FTFx cache driver state information. More...

Enumerations
enum	_ftfx_cache_ram_func_constants { kFTFx_CACHE_RamFuncMaxSizeInWords = 16U }
	Constants for execute-in-RAM flash function. More...

Functions
status_t	FTFx_CACHE_Init (ftfx_cache_config_t *config)
	Initializes the global FTFx cache structure members. More...
status_t	FTFx_CACHE_ClearCachePrefetchSpeculation (ftfx_cache_config_t *config, bool isPreProcess)
	Process the cache/prefetch/speculation to the flash. More...
status_t	FTFx_CACHE_PflashSetPrefetchSpeculation (ftfx_prefetch_speculation_status_t *speculationStatus)
	Sets the PFlash prefetch speculation to the intended speculation status. More...
status_t	FTFx_CACHE_PflashGetPrefetchSpeculation (ftfx_prefetch_speculation_status_t *speculationStatus)
	Gets the PFlash prefetch speculation status. More...

---

Data Structure Documentation

struct _flash_prefetch_speculation_status

Data Fields
bool	instructionOff
	Instruction speculation. More...
bool	dataOff
	Data speculation. More...

Field Documentation

bool _flash_prefetch_speculation_status::instructionOff

bool _flash_prefetch_speculation_status::dataOff

struct _ftfx_cache_config

An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.

Data Fields
uint8_t	flashMemoryIndex
	0 - primary flash; 1 - secondary flash
function_bit_operation_ptr_t	bitOperFuncAddr
	An buffer point to the flash execute-in-RAM function. More...

Field Documentation

function_bit_operation_ptr_t _ftfx_cache_config::bitOperFuncAddr

Typedef Documentation

typedef struct _ftfx_cache_config ftfx_cache_config_t

An instance of this structure is allocated by the user of the flash driver and passed into each of the driver APIs.

Enumeration Type Documentation

enum _ftfx_cache_ram_func_constants

Enumerator
kFTFx_CACHE_RamFuncMaxSizeInWords	The maximum size of execute-in-RAM function.

Function Documentation

status_t FTFx_CACHE_Init

(

ftfx_cache_config_t *

config

)

This function checks and initializes the Flash module for the other FTFx cache APIs.

Parameters

config

Pointer to the storage for the driver runtime state.

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	An invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.

status_t FTFx_CACHE_ClearCachePrefetchSpeculation	(	ftfx_cache_config_t *	config,
		bool	isPreProcess
	)

Parameters

config	A pointer to the storage for the driver runtime state.
isPreProcess	The possible option used to control flash cache/prefetch/speculation

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidArgument	Invalid argument is provided.
kStatus_FTFx_ExecuteInRamFunctionNotReady	Execute-in-RAM function is not available.

status_t FTFx_CACHE_PflashSetPrefetchSpeculation

(

ftfx_prefetch_speculation_status_t *

speculationStatus

)

Parameters

speculationStatus

The expected protect status to set to the PFlash protection register. Each bit is

Return values

kStatus_FTFx_Success	API was executed successfully.
kStatus_FTFx_InvalidSpeculationOption	An invalid speculation option argument is provided.

status_t FTFx_CACHE_PflashGetPrefetchSpeculation

(

ftfx_prefetch_speculation_status_t *

speculationStatus

)

Parameters

speculationStatus

Speculation status returned by the PFlash IP.

Return values

kStatus_FTFx_Success

API was executed successfully.