gnss11.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 GNSS11_H
#define GNSS11_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 GNSS11_RSP_START                                "$"
#define GNSS11_RSP_DELIMITER                            ","
#define GNSS11_RSP_END                                  "\r\n"
#define GNSS11_RSP_GGA                                  "GGA"
 
#define GNSS11_GGA_ELEMENT_SIZE                         15
#define GNSS11_GGA_TIME                                 1
#define GNSS11_GGA_LATITUDE                             2
#define GNSS11_GGA_LATITUDE_SIDE                        3
#define GNSS11_GGA_LONGITUDE                            4
#define GNSS11_GGA_LONGITUDE_SIDE                       5
#define GNSS11_GGA_QUALITY_INDICATOR                    6
#define GNSS11_GGA_NUMBER_OF_SATELLITES                 7
#define GNSS11_GGA_H_DILUTION_OF_POS                    8
#define GNSS11_GGA_ALTITUDE                             9
#define GNSS11_GGA_ALTITUDE_UNIT                        10
#define GNSS11_GGA_GEOIDAL_SEPARATION                   11
#define GNSS11_GGA_GEOIDAL_SEPARATION_UNIT              12
#define GNSS11_GGA_TIME_SINCE_LAST_DGPS                 13
#define GNSS11_GGA_DGPS_REFERENCE_STATION_ID            14
 
#define GNSS11_DUMMY                                    0xFF
 
#define GNSS11_SET_DEV_ADDR                             0x42
 
#define GNSS11_TX_DRV_BUFFER_SIZE                       100
#define GNSS11_RX_DRV_BUFFER_SIZE                       1000
 
#define GNSS11_SET_DATA_SAMPLE_EDGE                     SET_SPI_DATA_SAMPLE_EDGE
#define GNSS11_SET_DATA_SAMPLE_MIDDLE                   SET_SPI_DATA_SAMPLE_MIDDLE
 
 // gnss11_cmd
 
#define GNSS11_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.ovc     = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst     = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ant_on  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.eint    = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // gnss11_map
 // gnss11
 
typedef enum
{
    GNSS11_DRV_SEL_UART,            
    GNSS11_DRV_SEL_SPI,             
    GNSS11_DRV_SEL_I2C              
} gnss11_drv_t;
 
struct gnss11_s;
typedef err_t ( *gnss11_master_io_t )( struct gnss11_s*, uint8_t*, uint16_t ); 
typedef struct gnss11_s
{
    digital_out_t rst;              
    digital_out_t ant_on;           
    digital_in_t  eint;             
    digital_in_t  ovc;              
    i2c_master_t  i2c;              
    spi_master_t  spi;              
    uart_t        uart;             
    uint8_t uart_rx_buffer[ GNSS11_RX_DRV_BUFFER_SIZE ];    
    uint8_t uart_tx_buffer[ GNSS11_TX_DRV_BUFFER_SIZE ];    
    uint8_t       slave_address;    
    pin_name_t    chip_select;      
    gnss11_drv_t  drv_sel;          
    gnss11_master_io_t write_f;     
    gnss11_master_io_t read_f;      
} gnss11_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 ant_on;              
    pin_name_t eint;                
    pin_name_t ovc;                 
    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;      
    gnss11_drv_t     drv_sel;       
} gnss11_cfg_t;
 
typedef enum
{
    GNSS11_OK = 0,
    GNSS11_ERROR = -1
 
} gnss11_return_value_t;
 
void gnss11_cfg_setup ( gnss11_cfg_t *cfg );
 
err_t gnss11_init ( gnss11_t *ctx, gnss11_cfg_t *cfg );
 
void gnss11_drv_interface_selection ( gnss11_cfg_t *cfg, gnss11_drv_t drv_sel );
 
err_t gnss11_default_cfg ( gnss11_t *ctx );
 
err_t gnss11_generic_write ( gnss11_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t gnss11_generic_read ( gnss11_t *ctx, uint8_t *data_out, uint16_t len );
 
uint8_t gnss11_get_ovc_pin ( gnss11_t *ctx );
 
void gnss11_set_rst_pin ( gnss11_t *ctx, uint8_t state );
 
void gnss11_set_ant_on_pin ( gnss11_t *ctx, uint8_t state );
 
uint8_t gnss11_get_eint_pin ( gnss11_t *ctx );
 
void gnss11_reset_device ( gnss11_t *ctx );
 
err_t gnss11_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS11_H
 
 // gnss11
 
// ------------------------------------------------------------------------ END