Fmc Interface. More...

Collaboration diagram for Fmc Interface:

Modules
	Fmc erase command
	Fmc erase command definition.

	Fmc status reg w/r command
	Fmc status register write and read command definition.

	Fmc status reg operation command
	Fmc status register operation command definition.

	Fmc read command
	Fmc read command definition.

	Fmc burst read command
	Fmc burst read command definition.

	Fmc work type select
	Fmc work type select definition.

Data Structures
struct	_flash_ids
	Structure with flash id. More...

Macros
#define	CMD_TRIG (0x01)

#define	CMD_WRITE_ENABLE (0x06)

#define	QUAD_ENABLE_Pos (9)

#define	QUAD_ENABLE_Msk (0x1ul << QUAD_ENABLE_Pos)

#define	Write_Enable_Latch_Pos (1)

#define	Write_Enable_Latch_Msk (0x1ul << Write_Enable_Latch_Pos)

#define	Write_In_Process_Pos (0)

#define	Write_In_Process_Msk (0x1ul << Write_In_Process_Pos)

#define	Long_Time_Op_Pos (17)

#define	PAGE_SIZE (256)

#define	SECTOR_SIZE (4096)

Typedefs
typedef struct _flash_ids	FLASH_IDS_T
	Structure with flash id. More...

Functions
__STATIC_FORCEINLINE void	FMC_EnterDeepPowerDownMode (FLCTL_T *fmc)
	Enter flash deep power down mode. More...

__STATIC_FORCEINLINE void	FMC_ExitDeepPowerDownMode (FLCTL_T *fmc)
	Exit flash deep power down mode. More...

void	FMC_GetFlashUniqueId (FLCTL_T *fmc)
	This function is used to get flash unique id,. More...

void	FMC_GetFlashJedecId (FLCTL_T *fmc)
	This function is used to get flash jedec id,. More...

uint32_t	FMC_GetFlashCodeAreaSize (FLCTL_T *fmc)
	Get Size of Flash in Bytes. More...

int	FMC_EraseSector (FLCTL_T *fmc, unsigned long adr)
	Erase a 4KB Sector in Flash Memory. More...

int	FMC_EraseBlock32k (FLCTL_T *fmc, unsigned long addr)
	Erase a 32KB Block in Flash Memory. More...

int	FMC_EraseBlock64k (FLCTL_T *fmc, unsigned long addr)
	Erase a 64KB Block in Flash Memory. More...

int	FMC_EraseChip (FLCTL_T *fmc)
	Erase the whole flash memory. More...

int	FMC_EraseCodeArea (FLCTL_T *fmc, uint32_t addr, uint32_t len)
	Erase specific data in flash code area. More...

void	InitIcache (FLCTL_T *fmc, uint32_t mode)
	This function is used to init Icache,. More...

int32_t	FMC_GetCrc32Sum (FLCTL_T fmc, uint32_t addr, uint32_t count, uint32_t chksum)
	Calculate and read the CRC32 checksum of a specified flash area. More...

int	BlankCheck (FLCTL_T *fmc, unsigned long adr, unsigned long sz)
	Blank check checks if memory is blank. More...

unsigned long	Verify (FLCTL_T fmc, unsigned long adr, unsigned long sz, unsigned char buf)
	Verify in flash memory. More...

int	ProgramPage (FLCTL_T fmc, unsigned long adr, unsigned long sz, unsigned char buf)
	Program page in flash memory. More...

unsigned char	FMC_ReadStatusReg (FLCTL_T *fmc, unsigned char cmd)
	This function is used to read status, The Read Status Register can be read at any time. More...

unsigned char	FMC_WriteEnable (FLCTL_T *fmc)
	This function is used to enable write function,. More...

void	FMC_WriteStatusReg (FLCTL_T *fmc, unsigned char ops, unsigned int buf)
	This function is used to write status, The Read Status Register can be read at any time. More...

unsigned char	FMC_ReadByte (FLCTL_T *fmc, unsigned int Addr, unsigned char cmd)
	This function is used to read flash,. More...

void	FMC_WriteByte (FLCTL_T *fmc, unsigned int addr, unsigned char data)
	This function is used to write one byte to flash memory. More...

void	FMC_WriteHalfWord (FLCTL_T *fmc, unsigned int addr, unsigned short data)
	This function is used to write halfword to flash memory. More...

unsigned int	FMC_ReadWord (FLCTL_T *fmc, unsigned int Addr, unsigned char cmd)
	This function is used to read flash. More...

unsigned char *	FMC_ReadPage (FLCTL_T *fmc, unsigned int Addr, unsigned char cmd)
	This function is used to read a page size (256 bytes) of data from flash. More...

