Go to the documentation of this file.
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
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
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
113 #define LBANDRTK_PREAMBLE_SYNC_CHAR_1 0xB5
114 #define LBANDRTK_PREAMBLE_SYNC_CHAR_2 0x62
120 #define LBANDRTK_MAX_PAYLOAD_LEN 528u
126 #define LBANDRTK_DUMMY 0xFF
132 #define LBANDRTK_TIMEOUT 3000u
133 #define LBANDRTK_NUM_OF_RETRIES 5
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
156 #define LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA 504u
157 #define LBANDRTK_UBX_RXM_PMP_EBN0_SCALE 0.125f
164 #define LBANDRTK_SET_DEV_ADDR 0x43
171 #define LBANDRTK_DRV_TX_BUFFER_SIZE ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
172 #define LBANDRTK_DRV_RX_BUFFER_SIZE ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
182 #define LBANDRTK_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
183 #define LBANDRTK_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
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 );
void lbandrtk_cfg_setup(lbandrtk_cfg_t *cfg)
LBAND RTK configuration object setup function.
spi_master_mode_t spi_mode
Definition: lbandrtk.h:323
uint32_t center_freq
Definition: lbandrtk.h:260
LBAND RTK Click context object.
Definition: lbandrtk.h:279
LBAND RTK Click CFG-PMP: Point to multipoint (PMP) configuration object.
Definition: lbandrtk.h:259
pin_name_t ein
Definition: lbandrtk.h:317
pin_name_t rst
Definition: lbandrtk.h:316
void lbandrtk_reset_device(lbandrtk_t *ctx)
LBAND RTK reset device function.
lbandrtk_ubx_frame_t frame
Definition: lbandrtk.h:297
uint8_t slave_address
Definition: lbandrtk.h:291
#define LBANDRTK_DRV_RX_BUFFER_SIZE
Definition: lbandrtk.h:172
uart_parity_t parity_bit
Definition: lbandrtk.h:329
uint8_t msg_id
Definition: lbandrtk.h:246
uint8_t use_prescrambling
Definition: lbandrtk.h:268
This file contains SPI specific macros, functions, etc.
pin_name_t miso
Definition: lbandrtk.h:309
uint32_t spi_speed
Definition: lbandrtk.h:322
pin_name_t scl
Definition: lbandrtk.h:307
pin_name_t cs
Definition: lbandrtk.h:312
@ LBANDRTK_ERROR
Definition: lbandrtk.h:343
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.
LBAND RTK Click configuration object.
Definition: lbandrtk.h:306
pin_name_t rx_pin
Definition: lbandrtk.h:313
pin_name_t mosi
Definition: lbandrtk.h:310
char uart_rx_buffer[LBANDRTK_DRV_RX_BUFFER_SIZE]
Definition: lbandrtk.h:288
char uart_tx_buffer[LBANDRTK_DRV_TX_BUFFER_SIZE]
Definition: lbandrtk.h:289
bool uart_blocking
Definition: lbandrtk.h:327
@ LBANDRTK_OK
Definition: lbandrtk.h:342
err_t(* lbandrtk_master_io_t)(struct lbandrtk_s *, uint8_t *, uint16_t)
LBAND RTK Click driver interface.
Definition: lbandrtk.h:232
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_drv_t drv_sel
Definition: lbandrtk.h:332
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_master_io_t read_f
Definition: lbandrtk.h:296
pin_name_t chip_select
Definition: lbandrtk.h:292
err_t lbandrtk_generic_read(lbandrtk_t *ctx, uint8_t *data_out, uint16_t len)
LBAND RTK data reading function.
uart_stop_bits_t stop_bit
Definition: lbandrtk.h:330
uint32_t unique_word_low
Definition: lbandrtk.h:270
digital_out_t rst
Definition: lbandrtk.h:280
lbandrtk_return_value_t
LBAND RTK Click return value data.
Definition: lbandrtk.h:341
err_t lbandrtk_set_pmp_cfg(lbandrtk_t *ctx, lbandrtk_pmp_cfg_t pmp_cfg)
LBAND RTK set pmp cfg function.
err_t lbandrtk_get_pmp_cfg(lbandrtk_t *ctx, lbandrtk_pmp_cfg_t *pmp_cfg)
LBAND RTK get pmp cfg function.
spi_master_chip_select_polarity_t cs_polarity
Definition: lbandrtk.h:324
uart_data_bits_t data_bit
Definition: lbandrtk.h:328
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.
spi_master_t spi
Definition: lbandrtk.h:284
void lbandrtk_set_rst_pin(lbandrtk_t *ctx, uint8_t state)
LBAND RTK set rst pin function.
i2c_master_t i2c
Definition: lbandrtk.h:283
lbandrtk_master_io_t write_f
Definition: lbandrtk.h:295
#define LBANDRTK_MAX_PAYLOAD_LEN
LBAND RTK UBX max payload size.
Definition: lbandrtk.h:120
void lbandrtk_set_ein_pin(lbandrtk_t *ctx, uint8_t state)
LBAND RTK set ein pin function.
uint8_t class_id
Definition: lbandrtk.h:245
pin_name_t sda
Definition: lbandrtk.h:308
@ LBANDRTK_DRV_SEL_I2C
Definition: lbandrtk.h:224
lbandrtk_drv_t drv_sel
Definition: lbandrtk.h:293
uint32_t i2c_speed
Definition: lbandrtk.h:319
uart_t uart
Definition: lbandrtk.h:285
LBAND RTK Click UBX frame union object.
Definition: lbandrtk.h:239
err_t lbandrtk_generic_write(lbandrtk_t *ctx, uint8_t *data_in, uint16_t len)
LBAND RTK data writing function.
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.
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.
err_t lbandrtk_set_default_pmp_cfg(lbandrtk_t *ctx)
LBAND RTK set default pmp cfg function.
void lbandrtk_drv_interface_selection(lbandrtk_cfg_t *cfg, lbandrtk_drv_t drv_sel)
LBAND RTK driver interface setup function.
uint8_t use_descrambler
Definition: lbandrtk.h:266
err_t lbandrtk_write_ubx_frame(lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame)
LBAND RTK write ubx frame function.
#define LBANDRTK_DRV_TX_BUFFER_SIZE
LBAND RTK driver buffer size.
Definition: lbandrtk.h:171
pin_name_t tx_pin
Definition: lbandrtk.h:314
uint32_t unique_word_high
Definition: lbandrtk.h:269
@ LBANDRTK_DRV_SEL_SPI
Definition: lbandrtk.h:223
uint16_t search_window
Definition: lbandrtk.h:261
uint8_t use_service_id
Definition: lbandrtk.h:263
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.
err_t lbandrtk_check_ack(lbandrtk_t *ctx, uint8_t class_id, uint8_t msg_id)
LBAND RTK check ack function.
struct lbandrtk_s lbandrtk_t
LBAND RTK Click context object.
lbandrtk_drv_t
LBAND RTK Click driver selector.
Definition: lbandrtk.h:221
digital_out_t ein
Definition: lbandrtk.h:281
@ LBANDRTK_DRV_SEL_UART
Definition: lbandrtk.h:222
uint8_t i2c_address
Definition: lbandrtk.h:320
uint16_t payload_len
Definition: lbandrtk.h:247
pin_name_t sck
Definition: lbandrtk.h:311
uint16_t descrambler_init
Definition: lbandrtk.h:267
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.
uint16_t header
Definition: lbandrtk.h:243
err_t lbandrtk_init(lbandrtk_t *ctx, lbandrtk_cfg_t *cfg)
LBAND RTK initialization function.
uint16_t data_rate
Definition: lbandrtk.h:265
uint32_t baud_rate
Definition: lbandrtk.h:326
uint16_t service_id
Definition: lbandrtk.h:264
err_t lbandrtk_read_ubx_frame(lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame)
LBAND RTK read ubx frame function.