lbandrtk  2.1.0.0
lbandrtk.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 LBANDRTK_H
29 #define LBANDRTK_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_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "drv_uart.h"
40 #include "spi_specifics.h"
41 
62 #define LBANDRTK_CLASS_ID_UBX_ACK 0x05
63 #define LBANDRTK_CLASS_ID_UBX_CFG 0x06
64 #define LBANDRTK_CLASS_ID_UBX_INF 0x04
65 #define LBANDRTK_CLASS_ID_UBX_MON 0x0A
66 #define LBANDRTK_CLASS_ID_UBX_RXM 0x02
67 #define LBANDRTK_MSG_ID_UBX_ACK_ACK 0x01
68 #define LBANDRTK_MSG_ID_UBX_ACK_NAK 0x00
69 #define LBANDRTK_MSG_ID_UBX_CFG_RST 0x04
70 #define LBANDRTK_MSG_ID_UBX_CFG_VALDEL 0x8C
71 #define LBANDRTK_MSG_ID_UBX_CFG_VALGET 0x8B
72 #define LBANDRTK_MSG_ID_UBX_CFG_VALSET 0x8A
73 #define LBANDRTK_MSG_ID_UBX_INF_ERROR 0x00
74 #define LBANDRTK_MSG_ID_UBX_INF_NOTICE 0x02
75 #define LBANDRTK_MSG_ID_UBX_INF_WARNING 0x01
76 #define LBANDRTK_MSG_ID_UBX_MON_HW2 0x0B
77 #define LBANDRTK_MSG_ID_UBX_MON_VER 0x04
78 #define LBANDRTK_MSG_ID_UBX_RXM_PMP 0x72
79 #define LBANDRTK_MSG_ID_UBX_RXM_PMREQ 0x41
80 
85 #define LBANDRTK_VER_CFG_POLL_REQUEST 0x00
86 #define LBANDRTK_VER_CFG_POLLED 0x01
87 #define LBANDRTK_LAYER_RAM 0x01
88 #define LBANDRTK_LAYER_BBR 0x02
89 #define LBANDRTK_LAYER_FLASH 0x04
90 #define LBANDRTK_LAYER_ALL 0x07
91 #define LBANDRTK_KEY_ID_SIZE_1_BIT 0x10000000ul
92 #define LBANDRTK_KEY_ID_SIZE_1_BYTE 0x20000000ul
93 #define LBANDRTK_KEY_ID_SIZE_2_BYTES 0x30000000ul
94 #define LBANDRTK_KEY_ID_SIZE_4_BYTES 0x40000000ul
95 #define LBANDRTK_KEY_ID_SIZE_8_BYTES 0x50000000ul
96 #define LBANDRTK_KEY_ID_SIZE_MASK 0x70000000ul
97 #define LBANDRTK_KEY_ID_GROUP_MASK 0x00FF0000ul
98 #define LBANDRTK_KEY_ID_ITEM_MASK 0x00000FFFul
99 #define LBANDRTK_CFG_PMP_CENTER_FREQUENCY 0x40B10011ul
100 #define LBANDRTK_CFG_PMP_SEARCH_WINDOW 0x30B10012ul
101 #define LBANDRTK_CFG_PMP_USE_SERVICE_ID 0x10B10016ul
102 #define LBANDRTK_CFG_PMP_SERVICE_ID 0x30B10017ul
103 #define LBANDRTK_CFG_PMP_DATA_RATE 0x30B10013ul
104 #define LBANDRTK_CFG_PMP_USE_DESCRAMBLER 0x10B10014ul
105 #define LBANDRTK_CFG_PMP_DESCRAMBLER_INIT 0x30B10015ul
106 #define LBANDRTK_CFG_PMP_USE_PRESCRAMBLING 0x10B10019ul
107 #define LBANDRTK_CFG_PMP_UNIQUE_WORD 0x50B1001Aul
108 
113 #define LBANDRTK_PREAMBLE_SYNC_CHAR_1 0xB5
114 #define LBANDRTK_PREAMBLE_SYNC_CHAR_2 0x62
115 
120 #define LBANDRTK_MAX_PAYLOAD_LEN 528u
121 
126 #define LBANDRTK_DUMMY 0xFF
127 
132 #define LBANDRTK_TIMEOUT 3000u
133 #define LBANDRTK_NUM_OF_RETRIES 5
134 
139 #define LBANDRTK_PMP_CENTER_FREQ_EU 1545260000ul
140 #define LBANDRTK_PMP_CENTER_FREQ_US 1556290000ul
141 #define LBANDRTK_PMP_CENTER_FREQ LBANDRTK_PMP_CENTER_FREQ_EU
142 #define LBANDRTK_PMP_SEARCH_WINDOW 2200u
143 #define LBANDRTK_PMP_USE_SERVICE_ID 0
144 #define LBANDRTK_PMP_SERVICE_ID 21845u
145 #define LBANDRTK_PMP_DATA_RATE 2400u
146 #define LBANDRTK_PMP_USE_DESCRAMBLER 1
147 #define LBANDRTK_PMP_DESCRAMBLER_INIT 26969u
148 #define LBANDRTK_PMP_USE_PRESCRAMBLING 0
149 #define LBANDRTK_PMP_UNIQUE_WORD_HIGH 0xE15AE893ul
150 #define LBANDRTK_PMP_UNIQUE_WORD_LOW 0xE15AE893ul
151 
156 #define LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA 504u
157 #define LBANDRTK_UBX_RXM_PMP_EBN0_SCALE 0.125f
158 
164 #define LBANDRTK_SET_DEV_ADDR 0x43
165 
171 #define LBANDRTK_DRV_TX_BUFFER_SIZE ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
172 #define LBANDRTK_DRV_RX_BUFFER_SIZE ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
173 
182 #define LBANDRTK_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
183 #define LBANDRTK_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
184  // lbandrtk_set
186 
201 #define LBANDRTK_MAP_MIKROBUS( cfg, mikrobus ) \
202  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
203  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
204  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
205  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
206  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
207  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
208  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
209  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
210  cfg.ein = MIKROBUS( mikrobus, MIKROBUS_AN ); \
211  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_PWM );
212  // lbandrtk_map // lbandrtk
215 
220 typedef enum
221 {
227 
232 typedef err_t ( *lbandrtk_master_io_t )( struct lbandrtk_s*, uint8_t*, uint16_t );
238 typedef union
239 {
240  uint8_t data_buf[ LBANDRTK_MAX_PAYLOAD_LEN + 8 ];
241  struct
242  {
243  uint16_t header;
245  uint8_t class_id;
246  uint8_t msg_id;
247  uint16_t payload_len;
248  uint8_t payload[ LBANDRTK_MAX_PAYLOAD_LEN + 2 ];
250  };
251 
253 
258 typedef struct
259 {
260  uint32_t center_freq;
261  uint16_t search_window;
263  uint8_t use_service_id;
264  uint16_t service_id;
265  uint16_t data_rate;
266  uint8_t use_descrambler;
267  uint16_t descrambler_init;
269  uint32_t unique_word_high;
270  uint32_t unique_word_low;
273 
278 typedef struct lbandrtk_s
279 {
280  digital_out_t rst;
281  digital_out_t ein;
283  i2c_master_t i2c;
284  spi_master_t spi;
285  uart_t uart;
287  // Buffers
291  uint8_t slave_address;
292  pin_name_t chip_select;
298 
300 
305 typedef struct
306 {
307  pin_name_t scl;
308  pin_name_t sda;
309  pin_name_t miso;
310  pin_name_t mosi;
311  pin_name_t sck;
312  pin_name_t cs;
313  pin_name_t rx_pin;
314  pin_name_t tx_pin;
316  pin_name_t rst;
317  pin_name_t ein;
319  uint32_t i2c_speed;
320  uint8_t i2c_address;
322  uint32_t spi_speed;
323  spi_master_mode_t spi_mode;
324  spi_master_chip_select_polarity_t cs_polarity;
326  uint32_t baud_rate;
328  uart_data_bits_t data_bit;
329  uart_parity_t parity_bit;
330  uart_stop_bits_t stop_bit;
335 
340 typedef enum
341 {
343  LBANDRTK_ERROR = -1
344 
346 
363 
379 
394 
407 err_t lbandrtk_generic_write ( lbandrtk_t *ctx, uint8_t *data_in, uint16_t len );
408 
421 err_t lbandrtk_generic_read ( lbandrtk_t *ctx, uint8_t *data_out, uint16_t len );
422 
436 
450 
460 void lbandrtk_set_rst_pin ( lbandrtk_t *ctx, uint8_t state );
461 
471 void lbandrtk_set_ein_pin ( lbandrtk_t *ctx, uint8_t state );
472 
482 
495 err_t lbandrtk_check_ack ( lbandrtk_t *ctx, uint8_t class_id, uint8_t msg_id );
496 
514 err_t lbandrtk_set_val_8 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t value );
515 
533 err_t lbandrtk_set_val_16 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t value );
534 
552 err_t lbandrtk_set_val_32 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value );
553 
572 err_t lbandrtk_set_val_64 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value_high, uint32_t value_low );
573 
590 err_t lbandrtk_get_val_8 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t *value );
591 
608 err_t lbandrtk_get_val_16 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t *value );
609 
626 err_t lbandrtk_get_val_32 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value );
627 
645 err_t lbandrtk_get_val_64 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value_high, uint32_t *value_low );
646 
658 
672 
686 
687 #ifdef __cplusplus
688 }
689 #endif
690 #endif // LBANDRTK_H
691  // lbandrtk
693 
694 // ------------------------------------------------------------------------ END
lbandrtk_cfg_setup
void lbandrtk_cfg_setup(lbandrtk_cfg_t *cfg)
LBAND RTK configuration object setup function.
lbandrtk_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: lbandrtk.h:323
lbandrtk_pmp_cfg_t::center_freq
uint32_t center_freq
Definition: lbandrtk.h:260
lbandrtk_s
LBAND RTK Click context object.
Definition: lbandrtk.h:279
lbandrtk_pmp_cfg_t
LBAND RTK Click CFG-PMP: Point to multipoint (PMP) configuration object.
Definition: lbandrtk.h:259
lbandrtk_cfg_t::ein
pin_name_t ein
Definition: lbandrtk.h:317
lbandrtk_cfg_t::rst
pin_name_t rst
Definition: lbandrtk.h:316
lbandrtk_reset_device
void lbandrtk_reset_device(lbandrtk_t *ctx)
LBAND RTK reset device function.
lbandrtk_s::frame
lbandrtk_ubx_frame_t frame
Definition: lbandrtk.h:297
lbandrtk_s::slave_address
uint8_t slave_address
Definition: lbandrtk.h:291
LBANDRTK_DRV_RX_BUFFER_SIZE
#define LBANDRTK_DRV_RX_BUFFER_SIZE
Definition: lbandrtk.h:172
lbandrtk_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lbandrtk.h:329
lbandrtk_ubx_frame_t::msg_id
uint8_t msg_id
Definition: lbandrtk.h:246
lbandrtk_pmp_cfg_t::use_prescrambling
uint8_t use_prescrambling
Definition: lbandrtk.h:268
spi_specifics.h
This file contains SPI specific macros, functions, etc.
lbandrtk_cfg_t::miso
pin_name_t miso
Definition: lbandrtk.h:309
lbandrtk_cfg_t::spi_speed
uint32_t spi_speed
Definition: lbandrtk.h:322
lbandrtk_cfg_t::scl
pin_name_t scl
Definition: lbandrtk.h:307
lbandrtk_cfg_t::cs
pin_name_t cs
Definition: lbandrtk.h:312
LBANDRTK_ERROR
@ LBANDRTK_ERROR
Definition: lbandrtk.h:343
lbandrtk_set_val_64
err_t lbandrtk_set_val_64(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value_high, uint32_t value_low)
LBAND RTK set val 64 function.
lbandrtk_cfg_t
LBAND RTK Click configuration object.
Definition: lbandrtk.h:306
lbandrtk_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lbandrtk.h:313
lbandrtk_cfg_t::mosi
pin_name_t mosi
Definition: lbandrtk.h:310
lbandrtk_s::uart_rx_buffer
char uart_rx_buffer[LBANDRTK_DRV_RX_BUFFER_SIZE]
Definition: lbandrtk.h:288
lbandrtk_s::uart_tx_buffer
char uart_tx_buffer[LBANDRTK_DRV_TX_BUFFER_SIZE]
Definition: lbandrtk.h:289
lbandrtk_cfg_t::uart_blocking
bool uart_blocking
Definition: lbandrtk.h:327
LBANDRTK_OK
@ LBANDRTK_OK
Definition: lbandrtk.h:342
lbandrtk_master_io_t
err_t(* lbandrtk_master_io_t)(struct lbandrtk_s *, uint8_t *, uint16_t)
LBAND RTK Click driver interface.
Definition: lbandrtk.h:232
lbandrtk_get_val_64
err_t lbandrtk_get_val_64(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value_high, uint32_t *value_low)
LBAND RTK get val 64 function.
lbandrtk_cfg_t::drv_sel
lbandrtk_drv_t drv_sel
Definition: lbandrtk.h:332
lbandrtk_set_val_8
err_t lbandrtk_set_val_8(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t value)
LBAND RTK set val 8 function.
lbandrtk_s::read_f
lbandrtk_master_io_t read_f
Definition: lbandrtk.h:296
lbandrtk_s::chip_select
pin_name_t chip_select
Definition: lbandrtk.h:292
lbandrtk_generic_read
err_t lbandrtk_generic_read(lbandrtk_t *ctx, uint8_t *data_out, uint16_t len)
LBAND RTK data reading function.
lbandrtk_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lbandrtk.h:330
lbandrtk_pmp_cfg_t::unique_word_low
uint32_t unique_word_low
Definition: lbandrtk.h:270
lbandrtk_s::rst
digital_out_t rst
Definition: lbandrtk.h:280
lbandrtk_return_value_t
lbandrtk_return_value_t
LBAND RTK Click return value data.
Definition: lbandrtk.h:341
lbandrtk_set_pmp_cfg
err_t lbandrtk_set_pmp_cfg(lbandrtk_t *ctx, lbandrtk_pmp_cfg_t pmp_cfg)
LBAND RTK set pmp cfg function.
lbandrtk_get_pmp_cfg
err_t lbandrtk_get_pmp_cfg(lbandrtk_t *ctx, lbandrtk_pmp_cfg_t *pmp_cfg)
LBAND RTK get pmp cfg function.
lbandrtk_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: lbandrtk.h:324
lbandrtk_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lbandrtk.h:328
lbandrtk_get_val_16
err_t lbandrtk_get_val_16(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t *value)
LBAND RTK get val 16 function.
lbandrtk_s::spi
spi_master_t spi
Definition: lbandrtk.h:284
lbandrtk_set_rst_pin
void lbandrtk_set_rst_pin(lbandrtk_t *ctx, uint8_t state)
LBAND RTK set rst pin function.
lbandrtk_s::i2c
i2c_master_t i2c
Definition: lbandrtk.h:283
lbandrtk_s::write_f
lbandrtk_master_io_t write_f
Definition: lbandrtk.h:295
LBANDRTK_MAX_PAYLOAD_LEN
#define LBANDRTK_MAX_PAYLOAD_LEN
LBAND RTK UBX max payload size.
Definition: lbandrtk.h:120
lbandrtk_set_ein_pin
void lbandrtk_set_ein_pin(lbandrtk_t *ctx, uint8_t state)
LBAND RTK set ein pin function.
lbandrtk_ubx_frame_t::class_id
uint8_t class_id
Definition: lbandrtk.h:245
lbandrtk_cfg_t::sda
pin_name_t sda
Definition: lbandrtk.h:308
LBANDRTK_DRV_SEL_I2C
@ LBANDRTK_DRV_SEL_I2C
Definition: lbandrtk.h:224
lbandrtk_s::drv_sel
lbandrtk_drv_t drv_sel
Definition: lbandrtk.h:293
lbandrtk_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: lbandrtk.h:319
lbandrtk_s::uart
uart_t uart
Definition: lbandrtk.h:285
lbandrtk_ubx_frame_t
LBAND RTK Click UBX frame union object.
Definition: lbandrtk.h:239
lbandrtk_generic_write
err_t lbandrtk_generic_write(lbandrtk_t *ctx, uint8_t *data_in, uint16_t len)
LBAND RTK data writing function.
lbandrtk_get_val_8
err_t lbandrtk_get_val_8(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t *value)
LBAND RTK get val 8 function.
lbandrtk_get_val_32
err_t lbandrtk_get_val_32(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value)
LBAND RTK get val 32 function.
lbandrtk_set_default_pmp_cfg
err_t lbandrtk_set_default_pmp_cfg(lbandrtk_t *ctx)
LBAND RTK set default pmp cfg function.
lbandrtk_drv_interface_selection
void lbandrtk_drv_interface_selection(lbandrtk_cfg_t *cfg, lbandrtk_drv_t drv_sel)
LBAND RTK driver interface setup function.
lbandrtk_pmp_cfg_t::use_descrambler
uint8_t use_descrambler
Definition: lbandrtk.h:266
lbandrtk_write_ubx_frame
err_t lbandrtk_write_ubx_frame(lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame)
LBAND RTK write ubx frame function.
LBANDRTK_DRV_TX_BUFFER_SIZE
#define LBANDRTK_DRV_TX_BUFFER_SIZE
LBAND RTK driver buffer size.
Definition: lbandrtk.h:171
lbandrtk_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lbandrtk.h:314
lbandrtk_pmp_cfg_t::unique_word_high
uint32_t unique_word_high
Definition: lbandrtk.h:269
LBANDRTK_DRV_SEL_SPI
@ LBANDRTK_DRV_SEL_SPI
Definition: lbandrtk.h:223
lbandrtk_pmp_cfg_t::search_window
uint16_t search_window
Definition: lbandrtk.h:261
lbandrtk_pmp_cfg_t::use_service_id
uint8_t use_service_id
Definition: lbandrtk.h:263
lbandrtk_set_val_32
err_t lbandrtk_set_val_32(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value)
LBAND RTK set val 32 function.
lbandrtk_check_ack
err_t lbandrtk_check_ack(lbandrtk_t *ctx, uint8_t class_id, uint8_t msg_id)
LBAND RTK check ack function.
lbandrtk_t
struct lbandrtk_s lbandrtk_t
LBAND RTK Click context object.
lbandrtk_drv_t
lbandrtk_drv_t
LBAND RTK Click driver selector.
Definition: lbandrtk.h:221
lbandrtk_s::ein
digital_out_t ein
Definition: lbandrtk.h:281
LBANDRTK_DRV_SEL_UART
@ LBANDRTK_DRV_SEL_UART
Definition: lbandrtk.h:222
lbandrtk_cfg_t::i2c_address
uint8_t i2c_address
Definition: lbandrtk.h:320
lbandrtk_ubx_frame_t::payload_len
uint16_t payload_len
Definition: lbandrtk.h:247
lbandrtk_cfg_t::sck
pin_name_t sck
Definition: lbandrtk.h:311
lbandrtk_pmp_cfg_t::descrambler_init
uint16_t descrambler_init
Definition: lbandrtk.h:267
lbandrtk_set_val_16
err_t lbandrtk_set_val_16(lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t value)
LBAND RTK set val 16 function.
lbandrtk_ubx_frame_t::header
uint16_t header
Definition: lbandrtk.h:243
lbandrtk_init
err_t lbandrtk_init(lbandrtk_t *ctx, lbandrtk_cfg_t *cfg)
LBAND RTK initialization function.
lbandrtk_pmp_cfg_t::data_rate
uint16_t data_rate
Definition: lbandrtk.h:265
lbandrtk_cfg_t::baud_rate
uint32_t baud_rate
Definition: lbandrtk.h:326
lbandrtk_pmp_cfg_t::service_id
uint16_t service_id
Definition: lbandrtk.h:264
lbandrtk_read_ubx_frame
err_t lbandrtk_read_ubx_frame(lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame)
LBAND RTK read ubx frame function.