uwb3.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef UWB3_H
#define UWB3_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define UWB3_CMD_HELP               "help"
#define UWB3_CMD_STAT               "stat"
#define UWB3_CMD_DECA               "deca$"
#define UWB3_CMD_STOP               "stop"
#define UWB3_CMD_SAVE               "save"
#define UWB3_CMD_THREAD             "thread"
 
#define UWB3_CMD_LISTENER2          "listener2"
#define UWB3_CMD_TCFM               "tcfm"
#define UWB3_CMD_TCWM               "tcwm"
#define UWB3_CMD_RESPF              "respf"
#define UWB3_CMD_INITF              "initf"
 
#define UWB3_CMD_LSTAT              "lstat"
 
#define UWB3_CMD_PAVRG              "pavrg"
 
#define UWB3_CMD_ANTTXA             "anttxa"
#define UWB3_CMD_ANTRXA             "antrxa"
#define UWB3_CMD_XTALTRIM           "xtaltrim"
#define UWB3_CMD_PDOAOFF            "pdoaoff"
#define UWB3_CMD_UART               "uart"
 
#define UWB3_CMD_RESTORE            "restore"
#define UWB3_CMD_DIAG               "diag"
#define UWB3_CMD_UWBCFG             "uwbcfg"
#define UWB3_CMD_STSKEYIV           "stskeyiv"
#define UWB3_CMD_TXPOWER            "txpower"
#define UWB3_CMD_ANTENNA            "antenna"
#define UWB3_CMD_DECAID             "decaid"
#define UWB3_CMD_VERSION            "version"
 
#define UWB3_RSP_OK                 "ok"
#define UWB3_RSP_ERROR              "error"
 
#define UWB3_TX_DRV_BUFFER_SIZE     100
#define UWB3_RX_DRV_BUFFER_SIZE     1000
 
 // uwb3_cmd
 
#define UWB3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // uwb3_map
 // uwb3
 
typedef struct
{
    // Output pins
    digital_out_t rst;                          
    // Modules
    uart_t uart;                                
    // Buffers
    uint8_t uart_rx_buffer[ UWB3_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ UWB3_TX_DRV_BUFFER_SIZE ];  
} uwb3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t rst;                             
    // Static variable
    uint32_t         baud_rate;                 
    bool             uart_blocking;             
    uart_data_bits_t data_bit;                  
    uart_parity_t    parity_bit;                
    uart_stop_bits_t stop_bit;                  
} uwb3_cfg_t;
 
typedef enum
{
    UWB3_OK = 0,
    UWB3_ERROR = -1,
    UWB3_ERROR_TIMEOUT = -2
 
} uwb3_return_value_t;
 
void uwb3_cfg_setup ( uwb3_cfg_t *cfg );
 
err_t uwb3_init ( uwb3_t *ctx, uwb3_cfg_t *cfg );
 
err_t uwb3_generic_write ( uwb3_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t uwb3_generic_read ( uwb3_t *ctx, uint8_t *data_out, uint16_t len );
 
void uwb3_send_cmd ( uwb3_t *ctx, uint8_t *cmd );
 
void uwb3_send_cmd_with_parameter ( uwb3_t *ctx, uint8_t *cmd, uint8_t *param );
 
void uwb3_set_rst_pin ( uwb3_t *ctx, uint8_t state );
 
void uwb3_reset_device ( uwb3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // UWB3_H
 
 // uwb3
 
// ------------------------------------------------------------------------ END