ftdi  2.1.0.0
ftdi.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef FTDI_H
29 #define FTDI_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
74 #define FTDI_TX_DRV_BUFFER_SIZE 100
75 #define FTDI_RX_DRV_BUFFER_SIZE 300
76  // ftdi_cmd
78 
93 #define FTDI_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
95  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
96  // ftdi_map // ftdi
99 
104 typedef struct
105 {
106  // Modules
107  uart_t uart;
109  // Buffers
110  uint8_t uart_rx_buffer[ FTDI_RX_DRV_BUFFER_SIZE ];
111  uint8_t uart_tx_buffer[ FTDI_TX_DRV_BUFFER_SIZE ];
113 } ftdi_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t rx_pin;
123  pin_name_t tx_pin;
125  // Static variable
126  uint32_t baud_rate;
128  uart_data_bits_t data_bit;
129  uart_parity_t parity_bit;
130  uart_stop_bits_t stop_bit;
132 } ftdi_cfg_t;
133 
138 typedef enum
139 {
140  FTDI_OK = 0,
141  FTDI_ERROR = -1
142 
144 
161 
175 err_t ftdi_init ( ftdi_t *ctx, ftdi_cfg_t *cfg );
176 
189 err_t ftdi_generic_write ( ftdi_t *ctx, uint8_t *data_in, uint16_t len );
190 
203 err_t ftdi_generic_read ( ftdi_t *ctx, uint8_t *data_out, uint16_t len );
204 
205 #ifdef __cplusplus
206 }
207 #endif
208 #endif // FTDI_H
209  // ftdi
211 
212 // ------------------------------------------------------------------------ END
ftdi_cfg_t::baud_rate
uint32_t baud_rate
Definition: ftdi.h:126
ftdi_t::uart
uart_t uart
Definition: ftdi.h:107
ftdi_generic_read
err_t ftdi_generic_read(ftdi_t *ctx, uint8_t *data_out, uint16_t len)
FTDI data reading function.
ftdi_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ftdi.h:122
FTDI_TX_DRV_BUFFER_SIZE
#define FTDI_TX_DRV_BUFFER_SIZE
FTDI driver buffer size.
Definition: ftdi.h:74
ftdi_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ftdi.h:123
ftdi_generic_write
err_t ftdi_generic_write(ftdi_t *ctx, uint8_t *data_in, uint16_t len)
FTDI data writing function.
ftdi_init
err_t ftdi_init(ftdi_t *ctx, ftdi_cfg_t *cfg)
FTDI initialization function.
ftdi_t
FTDI Click context object.
Definition: ftdi.h:105
ftdi_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ftdi.h:129
ftdi_return_value_t
ftdi_return_value_t
FTDI Click return value data.
Definition: ftdi.h:139
FTDI_RX_DRV_BUFFER_SIZE
#define FTDI_RX_DRV_BUFFER_SIZE
Definition: ftdi.h:75
ftdi_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ftdi.h:130
ftdi_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ftdi.h:128
ftdi_cfg_t
FTDI Click configuration object.
Definition: ftdi.h:120
FTDI_ERROR
@ FTDI_ERROR
Definition: ftdi.h:141
FTDI_OK
@ FTDI_OK
Definition: ftdi.h:140
ftdi_cfg_setup
void ftdi_cfg_setup(ftdi_cfg_t *cfg)
FTDI configuration object setup function.
ftdi_cfg_t::uart_blocking
bool uart_blocking
Definition: ftdi.h:127