gnss12.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 GNSS12_H
#define GNSS12_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 GNSS12_RSP_START                                "$"
#define GNSS12_RSP_DELIMITER                            ","
#define GNSS12_RSP_GNGGA                                "$GNGGA"
 
#define GNSS12_GNGGA_ELEMENT_SIZE                       15
#define GNSS12_GNGGA_TIME                               1
#define GNSS12_GNGGA_LATITUDE                           2
#define GNSS12_GNGGA_LATITUDE_SIDE                      3
#define GNSS12_GNGGA_LONGITUDE                          4
#define GNSS12_GNGGA_LONGITUDE_SIDE                     5
#define GNSS12_GNGGA_QUALITY_INDICATOR                  6
#define GNSS12_GNGGA_NUMBER_OF_SATELLITES               7
#define GNSS12_GNGGA_H_DILUTION_OF_POS                  8
#define GNSS12_GNGGA_ALTITUDE                           9
#define GNSS12_GNGGA_ALTITUDE_UNIT                      10
#define GNSS12_GNGGA_GEOIDAL_SEPARATION                 11
#define GNSS12_GNGGA_GEOIDAL_SEPARATION_UNIT            12
#define GNSS12_GNGGA_TIME_SINCE_LAST_DGPS               13
#define GNSS12_GNGGA_DGPS_REFERENCE_STATION_ID          14
 
#define GNSS12_DUMMY                                    0xFF
 
#define GNSS12_SET_DEV_ADDR                             0x42
 
#define GNSS12_DRV_BUFFER_SIZE                          200
 
#define GNSS12_SET_DATA_SAMPLE_EDGE                     SET_SPI_DATA_SAMPLE_EDGE
#define GNSS12_SET_DATA_SAMPLE_MIDDLE                   SET_SPI_DATA_SAMPLE_MIDDLE
 
 // gnss12_set
 
#define GNSS12_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.rst     = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.lna_en  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.eint    = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // gnss12_map
 // gnss12
 
typedef enum
{
    GNSS12_DRV_SEL_UART,            
    GNSS12_DRV_SEL_SPI,             
    GNSS12_DRV_SEL_I2C              
} gnss12_drv_t;
 
typedef err_t ( *gnss12_master_io_t )( struct gnss12_s*, uint8_t*, uint8_t ); 
typedef struct gnss12_s
{
    digital_out_t rst;              
    digital_in_t  eint;             
    digital_in_t  lna_en;           
    i2c_master_t  i2c;              
    spi_master_t  spi;              
    uart_t        uart;             
    // Buffers
    char uart_rx_buffer[ GNSS12_DRV_BUFFER_SIZE ];  
    char uart_tx_buffer[ GNSS12_DRV_BUFFER_SIZE ];  
    uint8_t       slave_address;    
    pin_name_t    chip_select;      
    gnss12_drv_t  drv_sel;          
    gnss12_master_io_t write_f;     
    gnss12_master_io_t read_f;      
} gnss12_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 lna_en;              
    pin_name_t eint;                
    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;      
    gnss12_drv_t     drv_sel;       
} gnss12_cfg_t;
 
typedef enum
{
    GNSS12_OK = 0,
    GNSS12_ERROR = -1
 
} gnss12_return_value_t;
 
void gnss12_cfg_setup ( gnss12_cfg_t *cfg );
 
void gnss12_drv_interface_selection ( gnss12_cfg_t *cfg, gnss12_drv_t drv_sel );
 
err_t gnss12_init ( gnss12_t *ctx, gnss12_cfg_t *cfg );
 
err_t gnss12_generic_write ( gnss12_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t gnss12_generic_read ( gnss12_t *ctx, uint8_t *data_out, uint8_t len );
 
void gnss12_set_rst_pin ( gnss12_t *ctx, uint8_t state );
 
uint8_t gnss12_get_lna_en_pin ( gnss12_t *ctx );
 
uint8_t gnss12_get_eint_pin ( gnss12_t *ctx );
 
void gnss12_reset_device ( gnss12_t *ctx );
 
err_t gnss12_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS12_H
 
 // gnss12
 
// ------------------------------------------------------------------------ END