usbuart3  2.0.0.0
usbuart3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef USBUART3_H
36 #define USBUART3_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define USBUART3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.sus = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define USBUART3_RETVAL uint8_t
77 
78 #define USBUART3_OK 0x00
79 #define USBUART3_INIT_ERROR 0xFF
80 
86 #define DRV_RX_BUFFER_SIZE 500
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t rst;
103  digital_out_t cts;
104  digital_out_t wup;
105 
106  // Input pins
107 
108  digital_in_t sus;
109  digital_in_t rts;
110 
111  // Modules
112 
113  uart_t uart;
114 
115  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
116  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
117 
118 } usbuart3_t;
119 
123 typedef struct
124 {
125  // Communication gpio pins
126 
127  pin_name_t rx_pin;
128  pin_name_t tx_pin;
129 
130  // Additional gpio pins
131 
132  pin_name_t sus;
133  pin_name_t rst;
134  pin_name_t cts;
135  pin_name_t wup;
136  pin_name_t rts;
137 
138  // static variable
139 
140  uint32_t baud_rate; // Clock speed.
142  uart_data_bits_t data_bit; // Data bits.
143  uart_parity_t parity_bit; // Parity bit.
144  uart_stop_bits_t stop_bit; // Stop bits.
145 
147 
151 typedef uint8_t usbuart3_error_t;
152  // End types group
154 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
174 
183 
190 void usbuart3_generic_write ( usbuart3_t *ctx, char *data_buf, uint16_t len );
191 
199 int32_t usbuart3_generic_read ( usbuart3_t *ctx, char *data_buf, uint16_t max_len );
200 
209 
217 uint8_t usbuart3_get_susp ( usbuart3_t *ctx );
218 
219 
220 #ifdef __cplusplus
221 }
222 #endif
223 #endif // _USBUART3_H_
224  // End public_function group
227 
228 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: usbuart3.h:86
usbuart3_cfg_t
Click configuration structure definition.
Definition: usbuart3.h:124
usbuart3_t::wup
digital_out_t wup
Definition: usbuart3.h:104
usbuart3_t::rst
digital_out_t rst
Definition: usbuart3.h:102
usbuart3_cfg_t::rst
pin_name_t rst
Definition: usbuart3.h:133
usbuart3_t::uart
uart_t uart
Definition: usbuart3.h:113
usbuart3_get_susp
uint8_t usbuart3_get_susp(usbuart3_t *ctx)
Set device mode.
USBUART3_RETVAL
#define USBUART3_RETVAL
Definition: usbuart3.h:76
usbuart3_reset
void usbuart3_reset(usbuart3_t *ctx)
Function for reset.
usbuart3_t
Click ctx object definition.
Definition: usbuart3.h:99
usbuart3_cfg_setup
void usbuart3_cfg_setup(usbuart3_cfg_t *cfg)
Config Object Initialization function.
usbuart3_t::sus
digital_in_t sus
Definition: usbuart3.h:108
usbuart3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: usbuart3.h:144
usbuart3_init
USBUART3_RETVAL usbuart3_init(usbuart3_t *ctx, usbuart3_cfg_t *cfg)
Initialization function.
usbuart3_t::rts
digital_in_t rts
Definition: usbuart3.h:109
usbuart3_cfg_t::uart_blocking
bool uart_blocking
Definition: usbuart3.h:141
usbuart3_t::cts
digital_out_t cts
Definition: usbuart3.h:103
usbuart3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: usbuart3.h:127
usbuart3_error_t
uint8_t usbuart3_error_t
Error type.
Definition: usbuart3.h:151
usbuart3_cfg_t::sus
pin_name_t sus
Definition: usbuart3.h:132
usbuart3_generic_write
void usbuart3_generic_write(usbuart3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
usbuart3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: usbuart3.h:128
usbuart3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: usbuart3.h:142
usbuart3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: usbuart3.h:143
usbuart3_cfg_t::baud_rate
uint32_t baud_rate
Definition: usbuart3.h:140
usbuart3_generic_read
int32_t usbuart3_generic_read(usbuart3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
usbuart3_cfg_t::rts
pin_name_t rts
Definition: usbuart3.h:136
usbuart3_cfg_t::cts
pin_name_t cts
Definition: usbuart3.h:134
usbuart3_cfg_t::wup
pin_name_t wup
Definition: usbuart3.h:135