Enumerations

enum  app_qspi_id_t {
  APP_QSPI_ID_0,
  APP_QSPI_ID_1,
  APP_QSPI_ID_2,
  APP_QSPI_ID_MAX
}
 QSPI module Enumerations definition. More...
 
enum  app_qspi_evt_type_t {
  APP_QSPI_EVT_ERROR,
  APP_QSPI_EVT_TX_CPLT,
  APP_QSPI_EVT_RX_DATA,
  APP_QSPI_EVT_ABORT,
  APP_QSPI_EVT_ASYNC_WR_SCRN_CPLT,
  APP_QSPI_EVT_ASYNC_WR_SCRN_FAIL
}
 APP QSPI Event Type. More...
 
enum  app_qspi_mmap_endian_mode_e {
  APP_QSPI_MMAP_ENDIAN_MODE_0 = 0,
  APP_QSPI_MMAP_ENDIAN_MODE_1,
  APP_QSPI_MMAP_ENDIAN_MODE_2
}
 QSPI Memory-Mapped Endian Mode. More...
 
enum  app_qspi_device_e {
  APP_QSPI_DEVICE_UNSET = 0,
  APP_QSPI_DEVICE_FLASH = 1,
  APP_QSPI_DEVICE_PSRAM = 2
}
 QSPI Device supporting Memory-Mapped Mode. More...
 
enum  app_qspi_psram_mmap_rd_cmd_e {
  PSRAM_MMAP_CMD_QREAD_0BH = 0x00,
  PSRAM_MMAP_CMD_QREAD_EBH = 0x01,
  PSRAM_MMAP_CMD_READ_MAX
}
 Define PSRAM's Read Command for Memory-Mapped Mode. More...
 
enum  app_qspi_psram_mmap_wr_cmd_e {
  PSRAM_MMAP_CMD_QWRITE_02H = 0x00,
  PSRAM_MMAP_CMD_QWRITE_38H = 0x01,
  PSRAM_MMAP_CMD_WRITE_MAX
}
 Define PSRAM's Write Command for Memory-Mapped Mode. More...
 
enum  app_qspi_flash_mmap_rd_cmd_e {
  FLASH_MMAP_CMD_DREAD_3BH = 0x00,
  FLASH_MMAP_CMD_2READ_BBH = 0x01,
  FLASH_MMAP_CMD_2READ_BBH_SIOO = 0x02,
  FLASH_MMAP_CMD_QREAD_6BH = 0x03,
  FLASH_MMAP_CMD_4READ_EBH = 0x04,
  FLASH_MMAP_CMD_4READ_EBH_SIOO = 0x05,
  FLASH_MMAP_CMD_READ_MAX
}
 Define Flash's Read Command for Memory-Mapped Mode. More...
 
enum  app_qspi_draw_screen_interface_type_e {
  DRAW_TYPE_IF_NONE = 0x00,
  DRAW_TYPE_IF_DUAL_SCREEN,
  DRAW_TYPE_IF_VERI_LINKED_SCREEN
}
 APP QSPI interface type when drawing screen. More...
 
enum  qspi_pins_group_e {
  QSPI0_PIN_GROUP_0 = 0x00,
  QSPI1_PIN_GROUP_0 = 0x01,
  QSPI2_PIN_GROUP_0 = 0x02,
  QSPIx_PIN_GROUP_MAX
}
 Define Pin Groups for QSPI. More...
 
enum  blit_xfer_type_e {
  BLIT_BY_DMA_SG = 0,
  BLIT_BY_DMA_LLP = 1
}
 Define BLIT Mode By DMA. More...
 
enum  app_qspi_state_t {
  APP_QSPI_INVALID = 0,
  APP_QSPI_ACTIVITY
}
 App qspi state types. More...
 
enum  app_qspi_dma_state_t {
  APP_QSPI_DMA_INVALID = 0,
  APP_QSPI_DMA_ACTIVITY
}
 App qspi dma_state types. More...
 

Detailed Description

Enumeration Type Documentation

◆ app_qspi_device_e

QSPI Device supporting Memory-Mapped Mode.

Enumerator
APP_QSPI_DEVICE_UNSET 

UnSet Device

APP_QSPI_DEVICE_FLASH 

Flash Device

APP_QSPI_DEVICE_PSRAM 

PSRAM Device

Definition at line 147 of file app_qspi.h.

◆ app_qspi_dma_state_t

App qspi dma_state types.

Enumerator
APP_QSPI_DMA_INVALID 
APP_QSPI_DMA_ACTIVITY 

