gnss.h

Go to the documentation of this file.

/****************************************************************************
 * arch/arm/include/cxd56xx/gnss.h
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/
#ifndef __ARCH_ARM_INCLUDE_CXD56XX_GNSS_H
#define __ARCH_ARM_INCLUDE_CXD56XX_GNSS_H
 
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <arch/chip/gnss_type.h>
 
#define CXD56_GNSS_IOCTL_START 1
 
#define CXD56_GNSS_IOCTL_STOP 2
 
#define CXD56_GNSS_IOCTL_SELECT_SATELLITE_SYSTEM 3
 
#define CXD56_GNSS_IOCTL_GET_SATELLITE_SYSTEM 4
 
#define CXD56_GNSS_IOCTL_SET_RECEIVER_POSITION_ELLIPSOIDAL 5
 
#define CXD56_GNSS_IOCTL_SET_RECEIVER_POSITION_ORTHOGONAL 6
 
#define CXD56_GNSS_IOCTL_SET_OPE_MODE 7
 
#define CXD56_GNSS_IOCTL_GET_OPE_MODE 8
 
#define CXD56_GNSS_IOCTL_SET_TCXO_OFFSET 9
 
#define CXD56_GNSS_IOCTL_GET_TCXO_OFFSET 10
 
#define CXD56_GNSS_IOCTL_SET_TIME 11
 
#define CXD56_GNSS_IOCTL_GET_ALMANAC 12
 
#define CXD56_GNSS_IOCTL_SET_ALMANAC 13
 
#define CXD56_GNSS_IOCTL_GET_EPHEMERIS 14
 
#define CXD56_GNSS_IOCTL_SET_EPHEMERIS 15
 
#define CXD56_GNSS_IOCTL_SAVE_BACKUP_DATA 16
 
#define CXD56_GNSS_IOCTL_ERASE_BACKUP_DATA 17
 
#define CXD56_GNSS_IOCTL_OPEN_CEP_DATA 18
 
#define CXD56_GNSS_IOCTL_CLOSE_CEP_DATA 19
 
#define CXD56_GNSS_IOCTL_CHECK_CEP_DATA 20
 
#define CXD56_GNSS_IOCTL_GET_CEP_AGE 21
 
#define CXD56_GNSS_IOCTL_RESET_CEP_FLAG 22
 
#define CXD56_GNSS_IOCTL_RTK_START 23
 
#define CXD56_GNSS_IOCTL_RTK_STOP 24
 
#define CXD56_GNSS_IOCTL_RTK_SET_INTERVAL 25
 
#define CXD56_GNSS_IOCTL_RTK_GET_INTERVAL 26
 
#define CXD56_GNSS_IOCTL_RTK_SELECT_SATELLITE_SYSTEM 27
 
#define CXD56_GNSS_IOCTL_RTK_GET_SATELLITE_SYSTEM 28
 
#define CXD56_GNSS_IOCTL_RTK_SET_EPHEMERIS_ENABLER 29
 
#define CXD56_GNSS_IOCTL_RTK_GET_EPHEMERIS_ENABLER 30
 
#define CXD56_GNSS_IOCTL_AGPS_SET_ACQUIST 31
 
#define CXD56_GNSS_IOCTL_AGPS_SET_FRAMETIME 32
 
#define CXD56_GNSS_IOCTL_AGPS_SET_TAU_GPS 33
 
#define CXD56_GNSS_IOCTL_AGPS_SET_TIME_GPS 34
 
#define CXD56_GNSS_IOCTL_AGPS_CLEAR_RECEIVER_INFO 35
 
#define CXD56_GNSS_IOCTL_AGPS_SET_TOW_ASSIST 36
 
#define CXD56_GNSS_IOCTL_AGPS_SET_UTC_MODEL 37
 
#define CXD56_GNSS_IOCTL_SPECTRUM_CONTROL 38
 
#define CXD56_GNSS_IOCTL_FACTORY_START_TEST 39
 
#define CXD56_GNSS_IOCTL_FACTORY_STOP_TEST 40
 
#define CXD56_GNSS_IOCTL_FACTORY_GET_TEST_RESULT 41
 
#define CXD56_GNSS_IOCTL_SIGNAL_SET 42
 
#define CXD56_GNSS_IOCTL_PVTLOG_START 43
 
#define CXD56_GNSS_IOCTL_PVTLOG_STOP 44
 
#define CXD56_GNSS_IOCTL_PVTLOG_DELETE_LOG 45
 
#define CXD56_GNSS_IOCTL_PVTLOG_GET_STATUS 46
 
#define CXD56_GNSS_IOCTL_NAVMSG_START 47
 
#define CXD56_GNSS_IOCTL_SET_VAR_EPHEMERIS 48
 
#define CXD56_GNSS_IOCTL_GET_VAR_EPHEMERIS 49
 
#define CXD56_GNSS_IOCTL_SET_USECASE 50
 
#define CXD56_GNSS_IOCTL_GET_USECASE 51
 
#define CXD56_GNSS_IOCTL_SET_1PPS_OUTPUT 52
 
#define CXD56_GNSS_IOCTL_GET_1PPS_OUTPUT 53
 
#define CXD56_GNSS_IOCTL_GET_VERSION 54
 
#define CXD56_GNSS_IOCTL_SLEEP 55
 
#define CXD56_GNSS_IOCTL_WAKEUP 56
 
#define CXD56_GNSS_IOCTL_RESET 57
 
/* check macros for GNSS commands */
 
