rs485isolator2 2.0.0.0
rs485isolator2.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 RS485ISOLATOR2_H
36#define RS485ISOLATOR2_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_uart.h"
41
42
43// -------------------------------------------------------------- PUBLIC MACROS
53#define RS485ISOLATOR2_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56 cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57 cfg.de = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58 cfg.inr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59 cfg. ind = MIKROBUS( mikrobus, MIKROBUS_INT )
66#define RS485ISOLATOR2_RETVAL uint8_t
67
68#define RS485ISOLATOR2_OK 0x00
69#define RS485ISOLATOR2_INIT_ERROR 0xFF
76#define DRV_RX_BUFFER_SIZE 500
79#define RS485ISOLATOR2_ENABLE_RE 0x00
80#define RS485ISOLATOR2_DISABLE_RE 0x01
81
82// Driver Output Enable
83
84#define RS485ISOLATOR2_ENABLE_DE 0x01
85#define RS485ISOLATOR2_DISABLE_DE 0x00
86
87// Receiver Inversion Enable
88
89#define RS485ISOLATOR2_ENABLE_INR 0x01
90#define RS485ISOLATOR2_DISABLE_INR 0x00
91
92// Driver Inversion Enable
93
94#define RS485ISOLATOR2_ENABLE_IND 0x01
95#define RS485ISOLATOR2_DISABLE_IND 0x00
96 // End group macro
98// --------------------------------------------------------------- PUBLIC TYPES
106typedef struct
107{
108 // Output pins
109
110 digital_out_t re;
111 digital_out_t de;
112 digital_out_t inr;
113 digital_out_t ind;
114
115 // Modules
116
117 uart_t uart;
118
119 char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
120 char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
121
123
127typedef struct
128{
129 // Communication gpio pins
130
131 pin_name_t rx_pin;
132 pin_name_t tx_pin;
133
134 // Additional gpio pins
135
136 pin_name_t re;
137 pin_name_t de;
138 pin_name_t inr;
139 pin_name_t ind;
140
141 // static variable
142
143 uint32_t baud_rate; // Clock speed.
145 uart_data_bits_t data_bit; // Data bits.
146 uart_parity_t parity_bit; // Parity bit.
147 uart_stop_bits_t stop_bit; // Stop bits.
148
150
155 // End types group
157// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
158
164#ifdef __cplusplus
165extern "C"{
166#endif
167
177
186
192void rs485isolator2_set_de_pin ( rs485isolator2_t *ctx, uint8_t state );
193
199void rs485isolator2_set_re_pin ( rs485isolator2_t *ctx, uint8_t state );
200
206void rs485isolator2_set_ind_pin ( rs485isolator2_t *ctx, uint8_t state );
207
213void rs485isolator2_set_inr_pin ( rs485isolator2_t *ctx, uint8_t state );
214
221void rs485isolator2_generic_write ( rs485isolator2_t *ctx, char *data_buf, uint16_t len );
222
230int32_t rs485isolator2_generic_read ( rs485isolator2_t *ctx, char *data_buf, uint16_t max_len );
231
238
239
240#ifdef __cplusplus
241}
242#endif
243#endif // _RS485ISOLATOR2_H_
244 // End public_function group
247
248// ------------------------------------------------------------------------- END
#define DRV_RX_BUFFER_SIZE
Definition: rs485isolator2.h:76
#define RS485ISOLATOR2_RETVAL
Definition: rs485isolator2.h:66
void rs485isolator2_set_ind_pin(rs485isolator2_t *ctx, uint8_t state)
Get IND (int) pin state.
void rs485isolator2_send_bit_by_bit(rs485isolator2_t *ctx, char *command)
Bit by bit write function.
void rs485isolator2_generic_write(rs485isolator2_t *ctx, char *data_buf, uint16_t len)
Generic write function.
void rs485isolator2_set_inr_pin(rs485isolator2_t *ctx, uint8_t state)
Set INR ( pwm ) pin state.
void rs485isolator2_set_de_pin(rs485isolator2_t *ctx, uint8_t state)
Set DE ( cs ) pin state.
int32_t rs485isolator2_generic_read(rs485isolator2_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
void rs485isolator2_set_re_pin(rs485isolator2_t *ctx, uint8_t state)
Set RE ( reset ) pin state.
RS485ISOLATOR2_RETVAL rs485isolator2_init(rs485isolator2_t *ctx, rs485isolator2_cfg_t *cfg)
Initialization function.
void rs485isolator2_cfg_setup(rs485isolator2_cfg_t *cfg)
Config Object Initialization function.
uint8_t rs485isolator2_error_t
Error type.
Definition: rs485isolator2.h:154
Click configuration structure definition.
Definition: rs485isolator2.h:128
uint32_t baud_rate
Definition: rs485isolator2.h:143
pin_name_t re
Definition: rs485isolator2.h:136
bool uart_blocking
Definition: rs485isolator2.h:144
uart_data_bits_t data_bit
Definition: rs485isolator2.h:145
pin_name_t tx_pin
Definition: rs485isolator2.h:132
pin_name_t de
Definition: rs485isolator2.h:137
pin_name_t inr
Definition: rs485isolator2.h:138
pin_name_t rx_pin
Definition: rs485isolator2.h:131
uart_stop_bits_t stop_bit
Definition: rs485isolator2.h:147
uart_parity_t parity_bit
Definition: rs485isolator2.h:146
pin_name_t ind
Definition: rs485isolator2.h:139
Click ctx object definition.
Definition: rs485isolator2.h:107
digital_out_t re
Definition: rs485isolator2.h:110
uart_t uart
Definition: rs485isolator2.h:117
digital_out_t de
Definition: rs485isolator2.h:111
digital_out_t ind
Definition: rs485isolator2.h:113
digital_out_t inr
Definition: rs485isolator2.h:112