Classes | Macros | Typedefs | Enumerations | Functions
app_qspi.h File Reference

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

`#include "app_drv_config.h"`
`#include "gr55xx_hal.h"`
`#include "app_io.h"`
`#include "app_dma.h"`
`#include "app_drv_error.h"`
`#include "stdbool.h"`
Include dependency graph for app_qspi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
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_evt_t
| QSPI event 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
| APP_QSPI_PIN Qspi pin defines. More...
#define | APP_QSPI_PIN_DISABLE 0
| QSPI pin disable. More...
#define | QSPI_SMART_CS_ENABLE 1
| QSPI_SMART_CS_ENABLE smart cs enable defines. More...
#define | QSPI_SMART_CS_LOW(id)
| QSPI_SMART_CS_LOW Pull down QSPI CS. More...
#define | QSPI_SMART_CS_HIGH(id)
| QSPI_SMART_CS_HIGH Pull up QSPI CS. More...

## Typedefs
typedef qspi_command_t | app_qspi_command_t
| QSPI command structure definition. 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_MAX, APP_STORAGE_RAM_ID = 0xf }
| 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 Event Type. 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...
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_sync (app_qspi_id_t id, uint8_t *p_data, uint32_t length, uint32_t timeout)
| Transmit an amount of data in blocking mode with standard SPI. 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_transmit_async (app_qspi_id_t id, uint8_t *p_data, uint32_t length)
| Transmit an amount of data in non-blocking mode at standard SPI with Interrupt. 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_sync (app_qspi_id_t id, uint8_t *p_data, uint32_t length, uint32_t timeout)
| Receive an amount of data in blocking mode with standard SPI. 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...
uint16_t | app_qspi_receive_async (app_qspi_id_t id, uint8_t *p_data, uint32_t length)
| Receive an amount of data in non-blocking mode at standard SPI with Interrupt. More...
uint16_t | app_qspi_transmit_in_qpi_async (app_qspi_id_t id, uint32_t data_width, uint8_t *p_data, uint32_t length)
| Transmit an amount of data in QPI mode (Async Mode). More...
qspi_handle_t * | app_qspi_get_handle (app_qspi_id_t id)
| Return the QSPI handle. 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.