Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

driver_ubx.h 10 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. /*
  2. * This file is Copyright (c) 2010 by the GPSD project
  3. * BSD terms apply: see the file COPYING in the distribution root for details
  4. */
  5. #ifndef _GPSD_UBX_H_
  6. #define _GPSD_UBX_H_
  7. #define UBX_MESSAGE_BASE_SIZE 6
  8. #define UBX_MESSAGE_DATA_OFFSET UBX_MESSAGE_BASE_SIZE
  9. typedef enum {
  10. UBX_CLASS_NAV = 0x01, /**< Navigation */
  11. UBX_CLASS_RXM = 0x02, /**< Receiver Manager */
  12. UBX_CLASS_INF = 0x04, /**< Informative text messages */
  13. UBX_CLASS_ACK = 0x05, /**< (Not) Acknowledges for cfg messages */
  14. UBX_CLASS_CFG = 0x06, /**< Configuration requests */
  15. UBX_CLASS_UPD = 0x09, /**< Firmware updates */
  16. UBX_CLASS_MON = 0x0a, /**< System monitoring */
  17. UBX_CLASS_AID = 0x0b, /**< AGPS (Deprecated) */
  18. UBX_CLASS_TIM = 0x0d, /**< Time */
  19. UBX_CLASS_ESF = 0x10, /**< External Sensor Fusion */
  20. UBX_CLASS_MGA = 0x13, /**< Multi GNSS Assistance */
  21. UBX_CLASS_LOG = 0x21, /**< Log */
  22. UBX_CLASS_SEC = 0x27, /**< Security */
  23. UBX_CLASS_HNR = 0x28, /**< High Rate Nav Results */
  24. UBX_CLASS_NMEA = 0xf0, /**< NMEA, for configuring */
  25. UBX_CLASS_RTCM3 = 0xf5, /**< RTCM3, for configuring */
  26. } ubx_classes_t;
  27. #define UBX_MSGID(cls_, id_) (((cls_)<<8)|(id_))
  28. typedef enum {
  29. UBX_NAV_POSECEF = UBX_MSGID(UBX_CLASS_NAV, 0x01),
  30. UBX_NAV_POSLLH = UBX_MSGID(UBX_CLASS_NAV, 0x02),
  31. UBX_NAV_STATUS = UBX_MSGID(UBX_CLASS_NAV, 0x03),
  32. UBX_NAV_DOP = UBX_MSGID(UBX_CLASS_NAV, 0x04),
  33. UBX_NAV_ATT = UBX_MSGID(UBX_CLASS_NAV, 0x05),
  34. UBX_NAV_SOL = UBX_MSGID(UBX_CLASS_NAV, 0x06),
  35. UBX_NAV_PVT = UBX_MSGID(UBX_CLASS_NAV, 0x07),
  36. UBX_NAV_POSUTM = UBX_MSGID(UBX_CLASS_NAV, 0x08),
  37. UBX_NAV_ODO = UBX_MSGID(UBX_CLASS_NAV, 0x09),
  38. UBX_NAV_RESETODO = UBX_MSGID(UBX_CLASS_NAV, 0x10),
  39. UBX_NAV_VELECEF = UBX_MSGID(UBX_CLASS_NAV, 0x11),
  40. UBX_NAV_VELNED = UBX_MSGID(UBX_CLASS_NAV, 0x12),
  41. UBX_NAV_HPPOSECEF = UBX_MSGID(UBX_CLASS_NAV, 0x13),
  42. UBX_NAV_HPPOSLLH = UBX_MSGID(UBX_CLASS_NAV, 0x14),
  43. UBX_NAV_TIMEGPS = UBX_MSGID(UBX_CLASS_NAV, 0x20),
  44. UBX_NAV_TIMEUTC = UBX_MSGID(UBX_CLASS_NAV, 0x21),
  45. UBX_NAV_CLOCK = UBX_MSGID(UBX_CLASS_NAV, 0x22),
  46. UBX_NAV_TIMEGLO = UBX_MSGID(UBX_CLASS_NAV, 0x23),
  47. UBX_NAV_TIMEBDS = UBX_MSGID(UBX_CLASS_NAV, 0x24),
  48. UBX_NAV_TIMEGAL = UBX_MSGID(UBX_CLASS_NAV, 0x25),
  49. UBX_NAV_TIMELS = UBX_MSGID(UBX_CLASS_NAV, 0x26),
  50. UBX_NAV_SVINFO = UBX_MSGID(UBX_CLASS_NAV, 0x30),
  51. UBX_NAV_DGPS = UBX_MSGID(UBX_CLASS_NAV, 0x31),
  52. UBX_NAV_SBAS = UBX_MSGID(UBX_CLASS_NAV, 0x32),
  53. UBX_NAV_ORB = UBX_MSGID(UBX_CLASS_NAV, 0x34),
  54. UBX_NAV_SAT = UBX_MSGID(UBX_CLASS_NAV, 0x35),
  55. UBX_NAV_GEOFENCE = UBX_MSGID(UBX_CLASS_NAV, 0x39),
  56. UBX_NAV_SVIN = UBX_MSGID(UBX_CLASS_NAV, 0x3b),
  57. UBX_NAV_RELPOSNED = UBX_MSGID(UBX_CLASS_NAV, 0x3c),
  58. UBX_NAV_EKFSTATUS = UBX_MSGID(UBX_CLASS_NAV, 0x40),
  59. UBX_NAV_SIG = UBX_MSGID(UBX_CLASS_NAV, 0x43),
  60. UBX_NAV_AOPSTATUS = UBX_MSGID(UBX_CLASS_NAV, 0x60),
  61. UBX_NAV_EOE = UBX_MSGID(UBX_CLASS_NAV, 0x61),
  62. UBX_RXM_RAW = UBX_MSGID(UBX_CLASS_RXM, 0x10),
  63. UBX_RXM_SFRB = UBX_MSGID(UBX_CLASS_RXM, 0x11),
  64. UBX_RXM_SFRBX = UBX_MSGID(UBX_CLASS_RXM, 0x13),
  65. UBX_RXM_MEASX = UBX_MSGID(UBX_CLASS_RXM, 0x14),
  66. UBX_RXM_RAWX = UBX_MSGID(UBX_CLASS_RXM, 0x15),
  67. UBX_RXM_SVSI = UBX_MSGID(UBX_CLASS_RXM, 0x20),
  68. UBX_RXM_ALM = UBX_MSGID(UBX_CLASS_RXM, 0x30),
  69. UBX_RXM_EPH = UBX_MSGID(UBX_CLASS_RXM, 0x31),
  70. UBX_RXM_RTCM = UBX_MSGID(UBX_CLASS_RXM, 0x32),
  71. UBX_RXM_POSREQ = UBX_MSGID(UBX_CLASS_RXM, 0x40),
  72. UBX_RXM_PMREQ = UBX_MSGID(UBX_CLASS_RXM, 0x41),
  73. UBX_RXM_RLM = UBX_MSGID(UBX_CLASS_RXM, 0x59),
  74. UBX_RXM_IMES = UBX_MSGID(UBX_CLASS_RXM, 0x61),
  75. UBX_INF_ERROR = UBX_MSGID(UBX_CLASS_INF, 0X00),
  76. UBX_INF_WARNING = UBX_MSGID(UBX_CLASS_INF, 0X01),
  77. UBX_INF_NOTICE = UBX_MSGID(UBX_CLASS_INF, 0x02),
  78. UBX_INF_TEST = UBX_MSGID(UBX_CLASS_INF, 0x03),
  79. UBX_INF_DEBUG = UBX_MSGID(UBX_CLASS_INF, 0x04),
  80. /* where is UBX-INF-USER documented? */
  81. UBX_INF_USER = UBX_MSGID(UBX_CLASS_INF, 0x07),
  82. UBX_ACK_NAK = UBX_MSGID(UBX_CLASS_ACK, 0x00),
  83. UBX_ACK_ACK = UBX_MSGID(UBX_CLASS_ACK, 0x01),
  84. UBX_CFG_PRT = UBX_MSGID(UBX_CLASS_CFG, 0x00),
  85. UBX_CFG_MSG = UBX_MSGID(UBX_CLASS_CFG, 0x01),
  86. UBX_CFG_INF = UBX_MSGID(UBX_CLASS_CFG, 0x02),
  87. UBX_CFG_RST = UBX_MSGID(UBX_CLASS_CFG, 0x04),
  88. UBX_CFG_DAT = UBX_MSGID(UBX_CLASS_CFG, 0x06),
  89. UBX_CFG_RATE = UBX_MSGID(UBX_CLASS_CFG, 0x08),
  90. UBX_CFG_CFG = UBX_MSGID(UBX_CLASS_CFG, 0x09),
  91. UBX_CFG_RXM = UBX_MSGID(UBX_CLASS_CFG, 0x11),
  92. UBX_CFG_ANT = UBX_MSGID(UBX_CLASS_CFG, 0x13),
  93. UBX_CFG_SBAS = UBX_MSGID(UBX_CLASS_CFG, 0x16),
  94. UBX_CFG_NMEA = UBX_MSGID(UBX_CLASS_CFG, 0x17),
  95. UBX_CFG_USB = UBX_MSGID(UBX_CLASS_CFG, 0x1b),
  96. UBX_CFG_ODO = UBX_MSGID(UBX_CLASS_CFG, 0x1e),
  97. UBX_CFG_NAVX5 = UBX_MSGID(UBX_CLASS_CFG, 0x23),
  98. UBX_CFG_NAV5 = UBX_MSGID(UBX_CLASS_CFG, 0x24),
  99. UBX_CFG_TP5 = UBX_MSGID(UBX_CLASS_CFG, 0x31),
  100. UBX_CFG_RINV = UBX_MSGID(UBX_CLASS_CFG, 0x34),
  101. UBX_CFG_ITFM = UBX_MSGID(UBX_CLASS_CFG, 0x39),
  102. UBX_CFG_PM2 = UBX_MSGID(UBX_CLASS_CFG, 0x3b),
  103. UBX_CFG_TMODE2 = UBX_MSGID(UBX_CLASS_CFG, 0x3D),
  104. UBX_CFG_GNSS = UBX_MSGID(UBX_CLASS_CFG, 0x3e),
  105. UBX_CFG_LOGFILTER = UBX_MSGID(UBX_CLASS_CFG, 0x47),
  106. UBX_CFG_TXSLOT = UBX_MSGID(UBX_CLASS_CFG, 0x53),
  107. UBX_CFG_PWR = UBX_MSGID(UBX_CLASS_CFG, 0x57),
  108. UBX_CFG_HNR = UBX_MSGID(UBX_CLASS_CFG, 0x5c),
  109. UBX_CFG_ESRC = UBX_MSGID(UBX_CLASS_CFG, 0x60),
  110. UBX_CFG_DOSC = UBX_MSGID(UBX_CLASS_CFG, 0x61),
  111. UBX_CFG_SMGR = UBX_MSGID(UBX_CLASS_CFG, 0x62),
  112. UBX_CFG_GEOFENCE = UBX_MSGID(UBX_CLASS_CFG, 0x69),
  113. UBX_CFG_DGNSS = UBX_MSGID(UBX_CLASS_CFG, 0x70),
  114. UBX_CFG_TMODE3 = UBX_MSGID(UBX_CLASS_CFG, 0x71),
  115. UBX_CFG_FIXSEED = UBX_MSGID(UBX_CLASS_CFG, 0x84),
  116. UBX_CFG_DYNSEED = UBX_MSGID(UBX_CLASS_CFG, 0x85),
  117. UBX_CFG_PMS = UBX_MSGID(UBX_CLASS_CFG, 0x86),
  118. UBX_UPD_DOWNL = UBX_MSGID(UBX_CLASS_UPD, 0x01),
  119. UBX_UPD_UPLOAD = UBX_MSGID(UBX_CLASS_UPD, 0x02),
  120. UBX_UPD_EXEC = UBX_MSGID(UBX_CLASS_UPD, 0x03),
  121. UBX_UPD_MEMCPY = UBX_MSGID(UBX_CLASS_UPD, 0x04),
  122. UBX_UPD_SOS = UBX_MSGID(UBX_CLASS_UPD, 0x14),
  123. UBX_MON_SCHED = UBX_MSGID(UBX_CLASS_MON, 0x01),
  124. UBX_MON_IO = UBX_MSGID(UBX_CLASS_MON, 0x02),
  125. UBX_MON_IPC = UBX_MSGID(UBX_CLASS_MON, 0x03),
  126. UBX_MON_VER = UBX_MSGID(UBX_CLASS_MON, 0x04),
  127. UBX_MON_EXCEPT = UBX_MSGID(UBX_CLASS_MON, 0x05),
  128. UBX_MON_MSGPP = UBX_MSGID(UBX_CLASS_MON, 0x06),
  129. UBX_MON_RXBUF = UBX_MSGID(UBX_CLASS_MON, 0x07),
  130. UBX_MON_TXBUF = UBX_MSGID(UBX_CLASS_MON, 0x08),
  131. UBX_MON_HW = UBX_MSGID(UBX_CLASS_MON, 0x09),
  132. UBX_MON_USB = UBX_MSGID(UBX_CLASS_MON, 0x0a),
  133. UBX_MON_HW2 = UBX_MSGID(UBX_CLASS_MON, 0x0b),
  134. UBX_MON_RXR = UBX_MSGID(UBX_CLASS_MON, 0x21),
  135. UBX_MON_PATCH = UBX_MSGID(UBX_CLASS_MON, 0x27),
  136. UBX_MON_GNSS = UBX_MSGID(UBX_CLASS_MON, 0x28),
  137. UBX_MON_SMGR = UBX_MSGID(UBX_CLASS_MON, 0x2e),
  138. /* USB-AID- Deprecated */
  139. UBX_AID_REQ = UBX_MSGID(UBX_CLASS_AID, 0x00),
  140. UBX_AID_INI = UBX_MSGID(UBX_CLASS_AID, 0x01),
  141. UBX_AID_HUI = UBX_MSGID(UBX_CLASS_AID, 0x02),
  142. UBX_AID_DATA = UBX_MSGID(UBX_CLASS_AID, 0x10),
  143. UBX_AID_ALM = UBX_MSGID(UBX_CLASS_AID, 0x30),
  144. UBX_AID_EPH = UBX_MSGID(UBX_CLASS_AID, 0x31),
  145. UBX_AID_AOP = UBX_MSGID(UBX_CLASS_AID, 0x33),
  146. UBX_TIM_TP = UBX_MSGID(UBX_CLASS_TIM, 0x01),
  147. UBX_TIM_TM = UBX_MSGID(UBX_CLASS_TIM, 0x02),
  148. UBX_TIM_TM2 = UBX_MSGID(UBX_CLASS_TIM, 0x03),
  149. UBX_TIM_SVIN = UBX_MSGID(UBX_CLASS_TIM, 0x04),
  150. UBX_TIM_VRFY = UBX_MSGID(UBX_CLASS_TIM, 0x06),
  151. UBX_TIM_DOSC = UBX_MSGID(UBX_CLASS_TIM, 0x11),
  152. UBX_TIM_TOS = UBX_MSGID(UBX_CLASS_TIM, 0x12),
  153. UBX_TIM_SMEAS = UBX_MSGID(UBX_CLASS_TIM, 0x13),
  154. UBX_TIM_VCOCAL = UBX_MSGID(UBX_CLASS_TIM, 0x15),
  155. UBX_TIM_FCHG = UBX_MSGID(UBX_CLASS_TIM, 0x16),
  156. UBX_TIM_HOC = UBX_MSGID(UBX_CLASS_TIM, 0x17),
  157. UBX_ESF_MEAS = UBX_MSGID(UBX_CLASS_SEC, 0x02),
  158. UBX_ESF_RAW = UBX_MSGID(UBX_CLASS_SEC, 0x03),
  159. UBX_ESF_STATUS = UBX_MSGID(UBX_CLASS_SEC, 0x10),
  160. UBX_ESF_INS = UBX_MSGID(UBX_CLASS_SEC, 0x15),
  161. UBX_MGA_GPS = UBX_MSGID(UBX_CLASS_MGA, 0x00),
  162. UBX_MGA_GAL = UBX_MSGID(UBX_CLASS_MGA, 0x02),
  163. UBX_MGA_BDS = UBX_MSGID(UBX_CLASS_MGA, 0x03),
  164. UBX_MGA_QZSS = UBX_MSGID(UBX_CLASS_MGA, 0x05),
  165. UBX_MGA_GLO = UBX_MSGID(UBX_CLASS_MGA, 0x06),
  166. UBX_MGA_ANO = UBX_MSGID(UBX_CLASS_MGA, 0x20),
  167. UBX_MGA_FLASH = UBX_MSGID(UBX_CLASS_MGA, 0x21),
  168. UBX_MGA_INI = UBX_MSGID(UBX_CLASS_MGA, 0x40),
  169. UBX_MGA_ACK = UBX_MSGID(UBX_CLASS_MGA, 0x60),
  170. UBX_MGA_DBD = UBX_MSGID(UBX_CLASS_MGA, 0x80),
  171. UBX_LOG_ERASE = UBX_MSGID(UBX_CLASS_LOG, 0x03),
  172. UBX_LOG_STRING = UBX_MSGID(UBX_CLASS_LOG, 0x04),
  173. UBX_LOG_CREATE = UBX_MSGID(UBX_CLASS_LOG, 0x07),
  174. UBX_LOG_INFO = UBX_MSGID(UBX_CLASS_LOG, 0x08),
  175. UBX_LOG_RETRIEVE = UBX_MSGID(UBX_CLASS_LOG, 0x09),
  176. UBX_LOG_RETRIEVEPOS = UBX_MSGID(UBX_CLASS_LOG, 0x0b),
  177. UBX_LOG_RETRIEVESTRING = UBX_MSGID(UBX_CLASS_LOG, 0x0d),
  178. UBX_LOG_FINDTIME = UBX_MSGID(UBX_CLASS_LOG, 0x0e),
  179. UBX_LOG_RETRIEVEPOSEXTRA = UBX_MSGID(UBX_CLASS_LOG, 0x0f),
  180. UBX_SEC_SIGN = UBX_MSGID(UBX_CLASS_SEC, 0x01),
  181. UBX_SEC_UNIQID = UBX_MSGID(UBX_CLASS_SEC, 0x03),
  182. UBX_HNR_PVT = UBX_MSGID(UBX_CLASS_HNR, 0x00),
  183. } ubx_message_t;
  184. typedef enum {
  185. UBX_MODE_NOFIX = 0x00, /* no fix available */
  186. UBX_MODE_DR = 0x01, /* Dead reckoning */
  187. UBX_MODE_2D = 0x02, /* 2D fix */
  188. UBX_MODE_3D = 0x03, /* 3D fix */
  189. UBX_MODE_GPSDR = 0x04, /* GPS + dead reckoning */
  190. UBX_MODE_TMONLY = 0x05, /* Time-only fix */
  191. } ubx_mode_t;
  192. #define UBX_SOL_FLAG_GPS_FIX_OK 0x01
  193. #define UBX_SOL_FLAG_DGPS 0x02
  194. #define UBX_SOL_VALID_WEEK 0x04
  195. #define UBX_SOL_VALID_TIME 0x08
  196. #define UBX_TIMEGPS_VALID_TIME 0x01
  197. #define UBX_TIMEGPS_VALID_WEEK 0x02
  198. #define UBX_TIMEGPS_VALID_LEAP_SECOND 0x04
  199. /* from UBX_NAV_SVINFO */
  200. #define UBX_SAT_USED 0x01
  201. #define UBX_SAT_DGPS 0x02
  202. #define UBX_SAT_EPHALM 0x04
  203. #define UBX_SAT_EPHEM 0x08
  204. #define UBX_SAT_UNHEALTHY 0x10
  205. #define UBX_SIG_IDLE 0
  206. #define UBX_SIG_SRCH1 1
  207. #define UBX_SIG_SRCH2 2
  208. #define UBX_SIG_DETECT 3
  209. #define UBX_SIG_CDLK 4
  210. #define UBX_SIG_CDCRLK1 5
  211. #define UBX_SIG_CDCRLK2 6
  212. #define UBX_SIG_NAVMSG 7
  213. #define UBX_NAV_PVT_VALID_DATE 0x01
  214. #define UBX_NAV_PVT_VALID_TIME 0x02
  215. #define UBX_NAV_PVT_VALID_RESL 0x04
  216. #define UBX_NAV_PVT_VALID_DATE_TIME (UBX_NAV_PVT_VALID_DATE | UBX_NAV_PVT_VALID_TIME)
  217. #define UBX_NAV_PVT_VALID_MAG 0x08
  218. #define UBX_NAV_PVT_FLAG_GPS_FIX_OK 0x01
  219. #define UBX_NAV_PVT_FLAG_DGPS 0x02
  220. #define UBX_NAV_PVT_FLAG_HDG_OK 0x20
  221. #endif /* _GPSD_UBX_H_ */