rs485isolator  2.0.0.0
rs485isolator.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 RS485ISOLATOR_H
36 #define RS485ISOLATOR_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 RS485ISOLATOR_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56  cfg.de = MIKROBUS( mikrobus, MIKROBUS_CS )
57 
63 #define RS485ISOLATOR_OK 0
64 #define RS485ISOLATOR_ERROR -1
65 
71 #define RS485ISOLATOR_RECEIVER_ENABLE 0
72 #define RS485ISOLATOR_RECEIVER_DISABLE 1
73 
79 #define RS485ISOLATOR_DRIVER_ENABLE 1
80 #define RS485ISOLATOR_DRIVER_DISABLE 0
81 
87 #define RS485ISOLATOR_DRV_RX_BUFFER_SIZE 200
88 #define RS485ISOLATOR_DRV_TX_BUFFER_SIZE 200
89  // End group macro
92 // --------------------------------------------------------------- PUBLIC TYPES
100 typedef struct
101 {
102  // Output pins
103  digital_out_t re;
104  digital_out_t de;
105 
106  // Modules
107  uart_t uart;
108 
109  uint8_t uart_rx_buffer[ RS485ISOLATOR_DRV_RX_BUFFER_SIZE ];
110  uint8_t uart_tx_buffer[ RS485ISOLATOR_DRV_TX_BUFFER_SIZE ];
111 
113 
117 typedef struct
118 {
119  // Communication gpio pins
120  pin_name_t rx_pin;
121  pin_name_t tx_pin;
122 
123  // Additional gpio pins
124  pin_name_t re;
125  pin_name_t de;
126 
127  // static variable
128  uint32_t baud_rate; // Clock speed.
130  uart_data_bits_t data_bit; // Data bits.
131  uart_parity_t parity_bit; // Parity bit.
132  uart_stop_bits_t stop_bit; // Stop bits.
133 
135  // End types group
137 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
138 
144 #ifdef __cplusplus
145 extern "C"{
146 #endif
147 
157 
166 
173 void rs485isolator_generic_write ( rs485isolator_t *ctx, uint8_t *data_buf, uint16_t len );
174 
182 err_t rs485isolator_generic_read ( rs485isolator_t *ctx, uint8_t *data_buf, uint16_t max_len );
183 
191 
198 void rs485isolator_set_driver_mode ( rs485isolator_t *ctx, uint8_t state );
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // _RS485ISOLATOR_H_
204  // End public_function group
207 
208 // ------------------------------------------------------------------------- END
rs485isolator_generic_write
void rs485isolator_generic_write(rs485isolator_t *ctx, uint8_t *data_buf, uint16_t len)
Generic write function.
RS485ISOLATOR_DRV_TX_BUFFER_SIZE
#define RS485ISOLATOR_DRV_TX_BUFFER_SIZE
Definition: rs485isolator.h:88
rs485isolator_cfg_t::uart_blocking
bool uart_blocking
Definition: rs485isolator.h:129
rs485isolator_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs485isolator.h:128
rs485isolator_t::de
digital_out_t de
Definition: rs485isolator.h:104
rs485isolator_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs485isolator.h:132
rs485isolator_init
err_t rs485isolator_init(rs485isolator_t *ctx, rs485isolator_cfg_t *cfg)
Initialization function.
rs485isolator_cfg_t
Click configuration structure definition.
Definition: rs485isolator.h:118
rs485isolator_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs485isolator.h:130
RS485ISOLATOR_DRV_RX_BUFFER_SIZE
#define RS485ISOLATOR_DRV_RX_BUFFER_SIZE
Definition: rs485isolator.h:87
rs485isolator_cfg_t::re
pin_name_t re
Definition: rs485isolator.h:124
rs485isolator_set_driver_mode
void rs485isolator_set_driver_mode(rs485isolator_t *ctx, uint8_t state)
Set driver state.
rs485isolator_cfg_t::de
pin_name_t de
Definition: rs485isolator.h:125
rs485isolator_set_receiver_mode
void rs485isolator_set_receiver_mode(rs485isolator_t *ctx, uint8_t state)
Set receiver state.
rs485isolator_t
Click ctx object definition.
Definition: rs485isolator.h:101
rs485isolator_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs485isolator.h:131
rs485isolator_t::re
digital_out_t re
Definition: rs485isolator.h:103
rs485isolator_cfg_setup
void rs485isolator_cfg_setup(rs485isolator_cfg_t *cfg)
Config Object Initialization function.
rs485isolator_generic_read
err_t rs485isolator_generic_read(rs485isolator_t *ctx, uint8_t *data_buf, uint16_t max_len)
Generic read function.
rs485isolator_t::uart
uart_t uart
Definition: rs485isolator.h:107
rs485isolator_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs485isolator.h:120
rs485isolator_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs485isolator.h:121