XIP LL driver functions

Functions
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_cmd (xqspi_regs_t *XQSPIx, uint32_t cmd)
	Set read command. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_cmd (xqspi_regs_t *XQSPIx)
	Get read command. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_enable_xip_hp (xqspi_regs_t *XQSPIx)
	Enable high performance mode. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_disable_xip_hp (xqspi_regs_t *XQSPIx)
	Disable high performance mode. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_is_enabled_xip_hp (xqspi_regs_t *XQSPIx)
	Check if high performance mode is enabled. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_ss (xqspi_regs_t *XQSPIx, uint32_t ss)
	Set slave select. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_ss (xqspi_regs_t *XQSPIx)
	Get slave select. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_cpha (xqspi_regs_t *XQSPIx, uint32_t cpha)
	Set clock phase. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_cpha (xqspi_regs_t *XQSPIx)
	Get clock phase. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_cpol (xqspi_regs_t *XQSPIx, uint32_t cpol)
	Set clock polarity. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_cpol (xqspi_regs_t *XQSPIx)
	Get clock polarity. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_addr_size (xqspi_regs_t *XQSPIx, uint32_t size)
	Set address bytes in command. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_addr_size (xqspi_regs_t *XQSPIx)
	Get address bytes in command. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_endian (xqspi_regs_t *XQSPIx, uint32_t endian)
	Set endian in reading data. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_endian (xqspi_regs_t *XQSPIx)
	Get endian in reading data. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_hp_cmd (xqspi_regs_t *XQSPIx, uint32_t cmd)
	Set high performance command. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_hp_cmd (xqspi_regs_t *XQSPIx)
	Get high performance command. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_dummycycles (xqspi_regs_t *XQSPIx, uint32_t cycles)
	Set dummy cycles in command. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_dummycycles (xqspi_regs_t *XQSPIx)
	Get dummy cycles in command. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_set_xip_dummy_hp (xqspi_regs_t *XQSPIx, uint32_t cycles)
	Set dummy cycles in high performance end. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_dummy_hp (xqspi_regs_t *XQSPIx)
	Get dummy cycles in high performance end. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_enable_xip (xqspi_regs_t *XQSPIx)
	Enable XIP mode. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_disable_xip (xqspi_regs_t *XQSPIx)
	Disable XIP mode. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_is_enabled_xip (xqspi_regs_t *XQSPIx)
	Check if XIP mode is enabled. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_xip_flag (xqspi_regs_t *XQSPIx)
	Get XIP status. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_is_enabled_xip_it (xqspi_regs_t *XQSPIx)
	Check if XIP interrupt is enabled. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_flag_xip_it (xqspi_regs_t *XQSPIx)
	Get XIP interrupt flag. More...
SECTION_RAM_CODE __STATIC_INLINE uint32_t	ll_xqspi_get_req_xip_it (xqspi_regs_t *XQSPIx)
	Get XIP interrupt request. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_enable_xip_it (xqspi_regs_t *XQSPIx)
	Set XIP interrupt enable. More...
SECTION_RAM_CODE __STATIC_INLINE void	ll_xqspi_disable_xip_it (xqspi_regs_t *XQSPIx)
	Set XIP interrupt disable. More...

Detailed Description

Function Documentation

ll_xqspi_disable_xip()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_disable_xip

(

xqspi_regs_t *

XQSPIx

)

Disable XIP mode.

Register	BitsName
CTRL3	EN_REQ

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_disable_xip_hp()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_disable_xip_hp

(

xqspi_regs_t *

XQSPIx

)

Disable high performance mode.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_HPEN

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_disable_xip_it()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_disable_xip_it

(

xqspi_regs_t *

XQSPIx

)

Set XIP interrupt disable.

Note

This bit is write-only.

Register	BitsName
INTCLR	INT_CLR

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_enable_xip()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_enable_xip

(

xqspi_regs_t *

XQSPIx

)

Enable XIP mode.

Register	BitsName
CTRL3	EN_REQ

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_enable_xip_hp()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_enable_xip_hp

(

xqspi_regs_t *

XQSPIx

)

Enable high performance mode.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_HPEN

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_enable_xip_it()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_enable_xip_it

(

xqspi_regs_t *

XQSPIx

)

Set XIP interrupt enable.

Note

This bit is write-only.

Register	BitsName
INTSET	INT_SET

Parameters

XQSPIx

XQSPI instance

Return values

None

ll_xqspi_get_flag_xip_it()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_flag_xip_it

(

xqspi_regs_t *

XQSPIx

)

Get XIP interrupt flag.

