QSPI Private Macros

Collaboration diagram for QSPI Private Macros:

Macros
#define	IS_QSPI_CLOCK_PRESCALER(__PRESCALER__)   ((__PRESCALER__) <= 0xFFFF)
	Check if QSPI Clock Prescaler is valid. More...
#define	IS_QSPI_FIFO_THRESHOLD(__THR__)   (((__THR__) >= 0) && ((__THR__) <= (QSPI_MAX_FIFO_DEPTH - 1)))
	Check if QSPI FIFO Threshold is valid. More...
#define	IS_QSPI_CLOCK_MODE(__CLKMODE__)
	Check if QSPI Clock Mode is valid. More...
#define	IS_QSPI_RX_SAMPLE_DLY(__DLY__)   (((__DLY__) >= 0) && ((__DLY__) <= 7))
	Check if QSPI RX Sample Delay Value is valid. More...
#define	IS_QSPI_INSTRUCTION_SIZE(__INST_SIZE__)
	Check if QSPI Instruction Size is valid. More...
#define	IS_QSPI_ADDRESS_SIZE(__ADDR_SIZE__)
	Check if QSPI Address Size is valid. More...
#define	IS_QSPI_DUMMY_CYCLES(__DCY__)   ((__DCY__) <= 31)
	Check if QSPI Dummy Cycle is valid. More...
#define	IS_QSPI_INSTADDR_MODE(__MODE__)
	Check if QSPI Instruction and Address Mode is valid. More...
#define	IS_QSPI_DATA_MODE(__MODE__)
	Check if QSPI Data Mode is valid. More...
#define	IS_QSPI_SUPPORTED_DATA_SIZE(__SIZE__)
	Check if QSPI Data Size is supported currently. More...

Detailed Description

Macro Definition Documentation

IS_QSPI_ADDRESS_SIZE

#define IS_QSPI_ADDRESS_SIZE

(

__ADDR_SIZE__

)

Value:

                                                 (((__ADDR_SIZE__) == QSPI_ADDRSIZE_00_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_04_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_08_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_12_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_16_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_20_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_24_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_28_BITS) || \
                                                 ((__ADDR_SIZE__) == QSPI_ADDRSIZE_32_BITS))

Check if QSPI Address Size is valid.

Parameters

<strong>ADDR_SIZE</strong>

QSPI Address Size .

Return values

SET	(ADDR_SIZE is valid) or RESET (ADDR_SIZE is invalid)

Definition at line 893 of file gr55xx_hal_qspi.h.

IS_QSPI_CLOCK_MODE

#define IS_QSPI_CLOCK_MODE

(

__CLKMODE__

)

Value:

                                                 (((__CLKMODE__) == QSPI_CLOCK_MODE_0) || \
                                                 ((__CLKMODE__) == QSPI_CLOCK_MODE_1) || \
                                                 ((__CLKMODE__) == QSPI_CLOCK_MODE_2) || \
                                                 ((__CLKMODE__) == QSPI_CLOCK_MODE_3))

Check if QSPI Clock Mode is valid.

Parameters

<strong>CLKMODE</strong>

QSPI Clock Mode.

Return values

SET	(CLKMODE is valid) or RESET (CLKMODE is invalid)

Definition at line 868 of file gr55xx_hal_qspi.h.

IS_QSPI_CLOCK_PRESCALER

#define IS_QSPI_CLOCK_PRESCALER

(

__PRESCALER__

)

((__PRESCALER__) <= 0xFFFF)

Check if QSPI Clock Prescaler is valid.

Parameters

<strong>PRESCALER</strong>

QSPI Clock Prescaler.

Return values

SET	(PRESCALER is valid) or RESET (PRESCALER is invalid)

Definition at line 855 of file gr55xx_hal_qspi.h.

IS_QSPI_DATA_MODE

#define IS_QSPI_DATA_MODE

(

__MODE__

)