Definition at line 483 of file app_qspi.h.

◆ app_qspi_draw_screen_interface_type_e

APP QSPI interface type when drawing screen.

Enumerator
DRAW_TYPE_IF_NONE 
DRAW_TYPE_IF_DUAL_SCREEN 
DRAW_TYPE_IF_VERI_LINKED_SCREEN 

Definition at line 188 of file app_qspi.h.

◆ app_qspi_evt_type_t

APP QSPI Event Type.

Enumerator
APP_QSPI_EVT_ERROR 

Error reported by QSPI peripheral.

APP_QSPI_EVT_TX_CPLT 

Requested TX transfer completed.

APP_QSPI_EVT_RX_DATA 

Requested RX transfer completed.

APP_QSPI_EVT_ABORT 

Abort reported by QSPI peripheral.

APP_QSPI_EVT_ASYNC_WR_SCRN_CPLT 

ASYNC-Write Quad Screen Complete

APP_QSPI_EVT_ASYNC_WR_SCRN_FAIL 

ASYNC-Write Quad Screen Fail

Definition at line 122 of file app_qspi.h.

◆ app_qspi_flash_mmap_rd_cmd_e

Define Flash's Read Command for Memory-Mapped Mode.

Enumerator
FLASH_MMAP_CMD_DREAD_3BH 

3BH in Dual

FLASH_MMAP_CMD_2READ_BBH 

BBH in 2Read

FLASH_MMAP_CMD_2READ_BBH_SIOO 

BBH in 2Read with SIOO mode

FLASH_MMAP_CMD_QREAD_6BH 

6BH in QRead

FLASH_MMAP_CMD_4READ_EBH 

EBH in 4Read

FLASH_MMAP_CMD_4READ_EBH_SIOO 

EBH in 4Read with SIOO mode

FLASH_MMAP_CMD_READ_MAX 

Definition at line 174 of file app_qspi.h.

◆ app_qspi_id_t

QSPI module Enumerations definition.

Enumerator
APP_QSPI_ID_0 

QSPI module 0

APP_QSPI_ID_1 

QSPI module 1

APP_QSPI_ID_2 

QSPI module 2

APP_QSPI_ID_MAX 

Only for check parameter, not used as input parameters.

Definition at line 109 of file app_qspi.h.

◆ app_qspi_mmap_endian_mode_e

QSPI Memory-Mapped Endian Mode.

Enumerator
APP_QSPI_MMAP_ENDIAN_MODE_0 

MMAP Endian Mode 0

APP_QSPI_MMAP_ENDIAN_MODE_1 

MMAP Endian Mode 1

APP_QSPI_MMAP_ENDIAN_MODE_2 

MMAP Endian Mode 2

Definition at line 138 of file app_qspi.h.

◆ app_qspi_psram_mmap_rd_cmd_e

Define PSRAM's Read Command for Memory-Mapped Mode.

Enumerator
PSRAM_MMAP_CMD_QREAD_0BH 

0BH in Quad

PSRAM_MMAP_CMD_QREAD_EBH 

EBH in Quad

PSRAM_MMAP_CMD_READ_MAX 

Definition at line 156 of file app_qspi.h.

◆ app_qspi_psram_mmap_wr_cmd_e

Define PSRAM's Write Command for Memory-Mapped Mode.

Enumerator
PSRAM_MMAP_CMD_QWRITE_02H 

02H in Quad

PSRAM_MMAP_CMD_QWRITE_38H 

38H in Quad

PSRAM_MMAP_CMD_WRITE_MAX 

Definition at line 165 of file app_qspi.h.

◆ app_qspi_state_t

App qspi state types.

Enumerator
APP_QSPI_INVALID 
APP_QSPI_ACTIVITY 

Definition at line 473 of file app_qspi.h.

◆ blit_xfer_type_e

Define BLIT Mode By DMA.

Enumerator
BLIT_BY_DMA_SG 

need enable BLIT_IMAGE_FEATURE_SUPPORT

BLIT_BY_DMA_LLP 

need enable PSRAM_LLP_FEATUTE_SUPPORT

Definition at line 228 of file app_qspi.h.

◆ qspi_pins_group_e

Define Pin Groups for QSPI.

Enumerator
QSPI0_PIN_GROUP_0 

QSPI0 Pinmux Group

QSPI1_PIN_GROUP_0 

QSPI1 Pinmux Group 0

QSPI2_PIN_GROUP_0 

QSPI2 Pinmux Group 0

QSPIx_PIN_GROUP_MAX 

Definition at line 197 of file app_qspi.h.