Macros
QSPI Private Macros
Peripheral Driver » HAL Driver » QSPI » Defines

## 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

  __ADDR_SIZE__ | QSPI Address Size .

Return values

  SET | (__ADDR_SIZE__ is valid) or RESET (__ADDR_SIZE__ is invalid)

Definition at line 879 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

  __CLKMODE__ | QSPI Clock Mode.

Return values

  SET | (__CLKMODE__ is valid) or RESET (__CLKMODE__ is invalid)

Definition at line 854 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

  __PRESCALER__ | QSPI Clock Prescaler.

Return values

  SET | (__PRESCALER__ is valid) or RESET (__PRESCALER__ is invalid)

Definition at line 841 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

  __MODE__ | QSPI Data Mode.

Return values

  SET | (__MODE__ is valid) or RESET (__MODE__ is invalid)

Definition at line 907 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

  __DCY__ | QSPI Dummy Cycle.

Return values

  SET | (__DCY__ is valid) or RESET (__DCY__ is invalid)

Definition at line 893 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

  __THR__ | QSPI FIFO Threshold.

Return values

  SET | (__THR__ is valid) or RESET (__THR__ is invalid)

Definition at line 848 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

  __MODE__ | QSPI Instruction and Address Mode.

Return values

  SET | (__MODE__ is valid) or RESET (__MODE__ is invalid)

Definition at line 899 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

  __INST_SIZE__ | QSPI Instruction Size.

Return values

  SET | (__INST_SIZE__ is valid) or RESET (__INST_SIZE__ is invalid)

Definition at line 870 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

  __DLY__ | QSPI RX Sample Delay value

Return values

  SET | (__DLY__ is valid) or RESET (__DLY__ is invalid)

Definition at line 863 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

  __SIZE__ | QSPI Data Size.

Return values

  SET | (__MODE__ is valid) or RESET (__MODE__ is invalid)

Definition at line 916 of file gr55xx_hal_qspi.h.

QSPI_ADDRSIZE_04_BITS
#define QSPI_ADDRSIZE_04_BITS
Definition: gr55xx_hal_qspi.h:457
QSPI_CLOCK_MODE_2
#define QSPI_CLOCK_MODE_2
Definition: gr55xx_hal_qspi.h:426
QSPI_ADDRSIZE_00_BITS
#define QSPI_ADDRSIZE_00_BITS
Definition: gr55xx_hal_qspi.h:456
QSPI_ADDRSIZE_08_BITS
#define QSPI_ADDRSIZE_08_BITS
Definition: gr55xx_hal_qspi.h:458
QSPI_DATASIZE_08_BITS
#define QSPI_DATASIZE_08_BITS
Definition: gr55xx_hal_qspi.h:476
QSPI_ADDRSIZE_16_BITS
#define QSPI_ADDRSIZE_16_BITS
Definition: gr55xx_hal_qspi.h:460
QSPI_CLOCK_MODE_1
#define QSPI_CLOCK_MODE_1
Definition: gr55xx_hal_qspi.h:425
QSPI_INSTSIZE_08_BITS
#define QSPI_INSTSIZE_08_BITS
Definition: gr55xx_hal_qspi.h:447
QSPI_DATASIZE_32_BITS
#define QSPI_DATASIZE_32_BITS
Definition: gr55xx_hal_qspi.h:500
QSPI_INSTSIZE_00_BITS
#define QSPI_INSTSIZE_00_BITS
Definition: gr55xx_hal_qspi.h:445
QSPI_ADDRSIZE_28_BITS
#define QSPI_ADDRSIZE_28_BITS
Definition: gr55xx_hal_qspi.h:463
QSPI_INST_ADDR_ALL_IN_SPI
#define QSPI_INST_ADDR_ALL_IN_SPI
Definition: gr55xx_hal_qspi.h:510
QSPI_INST_ADDR_ALL_IN_SPIFRF
#define QSPI_INST_ADDR_ALL_IN_SPIFRF
Definition: gr55xx_hal_qspi.h:512
QSPI_ADDRSIZE_20_BITS
#define QSPI_ADDRSIZE_20_BITS
Definition: gr55xx_hal_qspi.h:461
QSPI_INSTSIZE_16_BITS
#define QSPI_INSTSIZE_16_BITS
Definition: gr55xx_hal_qspi.h:448
QSPI_CLOCK_MODE_3
#define QSPI_CLOCK_MODE_3
Definition: gr55xx_hal_qspi.h:427
QSPI_INSTSIZE_04_BITS
#define QSPI_INSTSIZE_04_BITS
Definition: gr55xx_hal_qspi.h:446
QSPI_DATA_MODE_SPI
#define QSPI_DATA_MODE_SPI
Definition: gr55xx_hal_qspi.h:435
QSPI_DATA_MODE_QUADSPI
#define QSPI_DATA_MODE_QUADSPI
Definition: gr55xx_hal_qspi.h:437
QSPI_ADDRSIZE_12_BITS
#define QSPI_ADDRSIZE_12_BITS
Definition: gr55xx_hal_qspi.h:459
QSPI_CLOCK_MODE_0
#define QSPI_CLOCK_MODE_0
Definition: gr55xx_hal_qspi.h:424
QSPI_DATA_MODE_DUALSPI
#define QSPI_DATA_MODE_DUALSPI
Definition: gr55xx_hal_qspi.h:436
QSPI_DATASIZE_16_BITS
#define QSPI_DATASIZE_16_BITS
Definition: gr55xx_hal_qspi.h:484
QSPI_ADDRSIZE_32_BITS
#define QSPI_ADDRSIZE_32_BITS
Definition: gr55xx_hal_qspi.h:464
QSPI_INST_IN_SPI_ADDR_IN_SPIFRF
#define QSPI_INST_IN_SPI_ADDR_IN_SPIFRF
Definition: gr55xx_hal_qspi.h:511
QSPI_ADDRSIZE_24_BITS
#define QSPI_ADDRSIZE_24_BITS
Definition: gr55xx_hal_qspi.h:462