int	FMC_ReadStream (FLCTL_T fmc, unsigned int Addr, unsigned char cmd, unsigned char buf, unsigned int len)
	This function is used to read data stream from flash. More...

int	FMC_WriteStream (FLCTL_T fmc, unsigned int Addr, unsigned char buf, unsigned int len)
	This function is used to write data stream to flash. More...

int	FMC_ReadInfoArea (FLCTL_T fmc, unsigned int Addr, unsigned char cmd, unsigned char buf, unsigned int len)
	This function is used to read data from the flash 4KB INFO area. More...

int	FMC_WriteInfoArea (FLCTL_T fmc, unsigned int Addr, unsigned char buf, unsigned int len)
	This function is used to write data to the flash 4KB INFO area. More...

int	FMC_EraseInfoArea (FLCTL_T *fmc)
	This function is used to erase the flash 4KB INFO area. More...

void	FMC_SetFlashMode (FLCTL_T *fmc, uint32_t mode, bool enhance)
	This function is used to set flash work mode. More...

void	FMC_ExitEnhanceMode (FLCTL_T *fmc)
	This function is used to exit flash enhanced read mode. More...

void	FMC_EnterEnhanceMode (FLCTL_T *fmc, uint32_t mode)
	This function is used to enter flash enhanced read mode. More...

void	FMC_EnableAutoDp (FLCTL_T *fmc)
	This function is used to enable auto enter deep power down function. More...

void	FMC_DisableAutoDp (FLCTL_T *fmc)
	This function is used to disable auto enter deep power down function. More...

void	FMC_SetRdpWaitCount (FLCTL_T *fmc, uint32_t cnt)
	This function is used to set wait count for release from Deep Power-down mode. More...

Detailed Description

Fmc Interface.

Macro Definition Documentation

◆ CMD_TRIG

#define CMD_TRIG (0x01)

Command to triger start operate

◆ CMD_WRITE_ENABLE

#define CMD_WRITE_ENABLE (0x06)

Command to write enable operate

◆ Long_Time_Op_Pos

#define Long_Time_Op_Pos (17)

Flash mode reg long time operate bit position

◆ PAGE_SIZE

#define PAGE_SIZE (256)

Flash one page size

◆ QUAD_ENABLE_Msk

#define QUAD_ENABLE_Msk (0x1ul << QUAD_ENABLE_Pos)

Flash status reg quad enable value

◆ QUAD_ENABLE_Pos

#define QUAD_ENABLE_Pos (9)

Flash status reg quad enable bit position

◆ SECTOR_SIZE

#define SECTOR_SIZE (4096)

Flash one sector size

◆ Write_Enable_Latch_Msk

#define Write_Enable_Latch_Msk (0x1ul << Write_Enable_Latch_Pos)

Flash write enable value

◆ Write_Enable_Latch_Pos

#define Write_Enable_Latch_Pos (1)

Flash write enable bit position

◆ Write_In_Process_Msk

#define Write_In_Process_Msk (0x1ul << Write_In_Process_Pos)

Flash status reg WIP bit value,this bit indicates whether the memory is busy

◆ Write_In_Process_Pos

#define Write_In_Process_Pos (0)

Flash status reg WIP bit position

Typedef Documentation

◆ FLASH_IDS_T

typedef struct _flash_ids FLASH_IDS_T

Structure with flash id.

Parameters

manufacturer_id	Specifies the flash manufacturer id
memory_type_id	Specifies the flash memory type id
memory_density_id	Specifies the flash memory density id
uid	Specifies the flash unique id

Function Documentation

◆ BlankCheck()

int BlankCheck	(	FLCTL_T *	fmc,
		unsigned long	adr,
		unsigned long	sz
	)

Blank check checks if memory is blank.

Parameters

fmc	Where fmc is a flash peripheral.
adr	Block start address
sz	Block Size (in bytes)

Return values

0	Success
1	Fail

◆ FMC_DisableAutoDp()

void FMC_DisableAutoDp ( FLCTL_T * fmc )

This function is used to disable auto enter deep power down function.

Parameters

fmc	Where fmc is a flash peripheral.

Returns: None

◆ FMC_EnableAutoDp()

void FMC_EnableAutoDp ( FLCTL_T * fmc )

This function is used to enable auto enter deep power down function.

Parameters

fmc	Where fmc is a flash peripheral.

Returns: None

◆ FMC_EnterDeepPowerDownMode()

__STATIC_FORCEINLINE void FMC_EnterDeepPowerDownMode ( FLCTL_T * fmc )

