ftdi.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 FTDI_H
#define FTDI_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 FTDI_TX_DRV_BUFFER_SIZE     100
#define FTDI_RX_DRV_BUFFER_SIZE     300
 
 // ftdi_cmd
 
#define FTDI_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX );
 
 // ftdi_map
 // ftdi
 
typedef struct
{
    // Modules
    uart_t uart;    
    // Buffers
    uint8_t uart_rx_buffer[ FTDI_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ FTDI_TX_DRV_BUFFER_SIZE ];  
} ftdi_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // 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;                  
} ftdi_cfg_t;
 
typedef enum
{
    FTDI_OK = 0,
    FTDI_ERROR = -1
 
} ftdi_return_value_t;
 
void ftdi_cfg_setup ( ftdi_cfg_t *cfg );
 
err_t ftdi_init ( ftdi_t *ctx, ftdi_cfg_t *cfg );
 
err_t ftdi_generic_write ( ftdi_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t ftdi_generic_read ( ftdi_t *ctx, uint8_t *data_out, uint16_t len );
 
#ifdef __cplusplus
}
#endif
#endif // FTDI_H
 
 // ftdi
 
// ------------------------------------------------------------------------ END