rs4856  2.0.0.0
rs4856.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 RS4856_H
36 #define RS4856_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 RS4856_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.re = MIKROBUS( mikrobus, MIKROBUS_CS ); \
70  cfg.de = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define RS4856_RETVAL uint8_t
78 
79 #define RS4856_OK 0x00
80 #define RS4856_INIT_ERROR 0xFF
81 
87 #define DRV_RX_BUFFER_SIZE 500
88 
94 #define RS4856_PIN_STATE_LOW 0
95 #define RS4856_PIN_STATE_HIGH 1
96  // End group macro
99 // --------------------------------------------------------------- PUBLIC TYPES
107 typedef struct
108 {
109  // Output pins
110 
111  digital_out_t re;
112  digital_out_t de;
113 
114  // Modules
115 
116  uart_t uart;
117 
118  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
119  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
120 
121 } rs4856_t;
122 
126 typedef struct
127 {
128  // Communication gpio pins
129 
130  pin_name_t rx_pin;
131  pin_name_t tx_pin;
132 
133  // Additional gpio pins
134 
135  pin_name_t re;
136  pin_name_t de;
137 
138  // static variable
139 
140  uint32_t baud_rate; // Clock speed.
142  uart_data_bits_t data_bit; // Data bits.
143  uart_parity_t parity_bit; // Parity bit.
144  uart_stop_bits_t stop_bit; // Stop bits.
145 
146 } rs4856_cfg_t;
147 
151 typedef uint8_t rs4856_error_t;
152  // End types group
154 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
174 
184 
192 void rs4856_generic_write ( rs4856_t *ctx, char *data_buf, uint16_t len );
193 
202 int16_t rs4856_generic_read ( rs4856_t *ctx, char *data_buf, uint16_t max_len );
203 
211 void rs4856_re_pin_set (rs4856_t *ctx, uint8_t pin_state );
212 
220 void rs4856_de_pin_set ( rs4856_t *ctx, uint8_t pin_state );
221 
222 void rs4856_send_command ( rs4856_t *ctx, char *command );
223 
224 #ifdef __cplusplus
225 }
226 #endif
227 #endif // _RS4856_H_
228  // End public_function group
231 
232 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rs4856.h:87
rs4856_error_t
uint8_t rs4856_error_t
Error type.
Definition: rs4856.h:151
rs4856_t::de
digital_out_t de
Definition: rs4856.h:112
rs4856_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4856.h:142
rs4856_cfg_setup
void rs4856_cfg_setup(rs4856_cfg_t *cfg)
Config Object Initialization function.
rs4856_re_pin_set
void rs4856_re_pin_set(rs4856_t *ctx, uint8_t pin_state)
Sets RE pin to high or low state.
rs4856_de_pin_set
void rs4856_de_pin_set(rs4856_t *ctx, uint8_t pin_state)
Sets DE pin to high or low state.
rs4856_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs4856.h:130
rs4856_cfg_t::de
pin_name_t de
Definition: rs4856.h:136
rs4856_generic_write
void rs4856_generic_write(rs4856_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rs4856_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4856.h:140
rs4856_t::uart
uart_t uart
Definition: rs4856.h:116
rs4856_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4856.h:143
rs4856_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4856.h:144
rs4856_t::re
digital_out_t re
Definition: rs4856.h:111
rs4856_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4856.h:131
rs4856_t
Click ctx object definition.
Definition: rs4856.h:108
rs4856_cfg_t
Click configuration structure definition.
Definition: rs4856.h:127
rs4856_send_command
void rs4856_send_command(rs4856_t *ctx, char *command)
rs4856_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4856.h:141
rs4856_cfg_t::re
pin_name_t re
Definition: rs4856.h:135
rs4856_generic_read
int16_t rs4856_generic_read(rs4856_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rs4856_init
RS4856_RETVAL rs4856_init(rs4856_t *ctx, rs4856_cfg_t *cfg)
Initialization function.
RS4856_RETVAL
#define RS4856_RETVAL
Definition: rs4856.h:77