iqrf  2.0.0.0
iqrf.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 IQRF_H
35 #define IQRF_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 IQRF_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.adc = MIKROBUS( mikrobus, MIKROBUS_AN ); \
70  cfg.io = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
74 
80 #define IQRF_RETVAL uint8_t
81 
82 #define IQRF_OK 0x00
83 #define IQRF_INIT_ERROR 0xFF
84 
90 #define DRV_RX_BUFFER_SIZE 500
91  // End group macro
94 
95 // --------------------------------------------------------------- PUBLIC TYPES
105 typedef struct
106 {
107  // Output pins
108 
109  digital_out_t io;
110  digital_out_t cs;
111  digital_out_t pwm;
112 
113  // Input pins
114 
115  digital_in_t adc;
116  digital_in_t int_pin;
117 
118  // Modules
119 
120  uart_t uart;
121 
122  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
123  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
124 
125 } iqrf_t;
126 
130 typedef struct
131 {
132  // Communication gpio pins
133 
134  pin_name_t rx_pin;
135  pin_name_t tx_pin;
136 
137  // Additional gpio pins
138 
139  pin_name_t adc;
140  pin_name_t io;
141  pin_name_t cs;
142  pin_name_t pwm;
143  pin_name_t int_pin;
144 
145  // Static variable
146 
147  uint32_t baud_rate; // Clock speed.
149  uart_data_bits_t data_bit; // Data bits.
150  uart_parity_t parity_bit; // Parity bit.
151  uart_stop_bits_t stop_bit; // Stop bits.
152 
153 } iqrf_cfg_t;
154  // End types group
156 
157 // ------------------------------------------------------------------ CONSTANTS // End constants group
165 
166 // ------------------------------------------------------------------ VARIABLES // End variable group
174 
175 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
176 
182 #ifdef __cplusplus
183 extern "C"{
184 #endif
185 
195 
204 
218 void iqrf_default_cfg ( iqrf_t *ctx );
219 
229 void iqrf_generic_multi_write ( iqrf_t *ctx, char *data_buf, uint8_t len );
230 
240 void iqrf_generic_multi_read ( iqrf_t *ctx, char *data_buf, uint8_t len );
241 
251 
260 void iqrf_generic_single_write ( iqrf_t *ctx, char tx_data );
261 
278 uint8_t iqrf_get_interrupt ( iqrf_t *ctx );
279 
287 void iqrf_hw_reset ( iqrf_t *ctx );
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 #endif // _IQRF_H_
293  // End public_function group
296 
297 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: iqrf.h:90
iqrf_cfg_t::tx_pin
pin_name_t tx_pin
Definition: iqrf.h:135
iqrf_t::adc
digital_in_t adc
Definition: iqrf.h:115
iqrf_default_cfg
void iqrf_default_cfg(iqrf_t *ctx)
Click Default Configuration function.
iqrf_cfg_t::rx_pin
pin_name_t rx_pin
Definition: iqrf.h:134
iqrf_t::io
digital_out_t io
Definition: iqrf.h:109
iqrf_t
Click ctx object definition.
Definition: iqrf.h:106
iqrf_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: iqrf.h:150
iqrf_t::pwm
digital_out_t pwm
Definition: iqrf.h:111
iqrf_get_interrupt
uint8_t iqrf_get_interrupt(iqrf_t *ctx)
Interrupt function.
iqrf_init
IQRF_RETVAL iqrf_init(iqrf_t *ctx, iqrf_cfg_t *cfg)
Initialization function.
iqrf_cfg_t
Click configuration structure definition.
Definition: iqrf.h:131
iqrf_generic_single_read
char iqrf_generic_single_read(iqrf_t *ctx)
Generic single read function.
iqrf_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: iqrf.h:149
IQRF_RETVAL
#define IQRF_RETVAL
Definition: iqrf.h:80
iqrf_hw_reset
void iqrf_hw_reset(iqrf_t *ctx)
Hardware reset function.
iqrf_t::int_pin
digital_in_t int_pin
Definition: iqrf.h:116
iqrf_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: iqrf.h:151
iqrf_cfg_t::int_pin
pin_name_t int_pin
Definition: iqrf.h:143
iqrf_cfg_t::baud_rate
uint32_t baud_rate
Definition: iqrf.h:147
iqrf_cfg_t::uart_blocking
bool uart_blocking
Definition: iqrf.h:148
iqrf_t::uart
uart_t uart
Definition: iqrf.h:120
iqrf_generic_multi_write
void iqrf_generic_multi_write(iqrf_t *ctx, char *data_buf, uint8_t len)
Generic multi write function.
iqrf_t::cs
digital_out_t cs
Definition: iqrf.h:110
iqrf_cfg_t::cs
pin_name_t cs
Definition: iqrf.h:141
iqrf_generic_single_write
void iqrf_generic_single_write(iqrf_t *ctx, char tx_data)
Generic single write function.
iqrf_cfg_setup
void iqrf_cfg_setup(iqrf_cfg_t *cfg)
Config Object Initialization function.
iqrf_cfg_t::adc
pin_name_t adc
Definition: iqrf.h:139
iqrf_generic_multi_read
void iqrf_generic_multi_read(iqrf_t *ctx, char *data_buf, uint8_t len)
Generic multi read function.
iqrf_cfg_t::pwm
pin_name_t pwm
Definition: iqrf.h:142
iqrf_cfg_t::io
pin_name_t io
Definition: iqrf.h:140