usbuartiso.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 USBUARTISO_H
#define USBUARTISO_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 USBUARTISO_TX_DRV_BUFFER_SIZE    100
#define USBUARTISO_RX_DRV_BUFFER_SIZE    300
 
 // usbuartiso_cmd
 
#define USBUARTISO_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.slp = MIKROBUS( mikrobus, MIKROBUS_AN );     \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS );     \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // usbuartiso_map
 // usbuartiso
 
typedef struct
{
    // Output pins
    digital_out_t cts;    
    digital_out_t pwr;    
    // Input pins
    digital_in_t slp;     
    digital_in_t rts;     
    // Modules
    uart_t uart;          
    // Buffers
    uint8_t uart_rx_buffer[ USBUARTISO_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ USBUARTISO_TX_DRV_BUFFER_SIZE ];  
} usbuartiso_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;    
    pin_name_t tx_pin;    
    // Additional gpio pins
    pin_name_t slp;    
    pin_name_t cts;    
    pin_name_t pwr;    
    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;         
} usbuartiso_cfg_t;
 
typedef enum
{
    USBUARTISO_OK = 0,
    USBUARTISO_ERROR = -1
 
} usbuartiso_return_value_t;
 
void usbuartiso_cfg_setup ( usbuartiso_cfg_t *cfg );
 
err_t usbuartiso_init ( usbuartiso_t *ctx, usbuartiso_cfg_t *cfg );
 
void usbuartiso_default_cfg ( usbuartiso_t *ctx );
 
err_t usbuartiso_generic_write ( usbuartiso_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t usbuartiso_generic_read ( usbuartiso_t *ctx, uint8_t *data_out, uint16_t len );
 
void usbuartiso_power_on ( usbuartiso_t *ctx );
 
void usbuartiso_power_off ( usbuartiso_t *ctx );
 
uint8_t usbuartiso_get_slp_ind ( usbuartiso_t *ctx );
 
uint8_t usbuartiso_request_to_send ( usbuartiso_t *ctx );
 
void usbuartiso_clear_to_send ( usbuartiso_t *ctx, uint8_t cts );
 
#ifdef __cplusplus
}
#endif
#endif // USBUARTISO_H
 
 // usbuartiso
 
// ------------------------------------------------------------------------ END