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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define RS4852_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.de = MIKROBUS( mikrobus, MIKROBUS_CS ); \
70  cfg.re = MIKROBUS( mikrobus, MIKROBUS_PWM )
71 
77 #define RS4852_RETVAL uint8_t
78 
79 #define RS4852_OK 0x00
80 #define RS4852_INIT_ERROR 0xFF
81 
87 #define DRV_RX_BUFFER_SIZE 500
88 
94 #define RS4852_ENABLE_DE 0x01
95 #define RS4852_DISABLE_DE 0x00
96 
102 #define RS4852_ENABLE_RE 0x00
103 #define RS4852_DISABLE_RE 0x01
104  // End group macro
107 // --------------------------------------------------------------- PUBLIC TYPES
115 typedef struct
116 {
117  // Output pins
118 
119  digital_out_t de;
120  digital_out_t re;
121 
122  // Modules
123 
124  uart_t uart;
125 
126  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
127  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
128 
129 } rs4852_t;
130 
134 typedef struct
135 {
136  // Communication gpio pins
137 
138  pin_name_t rx_pin;
139  pin_name_t tx_pin;
140 
141  // Additional gpio pins
142 
143  pin_name_t de;
144  pin_name_t re;
145 
146  // static variable
147 
148  uint32_t baud_rate; // Clock speed.
150  uart_data_bits_t data_bit; // Data bits.
151  uart_parity_t parity_bit; // Parity bit.
152  uart_stop_bits_t stop_bit; // Stop bits.
153 
154 } rs4852_cfg_t;
155 
159 typedef uint8_t rs4852_error_t;
160  // End types group
162 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
163 
169 #ifdef __cplusplus
170 extern "C"{
171 #endif
172 
182 
191 
198 void rs4852_generic_write ( rs4852_t *ctx, char *data_buf, uint16_t len );
199 
207 int32_t rs4852_generic_read ( rs4852_t *ctx, char *data_buf, uint16_t max_len );
208 
214 void rs4852_set_de_pin ( rs4852_t *ctx, uint8_t state );
215 
221 void rs4852_set_re_pin ( rs4852_t *ctx, uint8_t state );
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 #endif // _RS4852_H_
227  // End public_function group
230 
231 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4852.h:87
rs4852_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4852.h:150
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:138
rs4852_cfg_t::de
pin_name_t de
Definition: rs4852.h:143
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:124
rs4852_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4852.h:151
rs4852_t::re
digital_out_t re
Definition: rs4852.h:120
rs4852_cfg_t::re
pin_name_t re
Definition: rs4852.h:144
rs4852_t::de
digital_out_t de
Definition: rs4852.h:119
rs4852_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4852.h:152
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:148
RS4852_RETVAL
#define RS4852_RETVAL
Definition: rs4852.h:77
rs4852_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4852.h:149
rs4852_cfg_t
Click configuration structure definition.
Definition: rs4852.h:135
rs4852_error_t
uint8_t rs4852_error_t
Error type.
Definition: rs4852.h:159
rs4852_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4852.h:139
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:116