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 
41 #ifdef PREINIT_SUPPORTED
42 #include "preinit.h"
43 #endif
44 
45 #ifdef MikroCCoreVersion
46  #if MikroCCoreVersion >= 1
47  #include "delays.h"
48  #endif
49 #endif
50 
51 #include "drv_digital_out.h"
52 #include "drv_digital_in.h"
53 #include "drv_uart.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define IQRF2_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
69 
75 #define IQRF2_RETVAL uint8_t
76 
77 #define IQRF2_OK 0x00
78 #define IQRF2_INIT_ERROR 0xFF
79 
85 #define DRV_RX_BUFFER_SIZE 500
86  // End group macro
89 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99  // Modules
100 
101  uart_t uart;
102 
103  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
104  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
105 
106 } iqrf2_t;
107 
111 typedef struct
112 {
113  // Communication gpio pins
114 
115  pin_name_t rx_pin;
116  pin_name_t tx_pin;
117 
118  // static variable
119 
120  uint32_t baud_rate; // Clock speed.
122  uart_data_bits_t data_bit; // Data bits.
123  uart_parity_t parity_bit; // Parity bit.
124  uart_stop_bits_t stop_bit; // Stop bits.
125 
126 } iqrf2_cfg_t;
127 
131 typedef uint8_t iqrf2_error_t;
132  // End types group
134 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
135 
141 #ifdef __cplusplus
142 extern "C"{
143 #endif
144 
154 
163 
170 void iqrf2_generic_write ( iqrf2_t *ctx, char *data_buf, uint16_t len );
171 
179 int32_t iqrf2_generic_read ( iqrf2_t *ctx, char *data_buf, uint16_t max_len );
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 #endif // _IQRF2_H_
185  // End public_function group
188 
189 // ------------------------------------------------------------------------- END
IQRF2_RETVAL
#define IQRF2_RETVAL
Definition: iqrf2.h:75
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: iqrf2.h:85
iqrf2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: iqrf2.h:123
iqrf2_cfg_t::baud_rate
uint32_t baud_rate
Definition: iqrf2.h:120
iqrf2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: iqrf2.h:122
iqrf2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: iqrf2.h:124
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:112
iqrf2_error_t
uint8_t iqrf2_error_t
Error type.
Definition: iqrf2.h:131
iqrf2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: iqrf2.h:115
iqrf2_t::uart
uart_t uart
Definition: iqrf2.h:101
iqrf2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: iqrf2.h:116
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:121
iqrf2_t
Click ctx object definition.
Definition: iqrf2.h:98