Enter flash deep power down mode.

Parameters

fmc	Where fmc is the base address of fmc peripheral

Returns: None

Note: This function should be put in RAM in case of use Make sure Flash is out of enhance mode before use this API

◆ FMC_EnterEnhanceMode()

void FMC_EnterEnhanceMode	(	FLCTL_T *	fmc,
		uint32_t	mode
	)

This function is used to enter flash enhanced read mode.

Parameters

fmc	Where fmc is a flash peripheral.
mode	Where mode is line mode select. Fmc work type select

Note: Some Flash does not support 2-line enhance mode

Returns: None

◆ FMC_EraseBlock32k()

int FMC_EraseBlock32k	(	FLCTL_T *	fmc,
		unsigned long	addr
	)

Erase a 32KB Block in Flash Memory.

This function is used to erase a 32KB flash block in flash code area.

Note: The 1st 28KB flash block is not allowed to be erased as the Info Area resides in this physical 32KB flash block.; The 32KB flash block start address is 0x7000, 0xF000, 0x17000, 0x1F000, 0x27000, 0x2F000, ...

Parameters

fmc	where fmc is a flash peripheral.
adr	where addr is a erase start address.

Return values

0	Success.
-1	Fail.

◆ FMC_EraseBlock64k()

int FMC_EraseBlock64k	(	FLCTL_T *	fmc,
		unsigned long	addr
	)

Erase a 64KB Block in Flash Memory.

This function is used to erase a 64KB flash block in flash code area.

Note: The 1st 60KB flash block is not allowed to be erased as the Info Area resides in this physical 64KB flash block.; The 64KB flash block start address is 0xF000, 0x1F000, 0x2F000, 0x3F000, 0x4F000, 0x5F000, ...

Parameters

fmc	where fmc is a flash peripheral.
adr	where addr is a erase start address.

Return values

0	Success.
-1	Fail.

◆ FMC_EraseChip()

int FMC_EraseChip ( FLCTL_T * fmc )

Erase the whole flash memory.

This function is used to erase all data in flash, include Code Area and Info Area.

Note: This API should only be used when you really know what you are doing.

Parameters

fmc	where fmc is a flash peripheral.

Return values

0	Success.
-1	Fail.

◆ FMC_EraseCodeArea()

int FMC_EraseCodeArea	(	FLCTL_T *	fmc,
		uint32_t	addr,
		uint32_t	len
	)

Erase specific data in flash code area.

This function is used to erase specific data in flash Code Area.

Note: This API is the most recommended function used to erase data in flash code area.

Parameters

fmc	where fmc is a flash peripheral.
addr	start address to erase, should be 4KB aligned.
len	length to erase in bytes.

Return values

0	Success.
-1	Fail.

◆ FMC_EraseInfoArea()

int FMC_EraseInfoArea ( FLCTL_T * fmc )

This function is used to erase the flash 4KB INFO area.

Parameters

fmc	where fmc is a flash peripheral

Return values

0	erase success
-1	erase fail

◆ FMC_EraseSector()

int FMC_EraseSector	(	FLCTL_T *	fmc,
		unsigned long	adr
	)

Erase a 4KB Sector in Flash Memory.

This function is used to erase a 4KB flash sector in flash code area.

Parameters

fmc	where fmc is a flash peripheral.
adr	where addr is a erase start address.

Return values

0	Success.
-1	Fail.

◆ FMC_ExitDeepPowerDownMode()

__STATIC_FORCEINLINE void FMC_ExitDeepPowerDownMode ( FLCTL_T * fmc )

Exit flash deep power down mode.

Parameters

fmc	Where fmc is the base address of fmc peripheral

Returns: None

Note: This function should be put in RAM in case of use Flash may need some time (0.1us ~ 30us for different flash vendor) before it reliably wakes up from deep power down mode.

◆ FMC_ExitEnhanceMode()

void FMC_ExitEnhanceMode ( FLCTL_T * fmc )

This function is used to exit flash enhanced read mode.

Parameters

fmc	Where fmc is a flash peripheral.

Returns: None

◆ FMC_GetCrc32Sum()

int32_t FMC_GetCrc32Sum	(	FLCTL_T *	fmc,
		uint32_t	addr,
		uint32_t	count,
		uint32_t *	chksum
	)

Calculate and read the CRC32 checksum of a specified flash area.

Parameters

[in]	fmc	Where fmc is a flash peripheral.
[in]	addr	Start address of the flash area to be executed CRC32 checksum calculation.
[in]	count	Number of bytes to be calculated.
[out]	chksum	If success, it will contain the result of CRC32 checksum calculation.

