cxd56_gnss_nmea.h

/****************************************************************************
 * modules/include/gpsutils/cxd56_gnss_nmea.h
 *
 *   Copyright 2018, 2019, 2023 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __SDK_MODULES_INCLUDE_GPSUTILS_CXD56_GNSS_NMEA_H
#define __SDK_MODULES_INCLUDE_GPSUTILS_CXD56_GNSS_NMEA_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/*-----------------------------------------------------------------------------
 * include files
 *---------------------------------------------------------------------------*/
 
#include <stdint.h>
#include <arch/chip/gnss.h>
 
#define NMEA_SENTENCE_MAX_LEN  160
 
#define NMEA_GGA_ON     0x00000001 
#define NMEA_GLL_ON     0x00000002 
#define NMEA_GSA_ON     0x00000004 
#define NMEA_GSV_ON     0x00000008 
#define NMEA_GNS_ON     0x00000010 
#define NMEA_RMC_ON     0x00000020 
#define NMEA_VTG_ON     0x00000040 
#define NMEA_ZDA_ON     0x00000080 
#define NMEA_SARRLM_ON  0x00000800 
#define NMEA_QZQSM_ON   0x00004000 
#define NMEA_GST_ON     0x00100000 
typedef struct
{
  char *(*bufReq)(uint16_t);        
  void (*bufFree)(char *);          
  int (*out)(char *);               
  int (*outBin)(char *, uint32_t);  
} NMEA_OUTPUT_CB;
 
typedef char NMEA_SPECTRUM_DATA[112];
 
struct nmea_raw_s {
    double lat;
    double lon;
    double alt;
    float vel;
    float dir;
};
 
void NMEA_InitMask(void);
 
int NMEA_RegistOutputFunc(const NMEA_OUTPUT_CB *func);
 
void NMEA_SetMask(uint32_t mask);
 
uint32_t NMEA_GetMask(void);
 
uint16_t NMEA_Output(const struct cxd56_gnss_positiondata_s* pposdat);
 
/*
 * Output QZSS Satellite Report sentence for Disaster and Crisis Management(DC Report)
 * @param[in] dcrdat : QZSS DC report data
 * @retval >0 : success, output total sentence size
 * @retval <0 : fail
 */
 
uint16_t NMEA_DcReport_Output(const struct cxd56_gnss_dcreport_data_s* dcrdat);
 
/*
 * Output GAL SAR/RLM sentence
 * @param[in] dat : Galileo SAR/RLM data
 * @retval >0 : success, output total sentence size
 * @retval <0 : fail
 */
 
uint16_t NMEA_GalSarRlm_Output(const struct cxd56_gnss_gal_sarrlm_s* dat);
 
uint16_t NMEA_OutputSpectrum(NMEA_SPECTRUM_DATA *spectrumdat);
 
/*
 * Extract raw data from position data
 * @param[in] pposdat : Position data output from GNSS
 * @param[out] rawdat : Extracted raw data
 * @retval 0 : success
 * @retval <0 : fail
 */
 
int NMEA_ExtractRawData(const struct cxd56_gnss_positiondata_s* pposdat,
                        struct nmea_raw_s *rawdat);
 
void NMEA_InitMask2(void);
 
int NMEA_RegistOutputFunc2(const NMEA_OUTPUT_CB *func);
 
void NMEA_SetMask2(uint32_t mask);
 
uint32_t NMEA_GetMask2(void);
 
uint16_t NMEA_Output2(const struct cxd56_gnss_positiondata2_s* pposdat);
 
/*
 * Output QZSS Satellite Report sentence for Disaster and Crisis
 * Management(DC Report) for cxd5610 gnss
 * @param[in] dcrdat : QZSS DC report data
 * @retval >0 : success, output total sentence size
 * @retval <0 : fail
 */
 
uint16_t NMEA_DcReport_Output2(const struct cxd56_gnss_dcreport_data_s* dcrdat);
 
/* @} gnss_nmea */
/* @} gnss */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __SDK_MODULES_INCLUDE_GPSUTILS_CXD56_GNSS_NMEA_H */