rs4858 2.1.0.0
rs4858.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef RS4858_H
29#define RS4858_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
60#define RS4858_TX_DRV_BUFFER_SIZE 100
61#define RS4858_RX_DRV_BUFFER_SIZE 300
62 // rs4858_cmd
64
79#define RS4858_MAP_MIKROBUS( cfg, mikrobus ) \
80 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
81 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
82 cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
83 // rs4858_map // rs4858
86
91typedef struct
92{
93 // Output pins
94 digital_out_t en;
96 // Modules
97 uart_t uart;
99 // Buffers
100 uint8_t uart_rx_buffer[ RS4858_RX_DRV_BUFFER_SIZE ];
101 uint8_t uart_tx_buffer[ RS4858_TX_DRV_BUFFER_SIZE ];
103} rs4858_t;
104
109typedef struct
110{
111 // Communication gpio pins
112 pin_name_t rx_pin;
113 pin_name_t tx_pin;
115 // Additional gpio pins
116 pin_name_t en;
118 // Static variable
119 uint32_t baud_rate;
121 uart_data_bits_t data_bit;
122 uart_parity_t parity_bit;
123 uart_stop_bits_t stop_bit;
126
131typedef enum
132{
134 RS4858_ERROR = -1
135
137
154
168err_t rs4858_init ( rs4858_t *ctx, rs4858_cfg_t *cfg );
169
181
194err_t rs4858_generic_write ( rs4858_t *ctx, uint8_t *data_in, uint16_t len );
195
208err_t rs4858_generic_read ( rs4858_t *ctx, uint8_t *data_out, uint16_t len );
209
220
231
232#ifdef __cplusplus
233}
234#endif
235#endif // RS4858_H
236 // rs4858
238
239// ------------------------------------------------------------------------ END
#define RS4858_RX_DRV_BUFFER_SIZE
Definition: rs4858.h:61
#define RS4858_TX_DRV_BUFFER_SIZE
RS485 8 driver buffer size.
Definition: rs4858.h:60
void rs4858_enable_device(rs4858_t *ctx)
RS485 8 enable the device function.
err_t rs4858_init(rs4858_t *ctx, rs4858_cfg_t *cfg)
RS485 8 initialization function.
void rs4858_disable_device(rs4858_t *ctx)
RS485 8 disable the device function.
void rs4858_cfg_setup(rs4858_cfg_t *cfg)
RS485 8 configuration object setup function.
err_t rs4858_generic_write(rs4858_t *ctx, uint8_t *data_in, uint16_t len)
RS485 8 data writing function.
void rs4858_default_cfg(rs4858_t *ctx)
RS485 8 default configuration function.
err_t rs4858_generic_read(rs4858_t *ctx, uint8_t *data_out, uint16_t len)
RS485 8 data reading function.
rs4858_return_value_t
RS485 8 Click return value data.
Definition: rs4858.h:132
@ RS4858_OK
Definition: rs4858.h:133
@ RS4858_ERROR
Definition: rs4858.h:134
RS485 8 Click configuration object.
Definition: rs4858.h:110
uint32_t baud_rate
Definition: rs4858.h:119
bool uart_blocking
Definition: rs4858.h:120
uart_data_bits_t data_bit
Definition: rs4858.h:121
pin_name_t tx_pin
Definition: rs4858.h:113
pin_name_t rx_pin
Definition: rs4858.h:112
uart_stop_bits_t stop_bit
Definition: rs4858.h:123
pin_name_t en
Definition: rs4858.h:116
uart_parity_t parity_bit
Definition: rs4858.h:122
RS485 8 Click context object.
Definition: rs4858.h:92
uart_t uart
Definition: rs4858.h:97
digital_out_t en
Definition: rs4858.h:94