Return values

0	Success
-1	Invalid parameter.

◆ FMC_GetFlashCodeAreaSize()

uint32_t FMC_GetFlashCodeAreaSize ( FLCTL_T * fmc )

Get Size of Flash in Bytes.

Parameters

fmc	Flash memory controller base

Returns: Size in bytes

◆ FMC_GetFlashJedecId()

void FMC_GetFlashJedecId ( FLCTL_T * fmc )

This function is used to get flash jedec id,.

Parameters

fmc	where fmc is a flash peripheral.

Returns: Flash jedec id

◆ FMC_GetFlashUniqueId()

void FMC_GetFlashUniqueId ( FLCTL_T * fmc )

This function is used to get flash unique id,.

Parameters

fmc	where fmc is a flash peripheral.

Returns: Flash unique id

◆ FMC_ReadByte()

unsigned char FMC_ReadByte	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char	cmd
	)

This function is used to read flash,.

Parameters

fmc	where fmc is a flash peripheral.
Addr	where Addr is start address to read
cmd	where cmd can be CMD_FAST_READ or CMD_NORM_READ

Returns: 1byte data

◆ FMC_ReadInfoArea()

int FMC_ReadInfoArea	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char	cmd,
		unsigned char *	buf,
		unsigned int	len
	)

This function is used to read data from the flash 4KB INFO area.

Parameters

fmc	where fmc is a flash peripheral.
Addr	where Addr is start address to read, can be 0 ~ 4095
cmd	where cmd can be CMD_FAST_READ or CMD_NORM_READ
buf	where buf is a buffer to store read data
len	where len is data length of bytes to read

Return values

0	read success
-1	read fail

◆ FMC_ReadPage()

unsigned char * FMC_ReadPage	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char	cmd
	)

This function is used to read a page size (256 bytes) of data from flash.

Parameters

fmc	where fmc is a flash peripheral.
Addr	where Addr is start address to read
cmd	where cmd can be CMD_FAST_READ or CMD_NORM_READ

Returns: Internal Buffer address

◆ FMC_ReadStatusReg()

unsigned char FMC_ReadStatusReg	(	FLCTL_T *	fmc,
		unsigned char	cmd
	)

This function is used to read status, The Read Status Register can be read at any time.

Parameters

fmc	where fmc is a flash peripheral.
cmd	where cmd can be CMD_READ_STATUS_L(return register bit[7:0]) CMD_READ_STATUS_H(return register bit[15:8])

Returns: status value

◆ FMC_ReadStream()

int FMC_ReadStream	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char	cmd,
		unsigned char *	buf,
		unsigned int	len
	)

This function is used to read data stream from flash.

Parameters

fmc	where fmc is a flash peripheral.
Addr	where Addr is start address to read
cmd	where cmd can be CMD_FAST_READ or CMD_NORM_READ
buf	where buf is a buffer to store read data
len	where len is data length of bytes to read

Returns: None

◆ FMC_ReadWord()

unsigned int FMC_ReadWord	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char	cmd
	)

This function is used to read flash.

Parameters

fmc	where fmc is a flash peripheral.
Addr	where Addr is start address to read
cmd	where cmd can be CMD_FAST_READ or CMD_NOR_READ

Returns: 4byte data

◆ FMC_SetFlashMode()

void FMC_SetFlashMode	(	FLCTL_T *	fmc,
		uint32_t	mode,
		bool	enhance
	)

This function is used to set flash work mode.

Parameters

fmc	Where fmc is a flash peripheral.
mode	Where mode is line mode select. Fmc work type select
enhance	Whether enhanced mode is supported

Returns: None

◆ FMC_SetRdpWaitCount()

void FMC_SetRdpWaitCount	(	FLCTL_T *	fmc,
		uint32_t	cnt
	)

This function is used to set wait count for release from Deep Power-down mode.

Parameters

fmc	Where fmc is a flash peripheral.
cnt	Where cnt is a flash clk count value.

Returns: None

◆ FMC_WriteByte()

void FMC_WriteByte	(	FLCTL_T *	fmc,
		unsigned int	addr,
		unsigned char	data
	)

This function is used to write one byte to flash memory.

Parameters

fmc	Where fmc is a flash peripheral.
addr	Where Addr is start address to write
data	Where data is data need to program

Returns: None

◆ FMC_WriteEnable()

unsigned char FMC_WriteEnable ( FLCTL_T * fmc )

This function is used to enable write function,.

Parameters

fmc	where fmc is a flash peripheral.

Returns: Enable or not

◆ FMC_WriteHalfWord()

