rtkbase  2.1.0.0
rtkbase.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 RTKBASE_H
29 #define RTKBASE_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
60 #define TX_DRV_BUFFER_SIZE 100
61 #define RX_DRV_BUFFER_SIZE 1000
62  // rtkbase_cmd
64 
79 #define RTKBASE_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
81  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
82  cfg.shd = MIKROBUS( mikrobus, MIKROBUS_AN ); \
83  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
84  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_CS ); \
85  cfg.bt = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
86  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
87  // rtkbase_map // rtkbase
90 
95 typedef struct
96 {
97  // Output pins
98  digital_out_t shd;
99  digital_out_t rst;
100  digital_out_t wup;
101  digital_out_t bt;
103  // Input pins
104  digital_in_t int_pin;
106  // Modules
107  uart_t uart;
109  // Buffers
110  char uart_rx_buffer[ RX_DRV_BUFFER_SIZE ];
111  char uart_tx_buffer[ TX_DRV_BUFFER_SIZE ];
113 } rtkbase_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t rx_pin;
123  pin_name_t tx_pin;
125  // Additional gpio pins
126  pin_name_t shd;
127  pin_name_t rst;
128  pin_name_t wup;
129  pin_name_t bt;
130  pin_name_t int_pin;
132  // Static variable
133  uint32_t baud_rate;
135  uart_data_bits_t data_bit;
136  uart_parity_t parity_bit;
137  uart_stop_bits_t stop_bit;
139 } rtkbase_cfg_t;
140 
145 typedef enum
146 {
148  RTKBASE_ERROR = -1
149 
151 
168 
182 err_t rtkbase_init ( rtkbase_t *ctx, rtkbase_cfg_t *cfg );
183 
196 err_t rtkbase_generic_write ( rtkbase_t *ctx, char *data_in, uint16_t len );
197 
210 err_t rtkbase_generic_read ( rtkbase_t *ctx, char *data_out, uint16_t len );
211 
221 
231 
241 
251 void rtkbase_set_rst_pin ( rtkbase_t *ctx, uint8_t state );
252 
262 void rtkbase_set_wup_pin ( rtkbase_t *ctx, uint8_t state );
263 
273 void rtkbase_set_boot_pin ( rtkbase_t *ctx, uint8_t state );
274 
284 void rtkbase_set_shd_pin ( rtkbase_t *ctx, uint8_t state );
285 
295 
305 uint32_t rtkbase_calculate_crc24( uint8_t *data_buf, uint16_t data_len );
306 
307 #ifdef __cplusplus
308 }
309 #endif
310 #endif // RTKBASE_H
311  // rtkbase
313 
314 // ------------------------------------------------------------------------ END
rtkbase_generic_read
err_t rtkbase_generic_read(rtkbase_t *ctx, char *data_out, uint16_t len)
RTK Base data reading function.
rtkbase_cfg_t::shd
pin_name_t shd
Definition: rtkbase.h:126
rtkbase_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rtkbase.h:137
rtkbase_calculate_crc24
uint32_t rtkbase_calculate_crc24(uint8_t *data_buf, uint16_t data_len)
RTK Base calculate crc24 function.
RTKBASE_ERROR
@ RTKBASE_ERROR
Definition: rtkbase.h:148
rtkbase_t::wup
digital_out_t wup
Definition: rtkbase.h:100
rtkbase_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rtkbase.h:136
rtkbase_set_rst_pin
void rtkbase_set_rst_pin(rtkbase_t *ctx, uint8_t state)
RTK Base set RST pin function.
RTKBASE_OK
@ RTKBASE_OK
Definition: rtkbase.h:147
rtkbase_cfg_t::uart_blocking
bool uart_blocking
Definition: rtkbase.h:134
rtkbase_cfg_t::bt
pin_name_t bt
Definition: rtkbase.h:129
rtkbase_init
err_t rtkbase_init(rtkbase_t *ctx, rtkbase_cfg_t *cfg)
RTK Base initialization function.
rtkbase_set_shd_pin
void rtkbase_set_shd_pin(rtkbase_t *ctx, uint8_t state)
RTK Base set SHD pin function.
rtkbase_set_boot_pin
void rtkbase_set_boot_pin(rtkbase_t *ctx, uint8_t state)
RTK Base set BOOT pin function.
rtkbase_cfg_t::rst
pin_name_t rst
Definition: rtkbase.h:127
rtkbase_set_wup_pin
void rtkbase_set_wup_pin(rtkbase_t *ctx, uint8_t state)
RTK Base set WUP pin function.
rtkbase_enable_rx_interrupt
void rtkbase_enable_rx_interrupt(rtkbase_t *ctx)
RTK Base enable rx interrupt function.
rtkbase_get_int_pin
uint8_t rtkbase_get_int_pin(rtkbase_t *ctx)
RTK Base get INT pin function.
rtkbase_t::rst
digital_out_t rst
Definition: rtkbase.h:99
rtkbase_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rtkbase.h:122
rtkbase_rx_bytes_available
err_t rtkbase_rx_bytes_available(rtkbase_t *ctx)
RTK Base rx bytes available function.
rtkbase_t::uart
uart_t uart
Definition: rtkbase.h:107
rtkbase_cfg_t::int_pin
pin_name_t int_pin
Definition: rtkbase.h:130
rtkbase_cfg_t::wup
pin_name_t wup
Definition: rtkbase.h:128
rtkbase_t::int_pin
digital_in_t int_pin
Definition: rtkbase.h:104
RX_DRV_BUFFER_SIZE
#define RX_DRV_BUFFER_SIZE
Definition: rtkbase.h:61
rtkbase_t::bt
digital_out_t bt
Definition: rtkbase.h:101
rtkbase_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rtkbase.h:135
rtkbase_clear_ring_buffers
void rtkbase_clear_ring_buffers(rtkbase_t *ctx)
RTK Base clear ring buffers function.
rtkbase_cfg_setup
void rtkbase_cfg_setup(rtkbase_cfg_t *cfg)
RTK Base configuration object setup function.
rtkbase_t::shd
digital_out_t shd
Definition: rtkbase.h:98
rtkbase_generic_write
err_t rtkbase_generic_write(rtkbase_t *ctx, char *data_in, uint16_t len)
RTK Base data writing function.
rtkbase_return_value_t
rtkbase_return_value_t
RTK Base Click return value data.
Definition: rtkbase.h:146
rtkbase_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rtkbase.h:123
rtkbase_t
RTK Base Click context object.
Definition: rtkbase.h:96
rtkbase_cfg_t
RTK Base Click configuration object.
Definition: rtkbase.h:120
TX_DRV_BUFFER_SIZE
#define TX_DRV_BUFFER_SIZE
RTK Base driver buffer size.
Definition: rtkbase.h:60
rtkbase_cfg_t::baud_rate
uint32_t baud_rate
Definition: rtkbase.h:133