iqrf2  2.0.0.0
iqrf2.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  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef IQRF2_H
35 #define IQRF2_H
36 
37 #include "mikrosdk_version.h"
38 
39 #ifdef __GNUC__
40 #if mikroSDK_GET_VERSION < 20800ul
41 #include "rcu_delays.h"
42 #else
43 #include "delays.h"
44 #endif
45 #endif
46 
47 #include "drv_digital_out.h"
48 #include "drv_digital_in.h"
49 #include "drv_uart.h"
50 
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define IQRF2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
65 
71 #define IQRF2_RETVAL uint8_t
72 
73 #define IQRF2_OK 0x00
74 #define IQRF2_INIT_ERROR 0xFF
75 
81 #define DRV_RX_BUFFER_SIZE 500
82  // End group macro
85 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95  // Modules
96 
97  uart_t uart;
98 
99  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
100  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
101 
102 } iqrf2_t;
103 
107 typedef struct
108 {
109  // Communication gpio pins
110 
111  pin_name_t rx_pin;
112  pin_name_t tx_pin;
113 
114  // static variable
115 
116  uint32_t baud_rate; // Clock speed.
118  uart_data_bits_t data_bit; // Data bits.
119  uart_parity_t parity_bit; // Parity bit.
120  uart_stop_bits_t stop_bit; // Stop bits.
121 
122 } iqrf2_cfg_t;
123 
127 typedef uint8_t iqrf2_error_t;
128  // End types group
130 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
131 
137 #ifdef __cplusplus
138 extern "C"{
139 #endif
140 
150 
159 
166 void iqrf2_generic_write ( iqrf2_t *ctx, char *data_buf, uint16_t len );
167 
175 int32_t iqrf2_generic_read ( iqrf2_t *ctx, char *data_buf, uint16_t max_len );
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 #endif // _IQRF2_H_
181  // End public_function group
184 
185 // ------------------------------------------------------------------------- END
IQRF2_RETVAL
#define IQRF2_RETVAL
Definition: iqrf2.h:71
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: iqrf2.h:81
iqrf2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: iqrf2.h:119
iqrf2_cfg_t::baud_rate
uint32_t baud_rate
Definition: iqrf2.h:116
iqrf2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: iqrf2.h:118
iqrf2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: iqrf2.h:120
iqrf2_init
IQRF2_RETVAL iqrf2_init(iqrf2_t *ctx, iqrf2_cfg_t *cfg)
Initialization function.
iqrf2_cfg_t
Click configuration structure definition.
Definition: iqrf2.h:108
iqrf2_error_t
uint8_t iqrf2_error_t
Error type.
Definition: iqrf2.h:127
iqrf2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: iqrf2.h:111
iqrf2_t::uart
uart_t uart
Definition: iqrf2.h:97
iqrf2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: iqrf2.h:112
iqrf2_cfg_setup
void iqrf2_cfg_setup(iqrf2_cfg_t *cfg)
Config Object Initialization function.
iqrf2_generic_read
int32_t iqrf2_generic_read(iqrf2_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
iqrf2_generic_write
void iqrf2_generic_write(iqrf2_t *ctx, char *data_buf, uint16_t len)
Generic write function.
iqrf2_cfg_t::uart_blocking
bool uart_blocking
Definition: iqrf2.h:117
iqrf2_t
Click ctx object definition.
Definition: iqrf2.h:94