rs4855  2.0.0.0
rs4855.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 RS4855_H
36 #define RS4855_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 RS4855_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.de = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.re = MIKROBUS( mikrobus, MIKROBUS_CS )
58 
64 #define RS4855_RETVAL uint8_t
65 
66 #define RS4855_OK 0x00
67 #define RS4855_INIT_ERROR 0xFF
68 
74 #define DRV_RX_BUFFER_SIZE 500
75 
77 #define RS4855_PIN_STATE_HIGH 1
78 #define RS4855_PIN_STATE_LOW 0
79  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
89 typedef struct
90 {
91  // Output pins
92 
93  digital_out_t de;
94  digital_out_t re;
95 
96  // Modules
97 
98  uart_t uart;
99 
100  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
101  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
102 
103 } rs4855_t;
104 
108 typedef struct
109 {
110  // Communication gpio pins
111 
112  pin_name_t rx_pin;
113  pin_name_t tx_pin;
114 
115  // Additional gpio pins
116 
117  pin_name_t de;
118  pin_name_t re;
119 
120  // static variable
121 
122  uint32_t baud_rate; // Clock speed.
124  uart_data_bits_t data_bit; // Data bits.
125  uart_parity_t parity_bit; // Parity bit.
126  uart_stop_bits_t stop_bit; // Stop bits.
127 
128 } rs4855_cfg_t;
129 
133 typedef uint8_t rs4855_error_t;
134  // End types group
136 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
137 
143 #ifdef __cplusplus
144 extern "C"{
145 #endif
146 
155 void rs4855_cfg_setup ( rs4855_cfg_t *cfg );
156 
165 
172 void rs4855_generic_write ( rs4855_t *ctx, char *data_buf, uint16_t len );
173 
181 int32_t rs4855_generic_read ( rs4855_t *ctx, char *data_buf, uint16_t max_len );
182 
188 void rs4855_set_de_state( rs4855_t *ctx, uint8_t state );
189 
195 void rs4855_set_re_state( rs4855_t *ctx, uint8_t state );
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 #endif // _RS4855_H_
201  // End public_function group
204 
205 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4855.h:74
rs4855_cfg_t::re
pin_name_t re
Definition: rs4855.h:118
rs4855_cfg_t::de
pin_name_t de
Definition: rs4855.h:117
rs4855_cfg_setup
void rs4855_cfg_setup(rs4855_cfg_t *cfg)
Config Object Initialization function.
rs4855_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4855.h:125
rs4855_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4855.h:113
rs4855_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4855.h:124
rs4855_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4855.h:123
rs4855_generic_write
void rs4855_generic_write(rs4855_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rs4855_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs4855.h:112
rs4855_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4855.h:122
rs4855_t
Click ctx object definition.
Definition: rs4855.h:89
rs4855_set_re_state
void rs4855_set_re_state(rs4855_t *ctx, uint8_t state)
Sets RE pin to high or low state.
rs4855_t::uart
uart_t uart
Definition: rs4855.h:98
rs4855_cfg_t
Click configuration structure definition.
Definition: rs4855.h:108
rs4855_generic_read
int32_t rs4855_generic_read(rs4855_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
RS4855_RETVAL
#define RS4855_RETVAL
Definition: rs4855.h:64
rs4855_error_t
uint8_t rs4855_error_t
Error type.
Definition: rs4855.h:133
rs4855_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4855.h:126
rs4855_t::de
digital_out_t de
Definition: rs4855.h:93
rs4855_init
RS4855_RETVAL rs4855_init(rs4855_t *ctx, rs4855_cfg_t *cfg)
Initialization function.
rs4855_t::re
digital_out_t re
Definition: rs4855.h:94
rs4855_set_de_state
void rs4855_set_de_state(rs4855_t *ctx, uint8_t state)
Sets DE pin to high or low state.