#define CXD56_GNSS_IOCTL_INVAL 0
#define CXD56_GNSS_IOCTL_MAX   58
 
/* @} gnss_ioctl */
 
/* Same value to GD Start mode CXD56_GNSS_STMOD_XXXX for fw_gd_start */
/* @{ */
 
#define CXD56_GNSS_STMOD_COLD       0 
#define CXD56_GNSS_STMOD_WARM       1 
#define CXD56_GNSS_STMOD_WARM_ACC2  2 
#define CXD56_GNSS_STMOD_HOT        3 
#define CXD56_GNSS_STMOD_HOT_ACC    4 
#define CXD56_GNSS_STMOD_HOT_ACC2   5 
#define CXD56_GNSS_STMOD_HOT_ACC3   6 
#define CXD56_GNSS_STMOD_GSPQ       CXD56_GNSS_STMOD_HOT_ACC3
/* @} */
 
/* @{ */
 
#define CXD56_GNSS_GPS_ALMANAC_SIZE       2048 
#define CXD56_GNSS_GPS_EPHEMERIS_SIZE     3072 
#define CXD56_GNSS_GLONASS_ALMANAC_SIZE   576  
#define CXD56_GNSS_GLONASS_EPHEMERIS_SIZE 1152 
#define CXD56_GNSS_QZSSL1CA_ALMANAC_SIZE  640  
#define CXD56_GNSS_QZSSL1CA_EPHEMERIS_SIZE 960 
/* @} */
 
/*
 * @name PVTLOG notify threshold of the stored data.
*/
/* @{ */
 
#define CXD56_GNSS_PVTLOG_THRESHOLD_FULL            0 
#define CXD56_GNSS_PVTLOG_THRESHOLD_HALF            1 
#define CXD56_GNSS_PVTLOG_THRESHOLD_ONE_DATA        2 
/* @} */
 
/* @{ */
#define CXD56_GNSS_READ_OFFSET_LAST_GNSS    0x0000
 
#define CXD56_GNSS_READ_OFFSET_GNSS(N)      (0x1000 + 0x800 * (N))
 
#define CXD56_GNSS_READ_OFFSET_AGPS         0x5000
 
#define CXD56_GNSS_READ_OFFSET_RTK          0x6000
 
#define CXD56_GNSS_READ_OFFSET_GPSEPHEMERIS 0x7000
 
#define CXD56_GNSS_READ_OFFSET_GLNEPHEMERIS 0x8000
 
#define CXD56_GNSS_READ_OFFSET_SBAS         0x9000
 
#define CXD56_GNSS_READ_OFFSET_DCREPORT     0x9800
 
#define CXD56_GNSS_READ_OFFSET_SARRLM       0x9900
 
#define CXD56_GNSS_READ_OFFSET_SPECTRUM     0xa000
 
#define CXD56_GNSS_READ_OFFSET_INFO         0xf000
 
#define CXD56_GNSS_READ_OFFSET_PVTLOG       0x10000
 
