rs485isolator4  2.1.0.0
rs485isolator4.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 RS485ISOLATOR4_H
29 #define RS485ISOLATOR4_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 RS485ISOLATOR4_TX_DRV_BUFFER_SIZE 256
75 #define RS485ISOLATOR4_RX_DRV_BUFFER_SIZE 256
76  // rs485isolator4_cmd
78 
93 #define RS485ISOLATOR4_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
95  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
96  cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST ); \
97  cfg.de = MIKROBUS( mikrobus, MIKROBUS_PWM );
98  // rs485isolator4_map // rs485isolator4
101 
106 typedef struct
107 {
108  // Output pins
109  digital_out_t re;
110  digital_out_t de;
112  // Modules
113  uart_t uart;
115  // Buffers
116  uint8_t uart_rx_buffer[ RS485ISOLATOR4_RX_DRV_BUFFER_SIZE ];
117  uint8_t uart_tx_buffer[ RS485ISOLATOR4_TX_DRV_BUFFER_SIZE ];
120 
125 typedef struct
126 {
127  // Communication gpio pins
128  pin_name_t rx_pin;
129  pin_name_t tx_pin;
131  // Additional gpio pins
132  pin_name_t re;
133  pin_name_t de;
135  // Static variable
136  uint32_t baud_rate;
138  uart_data_bits_t data_bit;
139  uart_parity_t parity_bit;
140  uart_stop_bits_t stop_bit;
143 
148 typedef enum
149 {
152 
154 
171 
186 
199 err_t rs485isolator4_generic_write ( rs485isolator4_t *ctx, uint8_t *data_in, uint16_t len );
200 
213 err_t rs485isolator4_generic_read ( rs485isolator4_t *ctx, uint8_t *data_out, uint16_t len );
214 
224 
234 
244 
254 
255 #ifdef __cplusplus
256 }
257 #endif
258 #endif // RS485ISOLATOR4_H
259  // rs485isolator4
261 
262 // ------------------------------------------------------------------------ END
rs485isolator4_generic_write
err_t rs485isolator4_generic_write(rs485isolator4_t *ctx, uint8_t *data_in, uint16_t len)
RS485 Isolator 4 data writing function.
rs485isolator4_t
RS485 Isolator 4 Click context object.
Definition: rs485isolator4.h:107
rs485isolator4_t::uart
uart_t uart
Definition: rs485isolator4.h:113
rs485isolator4_driver_disable
void rs485isolator4_driver_disable(rs485isolator4_t *ctx)
RS485 Isolator 4 driver disable function.
rs485isolator4_cfg_t
RS485 Isolator 4 Click configuration object.
Definition: rs485isolator4.h:126
RS485ISOLATOR4_RX_DRV_BUFFER_SIZE
#define RS485ISOLATOR4_RX_DRV_BUFFER_SIZE
Definition: rs485isolator4.h:75
rs485isolator4_receiver_disable
void rs485isolator4_receiver_disable(rs485isolator4_t *ctx)
RS485 Isolator 4 receiver disable function.
RS485ISOLATOR4_TX_DRV_BUFFER_SIZE
#define RS485ISOLATOR4_TX_DRV_BUFFER_SIZE
RS485 Isolator 4 driver buffer size.
Definition: rs485isolator4.h:74
rs485isolator4_t::de
digital_out_t de
Definition: rs485isolator4.h:110
RS485ISOLATOR4_ERROR
@ RS485ISOLATOR4_ERROR
Definition: rs485isolator4.h:151
rs485isolator4_cfg_setup
void rs485isolator4_cfg_setup(rs485isolator4_cfg_t *cfg)
RS485 Isolator 4 configuration object setup function.
rs485isolator4_return_value_t
rs485isolator4_return_value_t
RS485 Isolator 4 Click return value data.
Definition: rs485isolator4.h:149
rs485isolator4_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs485isolator4.h:140
rs485isolator4_generic_read
err_t rs485isolator4_generic_read(rs485isolator4_t *ctx, uint8_t *data_out, uint16_t len)
RS485 Isolator 4 data reading function.
rs485isolator4_cfg_t::re
pin_name_t re
Definition: rs485isolator4.h:132
rs485isolator4_driver_enable
void rs485isolator4_driver_enable(rs485isolator4_t *ctx)
RS485 Isolator 4 driver enable function.
rs485isolator4_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs485isolator4.h:139
rs485isolator4_receiver_enable
void rs485isolator4_receiver_enable(rs485isolator4_t *ctx)
RS485 Isolator 4 receiver enable function.
RS485ISOLATOR4_OK
@ RS485ISOLATOR4_OK
Definition: rs485isolator4.h:150
rs485isolator4_cfg_t::de
pin_name_t de
Definition: rs485isolator4.h:133
rs485isolator4_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs485isolator4.h:128
rs485isolator4_t::re
digital_out_t re
Definition: rs485isolator4.h:109
rs485isolator4_init
err_t rs485isolator4_init(rs485isolator4_t *ctx, rs485isolator4_cfg_t *cfg)
RS485 Isolator 4 initialization function.
rs485isolator4_cfg_t::uart_blocking
bool uart_blocking
Definition: rs485isolator4.h:137
rs485isolator4_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs485isolator4.h:136
rs485isolator4_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs485isolator4.h:138
rs485isolator4_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs485isolator4.h:129