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 
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 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define RS4855_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
69  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.de = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.re = MIKROBUS( mikrobus, MIKROBUS_CS )
72 
78 #define RS4855_RETVAL uint8_t
79 
80 #define RS4855_OK 0x00
81 #define RS4855_INIT_ERROR 0xFF
82 
88 #define DRV_RX_BUFFER_SIZE 500
89 
91 #define RS4855_PIN_STATE_HIGH 1
92 #define RS4855_PIN_STATE_LOW 0
93  // End group macro
95 // --------------------------------------------------------------- PUBLIC TYPES
103 typedef struct
104 {
105  // Output pins
106 
107  digital_out_t de;
108  digital_out_t re;
109 
110  // Modules
111 
112  uart_t uart;
113 
114  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
115  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
116 
117 } rs4855_t;
118 
122 typedef struct
123 {
124  // Communication gpio pins
125 
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
128 
129  // Additional gpio pins
130 
131  pin_name_t de;
132  pin_name_t re;
133 
134  // static variable
135 
136  uint32_t baud_rate; // Clock speed.
138  uart_data_bits_t data_bit; // Data bits.
139  uart_parity_t parity_bit; // Parity bit.
140  uart_stop_bits_t stop_bit; // Stop bits.
141 
142 } rs4855_cfg_t;
143 
147 typedef uint8_t rs4855_error_t;
148  // End types group
150 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
151 
157 #ifdef __cplusplus
158 extern "C"{
159 #endif
160 
170 
179 
186 void rs4855_generic_write ( rs4855_t *ctx, char *data_buf, uint16_t len );
187 
195 int32_t rs4855_generic_read ( rs4855_t *ctx, char *data_buf, uint16_t max_len );
196 
202 void rs4855_set_de_state( rs4855_t *ctx, uint8_t state );
203 
209 void rs4855_set_re_state( rs4855_t *ctx, uint8_t state );
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 #endif // _RS4855_H_
215  // End public_function group
218 
219 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4855.h:88
rs4855_cfg_t::re
pin_name_t re
Definition: rs4855.h:132
rs4855_cfg_t::de
pin_name_t de
Definition: rs4855.h:131
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:139
rs4855_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4855.h:127
rs4855_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4855.h:138
rs4855_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4855.h:137
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:126
rs4855_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4855.h:136
rs4855_t
Click ctx object definition.
Definition: rs4855.h:104
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:112
rs4855_cfg_t
Click configuration structure definition.
Definition: rs4855.h:123
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:78
rs4855_error_t
uint8_t rs4855_error_t
Error type.
Definition: rs4855.h:147
rs4855_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4855.h:140
rs4855_t::de
digital_out_t de
Definition: rs4855.h:107
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:108
rs4855_set_de_state
void rs4855_set_de_state(rs4855_t *ctx, uint8_t state)
Sets DE pin to high or low state.