MCUSW
FLS Configuration

Introduction

This files defines FLS MCAL configuration structures

Data Structures

struct  Fls_SectorType
 FLS Module Flashable Sectors and pages. More...
 
struct  Fls_ConfigType
 FLS Module Configuration Structure. More...
 
struct  FlashConfig
 
struct  FlsNorDeviceConfig
 

Variables

const FlsNorDeviceConfig FlsNorDevice
 
const struct Fls_ConfigType_s FlsConfigSet
 FLS Configuration struct declaration. More...
 

Enumerations

enum  OSPI_xferLines { OSPI_XFER_LINES_SINGLE = 0U, OSPI_XFER_LINES_DUAL, OSPI_XFER_LINES_QUAD, OSPI_XFER_LINES_OCTAL }
 Number of lines used for OSPI read/write transaction. More...
 
enum  FLASH_Protocol { FLS_OSPI = 0U, FLS_XSPI = 1U, FLS_QSPI = 2U }
 

Macros

#define FLS_PRE_COMPILE_VARIANT   (STD_ON)
 FLS Build Variant. Build variants.(i.e Pre Compile,Post Build or Link time) More...
 
#define FLS_INIT_CONFIG_PC   FlsConfigSet
 Pre Compile config macro name. More...
 
#define FLS_NOR
 FLS_MEMORY_TYPE. More...
 
#define FLS_BASE_ADDRESS   (1342177280U)
 Flash Memory start address, defines lower boundary for read/writ/erase/compare jobs. More...
 
#define FLS_BLANK_CHECK_API   (STD_ON)
 Enable/disable FLS Blank Check API. More...
 
#define FLS_COMPARE_API   (STD_ON)
 Enable/disable FLS compare API. More...
 
#define FLS_CANCEL_API   (STD_ON)
 Enable/disable FLS cancel API. More...
 
#define FLS_TIMEOUT_SUPERVISION_ENABLED   (STD_ON)
 Enable/disable FlsTimeoutSupervisionEnabled. More...
 
#define FLS_DEV_ERROR_DETECT   (STD_ON)
 Enable/disable FLS dev detect error. More...
 
#define FLS_DRIVER_INDEX   (0U)
 Index of driver, used by FEE. More...
 
#define FLS_GET_JOB_RESULT_API   (STD_ON)
 Enable/disable FLS Fls_GetJobResult function API. More...
 
#define FLS_GET_STATUS_API   (STD_ON)
 Enable/disable FLS Fls_GetStatus function API. More...
 
#define FLS_TOTAL_SIZE   (1073741824U)
 Total amount of flash memory in bytes. More...
 
#define FLS_USE_INTERRUPTS   (STD_OFF)
 Job processing triggered by hardware interrupt. More...
 
#define FLS_ISR_TYPE   (FLS_ISR_CAT1)
 ISR type. More...
 
#define FLS_TIMEOUT_DURATION   (50000U)
 Counter ID for counter used to count wait ticks. More...
 
#define FLS_VERSION_INFO_API   (STD_ON)
 Enable/disable FLS get version info API. More...
 
#define FLS_OS_COUNTER_ID   ((CounterType)OsCounter_0)
 Counter ID for counter used to count wait ticks. More...
 
#define FLS_OSPI_CTRL_BASE_ADDR   (1191444480U)
 Base Address of OSPI. More...
 
#define OSPI_REGISTER_READBACK_API   (STD_ON)
 Enable/disable OSPI register read back API. More...
 
#define OSPI_SAFETY_API   (STD_ON)
 Enable/disable OSPI safety API. More...
 
#define FLS_MAX_ERASE_TIME   (1000.0)
 Max Erase time in millisec. More...
 
#define FLS_MAX_WRITE_TIME   (1000.0)
 Max Write time in millisec. More...
 
#define FLS_NUMBER_OF_SECTOR_CFG   (2U)
 Number of Sectorlist configured. More...
 
#define NOR_NUMBER_FLASH   (3U)
 
#define FLS_ERASE_BUF_LEN   (262144U)
 
#define FLS_READ_WRITE_BUF_LEN   (768U)
 

FLS Driver ISR category level

Defines for FLS Driver ISR ISR category level

#define FLS_ISR_VOID   (0x00U)
 void ISR type More...
 
#define FLS_ISR_CAT1   (0x01U)
 Category 1 ISR type. More...
 
#define FLS_ISR_CAT2   (0x02U)
 Category 2 ISR type. More...
 

Macro Definition Documentation

◆ FLS_PRE_COMPILE_VARIANT

#define FLS_PRE_COMPILE_VARIANT   (STD_ON)

FLS Build Variant. Build variants.(i.e Pre Compile,Post Build or Link time)

◆ FLS_ISR_VOID

#define FLS_ISR_VOID   (0x00U)

void ISR type

◆ FLS_ISR_CAT1

