lbandrtk.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef LBANDRTK_H
#define LBANDRTK_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "drv_uart.h"
#include "spi_specifics.h"
 
#define LBANDRTK_CLASS_ID_UBX_ACK               0x05
#define LBANDRTK_CLASS_ID_UBX_CFG               0x06
#define LBANDRTK_CLASS_ID_UBX_INF               0x04
#define LBANDRTK_CLASS_ID_UBX_MON               0x0A
#define LBANDRTK_CLASS_ID_UBX_RXM               0x02
#define LBANDRTK_MSG_ID_UBX_ACK_ACK             0x01
#define LBANDRTK_MSG_ID_UBX_ACK_NAK             0x00
#define LBANDRTK_MSG_ID_UBX_CFG_RST             0x04
#define LBANDRTK_MSG_ID_UBX_CFG_VALDEL          0x8C
#define LBANDRTK_MSG_ID_UBX_CFG_VALGET          0x8B
#define LBANDRTK_MSG_ID_UBX_CFG_VALSET          0x8A
#define LBANDRTK_MSG_ID_UBX_INF_ERROR           0x00
#define LBANDRTK_MSG_ID_UBX_INF_NOTICE          0x02
#define LBANDRTK_MSG_ID_UBX_INF_WARNING         0x01
#define LBANDRTK_MSG_ID_UBX_MON_HW2             0x0B
#define LBANDRTK_MSG_ID_UBX_MON_VER             0x04
#define LBANDRTK_MSG_ID_UBX_RXM_PMP             0x72
#define LBANDRTK_MSG_ID_UBX_RXM_PMREQ           0x41
 
#define LBANDRTK_VER_CFG_POLL_REQUEST           0x00
#define LBANDRTK_VER_CFG_POLLED                 0x01
#define LBANDRTK_LAYER_RAM                      0x01
#define LBANDRTK_LAYER_BBR                      0x02
#define LBANDRTK_LAYER_FLASH                    0x04
#define LBANDRTK_LAYER_ALL                      0x07
#define LBANDRTK_KEY_ID_SIZE_1_BIT              0x10000000ul
#define LBANDRTK_KEY_ID_SIZE_1_BYTE             0x20000000ul
#define LBANDRTK_KEY_ID_SIZE_2_BYTES            0x30000000ul
#define LBANDRTK_KEY_ID_SIZE_4_BYTES            0x40000000ul
#define LBANDRTK_KEY_ID_SIZE_8_BYTES            0x50000000ul
#define LBANDRTK_KEY_ID_SIZE_MASK               0x70000000ul
#define LBANDRTK_KEY_ID_GROUP_MASK              0x00FF0000ul
#define LBANDRTK_KEY_ID_ITEM_MASK               0x00000FFFul
#define LBANDRTK_CFG_PMP_CENTER_FREQUENCY       0x40B10011ul
#define LBANDRTK_CFG_PMP_SEARCH_WINDOW          0x30B10012ul
#define LBANDRTK_CFG_PMP_USE_SERVICE_ID         0x10B10016ul
#define LBANDRTK_CFG_PMP_SERVICE_ID             0x30B10017ul
#define LBANDRTK_CFG_PMP_DATA_RATE              0x30B10013ul
#define LBANDRTK_CFG_PMP_USE_DESCRAMBLER        0x10B10014ul
#define LBANDRTK_CFG_PMP_DESCRAMBLER_INIT       0x30B10015ul
#define LBANDRTK_CFG_PMP_USE_PRESCRAMBLING      0x10B10019ul
#define LBANDRTK_CFG_PMP_UNIQUE_WORD            0x50B1001Aul
 
#define LBANDRTK_PREAMBLE_SYNC_CHAR_1           0xB5
#define LBANDRTK_PREAMBLE_SYNC_CHAR_2           0x62
 
#define LBANDRTK_MAX_PAYLOAD_LEN                528u
 
#define LBANDRTK_DUMMY                          0xFF
 
#define LBANDRTK_TIMEOUT                        3000u
#define LBANDRTK_NUM_OF_RETRIES                 5
 
#define LBANDRTK_PMP_CENTER_FREQ_EU             1545260000ul
#define LBANDRTK_PMP_CENTER_FREQ_US             1556290000ul
#define LBANDRTK_PMP_CENTER_FREQ                LBANDRTK_PMP_CENTER_FREQ_EU
#define LBANDRTK_PMP_SEARCH_WINDOW              2200u
#define LBANDRTK_PMP_USE_SERVICE_ID             0
#define LBANDRTK_PMP_SERVICE_ID                 21845u
#define LBANDRTK_PMP_DATA_RATE                  2400u
#define LBANDRTK_PMP_USE_DESCRAMBLER            1
#define LBANDRTK_PMP_DESCRAMBLER_INIT           26969u
#define LBANDRTK_PMP_USE_PRESCRAMBLING          0
#define LBANDRTK_PMP_UNIQUE_WORD_HIGH           0xE15AE893ul
#define LBANDRTK_PMP_UNIQUE_WORD_LOW            0xE15AE893ul
 
#define LBANDRTK_UBX_RXM_PMP_MAX_USER_DATA      504u
#define LBANDRTK_UBX_RXM_PMP_EBN0_SCALE         0.125f
 
#define LBANDRTK_SET_DEV_ADDR                   0x43
 
