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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define USBUART3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.sus = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define USBUART3_RETVAL uint8_t
67 
68 #define USBUART3_OK 0x00
69 #define USBUART3_INIT_ERROR 0xFF
70 
76 #define DRV_RX_BUFFER_SIZE 500
77  // End group macro
80 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91 
92  digital_out_t rst;
93  digital_out_t cts;
94  digital_out_t wup;
95 
96  // Input pins
97 
98  digital_in_t sus;
99  digital_in_t rts;
100 
101  // Modules
102 
103  uart_t uart;
104 
105  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
106  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
107 
108 } usbuart3_t;
109 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t rx_pin;
118  pin_name_t tx_pin;
119 
120  // Additional gpio pins
121 
122  pin_name_t sus;
123  pin_name_t rst;
124  pin_name_t cts;
125  pin_name_t wup;
126  pin_name_t rts;
127 
128  // static variable
129 
130  uint32_t baud_rate; // Clock speed.
132  uart_data_bits_t data_bit; // Data bits.
133  uart_parity_t parity_bit; // Parity bit.
134  uart_stop_bits_t stop_bit; // Stop bits.
135 
137 
141 typedef uint8_t usbuart3_error_t;
142  // End types group
144 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
145 
151 #ifdef __cplusplus
152 extern "C"{
153 #endif
154 
163 void usbuart3_cfg_setup ( usbuart3_cfg_t *cfg );
164 
173 
180 void usbuart3_generic_write ( usbuart3_t *ctx, char *data_buf, uint16_t len );
181 
189 int32_t usbuart3_generic_read ( usbuart3_t *ctx, char *data_buf, uint16_t max_len );
190 
198 void usbuart3_reset ( usbuart3_t *ctx );
199 
207 uint8_t usbuart3_get_susp ( usbuart3_t *ctx );
208 
209 
210 #ifdef __cplusplus
211 }
212 #endif
213 #endif // _USBUART3_H_
214  // End public_function group
217 
218 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: usbuart3.h:76
usbuart3_cfg_t
Click configuration structure definition.
Definition: usbuart3.h:113
usbuart3_t::wup
digital_out_t wup
Definition: usbuart3.h:94
usbuart3_t::rst
digital_out_t rst
Definition: usbuart3.h:92
usbuart3_cfg_t::rst
pin_name_t rst
Definition: usbuart3.h:123
usbuart3_t::uart
uart_t uart
Definition: usbuart3.h:103
usbuart3_get_susp
uint8_t usbuart3_get_susp(usbuart3_t *ctx)
Set device mode.
USBUART3_RETVAL
#define USBUART3_RETVAL
Definition: usbuart3.h:66
usbuart3_reset
void usbuart3_reset(usbuart3_t *ctx)
Function for reset.
usbuart3_t
Click ctx object definition.
Definition: usbuart3.h:88
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:98
usbuart3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: usbuart3.h:134
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:99
usbuart3_cfg_t::uart_blocking
bool uart_blocking
Definition: usbuart3.h:131
usbuart3_t::cts
digital_out_t cts
Definition: usbuart3.h:93
usbuart3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: usbuart3.h:117
usbuart3_error_t
uint8_t usbuart3_error_t
Error type.
Definition: usbuart3.h:141
usbuart3_cfg_t::sus
pin_name_t sus
Definition: usbuart3.h:122
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:118
usbuart3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: usbuart3.h:132
usbuart3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: usbuart3.h:133
usbuart3_cfg_t::baud_rate
uint32_t baud_rate
Definition: usbuart3.h:130
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:126
usbuart3_cfg_t::cts
pin_name_t cts
Definition: usbuart3.h:124
usbuart3_cfg_t::wup
pin_name_t wup
Definition: usbuart3.h:125