usbuart5.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 USBUART5_H
#define USBUART5_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 USBUART5_SUSPEND_MODE_DISABLE    0
#define USBUART5_SUSPEND_MODE_ENABLE     1
 
#define USBUART5_TX_DRV_BUFFER_SIZE    100
#define USBUART5_RX_DRV_BUFFER_SIZE    300
 
 // usbuart5_cmd
 
#define USBUART5_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.spd = MIKROBUS( mikrobus, MIKROBUS_AN );      \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );    \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS );     \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // usbuart5_map
 // usbuart5
 
typedef struct
{
    // Output pins
    digital_out_t rst;    
    digital_out_t cts;    
    // Input pins
    digital_in_t spd;     
    digital_in_t rts;     
    // Modules
    uart_t uart;          
    // Buffers
    char uart_rx_buffer[ USBUART5_RX_DRV_BUFFER_SIZE ];  
    char uart_tx_buffer[ USBUART5_TX_DRV_BUFFER_SIZE ];  
} usbuart5_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t spd;                             
    pin_name_t rst;                             
    pin_name_t cts;                             
    pin_name_t rts;                             
    // 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;                  
} usbuart5_cfg_t;
 
typedef enum
{
    USBUART5_OK = 0,
    USBUART5_ERROR = -1
 
} usbuart5_return_value_t;
 
typedef enum
{
    USBUART5_PIN_STATE_LOW = 0,
    USBUART5_PIN_STATE_HIGH = 1
 
} usbuart5_pin_state_t;
 
void usbuart5_cfg_setup ( usbuart5_cfg_t *cfg );
 
err_t usbuart5_init ( usbuart5_t *ctx, usbuart5_cfg_t *cfg );
 
void usbuart5_default_cfg ( usbuart5_t *ctx );
 
err_t usbuart5_generic_write ( usbuart5_t *ctx, char *data_in, uint16_t len );
 
err_t usbuart5_generic_read ( usbuart5_t *ctx, char *data_out, uint16_t len );
 
void usbuart5_enable_device ( usbuart5_t *ctx );
 
void usbuart5_reset_device ( usbuart5_t *ctx );
 
void usbuart5_set_cts_pin ( usbuart5_t *ctx, usbuart5_pin_state_t state );
 
uint8_t usbuart5_get_suspend_state ( usbuart5_t *ctx );
 
uint8_t usbuart5_get_rts_pin ( usbuart5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // USBUART5_H
 
 // usbuart5
 
// ------------------------------------------------------------------------ END