mbusslave 2.0.0.0
mbusslave.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 MBUSSLAVE_H
36#define MBUSSLAVE_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_uart.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define MBUSSLAVE_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
61#define MBUSSLAVE_RETVAL uint8_t
62
63#define MBUSSLAVE_OK 0x00
64#define MBUSSLAVE_INIT_ERROR 0xFF
71#define DRV_RX_BUFFER_SIZE 500 // End group macro
75// --------------------------------------------------------------- PUBLIC TYPES
83typedef struct
84{
85 // Modules
86
87 uart_t uart;
88
89 char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
90 char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
91
93
97typedef struct
98{
99 // Communication gpio pins
100
101 pin_name_t rx_pin;
102 pin_name_t tx_pin;
103
104 // static variable
105
106 uint32_t baud_rate; // Clock speed.
108 uart_data_bits_t data_bit; // Data bits.
109 uart_parity_t parity_bit; // Parity bit.
110 uart_stop_bits_t stop_bit; // Stop bits.
111
113
117typedef uint8_t mbusslave_error_t;
118 // End types group
120// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121
127#ifdef __cplusplus
128extern "C"{
129#endif
130
140
149
156void mbusslave_generic_write ( mbusslave_t *ctx, char *data_buf, uint16_t len );
157
165int32_t mbusslave_generic_read ( mbusslave_t *ctx, char *data_buf, uint16_t max_len );
166
167#ifdef __cplusplus
168}
169#endif
170#endif // _MBUSSLAVE_H_
171 // End public_function group
174
175// ------------------------------------------------------------------------- END
#define DRV_RX_BUFFER_SIZE
Definition: mbusslave.h:71
#define MBUSSLAVE_RETVAL
Definition: mbusslave.h:61
MBUSSLAVE_RETVAL mbusslave_init(mbusslave_t *ctx, mbusslave_cfg_t *cfg)
Initialization function.
void mbusslave_cfg_setup(mbusslave_cfg_t *cfg)
Config Object Initialization function.
int32_t mbusslave_generic_read(mbusslave_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
void mbusslave_generic_write(mbusslave_t *ctx, char *data_buf, uint16_t len)
Generic write function.
uint8_t mbusslave_error_t
Error type.
Definition: mbusslave.h:117
Click configuration structure definition.
Definition: mbusslave.h:98
uint32_t baud_rate
Definition: mbusslave.h:106
bool uart_blocking
Definition: mbusslave.h:107
uart_data_bits_t data_bit
Definition: mbusslave.h:108
pin_name_t tx_pin
Definition: mbusslave.h:102
pin_name_t rx_pin
Definition: mbusslave.h:101
uart_stop_bits_t stop_bit
Definition: mbusslave.h:110
uart_parity_t parity_bit
Definition: mbusslave.h:109
Click ctx object definition.
Definition: mbusslave.h:84
uart_t uart
Definition: mbusslave.h:87