binhonova  2.1.0.0
binhonova.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 BINHONOVA_H
29 #define BINHONOVA_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
70 #define BINHONOVA_TX_DRV_BUFFER_SIZE 100
71 #define BINHONOVA_RX_DRV_BUFFER_SIZE 300
72  // binhonova_cmd
74 
89 #define BINHONOVA_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
91  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
92  // binhonova_map // binhonova
95 
100 typedef struct
101 {
102  // Modules
103  uart_t uart;
105  // Buffers
106  uint8_t uart_rx_buffer[ BINHONOVA_RX_DRV_BUFFER_SIZE ];
107  uint8_t uart_tx_buffer[ BINHONOVA_TX_DRV_BUFFER_SIZE ];
109 } binhonova_t;
110 
115 typedef struct
116 {
117  // Communication gpio pins
118  pin_name_t rx_pin;
119  pin_name_t tx_pin;
121  // Static variable
122  uint32_t baud_rate;
124  uart_data_bits_t data_bit;
125  uart_parity_t parity_bit;
126  uart_stop_bits_t stop_bit;
129 
134 typedef enum
135 {
137  BINHONOVA_ERROR = -1
138 
140 
157 
172 
185 err_t binhonova_generic_write ( binhonova_t *ctx, uint8_t *data_in, uint16_t len );
186 
199 err_t binhonova_generic_read ( binhonova_t *ctx, uint8_t *data_out, uint16_t len );
200 
201 #ifdef __cplusplus
202 }
203 #endif
204 #endif // BINHONOVA_H
205  // binhonova
207 
208 // ------------------------------------------------------------------------ END
binhonova_return_value_t
binhonova_return_value_t
Binho Nova Click return value data.
Definition: binhonova.h:135
binhonova_cfg_t::uart_blocking
bool uart_blocking
Definition: binhonova.h:123
binhonova_t::uart
uart_t uart
Definition: binhonova.h:103
BINHONOVA_TX_DRV_BUFFER_SIZE
#define BINHONOVA_TX_DRV_BUFFER_SIZE
Binho Nova driver buffer size.
Definition: binhonova.h:70
binhonova_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: binhonova.h:124
binhonova_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: binhonova.h:125
binhonova_cfg_t
Binho Nova Click configuration object.
Definition: binhonova.h:116
binhonova_generic_read
err_t binhonova_generic_read(binhonova_t *ctx, uint8_t *data_out, uint16_t len)
Binho Nova data reading function.
binhonova_t
Binho Nova Click context object.
Definition: binhonova.h:101
binhonova_cfg_setup
void binhonova_cfg_setup(binhonova_cfg_t *cfg)
Binho Nova configuration object setup function.
binhonova_cfg_t::tx_pin
pin_name_t tx_pin
Definition: binhonova.h:119
BINHONOVA_OK
@ BINHONOVA_OK
Definition: binhonova.h:136
binhonova_init
err_t binhonova_init(binhonova_t *ctx, binhonova_cfg_t *cfg)
Binho Nova initialization function.
binhonova_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: binhonova.h:126
BINHONOVA_RX_DRV_BUFFER_SIZE
#define BINHONOVA_RX_DRV_BUFFER_SIZE
Definition: binhonova.h:71
BINHONOVA_ERROR
@ BINHONOVA_ERROR
Definition: binhonova.h:137
binhonova_cfg_t::baud_rate
uint32_t baud_rate
Definition: binhonova.h:122
binhonova_cfg_t::rx_pin
pin_name_t rx_pin
Definition: binhonova.h:118
binhonova_generic_write
err_t binhonova_generic_write(binhonova_t *ctx, uint8_t *data_in, uint16_t len)
Binho Nova data writing function.