Value:

                                                 (((__MODE__) == QSPI_DATA_MODE_SPI)     || \
                                                 ((__MODE__) == QSPI_DATA_MODE_DUALSPI) || \
                                                 ((__MODE__) == QSPI_DATA_MODE_QUADSPI))

Check if QSPI Data Mode is valid.

Parameters

<strong>MODE</strong>

QSPI Data Mode.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)

Definition at line 921 of file gr55xx_hal_qspi.h.

IS_QSPI_DUMMY_CYCLES

#define IS_QSPI_DUMMY_CYCLES

(

__DCY__

)

((__DCY__) <= 31)

Check if QSPI Dummy Cycle is valid.

Parameters

<strong>DCY</strong>

QSPI Dummy Cycle.

Return values

SET	(DCY is valid) or RESET (DCY is invalid)

Definition at line 907 of file gr55xx_hal_qspi.h.

IS_QSPI_FIFO_THRESHOLD

#define IS_QSPI_FIFO_THRESHOLD

(

__THR__

)

(((__THR__) >= 0) && ((__THR__) <= (QSPI_MAX_FIFO_DEPTH - 1)))

Check if QSPI FIFO Threshold is valid.

Parameters

<strong>THR</strong>

QSPI FIFO Threshold.

Return values

SET	(THR is valid) or RESET (THR is invalid)

Definition at line 862 of file gr55xx_hal_qspi.h.

IS_QSPI_INSTADDR_MODE

#define IS_QSPI_INSTADDR_MODE

(

__MODE__

)

Value:

                                                 (((__MODE__) == QSPI_INST_ADDR_ALL_IN_SPI)       || \
                                                 ((__MODE__) == QSPI_INST_IN_SPI_ADDR_IN_SPIFRF) || \
                                                 ((__MODE__) == QSPI_INST_ADDR_ALL_IN_SPIFRF))

Check if QSPI Instruction and Address Mode is valid.

Parameters

<strong>MODE</strong>

QSPI Instruction and Address Mode.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)

Definition at line 913 of file gr55xx_hal_qspi.h.

IS_QSPI_INSTRUCTION_SIZE

#define IS_QSPI_INSTRUCTION_SIZE

(

__INST_SIZE__

)

Value:

                                                 (((__INST_SIZE__) == QSPI_INSTSIZE_00_BITS) || \
                                                 ((__INST_SIZE__) == QSPI_INSTSIZE_04_BITS) || \
                                                 ((__INST_SIZE__) == QSPI_INSTSIZE_08_BITS) || \
                                                 ((__INST_SIZE__) == QSPI_INSTSIZE_16_BITS))

Check if QSPI Instruction Size is valid.

Parameters

<strong>INST_SIZE</strong>

QSPI Instruction Size.

Return values

SET	(INST_SIZE is valid) or RESET (INST_SIZE is invalid)

Definition at line 884 of file gr55xx_hal_qspi.h.

IS_QSPI_RX_SAMPLE_DLY

#define IS_QSPI_RX_SAMPLE_DLY

(

__DLY__

)

(((__DLY__) >= 0) && ((__DLY__) <= 7))

Check if QSPI RX Sample Delay Value is valid.

Parameters

<strong>DLY</strong>

QSPI RX Sample Delay value

Return values

SET	(DLY is valid) or RESET (DLY is invalid)

Definition at line 877 of file gr55xx_hal_qspi.h.

IS_QSPI_SUPPORTED_DATA_SIZE

#define IS_QSPI_SUPPORTED_DATA_SIZE

(

__SIZE__

)

Value:

                                                 (((__SIZE__) == QSPI_DATASIZE_08_BITS) || \
                                                 ((__SIZE__) == QSPI_DATASIZE_16_BITS) || \
                                                 ((__SIZE__) == QSPI_DATASIZE_32_BITS))

Check if QSPI Data Size is supported currently.

Parameters

<strong>SIZE</strong>

QSPI Data Size.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)

Definition at line 930 of file gr55xx_hal_qspi.h.