rs4852  2.0.0.0
rs4852.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 RS4852_H
36 #define RS4852_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 RS4852_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.de = MIKROBUS( mikrobus, MIKROBUS_CS ); \
66  cfg.re = MIKROBUS( mikrobus, MIKROBUS_PWM )
67 
73 #define RS4852_RETVAL uint8_t
74 
75 #define RS4852_OK 0x00
76 #define RS4852_INIT_ERROR 0xFF
77 
83 #define DRV_RX_BUFFER_SIZE 500
84 
90 #define RS4852_ENABLE_DE 0x01
91 #define RS4852_DISABLE_DE 0x00
92 
98 #define RS4852_ENABLE_RE 0x00
99 #define RS4852_DISABLE_RE 0x01
100  // End group macro
103 // --------------------------------------------------------------- PUBLIC TYPES
111 typedef struct
112 {
113  // Output pins
114 
115  digital_out_t de;
116  digital_out_t re;
117 
118  // Modules
119 
120  uart_t uart;
121 
122  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
123  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
124 
125 } rs4852_t;
126 
130 typedef struct
131 {
132  // Communication gpio pins
133 
134  pin_name_t rx_pin;
135  pin_name_t tx_pin;
136 
137  // Additional gpio pins
138 
139  pin_name_t de;
140  pin_name_t re;
141 
142  // static variable
143 
144  uint32_t baud_rate; // Clock speed.
146  uart_data_bits_t data_bit; // Data bits.
147  uart_parity_t parity_bit; // Parity bit.
148  uart_stop_bits_t stop_bit; // Stop bits.
149 
150 } rs4852_cfg_t;
151 
155 typedef uint8_t rs4852_error_t;
156  // End types group
158 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
159 
165 #ifdef __cplusplus
166 extern "C"{
167 #endif
168 
178 
187 
194 void rs4852_generic_write ( rs4852_t *ctx, char *data_buf, uint16_t len );
195 
203 int32_t rs4852_generic_read ( rs4852_t *ctx, char *data_buf, uint16_t max_len );
204 
210 void rs4852_set_de_pin ( rs4852_t *ctx, uint8_t state );
211 
217 void rs4852_set_re_pin ( rs4852_t *ctx, uint8_t state );
218 
219 #ifdef __cplusplus
220 }
221 #endif
222 #endif // _RS4852_H_
223  // End public_function group
226 
227 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4852.h:83
rs4852_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4852.h:146
rs4852_generic_write
void rs4852_generic_write(rs4852_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rs4852_init
RS4852_RETVAL rs4852_init(rs4852_t *ctx, rs4852_cfg_t *cfg)
Initialization function.
rs4852_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs4852.h:134
rs4852_cfg_t::de
pin_name_t de
Definition: rs4852.h:139
rs4852_set_re_pin
void rs4852_set_re_pin(rs4852_t *ctx, uint8_t state)
Set RE ( reset ) pin state.
rs4852_t::uart
uart_t uart
Definition: rs4852.h:120
rs4852_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4852.h:147
rs4852_t::re
digital_out_t re
Definition: rs4852.h:116
rs4852_cfg_t::re
pin_name_t re
Definition: rs4852.h:140
rs4852_t::de
digital_out_t de
Definition: rs4852.h:115
rs4852_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4852.h:148
rs4852_set_de_pin
void rs4852_set_de_pin(rs4852_t *ctx, uint8_t state)
Set DE ( cs ) pin state.
rs4852_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4852.h:144
RS4852_RETVAL
#define RS4852_RETVAL
Definition: rs4852.h:73
rs4852_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4852.h:145
rs4852_cfg_t
Click configuration structure definition.
Definition: rs4852.h:131
rs4852_error_t
uint8_t rs4852_error_t
Error type.
Definition: rs4852.h:155
rs4852_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4852.h:135
rs4852_cfg_setup
void rs4852_cfg_setup(rs4852_cfg_t *cfg)
Config Object Initialization function.
rs4852_generic_read
int32_t rs4852_generic_read(rs4852_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rs4852_t
Click ctx object definition.
Definition: rs4852.h:112