Note

This bit is read-only.

Register	BitsName
INTSTAT	INT_STAT

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 1

ll_xqspi_get_req_xip_it()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_req_xip_it

(

xqspi_regs_t *

XQSPIx

)

Get XIP interrupt request.

Note

This bit is read-only.

Register	BitsName
INTREQ	INT_REQ

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 1

ll_xqspi_get_xip_addr_size()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_addr_size

(

xqspi_regs_t *

XQSPIx

)

Get address bytes in command.

Register	BitsName
CTRL1	CFG_ADDR4

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_XIP_ADDR_3BYTES LL_XQSPI_XIP_ADDR_4BYTES

ll_xqspi_get_xip_cmd()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_cmd

(

xqspi_regs_t *

XQSPIx

)

Get read command.

Register	BitsName
CTRL0	CFG_CMD

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_XIP_CMD_READ LL_XQSPI_XIP_CMD_FAST_READ LL_XQSPI_XIP_CMD_DUAL_OUT_READ LL_XQSPI_XIP_CMD_DUAL_IO_READ LL_XQSPI_XIP_CMD_QUAD_OUT_READ LL_XQSPI_XIP_CMD_QUAD_IO_READ

ll_xqspi_get_xip_cpha()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_cpha

(

xqspi_regs_t *

XQSPIx

)

Get clock phase.

Register	BitsName
CTRL1	CFG_CPHA

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_SCPHA_1EDGE LL_XQSPI_SCPHA_2EDGE

ll_xqspi_get_xip_cpol()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_cpol

(

xqspi_regs_t *

XQSPIx

)

Get clock polarity.

Register	BitsName
CTRL1	CFG_CPOL

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_SCPOL_LOW LL_XQSPI_SCPOL_HIGH

ll_xqspi_get_xip_dummy_hp()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_dummy_hp

(

xqspi_regs_t *

XQSPIx

)

Get dummy cycles in high performance end.

Register	BitsName
CTRL2	CFG_ENDDUMMY

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 3.

ll_xqspi_get_xip_dummycycles()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_dummycycles

(

xqspi_regs_t *

XQSPIx

)

Get dummy cycles in command.

Note

- Fast Read Dual I/O: dummycycles = 4 * cycles + 4

• Fast Read Quad I/O: dummycycles = 2 * cycles + 2
• Fast Read Dual Out: dummycycles = 8 * cycles
• Fast Read Quad Out: dummycycles = 8 * cycles

Register	BitsName
CTRL2	CFG_DUMMYCYCLES

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 0xF.

ll_xqspi_get_xip_endian()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_endian

(

xqspi_regs_t *

XQSPIx

)

Get endian in reading data.

Register	BitsName
CTRL1	CFG_LE32

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_XIP_ENDIAN_BIG LL_XQSPI_XIP_ENDIAN_LITTLE

ll_xqspi_get_xip_flag()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_flag

(

xqspi_regs_t *

XQSPIx

)

Get XIP status.

Note

This bit is read-only.

Register	BitsName
STAT	EN_OUT

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 1

ll_xqspi_get_xip_hp_cmd()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_hp_cmd

(

xqspi_regs_t *

XQSPIx

)

Get high performance command.

Register	BitsName
CTRL2	CFG_HPMODE

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 0xFF.

ll_xqspi_get_xip_ss()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_get_xip_ss

(

xqspi_regs_t *

XQSPIx

)

Get slave select.

Register	BitsName
CTRL1	CFG_SS

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can be one of the following values: LL_XQSPI_XIP_SS0 LL_XQSPI_XIP_SS1 LL_XQSPI_XIP_SS2 LL_XQSPI_XIP_SS3

ll_xqspi_is_enabled_xip()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_is_enabled_xip

(

xqspi_regs_t *

XQSPIx

)

Check if XIP mode is enabled.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL3	EN_REQ

Parameters

XQSPIx

XQSPI instance

Return values

State

of bit (1 or 0).

ll_xqspi_is_enabled_xip_hp()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_is_enabled_xip_hp

(

xqspi_regs_t *

XQSPIx

)

Check if high performance mode is enabled.

Register	BitsName
CTRL1	CFG_HPEN

Parameters

XQSPIx

XQSPI instance

Return values

State

of bit (1 or 0).

ll_xqspi_is_enabled_xip_it()

SECTION_RAM_CODE __STATIC_INLINE uint32_t ll_xqspi_is_enabled_xip_it

(

xqspi_regs_t *

XQSPIx

)

Check if XIP interrupt is enabled.

Note

This bit is read-only.

