app_dspi.h File Reference

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

#include "grx_hal.h"
#include "app_io.h"
#include "app_dma.h"
#include "app_drv_error.h"
#include "app_drv_config.h"

Go to the source code of this file.

Classes

struct  app_dspi_pin_t
 DSPI IO configuration Structures. More...
 
struct  app_dspi_pin_cfg_t
 DSPI Transmission IO configuration Structures. More...
 
struct  app_dspi_dma_cfg_t
 DSPI DMA configuration Structures. More...
 
struct  app_dspi_evt_t
 DSPI event structure definition. More...
 
struct  dspi_env_t
 
struct  app_dspi_params_t
 DSPI parameters structure definition. More...
 

Macros

#define APP_DSPI_PIN_ENABLE   1
 
#define APP_DSPI_PIN_DISABLE   0
 

Typedefs

typedef dspi_command_t app_dspi_command_t
 DSPI command structure definition. More...
 
typedef void(* app_dspi_evt_handler_t) (app_dspi_evt_t *p_evt)
 DSPI event callback definition. More...
 

Enumerations

enum  app_dspi_evt_type_t {
  APP_DSPI_EVT_ERROR,
  APP_DSPI_EVT_TX_CPLT,
  APP_DSPI_EVT_ABORT
}
 DSPI event Enumerations definition. More...
 
enum  app_dspi_state_t {
  APP_DSPI_INVALID = 0,
  APP_DSPI_ACTIVITY
}
 App dspi state types. More...
 
enum  app_dspi_dma_state_t {
  APP_DSPI_DMA_INVALID = 0,
  APP_DSPI_DMA_ACTIVITY
}
 App dspi dma state types. More...
 

Functions

uint16_t app_dspi_init (app_dspi_params_t *p_params, app_dspi_evt_handler_t evt_handler)
 Initialize the APP DSPI DRIVER according to the specified parameters in the app_dspi_params_t and app_dspi_evt_handler_t. More...
 
uint16_t app_dspi_deinit (void)
 De-initialize the APP DSPI DRIVER peripheral. More...
 
uint16_t app_dspi_command_transmit_sync (app_dspi_command_t *p_cmd, uint8_t *p_data, uint32_t timeout)
 Receive an amount of data with the specified instruction in blocking mode. More...
 
uint16_t app_dspi_command_transmit_async (app_dspi_command_t *p_cmd, uint8_t *p_data)
 Receive an amount of data with the specified instruction in non-blocking mode with Interrupt. More...
 
uint16_t app_dspi_command_sync (app_dspi_command_t *p_cmd, uint32_t timeout)
 Transmit only instruction in blocking mode. More...
 
uint16_t app_dspi_command_async (app_dspi_command_t *p_cmd)
 Transmit instruction in non-blocking mode with Interrupt. More...
 
uint16_t app_dspi_transmit_sync (uint8_t *p_data, uint32_t length, uint32_t timeout)
 Transmit an amount of data in blocking mode. More...
 
uint16_t app_dspi_transmit_async (uint8_t *p_data, uint32_t length)
 Transmit an amount of data in non-blocking mode with Interrupt. More...
 
dspi_handle_tapp_dspi_get_handle (void)
 Return the DSPI handle. More...
 
uint16_t app_dspi_config_mode (uint32_t mode)
 Set the DSPI transmission mode. More...
 
uint16_t app_dspi_config_data_size (uint32_t data_size)
 Set the DSPI transmission data size. More...
 
uint16_t app_dspi_abort (void)
 Abort the current transmission. More...
 
uint16_t app_dspi_abort_it (void)
 Abort the current transmission (non-blocking function) More...
 

Detailed Description

Header file containing functions prototypes of DSPI 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_dspi.h.