usbuart.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 USBUART_H
#define USBUART_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 USBUART_MODE_SLEEP 1
#define USBUART_MODE_NORMAL 0
 
#define USBUART_CTS_ACTIVE  1
#define USBUART_CTS_NO_ACTIVE 0
 
#define USBUART_POWER_ON  1
#define USBUART_POWER_OFF 0
 
#define DRV_BUFFER_SIZE                       500
 
 // usbuart_set
 
#define USBUART_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.slp = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // usbuart_map
 // usbuart
 
typedef struct
{
    // Output pins
    
    digital_out_t cts;  
    digital_out_t slp;  
    digital_out_t pwr;   
    // Input pins
    
    digital_in_t rts;     
 
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} usbuart_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    pin_name_t cts;        
    pin_name_t slp;      
    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;                         
} usbuart_cfg_t;
 
typedef enum
{
   USBUART_OK = 0,
   USBUART_ERROR = -1
 
} usbuart_return_value_t;
 
void usbuart_cfg_setup ( usbuart_cfg_t *cfg );
 
err_t usbuart_init ( usbuart_t *ctx, usbuart_cfg_t *cfg );
 
void usbuart_generic_write ( usbuart_t *ctx, char *data_buf, uint16_t len );
 
uint32_t usbuart_generic_read ( usbuart_t *ctx, char *data_buf, uint16_t max_len );
 
void usbuart_pwr_ctrl ( usbuart_t *ctx, uint8_t state );
 
void usbuart_set_cts ( usbuart_t *ctx, uint8_t state );
 
void usbuart_set_mode ( usbuart_t *ctx, uint8_t mode );
 
uint8_t usbuart_get_rts ( usbuart_t *ctx );
 
void usbuart_send_command ( usbuart_t *ctx, char *command );
#ifdef __cplusplus
}
#endif
#endif // USBUART_H
 
 // usbuart
 
// ------------------------------------------------------------------------ END