rs4854  2.0.0.0
rs4854.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 RS4854_H
36 #define RS4854_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 RS4854_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 
64 #define RS4854_RETVAL uint8_t
65 
66 #define RS4854_OK 0x00
67 #define RS4854_INIT_ERROR 0xFF
68 
74 #define DRV_RX_BUFFER_SIZE 500
75 
81 #define RS4854_PIN_STATE_LOW 0
82 #define RS4854_PIN_STATE_HIGH 1
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
94 typedef struct
95 {
96  // Output pins
97 
98  digital_out_t re;
99  digital_out_t de;
100 
101  // Modules
102 
103  uart_t uart;
104 
105  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
106  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
107 
108 } rs4854_t;
109 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t rx_pin;
118  pin_name_t tx_pin;
119 
120  // Additional gpio pins
121 
122  pin_name_t re;
123  pin_name_t de;
124 
125  // static variable
126 
127  uint32_t baud_rate; // Clock speed.
129  uart_data_bits_t data_bit; // Data bits.
130  uart_parity_t parity_bit; // Parity bit.
131  uart_stop_bits_t stop_bit; // Stop bits.
132 
133 } rs4854_cfg_t;
134 
138 typedef uint8_t rs4854_error_t;
139  // End types group
141 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
142 
148 #ifdef __cplusplus
149 extern "C"{
150 #endif
151 
160 void rs4854_cfg_setup ( rs4854_cfg_t *cfg );
161 
170 
177 void rs4854_generic_write ( rs4854_t *ctx, char *data_buf, uint16_t len );
178 
186 int32_t rs4854_generic_read ( rs4854_t *ctx, char *data_buf, uint16_t max_len );
187 
195 void rs4854_rx_disable ( rs4854_t *ctx );
196 
204 void rs4854_rx_enable ( rs4854_t *ctx );
205 
213 void rs4854_tx_disable ( rs4854_t *ctx );
214 
222 void rs4854_tx_enable ( rs4854_t *ctx );
223 
231 void rs4854_re_pin_set (rs4854_t *ctx, uint8_t pin_state );
232 
240 void rs4854_de_pin_set ( rs4854_t *ctx, uint8_t pin_state );
241 
242 
243 #ifdef __cplusplus
244 }
245 #endif
246 #endif // _RS4854_H_
247  // End public_function group
250 
251 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4854.h:74
rs4854_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4854.h:130
rs4854_re_pin_set
void rs4854_re_pin_set(rs4854_t *ctx, uint8_t pin_state)
Sets RE pin to high or low state.
rs4854_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4854.h:128
rs4854_rx_enable
void rs4854_rx_enable(rs4854_t *ctx)
Rx enable function.
rs4854_cfg_setup
void rs4854_cfg_setup(rs4854_cfg_t *cfg)
Config Object Initialization function.
rs4854_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4854.h:118
rs4854_generic_read
int32_t rs4854_generic_read(rs4854_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rs4854_t::re
digital_out_t re
Definition: rs4854.h:98
rs4854_t::uart
uart_t uart
Definition: rs4854.h:103
rs4854_cfg_t::re
pin_name_t re
Definition: rs4854.h:122
rs4854_tx_disable
void rs4854_tx_disable(rs4854_t *ctx)
Tx disable function.
rs4854_tx_enable
void rs4854_tx_enable(rs4854_t *ctx)
Tx enable function.
rs4854_de_pin_set
void rs4854_de_pin_set(rs4854_t *ctx, uint8_t pin_state)
Sets DE pin to high or low state.
rs4854_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4854.h:131
rs4854_t::de
digital_out_t de
Definition: rs4854.h:99
rs4854_cfg_t
Click configuration structure definition.
Definition: rs4854.h:113
rs4854_t
Click ctx object definition.
Definition: rs4854.h:94
rs4854_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4854.h:129
rs4854_rx_disable
void rs4854_rx_disable(rs4854_t *ctx)
Rx disable function.
rs4854_generic_write
void rs4854_generic_write(rs4854_t *ctx, char *data_buf, uint16_t len)
Generic write function.
RS4854_RETVAL
#define RS4854_RETVAL
Definition: rs4854.h:64
rs4854_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4854.h:127
rs4854_error_t
uint8_t rs4854_error_t
Error type.
Definition: rs4854.h:138
rs4854_init
RS4854_RETVAL rs4854_init(rs4854_t *ctx, rs4854_cfg_t *cfg)
Initialization function.
rs4854_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs4854.h:117
rs4854_cfg_t::de
pin_name_t de
Definition: rs4854.h:123