rs2322  2.0.0.0
rs2322.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 RS2322_H
36 #define RS2322_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 RS2322_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.dcd = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define RS2322_RETVAL uint8_t
77 
78 #define RS2322_OK 0x00
79 #define RS2322_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 dcd;
103  digital_out_t cts;
104  digital_out_t ri;
105 
106  // Input pins
107 
108  digital_in_t dtr;
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 } rs2322_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 dtr;
133  pin_name_t dcd;
134  pin_name_t cts;
135  pin_name_t ri;
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 
146 } rs2322_cfg_t;
147 
151 typedef uint8_t rs2322_error_t;
152  // End types group
154 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
174 
183 
190 void rs2322_generic_write ( rs2322_t *ctx, char *data_buf, uint16_t len );
191 
199 int16_t rs2322_generic_read ( rs2322_t *ctx, char *data_buf, uint16_t max_len );
200 
209 void rs2322_set_dcd ( rs2322_t *ctx, uint8_t state );
210 
219 void rs2322_set_cts ( rs2322_t *ctx, uint8_t state );
220 
229 void rs2322_set_ri ( rs2322_t *ctx, uint8_t state );
230 
238 uint8_t rs2322_get_rts ( rs2322_t *ctx );
239 
247 uint8_t rs2322_get_dtr ( rs2322_t *ctx );
248 
255 void rs2322_send_command ( rs2322_t *ctx, char *command );
256 
257 #ifdef __cplusplus
258 }
259 #endif
260 #endif // _RS2322_H_
261  // End public_function group
264 
265 // ------------------------------------------------------------------------- END
rs2322_t
Click ctx object definition.
Definition: rs2322.h:99
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs2322.h:86
rs2322_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs2322.h:142
rs2322_t::cts
digital_out_t cts
Definition: rs2322.h:103
rs2322_set_ri
void rs2322_set_ri(rs2322_t *ctx, uint8_t state)
This function sets RI pin state.
rs2322_send_command
void rs2322_send_command(rs2322_t *ctx, char *command)
Function for send command.
rs2322_t::rts
digital_in_t rts
Definition: rs2322.h:109
rs2322_error_t
uint8_t rs2322_error_t
Error type.
Definition: rs2322.h:151
rs2322_get_dtr
uint8_t rs2322_get_dtr(rs2322_t *ctx)
This function get DTR pin state.
rs2322_cfg_t::cts
pin_name_t cts
Definition: rs2322.h:134
rs2322_init
RS2322_RETVAL rs2322_init(rs2322_t *ctx, rs2322_cfg_t *cfg)
Initialization function.
rs2322_t::uart
uart_t uart
Definition: rs2322.h:113
RS2322_RETVAL
#define RS2322_RETVAL
Definition: rs2322.h:76
rs2322_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs2322.h:127
rs2322_cfg_t
Click configuration structure definition.
Definition: rs2322.h:124
rs2322_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs2322.h:140
rs2322_cfg_t::rts
pin_name_t rts
Definition: rs2322.h:136
rs2322_t::dcd
digital_out_t dcd
Definition: rs2322.h:102
rs2322_t::dtr
digital_in_t dtr
Definition: rs2322.h:108
rs2322_cfg_t::uart_blocking
bool uart_blocking
Definition: rs2322.h:141
rs2322_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs2322.h:144
rs2322_t::ri
digital_out_t ri
Definition: rs2322.h:104
rs2322_cfg_t::dtr
pin_name_t dtr
Definition: rs2322.h:132
rs2322_generic_read
int16_t rs2322_generic_read(rs2322_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rs2322_cfg_t::ri
pin_name_t ri
Definition: rs2322.h:135
rs2322_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs2322.h:143
rs2322_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs2322.h:128
rs2322_set_cts
void rs2322_set_cts(rs2322_t *ctx, uint8_t state)
This function sets CTS pin state.
rs2322_generic_write
void rs2322_generic_write(rs2322_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rs2322_cfg_t::dcd
pin_name_t dcd
Definition: rs2322.h:133
rs2322_get_rts
uint8_t rs2322_get_rts(rs2322_t *ctx)
This function get RST pin state.
rs2322_set_dcd
void rs2322_set_dcd(rs2322_t *ctx, uint8_t state)
This function sets DCD pin state.
rs2322_cfg_setup
void rs2322_cfg_setup(rs2322_cfg_t *cfg)
Config Object Initialization function.