#define FLS_ISR_CAT1   (0x01U)

Category 1 ISR type.

◆ FLS_ISR_CAT2

#define FLS_ISR_CAT2   (0x02U)

Category 2 ISR type.

◆ FLS_INIT_CONFIG_PC

#define FLS_INIT_CONFIG_PC   FlsConfigSet

Pre Compile config macro name.

◆ FLS_NOR

#define FLS_NOR

FLS_MEMORY_TYPE.

◆ FLS_BASE_ADDRESS

#define FLS_BASE_ADDRESS   (1342177280U)

Flash Memory start address, defines lower boundary for read/writ/erase/compare jobs.

◆ FLS_BLANK_CHECK_API

#define FLS_BLANK_CHECK_API   (STD_ON)

Enable/disable FLS Blank Check API.

◆ FLS_COMPARE_API

#define FLS_COMPARE_API   (STD_ON)

Enable/disable FLS compare API.

◆ FLS_CANCEL_API

#define FLS_CANCEL_API   (STD_ON)

Enable/disable FLS cancel API.

◆ FLS_TIMEOUT_SUPERVISION_ENABLED

#define FLS_TIMEOUT_SUPERVISION_ENABLED   (STD_ON)

Enable/disable FlsTimeoutSupervisionEnabled.

◆ FLS_DEV_ERROR_DETECT

#define FLS_DEV_ERROR_DETECT   (STD_ON)

Enable/disable FLS dev detect error.

◆ FLS_DRIVER_INDEX

#define FLS_DRIVER_INDEX   (0U)

Index of driver, used by FEE.

◆ FLS_GET_JOB_RESULT_API

#define FLS_GET_JOB_RESULT_API   (STD_ON)

Enable/disable FLS Fls_GetJobResult function API.

◆ FLS_GET_STATUS_API

#define FLS_GET_STATUS_API   (STD_ON)

Enable/disable FLS Fls_GetStatus function API.

◆ FLS_TOTAL_SIZE

#define FLS_TOTAL_SIZE   (1073741824U)

Total amount of flash memory in bytes.

◆ FLS_USE_INTERRUPTS

#define FLS_USE_INTERRUPTS   (STD_OFF)

Job processing triggered by hardware interrupt.

◆ FLS_ISR_TYPE

#define FLS_ISR_TYPE   (FLS_ISR_CAT1)

ISR type.

◆ FLS_TIMEOUT_DURATION

#define FLS_TIMEOUT_DURATION   (50000U)

Counter ID for counter used to count wait ticks.

◆ FLS_VERSION_INFO_API

#define FLS_VERSION_INFO_API   (STD_ON)

Enable/disable FLS get version info API.

◆ FLS_OS_COUNTER_ID

#define FLS_OS_COUNTER_ID   ((CounterType)OsCounter_0)

Counter ID for counter used to count wait ticks.

◆ FLS_OSPI_CTRL_BASE_ADDR

#define FLS_OSPI_CTRL_BASE_ADDR   (1191444480U)

Base Address of OSPI.

◆ OSPI_REGISTER_READBACK_API

#define OSPI_REGISTER_READBACK_API   (STD_ON)

Enable/disable OSPI register read back API.

◆ OSPI_SAFETY_API

#define OSPI_SAFETY_API   (STD_ON)

Enable/disable OSPI safety API.

◆ FLS_MAX_ERASE_TIME

#define FLS_MAX_ERASE_TIME   (1000.0)

Max Erase time in millisec.

◆ FLS_MAX_WRITE_TIME

#define FLS_MAX_WRITE_TIME   (1000.0)

Max Write time in millisec.

◆ FLS_NUMBER_OF_SECTOR_CFG

#define FLS_NUMBER_OF_SECTOR_CFG   (2U)

Number of Sectorlist configured.

◆ NOR_NUMBER_FLASH

#define NOR_NUMBER_FLASH   (3U)

◆ FLS_ERASE_BUF_LEN

#define FLS_ERASE_BUF_LEN   (262144U)

◆ FLS_READ_WRITE_BUF_LEN

#define FLS_READ_WRITE_BUF_LEN   (768U)

Enumeration Type Documentation

◆ OSPI_xferLines

Number of lines used for OSPI read/write transaction.

Enumerator
OSPI_XFER_LINES_SINGLE 

Single line is used

OSPI_XFER_LINES_DUAL 

Two lines are used

OSPI_XFER_LINES_QUAD 

Four lines are used

OSPI_XFER_LINES_OCTAL 

Four lines are used

◆ FLASH_Protocol

Enumerator
FLS_OSPI 

Ospi is used

FLS_XSPI 

Xspi used

FLS_QSPI 

QSPI used

Variable Documentation

◆ FlsNorDevice

const FlsNorDeviceConfig FlsNorDevice

◆ FlsConfigSet

const struct Fls_ConfigType_s FlsConfigSet

FLS Configuration struct declaration.