Register	BitsName
INTEN	INT_EN

Parameters

XQSPIx

XQSPI instance

Return values

Returned

Value can between: 0 ~ 1

ll_xqspi_set_xip_addr_size()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_addr_size	(	xqspi_regs_t *	XQSPIx,
		uint32_t	size
	)

Set address bytes in command.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_ADDR4

Parameters

XQSPIx	XQSPI instance
size	This parameter can be one or more of the following values: LL_XQSPI_XIP_ADDR_3BYTES LL_XQSPI_XIP_ADDR_4BYTES

Return values

None

ll_xqspi_set_xip_cmd()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_cmd	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cmd
	)

Set read command.

Note

These bits should not be changed when XIP is ongoing.

Register	BitsName
CTRL0	CFG_CMD

Parameters

XQSPIx	XQSPI instance
cmd	This parameter can be one of the following values: LL_XQSPI_XIP_CMD_READ LL_XQSPI_XIP_CMD_FAST_READ LL_XQSPI_XIP_CMD_DUAL_OUT_READ LL_XQSPI_XIP_CMD_DUAL_IO_READ LL_XQSPI_XIP_CMD_QUAD_OUT_READ LL_XQSPI_XIP_CMD_QUAD_IO_READ

Return values

None

ll_xqspi_set_xip_cpha()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_cpha	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cpha
	)

Set clock phase.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_CPHA

Parameters

XQSPIx	XQSPI instance
cpha	This parameter can be one or more of the following values: LL_XQSPI_SCPHA_1EDGE LL_XQSPI_SCPHA_2EDGE

Return values

None

ll_xqspi_set_xip_cpol()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_cpol	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cpol
	)

Set clock polarity.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_CPOL

Parameters

XQSPIx	XQSPI instance
cpol	This parameter can be one or more of the following values: LL_XQSPI_SCPOL_LOW LL_XQSPI_SCPOL_HIGH

Return values

None

ll_xqspi_set_xip_dummy_hp()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_dummy_hp	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cycles
	)

Set dummy cycles in high performance end.

Note

These bits should not be changed when XIP is ongoing.

Register	BitsName
CTRL2	CFG_ENDDUMMY

Parameters

XQSPIx	XQSPI instance
cycles	This parameter can between: 0 ~ 3.

Return values

None

ll_xqspi_set_xip_dummycycles()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_dummycycles	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cycles
	)

Set dummy cycles in command.

Note

These bits should not be changed when XIP is ongoing.

• Fast Read Dual I/O: dummycycles = 4 * cycles + 4
• Fast Read Quad I/O: dummycycles = 2 * cycles + 2
• Fast Read Dual Out: dummycycles = 8 * cycles
• Fast Read Quad Out: dummycycles = 8 * cycles

Register	BitsName
CTRL2	CFG_DUMMYCYCLES

Parameters

XQSPIx	XQSPI instance
cycles	This parameter can between: 0 ~ 0xF.

Return values

None

ll_xqspi_set_xip_endian()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_endian	(	xqspi_regs_t *	XQSPIx,
		uint32_t	endian
	)

Set endian in reading data.

Note

This bit should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_LE32

Parameters

XQSPIx	XQSPI instance
endian	This parameter can be one or more of the following values: LL_XQSPI_XIP_ENDIAN_BIG LL_XQSPI_XIP_ENDIAN_LITTLE

Return values

None

ll_xqspi_set_xip_hp_cmd()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_hp_cmd	(	xqspi_regs_t *	XQSPIx,
		uint32_t	cmd
	)

Set high performance command.

Note

These bits should not be changed when XIP is ongoing.

Register	BitsName
CTRL2	CFG_HPMODE

Parameters

XQSPIx	XQSPI instance
cmd	This value is specified by different QSPI FLASH memory vendor to enter into its status register to activate HP mode in dual I/O and Quad I/O access. This parameter can between: 0 ~ 0xFF.

Return values

None

ll_xqspi_set_xip_ss()

SECTION_RAM_CODE __STATIC_INLINE void ll_xqspi_set_xip_ss	(	xqspi_regs_t *	XQSPIx,
		uint32_t	ss
	)

Set slave select.

Note

These bits should not be changed when XIP is ongoing.

Register	BitsName
CTRL1	CFG_SS

Parameters

XQSPIx	XQSPI instance
ss	This parameter can be one or more of the following values: LL_XQSPI_XIP_SS0 LL_XQSPI_XIP_SS1 LL_XQSPI_XIP_SS2 LL_XQSPI_XIP_SS3

Return values

None