app_uart.h File Reference

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

#include "grx_hal.h"
#include "ring_buffer.h"
#include "app_io.h"
#include "app_dma.h"
#include "app_drv_config.h"
+ Include dependency graph for app_uart.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  app_uart_pin_t
 UART pins Structures. More...
 
struct  app_uart_pin_cfg_t
 UART pins config Structures. More...
 
struct  app_uart_dma_cfg_t
 UART DMA configuration structure definition. More...
 
struct  app_uart_evt_t
 UART event structure definition. More...
 
struct  uart_env_t
 UART device structure definition. More...
 
struct  app_uart_params_t
 UART parameters structure definition. More...
 
struct  app_uart_tx_buf_t
 UART buffer structure definition. More...
 

Macros

#define TX_ONCE_MAX_SIZE   128
 UART max bytes size transmitted at one time. More...
 

Typedefs

typedef void(* app_uart_evt_handler_t) (app_uart_evt_t *p_evt)
 UART event callback definition. More...
 

Enumerations

enum  app_uart_id_t { APP_UART_ID_0, APP_UART_ID_1, APP_UART_ID_MAX }
 UART module Enumerations definition. More...
 
enum  app_uart_evt_type_t {
  APP_UART_EVT_ERROR, APP_UART_EVT_TX_CPLT, APP_UART_EVT_RX_DATA, APP_UART_EVT_ABORT_TX,
  APP_UART_EVT_ABORT_RX, APP_UART_EVT_ABORT_TXRX
}
 UART event Enumerations definition. More...
 
enum  app_uart_state_t { APP_UART_INVALID = 0, APP_UART_ACTIVITY }
 App uart state types. More...
 
enum  app_uart_dma_state_t { APP_UART_DMA_INVALID = 0, APP_UART_DMA_ACTIVITY }
 App uart dma state types. More...
 

Functions

uint16_t app_uart_init (app_uart_params_t *p_params, app_uart_evt_handler_t evt_handler, app_uart_tx_buf_t *tx_buffer)
 Initialize the APP UART DRIVER according to the specified parameters in the app_uart_params_t and app_uart_evt_handler_t. More...
 
uint16_t app_uart_deinit (app_uart_id_t id)
 De-initialize the APP UART DRIVER peripheral. More...
 
uint16_t app_uart_transmit_async (app_uart_id_t id, uint8_t *p_data, uint16_t size)
 Send an amount of data in interrupt mode. More...
 
uint16_t app_uart_transmit_sync (app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
 Send an amount of data in blocking mode. More...
 
uint16_t app_uart_receive_async (app_uart_id_t id, uint8_t *p_data, uint16_t size)
 Receive an amount of data in interrupt mode. More...
 
uint16_t app_uart_receive_sync (app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
 Receive an amount of data in blocking mode. More...
 
uart_handle_tapp_uart_get_handle (app_uart_id_t id)
 Return the UART handle. More...
 
void app_uart_flush (app_uart_id_t id)
 Flush all log entries from the buffer. More...
 
uint16_t app_uart_abort (app_uart_id_t id)
 Abort transmit and receive process and generate abort callback. More...
 
uint16_t app_uart_abort_transmit (app_uart_id_t id)
 Abort transmit process and generate abort transmit callback. More...
 
uint16_t app_uart_abort_receive (app_uart_id_t id)
 Abort receive process and generate abort receive callback. More...
 

Detailed Description

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