/* @} */
 
/* @{ */
#define CXD56_GNSS_SIG_GNSS         0
 
#define CXD56_GNSS_SIG_PVTLOG       2
 
#define CXD56_GNSS_SIG_AGPS         3
 
#define CXD56_GNSS_SIG_RTK          4
 
#define CXD56_GNSS_SIG_SPECTRUM     5
 
#define CXD56_GNSS_SIG_GPSEPHEMERIS 11
 
#define CXD56_GNSS_SIG_GLNEPHEMERIS 12
 
#define CXD56_GNSS_SIG_SBAS         14
 
#define CXD56_GNSS_SIG_DCREPORT     15
 
#define CXD56_GNSS_SIG_SARRLM       16
 
/* @} */
 
/* @} gnss_defs */
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
struct cxd56_gnss_ope_mode_param_s
{
  uint32_t mode;
 
  uint32_t cycle;
};
 
struct cxd56_gnss_orbital_param_s
{
  uint32_t  type; 
  uint32_t *data; 
};
 
struct cxd56_gnss_datetime_s
{
  struct cxd56_gnss_date_s date; 
  struct cxd56_gnss_time_s time; 
};
 
struct cxd56_gnss_ellipsoidal_position_s
{
  double latitude;  
  double longitude; 
  double altitude;  
};
 
struct cxd56_gnss_orthogonal_position_s
{
  int32_t x; 
  int32_t y; 
  int32_t z; 
};
 
struct cxd56_gnss_cep_data_s
{
  uint32_t *data;
  uint32_t  size;
  uint32_t  counter;
};
 
struct cxd56_gnss_cep_age_s
{
  float age;  
  float cepi; 
};
 
struct cxd56_gnss_agps_acquist_s
{
  uint8_t *data; 
  uint16_t size; 
};
 
struct cxd56_gnss_agps_tow_assist_s
{
  uint8_t *data; 
  uint16_t size; 
};
 
struct cxd56_gnss_agps_utc_model_s
{
  uint8_t *data; 
  uint16_t size; 
};
 
struct cxd56_gnss_agps_frametime_s
{
  uint16_t sec;  
  uint32_t frac; 
};
 
struct cxd56_gnss_agps_time_gps_s
{
  struct cxd56_gnss_date_s date; 
  struct cxd56_gnss_time_s time; 
};
 
struct cxd56_gnss_agps_tau_gps_s
{
  double    taugps;     
};
 
struct cxd56_gnss_spectrum_control_s
{
  uint8_t  enable; 
  uint32_t time;   
  uint8_t  point1; 
  uint8_t  point2; 
  uint8_t  step1;  
  uint8_t  step2;  
};
 
struct cxd56_gnss_test_info_s
{
  uint32_t satellite; 
  uint32_t reserve1;  
  uint32_t reserve2;  
  uint32_t reserve3;  
};
 
struct cxd56_gnss_test_result_s
{
  float cn;      
  float doppler; 
};
 
struct cxd56_gnss_signal_setting_s
{
  int     fd;      
  uint8_t enable;  
  uint8_t gnsssig; 
  int     signo;   
  void   *data;    
};
 
struct cxd56_gnss_signal_info_s
{
  int     fd;      
  uint8_t gnsssig; 
  int     signo;   
  void   *data;    
};
 
struct cxd56_pvtlog_setting_s
{
  uint32_t cycle;     
  uint32_t threshold; 
};
 
struct cxd56_pvtlog_status_s
{
  struct cxd56_gnss_status_s status;   
};
 
struct cxd56_rtk_setting_s
{
  int       interval; 
  uint32_t  gnss;     
  int       ephout;   
  uint64_t  sbasout;  
};
 
struct cxd56_gnss_set_var_ephemeris_s
{
  uint32_t *data; 
  uint32_t  size; 
};
 
struct cxd56_gnss_get_var_ephemeris_s
{
  uint32_t  type; 
  uint32_t *data; 
  uint32_t  size; 
};
 
/* @} gnss_datatypes */
 
/* @} gnss */
 
#undef EXTERN
#ifdef __cplusplus
}
#endif
 
#endif /* __ARCH_ARM_INCLUDE_CXD56XX_GNSS_H */