#define LBANDRTK_DRV_TX_BUFFER_SIZE             ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
#define LBANDRTK_DRV_RX_BUFFER_SIZE             ( LBANDRTK_MAX_PAYLOAD_LEN + 8 )
 
#define LBANDRTK_SET_DATA_SAMPLE_EDGE           SET_SPI_DATA_SAMPLE_EDGE
#define LBANDRTK_SET_DATA_SAMPLE_MIDDLE         SET_SPI_DATA_SAMPLE_MIDDLE
 
 // lbandrtk_set
 
#define LBANDRTK_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl    = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda    = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso   = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi   = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck    = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs     = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.ein    = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // lbandrtk_map
 // lbandrtk
 
typedef enum
{
    LBANDRTK_DRV_SEL_UART,      
    LBANDRTK_DRV_SEL_SPI,       
    LBANDRTK_DRV_SEL_I2C        
} lbandrtk_drv_t;
 
typedef err_t ( *lbandrtk_master_io_t )( struct lbandrtk_s*, uint8_t*, uint16_t ); 
typedef union
{
    uint8_t data_buf[ LBANDRTK_MAX_PAYLOAD_LEN + 8 ];
    struct
    {
        uint16_t header;        
        uint8_t class_id;       
        uint8_t msg_id;         
        uint16_t payload_len;   
        uint8_t payload[ LBANDRTK_MAX_PAYLOAD_LEN + 2 ]; 
    };
    
} lbandrtk_ubx_frame_t;
 
typedef struct
{
    uint32_t center_freq;       
    uint16_t search_window;     
    uint8_t use_service_id;     
    uint16_t service_id;        
    uint16_t data_rate;         
    uint8_t use_descrambler;    
    uint16_t descrambler_init;  
    uint8_t use_prescrambling;  
    uint32_t unique_word_high;  
    uint32_t unique_word_low;   
} lbandrtk_pmp_cfg_t;
 
typedef struct lbandrtk_s
{
    digital_out_t rst;          
    digital_out_t ein;          
    i2c_master_t  i2c;          
    spi_master_t  spi;          
    uart_t        uart;         
    // Buffers
    char uart_rx_buffer[ LBANDRTK_DRV_RX_BUFFER_SIZE ]; 
    char uart_tx_buffer[ LBANDRTK_DRV_TX_BUFFER_SIZE ]; 
    uint8_t     slave_address;  
    pin_name_t  chip_select;    
    lbandrtk_drv_t drv_sel;     
    lbandrtk_master_io_t write_f;   
    lbandrtk_master_io_t read_f;    
    lbandrtk_ubx_frame_t frame;
 
} lbandrtk_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  miso;           
    pin_name_t  mosi;           
    pin_name_t  sck;            
    pin_name_t  cs;             
    pin_name_t  rx_pin;         
    pin_name_t  tx_pin;         
    pin_name_t  rst;            
    pin_name_t  ein;            
    uint32_t    i2c_speed;      
    uint8_t     i2c_address;    
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
    lbandrtk_drv_t   drv_sel;   
} lbandrtk_cfg_t;
 
typedef enum
{
    LBANDRTK_OK = 0,
    LBANDRTK_ERROR = -1
 
} lbandrtk_return_value_t;
 
void lbandrtk_cfg_setup ( lbandrtk_cfg_t *cfg );
 
void lbandrtk_drv_interface_selection ( lbandrtk_cfg_t *cfg, lbandrtk_drv_t drv_sel );
 
err_t lbandrtk_init ( lbandrtk_t *ctx, lbandrtk_cfg_t *cfg );
 
err_t lbandrtk_generic_write ( lbandrtk_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t lbandrtk_generic_read ( lbandrtk_t *ctx, uint8_t *data_out, uint16_t len );
 
err_t lbandrtk_write_ubx_frame ( lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame );
 
err_t lbandrtk_read_ubx_frame ( lbandrtk_t *ctx, lbandrtk_ubx_frame_t *frame );
 
void lbandrtk_set_rst_pin ( lbandrtk_t *ctx, uint8_t state );
 
void lbandrtk_set_ein_pin ( lbandrtk_t *ctx, uint8_t state );
 
void lbandrtk_reset_device ( lbandrtk_t *ctx );
 
err_t lbandrtk_check_ack ( lbandrtk_t *ctx, uint8_t class_id, uint8_t msg_id );
 
err_t lbandrtk_set_val_8 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t value );
 
err_t lbandrtk_set_val_16 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t value );
 
err_t lbandrtk_set_val_32 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value );
 
err_t lbandrtk_set_val_64 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t value_high, uint32_t value_low );
 
err_t lbandrtk_get_val_8 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint8_t *value );
 
err_t lbandrtk_get_val_16 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint16_t *value );
 
err_t lbandrtk_get_val_32 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value );
 
err_t lbandrtk_get_val_64 ( lbandrtk_t *ctx, uint32_t key_id, uint8_t layer, uint32_t *value_high, uint32_t *value_low );
 
err_t lbandrtk_set_default_pmp_cfg ( lbandrtk_t *ctx );
 
err_t lbandrtk_set_pmp_cfg ( lbandrtk_t *ctx, lbandrtk_pmp_cfg_t pmp_cfg );
 
err_t lbandrtk_get_pmp_cfg ( lbandrtk_t *ctx, lbandrtk_pmp_cfg_t *pmp_cfg );
 
#ifdef __cplusplus
}
#endif
#endif // LBANDRTK_H
 
 // lbandrtk
 
// ------------------------------------------------------------------------ END