void FMC_WriteHalfWord	(	FLCTL_T *	fmc,
		unsigned int	addr,
		unsigned short	data
	)

This function is used to write halfword to flash memory.

Parameters

fmc	Where fmc is a flash peripheral.
addr	Where Addr is start address to write
data	Where data is data need to program

Returns: None

◆ FMC_WriteInfoArea()

int FMC_WriteInfoArea	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char *	buf,
		unsigned int	len
	)

This function is used to write data to the flash 4KB INFO area.

Parameters

fmc	where fmc is a flash peripheral
Addr	where Addr is start address to write, can be 0 ~ 4095
buf	where buf is a buffer to store data to write
len	where len is data length of bytes to write

Return values

0	write success
-1	write fail

◆ FMC_WriteStatusReg()

void FMC_WriteStatusReg	(	FLCTL_T *	fmc,
		unsigned char	ops,
		unsigned int	buf
	)

This function is used to write status, The Read Status Register can be read at any time.

Parameters

fmc	where fmc is a flash peripheral.
ops	where ops can be OPS_WR_STU_REG_ALL OPS_WR_STU_REG_NOR
buf	where buf is write value

Returns: none

◆ FMC_WriteStream()

int FMC_WriteStream	(	FLCTL_T *	fmc,
		unsigned int	Addr,
		unsigned char *	buf,
		unsigned int	len
	)

This function is used to write data stream to flash.

Parameters

fmc	where fmc is a flash peripheral
Addr	where Addr is start address to write, can be any valid address
buf	where buf is a buffer to store data to write
len	where len is data length of bytes to write

Returns: None

◆ InitIcache()

void InitIcache	(	FLCTL_T *	fmc,
		uint32_t	mode
	)

This function is used to init Icache,.

Parameters

fmc	Where fmc is a flash peripheral.
mode	Where mode can be FLASH_X1_MODE FLASH_X2_MODE FLASH_X4_MODE

Returns: None

◆ ProgramPage()

int ProgramPage	(	FLCTL_T *	fmc,
		unsigned long	adr,
		unsigned long	sz,
		unsigned char *	buf
	)

Program page in flash memory.

Parameters

fmc	Where fmc is a flash peripheral.
adr	Block start address
sz	Page size
buf	Page data

Return values

0	Success
1	Fail

◆ Verify()

unsigned long Verify	(	FLCTL_T *	fmc,
		unsigned long	adr,
		unsigned long	sz,
		unsigned char *	buf
	)

Verify in flash memory.

Parameters

fmc	Where fmc is a flash peripheral.
adr	Block start address
sz	Data lenth need to verify
buf	Programed data

Note: The buf address should be 4-bytes-alingned.

Returns: Final verify address

Modules

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ CMD_TRIG

◆ CMD_WRITE_ENABLE

◆ Long_Time_Op_Pos

◆ PAGE_SIZE

◆ QUAD_ENABLE_Msk

◆ QUAD_ENABLE_Pos

◆ SECTOR_SIZE

◆ Write_Enable_Latch_Msk

◆ Write_Enable_Latch_Pos

◆ Write_In_Process_Msk

◆ Write_In_Process_Pos

Typedef Documentation

◆ FLASH_IDS_T

Function Documentation

◆ BlankCheck()

◆ FMC_DisableAutoDp()

◆ FMC_EnableAutoDp()

◆ FMC_EnterDeepPowerDownMode()

◆ FMC_EnterEnhanceMode()

◆ FMC_EraseBlock32k()

◆ FMC_EraseBlock64k()

◆ FMC_EraseChip()

◆ FMC_EraseCodeArea()

◆ FMC_EraseInfoArea()

◆ FMC_EraseSector()

◆ FMC_ExitDeepPowerDownMode()

◆ FMC_ExitEnhanceMode()

◆ FMC_GetCrc32Sum()

◆ FMC_GetFlashCodeAreaSize()

◆ FMC_GetFlashJedecId()

◆ FMC_GetFlashUniqueId()

◆ FMC_ReadByte()

◆ FMC_ReadInfoArea()

◆ FMC_ReadPage()

◆ FMC_ReadStatusReg()

◆ FMC_ReadStream()

◆ FMC_ReadWord()

◆ FMC_SetFlashMode()

◆ FMC_SetRdpWaitCount()

◆ FMC_WriteByte()

◆ FMC_WriteEnable()

◆ FMC_WriteHalfWord()

◆ FMC_WriteInfoArea()

◆ FMC_WriteStatusReg()

◆ FMC_WriteStream()

◆ InitIcache()

◆ ProgramPage()

◆ Verify()