mbusmaster  2.0.0.0
mbusmaster.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 MBUSMASTER_H
36 #define MBUSMASTER_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 MBUSMASTER_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
56 
62 #define MBUSMASTER_RETVAL uint8_t
63 
64 #define MBUSMASTER_OK 0x00
65 #define MBUSMASTER_INIT_ERROR 0xFF
66 
72 #define DRV_RX_BUFFER_SIZE 500
73  // End group macro
76 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  //digital_in_t int_pin;
89 
90  // Modules
91 
92  uart_t uart;
93 
94  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
95  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
96 
97 } mbusmaster_t;
98 
102 typedef struct
103 {
104  // Communication gpio pins
105 
106  pin_name_t rx_pin;
107  pin_name_t tx_pin;
108 
109  // static variable
110 
111  uint32_t baud_rate; // Clock speed.
113  uart_data_bits_t data_bit; // Data bits.
114  uart_parity_t parity_bit; // Parity bit.
115  uart_stop_bits_t stop_bit; // Stop bits.
116 
118  // End types group
120 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 
149 
156 void mbusmaster_generic_write ( mbusmaster_t *ctx, char *data_buf, uint16_t len );
157 
165 int32_t mbusmaster_generic_read ( mbusmaster_t *ctx, char *data_buf, uint16_t max_len );
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 #endif // _MBUSMASTER_H_
171  // End public_function group
174 
175 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: mbusmaster.h:72
mbusmaster_generic_read
int32_t mbusmaster_generic_read(mbusmaster_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
mbusmaster_cfg_t::tx_pin
pin_name_t tx_pin
Definition: mbusmaster.h:107
mbusmaster_cfg_t::uart_blocking
bool uart_blocking
Definition: mbusmaster.h:112
mbusmaster_generic_write
void mbusmaster_generic_write(mbusmaster_t *ctx, char *data_buf, uint16_t len)
Generic write function.
mbusmaster_t::uart
uart_t uart
Definition: mbusmaster.h:92
mbusmaster_cfg_t::baud_rate
uint32_t baud_rate
Definition: mbusmaster.h:111
mbusmaster_init
MBUSMASTER_RETVAL mbusmaster_init(mbusmaster_t *ctx, mbusmaster_cfg_t *cfg)
Initialization function.
mbusmaster_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: mbusmaster.h:114
MBUSMASTER_RETVAL
#define MBUSMASTER_RETVAL
Definition: mbusmaster.h:62
mbusmaster_cfg_setup
void mbusmaster_cfg_setup(mbusmaster_cfg_t *cfg)
Config Object Initialization function.
mbusmaster_t
Click ctx object definition.
Definition: mbusmaster.h:87
mbusmaster_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: mbusmaster.h:115
mbusmaster_cfg_t
Click configuration structure definition.
Definition: mbusmaster.h:103
mbusmaster_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: mbusmaster.h:113
mbusmaster_cfg_t::rx_pin
pin_name_t rx_pin
Definition: mbusmaster.h:106