app_qspi.h File Reference

Header file containing functions prototypes of QSPI app library. More...

#include "gr55xx_hal.h"
#include "app_io.h"
#include "app_dma.h"
#include "app_drv_error.h"
#include "app_drv_config.h"
#include "stdbool.h"
#include "app_qspi_user_config.h"

Go to the source code of this file.

Classes

struct  app_qspi_mmap_device_t
 QSPI memory-mapped configuration Structures. More...
 
struct  app_qspi_pin_t
 QSPI IO configuration Structures. More...
 
struct  app_qspi_pin_cfg_t
 QSPI configuration Structures. More...
 
struct  app_qspi_dma_cfg_t
 QSPI DMA configuration structure definition. More...
 
struct  app_qspi_screen_command_t
 
struct  app_qspi_evt_t
 QSPI event structure definition. More...
 
struct  app_qspi_screen_info_t
 Screen Info. structure definition. More...
 
struct  app_qspi_screen_scroll_t
 Scroll-Screen structure definition. More...
 
struct  _screen_veri_link_scroll_t
 Vertical Scroll-Screen Linked List Structure. More...
 
struct  app_qspi_screen_block_t
 One block of screen Structure. More...
 
struct  dual_screen_scroll_t
 Dual Screen (HOR/VER) Scroll Structure, just used for inner driver. More...
 
struct  veri_linked_screen_scroll_t
 Veritical Linked List Screen-Scroll Structure, just used for inner driver. More...
 
struct  app_qspi_async_draw_screen_info_t
 Async Draw Screen Structure, just used for inner driver. More...
 
struct  blit_image_config_t
 Blit Image structure definition. More...
 
struct  qspi_env_t
 QSPI device structure definition. More...
 
struct  app_qspi_params_t
 QSPI parameters structure definition. More...
 

Macros

#define APP_QSPI_PIN_ENABLE   1
 
#define APP_QSPI_PIN_DISABLE   0
 
#define QSPI_MAX_XFER_SIZE_ONCE   (0xFFFCu)
 
#define DMA_MAX_XFER_SIZE_ONCE   (4095u)
 
#define APP_STORAGE_RAM_ID   0xf
 

Typedefs

typedef qspi_command_t app_qspi_command_t
 QSPI command structure definition. More...
 
typedef struct _screen_veri_link_scroll_t app_qspi_screen_veri_link_scroll_t
 Vertical Scroll-Screen Linked List Structure. More...
 
typedef void(* app_qspi_evt_handler_t) (app_qspi_evt_t *p_evt)
 QSPI event callback definition. More...
 

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

Functions

uint16_t app_qspi_init (app_qspi_params_t *p_params, app_qspi_evt_handler_t evt_handler)
 Initialize the APP QSPI DRIVER according to the specified parameters in the app_qspi_params_t and app_qspi_evt_handler_t. More...
 
uint16_t app_qspi_deinit (app_qspi_id_t id)
 De-initialize the APP QSPI DRIVER peripheral. More...
 
uint16_t app_qspi_abort (app_qspi_id_t id)
 Abort qspi communication with Interrupt. More...
 
bool app_qspi_config_memory_mappped (app_qspi_id_t id, app_qspi_mmap_device_t dev)
 Config the memory mapped mode (also called XIP mode) and Active the mode. More...
 
bool app_qspi_active_memory_mappped (app_qspi_id_t id, bool is_active)
 Active or Deactive memory mapped mode (also called XIP mode) More...
 
uint16_t app_qspi_command_receive_sync (app_qspi_id_t id, app_qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout)
 Receive an amount of data with the specified instruction, address and dummy cycles in blocking mode. More...
 
uint16_t app_qspi_command_receive_async (app_qspi_id_t id, app_qspi_command_t *p_cmd, uint8_t *p_data)
 Receive an amount of data with the specified instruction, address and dummy cycles in non-blocking mode with Interrupt. More...
 
uint16_t app_qspi_command_transmit_sync (app_qspi_id_t id, app_qspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout)
 Receive an amount of data with the specified instruction, address and dummy cycles in blocking mode. More...
 
uint16_t app_qspi_command_transmit_async (app_qspi_id_t id, app_qspi_command_t *p_cmd, uint8_t *p_data)
 Receive an amount of data with the specified instruction, address and dummy cycles in non-blocking mode with Interrupt. More...
 
uint16_t app_qspi_command_sync (app_qspi_id_t id, app_qspi_command_t *p_cmd, uint32_t timeout)
 Transmit only instruction in blocking mode. More...
 
uint16_t app_qspi_command_async (app_qspi_id_t id, app_qspi_command_t *p_cmd)
 Transmit instruction in non-blocking mode with Interrupt. More...
 
uint16_t app_qspi_transmit_sync_ex (app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length, uint32_t timeout)
 Transmit data without command, support std/dual/quad mode. More...
 
uint16_t app_qspi_transmit_async_ex (app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length)
 Transmit data without command, support std/dual/quad mode. More...
 
uint16_t app_qspi_receive_sync_ex (app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length, uint32_t timeout)
 Receive data without command, support std/dual/quad mode. More...
 
uint16_t app_qspi_receive_async_ex (app_qspi_id_t id, uint32_t qspi_mode, uint32_t data_width, uint8_t *p_data, uint32_t length)
 Receive data without command, support std/dual/quad mode. More...
 
bool app_qspi_mmap_set_endian_mode (app_qspi_id_t id, app_qspi_mmap_endian_mode_e mode)
 Set Data Endian Mode to Read in Memory mapped Mode(XIP Mode) More...
 
uint8_t app_qspi_mmap_read_u8 (app_qspi_id_t id, uint32_t address)
 Read U8 Data in Memory mapped Mode(XIP Mode), can be used in flash/psram device. More...
 
uint16_t app_qspi_mmap_read_u16 (app_qspi_id_t id, uint32_t address)
 Read U16 Data in Memory mapped Mode(XIP Mode), The Data is ordered by the order in flash/psram device. More...
 
uint32_t app_qspi_mmap_read_u32 (app_qspi_id_t id, uint32_t address)
 Read U32 Data in Memory mapped Mode(XIP Mode), The Data is ordered by the order in flash/psram device. More...
 
bool app_qspi_mmap_read_block (app_qspi_id_t id, uint32_t address, uint8_t *buffer, uint32_t length)
 Read data block in Memory mapped Mode(XIP Mode), The Data is ordered by the order in flash/psram device. More...
 
uint32_t app_qspi_get_xip_base_address (app_qspi_id_t id)
 Return the XIP Base Address of QSPI Instance. More...
 
qspi_handle_tapp_qspi_get_handle (app_qspi_id_t id)
 Return the QSPI handle. More...
 

Variables

const app_qspi_pin_cfg_t g_qspi_pin_groups [QSPIx_PIN_GROUP_MAX]
 The Referrence to pin groups define. More...
 

Detailed Description

Header file containing functions prototypes of QSPI app library.

Author
BLE Driver Team
Attention
#####Copyright (c) 2019 GOODIX All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file app_qspi.h.