Coverage Report

Created: 2025-10-13 07:02

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gpsd/gpsd-3.26.2~dev/drivers/driver_ubx.c
Line
Count
Source
1
/*
2
 * UBX driver.  For u-blox binary, also includes Antaris4 binary
3
 * Reference manuals are at
4
 * http://www.u-blox.com/en/download/documents-a-resources/u-blox-6-gps-modules-resources.html
5
 *
6
 * updated for u-blox 8
7
 * http://www.ublox.com/images/downloads/Product_Docs/u-bloxM8_ReceiverDescriptionProtocolSpec_%28UBX-13003221%29_Public.pdf
8
 *
9
 * Week counters are not limited to 10 bits. It's unknown what
10
 * the firmware is doing to disambiguate them, if anything; it might just
11
 * be adding a fixed offset based on a hidden epoch value, in which case
12
 * unhappy things will occur on the next rollover.
13
 *
14
 * For the Antaris 4, the default leap-second offset (before getting one from
15
 * the sats, one presumes) is 0sec; for the u-blox 6 it's 15sec.
16
 *
17
 * This file is Copyright by the GPSD project
18
 * SPDX-License-Identifier: BSD-2-clause
19
 *
20
 */
21
22
#include "../include/gpsd_config.h"  // must be before all includes
23
24
#include <math.h>
25
#include <stdbool.h>
26
#include <stdio.h>
27
#include <stdlib.h>                // for abs()
28
#include <string.h>
29
#include <unistd.h>
30
31
32
#include "../include/compiler.h"   // for FALLTHROUGH
33
#include "../include/gpsd.h"
34
#include "../include/driver_ubx.h"
35
36
#include "../include/bits.h"       // For UINT2INT()
37
#include "../include/timespec.h"
38
39
// UBX-NAV-PVT, UBX-NAV-PVAT flag bits
40
#define UBX_NAV_PVT_FLAG_GPS_FIX_OK 0x01
41
0
#define UBX_NAV_PVT_FLAG_DGPS       0x02
42
#define UBX_NAV_PVT_FLAG_ROLL_OK    0x08
43
#define UBX_NAV_PVT_FLAG_PITCH_OK   0x10
44
0
#define UBX_NAV_PVT_FLAG_HDG_OK     0x20
45
0
#define UBX_NAV_PVT_FLAG_RTK_FLT    0x40
46
0
#define UBX_NAV_PVT_FLAG_RTK_FIX    0x80
47
48
/*
49
 * Some high-precision messages provide data where the main part is a
50
 * signed 32-bit integer (same as the standard-precision versions),
51
 * and there's an 8-bit signed field providing an addend scaled to
52
 * 1/100th of the main value.  This macro provides a fetch for such
53
 * values, scaled to match the extension (i.e., 100X the main-value scale).
54
 * Since the fields are nonconsective, the offsets are provided separately.
55
 * The result is a signed 64-bit integer.
56
 *
57
 * The second macro incorporates scaling the result by a specified double.
58
 */
59
#define getles32x100s8(buf, off, offx) \
60
0
    ((int64_t)(getles32((buf), (off)) * 100LL + getsb((buf), (offx))))
61
#define getles32x100s8d(buf, off, offx, scale) \
62
0
    (getles32x100s8((buf), (off), (offx)) * (double)(scale))
63
64
/*
65
 * A ubx packet looks like this:
66
 * leader: 0xb5 0x62
67
 * message class: 1 byte
68
 * message type: 1 byte
69
 * length of payload: 2 bytes
70
 * payload: variable length
71
 * checksum: 2 bytes
72
 *
73
 * see also the FV25 and UBX documents on reference.html
74
 */
75
0
#define UBX_PREFIX_LEN          6
76
#define UBX_CLASS_OFFSET        2
77
#define UBX_TYPE_OFFSET         3
78
79
// because we hates magic numbers forever
80
0
#define USART1_ID               1
81
#define USART2_ID               2
82
0
#define USB_ID                  3
83
0
#define UBX_PROTOCOL_MASK       0x01
84
0
#define NMEA_PROTOCOL_MASK      0x02
85
0
#define RTCM_PROTOCOL_MASK      0x04
86
0
#define RTCM3_PROTOCOL_MASK     0x20    // protVer 20+
87
0
#define UBX_CFG_LEN             20
88
0
#define outProtoMask            14
89
90
// UBX Satellite/Dignal Numbering
91
static const struct vlist_t vgnss_sig_ids[] = {
92
    {0x0000, "GPS L1 C/A"},
93
    {0x0003, "GPS L2 CL"},
94
    {0x0004, "GPS L2 CM"},
95
    {0x0006, "GPS L5 I"},
96
    {0x0007, "GPS L5 Q"},
97
    {0x0100, "SBAS L1 C/A"},
98
    {0x0200, "GAL E1 C"},
99
    {0x0201, "GAL E1 B"},
100
    {0x0203, "GAL E5 aI"},
101
    {0x0204, "GAL E5 aQ"},
102
    {0x0205, "GAL E5 bI"},
103
    {0x0206, "GAL E5 bQ"},
104
    {0x0300, "BDS B1I D1"},
105
    {0x0301, "BDS B1I D2"},
106
    {0x0302, "BDS B2I D1"},
107
    {0x0303, "BDS B2I D2"},
108
    {0x0305, "BDS B1 Cp"},
109
    {0x0306, "BDS B1 Cd"},
110
    {0x0307, "BDS B2 ap"},
111
    {0x0308, "BDS B2 ad"},
112
    {0x0508, "QZSS L1 C/A"},
113
    {0x0501, "QZSS L1 S"},
114
    {0x0504, "QZSS L2 CM"},
115
    {0x0505, "QZSS L2 CL"},
116
    {0x0508, "QZSS L5 I"},
117
    {0x0509, "QZSS L5 Q"},
118
    {0x0600, "GLO L1 OF"},
119
    {0x0602, "GLO L2 OF"},
120
    {0x0700, "NavIc L5 A"},
121
    {0, NULL},
122
};
123
124
// UBX-ACK-* ids
125
static const struct vlist_t vack_ids[] = {
126
    {UBX_ACK_ACK, "ACK-ACK"},
127
    {UBX_ACK_NAK, "ACK-NAK"},
128
    {0, NULL},
129
};
130
131
// UBX-INF-* inf_ids
132
static const struct vlist_t vinf_ids[] = {
133
    {UBX_INF_DEBUG, "INF-DEBUG"},
134
    {UBX_INF_TEST, "INF-TEST"},
135
    {UBX_INF_NOTICE, "INF-NOTICE"},
136
    {UBX_INF_WARNING, "INF-WARNING"},
137
    {UBX_INF_ERROR, " INF-ERROR"},
138
    {0, NULL},
139
};
140
141
// UBX-MON-COMMS protIds
142
static const struct vlist_t vprotIds[] = {
143
    {0, "UBX"},
144
    {1, "NMEA"},
145
    {2, "RTCM2"},
146
    {5, "RTCM3"},
147
    {255, "None"},
148
    {0, NULL},
149
};
150
151
// UBX-MON-COMMS txErrors
152
static const struct flist_t vmon_comms_txerrors[] = {
153
    {1, 1, "mem"},
154
    {2, 2, "alloc"},
155
    {0, 0, NULL},
156
};
157
158
// UBX-MON-TXBUF errors
159
static const struct flist_t vmon_txbuf_errors[] = {
160
    {0x40, 0x40, "mem"},
161
    {0x80, 0x80, "alloc"},
162
    {0, 0, NULL},
163
};
164
165
// UBX-MON-HW flags
166
static const struct flist_t vmon_hw_flags[] = {
167
    {1, 1, "RTC Calibrated"},
168
    {2, 2, "Safeboot Active"},
169
    {0x04, 0x0c, "Jam OK"},
170
    {0x08, 0x0c, "Jam Warn"},
171
    {0x0c, 0x0c, "Jam Critical"},
172
    {0x10, 0x10, "xtal Absent"},
173
    {0, 0, NULL},
174
};
175
176
// UBX-MON-HW aPower
177
static const struct vlist_t vaPower[] = {
178
    {0, "Off"},
179
    {1, "On"},
180
    {2, "Unk"},
181
    {0, NULL},
182
};
183
184
// UBX-MON-HW aStatus
185
static const struct vlist_t vaStatus[] = {
186
    {0, "Init"},
187
    {1, "Unk"},
188
    {2, "OK"},
189
    {3, "Short"},
190
    {4, "Open"},
191
    {0, NULL},
192
};
193
194
// UBX-MON-RF blockId
195
static const struct vlist_t vmon_rf_blockId[] = {
196
    {0, "L1 Unk"},
197
    {1, "L2 or L5"},
198
    {0, NULL},
199
};
200
201
// UBX-MON-RF flags
202
static const struct vlist_t vmon_rf_flags[] = {
203
    {0, "Jam Unk"},
204
    {1, "Jam OK"},
205
    {2, "Jam Warn"},
206
    {3, "Jam Crit"},
207
    {0, NULL},
208
};
209
210
// Names for portID values in:
211
//  UBX-CFG-PRT, UBX-MON-IO, UBX-MON-RXBUF, UBX-MON-TXBUF, target
212
static const struct vlist_t vtarget[] = {
213
    {0, "DDC"},             // The license free name for I2C
214
    {1, "UART1"},
215
    {2, "UART2"},
216
    {3, "USB"},
217
    {4, "SPI"},
218
    {0x100, "UART1"},       // MON-COMMS
219
    {0x200, "UART2"},       // MON-COMMS
220
    {0x300, "USB"},         // MON-COMMS
221
    {0x400, "SPI"},         // MON-COMMS
222
    {0, NULL},
223
};
224
225
// UBX-HNR-PVT, UBX-NAV-SOL gpsFix, UBX-NAV-PVT fixType
226
static const struct vlist_t vpvt_fixType[] = {
227
    {0, "None"},
228
    {1, "DR"},
229
    {2, "2D"},
230
    {3, "3D"},
231
    {4, "GNSSDR"},
232
    {5, "Time"},
233
    {0, NULL},
234
};
235
236
// UBX-HNR-PVT flags
237
static const struct flist_t fhnr_pvt_flags[] = {
238
    {1, 1, "gnssFixOK"},
239
    {2, 2, "diffSoln"},
240
    {4, 4, "WKNSET"},
241
    {8, 8, "TOWSET"},
242
    {0x20, 0x20, "headVehValid"},
243
    {0, 0, NULL},
244
};
245
246
// UBX-NAV-PVT flags
247
static const struct flist_t fnav_pvt_flags[] = {
248
    {1, 1, "gnssFixOK"},
249
    {2, 2, "diffSoln"},
250
    {8, 8, "vehRollValid"},
251
    // {0, 0x10, "psmState"},      // ??
252
    {0x10, 0x10, "vehPitchValid"},
253
    {0x10, 0x10, "vehHeadingValid"},  // aka headVelValid
254
    {0x40, 0xc0, "CarrSolnFLT"},
255
    {0x80, 0xc0, "CarrSolnFIX"},
256
    {0, 0, NULL},
257
};
258
259
// UBX-NAV-PVT flags2
260
static const struct flist_t fpvt_flags2[] = {
261
    {0x20, 0x20, "confirmedAvai"},   // protver 19+
262
    {0x40, 0x40, "confirmedDate"},
263
    {0x80, 0x80, "confirmedTime"},
264
    {0, 0, NULL},
265
};
266
267
// UBX-NAV-PVT flags3
268
static const struct flist_t fpvt_flags3[] = {
269
    {0x20, 0x20, "invalLlh"},
270
    {0, 0, NULL},
271
};
272
273
// UBX-HNR-PVT, UBX-NAV-PVT valid
274
static const struct flist_t fpvt_valid[] = {
275
    {1, 1, "validDate"},
276
    {2, 2, "validTime"},
277
    {4, 4, "fullyResolved"},
278
    {8, 8, "validMag"},
279
    {0, 0, NULL},
280
};
281
282
// UBX-NAV-PVT, dgps_age
283
static const int pvt_dgps_age[] = {
284
    -1, 1, 2, 5, 10,
285
    15, 20, 30, 45, 60,
286
    90, 120, 240};
287
288
// UBX-NAV-SAT flags
289
static const struct flist_t fsat_flags[] = {
290
    // bits 0, 1, and 2 == qualityInd
291
    {8, 8, "Used"},
292
    {0x10, 0x30, "healthy"},
293
    {0x20, 0x30, "unhealthy"},
294
    {0x40, 0x40, "diffCorr"},
295
    {0x800, 0x800, "ephAvail"},
296
    {0x1000, 0x1000, "almAvail"},
297
    {0x2000, 0x2000, "anoAvail"},
298
    {0x4000, 0x4000, "aopAvail"},
299
    {0x10000, 0x10000, "sbasCorrUsed"},
300
    {0x20000, 0x20000, "rtcmCorrUsed"},
301
    {0x40000, 0x40000, "slasCorrUsed"},
302
    {0x80000, 0x80000, "spartnCorrUsed"},
303
    {0x100000L, 0x100000L, "prCorrUsed"},
304
    {0x200000L, 0x200000L, "crCorrUsed"},
305
    {0x400000L, 0x400000L, "doCorrUsed"},
306
    {0x800000L, 0x800000L, "cbasCorrUsed"},
307
    {0, 0, NULL},
308
};
309
310
// UBX-NAV-SIG corrSource
311
static const struct vlist_t vsig_corrsource[] = {
312
    {0, "None"},
313
    {1, "SBAS"},
314
    {2, "rBDS"},
315
    {3, "RTCM2"},
316
    {4, "RTCM3 OSR"},
317
    {5, "RTCM3 SSR"},
318
    {6, "QZSS SLAS"},
319
    {7, "SPARTN"},
320
    {8, "CLAS"},
321
    {0, NULL},
322
};
323
324
// UBX-NAV-SIG ionoModel
325
static const struct vlist_t vsig_ionomodel[] = {
326
    {0, "None"},
327
    {1, "Klobuchar GPS"},
328
    {2, "SBAS"},
329
    {8, "Dual F Delay"},
330
    {0, NULL},
331
};
332
333
// UBX-NAV-SIG sigFlags
334
static const struct flist_t fsig_sigFlags[] = {
335
    {1, 3, "healthy"},
336
    {2, 3, "unhealthy"},
337
    {4, 4, "prSmoothed"},
338
    {8, 8, "prUsed"},
339
    {0x10, 0x10, "crUsed"},
340
    {0x20, 0x20, "doUsed"},
341
    {0x40, 0x40, "prCorrUsed"},
342
    {0x80, 0x80, "crCorrUsed"},
343
    {0x100, 0x100, "doCorrUsed"},
344
    {0x200, 0x200, "Authenticated"},  // u-blox M9 SPG, GALILEO
345
    {0, 0, NULL},
346
};
347
348
// UBX-NAV-SVIN active
349
// UBX-TIM-SVIN active
350
static const struct vlist_t vsvin_active[] = {
351
    {0, "Inactive"},
352
    {1, "Active"},
353
    {0, NULL},
354
};
355
356
// UBX-NAV-SVIN valid
357
// UBX-TIM-SVIN valid
358
static const struct vlist_t vsvin_valid[] = {
359
    {0, "Invalid"},
360
    {1, "Valid"},
361
    {0, NULL},
362
};
363
364
// UBX-NAV-SVINFO flags
365
static const struct flist_t fsvinfo_flags[] = {
366
    {1, 1, "svUsed"},
367
    {2, 2, "diffCorr"},
368
    {4, 4, "orbitAvail"},
369
    {8, 8, "orbitEph"},
370
    {0x10, 0x10, "unhealthy"},
371
    {0x20, 0x20, "orbitAlm"},
372
    {0x40, 0x40, "orbitAop"},
373
    {0x80, 0x80, "smoothed"},
374
    {0, 0, NULL},
375
};
376
377
// UBX-NAV-SVINFO globalFlags
378
static const struct vlist_t vglobalFlags[] = {
379
    {0, "Antaris 4"},
380
    {1, "u-blox 5"},
381
    {2, "u-blox 6"},
382
    {3, "u-blox 7"},
383
    {4, "u-blox 8"},
384
    {0, NULL},
385
};
386
387
// UBX-NAV-SAT, UBX-NAV-SVINFO qualtyiInd
388
static const struct vlist_t vquality[] = {
389
    {0, "None"},
390
    {1, "Searching"},
391
    {2, "Acquired"},
392
    {3, "Unusable"},
393
    {4, "Code locked"},
394
    {5, "Carrier locked"},
395
    {6, "Carrier locked"},
396
    {7, "Carrier locked"},
397
    {0, NULL},
398
};
399
400
// UBX-NAV-TIMEGPS valid
401
static const struct flist_t vtimegps_valid[] = {
402
    {1, 1, "towValid"},
403
    {2, 2, "weekValid"},
404
    {4, 4, "leapSValid"},
405
    {0, 0, NULL},
406
};
407
408
// UBX-NAV-TIMELS srcOfCurrLs
409
static const struct vlist_t vsrcOfCurrLs[] = {
410
    {0, "firmware"},
411
    {1, "GPS GLONASS difference"},
412
    {2, "GPS"},
413
    {3, "SBAS"},
414
    {4, "BeiDou"},
415
    {5, "Galileo"},
416
    {6, "Aided data"},
417
    {7, "Configured"},
418
    {0, NULL},
419
};
420
421
// UBX-NAV-TIMELS srcOfLsChange
422
static const struct vlist_t vsrcOfLsChange[] = {
423
    {0, "No Source"},
424
    {1, "Undefined"},
425
    {2, "GPS"},
426
    {3, "SBAS"},
427
    {4, "BeiDou"},
428
    {5, "Galileo"},
429
    {6, "GLONASS"},
430
    {0, NULL},
431
};
432
433
// UBX-NAV-TIMELS valid
434
static const struct flist_t vtimels_valid[] = {
435
    {1, 1, "validCurrLs"},
436
    {2, 2, "validTimeToLsEvent"},
437
    {0, 0, NULL},
438
};
439
440
// start ubx message configuration stuff
441
442
/* UBX-NAV-SOL deprecated in u-blox 6, gone in u-blox 9.
443
 * Use UBX-NAV-PVT after u-blox 7 (protver 15+)
444
 * u-blox 6 w/ GLONASS, protver 14 have NAV-PVT
445
 * UBX-NAV-SOL has same data from NAV-POSECEF and NAV-VELECEF.
446
 * Need NAV-SOL for fix type and fix flags.
447
 * skip NAV-POSLLH as we compute lat/lon/alt/geoid from ECEF.
448
 *
449
 * UBX-NAV-SVINFO deprecated in u-blox 8, gone in u-blox 9.
450
 * Use UBX-NAV-SAT after u-blox 7
451
 *
452
 * UBX-NAV-EOE makes a good cycle ender */
453
454
// nmea to turn off
455
static const unsigned char nmea_off[] = {
456
    0x00,          // msg id  = GGA
457
    0x01,          // msg id  = GLL
458
    0x02,          // msg id  = GSA
459
    0x03,          // msg id  = GSV
460
    0x04,          // msg id  = RMC
461
    0x05,          // msg id  = VTG
462
    0x07,          // msg id  = GST
463
    0x08,          // msg id  = ZDA
464
    0x09,          // msg id  = GBS
465
};
466
467
// UBX-NAV that ww want on, for all protver
468
static const unsigned char ubx_nav_on[] = {
469
    0x04,          // UBX-NAV-DOP
470
    0x20,          // UBX-NAV-TIMEGPS
471
    // UBX-NAV-CLOCK, nice cycle ender if no NAV-EOE (protVer 18)
472
    0x22,
473
};
474
475
// UBX-NAV for protver < 15, not present in protVer >= 27
476
static const unsigned char ubx_14_nav_on[] = {
477
    0x06,              // msg id = NAV-SOL
478
    0x30,              // msg id = NAV-SVINFO
479
};
480
481
// UBX for protver >= 15
482
static const unsigned char ubx_15_nav_on[] = {
483
    // Need NAV-POSECEF, NAV-VELECEF and NAV-PVT to replace NAV-SOL
484
    0x01,              // msg id = NAV-POSECEF
485
    0x07,              // msg id = NAV-PVT
486
    0x11,              // msg id = NAV-VELECEF
487
    0x35,              // msg id = NAV-SAT
488
    0x43,              // msg id = NAV-SIG
489
};
490
491
// end ubx message configuration stuff
492
493
static gps_mask_t ubx_msg_inf(struct gps_device_t *session, unsigned char *buf,
494
                              size_t data_len);
495
static gps_mask_t ubx_msg_log_batch(struct gps_device_t *session,
496
                                    unsigned char *buf, size_t data_len);
497
static gps_mask_t ubx_msg_log_info(struct gps_device_t *session,
498
                                   unsigned char *buf, size_t data_len);
499
static gps_mask_t ubx_msg_log_retrievepos(struct gps_device_t *session,
500
                                          unsigned char *buf, size_t data_len);
501
static gps_mask_t ubx_msg_log_retrieveposextra(struct gps_device_t *session,
502
                                               unsigned char *buf,
503
                                               size_t data_len);
504
static gps_mask_t ubx_msg_log_retrievestring(struct gps_device_t *session,
505
                                             unsigned char *buf,
506
                                             size_t data_len);
507
static gps_mask_t ubx_msg_nav_dop(struct gps_device_t *session,
508
                                  unsigned char *buf, size_t data_len);
509
static gps_mask_t ubx_msg_nav_eoe(struct gps_device_t *session,
510
                                  unsigned char *buf, size_t data_len);
511
static gps_mask_t ubx_msg_nav_posecef(struct gps_device_t *session,
512
                                      unsigned char *buf, size_t data_len);
513
static gps_mask_t ubx_msg_nav_pvt(struct gps_device_t *session,
514
                                  unsigned char *buf, size_t data_len);
515
static gps_mask_t ubx_msg_nav_sat(struct gps_device_t *session,
516
                                  unsigned char *buf, size_t data_len);
517
static gps_mask_t ubx_msg_nav_sbas(struct gps_device_t *session,
518
                                   unsigned char *buf, size_t data_len);
519
static gps_mask_t ubx_msg_nav_sol(struct gps_device_t *session,
520
                                  unsigned char *buf, size_t data_len);
521
static gps_mask_t ubx_msg_nav_svinfo(struct gps_device_t *session,
522
                                     unsigned char *buf, size_t data_len);
523
static gps_mask_t ubx_msg_nav_timegps(struct gps_device_t *session,
524
                                      unsigned char *buf, size_t data_len);
525
static gps_mask_t ubx_msg_sec_uniqid(struct gps_device_t *session,
526
                                  unsigned char *buf, size_t data_len);
527
static gps_mask_t ubx_msg_nav_velecef(struct gps_device_t *session,
528
                                      unsigned char *buf, size_t data_len);
529
static gps_mask_t ubx_msg_tim_tp(struct gps_device_t *session,
530
                                 unsigned char *buf, size_t data_len);
531
static void ubx_mode(struct gps_device_t *session, int mode);
532
533
typedef struct {
534
    const char *fw_string;
535
    const float protver;
536
} fw_protver_map_entry_t;
537
538
/* based on u-blox document no. GPS.G7-SW-12001-B1 (15 June 2018)
539
 * capture decimal parts of protVer info even when session->protver currently
540
 * is integer (which _might_ change in the future, so avoid having to revisit
541
 * the info at that time).
542
 * This list is substantially incomplete and over specific. */
543
static const fw_protver_map_entry_t fw_protver_map[] = {
544
    {"2.10", 8.10},           // antaris 4, version 8 is a guess
545
    {"2.11", 8.11},           // antaris 4, version 8 is a guess
546
    {"3.04", 9.00},           // antaris 4, version 9 is a guess
547
    {"4.00", 10.00},          // antaris 4, and u-blox 5
548
    {"4.01", 10.01},          // antaris 4, and u-blox 5
549
    {"5.00", 11.00},          // u-blox 5 and antaris 4
550
    {"6.00", 12.00},          // u-blox 5 and 6
551
    {"6.02", 12.02},          // u-blox 5 and 6
552
    {"6.02", 12.03},          // u-blox 5 and 6
553
    {"7.01", 13.01},          // u-blox 7
554
    {"7.03", 13.03},          // u-blox 6 and 7
555
    {"1.00", 14.00},          // u-blox 6 w/ GLONASS, and 7
556
    // protVer >14 should carry explicit protVer in MON-VER extension
557
    {NULL, 0.0},
558
};
559
560
/*
561
 * Model  Fw          Protver
562
 * M8     2,01        15.00
563
 * M9     HPG 1.13    27.12
564
 * M10    SPG 5.00    34.00
565
 * F20P   HPG 2.02    50.10
566
 */
567
568
/* send a ubx message.
569
 * calculate checksums, etc.
570
 */
571
bool ubx_write(struct gps_device_t * session,
572
               unsigned int msg_class, unsigned int msg_id,
573
               const unsigned char *msg, size_t data_len)
574
0
{
575
0
    unsigned char CK_A, CK_B;
576
0
    ssize_t count;
577
0
    size_t i;
578
0
    bool ok;
579
580
    // do not write if -b (readonly) option set
581
    // "passive" handled earlier
582
0
    if (session->context->readonly) {
583
0
        return true;
584
0
    }
585
586
0
    session->msgbuf[0] = 0xb5;
587
0
    session->msgbuf[1] = 0x62;
588
589
0
    CK_A = CK_B = 0;
590
0
    session->msgbuf[2] = msg_class;
591
0
    session->msgbuf[3] = msg_id;
592
0
    session->msgbuf[4] = data_len & 0xff;
593
0
    session->msgbuf[5] = (data_len >> 8) & 0xff;
594
595
0
    if ((sizeof(session->msgbuf) - 8) <= data_len) {
596
0
        GPSD_LOG(LOG_ERROR, &session->context->errout,
597
0
                 "=> GPS: UBX class: %02x, id: %02x, len: %zd TOO LONG!\n",
598
0
                 msg_class, msg_id, data_len);
599
0
    }
600
0
    if (NULL != msg &&
601
0
        0 < data_len) {
602
0
        (void)memcpy(&session->msgbuf[6], msg, data_len);
603
0
    }
604
605
    // calculate CRC
606
0
    for (i = 2; i < (6 + data_len); i++) {
607
0
        CK_A += session->msgbuf[i];
608
0
        CK_B += CK_A;
609
0
    }
610
611
0
    session->msgbuf[6 + data_len] = CK_A;
612
0
    session->msgbuf[7 + data_len] = CK_B;
613
0
    session->msgbuflen = data_len + 8;
614
615
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
616
0
             "=> GPS: UBX class: %02x, id: %02x, len: %zd, crc: %02x%02x\n",
617
0
             msg_class, msg_id, data_len,
618
0
             CK_A, CK_B);
619
0
    count = gpsd_write(session, session->msgbuf, session->msgbuflen);
620
0
    ok = (count == (ssize_t) session->msgbuflen);
621
0
    return (ok);
622
0
}
623
624
/* Convert a ubx PRN (single svid) to an NMEA 4.0 (extended)
625
 * PRN and ubx gnssid, svid
626
 *
627
 * This does NOT match NMEA 4.10 and 4.11 where all PRN are 1-99,
628
 * except IMES, QZSS, and some SBAS.
629
 *
630
 * return 0 on fail
631
 */
632
static short ubx_to_prn(int ubx_PRN, unsigned char *gnssId,
633
                        unsigned char *svId)
634
0
{
635
0
    *gnssId = 0;
636
0
    *svId = 0;
637
638
    // IRNSS??
639
0
    if (1 > ubx_PRN) {
640
        // skip 0 PRN
641
0
        return 0;
642
0
    } else if (32 >= ubx_PRN) {
643
        // GPS 1..32 -> 1..32
644
0
        *gnssId = 0;
645
0
        *svId = ubx_PRN;
646
0
    } else if (64 >= ubx_PRN) {
647
        /* BeiDou, 159..163,33..64 -> 1..5,6..37
648
         * Wikipedia, March 2025, says BDS PRNs go up to 62
649
         * Where/how do they map??
650
         * https://en.wikipedia.org/wiki/List_of_BeiDou_satellites */
651
0
        *gnssId = 3;
652
0
        *svId = ubx_PRN - 27;
653
0
    } else if (96 >= ubx_PRN) {
654
        // GLONASS 65..96 -> 1..32
655
0
        *gnssId = 6;
656
0
        *svId = ubx_PRN - 64;
657
0
    } else if (120 > ubx_PRN) {
658
        // Huh?
659
0
        return 0;
660
0
    } else if (158 >= ubx_PRN) {
661
        // SBAS 120..158 -> 120..158
662
0
        *gnssId = 1;
663
0
        *svId = ubx_PRN;
664
0
    } else if (163 >= ubx_PRN) {
665
        // BeiDou, 159..163 -> 1..5
666
0
        *gnssId = 3;
667
0
        *svId = ubx_PRN - 158;
668
0
    } else if (173 > ubx_PRN) {
669
        // Huh?
670
0
        return 0;
671
0
    } else if (182 >= ubx_PRN) {
672
        // IMES 173..182 -> 1..5, in u-blox 8, bot u-blox 9
673
0
        *gnssId = 4;
674
0
        *svId = ubx_PRN - 172;
675
0
    } else if (193 > ubx_PRN) {
676
        // Huh?
677
0
        return 0;
678
0
    } else if (199 >= ubx_PRN) {
679
        // QZSS 193..197 -> 1..5
680
        // ZED-F9T also see 198 and 199
681
0
        *gnssId = 5;
682
0
        *svId = ubx_PRN - 192;
683
0
    } else if (211 > ubx_PRN) {
684
        // Huh?
685
0
        return 0;
686
0
    } else if (246 >= ubx_PRN) {
687
        // Galileo 211..246 -> 1..36
688
0
        *gnssId = 2;
689
0
        *svId = ubx_PRN - 210;
690
0
    } else {
691
        // greater than 246, GLONASS (255), unused, or other unknown
692
0
        return 0;
693
0
    }
694
0
    return ubx2_to_prn(*gnssId, *svId);
695
0
}
696
697
// UBX-ACK-ACK, UBX-ACK-NAK
698
static gps_mask_t ubx_msg_ack(struct gps_device_t *session,
699
                              unsigned char *buf, size_t data_len)
700
0
{
701
0
    unsigned msgid = getbes16(buf, 2);
702
703
0
    if (2 > data_len) {
704
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
705
0
                 "UBX: %s-: runt payload len %zd",
706
0
                 val2str(msgid, vack_ids), data_len);
707
0
        return 0;
708
0
    }
709
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
710
0
             "UBX: %s: class: %02x, id: %02x\n",
711
0
             val2str(msgid, vack_ids),
712
0
             buf[UBX_PREFIX_LEN],
713
0
             buf[UBX_PREFIX_LEN + 1]);
714
0
    return 0;
715
0
}
716
717
// UBX-CFG-DOSC
718
static gps_mask_t ubx_msg_cfg_dosc(struct gps_device_t *session,
719
                                   unsigned char *buf, size_t data_len)
720
0
{
721
0
    unsigned version, numOsc, reserved1;
722
723
0
    if (4 > data_len) {
724
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
725
0
                 "UBX: CFG-DOSC, runt payload len %zd", data_len);
726
0
        return 0;
727
0
    }
728
0
    version = getub(buf, 0);
729
730
0
    if (0 != version) {
731
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
732
0
                 "UBX: CFG-DOSC, unknown version %u\n", version);
733
0
        return 0;
734
0
    }
735
736
0
    numOsc = getub(buf, 1);
737
0
    if (2 < numOsc) {
738
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
739
0
                 "UBX: CFG-DOSC, invalid numOsc %u\n", numOsc);
740
0
        return 0;
741
0
    }
742
0
    reserved1 = getleu16(buf, 2);
743
744
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
745
0
             "UBX: CFG-DOSC: version %u numOsc %u reserved1 x%x \n",
746
0
             version, numOsc, reserved1);
747
748
0
    return 0;
749
0
}
750
751
// UBX-CFG-ESRC
752
static gps_mask_t ubx_msg_cfg_esrc(struct gps_device_t *session,
753
                                   unsigned char *buf, size_t data_len)
754
0
{
755
0
    unsigned version, numSources, reserved1;
756
757
0
    if (4 > data_len) {
758
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
759
0
                 "UBX: CFG-ESRC, runt payload len %zd", data_len);
760
0
        return 0;
761
0
    }
762
0
    version = getub(buf, 0);
763
764
0
    if (0 != version) {
765
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
766
0
                 "UBX: CFG-DOSC, unknown version %u\n", version);
767
0
        return 0;
768
0
    }
769
770
0
    numSources = getub(buf, 1);
771
0
    if (2 < numSources) {
772
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
773
0
                 "UBX: CFG-ESRC, invalid numSources %u\n", numSources);
774
0
        return 0;
775
0
    }
776
0
    reserved1 = getleu16(buf, 2);
777
778
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
779
0
             "UBX: CFG-ESRC: version %u numSources %u reserved1 x%x \n",
780
0
             version, numSources, reserved1);
781
782
0
    return 0;
783
0
}
784
785
// UBX-CFG-RATE
786
// Deprecated in u-blox 10
787
static gps_mask_t ubx_msg_cfg_rate(struct gps_device_t *session,
788
                                   unsigned char *buf, size_t data_len)
789
0
{
790
0
    uint16_t measRate, navRate, timeRef;
791
792
0
    if (6 > data_len) {
793
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
794
0
                 "UBX: CFG-RATE, runt payload len %zd", data_len);
795
0
        return 0;
796
0
    }
797
798
0
    measRate = getleu16(buf, 0);  // Measurement rate (ms)
799
0
    navRate = getleu16(buf, 2);   // Navigation rate (cycles)
800
0
    timeRef = getleu16(buf, 4);   // Time system, e.g. UTC, GPS, ...
801
802
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
803
0
             "UBX: CFG-RATE: measRate %ums, navRate %u cycle(s), timeRef %u\n",
804
0
             (unsigned)measRate, (unsigned)navRate,
805
0
             (unsigned)timeRef);
806
807
    // Update our notion of what the device's measurement rate is
808
0
    MSTOTS(&session->gpsdata.dev.cycle, measRate);
809
810
0
    return 0;
811
0
}
812
813
/* UBX-CFG-VALGET
814
 * Present in protVer 24 and up
815
 */
816
static gps_mask_t ubx_msg_cfg_valget(struct gps_device_t *session,
817
                                   unsigned char *buf, size_t data_len)
818
0
{
819
0
    unsigned version, layer, position;
820
821
0
    if (4 > data_len) {
822
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
823
0
                 "UBX: CFG-VALGET, runt payload len %zd", data_len);
824
0
        return 0;
825
0
    }
826
827
0
    version = getub(buf, 0);        // version
828
829
0
    if (1 != version) {
830
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
831
0
                 "UBX: CFG-VALGET, unknown version %u\n", version);
832
0
        return 0;
833
0
    }
834
835
0
    layer = getub(buf, 1);           // layer
836
0
    position = getleu16(buf, 2);     // position
837
838
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
839
0
             "UBX: CFG-VALGET: version %u layer %u position %u\n",
840
0
             version, layer, position);
841
842
    // FIXME: get the key/value pairs.
843
844
0
    return 0;
845
0
}
846
847
/* UBX-ESF-ALG
848
 *
849
 * UBX-ESF-ALG, and UBX-ESF-INS are synchronous to the GNSS epoch.
850
 * They need to be combined and reported together with the rest of
851
 * the epoch.
852
 */
853
static gps_mask_t ubx_msg_esf_alg(struct gps_device_t *session,
854
                                  unsigned char *buf, size_t data_len)
855
0
{
856
0
    unsigned version, flags, error, reserved1;
857
0
    unsigned long yaw;
858
0
    int pitch, roll;
859
0
    static gps_mask_t mask = 0;
860
861
0
    if (16 > data_len) {
862
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
863
0
                 "UBX: ESF-ALG: runt payload len %zd", data_len);
864
0
        return mask;
865
0
    }
866
867
    // UBX-ESF-ALG is aligned with the GNSS epoch.
868
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
869
870
0
    version = getub(buf, 4);
871
0
    flags = getub(buf, 5);
872
0
    error = getub(buf, 6);
873
0
    reserved1 = getub(buf, 7);
874
0
    yaw = getleu32(buf, 8);
875
0
    pitch = getles16(buf, 12);
876
0
    roll = getles16(buf, 14);
877
878
0
    if (0 == (2 & error)) {
879
        // no yawAlgError
880
0
        session->gpsdata.attitude.yaw = 0.01 * yaw;
881
0
        mask |= ATTITUDE_SET;
882
0
    }
883
0
    if (0 == (5 & error)) {
884
        // no tiltAlgError or angleError
885
0
        session->gpsdata.attitude.roll = 0.01 * roll;
886
0
        session->gpsdata.attitude.pitch = 0.01 * pitch;
887
0
        mask |= ATTITUDE_SET;
888
0
    }
889
890
0
    if (0 != mask) {
891
0
        timespec_t ts_tow;
892
        // got good data, set the measurement time
893
0
        MSTOTS(&ts_tow, session->driver.ubx.iTOW);
894
0
        session->gpsdata.attitude.mtime =
895
0
            gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
896
0
    }
897
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
898
0
             "UBX: ESF-ALG: iTOW %lld version %u flags x%x error x%x"
899
0
             " reserved1 x%x yaw %ld pitch %u roll %u\n",
900
0
            (long long)session->driver.ubx.iTOW, version, flags, error,
901
0
            reserved1, yaw, pitch, roll);
902
903
0
    return mask;
904
0
}
905
906
/* UBX-ESF-INS
907
 *
908
 * protVer 19 and up.  ADR and UDR only
909
 *
910
 * UBX-ESF-ALG, and UBX-ESF-INS are synchronous to the GNSS epoch.
911
 * They need to be combined and reported together with the rest of
912
 * the epoch.
913
 */
914
static gps_mask_t ubx_msg_esf_ins(struct gps_device_t *session,
915
                                  unsigned char *buf, size_t data_len)
916
0
{
917
0
    unsigned long long bitfield0, reserved1;
918
0
    long xAngRate, yAngRate, zAngRate;
919
0
    long xAccel, yAccel, zAccel;
920
0
    static gps_mask_t mask = 0;
921
922
0
    if (16 > data_len) {
923
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
924
0
                 "UBX: ESF-INS: runt payload len %zd", data_len);
925
0
        return mask;
926
0
    }
927
928
0
    bitfield0 = getleu32(buf, 0);
929
0
    reserved1 = getleu32(buf, 4);
930
    // UBX-ESF-INS is aligned with the GNSS epoch.
931
0
    session->driver.ubx.iTOW = getleu32(buf, 8);
932
0
    xAngRate = getles32(buf, 12);
933
0
    yAngRate = getles32(buf, 16);
934
0
    zAngRate = getles32(buf, 20);
935
0
    xAccel = getles32(buf, 24);
936
0
    yAccel = getles32(buf, 28);
937
0
    zAccel = getles32(buf, 32);
938
939
0
    if (0x100 == (0x100 & bitfield0)) {
940
        // xAngRateValid
941
0
        session->gpsdata.attitude.gyro_x = 0.001 * xAngRate;  // deg/s
942
0
        mask |= ATTITUDE_SET;
943
0
    }
944
0
    if (0x200 == (0x200 & bitfield0)) {
945
        // yAngRateValid
946
0
        session->gpsdata.attitude.gyro_y = 0.001 * yAngRate;  // deg/s
947
0
        mask |= ATTITUDE_SET;
948
0
    }
949
0
    if (0x400 == (0x400 & bitfield0)) {
950
        // zAngRateValid
951
0
        session->gpsdata.attitude.gyro_z = 0.001 * zAngRate;  // deg/s
952
0
        mask |= ATTITUDE_SET;
953
0
    }
954
0
    if (0x800 == (0x800 & bitfield0)) {
955
        // xAccelValid
956
0
        session->gpsdata.attitude.acc_x = 0.01 * xAccel;  // m/s^2
957
0
        mask |= ATTITUDE_SET;
958
0
    }
959
0
    if (0x1000 == (0x1000 & bitfield0)) {
960
        // yAccelValid
961
0
        session->gpsdata.attitude.acc_y = 0.01 * yAccel;  // m/s^2
962
0
        mask |= ATTITUDE_SET;
963
0
    }
964
0
    if (0x2000 == (0x2000 & bitfield0)) {
965
        // zAccelValid
966
0
        session->gpsdata.attitude.acc_z = 0.01 * zAccel;  // m/s^2
967
0
        mask |= ATTITUDE_SET;
968
0
    }
969
970
0
    if (0 != mask) {
971
0
        timespec_t ts_tow;
972
        // got good data, set the measurement time
973
0
        MSTOTS(&ts_tow, session->driver.ubx.iTOW);
974
0
        session->gpsdata.attitude.mtime =
975
0
            gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
976
0
    }
977
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
978
0
             "UBX: ESF-INS: bitfield0 %llu, reserved1 %llu iTOW %lld"
979
0
             " xAngRate %ld yAngRate %ld zAngRate %ld"
980
0
             " xAccel %ld yAccel %ld zAccel %ld\n",
981
0
            bitfield0, reserved1,
982
0
            (long long)session->driver.ubx.iTOW,
983
0
            xAngRate, yAngRate, zAngRate, xAccel, yAccel, zAccel);
984
985
0
    return mask;
986
0
}
987
988
/* UBX-ESF-MEAS
989
 *
990
 * protVer 15 and up.  ADR only
991
 * protVer 19 and up.  ADR and UDR only
992
 *
993
 * asynchronous to the GNSS epoch, and at a higher rate.
994
 * Needs to be reported immediately.
995
 *
996
 */
997
static gps_mask_t ubx_msg_esf_meas(struct gps_device_t *session,
998
                                   unsigned char *buf, size_t data_len)
999
0
{
1000
0
    unsigned flags, id, numMeas, expected_len;
1001
0
    gps_mask_t mask = 0;
1002
0
    unsigned i;
1003
    // where to store the IMU data.
1004
0
    struct attitude_t *datap = &session->gpsdata.imu[0];
1005
1006
0
    if (8 > data_len) {
1007
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1008
0
                 "UBX: ESF-MEAS: runt payload len %zd", data_len);
1009
0
        return mask;
1010
0
    }
1011
    // do not accumulate IMU data
1012
0
    gps_clear_att(datap);
1013
0
    (void)strlcpy(datap->msg, "UBX-ESF-MEAS", sizeof(datap->msg));
1014
1015
0
    datap->timeTag = getleu32(buf, 0);
1016
0
    flags = getleu16(buf, 4);
1017
0
    numMeas = (flags >> 11) & 0x01f;
1018
0
    id = getleu16(buf, 6);
1019
0
    expected_len = 8 + (4 * numMeas);
1020
0
    if (0x08 & flags) {
1021
0
        expected_len += 4;
1022
0
    }
1023
0
    if (expected_len != data_len) {
1024
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1025
0
                 "UBX: ESF-MEAS: bad length.  Got %zd, expected %u",
1026
0
                 data_len, expected_len);
1027
0
        return 0;
1028
0
    }
1029
1030
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1031
0
             "UBX: ESF-MEAS: timeTag %lu flags x%x (numMeas %u) id %u\n",
1032
0
             datap->timeTag, flags, numMeas, id);
1033
1034
0
    for (i = 0; i < numMeas; i++) {
1035
0
        unsigned long data, dataField;
1036
0
        long dataF;
1037
0
        unsigned char dataType;
1038
1039
0
        data = getleu32(buf, 8 + (i * 4));
1040
0
        dataType = (unsigned char)(data >> 24) & 0x3f;
1041
0
        dataField = data & BITMASK(24);
1042
0
        switch (dataType) {
1043
0
        case 5:            // gyro z angular rate, deg/s^2
1044
0
            dataF = UINT2INT(dataField, 24);
1045
0
            datap->gyro_z = dataF / 4096.0;
1046
0
            mask |= IMU_SET;
1047
0
            break;
1048
0
        case 12:           // gyro temp, deg C
1049
0
            dataF = UINT2INT(dataField, 24);
1050
0
            datap->gyro_temp = dataF / 100.0;
1051
0
            mask |= IMU_SET;
1052
0
            break;
1053
0
        case 13:           // gyro y angular rate, deg/s^2
1054
0
            dataF = UINT2INT(dataField, 24);
1055
0
            datap->gyro_y = dataF / 4096.0;
1056
0
            mask |= IMU_SET;
1057
0
            break;
1058
0
        case 14:           // gyro x angular rate, deg/s^2
1059
0
            dataF = UINT2INT(dataField, 24);
1060
0
            datap->gyro_x = dataF / 4096.0;
1061
0
            mask |= IMU_SET;
1062
0
            break;
1063
0
        case 16:            // accel x, m/s^2
1064
0
            dataF = UINT2INT(dataField, 24);
1065
0
            datap->acc_x = dataF / 1024.0;
1066
0
            mask |= IMU_SET;
1067
0
            break;
1068
0
        case 17:           // accel y, m/s^2
1069
0
            dataF = UINT2INT(dataField, 24);
1070
0
            datap->acc_y = dataF / 1024.0;
1071
0
            mask |= IMU_SET;
1072
0
            break;
1073
0
        case 18:           // accel z, m/s^2
1074
0
            dataF = UINT2INT(dataField, 24);
1075
0
            datap->acc_z = dataF / 1024.0;
1076
0
            mask |= IMU_SET;
1077
0
            break;
1078
        // case 6:            // front-left wheel ticks
1079
        // case 7:            // front-right wheel ticks
1080
        // case 8:            // rear-left wheel ticks
1081
        // case 9:            // rear-right wheel ticks
1082
        // case 10:           // speed tick
1083
        // case 11:           // speed, m/s
1084
0
        default:
1085
            // ignore all else
1086
0
            dataF = dataField;
1087
0
            break;
1088
0
        }
1089
1090
0
        GPSD_LOG(LOG_PROG + 1, &session->context->errout,
1091
0
                 "UBX: ESF-MEAS: dataType %2u dataField %9ld\n",
1092
0
                 dataType, dataF);
1093
0
    }
1094
1095
0
    return mask;
1096
0
}
1097
1098
/* UBX-ESF-RAW
1099
 *
1100
 * protVer 15 and up.  ADR only
1101
 * protVer 19 and up.  ADR and UDR only
1102
 *
1103
 * asynchronous to the GNSS epoch, and a a higher rate.
1104
 * Needs to be reported immediately.
1105
 *
1106
 */
1107
static gps_mask_t ubx_msg_esf_raw(struct gps_device_t *session,
1108
                                  unsigned char *buf, size_t data_len)
1109
0
{
1110
0
    unsigned long reserved1, last_sTtag = 0;
1111
0
    unsigned i;
1112
0
    uint16_t blocks;
1113
0
    gps_mask_t mask = 0;
1114
0
    struct attitude_t *datap = NULL;
1115
0
    int max_imu, cur_imu = -1;
1116
0
    max_imu = sizeof(session->gpsdata.imu) / sizeof(struct attitude_t);
1117
1118
0
    if (4 > data_len) {
1119
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1120
0
                 "UBX: ESF-RAW:runt payload len %zd", data_len);
1121
0
        return mask;
1122
0
    }
1123
1124
0
    reserved1 = getleu32(buf, 0);  // reserved1
1125
0
    if (0 != ((data_len - 4) % 8)) {
1126
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1127
0
                 "UBX: ESF-RAW: weird payload len %zd", data_len);
1128
0
        return mask;
1129
0
    }
1130
0
    blocks = (data_len - 4) / 8;
1131
1132
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1133
0
             "UBX: ESF-RAW: reserved1 x%lx, blocks %u\n",
1134
0
             reserved1, blocks);
1135
1136
    // loop over all blocks, use the next imu[] when time changes.
1137
0
    for (i = 0; i < blocks; i++) {
1138
0
        unsigned long data, dataField, sTtag;
1139
0
        long dataF;
1140
0
        unsigned char dataType;
1141
1142
0
        sTtag = getleu32(buf, 8 + (i * 8));
1143
0
        if ((-1 == cur_imu) ||
1144
0
            (last_sTtag != sTtag)) {
1145
0
            cur_imu++;
1146
0
            if (max_imu <= cur_imu) {
1147
0
                GPSD_LOG(LOG_WARN, &session->context->errout,
1148
0
                         "UBX: ESF-RAW: too many imu max %d block %u\n",
1149
0
                         max_imu, i);
1150
0
                break;
1151
0
            }
1152
0
            last_sTtag = sTtag;
1153
0
            datap = &session->gpsdata.imu[cur_imu];
1154
            // do not accumulate IMU data
1155
0
            gps_clear_att(datap);
1156
0
            (void)strlcpy(datap->msg, "UBX-ESF-RAW", sizeof(datap->msg));
1157
0
        }
1158
0
        if (NULL == datap) {
1159
            // paranoia
1160
0
            continue;
1161
0
        }
1162
1163
0
        data = getleu32(buf, 4 + (i * 8));
1164
0
        dataType = (unsigned char)(data >> 24) & 0x3f;
1165
0
        dataField = data & BITMASK(24);
1166
0
        datap->timeTag = sTtag;
1167
0
        switch (dataType) {
1168
0
        case 5:            // gyro z angular rate, deg/s^2
1169
0
            dataF = UINT2INT(dataField, 24);
1170
0
            datap->gyro_z = dataF / 4096.0;
1171
0
            mask |= IMU_SET;
1172
0
            break;
1173
0
        case 12:           // gyro temp, deg C
1174
0
            dataF = UINT2INT(dataField, 24);
1175
0
            datap->gyro_temp = dataF / 100.0;
1176
0
            mask |= IMU_SET;
1177
0
            break;
1178
0
        case 13:           // gyro y angular rate, deg/s^2
1179
0
            dataF = UINT2INT(dataField, 24);
1180
0
            datap->gyro_y = dataF / 4096.0;
1181
0
            mask |= IMU_SET;
1182
0
            break;
1183
0
        case 14:           // gyro x angular rate, deg/s^2
1184
0
            dataF = UINT2INT(dataField, 24);
1185
0
            datap->gyro_x = dataF / 4096.0;
1186
0
            mask |= IMU_SET;
1187
0
            break;
1188
0
        case 16:            // accel x, m/s^2
1189
0
            dataF = UINT2INT(dataField, 24);
1190
0
            datap->acc_x = dataF / 1024.0;
1191
0
            mask |= IMU_SET;
1192
0
            break;
1193
0
        case 17:           // accel y, m/s^2
1194
0
            dataF = UINT2INT(dataField, 24);
1195
0
            datap->acc_y = dataF / 1024.0;
1196
0
            mask |= IMU_SET;
1197
0
            break;
1198
0
        case 18:           // accel z, m/s^2
1199
0
            dataF = UINT2INT(dataField, 24);
1200
0
            datap->acc_z = dataF / 1024.0;
1201
0
            mask |= IMU_SET;
1202
0
            break;
1203
        // case 6:            // front-left wheel ticks
1204
        // case 7:            // front-right wheel ticks
1205
        // case 8:            // rear-left wheel ticks
1206
        // case 9:            // rear-right wheel ticks
1207
        // case 10:           // speed tick
1208
        // case 11:           // speed, m/s
1209
0
        default:
1210
            // ignore all else
1211
0
            dataF = dataField;
1212
0
            break;
1213
0
        }
1214
1215
0
        GPSD_LOG(LOG_PROG + 1, &session->context->errout,
1216
0
                 "UBX: ESF-RAW: dataType %2u dataField %9ld sTtag %lu\n",
1217
0
                 dataType, dataF, datap->timeTag);
1218
0
    }
1219
0
    return mask;
1220
0
}
1221
1222
// UBX-ESF-STATUS
1223
static gps_mask_t ubx_msg_esf_status(struct gps_device_t *session,
1224
                                     unsigned char *buf, size_t data_len)
1225
0
{
1226
0
    unsigned version, fusionMode, numSens, expected_len;
1227
0
    static gps_mask_t mask = 0;
1228
1229
0
    if (16 > data_len) {
1230
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1231
0
                 "UBX: ESF-STATUS:runt payload len %zd", data_len);
1232
0
        return mask;
1233
0
    }
1234
1235
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
1236
0
    version = getub(buf, 4);
1237
0
    fusionMode = getub(buf, 12);
1238
0
    numSens = getub(buf, 15);
1239
0
    expected_len = 16 + (4 * numSens);
1240
1241
0
    if (expected_len != data_len) {
1242
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1243
0
                 "UBX: ESF-STATUS: bad length.  Expected %u got %zd",
1244
0
                 expected_len, data_len);
1245
0
        return mask;
1246
0
    }
1247
1248
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1249
0
             "UBX: ESF-STATUS: iTOW %lld version %u fusionMode %u numSens %u\n",
1250
0
            (long long)session->driver.ubx.iTOW, version, fusionMode, numSens);
1251
1252
0
    return mask;
1253
0
}
1254
1255
/**
1256
 * HNR Attitude solution
1257
 * UBX-HNR-ATT Class x28, ID 1
1258
 *
1259
 * Not before u-blox 8, protVer 19.2 and up.
1260
 * only on ADR, and UDR
1261
 */
1262
static gps_mask_t ubx_msg_hnr_att(struct gps_device_t *session,
1263
                                  unsigned char *buf, size_t data_len)
1264
0
{
1265
0
    uint8_t version;
1266
0
    int64_t iTOW;
1267
0
    timespec_t ts_tow;
1268
0
    gps_mask_t mask = 0;
1269
1270
0
    if (32 > data_len) {
1271
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1272
0
                 "UBX: HNR-ATT: runt payload len %zd", data_len);
1273
0
        return 0;
1274
0
    }
1275
1276
    // don't set session->driver.ubx.iTOW, HNR is off-cycle
1277
0
    iTOW = getleu32(buf, 0);
1278
0
    MSTOTS(&ts_tow, iTOW);
1279
0
    session->gpsdata.attitude.mtime =
1280
0
        gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
1281
1282
0
    version  = (unsigned int)getub(buf, 4);
1283
1284
0
    session->gpsdata.attitude.roll = 1e-5 * getles32(buf, 8);
1285
0
    session->gpsdata.attitude.pitch = 1e-5 * getles32(buf, 12);
1286
    // seems to be true heading
1287
0
    session->gpsdata.attitude.heading = 1e-5 * getles32(buf, 16);
1288
0
    mask |= ATTITUDE_SET;
1289
1290
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1291
0
         "UBX: HNR-ATT: iTOW %lld version %u roll %.5f pitch %.5f "
1292
0
         "heading %.5f\n",
1293
0
         (long long)iTOW,
1294
0
         version,
1295
0
         session->gpsdata.attitude.roll,
1296
0
         session->gpsdata.attitude.pitch,
1297
0
         session->gpsdata.attitude.heading);
1298
1299
0
    return mask;
1300
0
}
1301
1302
/**
1303
 * HNR Vehicle dynamics information
1304
 * UBX-HNR-INS Class x28, ID 2
1305
 *
1306
 * Not before u-blox 8, protVer 19.1 and up.
1307
 * only on ADR, and UDR
1308
 */
1309
static gps_mask_t ubx_msg_hnr_ins(struct gps_device_t *session,
1310
                                  unsigned char *buf, size_t data_len)
1311
0
{
1312
0
    uint8_t version;
1313
0
    uint32_t bitfield0;
1314
0
    gps_mask_t mask = 0;
1315
0
    int64_t iTOW;
1316
1317
0
    if (36 > data_len) {
1318
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1319
0
                 "UBX: HNR-INS: runt payload len %zd", data_len);
1320
0
        return 0;
1321
0
    }
1322
1323
0
    version  = (unsigned int)getub(buf, 0);
1324
1325
0
    bitfield0 = getleu32(buf, 0);
1326
    // don't set session->driver.ubx.iTOW, HNR is off-cycle
1327
0
    iTOW = getleu32(buf, 8);
1328
1329
0
    if (0x100 == (0x100 & bitfield0)) {
1330
        // xAngRateValid
1331
0
        session->gpsdata.attitude.gyro_x = 0.001 * getles32(buf, 12);  // deg/s
1332
0
        mask |= ATTITUDE_SET;
1333
0
    }
1334
0
    if (0x200 == (0x200 & bitfield0)) {
1335
        // yAngRateValid
1336
0
        session->gpsdata.attitude.gyro_y = 0.001 * getles32(buf, 16);  // deg/s
1337
0
        mask |= ATTITUDE_SET;
1338
0
    }
1339
0
    if (0x400 == (0x400 & bitfield0)) {
1340
        // zAngRateValid
1341
0
        session->gpsdata.attitude.gyro_z = 0.001 * getles32(buf, 20);  // deg/s
1342
0
        mask |= ATTITUDE_SET;
1343
0
    }
1344
0
    if (0x800 == (0x800 & bitfield0)) {
1345
        // xAccelValid
1346
0
        session->gpsdata.attitude.acc_x = 0.01 * getles32(buf, 24);  // m/s^2
1347
0
        mask |= ATTITUDE_SET;
1348
0
    }
1349
0
    if (0x1000 == (0x1000 & bitfield0)) {
1350
        // yAccelValid
1351
0
        session->gpsdata.attitude.acc_y = 0.01 * getles32(buf, 28);  // m/s^2
1352
0
        mask |= ATTITUDE_SET;
1353
0
    }
1354
0
    if (0x2000 == (0x2000 & bitfield0)) {
1355
        // zAccelValid
1356
0
        session->gpsdata.attitude.acc_z = 0.01 * getles32(buf, 32);  // m/s^2
1357
0
        mask |= ATTITUDE_SET;
1358
0
    }
1359
1360
0
    if (0 != mask) {
1361
0
        timespec_t ts_tow;
1362
        // got good data, set the measurement time
1363
0
        MSTOTS(&ts_tow, iTOW);
1364
0
        session->gpsdata.attitude.mtime =
1365
0
            gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
1366
0
    }
1367
1368
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1369
0
         "UBX: HNR-INS: iTOW %lld version %u bitfield0 x%x "
1370
0
         "gyro_x %.3f gyro_y %.3f gyro_z %.3f "
1371
0
         "acc_x %.3f acc_y %.3f acc_z %.3f\n",
1372
0
         (long long)iTOW,
1373
0
         version, bitfield0,
1374
0
         session->gpsdata.attitude.gyro_x,
1375
0
         session->gpsdata.attitude.gyro_y,
1376
0
         session->gpsdata.attitude.gyro_z,
1377
0
         session->gpsdata.attitude.acc_x,
1378
0
         session->gpsdata.attitude.acc_y,
1379
0
         session->gpsdata.attitude.acc_z);
1380
1381
0
    return mask;
1382
0
}
1383
1384
/**
1385
 * High rate output of PVT solution
1386
 * UBX-HNR-PVT Class x28, ID 2
1387
 *
1388
 * Present in:
1389
 *    protVer 19 and up
1390
 *    only on ADR, and UDR
1391
 */
1392
static gps_mask_t ubx_msg_hnr_pvt(struct gps_device_t *session,
1393
                                  unsigned char *buf, size_t data_len)
1394
0
{
1395
0
    char buf2[80];
1396
0
    char buf3[80];
1397
0
    char ts_buf[TIMESPEC_LEN];
1398
0
    gps_mask_t mask = 0;
1399
0
    int64_t iTOW;
1400
0
    int *mode = &session->newdata.mode;
1401
0
    int *status = &session->newdata.status;
1402
0
    struct tm unpacked_date = {0};
1403
0
    unsigned flags;
1404
0
    unsigned gpsFix;    // same as NAV-PVT typeFix
1405
0
    unsigned valid;
1406
1407
0
    if (72 > data_len) {
1408
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1409
0
                 "UBX: HNR-PVT: runt payload len %zd", data_len);
1410
0
        return 0;
1411
0
    }
1412
1413
    // don't set session->driver.ubx.iTOW, HNR is off-cycle
1414
0
    iTOW = getleu32(buf, 0);
1415
    // valid same as UBX-NAV-PVT valid
1416
0
    valid = (unsigned int)getub(buf, 11);
1417
    // gpsFix same as UBX-NAV-PVT fixType
1418
0
    gpsFix = (unsigned char)getub(buf, 16);
1419
    // flags NOT same as UBX-NAV-PVT flags
1420
0
    flags = (unsigned int)getub(buf, 17);
1421
1422
0
    switch (gpsFix) {
1423
0
    case UBX_MODE_TMONLY:
1424
        // 5 - Surveyed-in, so a precise 3D.
1425
0
        *mode = MODE_3D;
1426
0
        *status = STATUS_TIME;
1427
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
1428
0
        break;
1429
1430
0
    case UBX_MODE_3D:
1431
        // 3
1432
0
        *mode = MODE_3D;
1433
0
        *status = STATUS_GPS;
1434
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
1435
0
        break;
1436
1437
0
    case UBX_MODE_GPSDR:
1438
        // 4
1439
0
        *mode = MODE_3D;
1440
0
        *status = STATUS_GNSSDR;
1441
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
1442
0
        break;
1443
1444
0
    case UBX_MODE_2D:
1445
        // 2
1446
0
        *mode = MODE_2D;
1447
0
        *status = STATUS_GPS;
1448
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
1449
0
        break;
1450
1451
0
    case UBX_MODE_DR:           // consider this too as 2D
1452
        // 1
1453
        // should be 3D?
1454
0
        *mode = MODE_2D;
1455
0
        *status = STATUS_DR;
1456
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
1457
0
        break;
1458
1459
0
    case UBX_MODE_NOFIX:
1460
        // 0
1461
0
        FALLTHROUGH
1462
0
    default:
1463
        // huh?
1464
0
        *mode = MODE_NO_FIX;
1465
0
        *status = STATUS_UNK;
1466
0
        mask |= MODE_SET | STATUS_SET;
1467
0
        break;
1468
0
    }
1469
1470
0
    if (UBX_NAV_PVT_FLAG_DGPS == (flags & UBX_NAV_PVT_FLAG_DGPS)) {
1471
        // RTK flags not in u-blox 8
1472
0
        if (UBX_NAV_PVT_FLAG_RTK_FIX == (flags & UBX_NAV_PVT_FLAG_RTK_FIX)) {
1473
0
            *status = STATUS_RTK_FIX;
1474
0
        } else if (UBX_NAV_PVT_FLAG_RTK_FLT ==
1475
0
                   (flags & UBX_NAV_PVT_FLAG_RTK_FLT)) {
1476
0
            *status = STATUS_RTK_FLT;
1477
0
        } else {
1478
0
            *status = STATUS_DGPS;
1479
0
        }
1480
0
        mask |= STATUS_SET;
1481
0
    }
1482
1483
0
    if (UBX_NAV_PVT_VALID_DATE_TIME == (valid & UBX_NAV_PVT_VALID_DATE_TIME)) {
1484
0
        unpacked_date.tm_year = (uint16_t)getleu16(buf, 4) - 1900;
1485
0
        unpacked_date.tm_mon = (uint8_t)getub(buf, 6) - 1;
1486
0
        unpacked_date.tm_mday = (uint8_t)getub(buf, 7);
1487
0
        unpacked_date.tm_hour = (uint8_t)getub(buf, 8);
1488
0
        unpacked_date.tm_min = (uint8_t)getub(buf, 9);
1489
0
        unpacked_date.tm_sec = (uint8_t)getub(buf, 10);
1490
0
        unpacked_date.tm_isdst = 0;
1491
0
        unpacked_date.tm_wday = 0;
1492
0
        unpacked_date.tm_yday = 0;
1493
0
        session->newdata.time.tv_sec = mkgmtime(&unpacked_date);
1494
        // field 9, nano, can be negative! So normalize
1495
0
        session->newdata.time.tv_nsec = getles32(buf, 12);
1496
0
        TS_NORM(&session->newdata.time);
1497
0
        mask |= TIME_SET | NTPTIME_IS | GOODTIME_IS;
1498
0
    }
1499
1500
0
    session->newdata.longitude = 1e-7 * getles32(buf, 20);
1501
0
    session->newdata.latitude = 1e-7 * getles32(buf, 24);
1502
    // altitude WGS84
1503
0
    session->newdata.altHAE = (double)1e-3 * getles32(buf, 28);
1504
    // altitude MSL, double to prevent promotion to (long double)
1505
0
    session->newdata.altMSL = (double)1e-3 * getles32(buf, 32);
1506
    // Let gpsd_error_model() deal with geoid_sep
1507
1508
    // gSpeed (2D)
1509
0
    session->newdata.speed = 1e-3 * (int32_t)getles32(buf, 36);
1510
    // offset 40,  Speed (3D) do what with it?
1511
    // u-blox calls this headMot (Heading of motion 2-D)
1512
0
    session->newdata.track = 1e-5 * (int32_t)getles32(buf, 44);
1513
    // offset 48, headVeh (Heading of Vehicle 2-D)
1514
0
    mask |= LATLON_SET | ALTITUDE_SET | SPEED_SET | TRACK_SET;
1515
1516
    /* u-blox does not document the basis for the following "accuracy"
1517
     * estimates.  Maybe CEP(50), one sigma, two sigma, CEP(99), etc. */
1518
1519
    // Horizontal Accuracy estimate, in mm
1520
0
    session->newdata.eph = (double)(getles32(buf, 52) / 1000.0);
1521
    // Vertical Accuracy estimate, in mm
1522
0
    session->newdata.epv = (double)(getles32(buf, 56) / 1000.0);
1523
    // Speed Accuracy estimate, in mm/s
1524
0
    session->newdata.eps = (double)(getles32(buf, 60) / 1000.0);
1525
    // headAcc (Heading Accuracy)
1526
0
    session->newdata.epd = (double)getles32(buf, 64) * 1e-5;
1527
    // let gpsd_error_model() do the rest
1528
1529
    // 4 final bytes reserved
1530
1531
0
    mask |= HERR_SET | SPEEDERR_SET | VERR_SET;
1532
    // HNR-PVT interleaves with the normal cycle, so cycle end is a mess
1533
0
    mask |= REPORT_IS;
1534
1535
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1536
0
         "UBX: HNR-PVT: iTOW %lld flags %02x time %s lat %.2f lon %.2f "
1537
0
         "altHAE %.2f track %.2f speed %.2f climb %.2f mode %d status %d "
1538
0
         "used %d\n",
1539
0
         (long long)iTOW, flags,
1540
0
         timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
1541
0
         session->newdata.latitude,
1542
0
         session->newdata.longitude,
1543
0
         session->newdata.altHAE,
1544
0
         session->newdata.track,
1545
0
         session->newdata.speed,
1546
0
         session->newdata.climb,
1547
0
         session->newdata.mode,
1548
0
         session->newdata.status,
1549
0
         session->gpsdata.satellites_used);
1550
0
    GPSD_LOG(LOG_IO, &session->context->errout,
1551
0
             "UBX: HNR-PVT: gpsFix:%s flags:%s valid:%s\n",
1552
0
             val2str(gpsFix, vpvt_fixType),
1553
0
             flags2str(flags, fhnr_pvt_flags, buf2, sizeof(buf2)),
1554
0
             flags2str(valid, fpvt_valid, buf3, sizeof(buf3)));
1555
1556
0
    return mask;
1557
0
}
1558
1559
/* UBX-INF-*
1560
 *
1561
 * Present in:
1562
 *   protVer 13 (6-series)
1563
 *   to
1564
 *   protVer 34 (10-series)
1565
 */
1566
static gps_mask_t ubx_msg_inf(struct gps_device_t *session,
1567
                              unsigned char *buf, size_t data_len)
1568
0
{
1569
0
    unsigned msgid = getbes16(buf, 2);
1570
1571
    // No minimum payload length
1572
1573
0
    if (data_len > MAX_PACKET_LENGTH - 1) {
1574
0
        data_len = MAX_PACKET_LENGTH - 1;
1575
0
    }
1576
1577
0
    GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: %s: %.*s\n",
1578
0
             val2str(msgid, vinf_ids),
1579
0
             (int)data_len, (char *)buf + UBX_PREFIX_LEN);
1580
0
    return 0;
1581
0
}
1582
1583
/**
1584
 * UBX-LOG-BATCH entry only part of UBX protocol
1585
 * Used for GPS standalone operation (internal batch retrieval)
1586
 */
1587
static gps_mask_t ubx_msg_log_batch(struct gps_device_t *session,
1588
                                    unsigned char *buf UNUSED, size_t data_len)
1589
0
{
1590
0
    struct tm unpacked_date = {0};
1591
0
    unsigned char contentValid, timeValid, flags, psmState;
1592
0
    bool gnssFixOK, diffSoln;
1593
0
    char ts_buf[TIMESPEC_LEN];
1594
0
    gps_mask_t mask = 0;
1595
1596
0
    gps_clear_log(&session->gpsdata.log);
1597
    // u-blox 8 100 bytes payload
1598
0
    if (100 > data_len) {
1599
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1600
0
                 "UBX: LOG-BATCH: runt len %zd", data_len);
1601
0
        return 0;
1602
0
    }
1603
0
    timeValid = getub(buf, 15);
1604
0
    if (3 != (timeValid & 3)) {
1605
        // No time, pointless...
1606
0
        return 0;
1607
0
    }
1608
1609
0
    unpacked_date.tm_year = getleu16(buf, 8) - 1900;
1610
0
    unpacked_date.tm_mon = getub(buf, 10) - 1;
1611
0
    unpacked_date.tm_mday = getub(buf, 11);
1612
0
    unpacked_date.tm_hour = getub(buf, 12);
1613
0
    unpacked_date.tm_min = getub(buf, 13);
1614
0
    unpacked_date.tm_sec = getub(buf, 14);
1615
1616
0
    contentValid = getub(buf, 1);
1617
0
    session->gpsdata.log.index_cnt = getleu16(buf, 2);
1618
1619
0
    session->gpsdata.log.then.tv_sec = mkgmtime(&unpacked_date);
1620
0
    session->gpsdata.log.then.tv_nsec = getles32(buf, 20);
1621
0
    TS_NORM(&session->gpsdata.log.then);
1622
1623
0
    session->gpsdata.log.fixType = getub(buf, 24);
1624
0
    flags = getub(   buf, 25);
1625
0
    gnssFixOK = flags & 1;
1626
0
    diffSoln = flags & 2;
1627
0
    psmState = ((flags >> 2) & 7);
1628
1629
    // flags2 undocumented
1630
    // flags2 = getub(   buf, 26);
1631
1632
0
    if ((gnssFixOK &&
1633
0
         2 <= session->gpsdata.log.fixType)) {
1634
        // good 2D fix
1635
0
        session->gpsdata.log.lon = 1.0e-7 * getles32(buf, 28);
1636
0
        session->gpsdata.log.lat = 1.0e-7 * getles32(buf, 32);
1637
0
        session->gpsdata.log.gSpeed = 1.0e-3 * getles32(buf, 64);
1638
        // seems to be true heading
1639
0
        session->gpsdata.log.heading = 1.0e-5 * getles32(buf, 68);
1640
0
        if (diffSoln) {
1641
0
            session->gpsdata.log.status = STATUS_DGPS;
1642
0
        } else {
1643
0
            session->gpsdata.log.status = STATUS_GPS;
1644
0
        }
1645
0
        if (3 <= session->gpsdata.log.fixType) {
1646
            // good 3D fix
1647
0
            session->gpsdata.log.altHAE = 1.0e-3 * getles32(buf, 36);
1648
0
        }
1649
0
    }
1650
0
    session->gpsdata.log.hAcc = 1.0e-3 * getleu32(buf, 44);
1651
1652
0
    GPSD_LOG(LOG_INF, &session->context->errout,
1653
0
            "UBX: LOG-BATCH: time=%s index_cnt=%u fixType=%u lon=%.7f lat=%.7f"
1654
0
             " gSpeed=%.3f heading=%.5f altHae=%.3f psmState=%u hAcc=%.3f\n",
1655
0
             timespec_str(&session->gpsdata.log.then, ts_buf, sizeof(ts_buf)),
1656
0
             session->gpsdata.log.index_cnt, session->gpsdata.log.fixType,
1657
0
             session->gpsdata.log.lon, session->gpsdata.log.lat,
1658
0
             session->gpsdata.log.gSpeed, session->gpsdata.log.heading,
1659
0
             session->gpsdata.log.altHAE, psmState,
1660
0
             session->gpsdata.log.hAcc);
1661
1662
1663
0
    if (1 == (contentValid & 1)) {
1664
        // extraPVT valid
1665
        //  iTOW = getleu32(buf, 4);
1666
0
        session->gpsdata.log.tAcc = (double)getleu32(buf, 16);
1667
0
        session->gpsdata.log.numSV = getub(buf, 27);
1668
0
        session->gpsdata.log.altMSL = 1.0e-3 * getles32(buf, 40);
1669
0
        session->gpsdata.log.vAcc = 1.0e-3 * getleu32(buf, 48);
1670
0
        session->gpsdata.log.velN = 1.0e-3 * getles32(buf, 52);
1671
0
        session->gpsdata.log.velE = 1.0e-3 * getles32(buf, 56);
1672
0
        session->gpsdata.log.velD = 1.0e-3 * getles32(buf, 60);
1673
0
        session->gpsdata.log.sAcc = 1.0e-3 * getleu32(buf, 72);
1674
0
        session->gpsdata.log.headAcc = 1.0e-5 * getleu32(buf, 76);
1675
0
        session->gpsdata.log.pDOP = 1.0e-2 * getleu32(buf, 80);
1676
0
        GPSD_LOG(LOG_INF, &session->context->errout,
1677
0
                "UBX: LOG-BATCH extraPVT: time=%s index_cnt=%d"
1678
0
                 " tAcc=%.2f numSV=%d altMSL=%.3f hAcc=%.2f vAcc=%.3f"
1679
0
                 " velN=%.3f velE=%.3f velD=%.3f sAcc=%.3f headAcc=%.5f"
1680
0
                 " pDOP=%.5f\n",
1681
0
                 timespec_str(&session->gpsdata.log.then, ts_buf,
1682
0
                              sizeof(ts_buf)),
1683
0
                 session->gpsdata.log.index_cnt,
1684
0
                 session->gpsdata.log.tAcc, session->gpsdata.log.numSV,
1685
0
                 session->gpsdata.log.altMSL, session->gpsdata.log.hAcc,
1686
0
                 session->gpsdata.log.vAcc, session->gpsdata.log.velN,
1687
0
                 session->gpsdata.log.velE, session->gpsdata.log.velD,
1688
0
                 session->gpsdata.log.sAcc, session->gpsdata.log.headAcc,
1689
0
                 session->gpsdata.log.pDOP);
1690
0
    }
1691
1692
0
    if (2 == (contentValid & 2)) {
1693
0
        session->gpsdata.log.distance = getleu32(buf, 84);
1694
0
        session->gpsdata.log.totalDistance = getleu32(buf, 88);
1695
0
        session->gpsdata.log.distanceStd = getleu32(buf, 92);
1696
0
        GPSD_LOG(LOG_INF, &session->context->errout,
1697
0
                 "UBX: LOG-BATCH extraOdo: time=%s index_cnt=%d distance=%.0f"
1698
0
                 " totalDistance=%.0f distanceStd=%.0f\n",
1699
0
                 timespec_str(&session->gpsdata.log.then, ts_buf,
1700
0
                              sizeof(ts_buf)),
1701
0
                 session->gpsdata.log.index_cnt, session->gpsdata.log.distance,
1702
0
                 session->gpsdata.log.totalDistance,
1703
0
                 session->gpsdata.log.distanceStd);
1704
0
    }
1705
1706
0
    mask |= LOG_SET;
1707
0
    return mask;
1708
0
}
1709
1710
/**
1711
 * UBX-LOG-INFO info of log status
1712
 * u-blox 7,8,9.  protVer 14 to 29
1713
 * WIP: Initial decode, log only.
1714
 *
1715
 */
1716
static gps_mask_t ubx_msg_log_info(struct gps_device_t *session,
1717
                                   unsigned char *buf UNUSED, size_t data_len)
1718
0
{
1719
0
    struct tm oldest_date = {0}, newest_date = {0};
1720
0
    timespec_t oldest = {0, 0};
1721
0
    timespec_t newest = {0, 0};
1722
0
    unsigned char version, status;
1723
0
    unsigned long filestoreCapacity;
1724
0
    unsigned long currentMaxLogSize;
1725
0
    unsigned long currentLogSize;
1726
0
    unsigned long entryCount;
1727
0
    char ts_buf[TIMESPEC_LEN];
1728
0
    char ts_buf1[TIMESPEC_LEN];
1729
0
    gps_mask_t mask = 0;
1730
1731
0
    gps_clear_log(&session->gpsdata.log);
1732
    // u-blox 7/8/9 48 bytes payload
1733
0
    if (48 > data_len) {
1734
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1735
0
                 "UBX: LOG-INFO: runt len %zd", data_len);
1736
0
        return 0;
1737
0
    }
1738
    // u-blox 7/8/9 version 1
1739
0
    version = getub(buf, 0);
1740
0
    filestoreCapacity = getleu32(buf, 4);
1741
0
    currentMaxLogSize = getleu32(buf, 16);
1742
0
    currentLogSize = getleu32(buf, 20);
1743
0
    entryCount = getleu32(buf, 24);
1744
0
    status = getub(buf, 44);
1745
1746
0
    oldest_date.tm_year = getleu16(buf, 28);
1747
0
    if (0 != oldest_date.tm_year) {
1748
0
        oldest_date.tm_year -= 1900;
1749
0
        oldest_date.tm_mon = getub(buf, 30) - 1;
1750
0
        oldest_date.tm_mday = getub(buf, 31);
1751
0
        oldest_date.tm_hour = getub(buf, 32);
1752
0
        oldest_date.tm_min = getub(buf, 33);
1753
0
        oldest_date.tm_sec = getub(buf, 34);
1754
0
        oldest.tv_sec = mkgmtime(&oldest_date);
1755
0
        oldest.tv_nsec = 0;
1756
0
        TS_NORM(&oldest);
1757
0
    }
1758
1759
0
    newest_date.tm_year = getleu16(buf, 36);
1760
0
    if (0 != newest_date.tm_year) {
1761
0
        newest_date.tm_year -= 1900;
1762
0
        newest_date.tm_mon = getub(buf, 38) - 1;
1763
0
        newest_date.tm_mday = getub(buf, 39);
1764
0
        newest_date.tm_hour = getub(buf, 40);
1765
0
        newest_date.tm_min = getub(buf, 41);
1766
0
        newest_date.tm_sec = getub(buf, 42);
1767
0
        newest.tv_sec = mkgmtime(&newest_date);
1768
0
        newest.tv_nsec = 0;
1769
0
        TS_NORM(&newest);
1770
0
    }
1771
1772
0
    GPSD_LOG(LOG_INF, &session->context->errout,
1773
0
             "UBX: LOG-INFO: version=%u status=x%x Cap=%lu MaxSize=%lu "
1774
0
             "Size=%lu cnt=%lu oldest=%s newest=%s\n",
1775
0
             version, status,
1776
0
             filestoreCapacity,
1777
0
             currentMaxLogSize,
1778
0
             currentLogSize,
1779
0
             entryCount,
1780
0
             timespec_str(&oldest, ts_buf, sizeof(ts_buf)),
1781
0
             timespec_str(&newest, ts_buf1, sizeof(ts_buf1)));
1782
1783
    // mask |= LOG_SET;
1784
0
    return mask;
1785
0
}
1786
1787
/*
1788
 * UBX-LOG-RETRIEVEPOS (Indexed PVT entry)
1789
 * Used for GPS standalone operation and host saved logs
1790
 * u-blox 7,8,9.  protVer 14 to 29
1791
 */
1792
static gps_mask_t ubx_msg_log_retrievepos(struct gps_device_t *session,
1793
                                          unsigned char *buf UNUSED,
1794
                                          size_t data_len)
1795
0
{
1796
0
    struct tm unpacked_date = {0};
1797
0
    unsigned char fixType;
1798
0
    gps_mask_t mask = 0;
1799
1800
0
    gps_clear_log(&session->gpsdata.log);
1801
    // u-blox 40 bytes payload
1802
0
    if (40 > data_len) {
1803
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1804
0
                 "UBX: LOG-RETRIEVEPOS: runt len %zd", data_len);
1805
0
        return 0;
1806
0
    }
1807
0
    unpacked_date.tm_year = getleu16(buf, 30);
1808
0
    if (1900 > unpacked_date.tm_year) {
1809
        // useless, no date
1810
0
        return 0;
1811
0
    }
1812
0
    unpacked_date.tm_year -= 1900;
1813
0
    unpacked_date.tm_mon = getub(buf, 32) - 1;
1814
0
    unpacked_date.tm_mday = getub(buf, 33);
1815
0
    unpacked_date.tm_hour = getub(buf, 34);
1816
0
    unpacked_date.tm_min = getub(buf, 35);
1817
0
    unpacked_date.tm_sec = getub(buf, 36);
1818
0
    session->gpsdata.log.then.tv_sec = mkgmtime(&unpacked_date);
1819
1820
0
    session->gpsdata.log.index_cnt = getleu32(buf, 0);
1821
0
    session->gpsdata.log.lon = getleu32(buf, 4) * 1.0e-7;
1822
0
    session->gpsdata.log.lat = getleu32(buf, 8) * 1.0e-7;
1823
0
    session->gpsdata.log.altMSL = getleu32(buf, 12) * 1.0e-3;
1824
    // hAcc CEP() unspecified...
1825
0
    session->gpsdata.log.hAcc = getleu32(buf, 16) * 1.0e-3;
1826
0
    session->gpsdata.log.gSpeed = getleu32(buf, 20) * 1.0e-3;
1827
    // seems to be true heading
1828
0
    session->gpsdata.log.heading = getleu32(buf, 24) * 1.0e-5;
1829
0
    fixType = getub(buf, 29);
1830
0
    session->gpsdata.log.numSV = getub(buf, 38);
1831
1832
0
    switch (fixType) {
1833
0
    case 1:
1834
        // doc is unclear: 2D or 3D?
1835
0
        session->gpsdata.log.fixType = MODE_3D;
1836
0
        session->gpsdata.log.status = STATUS_DR;
1837
0
        break;
1838
0
    case 2:
1839
0
        session->gpsdata.log.fixType = MODE_2D;
1840
0
        session->gpsdata.log.status = STATUS_GPS;
1841
0
        break;
1842
0
    case 3:
1843
0
        session->gpsdata.log.fixType = MODE_3D;
1844
0
        session->gpsdata.log.status = STATUS_GPS;
1845
0
        break;
1846
0
    case 4:
1847
        // doc is unclear: 2D or 3D?
1848
0
        session->gpsdata.log.fixType = MODE_3D;
1849
0
        session->gpsdata.log.status = STATUS_GNSSDR;
1850
0
        break;
1851
1852
0
    case 0:
1853
0
        FALLTHROUGH
1854
0
    default:
1855
        // huh?
1856
0
        session->gpsdata.log.fixType = MODE_NO_FIX;
1857
0
        session->gpsdata.log.status = STATUS_UNK;
1858
0
        break;
1859
0
    }
1860
1861
    // (long long) because of time_t
1862
0
    GPSD_LOG(LOG_INF, &session->context->errout,
1863
0
             "UBX: LOG-RETRIEVEPOS: time=%lld entryIndex=%d"
1864
0
             " lon=%.7f lat=%.7f altMSL=%.3f hAcc=%.3f"
1865
0
             " gspeed=%.3f heading=%.5f fixType=%d numSV=%d\n",
1866
0
             (long long)session->gpsdata.log.then.tv_sec,
1867
0
             session->gpsdata.log.index_cnt, session->gpsdata.log.lon,
1868
0
             session->gpsdata.log.lat, session->gpsdata.log.altMSL,
1869
0
             session->gpsdata.log.hAcc, session->gpsdata.log.gSpeed,
1870
0
             session->gpsdata.log.heading, session->gpsdata.log.fixType,
1871
0
             session->gpsdata.log.numSV);
1872
1873
1874
0
    mask |= LOG_SET;
1875
0
    return mask;
1876
0
}
1877
1878
/*
1879
 * UBX-LOG-RETRIEVEPOSEXTRA (Indexed Odometry entry)
1880
 * Used for GPS standalone operation and host saved logs
1881
 * u-blox 7,8,9.  protVer 14 to 29
1882
 */
1883
static gps_mask_t ubx_msg_log_retrieveposextra(struct gps_device_t *session,
1884
                                               unsigned char *buf UNUSED,
1885
                                               size_t data_len)
1886
0
{
1887
0
    struct tm unpacked_date = {0};
1888
0
    gps_mask_t mask = 0;
1889
1890
0
    gps_clear_log(&session->gpsdata.log);
1891
    // u-blox 32 bytes payload
1892
0
    if (32 > data_len) {
1893
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1894
0
                 "UBX: LOG-RETRIEVEPOSEXTRA: runt len %zd", data_len);
1895
0
        return 0;
1896
0
    }
1897
1898
0
    unpacked_date.tm_year = getleu16(buf, 6);
1899
0
    if (1900 > unpacked_date.tm_year) {
1900
        // useless, no date
1901
0
        return 0;
1902
0
    }
1903
0
    unpacked_date.tm_year -= 1900;
1904
0
    unpacked_date.tm_mon = getub(buf, 8) - 1;
1905
0
    unpacked_date.tm_mday = getub(buf, 9);
1906
0
    unpacked_date.tm_hour = getub(buf, 10);
1907
0
    unpacked_date.tm_min = getub(buf, 11);
1908
0
    unpacked_date.tm_sec = getub(buf, 12);
1909
1910
0
    session->gpsdata.log.then.tv_sec = mkgmtime(&unpacked_date);
1911
0
    session->gpsdata.log.index_cnt = getleu32(buf, 0);
1912
    // distance units undocumented!  Assume meters, as in UBX-LOG-BATCH
1913
0
    session->gpsdata.log.distance = (double)getleu32(buf, 16);
1914
1915
    // (long long) because of time_t
1916
0
    GPSD_LOG(LOG_INF, &session->context->errout,
1917
0
             "UBX: LOG-RETRIEVEPOSEXTRA:"
1918
0
             " time=%lld entryindex=%u distance=%.0f\n",
1919
0
             (long long)session->gpsdata.log.then.tv_sec,
1920
0
             session->gpsdata.log.index_cnt, session->gpsdata.log.distance);
1921
1922
0
    mask |= LOG_SET;
1923
0
    return mask;
1924
0
}
1925
1926
/*
1927
 * UBX-LOG-RETRIEVESTRING
1928
 * Used for GPS standalone operation and host saved logs
1929
 * u-blox 7,8,9.  protVer 14 to 29
1930
 */
1931
static gps_mask_t ubx_msg_log_retrievestring(struct gps_device_t *session,
1932
                                             unsigned char *buf UNUSED,
1933
                                             size_t data_len)
1934
0
{
1935
0
    struct tm unpacked_date = {0};
1936
0
    unsigned int byteCount;
1937
0
    gps_mask_t mask = 0;
1938
1939
0
    gps_clear_log(&session->gpsdata.log);
1940
    // u-blox 16+ bytes payload
1941
0
    if (16 > data_len) {
1942
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1943
0
                 "UBX: LOG-RETRIEVESTRING: runt len %zd", data_len);
1944
0
        return 0;
1945
0
    }
1946
1947
0
    unpacked_date.tm_year = getleu16(buf, 6);
1948
0
    if (1900 > unpacked_date.tm_year) {
1949
        // useless, no date
1950
0
        return 0;
1951
0
    }
1952
0
    unpacked_date.tm_year -= 1900;
1953
0
    unpacked_date.tm_mon = getub(buf, 8) - 1;
1954
0
    unpacked_date.tm_mday = getub(buf, 9);
1955
0
    unpacked_date.tm_hour = getub(buf, 10);
1956
0
    unpacked_date.tm_min = getub(buf, 11);
1957
0
    unpacked_date.tm_sec = getub(buf, 12);
1958
1959
0
    session->gpsdata.log.then.tv_sec = mkgmtime(&unpacked_date);
1960
0
    session->gpsdata.log.index_cnt = getleu32(buf, 0);
1961
0
    byteCount = getleu16(buf, 14);
1962
1963
    // string could be 0 to 256 bytes, plus NUL
1964
0
    (void)strlcpy(session->gpsdata.log.string, (const char*)&buf[16],
1965
0
                  sizeof(session->gpsdata.log.string));
1966
    // (long long) because of time_t
1967
0
    GPSD_LOG(LOG_INF, &session->context->errout,
1968
0
             "UBX: LOG-RETRIEVESTRING:"
1969
0
             " time=%lld entryindex=%u byteCount=%u string=%s\n",
1970
0
             (long long)session->gpsdata.log.then.tv_sec,
1971
0
             session->gpsdata.log.index_cnt,
1972
0
             byteCount, session->gpsdata.log.string);
1973
1974
0
    mask |= LOG_SET;
1975
0
    return mask;
1976
0
}
1977
1978
/* UBX-MON-COMMS
1979
 * Replacement for MON-RXBUF and MON-TXBUF
1980
 */
1981
static gps_mask_t ubx_msg_mon_comms(struct gps_device_t *session,
1982
                                    unsigned char *buf, size_t data_len)
1983
0
{
1984
0
    gps_mask_t mask = 0;
1985
0
    char buf2[80];
1986
0
    unsigned i;
1987
0
    unsigned version;
1988
0
    unsigned nPorts;
1989
0
    unsigned txErrors;
1990
0
    unsigned protIds[4];
1991
1992
0
    if (8 > data_len) {
1993
        // 8 + (nPorts * 40)
1994
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1995
0
                 "UBX: MON-COMMS: runt payload len %zd\n", data_len);
1996
0
        return 0;
1997
0
    }
1998
0
    version = getub(buf, 0);
1999
0
    if (0 != version) {
2000
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2001
0
                 "UBX: MON-COMMS unkwnown version %u\n", version);
2002
0
        return 0;
2003
0
    }
2004
0
    nPorts = getub(buf, 1);
2005
0
    if ((8 + (nPorts * 40)) > data_len) {
2006
        // 8 + (nPorts * 40)
2007
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2008
0
                 "UBX: MON-COMMS unkwnown runt %zd\n", data_len);
2009
0
        return 0;
2010
0
    }
2011
0
    txErrors = getub(buf, 2);
2012
0
    for (i = 0; i < 4; i++) {
2013
0
        protIds[i] = getub(buf, 3 + i);
2014
0
    }
2015
2016
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2017
0
             "UBX: MON-COMMS: version %u, nPorts %u txErrors x%x  "
2018
0
             "protIds %u %u %u %u\n",
2019
0
             version, nPorts, txErrors, protIds[0], protIds[1], protIds[2],
2020
0
             protIds[3]);
2021
0
    GPSD_LOG(LOG_IO, &session->context->errout,
2022
0
             "UBX: MON-COMMS: txErrors:%s protIds %s %s %s %s\n",
2023
0
             flags2str(txErrors, vmon_comms_txerrors, buf2, sizeof(buf2)),
2024
0
             val2str(protIds[0], vprotIds),
2025
0
             val2str(protIds[1], vprotIds),
2026
0
             val2str(protIds[2], vprotIds),
2027
0
             val2str(protIds[3], vprotIds));
2028
2029
0
    for (i = 0; i < nPorts; i++) {
2030
0
        unsigned portId = getleu16(buf, 8 + (i * 40));
2031
0
        unsigned txPending = getleu16(buf, 10 + (i * 40));
2032
0
        unsigned long txBytes = getleu32(buf, 12 + (i * 40));
2033
0
        unsigned txUsage = getub(buf, 16 + (i * 40));
2034
0
        unsigned txPeakUsage = getub(buf, 17 + (i * 40));
2035
0
        unsigned rxPending = getleu16(buf, 18 + (i * 40));
2036
0
        unsigned long rxBytes = getleu32(buf, 20 + (i * 40));
2037
0
        unsigned rxUsage = getub(buf, 24 + (i * 40));
2038
0
        unsigned rxPeakUsage = getub(buf, 25 + (i * 40));
2039
0
        unsigned overrunErrs = getleu16(buf, 26 + (i * 40));
2040
0
        unsigned long msgs = getleu32(buf, 28 + (i * 40));
2041
0
        unsigned long skipped = getleu32(buf, 44 + (i * 40));
2042
2043
0
        GPSD_LOG(LOG_IO, &session->context->errout,
2044
0
                 "UBX: MON-COMMS: portId:%s\n",
2045
0
                 val2str(portId, vtarget));
2046
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
2047
0
                 "UBX: MON-COMMS: portId x%x, "
2048
0
                 "txPending %u txBytes %lu txUsage %u%% txPeakUsage %u%% "
2049
0
                 "rxPending %u rxBytes %lu rxUsage %u%% rxPeakUsage %u%% "
2050
0
                 "overrunErrs %u msgs %lu skipped %lu\n",
2051
0
                 portId,
2052
0
                 txPending, txBytes, txUsage, txPeakUsage,
2053
0
                 rxPending, rxBytes, rxUsage, rxPeakUsage,
2054
0
                 overrunErrs, msgs, skipped);
2055
0
    }
2056
0
    return mask;
2057
0
}
2058
2059
/* UBX-MON-HW
2060
 * 68 bytes in protVer 12 ( 6-series)
2061
 *    Present from Antaris (4-series)
2062
 * 60 bytes in 8-series and 9-series
2063
 *    Deprecated in protVer 32. M9 and 10-series, use MON-HW and MON-RF
2064
 * 56 bytes in protVer 34 (10-series)
2065
 *    Deprecated. and undocumented,  on M10, use MON-HW and MON-RF
2066
 *
2067
 * Oddly, UBX-MON-HW is output after NAV-EOE.  So too lare for the one
2068
 * TPV for that epoch, and too early for the next epoch.
2069
 */
2070
static gps_mask_t ubx_msg_mon_hw(struct gps_device_t *session,
2071
                                 unsigned char *buf, size_t data_len)
2072
0
{
2073
0
    char buf2[80];
2074
0
    unsigned int noisePerMs;
2075
0
    unsigned int agcCnt;
2076
0
    unsigned int aStatus;
2077
0
    unsigned int aPower;
2078
0
    unsigned int flags;
2079
0
    unsigned int jamInd;
2080
0
    gps_mask_t mask = 0;
2081
2082
0
    if (60 > data_len) {
2083
        // Doc says 68, but 8-series can have 60
2084
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2085
0
                 "UBX: MON-HW: runt payload len %zd\n", data_len);
2086
0
        return 0;
2087
0
    }
2088
2089
0
    noisePerMs = getleu16(buf, 16);
2090
0
    agcCnt = getleu16(buf, 18);         // 0 to 8191
2091
0
    aStatus = getub(buf, 20);
2092
0
    aPower = getub(buf, 21);
2093
    /* flags:
2094
     * 5 only has rtcCalib
2095
     * 6 (6.03) adds safeBoot
2096
     * 6 (7.03) adds jammingState
2097
     * 9 adds xtalAbsent
2098
     */
2099
0
    flags = getub(buf, 22);
2100
    // VP, 17 bytes on protVer 15+
2101
    // VP, 25 bytes on u-blox 6
2102
    // jamInd, on 5 this is reserved
2103
0
    if (68 == data_len) {
2104
0
        jamInd = getub(buf, 53);
2105
0
    } else if (60 == data_len) {
2106
0
        jamInd = getub(buf, 45);
2107
0
    } else {
2108
        // probably 56 == data_len, undocuemted in M10
2109
0
        jamInd = 0;   // WTF?
2110
0
    }
2111
0
    session->newdata.jam = jamInd;
2112
2113
0
    switch (aStatus) {
2114
0
    case 2:
2115
0
        session->newdata.ant_stat = ANT_OK;
2116
0
        break;
2117
0
    case 3:
2118
0
        session->newdata.ant_stat = ANT_SHORT;
2119
0
        break;
2120
0
    case 4:
2121
0
        session->newdata.ant_stat = ANT_OPEN;
2122
0
        break;
2123
0
    case 0:
2124
        // Init
2125
0
        FALLTHROUGH
2126
0
    case 1:
2127
        // Unknown
2128
0
        FALLTHROUGH
2129
0
    default:
2130
        // Dunno...
2131
0
        session->newdata.ant_stat = ANT_UNK;
2132
0
        break;
2133
0
    }
2134
0
    if (0 < jamInd ||
2135
0
        ANT_OK <= session->newdata.ant_stat) {
2136
0
        mask |= REPORT_IS;           // force a new, extra, TPV.
2137
0
    }
2138
2139
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2140
0
             "UBX: MON-HW: noisePerMs %u, agcCmt %u aStatus %u aPower %u "
2141
0
             "flags x%x jamInd %u\n",
2142
0
             noisePerMs, agcCnt, aStatus, aPower, flags, jamInd);
2143
0
    GPSD_LOG(LOG_IO, &session->context->errout,
2144
0
             "UBX: MON-HW:aStatus:%s aPower:%s flags:%s\n",
2145
0
             val2str(aStatus, vaStatus),
2146
0
             val2str(aPower, vaPower),
2147
0
             flags2str(flags, vmon_hw_flags, buf2, sizeof(buf2)));
2148
0
    return mask;
2149
0
}
2150
2151
/* UBX-MON-RF
2152
 * Present in protVer 27+ (9-series)
2153
 * Partially replaces MON-HW
2154
 *
2155
 * Oddly, UBX-MON-RF is output after NAV-EOE.  So too lare for the one
2156
 * TPV for that epoch, and too early for the next epoch.
2157
 */
2158
static gps_mask_t ubx_msg_mon_rf(struct gps_device_t *session,
2159
                                 unsigned char *buf, size_t data_len)
2160
0
{
2161
0
    unsigned i;
2162
0
    gps_mask_t mask = 0;
2163
0
    unsigned version;
2164
0
    unsigned nBlocks;
2165
0
    unsigned blockSize = 0;
2166
0
    bool compact;
2167
2168
0
    if (4 > data_len) {
2169
        // 4 + (nBlocks * 24)
2170
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2171
0
                 "UBX: MON-RF: runt payload len %zd\n", data_len);
2172
0
        return 0;
2173
0
    }
2174
0
    version = getub(buf, 0);
2175
0
    nBlocks = getub(buf, 1);
2176
2177
0
    if (0 != version) {
2178
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2179
0
                 "UBX: MON-RF unkwnown version %u\n", version);
2180
0
        return 0;
2181
0
    }
2182
0
    if (0 == nBlocks) {
2183
        // avoid divide by zero
2184
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2185
0
                 "UBX: MON-RF bBlocks is zero\n");
2186
0
        return 0;
2187
0
    }
2188
0
    blockSize = (data_len - 4) / nBlocks;
2189
2190
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2191
0
             "UBX: MON-RF: version %u, nblocks %u blockSize %u\n",
2192
0
             version, nBlocks, blockSize);
2193
2194
0
    if (4 != (data_len - blockSize * nBlocks)) {
2195
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2196
0
                 "UBX-MON-RF:  Bad length %zu s/b %u, nBlocks %u]n",
2197
0
                 data_len, 4 + blockSize * nBlocks, nBlocks);
2198
0
        return 0;
2199
0
    }
2200
2201
0
    if (20 == blockSize) {
2202
        // ZED-F9R HPS 1.30 firmware
2203
0
        compact = true;
2204
0
    } else if (24 == blockSize) {
2205
0
        compact = false;
2206
0
    } else {
2207
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2208
0
                 "UBX: MON-RF: bad blockSize%u\n", blockSize);
2209
0
        return 0;
2210
0
    }
2211
0
    for (i = 0; i < nBlocks; i++){
2212
0
        if (false == compact) {
2213
            /* ZED-F9N 1 == nBlock
2214
             * ZED-F9P 2 == nBlock
2215
             * what to do with with two jamInd and two antStatus? */
2216
0
            unsigned off = i * 24;
2217
0
            unsigned blockId = getub(buf, 4 + off);
2218
0
            unsigned flags =  getub(buf, 5 + off);
2219
0
            unsigned jammingState = flags & 3;
2220
0
            unsigned antStatus = getub(buf, 6 + off);
2221
0
            unsigned antPower = getub(buf, 7 + off);
2222
0
            unsigned long postStatus = getleu32(buf, 8 + off);
2223
0
            unsigned long reserved1 = getleu32(buf, 12 + off);
2224
0
            unsigned agcCnt = getleu16(buf, 18 + off);         // 0 to 8191
2225
0
            unsigned jamInd = getub(buf, 20 + off);   // aka cwsuppression
2226
0
            int ofsI = getsb(buf, 21 + off);
2227
0
            unsigned magI = getub(buf, 22 + off);
2228
0
            int ofsQ = getsb(buf, 23 + off);
2229
0
            unsigned magQ = getub(buf, 24 + off);
2230
0
            unsigned reserved2 = getleu16(buf, 25 + off);
2231
0
            unsigned ant_stat;
2232
2233
0
            switch (antStatus) {
2234
0
            case 2:
2235
0
                ant_stat = ANT_OK;
2236
0
                break;
2237
0
            case 3:
2238
0
                ant_stat = ANT_SHORT;
2239
0
                break;
2240
0
            case 4:
2241
0
                ant_stat = ANT_OPEN;
2242
0
                break;
2243
0
            case 0:
2244
                // Init
2245
0
                FALLTHROUGH
2246
0
            case 1:
2247
                // Unknown
2248
0
                FALLTHROUGH
2249
0
            default:
2250
                // Dunno...
2251
0
                ant_stat = ANT_UNK;
2252
0
                break;
2253
0
            }
2254
2255
            // use the highest ant_stat and jamInd
2256
0
            if ((unsigned)session->newdata.ant_stat < ant_stat) {
2257
0
                session->newdata.ant_stat = ant_stat;
2258
0
            }
2259
0
            if ((unsigned)session->newdata.jam < jamInd) {
2260
0
                session->newdata.jam = jamInd;
2261
0
            }
2262
2263
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
2264
0
                     "UBX: MON-RF: blk %u flags x%x jammingState %u "
2265
0
                     "antStatus %u antPower %u postStatus %lu reserved1 x%lx "
2266
0
                     "ageCnt %u "
2267
0
                     "jamInd %u ofsI %d magI %u ofsI %d magQ %u "
2268
0
                     "reserved2 x%x\n",
2269
0
                     blockId, flags, jammingState, antStatus, antPower,
2270
0
                     postStatus, reserved1, agcCnt, jamInd,
2271
0
                     ofsI, magI, ofsQ, magQ, reserved2);
2272
0
            GPSD_LOG(LOG_IO, &session->context->errout,
2273
0
                     "UBX: MON-RF:    blockId (%s) flags (%s) antStatus (%s) "
2274
0
                     "antPower (%s) agc %.1f%%\n",
2275
0
                     val2str(blockId, vmon_rf_blockId),
2276
0
                     val2str(flags, vmon_rf_flags),
2277
0
                     val2str(antStatus, vaStatus),
2278
0
                     val2str(antPower, vaPower), agcCnt / 81.91);
2279
0
        } else {
2280
            // compact, 20 bytes, HPS 1.30
2281
            /* ZED-F9R 2 == nBlock
2282
             * what to do with with two jamInd and two antStatus? */
2283
0
            unsigned off = i * 20;
2284
0
            unsigned blockId = getub(buf, 4 + off);
2285
0
            unsigned antStatus = getub(buf, 5 + off);
2286
0
            unsigned antPower = getub(buf, 6 + off);
2287
0
            unsigned cwSuppression = getub(buf, 7 + off);
2288
0
            unsigned long postStatus = getleu32(buf, 8 + off);
2289
            // reserved1 4 bytes
2290
0
            unsigned noisePerMS = getleu16(buf, 16 + off);
2291
0
            unsigned agcCnt = getleu16(buf, 18 + off);         // 0 to 8191
2292
0
            int ofsI = getsb(buf, 20 + off);
2293
0
            unsigned magI = getub(buf, 21 + off);
2294
0
            int ofsQ = getsb(buf, 22 + off);
2295
0
            unsigned magQ = getub(buf, 23 + off);
2296
0
            unsigned ant_stat;
2297
2298
0
            switch (antStatus) {
2299
0
            case 2:
2300
0
                ant_stat = ANT_OK;
2301
0
                break;
2302
0
            case 3:
2303
0
                ant_stat = ANT_SHORT;
2304
0
                break;
2305
0
            case 4:
2306
0
                ant_stat = ANT_OPEN;
2307
0
                break;
2308
0
            case 0:
2309
                // Init
2310
0
                FALLTHROUGH
2311
0
            case 1:
2312
                // Unknown
2313
0
                FALLTHROUGH
2314
0
            default:
2315
                // Dunno...
2316
0
                ant_stat = ANT_UNK;
2317
0
                break;
2318
0
            }
2319
2320
            // use the highest ant_stat and jamInd
2321
0
            if ((unsigned)session->newdata.ant_stat < ant_stat) {
2322
0
                session->newdata.ant_stat = ant_stat;
2323
0
            }
2324
2325
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
2326
0
                     "UBX: MON-RF: blk %u antStatus %u antPower %u "
2327
0
                     "cwSuppression %u postStatus %lu ageCnt %u jamInd %u "
2328
0
                     "ofsI %d magI %u ofsI %d magQ %u\n",
2329
0
                     blockId, antStatus, antPower, cwSuppression,
2330
0
                     postStatus, noisePerMS,  agcCnt,
2331
0
                     ofsI, magI, ofsQ, magQ);
2332
0
            GPSD_LOG(LOG_IO, &session->context->errout,
2333
0
                     "UBX: MON-RF:    blockId (%s) antStatus (%s) "
2334
0
                     "antPower (%s) agc %.1f%%\n",
2335
0
                     val2str(blockId, vmon_rf_blockId),
2336
0
                     val2str(antStatus, vaStatus),
2337
0
                     val2str(antPower, vaPower),
2338
0
                     agcCnt / 81.91);
2339
0
        }
2340
0
    }
2341
0
    if (0 < session->newdata.jam ||
2342
0
        ANT_OK <= session->newdata.ant_stat) {
2343
0
        mask |= REPORT_IS;           // force a new, extra, TPV.
2344
0
    }
2345
0
    return mask;
2346
0
}
2347
2348
/* UBX-MON-RXBUF
2349
 * Present in u-blox 5+ through at least protVer 23.01
2350
 * Supported but deprecated in M9P protVer 27.11, use MON-COMMS
2351
 * Supported but deprecated in M9N protVer 32.00 */
2352
static gps_mask_t ubx_msg_mon_rxbuf(struct gps_device_t *session,
2353
                                    unsigned char *buf, size_t data_len)
2354
0
{
2355
0
    int i;
2356
2357
0
    if (24 != data_len) {
2358
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2359
0
                 "UBX: MON-RXBUF: runt payload len %zd\n", data_len);
2360
0
        return 0;
2361
0
    }
2362
2363
0
    for (i = 0; i < 6; i++) {
2364
0
        unsigned int pending = getleu16(buf, i * 2);
2365
0
        unsigned int usage =  getub(buf, 12 + i);
2366
0
        unsigned int peakUsage = getub(buf, 18 + i);
2367
2368
0
        GPSD_LOG(LOG_IO, &session->context->errout,
2369
0
                 "UBX: MON-RXBUF: tgt:%s\n",
2370
0
                 val2str(i, vtarget));
2371
0
        GPSD_LOG(LOG_INF, &session->context->errout,
2372
0
                 "UBX: MON-RXBUF: tgt%d pending %4u usage %3u%% peakUsage %3d%%\n",
2373
0
                 i, pending, usage, peakUsage);
2374
0
    }
2375
0
    return 0;
2376
0
}
2377
2378
/* UBX-MON-TXBUF
2379
 * Present in u-blox 5+ through at least protVer 23.01
2380
 * Supported but deprecated in M9P protVer 27.11
2381
 * Supported but deprecated in M9N protVer 32.00 */
2382
static gps_mask_t ubx_msg_mon_txbuf(struct gps_device_t *session,
2383
                                    unsigned char *buf, size_t data_len)
2384
0
{
2385
0
    char buf2[80];
2386
0
    unsigned tUsage, tPeakusage;
2387
0
    unsigned errors, limit, reserved1;
2388
0
    int i;
2389
2390
0
    if (28 != data_len) {
2391
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2392
0
                 "UBX: MON-TXBUF: runt payload len %zd\n", data_len);
2393
0
        return 0;
2394
0
    }
2395
2396
0
    errors = limit = getub(buf, 26);
2397
2398
0
    for (i = 0; i < 6; i++) {
2399
0
        unsigned int pending = getleu16(buf, i * 2);
2400
0
        unsigned int usage =  getub(buf, 12 + i);
2401
0
        unsigned int peakUsage = getub(buf, 18 + i);
2402
2403
0
        GPSD_LOG(LOG_IO, &session->context->errout,
2404
0
                 "UBX: MON-TXBUF: tgt:%s\n",
2405
0
                 val2str(i, vtarget));
2406
0
        GPSD_LOG(LOG_INF, &session->context->errout,
2407
0
                 "UBX: MON-TXBUF: tgt %d limit %u pending %4u "
2408
0
                 "usage %3u%% peakUsage %3d%%\n",
2409
0
                 i, limit & 1, pending, usage, peakUsage);
2410
0
        limit = limit >> 1;
2411
0
    }
2412
0
    tUsage = getub(buf, 24);
2413
0
    tPeakusage = getub(buf, 25);
2414
0
    reserved1 = getub(buf, 27);
2415
2416
0
    GPSD_LOG(LOG_INF, &session->context->errout,
2417
0
             "UBX: MON-TXBUF: tUsage %3u%%, tPeakusage %3u%%, errors 0x%02x, "
2418
0
             "reserved1 0x%02x\n",
2419
0
             tUsage, tPeakusage, errors, reserved1);
2420
2421
0
    GPSD_LOG(LOG_IO, &session->context->errout,
2422
0
             "UBX: MON-TXBUF: errors:%s\n",
2423
0
             flags2str(errors, vmon_txbuf_errors, buf2, sizeof(buf2)));
2424
0
    return 0;
2425
0
}
2426
2427
/**
2428
 * Receiver/Software Version
2429
 * UBX-MON-VER
2430
 *
2431
 * sadly more info than fits in session->swtype for now.
2432
 * so squish the data hard.
2433
 */
2434
static gps_mask_t ubx_msg_mon_ver(struct gps_device_t *session,
2435
                                  unsigned char *buf,
2436
                                  size_t data_len)
2437
0
{
2438
0
    int n = 0;                           // extended info counter
2439
0
    int num_ext = (data_len - 40) / 30;  // number of extensions
2440
0
    char obuf[128];                      // temp version string buffer
2441
0
    char *cptr;
2442
2443
0
    if (40 > data_len) {
2444
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2445
0
                 "UBX: MON-VER: runt payload len %zd", data_len);
2446
0
        return 0;
2447
0
    }
2448
2449
    // save SW and HW Version as subtype
2450
0
    (void)snprintf(obuf, sizeof(obuf),
2451
0
                   "SW %.30s,HW %.10s",
2452
0
                   (char *)buf,
2453
0
                   (char *)(buf + 30));
2454
2455
    // save what we can
2456
0
    (void)strlcpy(session->subtype, obuf, sizeof(session->subtype));
2457
2458
0
    obuf[0] = '\0';
2459
    // extract Extended info strings.
2460
0
    for (n = 0; n < num_ext; n++) {
2461
0
        int start_of_str = 40 + (30 * n);
2462
2463
0
        if (0 < n) {
2464
            // commas between elements
2465
0
            (void)strlcat(obuf, ",", sizeof(obuf));
2466
0
        }
2467
0
        (void)strlcat(obuf, (char *)&buf[start_of_str], sizeof(obuf));
2468
0
    }
2469
2470
    // save what we can in subtype1
2471
0
    (void)strlcpy(session->subtype1, obuf, sizeof(session->subtype1));
2472
2473
    // find PROTVER literal, followed by single separator character
2474
0
    cptr = strstr(obuf, "PROTVER=");     // protVer 18 and above
2475
0
    if (NULL == cptr) {
2476
0
        cptr = strstr(obuf, "PROTVER "); // protVer 17 and below
2477
0
    }
2478
0
    if (NULL != cptr) {
2479
0
        int protver = atoi(cptr + 8);
2480
0
        if (7 < protver) {
2481
            /* protver 8, u-blox Antaris, is the oldest we know, but never
2482
             * used explicitly.  protver 15, u-blox 8, is oldest seen. */
2483
0
            session->driver.ubx.protver = protver;
2484
0
        }
2485
0
    }
2486
2487
    /* MON-VER did not contain PROTVER in any extension field (typical for
2488
     * protVer < 15), so use mapping table to try to derive protVer from
2489
     * firmware revision number carried in swVersion field */
2490
0
    if (0 == session->driver.ubx.protver) {
2491
0
        for (n = 0; NULL != fw_protver_map[n].fw_string; n++) {
2492
            // skip "SW " prefix in session->subtype
2493
0
            cptr = strstr(session->subtype + 3, fw_protver_map[n].fw_string);
2494
            // use only when swVersion field starts with fw_string
2495
0
            if (cptr == (session->subtype + 3)) {
2496
0
                session->driver.ubx.protver =
2497
0
                    (unsigned char)fw_protver_map[n].protver;
2498
0
                break;
2499
0
            }
2500
0
        }
2501
0
        if (0 == session->driver.ubx.protver) {
2502
            // Still not found, old chip.  Set to one so we know we tried.
2503
0
            session->driver.ubx.protver = 1;
2504
0
        }
2505
0
    }
2506
2507
    // output SW and HW Version at LOG_INF
2508
0
    GPSD_LOG(LOG_INF, &session->context->errout,
2509
0
             "UBX: MON-VER: %s %s PROTVER %u\n",
2510
0
             session->subtype, session->subtype1,
2511
0
             session->driver.ubx.protver);
2512
2513
2514
0
    return 0;
2515
0
}
2516
2517
/**
2518
 * Clock Solution UBX-NAV-CLOCK
2519
 *
2520
 * Present in:
2521
 *     protVer 8 to 34 (Antaris 4 to M10)
2522
 */
2523
static gps_mask_t ubx_msg_nav_clock(struct gps_device_t *session,
2524
                                    unsigned char *buf, size_t data_len)
2525
0
{
2526
0
    unsigned long tAcc, fAcc;
2527
2528
0
    if (20 > data_len) {
2529
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2530
0
                 "UBX: NAV-CLOCK: runt payload len %zd", data_len);
2531
0
        return 0;
2532
0
    }
2533
2534
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2535
    // u-bloc 6 sets clockbias and clockdrift to 0
2536
0
    session->gpsdata.fix.clockbias = getles32(buf, 4);
2537
0
    session->gpsdata.fix.clockdrift = getles32(buf, 8);
2538
0
    tAcc = getleu32(buf, 12);
2539
0
    fAcc = getleu32(buf, 16);
2540
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2541
0
             "UBX: NAV-CLOCK: iTOW=%lld clkB %ld clkD %ld tAcc %lu fAcc %lu\n",
2542
0
             (long long)session->driver.ubx.iTOW,
2543
0
             session->gpsdata.fix.clockbias,
2544
0
             session->gpsdata.fix.clockdrift,
2545
0
             tAcc, fAcc);
2546
0
    return 0;
2547
0
}
2548
2549
/**
2550
 * DGPS Data Used for NAV
2551
 *
2552
 * May be good cycle ender
2553
 *
2554
 * Present in u-blox 7
2555
 */
2556
static gps_mask_t ubx_msg_nav_dgps(struct gps_device_t *session,
2557
                                   unsigned char *buf, size_t data_len)
2558
0
{
2559
0
    long age;
2560
2561
0
    if (16 > data_len) {
2562
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2563
0
                 "UBX: NAV-DGPS: runt payload len %zd", data_len);
2564
0
        return 0;
2565
0
    }
2566
2567
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2568
0
    age = getleu32(buf, 4);
2569
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2570
0
             "NAV-DGPS: iTOW=%lld age %ld\n",
2571
0
             (long long)session->driver.ubx.iTOW, age);
2572
0
    return 0;
2573
0
}
2574
2575
/**
2576
 * UBX-NAV-DOP, Dilution of precision message
2577
 *
2578
 * Present in all u-blox (4 to 10)
2579
 */
2580
static gps_mask_t ubx_msg_nav_dop(struct gps_device_t *session,
2581
                                  unsigned char *buf, size_t data_len)
2582
0
{
2583
0
    unsigned u;
2584
0
    gps_mask_t mask = 0;
2585
2586
0
    if (18 > data_len) {
2587
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2588
0
                 "UBX: NAV-DOP: runt payload len %zd", data_len);
2589
0
        return 0;
2590
0
    }
2591
2592
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2593
    /*
2594
     * We make a deliberate choice not to clear DOPs from the
2595
     * last skyview here, but rather to treat this as a supplement
2596
     * to our calculations from the visibility matrix, trusting
2597
     * the firmware algorithms over ours.
2598
     */
2599
0
    u = getleu16(buf, 4);
2600
0
    if (9999 > u) {
2601
0
        session->gpsdata.dop.gdop = (double)(u / 100.0);
2602
0
        mask |= DOP_SET;
2603
0
    }
2604
0
    u = getleu16(buf, 6);
2605
0
    if (9999 > u) {
2606
0
        session->gpsdata.dop.pdop = (double)(u / 100.0);
2607
0
        mask |= DOP_SET;
2608
0
    }
2609
0
    u = getleu16(buf, 8);
2610
0
    if (9999 > u) {
2611
0
        session->gpsdata.dop.tdop = (double)(u / 100.0);
2612
0
        mask |= DOP_SET;
2613
0
    }
2614
0
    u = getleu16(buf, 10);
2615
0
    if (9999 > u) {
2616
0
        session->gpsdata.dop.vdop = (double)(u / 100.0);
2617
0
        mask |= DOP_SET;
2618
0
    }
2619
0
    u = getleu16(buf, 12);
2620
0
    if (9999 > u) {
2621
0
        session->gpsdata.dop.hdop = (double)(u / 100.0);
2622
0
        mask |= DOP_SET;
2623
0
    }
2624
    // Northing DOP
2625
0
    u = getleu16(buf, 14);
2626
0
    if (9999 > u) {
2627
0
        session->gpsdata.dop.ydop = (double)(u / 100.0);
2628
0
        mask |= DOP_SET;
2629
0
    }
2630
    // Easting DOP
2631
0
    u = getleu16(buf, 16);
2632
0
    if (9999 > u) {
2633
0
        session->gpsdata.dop.xdop = (double)(u / 100.0);
2634
0
        mask |= DOP_SET;
2635
0
    }
2636
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2637
0
             "UBX: NAV-DOP: gdop=%.2f pdop=%.2f "
2638
0
             "hdop=%.2f vdop=%.2f tdop=%.2f ydop=%.2f xdop=%.2f\n",
2639
0
             session->gpsdata.dop.gdop,
2640
0
             session->gpsdata.dop.pdop,
2641
0
             session->gpsdata.dop.hdop,
2642
0
             session->gpsdata.dop.vdop,
2643
0
             session->gpsdata.dop.tdop,
2644
0
             session->gpsdata.dop.ydop,
2645
0
             session->gpsdata.dop.xdop);
2646
0
    return mask;
2647
0
}
2648
2649
/**
2650
 * Position error ellipse parameters
2651
 * protVer 19.1 and up
2652
 * Not in u-blox 5, 6 or 7
2653
 * Present in some u-blox 8, 9 and 10 (ADR, HPS)
2654
 */
2655
static gps_mask_t ubx_msg_nav_eell(struct gps_device_t *session,
2656
                                   unsigned char *buf, size_t data_len)
2657
0
{
2658
0
    unsigned version;
2659
0
    unsigned errEllipseOrient;
2660
0
    unsigned long errEllipseMajor, errEllipseMinor;
2661
2662
0
    if (16 > data_len) {
2663
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2664
0
                 "UBX: NAV-EELL: runt payload len %zd", data_len);
2665
0
        return 0;
2666
0
    }
2667
2668
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2669
0
    version = getub(buf, 4);
2670
0
    if (0 != version) {
2671
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2672
0
                 "UBX: NAV-EELL unknown version %u s/b 0", version);
2673
0
        return 0;
2674
0
    }
2675
0
    session->newdata.errEllipseOrient = (double)(getleu16(buf, 6) * 1e-2);
2676
0
    session->newdata.errEllipseMajor = (double)(getleu32(buf, 8) * 1e-3);
2677
0
    session->newdata.errEllipseMinor = (double)(getleu32(buf, 12) * 1e-3);
2678
0
    errEllipseOrient = getleu16(buf, 6);
2679
0
    errEllipseMajor = getleu32(buf, 8);
2680
0
    errEllipseMinor = getleu32(buf, 12);
2681
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2682
0
             "UBX: NAV-EELL: iTOW %lld version %u errEllipseOrient %u "
2683
0
             "errEllipseMajor %lu errEllipseMinor %lu\n",
2684
0
             (long long)session->driver.ubx.iTOW, version,
2685
0
             errEllipseOrient,
2686
0
             errEllipseMajor,
2687
0
             errEllipseMinor);
2688
0
    return 0;
2689
0
}
2690
2691
/**
2692
 * End of Epoch
2693
 * Not in u-blox 5, 6 or 7
2694
 * Present in:
2695
 *    protVer 18 (8-series, 9)
2696
 */
2697
static gps_mask_t ubx_msg_nav_eoe(struct gps_device_t *session,
2698
                                  unsigned char *buf, size_t data_len)
2699
0
{
2700
0
    if (4 > data_len) {
2701
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2702
0
                 "UBX: NAV-EOE: runt payload len %zd", data_len);
2703
0
        return 0;
2704
0
    }
2705
2706
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2707
0
    GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-EOE: iTOW=%lld\n",
2708
0
             (long long)session->driver.ubx.iTOW);
2709
    // nothing to report, but the iTOW for cycle ender is good
2710
0
    return 0;
2711
0
}
2712
2713
/*
2714
 * UBX-NAV-HPPOSECEF - High Precision Position Solution in ECEF
2715
 *
2716
 * Present in u-blox 8 and above, protVwer 20.00 and up.
2717
 * Only with High Precision firmware.
2718
 */
2719
static gps_mask_t ubx_msg_nav_hpposecef(struct gps_device_t *session,
2720
                                        unsigned char *buf,
2721
                                        size_t data_len UNUSED)
2722
0
{
2723
0
    gps_mask_t mask = ECEF_SET;
2724
2725
0
    unsigned version = getub(buf, 0);
2726
0
    if (0 != version) {
2727
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2728
0
                 "UBX: NAV-HPPOSECEF unknown version %u s/b 0", version);
2729
0
        return 0;
2730
0
    }
2731
0
    session->driver.ubx.iTOW = getleu32(buf, 4);
2732
0
    session->newdata.ecef.x = getles32x100s8d(buf, 8, 20, 1e-4);
2733
0
    session->newdata.ecef.y = getles32x100s8d(buf, 12, 21, 1e-4);
2734
0
    session->newdata.ecef.z = getles32x100s8d(buf, 16, 22, 1e-4);
2735
2736
0
    session->newdata.ecef.pAcc = getleu32(buf, 24) / (double)10000.0;
2737
    // (long long) cast for 32-bit compat
2738
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2739
0
        "UBX: NAV-HPPOSECEF: version %d iTOW %lld ecef X %.4f Y %.4f Z %.4f "
2740
0
        "pAcc %.4f\n",
2741
0
        version,
2742
0
        (long long)session->driver.ubx.iTOW,
2743
0
        session->newdata.ecef.x,
2744
0
        session->newdata.ecef.y,
2745
0
        session->newdata.ecef.z,
2746
0
        session->newdata.ecef.pAcc);
2747
0
    return mask;
2748
0
}
2749
2750
 /**
2751
 * High Precision Geodetic Position Solution
2752
 * UBX-NAV-HPPOSLLH, Class 1, ID x14
2753
 *
2754
 * No mode, so limited usefulness.
2755
 *
2756
 * Present in u-blox 8 and above, protVwer 20.00 and up.
2757
 * Only with High Precision firmware.
2758
 */
2759
static gps_mask_t ubx_msg_nav_hpposllh(struct gps_device_t *session,
2760
                                       unsigned char *buf, size_t data_len)
2761
0
{
2762
0
    int version;
2763
0
    gps_mask_t mask = 0;
2764
2765
0
    if (36 > data_len) {
2766
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2767
0
                 "UBX: NAV-HPPOSLLH: runt payload len %zd", data_len);
2768
0
        return mask;
2769
0
    }
2770
2771
0
    mask = ONLINE_SET | HERR_SET | VERR_SET | LATLON_SET | ALTITUDE_SET;
2772
2773
0
    version = getub(buf, 0);
2774
0
    session->driver.ubx.iTOW = getles32(buf, 4);
2775
0
    session->newdata.longitude = getles32x100s8d(buf, 8, 24, 1e-9);
2776
0
    session->newdata.latitude = getles32x100s8d(buf, 12, 25, 1e-9);
2777
    // altitude WGS84
2778
0
    session->newdata.altHAE = getles32x100s8d(buf, 16, 26, 1e-5);
2779
    // altitude MSL
2780
0
    session->newdata.altMSL = getles32x100s8d(buf, 20, 27, 1e-5);
2781
    // Let gpsd_error_model() deal with geoid_sep
2782
2783
    // Horizontal accuracy estimate in .1 mm, unknown est type
2784
0
    session->newdata.eph = getleu32(buf, 28) * (double)1e-4;
2785
    // Vertical accuracy estimate in .1 mm, unknown est type
2786
0
    session->newdata.epv = getleu32(buf, 32) * (double)1e-4;
2787
2788
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2789
0
        "UBX: NAV-HPPOSLLH: version %d iTOW=%lld lat=%.4f lon=%.4f "
2790
0
        "altHAE=%.4f\n",
2791
0
        version,
2792
0
        (long long)session->driver.ubx.iTOW,
2793
0
        session->newdata.latitude,
2794
0
        session->newdata.longitude,
2795
0
        session->newdata.altHAE);
2796
0
    return mask;
2797
0
}
2798
2799
/*
2800
 * Navigation Position ECEF message
2801
 *
2802
 * This message does not bother to tell us if it is valid.
2803
 */
2804
static gps_mask_t ubx_msg_nav_posecef(struct gps_device_t *session,
2805
                                      unsigned char *buf, size_t data_len)
2806
0
{
2807
0
    gps_mask_t mask = ECEF_SET;
2808
2809
0
    if (20 > data_len) {
2810
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2811
0
                 "UBX: NAV-POSECEF: runt payload len %zd", data_len);
2812
0
        return 0;
2813
0
    }
2814
2815
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2816
    // all in cm
2817
0
    session->newdata.ecef.x = getles32(buf, 4) * 1e-2;
2818
0
    session->newdata.ecef.y = getles32(buf, 8) * 1e-2;
2819
0
    session->newdata.ecef.z = getles32(buf, 12) * 1e-2;
2820
0
    session->newdata.ecef.pAcc = getleu32(buf, 16) * 1e-2;
2821
2822
    // (long long) cast for 32-bit compat
2823
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2824
0
        "UBX: NAV-POSECEF: iTOW=%lld ECEF x=%.2f y=%.2f z=%.2f pAcc=%.2f\n",
2825
0
        (long long)session->driver.ubx.iTOW,
2826
0
        session->newdata.ecef.x,
2827
0
        session->newdata.ecef.y,
2828
0
        session->newdata.ecef.z,
2829
0
        session->newdata.ecef.pAcc);
2830
0
    return mask;
2831
0
}
2832
2833
 /**
2834
 * Geodetic position solution message
2835
 * UBX-NAV-POSLLH, Class 1, ID 2
2836
 *
2837
 * This message does not bother to tell us if it is valid.
2838
 * No mode, so limited usefulness
2839
 */
2840
static gps_mask_t ubx_msg_nav_posllh(struct gps_device_t *session,
2841
                                     unsigned char *buf,
2842
                                     size_t data_len UNUSED)
2843
0
{
2844
0
    gps_mask_t mask = 0;
2845
2846
0
    if (28 > data_len) {
2847
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2848
0
                 "UBX: NAV-POSLLH: runt payload len %zd", data_len);
2849
0
        return 0;
2850
0
    }
2851
2852
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2853
0
    session->newdata.longitude = 1e-7 * getles32(buf, 4);
2854
0
    session->newdata.latitude = 1e-7 * getles32(buf, 8);
2855
    // altitude WGS84
2856
0
    session->newdata.altHAE = 1e-3 * getles32(buf, 12);
2857
    // altitude MSL
2858
0
    session->newdata.altMSL = 1e-3 * getles32(buf, 16);
2859
    // Let gpsd_error_model() deal with geoid_sep
2860
2861
    // Horizontal accuracy estimate in mm, unknown type
2862
0
    session->newdata.eph = getleu32(buf, 20) * 1e-3;
2863
    // Vertical accuracy estimate in mm, unknown type
2864
0
    session->newdata.epv = getleu32(buf, 24) * 1e-3;
2865
2866
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
2867
0
        "UBX: NAV-POSLLH: iTOW=%lld lat=%.3f lon=%.3f altHAE=%.3f "
2868
0
        "eph %.3f epv %.3f\n",
2869
0
        (long long)session->driver.ubx.iTOW,
2870
0
        session->newdata.latitude,
2871
0
        session->newdata.longitude,
2872
0
        session->newdata.altHAE,
2873
0
        session->newdata.eph,
2874
0
        session->newdata.epv);
2875
2876
0
    mask = ONLINE_SET | HERR_SET | VERR_SET | LATLON_SET | ALTITUDE_SET;
2877
0
    return mask;
2878
0
}
2879
2880
/**
2881
 * Navigation Position Attitude Velocity Time solution message
2882
 * UBX-NAV-PVAT Class 1, ID 17
2883
 *
2884
 * Like UBX-NAV-PVT, plus parts of UBX-HNR-ATT, UBX-NAV-EELL, and NAV-TIMEUTC
2885
 *
2886
 * Present in:
2887
 *   protver 30  (ADR/DBD/HPS/LAP/MDR 9-series firmware)
2888
 *
2889
 * Not present in:
2890
 *    u-blox 5, 6, 7 or 8
2891
 */
2892
static gps_mask_t ubx_msg_nav_pvat(struct gps_device_t *session,
2893
                                  unsigned char *buf, size_t data_len UNUSED)
2894
0
{
2895
0
    char buf2[80];
2896
0
    char buf3[80];
2897
0
    char buf4[80];
2898
0
    unsigned version;
2899
0
    unsigned year, month, day, hour, min, sec;
2900
0
    double tAcc, hAcc, vAcc, sAcc;
2901
0
    double velN, velE, velD;
2902
0
    double vehRoll, vehPitch, vehHeading, motHeading;
2903
0
    double accRoll, accPitch, accHeading;
2904
0
    double magDec = NAN;
2905
0
    double magAcc = NAN;
2906
0
    long nano;
2907
0
    unsigned fixType;
2908
0
    unsigned flags;
2909
0
    unsigned flags2;
2910
0
    unsigned numSV;
2911
0
    unsigned valid;
2912
0
    int *status = &session->newdata.status;
2913
0
    int *mode = &session->newdata.mode;
2914
0
    gps_mask_t mask = 0;
2915
2916
0
    version = getub(buf, 4);
2917
0
    if (0 != version) {
2918
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
2919
0
                 "UBX: NAV-PVAT unknown version %u s/b 0", version);
2920
0
        return 0;
2921
0
    }
2922
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
2923
0
    valid = getub(buf, 5);
2924
0
    year = getleu16(buf, 6);
2925
0
    month = getub(buf, 8);
2926
0
    day = getub(buf, 9);
2927
0
    hour = getub(buf, 10);
2928
0
    min = getub(buf, 11);
2929
0
    sec = getub(buf, 12);
2930
    // 13, 14, 15 reserved
2931
0
    tAcc = 1e-3 * getleu32(buf, 16);
2932
0
    nano = getles32(buf, 20);
2933
0
    fixType = getub(buf, 24);
2934
0
    flags = getub(buf, 25);
2935
0
    flags2 = getub(buf, 26);
2936
0
    numSV = getub(buf, 27);
2937
2938
    // u-blox doc admits this may differ from skyview data.
2939
0
    session->gpsdata.satellites_used = numSV;
2940
2941
0
    switch (fixType) {
2942
0
    case UBX_MODE_TMONLY:
2943
        // 5 - Surveyed-in, so a precise 3D.
2944
0
        *mode = MODE_3D;
2945
0
        *status = STATUS_TIME;
2946
0
        mask |= STATUS_SET | LATLON_SET | ALTITUDE_SET | MODE_SET | SPEED_SET;
2947
0
        break;
2948
2949
0
    case UBX_MODE_3D:
2950
        // 3
2951
0
        *mode = MODE_3D;
2952
0
        *status = STATUS_GPS;
2953
0
        mask |= STATUS_SET | LATLON_SET | ALTITUDE_SET | MODE_SET | SPEED_SET;
2954
0
        break;
2955
2956
0
    case UBX_MODE_GPSDR:
2957
        // 4
2958
0
        *mode = MODE_3D;
2959
0
        *status = STATUS_GNSSDR;
2960
0
        mask |= STATUS_SET | LATLON_SET | ALTITUDE_SET | MODE_SET | SPEED_SET;
2961
0
        break;
2962
2963
0
    case UBX_MODE_2D:
2964
        // 2
2965
0
        *mode = MODE_2D;
2966
0
        *status = STATUS_GPS;
2967
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
2968
0
        break;
2969
2970
0
    case UBX_MODE_DR:           // consider this too as 2D
2971
        // 1
2972
0
        *mode = MODE_2D;
2973
0
        *status = STATUS_DR;
2974
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
2975
0
        break;
2976
2977
0
    case UBX_MODE_NOFIX:
2978
        // 0
2979
0
        FALLTHROUGH
2980
0
    default:
2981
        // huh?
2982
0
        *mode = MODE_NO_FIX;
2983
0
        *status = STATUS_UNK;
2984
0
        mask |= MODE_SET | STATUS_SET;
2985
0
        break;
2986
0
    }
2987
2988
0
    if (UBX_NAV_PVT_FLAG_DGPS == (flags & UBX_NAV_PVT_FLAG_DGPS)) {
2989
0
        if (UBX_NAV_PVT_FLAG_RTK_FIX == (flags & UBX_NAV_PVT_FLAG_RTK_FIX)) {
2990
0
            *status = STATUS_RTK_FIX;
2991
0
        } else if (UBX_NAV_PVT_FLAG_RTK_FLT ==
2992
0
                   (flags & UBX_NAV_PVT_FLAG_RTK_FLT)) {
2993
0
            *status = STATUS_RTK_FLT;
2994
0
        } else {
2995
0
            *status = STATUS_DGPS;
2996
0
        }
2997
0
        mask |= STATUS_SET;
2998
0
    }
2999
3000
0
    if ((valid & UBX_NAV_PVT_VALID_DATE_TIME) == UBX_NAV_PVT_VALID_DATE_TIME) {
3001
0
        struct tm unpacked_date = {0};
3002
3003
0
        unpacked_date.tm_year = year - 1900;
3004
0
        unpacked_date.tm_mon = month - 1;
3005
0
        unpacked_date.tm_mday = day;
3006
0
        unpacked_date.tm_hour = hour;
3007
0
        unpacked_date.tm_min = min;
3008
0
        unpacked_date.tm_sec = sec;
3009
0
        session->newdata.time.tv_sec = mkgmtime(&unpacked_date);
3010
        // nano, can be negative! So normalize
3011
0
        session->newdata.time.tv_nsec = nano;
3012
0
        TS_NORM(&session->newdata.time);
3013
0
        mask |= TIME_SET | NTPTIME_IS | GOODTIME_IS;
3014
0
    }
3015
3016
0
    if (LATLON_SET == (mask & LATLON_SET)) {
3017
0
        session->newdata.longitude = 1e-7 * getles32(buf, 28);
3018
0
        session->newdata.latitude = 1e-7 * getles32(buf, 32);
3019
0
        if (ALTITUDE_SET == (mask & ALTITUDE_SET)) {
3020
            // altitude WGS84
3021
0
            session->newdata.altHAE = 1e-3 * getles32(buf, 36);
3022
            // altitude MSL
3023
0
            session->newdata.altMSL = 1e-3 * getles32(buf, 40);
3024
            // Let gpsd_error_model() deal with geoid_sep
3025
0
        }
3026
0
    }
3027
0
    hAcc = 1e-3 * getleu32(buf, 44);
3028
0
    vAcc = 1e-3 * getleu32(buf, 48);
3029
0
    velN = 1e-3 * getles32(buf, 52);
3030
0
    velE = 1e-3 * getles32(buf, 56);
3031
0
    velD = 1e-3 * getles32(buf, 60);
3032
3033
    // Seems to be always valid.
3034
0
    session->newdata.eph = hAcc;
3035
0
    session->newdata.epv = vAcc;
3036
0
    session->newdata.NED.velN = velN;
3037
0
    session->newdata.NED.velE = velE;
3038
0
    session->newdata.NED.velD = velD;
3039
0
    mask |= VNED_SET;
3040
3041
    // gSpeed, seems to be always valid.
3042
0
    session->newdata.speed = 1e-3 * getles32(buf, 64);
3043
0
    sAcc = 1e-3 * getleu32(buf, 68);
3044
0
    session->newdata.eps = sAcc;
3045
0
    mask |= SPEED_SET;
3046
3047
0
    vehRoll = 1e-5 * getles32(buf, 72);
3048
0
    vehPitch = 1e-5 * getles32(buf, 76);
3049
0
    vehHeading = 1e-5 * getles32(buf, 80);
3050
3051
    // accuracies
3052
0
    accRoll = 1e-3 * getles32(buf, 88);
3053
0
    accPitch = 1e-3 * getles32(buf, 90);
3054
0
    accHeading = 1e-3 * getles32(buf, 92);
3055
3056
0
    if (0.0 != accRoll) {
3057
0
        session->gpsdata.attitude.roll = vehRoll;
3058
0
        mask |= ATTITUDE_SET;
3059
0
    }
3060
0
    if (0.0 != accPitch) {
3061
0
        session->gpsdata.attitude.pitch = vehPitch;
3062
0
        mask |= ATTITUDE_SET;
3063
0
    }
3064
0
    if (0.0 != accHeading) {
3065
        // seems to be true heading
3066
0
        session->gpsdata.attitude.heading = vehHeading;
3067
0
        mask |= ATTITUDE_SET;
3068
0
    }
3069
3070
0
    motHeading = 1e-5 * getles32(buf, 84);
3071
0
    if (flags & UBX_NAV_PVT_FLAG_HDG_OK) {
3072
        // u-blox calls this Heading of motion (2-D)
3073
0
        session->newdata.track = motHeading;
3074
0
        mask |= TRACK_SET;
3075
0
    }
3076
3077
0
    if (ATTITUDE_SET == (mask & ATTITUDE_SET)) {
3078
0
        session->gpsdata.attitude.mtime = session->newdata.time;
3079
0
    }
3080
3081
0
    if (valid & UBX_NAV_PVT_VALID_MAG) {
3082
0
        magDec = (double)(getles16(buf, 94) * 1e-2);
3083
0
        magAcc = (double)(getleu16(buf, 96) * 1e-2);
3084
0
    }
3085
0
    session->newdata.errEllipseOrient = (double)(getleu16(buf, 98) * 1e-2);
3086
0
    session->newdata.errEllipseMajor = (double)(getleu32(buf, 100) * 1e-3);
3087
0
    session->newdata.errEllipseMinor = (double)(getleu32(buf, 104) * 1e-3);
3088
3089
    // if cycle ender worked, could get rid of this REPORT_IS.
3090
    // mask |= REPORT_IS;
3091
3092
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3093
0
         "UBX: NAV-PVAT: iTOW %lld version %d valid x%02x "
3094
0
         "time %u/%02u/%02u %02u:%02u:%02u tAcc %.3f nano %lu fixType %u "
3095
0
         "flags x%x flags2 x%x numSV %u lat %.2f lon %.2f "
3096
0
         "altHAE %.2f altMSL %.2f "
3097
0
         "hAcc %.3f vAcc %.3f valNED %.3f %.3f %.3f speed %.3f sAcc %.3f "
3098
0
         "vehRPH %.5f %.5f %.5f "
3099
0
         "track %.2f accRPH %.3f %.3f %.3f "
3100
0
         "mode %d status %d used %d magDec %.2f magAcc %.2f "
3101
0
         "errEllipse %.2f %.3f %.3f\n",
3102
0
         (long long)session->driver.ubx.iTOW, version,
3103
         // timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
3104
0
         valid, year, month, day, hour, min, sec, tAcc, nano, fixType,
3105
0
         flags, flags2, numSV,
3106
0
         session->newdata.latitude,
3107
0
         session->newdata.longitude,
3108
0
         session->newdata.altHAE,
3109
0
         session->newdata.altMSL,
3110
0
         hAcc, vAcc, velN, velE, velD, session->newdata.speed, sAcc,
3111
0
         vehRoll, vehPitch, vehHeading,
3112
0
         motHeading,
3113
         //session->newdata.track,
3114
0
         accRoll, accPitch, accHeading,
3115
0
         session->newdata.mode,
3116
0
         session->newdata.status,
3117
0
         session->gpsdata.satellites_used,
3118
0
         magDec, magAcc,
3119
0
         session->newdata.errEllipseOrient,
3120
0
         session->newdata.errEllipseMajor,
3121
0
         session->newdata.errEllipseMinor);
3122
0
    GPSD_LOG(LOG_IO, &session->context->errout,
3123
0
             "UBX: NAV-PVAT: fixType(%s) flags(%s) flags2(%s) valid(%s)\n",
3124
0
             val2str(fixType, vpvt_fixType),
3125
0
             flags2str(flags, fnav_pvt_flags, buf2, sizeof(buf2)),
3126
0
             flags2str(flags2, fpvt_flags2, buf3, sizeof(buf3)),
3127
0
             flags2str(valid, fpvt_valid, buf4, sizeof(buf4)));
3128
0
    return mask;
3129
0
}
3130
3131
/**
3132
 * Navigation Position Velocity Time solution message
3133
 * UBX-NAV-PVT Class 1, ID 7
3134
 *
3135
 * Includes part of UBX-NAV-TIMEUTC
3136
 *
3137
 * Present in:
3138
 *   protver 14  (6-series w/ GLONASS, 7-series)
3139
 *
3140
 * Not present in:
3141
 *    u-blox 5 or 6
3142
 */
3143
static gps_mask_t ubx_msg_nav_pvt(struct gps_device_t *session,
3144
                                  unsigned char *buf, size_t data_len UNUSED)
3145
0
{
3146
0
    char buf2[80];
3147
0
    char buf3[80];
3148
0
    char buf4[80];
3149
0
    char buf5[80];
3150
0
    unsigned dgps_age;
3151
0
    struct tm unpacked_date = {0};
3152
0
    int *status = &session->newdata.status;
3153
0
    int *mode = &session->newdata.mode;
3154
0
    gps_mask_t mask = 0;
3155
0
    char ts_buf[TIMESPEC_LEN];
3156
3157
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3158
0
    unsigned valid = getub(buf, 11);
3159
0
    unsigned fixType = getub(buf, 20);
3160
0
    unsigned flags = getub(buf, 21);
3161
0
    unsigned flags2 = getub(buf, 22);
3162
0
    unsigned numSV = getub(buf, 23);
3163
0
    unsigned flags3 = getleu16(buf, 78);
3164
3165
    // session->gpsdata.satellites_used = numSV;
3166
3167
0
    switch (fixType) {
3168
0
    case UBX_MODE_TMONLY:
3169
        // 5 - Surveyed-in, so a precise 3D.
3170
0
        *mode = MODE_3D;
3171
0
        *status = STATUS_TIME;
3172
0
        mask |= STATUS_SET | MODE_SET;
3173
0
        break;
3174
3175
0
    case UBX_MODE_3D:
3176
        // 3
3177
0
        *mode = MODE_3D;
3178
0
        *status = STATUS_GPS;
3179
0
        mask |= STATUS_SET | LATLON_SET | MODE_SET;
3180
0
        break;
3181
3182
0
    case UBX_MODE_GPSDR:
3183
        // 4
3184
0
        *mode = MODE_3D;
3185
0
        *status = STATUS_GNSSDR;
3186
0
        mask |= STATUS_SET | LATLON_SET | MODE_SET;
3187
0
        break;
3188
3189
0
    case UBX_MODE_2D:
3190
        // 2
3191
0
        *mode = MODE_2D;
3192
0
        *status = STATUS_GPS;
3193
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
3194
0
        break;
3195
3196
0
    case UBX_MODE_DR:           // consider this too as 2D
3197
        // 1
3198
0
        *mode = MODE_2D;
3199
0
        *status = STATUS_DR;
3200
0
        mask |= LATLON_SET | SPEED_SET | MODE_SET | STATUS_SET;
3201
0
        break;
3202
3203
0
    case UBX_MODE_NOFIX:
3204
        // 0
3205
0
        FALLTHROUGH
3206
0
    default:
3207
        // huh?
3208
0
        *mode = MODE_NO_FIX;
3209
0
        *status = STATUS_UNK;
3210
0
        mask |= MODE_SET | STATUS_SET;
3211
0
        break;
3212
0
    }
3213
3214
0
    if (UBX_NAV_PVT_FLAG_DGPS == (flags & UBX_NAV_PVT_FLAG_DGPS)) {
3215
        // RTK flags not before protoVer 20.
3216
0
        if (UBX_NAV_PVT_FLAG_RTK_FIX == (flags & UBX_NAV_PVT_FLAG_RTK_FIX)) {
3217
0
            *status = STATUS_RTK_FIX;
3218
0
        } else if (UBX_NAV_PVT_FLAG_RTK_FLT ==
3219
0
                   (flags & UBX_NAV_PVT_FLAG_RTK_FLT)) {
3220
0
            *status = STATUS_RTK_FLT;
3221
0
        } else {
3222
0
            *status = STATUS_DGPS;
3223
0
        }
3224
3225
0
        dgps_age = (flags3 >> 1) & 0x0f;
3226
0
        if (0 < dgps_age) {
3227
0
            if (ROWS(pvt_dgps_age) <= dgps_age) {
3228
0
                dgps_age = ROWS(pvt_dgps_age) - 1;
3229
0
            }
3230
0
            session->newdata.dgps_age = pvt_dgps_age[dgps_age];
3231
0
        }
3232
0
        mask |= STATUS_SET;
3233
0
    }
3234
3235
0
    if ((valid & UBX_NAV_PVT_VALID_DATE_TIME) == UBX_NAV_PVT_VALID_DATE_TIME) {
3236
0
        unpacked_date.tm_year = (uint16_t)getleu16(buf, 4) - 1900;
3237
0
        unpacked_date.tm_mon = (uint8_t)getub(buf, 6) - 1;
3238
0
        unpacked_date.tm_mday = (uint8_t)getub(buf, 7);
3239
0
        unpacked_date.tm_hour = (uint8_t)getub(buf, 8);
3240
0
        unpacked_date.tm_min = (uint8_t)getub(buf, 9);
3241
0
        unpacked_date.tm_sec = (uint8_t)getub(buf, 10);
3242
0
        unpacked_date.tm_isdst = 0;
3243
0
        unpacked_date.tm_wday = 0;
3244
0
        unpacked_date.tm_yday = 0;
3245
0
        session->newdata.time.tv_sec = mkgmtime(&unpacked_date);
3246
        // field 16, nano, can be negative! So normalize
3247
0
        session->newdata.time.tv_nsec = getles32(buf, 16);
3248
0
        TS_NORM(&session->newdata.time);
3249
0
        mask |= TIME_SET | NTPTIME_IS | GOODTIME_IS;
3250
0
    }
3251
3252
0
    session->newdata.longitude = 1e-7 * getles32(buf, 24);
3253
0
    session->newdata.latitude = 1e-7 * getles32(buf, 28);
3254
    // altitude WGS84
3255
0
    session->newdata.altHAE = 1e-3 * getles32(buf, 32);
3256
    // altitude MSL
3257
0
    session->newdata.altMSL = 1e-3 * getles32(buf, 36);
3258
    // Let gpsd_error_model() deal with geoid_sep
3259
3260
0
    session->newdata.speed = 1e-3 * (int32_t)getles32(buf, 60);
3261
    // u-blox calls this Heading of motion (2-D)
3262
0
    session->newdata.track = 1e-5 * (int32_t)getles32(buf, 64);
3263
    // FIXME!!!!!
3264
0
    mask |= LATLON_SET | ALTITUDE_SET | SPEED_SET | TRACK_SET;
3265
3266
    /* u-blox does not document the basis for the following "accuracy"
3267
     * estimates.  Maybe CEP(50), one sigma, two sigma, CEP(99), etc. */
3268
3269
    // Horizontal Accuracy estimate, in mm
3270
0
    session->newdata.eph = (double)(getles32(buf, 40) / 1000.0);
3271
    // Vertical Accuracy estimate, in mm
3272
0
    session->newdata.epv = (double)(getles32(buf, 44) / 1000.0);
3273
    // Speed Accuracy estimate, in mm/s
3274
0
    session->newdata.eps = (double)(getles32(buf, 68) / 1000.0);
3275
    // let gpsd_error_model() do the rest
3276
3277
0
    mask |= HERR_SET | SPEEDERR_SET | VERR_SET;
3278
    // if cycle ender worked, could get rid of this REPORT_IS.
3279
    // mask |= REPORT_IS;
3280
3281
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3282
0
         "UBX: NAV-PVT: flags %02x time %s valid x%x lat %.2f lon %.2f "
3283
0
         "altHAE %.2f "
3284
0
         "track %.2f speed %.2f mode %d status %d used %d dgps_age %.0f\n",
3285
0
         flags,
3286
0
         timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
3287
0
         valid,
3288
0
         session->newdata.latitude,
3289
0
         session->newdata.longitude,
3290
0
         session->newdata.altHAE,
3291
0
         session->newdata.track,
3292
0
         session->newdata.speed,
3293
0
         session->newdata.mode,
3294
0
         session->newdata.status,
3295
0
         numSV,   // session->gpsdata.satellites_used,
3296
0
         session->newdata.dgps_age);
3297
0
    GPSD_LOG(LOG_IO, &session->context->errout,
3298
0
             "UBX: NAV-PVT: fixType %s flags(%s_ flags2(%s) flags3(%s) "
3299
0
             "valid(%s)\n",
3300
0
             val2str(fixType, vpvt_fixType),
3301
0
             flags2str(flags, fnav_pvt_flags, buf2, sizeof(buf2)),
3302
0
             flags2str(flags2, fpvt_flags2, buf3, sizeof(buf3)),
3303
0
             flags2str(flags3, fpvt_flags3, buf4, sizeof(buf4)),
3304
0
             flags2str(valid, fpvt_valid, buf5, sizeof(buf5)));
3305
0
    if (92 <= data_len) {
3306
        // u-blox 8 and 9 extended
3307
0
        double magDec = NAN;
3308
0
        double magAcc = NAN;
3309
#ifdef __UNUSED
3310
        if (flags & UBX_NAV_PVT_FLAG_HDG_OK) {
3311
            /* u-blox calls this Heading of vehicle (2-D)
3312
             * why is it different than earlier track? */
3313
            session->newdata.track = (double)(getles32(buf, 84) * 1e-5);
3314
        }
3315
#endif  // __UNUSED
3316
0
        if (valid & UBX_NAV_PVT_VALID_MAG) {
3317
0
            magDec = (double)(getles16(buf, 88) * 1e-2);
3318
0
            magAcc = (double)(getleu16(buf, 90) * 1e-2);
3319
0
        }
3320
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3321
0
             " UBX: NAV-PVT: headVeh %.5f magDec %.2f magAcc %.2f\n",
3322
0
             session->newdata.track, magDec, magAcc);
3323
0
    }
3324
0
    return mask;
3325
0
}
3326
3327
 /**
3328
 * High Precision Relative Positioning Information in NED frame
3329
 * UBX-NAV-RELPOSNED, Class 1, ID x3c
3330
 * HP GNSS only, protver 20+
3331
 */
3332
static gps_mask_t ubx_msg_nav_relposned(struct gps_device_t *session,
3333
                                        unsigned char *buf, size_t data_len)
3334
0
{
3335
0
    int version;
3336
0
    unsigned flags;
3337
0
    double accN = NAN, accE = NAN, accD = NAN, accL = NAN, accH = NAN;
3338
0
    gps_mask_t mask = 0;
3339
3340
0
    if (40 > data_len) {
3341
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3342
0
                 "UBX: NAV-RELPOSNED:0: runt payload len %zd",
3343
0
                 data_len);
3344
0
        return mask;
3345
0
    }
3346
0
    version = getub(buf, 0);
3347
    /* WTF?  u-blox did not make this sentence upward compatible
3348
     * 40 bytes in Version 0, protVer 20 to 27
3349
     * 64 bytes in Version 1, protVer 27.11+ */
3350
3351
0
    session->newdata.dgps_station = getleu16(buf, 2);          // 0 to 4095
3352
0
    session->driver.ubx.iTOW = getleu32(buf, 4);
3353
0
    if (1 > version) {
3354
        // version 0
3355
0
        flags = getleu32(buf, 36);
3356
0
        if (1 != (1 & flags)) {
3357
            // not gnssFixOK
3358
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
3359
0
                     "UBX: NAV-RELPOSNED:0 no fix");
3360
0
            return mask;
3361
0
        }
3362
0
        if (4 & flags) {
3363
            // rePosValid
3364
0
            session->newdata.NED.relPosN = getles32x100s8d(buf, 8, 20, 1e-4);
3365
0
            session->newdata.NED.relPosE = getles32x100s8d(buf, 12, 21, 1e-4);
3366
0
            session->newdata.NED.relPosD = getles32x100s8d(buf, 16, 22, 1e-4);
3367
3368
0
            accN = 1e-4 * getles32(buf, 24);
3369
0
            accE = 1e-4 * getles32(buf, 28);
3370
0
            accD = 1e-4 * getles32(buf, 32);
3371
0
            mask |= NED_SET;
3372
0
        }
3373
0
    } else {
3374
        // assume version 1
3375
0
        if (64 > data_len) {
3376
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
3377
0
                     "UBX: NAV-RELPOSNED:1: runt payload len %zd",
3378
0
                     data_len);
3379
0
            return mask;
3380
0
        }
3381
0
        flags = getleu32(buf, 60);
3382
0
        if (1 != (1 & flags)) {
3383
            // not gnssFixOK
3384
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
3385
0
                     "UBX: NAV-RELPOSNED:1 no fix");
3386
0
            return mask;
3387
0
        }
3388
0
        if (4 & flags) {
3389
            // rePosValid
3390
0
            session->newdata.NED.relPosN = getles32x100s8d(buf, 8, 32, 1e-4);
3391
0
            session->newdata.NED.relPosE = getles32x100s8d(buf, 12, 33, 1e-4);
3392
0
            session->newdata.NED.relPosD = getles32x100s8d(buf, 16, 34, 1e-4);
3393
0
            session->newdata.NED.relPosL = getles32x100s8d(buf, 20, 35, 1e-4);
3394
3395
0
            accN = 1e-4 * getles32(buf, 36);
3396
0
            accE = 1e-4 * getles32(buf, 40);
3397
0
            accD = 1e-4 * getles32(buf, 44);
3398
0
            accL = 1e-4 * getles32(buf, 48);
3399
0
            accH = 1e-4 * getles32(buf, 52);
3400
0
            if (0x100 & flags) {
3401
                // relPosHeadingValid
3402
0
                session->newdata.NED.relPosH = 1e-5 * getles32(buf, 24);
3403
0
            }
3404
0
            mask |= NED_SET;
3405
            // FIXME: RTK flags?
3406
0
        }
3407
0
    }
3408
3409
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3410
0
        "UBX: NAV-RELPOSNED: version %d iTOW=%lld refStationId %u flags x%x\n"
3411
0
        "UBX: NAV-RELPOSNED: relPos N=%.4f E=%.4f D=%.4f\n"
3412
0
        "UBX: NAV-RELPOSNED: acc N=%.4f E=%.4f D=%.4f L=%.4f H=%.4f\n",
3413
0
        version,
3414
0
        (long long)session->driver.ubx.iTOW,
3415
0
        session->newdata.dgps_station,
3416
0
        flags,
3417
0
        session->newdata.NED.relPosN,
3418
0
        session->newdata.NED.relPosE,
3419
0
        session->newdata.NED.relPosD,
3420
0
        accN, accE, accD, accL, accH);
3421
3422
0
    if (5 != (flags & 5)) {
3423
        // gnssFixOK or relPosValid are false, no fix
3424
0
        return 0;
3425
0
    }
3426
0
    return mask;
3427
0
}
3428
3429
/**
3430
 * GPS Satellite Info -- new style UBX-NAV-SAT
3431
 * Not present in:
3432
 *     u-blox 5
3433
 *     protVer 12  5 and 6-series
3434
 * Present in:
3435
 *    protVer 15_  8-series
3436
 *    protVer 27   (ZED-F9P)
3437
 */
3438
static gps_mask_t ubx_msg_nav_sat(struct gps_device_t *session,
3439
                                  unsigned char *buf, size_t data_len)
3440
0
{
3441
0
    char buf2[80];
3442
0
    unsigned int i, nchan, ver;
3443
0
    int seen = 0, used_tot = 0;
3444
0
    timespec_t ts_tow;
3445
3446
0
    if (8 > data_len) {
3447
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3448
0
                 "UBX: NAV-SAT runt datalen %zd\n", data_len);
3449
0
        return 0;
3450
0
    }
3451
3452
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3453
0
    MSTOTS(&ts_tow, session->driver.ubx.iTOW);
3454
0
    session->gpsdata.skyview_time =
3455
0
        gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
3456
3457
0
    ver = (unsigned int)getub(buf, 4);
3458
0
    if (1 != ver) {
3459
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3460
0
                 "UBX: NAV-SAT unknown version %d", ver);
3461
0
        return 0;
3462
0
    }
3463
0
    nchan = (unsigned int)getub(buf, 5);
3464
0
    if (nchan > MAXCHANNELS) {
3465
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3466
0
                 "UBX: NAV-SAT: runt >%d reported visible",
3467
0
                 MAXCHANNELS);
3468
0
        return 0;
3469
0
    }
3470
3471
#ifdef __UNUSED__    // debug
3472
    GPSD_LOG(LOG_SHOUT, &session->context->errout,
3473
             "UBX: NAV-SAT: gpsd_zero_satellites()\n");
3474
#endif
3475
0
    gpsd_zero_satellites(&session->gpsdata);
3476
3477
0
    for (i = 0; i < nchan; i++) {
3478
0
        unsigned int off = 8 + 12 * i;
3479
0
        short nmea_PRN = 0;
3480
0
        uint8_t gnssId = getub(buf, off + 0);
3481
0
        uint8_t svId = getub(buf, off + 1);
3482
0
        uint8_t cno = getub(buf, off + 2);
3483
0
        int elev = getsb(buf, off + 3);
3484
0
        int azim = getles16(buf, off + 4);
3485
0
        int prRes = getles16(buf, off + 6);
3486
        // health data in flags
3487
0
        unsigned long flags = getleu32(buf, off + 8);
3488
0
        bool used = (bool)(flags  & 0x08);
3489
        // Notice NO sigid!
3490
3491
0
        nmea_PRN = ubx2_to_prn(gnssId, svId);
3492
0
        if (0 >= nmea_PRN) {
3493
            // bad PRN??
3494
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
3495
0
                     "UBX: NAV-SAT(%d) Bad PRN: gnssid %u, svid %u PRN %d\n",
3496
0
                     seen, gnssId, svId, nmea_PRN);
3497
0
            continue;
3498
0
        }
3499
0
        session->gpsdata.skyview[seen].gnssid = gnssId;
3500
0
        session->gpsdata.skyview[seen].svid = svId;
3501
0
        session->gpsdata.skyview[seen].PRN = nmea_PRN;
3502
3503
0
        session->gpsdata.skyview[seen].ss = (double)cno;
3504
0
        if (90 >= abs(elev)) {
3505
0
            session->gpsdata.skyview[seen].elevation = (double)elev;
3506
0
        }
3507
        /* For some reason UBX allows 360 == azim here, but gpsd json does not
3508
         * so fix that.  Other UBX specifies 0-359. */
3509
0
        if (360 == azim) {
3510
0
            azim = 0;
3511
0
        }
3512
0
        if (360 > azim &&
3513
0
            0 <= azim) {
3514
0
            session->gpsdata.skyview[seen].azimuth = (double)azim;
3515
0
        }
3516
0
        session->gpsdata.skyview[seen].used = used;
3517
        // sbas_in_use is not same as used
3518
0
        if (used) {
3519
0
            used_tot++;
3520
0
        }
3521
0
        session->gpsdata.skyview[seen].prRes = prRes / 10.0;
3522
        // by some coincidence, our health flags matches u-blox's
3523
0
        session->gpsdata.skyview[seen].health = (flags >> 4) & 3;
3524
0
        session->gpsdata.skyview[seen].qualityInd = flags & 7;
3525
        // FIXME: sigid?
3526
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3527
0
                 "UBX: NAV-SAT(%d) gnssid %u, svid %u PRN %d "
3528
0
                 "prRes %d cno %u el %.1f az %.1f qual %d flags x%lx\n",
3529
0
                 seen, gnssId, svId, nmea_PRN, prRes, cno,
3530
0
                 session->gpsdata.skyview[seen].elevation,
3531
0
                 session->gpsdata.skyview[seen].azimuth,
3532
0
                 session->gpsdata.skyview[seen].qualityInd,
3533
0
                 flags);
3534
0
        GPSD_LOG(LOG_IO, &session->context->errout,
3535
0
                 "UBX: NAV-SAT: gnssId:%s flags:%s quality:%s\n",
3536
0
                 val2str(gnssId, vgnssId),
3537
0
                 flags2str(flags, fsat_flags, buf2, sizeof(buf2)),
3538
0
                 val2str(flags & 7, vquality));
3539
3540
0
        seen++;
3541
0
    }
3542
3543
0
    session->gpsdata.satellites_visible = seen;
3544
0
    session->gpsdata.satellites_used = used_tot;
3545
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3546
0
             "UBX: NAV-SAT: visible=%d used=%d mask={SATELLITE|USED}\n",
3547
0
             session->gpsdata.satellites_visible,
3548
0
             session->gpsdata.satellites_used);
3549
0
    return SATELLITE_SET | USED_IS;
3550
0
}
3551
3552
/*
3553
 * SBAS Info UBX-NAV-SBAS
3554
 * in u-blox 4_
3555
 * in NEO-M9N
3556
 * Not in some u-blox 9
3557
 * Decode looks good, but data only goes to log.
3558
 */
3559
static gps_mask_t ubx_msg_nav_sbas(struct gps_device_t *session,
3560
                                   unsigned char *buf, size_t data_len)
3561
0
{
3562
0
    unsigned i, cnt;
3563
0
    unsigned ubx_PRN;
3564
0
    short nmea_PRN;
3565
0
    unsigned char gnssid = 0;
3566
0
    unsigned char svid = 0;
3567
3568
0
    if (12 > data_len) {
3569
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3570
0
                 "UBX: NAV-SBAS: runt payload len %zd", data_len);
3571
0
        return 0;
3572
0
    }
3573
3574
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3575
0
    ubx_PRN = getub(buf, 4);
3576
0
    cnt = getub(buf, 8);
3577
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3578
0
             "UBX: NAV-SBAS iTOW %lu geo %u mode %u sys %u service x%x "
3579
0
             "cnt %u\n",
3580
0
             (unsigned long)session->driver.ubx.iTOW,
3581
0
             ubx_PRN, (unsigned)getub(buf, 5),
3582
0
             (unsigned)getub(buf, 6), (unsigned)getub(buf, 7),
3583
0
             cnt);
3584
3585
0
    if (MAXCHANNELS < cnt) {
3586
        // too many sats for us, pacify coverity
3587
0
        cnt = MAXCHANNELS;
3588
0
    }
3589
0
    if (data_len < (12 + (12 * cnt))) {
3590
        // length check, pacify coverity
3591
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3592
0
                 "UBX: NAV-SBAS: bad length %zd", data_len);
3593
0
    }
3594
0
    for (i = 0; i < cnt; i++) {
3595
0
        int off = 12 + (12 * i);
3596
0
        unsigned svID = getub(buf, off);
3597
0
        unsigned flags = getub(buf, off + 1);
3598
        // User Differential Range Error (udre)
3599
0
        unsigned udre = getub(buf, off + 2);
3600
0
        int svSys = getsb(buf, off + 3);
3601
0
        unsigned svService = getub(buf, off + 4);
3602
0
        int prc = getles16(buf, off + 6);
3603
0
        int ic = getles16(buf, off + 10);
3604
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3605
0
                 "UBX: NAV-SBAS SV%3u flags x%02x udre %u svSys %2d "
3606
0
                 "svService x%x prc %d ic %d\n",
3607
0
                 svID, flags, udre, svSys, svService, prc, ic);
3608
0
    }
3609
    /* really 'in_use' depends on the sats info, EGNOS is still
3610
     * in test.  In WAAS areas one might also check for the type of
3611
     * corrections indicated
3612
     */
3613
3614
0
    nmea_PRN = ubx_to_prn(ubx_PRN, &gnssid, &svid);
3615
#ifdef __UNUSED
3616
    // debug
3617
    GPSD_LOG(LOG_ERROR, &session->context->errout,
3618
             "UBX: NAV-SBAS ubx_prn %d gnssid %d, svid %d nmea_PRN %d\n",
3619
             ubx_PRN, gnssid, svid, nmea_PRN);
3620
#endif  // __UNUSED
3621
0
    session->driver.ubx.sbas_in_use = nmea_PRN;
3622
0
    return 0;
3623
0
}
3624
3625
/**
3626
 * Satellite Info -- UBX-NAV-SIG
3627
 *
3628
 * Like NAV-SAT, but NAV-SIG has no elevation and azimuth!  So we need both.
3629
 * Assume NAV-SAT was sent in this epoch before NAV-SIG.
3630
 * Seems like NAV-SAT always sent just before NAV-SIG.
3631
 *
3632
 * Present in:
3633
 *    protVer 27 (9-series and 10)
3634
 * Not present in:
3635
 *    protVer 12 6-eries
3636
 *    before protVer 27
3637
 */
3638
static gps_mask_t ubx_msg_nav_sig(struct gps_device_t *session,
3639
                                  unsigned char *buf, size_t data_len)
3640
0
{
3641
0
    unsigned int i, nchan, ver;
3642
0
    int seen = 0, used_tot = 0;
3643
0
    timespec_t ts_tow;
3644
    // saved skyview, hopefully from NAV-SAT
3645
0
    struct satellite_t skyview_old[MAXCHANNELS];
3646
3647
0
    if (8 > data_len) {
3648
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3649
0
                 "UBX: NAV-SIG runt datalen %zd\n", data_len);
3650
0
        return 0;
3651
0
    }
3652
3653
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3654
0
    MSTOTS(&ts_tow, session->driver.ubx.iTOW);
3655
0
    session->gpsdata.skyview_time =
3656
0
        gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
3657
3658
0
    ver = getub(buf, 4);
3659
0
    if (0 != ver) {
3660
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3661
0
                 "UBX: NAV-SIG unknown version %d s/b 0", ver);
3662
0
        return 0;
3663
0
    }
3664
0
    nchan = getub(buf, 5);
3665
0
    if (nchan > MAXCHANNELS) {
3666
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3667
0
                 "UBX: NAV-SIG: nchan %u > MAXCHANNELS %d",
3668
0
                 nchan, MAXCHANNELS);
3669
0
        return 0;
3670
0
    }
3671
    // two "unused" bytes at buf[6:7]
3672
3673
    /* elevation and azimuth are in NAV-SAT, make a copy of any NAV-SAT
3674
     * data before initializiing it. */
3675
0
    memcpy(skyview_old, session->gpsdata.skyview, sizeof(skyview_old));
3676
3677
#ifdef __UNUSED__    // debug
3678
    GPSD_LOG(LOG_SHOUT, &session->context->errout,
3679
             "UBX: NAV-SIG: gpsd_zero_satellites()\n");
3680
#endif
3681
0
    gpsd_zero_satellites(&session->gpsdata);
3682
3683
0
    for (i = 0; i < nchan; i++) {
3684
        // like NAV-SAT, but 16 bytes instead of 12, no elevation or azimuth
3685
0
        char buf2[80];
3686
0
        int sat_old;
3687
0
        unsigned off = 8 + 16 * i;
3688
0
        short nmea_PRN = 0;
3689
0
        uint8_t gnssId = getub(buf, off + 0);
3690
0
        uint8_t svId = getub(buf, off + 1);
3691
0
        uint8_t sigId = getub(buf, off + 2);
3692
0
        uint8_t freqid = getub(buf, off + 3);
3693
0
        int16_t prRes = getles16(buf, off + 4);     // 0.1 m
3694
0
        uint8_t cno = getub(buf, off + 6);          // dBHz
3695
0
        uint8_t qualityInd = getub(buf, off + 7);   // quality indicator
3696
        // not exactly right?
3697
0
        bool used = (4 <= qualityInd) ? true : false;
3698
0
        uint8_t corrSource = getub(buf, off + 8);   // correlation source
3699
0
        uint8_t ionoModel = getub(buf, off + 9);    // Ionospheric model used:
3700
0
        unsigned sigFlags = getleu16(buf, off + 10);
3701
3702
        // last 4 bytes, reserved
3703
0
        uint32_t reserved = getleu32(buf, 12);
3704
3705
0
        nmea_PRN = ubx2_to_prn(gnssId, svId);
3706
0
        if (0 >= nmea_PRN) {
3707
0
            if (-1 == nmea_PRN) {
3708
                // ignore GLONASS 255
3709
0
                continue;
3710
0
            }
3711
            // bad PRN??
3712
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
3713
0
                     "UBX: NAV-SIG(%d) Bad PRN: gnssid %u, svid %u PRN %d\n",
3714
0
                     seen, gnssId, svId, nmea_PRN);
3715
0
            continue;
3716
0
        }
3717
3718
0
        session->gpsdata.skyview[seen].gnssid = gnssId;
3719
0
        session->gpsdata.skyview[seen].svid = svId;
3720
0
        session->gpsdata.skyview[seen].sigid = sigId;
3721
0
        session->gpsdata.skyview[seen].freqid = freqid;
3722
0
        session->gpsdata.skyview[seen].PRN = nmea_PRN;
3723
0
        session->gpsdata.skyview[seen].prRes = prRes / 10.0;
3724
0
        session->gpsdata.skyview[seen].qualityInd = qualityInd;
3725
3726
0
        session->gpsdata.skyview[seen].ss = (double)cno;
3727
0
        session->gpsdata.skyview[seen].used = used;
3728
        // sbas_in_use is not same as used
3729
0
        if (used) {
3730
0
            used_tot++;
3731
0
        }
3732
        // by some coincidence, our health flags matches u-blox's
3733
0
        session->gpsdata.skyview[seen].health = sigFlags & 3;
3734
        // try to keep elevation and azimuth from NAV-SAT
3735
0
        for (sat_old = 0; sat_old < MAXCHANNELS; sat_old++) {
3736
0
            if (0 >= skyview_old[sat_old].PRN) {
3737
                // end of list, not found
3738
0
                break;
3739
0
            }
3740
0
            if (nmea_PRN != skyview_old[sat_old].PRN) {
3741
                // not this one
3742
0
                continue;
3743
0
            }
3744
            // found it, grab the data
3745
0
            session->gpsdata.skyview[seen].azimuth =
3746
0
                skyview_old[sat_old].azimuth;
3747
0
            session->gpsdata.skyview[seen].elevation =
3748
0
                skyview_old[sat_old].elevation;
3749
0
            break;
3750
0
        }
3751
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
3752
0
                 "UBX: NAV-SIG gnssid %u, svid %u sigid %u PRN %d freqid %u "
3753
0
                 "prRes %d cno %u qual %u corr %u, iono %u flags x%x res x%x "
3754
0
                 "az %.1f el %.1f\n",
3755
0
                 gnssId, svId, sigId, nmea_PRN, freqid, prRes, cno,
3756
0
                 qualityInd, corrSource, ionoModel, sigFlags, reserved,
3757
0
                 session->gpsdata.skyview[seen].azimuth,
3758
0
                 session->gpsdata.skyview[seen].elevation);
3759
0
        GPSD_LOG(LOG_IO, &session->context->errout,
3760
0
                 "UBX: NAV-SIG(%d): gnssId:%s flags:%s quality:%s "
3761
0
                 "courrSource:%s ionoModel:%s\n",
3762
0
                 seen, val2str(gnssId, vgnssId),
3763
0
                 flags2str(sigFlags, fsig_sigFlags, buf2, sizeof(buf2)),
3764
0
                 val2str(qualityInd, vquality),
3765
0
                 val2str(corrSource, vsig_corrsource),
3766
0
                 val2str(ionoModel, vsig_ionomodel));
3767
3768
0
        seen++;
3769
0
    }
3770
3771
0
    session->gpsdata.satellites_visible = seen;
3772
0
    session->gpsdata.satellites_used = used_tot;
3773
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3774
0
             "UBX: NAV-SIG: visible=%d used=%d mask={SATELLITE|USED}\n",
3775
0
             session->gpsdata.satellites_visible,
3776
0
             session->gpsdata.satellites_used);
3777
0
    return SATELLITE_SET | USED_IS;
3778
0
}
3779
3780
/**
3781
 * Navigation solution message: UBX-NAV-SOL
3782
 *
3783
 * Present in:
3784
 *    protVer 7 ( Antaris)
3785
 *    protVer up to 23,01
3786
 *
3787
 * Deprecated in:
3788
 *    protVer 13 (6-series)
3789
 *
3790
 * Not present in:
3791
 *    protVer 27 (9-series)
3792
 *    Use UBX-NAV-PVT instead
3793
 *
3794
 * UBX-NAV-SOL has ECEF and VECEF, so no need for UBX-NAV-POSECEF and
3795
 * UBX-NAV-VELECEF
3796
 */
3797
static gps_mask_t ubx_msg_nav_sol(struct gps_device_t *session,
3798
                                  unsigned char *buf, size_t data_len)
3799
0
{
3800
0
    char buf2[80];
3801
0
    unsigned flags, pdop;
3802
0
    unsigned gpsFix;
3803
0
    gps_mask_t mask = 0;
3804
0
    char ts_buf[TIMESPEC_LEN];
3805
3806
0
    if (52 > data_len) {
3807
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3808
0
                 "UBX: NAV-SOL: runt payload len %zd", data_len);
3809
0
        return 0;
3810
0
    }
3811
3812
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3813
0
    gpsFix = getub(buf, 10);
3814
0
    flags = getub(buf, 11);
3815
0
    mask = 0;
3816
0
#define DATE_VALID      (UBX_SOL_VALID_WEEK | UBX_SOL_VALID_TIME)
3817
0
    if ((flags & DATE_VALID) == DATE_VALID) {
3818
0
        unsigned short week;
3819
0
        timespec_t ts_tow;
3820
3821
0
        MSTOTS(&ts_tow, session->driver.ubx.iTOW);
3822
0
        ts_tow.tv_nsec += (long)getles32(buf, 4);
3823
0
        TS_NORM(&ts_tow);
3824
0
        week = (unsigned short)getles16(buf, 8);
3825
0
        session->newdata.time = gpsd_gpstime_resolv(session, week, ts_tow);
3826
0
        mask |= TIME_SET | NTPTIME_IS | GOODTIME_IS;
3827
0
    }
3828
0
#undef DATE_VALID
3829
3830
0
    session->newdata.ecef.x = getles32(buf, 12) / 100.0;
3831
0
    session->newdata.ecef.y = getles32(buf, 16) / 100.0;
3832
0
    session->newdata.ecef.z = getles32(buf, 20) / 100.0;
3833
0
    session->newdata.ecef.pAcc = getleu32(buf, 24) / 100.0;
3834
0
    session->newdata.ecef.vx = getles32(buf, 28) / 100.0;
3835
0
    session->newdata.ecef.vy = getles32(buf, 32) / 100.0;
3836
0
    session->newdata.ecef.vz = getles32(buf, 36) / 100.0;
3837
0
    session->newdata.ecef.vAcc = getleu32(buf, 40) / 100.0;
3838
0
    mask |= ECEF_SET | VECEF_SET;
3839
3840
0
    session->newdata.eps = (double)(getles32(buf, 40) / 100.0);
3841
0
    mask |= SPEEDERR_SET;
3842
3843
0
    pdop = getleu16(buf, 44);
3844
0
    if (9999 > pdop) {
3845
0
        session->gpsdata.dop.pdop = (double)(pdop / 100.0);
3846
0
        mask |= DOP_SET;
3847
0
    }
3848
0
    session->gpsdata.satellites_used = (int)getub(buf, 47);
3849
3850
0
    switch (gpsFix) {
3851
0
    case UBX_MODE_TMONLY:
3852
        // Surveyed-in, better not have moved
3853
0
        session->newdata.mode = MODE_3D;
3854
0
        session->newdata.status = STATUS_TIME;
3855
0
        break;
3856
0
    case UBX_MODE_3D:
3857
0
        session->newdata.mode = MODE_3D;
3858
0
        session->newdata.status = STATUS_GPS;
3859
0
        break;
3860
0
    case UBX_MODE_2D:
3861
0
        session->newdata.mode = MODE_2D;
3862
0
        session->newdata.status = STATUS_GPS;
3863
0
        break;
3864
0
    case UBX_MODE_DR:           // consider this too as 2D
3865
0
        session->newdata.mode = MODE_2D;
3866
0
        session->newdata.status = STATUS_DR;
3867
0
        break;
3868
0
    case UBX_MODE_GPSDR:        // DR-aided GPS is valid 3D
3869
0
        session->newdata.mode = MODE_3D;
3870
0
        session->newdata.status = STATUS_GNSSDR;
3871
0
        break;
3872
0
    default:
3873
0
        session->newdata.mode = MODE_NO_FIX;
3874
0
        session->newdata.status = STATUS_UNK;
3875
0
        break;
3876
0
    }
3877
3878
0
    if (0 != (flags & UBX_SOL_FLAG_DGPS))
3879
0
        session->newdata.status = STATUS_DGPS;
3880
3881
0
    mask |= MODE_SET | STATUS_SET;
3882
    // older u-blox, cycle ender may be iffy
3883
    // so err o nthe side of over-reporting TPV
3884
0
    mask |= REPORT_IS;
3885
3886
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
3887
0
             "UBX: NAV-SOL: time=%s ecef x:%.2f y:%.2f z:%.2f track=%.2f "
3888
0
             "speed=%.2f mode=%d status=%d used=%d\n",
3889
0
             timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
3890
0
             session->newdata.ecef.x,
3891
0
             session->newdata.ecef.y,
3892
0
             session->newdata.ecef.z,
3893
0
             session->newdata.track,
3894
0
             session->newdata.speed,
3895
0
             session->newdata.mode,
3896
0
             session->newdata.status,
3897
0
             session->gpsdata.satellites_used);
3898
0
    GPSD_LOG(LOG_IO, &session->context->errout,
3899
0
             "UBX: NAV-SOL-PVT: gpsFix:%s flags:%s\n",
3900
0
             val2str(gpsFix, vpvt_fixType),
3901
0
             flags2str(flags, fhnr_pvt_flags, buf2, sizeof(buf2)));
3902
0
    return mask;
3903
0
}
3904
3905
3906
/**
3907
 * Receiver navigation status
3908
 * UBX-NAV-STATUS Class 1, ID 3
3909
 *
3910
 * Present in Antaris to 9-series
3911
 */
3912
static gps_mask_t
3913
ubx_msg_nav_status(struct gps_device_t *session, unsigned char *buf,
3914
                   size_t data_len)
3915
0
{
3916
0
    uint8_t gpsFix;
3917
0
    uint8_t flags;
3918
0
    uint8_t fixStat;
3919
0
    uint8_t flags2;
3920
0
    uint32_t ttff;
3921
0
    uint32_t msss;
3922
0
    int *status = &session->newdata.status;
3923
0
    int *mode = &session->newdata.mode;
3924
0
    gps_mask_t mask = 0;
3925
3926
0
    if (16 > data_len) {
3927
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
3928
0
                 "UBX: NAV-STATUS: runt payload len %zd", data_len);
3929
0
        return 0;
3930
0
    }
3931
3932
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
3933
0
    gpsFix = getub(buf, 4);
3934
0
    flags = getub(buf, 5);
3935
0
    fixStat = getub(buf, 6);
3936
0
    flags2 = getub(buf, 7);
3937
0
    ttff = getleu32(buf, 8);
3938
0
    msss = getleu32(buf, 12);
3939
3940
    // FIXME: how does this compare with other places ubx sets mode/status?
3941
0
    if (0 == (1 & flags)) {
3942
        // gpsFix not OK
3943
0
        *mode = MODE_NO_FIX;
3944
0
        *status = STATUS_UNK;
3945
0
    } else {
3946
0
        switch (gpsFix) {
3947
0
        case UBX_MODE_TMONLY:
3948
            // 5 - Surveyed-in, so a precise 3D.
3949
0
            *mode = MODE_3D;
3950
0
            *status = STATUS_TIME;
3951
0
            break;
3952
3953
0
        case UBX_MODE_3D:
3954
            // 3
3955
0
            *mode = MODE_3D;
3956
0
            *status = STATUS_GPS;
3957
0
            break;
3958
3959
0
        case UBX_MODE_GPSDR:
3960
            // 4
3961
0
            *mode = MODE_3D;
3962
0
            *status = STATUS_GNSSDR;
3963
0
            break;
3964
3965
0
        case UBX_MODE_2D:
3966
            // 2
3967
0
            *mode = MODE_2D;
3968
0
            if (2 == (2 & fixStat)) {
3969
0
                *status = STATUS_DGPS;
3970
0
            } else {
3971
0
                *status = STATUS_GPS;
3972
0
            }
3973
0
            break;
3974
3975
0
        case UBX_MODE_DR:           // consider this too as 2D
3976
            // 1
3977
0
            *mode = MODE_2D;
3978
0
            *status = STATUS_DR;
3979
0
            break;
3980
3981
0
        case UBX_MODE_NOFIX:
3982
            // 0
3983
0
            FALLTHROUGH
3984
0
        default:
3985
            // > 5, huh??
3986
0
            *mode = MODE_NO_FIX;
3987
0
            *status = STATUS_UNK;
3988
0
            break;
3989
0
        }
3990
0
        if (2 == (2 & fixStat)) {
3991
0
            if (0x40 == (0x40 & flags2)) {
3992
0
                *status = STATUS_RTK_FLT;
3993
0
            } else if (0x80 == (0x80 & flags2)) {
3994
0
                *status = STATUS_RTK_FIX;
3995
0
            }
3996
            // else ??
3997
0
        } else if (1 == (1 & fixStat)) {
3998
0
            *status = STATUS_DGPS;
3999
0
        }
4000
0
    }
4001
0
    mask |= STATUS_SET | MODE_SET;
4002
4003
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4004
0
         "UBX: NAV-STATUS: iTOW %lld gpsFix %u flags %02x fixStat %02x "
4005
0
         "flags2=%02x ttff=%llu msss=%llu mode=%u status=%u\n",
4006
0
         (long long)session->driver.ubx.iTOW,
4007
0
         gpsFix,
4008
0
         flags,
4009
0
         fixStat,
4010
0
         flags2,
4011
0
         (long long unsigned)ttff,
4012
0
         (long long unsigned)msss,
4013
0
         session->newdata.mode,
4014
0
         session->newdata.status);
4015
0
    return mask;
4016
0
}
4017
4018
/**
4019
 * Survey-in data - UBX-NAV-SVIN
4020
 * Time Sync products only
4021
 */
4022
static gps_mask_t ubx_msg_nav_svin(struct gps_device_t *session,
4023
                                   unsigned char *buf, size_t data_len UNUSED)
4024
0
{
4025
0
    gps_mask_t mask = ONLINE_SET;
4026
0
    unsigned version = getub(buf, 0);
4027
    // 3 reserved bytes
4028
0
    unsigned long iTOW = getleu32(buf, 4);
4029
0
    unsigned long dur = getleu32(buf, 0);
4030
0
    long long meanX = getles32(buf, 12);             // cm
4031
0
    long long meanY = getles32(buf, 16);             // cm
4032
0
    long long meanZ = getles32(buf, 20);             // cm
4033
0
    int meanXHP = getsb(buf, 24);                    // 0.1 mm
4034
0
    int meanYHP = getsb(buf, 25);                    // 0.1 mm
4035
0
    int meanZHP = getsb(buf, 26);                    // 0.1 mm
4036
    // 1 reserved byte
4037
0
    unsigned long meanAcc = getleu32(buf, 28);  // 0.1 mm
4038
0
    unsigned long obs = getleu32(buf, 32);
4039
0
    unsigned valid = getub(buf, 36);
4040
0
    unsigned active = getub(buf, 37);
4041
    // 2 reserved
4042
4043
    // Only version 0 is defined up to ub-blox 9
4044
0
    if (0 != version) {
4045
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4046
0
                 "UBX: NAV-SVIN: unknown version $u %u", version);
4047
0
        return 0;
4048
0
    }
4049
4050
0
    session->driver.ubx.iTOW = iTOW;
4051
0
    meanX = (meanX * 10) + meanXHP;
4052
0
    meanY = (meanY * 10) + meanYHP;
4053
0
    meanZ = (meanZ * 10) + meanZHP;
4054
4055
    // casts for 32 bit compatibility
4056
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4057
0
             "UBX: NAV-SVIN: iTOW %llu dur=%lu meanX=%lld meanY=%lld "
4058
0
             "meanZ=%lld meanAcc=%lu "
4059
0
             "obs=%lu valid=%u(%s) active=%u(%s)\n",
4060
0
             (long long)iTOW, dur, meanX, meanY, meanZ,
4061
0
             meanAcc, obs, valid, val2str(valid, vsvin_valid),
4062
0
             active, val2str(active, vsvin_active));
4063
0
    return mask;
4064
0
}
4065
4066
/**
4067
 * GPS Satellite Info -- deprecated - UBX-NAV-SVINFO
4068
 * Present in:
4069
 *    protver < 27
4070
 * Not present in:
4071
      protver >= 27 (9-series), use UBX-NAV-SAT instead
4072
 */
4073
static gps_mask_t ubx_msg_nav_svinfo(struct gps_device_t *session,
4074
                                     unsigned char *buf, size_t data_len)
4075
0
{
4076
0
    char buf2[80];
4077
0
    unsigned i, nchan;
4078
0
    int seen = 0, used_tot = 0;
4079
0
    unsigned chipGen;
4080
0
    unsigned globalFlags;
4081
0
    timespec_t ts_tow;
4082
    // chipGen to protVer, Antaris 4, u-blox 4, 5, 6, 7 and 8
4083
0
    static unsigned gen2ver[] = {8, 10, 12, 13, 15};
4084
4085
0
    if (8 > data_len) {
4086
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4087
0
                 "UBX: NAV-SVINFO runt datalen %zd\n", data_len);
4088
0
        return 0;
4089
0
    }
4090
4091
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4092
0
    MSTOTS(&ts_tow, session->driver.ubx.iTOW);
4093
0
    session->gpsdata.skyview_time =
4094
0
        gpsd_gpstime_resolv(session, session->context->gps_week, ts_tow);
4095
4096
0
    nchan = getub(buf, 4);
4097
0
    if (nchan > MAXCHANNELS) {
4098
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4099
0
                 "UBX: NAV SVINFO: runt >%d reported visible",
4100
0
                 MAXCHANNELS);
4101
0
        return 0;
4102
0
    }
4103
0
    globalFlags = getub(buf, 5);
4104
0
    chipGen = globalFlags & 0x07;
4105
0
    if (ROWS(gen2ver) > chipGen &&
4106
        // put a floor under protVer
4107
0
        gen2ver[chipGen] > session->driver.ubx.protver) {
4108
0
        session->driver.ubx.protver = gen2ver[chipGen];
4109
0
    }
4110
4111
#ifdef __UNUSED__    // debug
4112
    GPSD_LOG(LOG_SHOUT, &session->context->errout,
4113
             "UBX: NAV-SVINFO: gpsd_zero_satellites()\n");
4114
#endif
4115
0
    gpsd_zero_satellites(&session->gpsdata);
4116
4117
0
    for (i = 0; i < nchan; i++) {
4118
0
        unsigned off = 8 + 12 * i;
4119
0
        short nmea_PRN;
4120
0
        unsigned chan = getub(buf, off);
4121
0
        unsigned ubx_PRN = getub(buf, off + 1);
4122
0
        unsigned flags = getub(buf, off + 2);
4123
0
        unsigned quality = getub(buf, off + 3);
4124
0
        unsigned cno = getub(buf, off + 4);
4125
0
        bool used = (bool)(flags & 0x01);
4126
0
        int el = getsb(buf, off + 5);
4127
0
        int az = getles16(buf, off + 6);
4128
0
        int prRes = getles16(buf, off + 7);
4129
4130
0
        nmea_PRN = ubx_to_prn(ubx_PRN,
4131
0
                              &session->gpsdata.skyview[seen].gnssid,
4132
0
                              &session->gpsdata.skyview[seen].svid);
4133
4134
0
        if (1 > nmea_PRN) {
4135
            // skip bad PRN
4136
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
4137
0
                     "UBX: NAV-SVINFO bad NMEA PRN %d\n", nmea_PRN);
4138
0
            continue;
4139
0
        }
4140
0
        session->gpsdata.skyview[seen].PRN = nmea_PRN;
4141
4142
0
        session->gpsdata.skyview[seen].ss = (double)cno;
4143
0
        if (90 >= abs(el)) {
4144
0
            session->gpsdata.skyview[seen].elevation = (double)el;
4145
0
        }
4146
0
        if (360 > az &&
4147
0
            0 <= az) {
4148
0
            session->gpsdata.skyview[seen].azimuth = (double)az;
4149
0
        }
4150
0
        session->gpsdata.skyview[seen].prRes = prRes / 100.0;
4151
0
        session->gpsdata.skyview[seen].qualityInd = quality;
4152
0
        session->gpsdata.skyview[seen].used = used;
4153
        // sbas_in_use is not same as used
4154
0
        if (used) {
4155
            // not really 'used', just integrity data from there
4156
0
            used_tot++;
4157
0
        }
4158
0
        if (0x10 == (0x10 & flags)) {
4159
0
           session->gpsdata.skyview[seen].health = SAT_HEALTH_BAD;
4160
0
        } else {
4161
0
           session->gpsdata.skyview[seen].health = SAT_HEALTH_OK;
4162
0
        }
4163
4164
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4165
0
                 "UBX: NAV-SVINFO chan %u ubx_prn %d gnssid %d svid %d "
4166
0
                 "nmea_PRN %d flags x%x az %.0f el %.0f cno %.0f prRes %.2f "
4167
0
                 "quality %u\n",
4168
0
                 chan, ubx_PRN,
4169
0
                 session->gpsdata.skyview[seen].gnssid,
4170
0
                 session->gpsdata.skyview[seen].svid, nmea_PRN, flags,
4171
0
                 session->gpsdata.skyview[seen].azimuth,
4172
0
                 session->gpsdata.skyview[seen].elevation,
4173
0
                 session->gpsdata.skyview[seen].ss,
4174
0
                 session->gpsdata.skyview[seen].prRes,
4175
0
                 session->gpsdata.skyview[seen].qualityInd);
4176
0
        GPSD_LOG(LOG_IO, &session->context->errout,
4177
0
                 "UBX: NAV-SVINFO: flags (%s) quality %s\n",
4178
0
                 flags2str(flags, fsvinfo_flags, buf2, sizeof(buf2)),
4179
0
                 val2str(quality, vquality));
4180
4181
0
        seen++;
4182
0
    }
4183
4184
0
    session->gpsdata.satellites_visible = seen;
4185
0
    session->gpsdata.satellites_used = used_tot;
4186
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4187
0
             "UBX: NAV-SVINFO: visible %d used %d mask {SATELLITE|USED} "
4188
0
             "gFlags x%x\n",
4189
0
             session->gpsdata.satellites_visible,
4190
0
             session->gpsdata.satellites_used,
4191
0
             globalFlags);
4192
0
    GPSD_LOG(LOG_IO, &session->context->errout,
4193
0
             "UBX: NAV-SVINFO: chipGen %s\n",
4194
0
             val2str(chipGen, vglobalFlags));
4195
0
    return SATELLITE_SET | USED_IS;
4196
0
}
4197
4198
/**
4199
 * GPS Leap Seconds - UBX-NAV-TIMEGPS
4200
 * Present in:
4201
 *     protVer 8 (Antaris 4)
4202
 *     protVer 27 (F9P)
4203
 *     protVer 34 (M10)
4204
 *
4205
 * Not in:
4206
 *     protVer 24 (NEO-D9S)
4207
 */
4208
static gps_mask_t ubx_msg_nav_timegps(struct gps_device_t *session,
4209
                                      unsigned char *buf, size_t data_len)
4210
0
{
4211
0
    char buf2[80];
4212
0
    uint8_t valid;         // Validity Flags
4213
0
    gps_mask_t mask = 0;
4214
0
    char ts_buf[TIMESPEC_LEN];
4215
4216
0
    if (16 > data_len) {
4217
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4218
0
                 "UBX: NAV-TIMEGPS: runt payload len %zd", data_len);
4219
0
        return 0;
4220
0
    }
4221
4222
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4223
0
    valid = getub(buf, 11);
4224
    // Valid leap seconds ?
4225
0
    if ((valid & UBX_TIMEGPS_VALID_LEAP_SECOND) ==
4226
0
        UBX_TIMEGPS_VALID_LEAP_SECOND) {
4227
0
        session->context->leap_seconds = (int)getub(buf, 10);
4228
0
        session->context->valid |= LEAP_SECOND_VALID;
4229
0
    }
4230
    // Valid GPS time of week and week number
4231
0
#define VALID_TIME (UBX_TIMEGPS_VALID_TIME | UBX_TIMEGPS_VALID_WEEK)
4232
0
    if ((valid & VALID_TIME) == VALID_TIME) {
4233
0
#undef VALID_TIME
4234
0
        uint16_t week;
4235
0
        double tAcc;      // Time Accuracy Estimate in ns
4236
0
        timespec_t ts_tow;
4237
4238
0
        week = getles16(buf, 8);
4239
0
        MSTOTS(&ts_tow, session->driver.ubx.iTOW);
4240
0
        ts_tow.tv_nsec += (long)getles32(buf, 4);
4241
0
        TS_NORM(&ts_tow);
4242
0
        session->newdata.time = gpsd_gpstime_resolv(session, week, ts_tow);
4243
4244
0
        tAcc = (double)getleu32(buf, 12);     // tAcc in ns
4245
0
        session->newdata.ept = tAcc / 1e9;
4246
0
        mask |= (TIME_SET | NTPTIME_IS);
4247
0
    }
4248
4249
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4250
0
             "UBX: NAV-TIMEGPS: time=%s mask={TIME} valid x%x\n",
4251
0
             timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
4252
0
             valid);
4253
0
    GPSD_LOG(LOG_IO, &session->context->errout,
4254
0
             "UBX: NAV-TIMEGPS: valid %s\n",
4255
0
             flags2str(valid, vtimegps_valid, buf2, sizeof(buf2)));
4256
0
    return mask;
4257
0
}
4258
4259
/**
4260
 * Navigation time to leap second: UBX-NAV-TIMELS
4261
 *
4262
 * Sets leap_notify if leap second is < 23 hours away.
4263
 * Present in:
4264
 *     protVer 15 (8-series)
4265
 * Not in:
4266
 *     protVer 12 (5-series)
4267
 *     protVer 13 (6-series)
4268
 *     protVer 14 (6-series / GLONASS, 6-series)
4269
 */
4270
static gps_mask_t ubx_msg_nav_timels(struct gps_device_t *session,
4271
                                     unsigned char *buf, size_t data_len)
4272
0
{
4273
0
    char buf2[80];
4274
0
    unsigned version;
4275
0
    unsigned valid;
4276
0
    int valid_curr_ls;
4277
0
    int valid_time_to_ls_event;
4278
4279
0
#define UBX_TIMELS_VALID_CURR_LS 0x01
4280
0
#define UBX_TIMELS_VALID_TIME_LS_EVT 0x01
4281
4282
0
    if (24 > data_len) {
4283
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4284
0
                 "UBX: NAV-TIMELS: runt %zd, expecting 24\n",
4285
0
                 data_len);
4286
0
        return 0;
4287
0
    }
4288
4289
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4290
0
    version = getub(buf, 4);
4291
    // Only version 0 is defined up to ub-blox 9
4292
0
    if (0 != version) {
4293
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4294
0
                 "UBX: NAV-TIMELS: unknown version $u %u", version);
4295
0
        return 0;
4296
0
    }
4297
0
    valid = getub(buf, 23);
4298
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4299
0
             "UBX: NAV-TIMELS: valid x%x version %d\n", valid, version);
4300
0
    GPSD_LOG(LOG_INF, &session->context->errout,
4301
0
             "UBX: NAV-TIMELS: valid %s\n",
4302
0
             flags2str(valid, vtimels_valid, buf2, sizeof(buf2)));
4303
4304
0
    valid_curr_ls = valid & UBX_TIMELS_VALID_CURR_LS;
4305
0
    valid_time_to_ls_event = valid & UBX_TIMELS_VALID_TIME_LS_EVT;
4306
0
    if (valid_curr_ls) {
4307
0
        unsigned int src_of_curr_ls = getub(buf,8);
4308
0
        int curr_ls = getsb(buf,9);
4309
4310
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4311
0
                 "UBX: NAV-TIMELS: srcOfCurrLs %u(%s) curr_ls %d\n",
4312
0
                 src_of_curr_ls,
4313
0
                 val2str(src_of_curr_ls, vsrcOfCurrLs),
4314
0
                 curr_ls);
4315
0
        session->context->leap_seconds = curr_ls;
4316
0
        session->context->valid |= LEAP_SECOND_VALID;
4317
0
    }  // Valid current leap second
4318
4319
0
    if (valid_time_to_ls_event) {
4320
0
        unsigned int src_of_ls_change;
4321
0
        unsigned short dateOfLSGpsWn, dateOfLSGpsDn;
4322
0
        int lsChange = getsb(buf, 11);
4323
0
        int timeToLsEvent = getles32(buf, 12);
4324
4325
0
        src_of_ls_change = getub(buf,10);
4326
4327
0
        dateOfLSGpsWn = getles16(buf,16);
4328
0
        dateOfLSGpsDn = getles16(buf,18);
4329
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4330
0
                 "UBX: NAV-TIMELS: srcOfCurLsChange %u(%s) lsChange %d "
4331
0
                 "timeToLsEvent %d dateOfLSGpsWn %d dateOfLSGpsDn %d\n",
4332
0
                 src_of_ls_change,
4333
0
                 val2str(src_of_ls_change, vsrcOfLsChange),
4334
0
                 lsChange, timeToLsEvent,
4335
0
                 dateOfLSGpsWn,dateOfLSGpsDn);
4336
4337
0
        if ((0 != lsChange) && (0 < timeToLsEvent) &&
4338
0
            ((60 * 60 * 23) > timeToLsEvent)) {
4339
0
            if (1 == lsChange) {
4340
0
                session->context->leap_notify = LEAP_ADDSECOND;
4341
0
                GPSD_LOG(LOG_WARN, &session->context->errout,
4342
0
                         "UBX: NAV-TIMELS: leap_notify %d "
4343
0
                         "Positive leap second today\n",
4344
0
                         session->context->leap_notify);
4345
0
            } else if (-1 == lsChange) {
4346
0
                session->context->leap_notify = LEAP_DELSECOND;
4347
0
                GPSD_LOG(LOG_WARN, &session->context->errout,
4348
0
                         "UBX: NAV-TIMELS:leap_notify %d "
4349
0
                         " Negative leap second today\n",
4350
0
                         session->context->leap_notify);
4351
0
            }
4352
0
        } else {
4353
0
            session->context->leap_notify = LEAP_NOWARNING;
4354
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
4355
0
                     "UBX: NAV-TIMELS: leap_notify %d, none today\n",
4356
0
                     session->context->leap_notify);
4357
0
        }
4358
0
    }
4359
0
    return 0;
4360
0
}
4361
4362
/**
4363
 * UBX-NAV-TIMEUTC
4364
 */
4365
static gps_mask_t ubx_msg_nav_timeutc(struct gps_device_t *session,
4366
                                      unsigned char *buf, size_t data_len)
4367
0
{
4368
0
    uint8_t valid;         // Validity Flags
4369
0
    gps_mask_t mask = 0;
4370
4371
0
    if (20 > data_len) {
4372
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4373
0
                 "UBX: NAV-TIMEUTC: runt payload len %zd", data_len);
4374
0
        return 0;
4375
0
    }
4376
4377
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4378
0
    valid = getub(buf, 19);
4379
0
    if (4 == (4 & valid)) {
4380
        // UTC is valid
4381
0
        struct tm date = {0};
4382
        // mask |= (TIME_SET | NTPTIME_IS);
4383
0
        uint32_t tAcc = getleu32(buf, 4);          // tAcc in ns
4384
        // nano can be negative, so this is not normalized UTC.
4385
0
        int32_t nano = getles32(buf, 8);           // fract sec in ns
4386
0
        date.tm_year = getleu16(buf, 12) - 1900;   // year, 1999..2099
4387
0
        date.tm_mon = getub(buf, 14) - 1;          // month 1..12
4388
0
        date.tm_mday = getub(buf, 15);             // day 1..31
4389
0
        date.tm_hour = getub(buf, 16);             // hour 0..23
4390
0
        date.tm_min = getub(buf, 17);              // min 0..59
4391
0
        date.tm_sec = getub(buf, 18);              // sec 0..60
4392
0
        session->newdata.time.tv_sec = mkgmtime(&date);
4393
0
        session->newdata.time.tv_nsec = nano;
4394
        // nano, can be negative! So normalize
4395
0
        TS_NORM(&session->newdata.time);
4396
        // other timestamped messages lack nano, so time will jump around...
4397
0
        mask |= TIME_SET | NTPTIME_IS | GOODTIME_IS;
4398
4399
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4400
0
                 "UBX: NAV-TIMEUTC: iTOW=%lld valid=%02x %04d-%02d-%02d "
4401
0
                 "%02d:%02d:%02d.%09d tAcc=%llu time %lld.%09lld\n",
4402
0
                 (long long)session->driver.ubx.iTOW,
4403
0
                 valid, date.tm_year + 1900, date.tm_mon + 1, date.tm_mday,
4404
0
                 date.tm_hour, date.tm_min, date.tm_sec, nano,
4405
0
                 (long long unsigned)tAcc,
4406
0
                 (long long)session->newdata.time.tv_sec,
4407
0
                 (long long)session->newdata.time.tv_nsec);
4408
0
    } else {
4409
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4410
0
                 "UBX: NAV-TIMEUTC: iTOW=%lld valid=%02x\n",
4411
0
                 (long long)session->driver.ubx.iTOW,
4412
0
                 valid);
4413
0
    }
4414
0
    return mask;
4415
0
}
4416
4417
/*
4418
 * Velocity Position ECEF message, UBX-NAV-VELECEF
4419
 */
4420
static gps_mask_t ubx_msg_nav_velecef(struct gps_device_t *session,
4421
                                      unsigned char *buf, size_t data_len)
4422
0
{
4423
0
    gps_mask_t mask = VECEF_SET;
4424
4425
0
    if (20 > data_len) {
4426
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4427
0
                 "UBX: NAV-VELECEF: runt payload len %zd", data_len);
4428
0
        return 0;
4429
0
    }
4430
4431
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4432
0
    session->newdata.ecef.vx = getles32(buf, 4) / 100.0;
4433
0
    session->newdata.ecef.vy = getles32(buf, 8) / 100.0;
4434
0
    session->newdata.ecef.vz = getles32(buf, 12) / 100.0;
4435
0
    session->newdata.ecef.vAcc = getleu32(buf, 16) / 100.0;
4436
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4437
0
        "UBX: NAV-VELECEF: iTOW=%lld ECEF vx=%.2f vy=%.2f vz=%.2f vAcc=%.2f\n",
4438
0
        (long long)session->driver.ubx.iTOW,
4439
0
        session->newdata.ecef.vx,
4440
0
        session->newdata.ecef.vy,
4441
0
        session->newdata.ecef.vz,
4442
0
        session->newdata.ecef.vAcc);
4443
0
    return mask;
4444
0
}
4445
4446
/*
4447
 * Velocity NED message, UBX-NAV-VELNED
4448
 * protocol versions 15+
4449
 */
4450
static gps_mask_t ubx_msg_nav_velned(struct gps_device_t *session,
4451
                                     unsigned char *buf, size_t data_len)
4452
0
{
4453
0
    gps_mask_t mask = VNED_SET;
4454
4455
0
    if (36 > data_len) {
4456
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4457
0
                 "UBX: NAV-VELNED: runt payload len %zd", data_len);
4458
0
        return 0;
4459
0
    }
4460
4461
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4462
0
    session->newdata.NED.velN = getles32(buf, 4) / 100.0;
4463
0
    session->newdata.NED.velE = getles32(buf, 8) / 100.0;
4464
0
    session->newdata.NED.velD = getles32(buf, 12) / 100.0;
4465
    // ignore speed for now
4466
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4467
0
        "UBX: NAV-VELNED: iTOW=%lld NED velN=%.2f velE=%.2f velD=%.2f\n",
4468
0
         (long long)session->driver.ubx.iTOW,
4469
0
        session->newdata.NED.velN,
4470
0
        session->newdata.NED.velE,
4471
0
        session->newdata.NED.velD);
4472
0
    return mask;
4473
0
}
4474
4475
/*
4476
 * Multi-GNSS Raw measurement Data -- UBX-RXM-RAWX
4477
 * Not in u-blox 5, 6 or 7
4478
 * u-blox 9, message version 0 (but no version byte!)
4479
 * u-blox 9, message version 1
4480
 */
4481
static gps_mask_t ubx_msg_rxm_rawx(struct gps_device_t *session,
4482
                                   const unsigned char *buf,
4483
                                   size_t data_len)
4484
0
{
4485
0
    double rcvTow;
4486
0
    uint16_t week;
4487
0
    int8_t leapS;
4488
0
    uint8_t numMeas;
4489
0
    uint8_t recStat;
4490
0
    uint8_t version;
4491
0
    int i;
4492
0
    const char * obs_code;
4493
0
    timespec_t ts_tow;
4494
4495
0
    if (16 > data_len) {
4496
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4497
0
                 "UBX: RXM-RAWX: runt payload len %zd", data_len);
4498
0
        return 0;
4499
0
    }
4500
4501
    // Note: this is "approximately" GPS TOW, this is not iTOW
4502
0
    rcvTow = getled64((const char *)buf, 0);   // time of week in seconds
4503
0
    week = getleu16(buf, 8);
4504
0
    leapS = getsb(buf, 10);
4505
0
    numMeas = getub(buf, 11);
4506
0
    recStat = getub(buf, 12);
4507
    /* byte 13 is version on u-blox 9, reserved on u-blox 8
4508
     * how is that supposed to work?? */
4509
0
    version = getub(buf, 13);
4510
4511
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4512
0
             "UBX: RXM-RAWX: rcvTow %f week %u leapS %d numMeas %u recStat %d"
4513
0
             " version %u\n",
4514
0
             rcvTow, week, leapS, numMeas, recStat, version);
4515
4516
0
    if (recStat & 1) {
4517
        // Valid leap seconds
4518
0
        session->context->leap_seconds = leapS;
4519
0
        session->context->valid |= LEAP_SECOND_VALID;
4520
0
    }
4521
    // RINEX 3 wants GPS time, not UTC time, do not add leap seconds.
4522
0
    DTOTS(&ts_tow, rcvTow);
4523
    // Do not set newdata.time.  set gpsdata.raw.mtime
4524
    // RINEX 3 "GPS time", not UTC, no leap seconds
4525
0
    session->gpsdata.raw.mtime = gpsd_gpstime(session, week, ts_tow);
4526
4527
    /* zero the measurement data
4528
     * so we can tell which meas never got set */
4529
0
    memset(session->gpsdata.raw.meas, 0, sizeof(session->gpsdata.raw.meas));
4530
4531
0
    if (numMeas > MAXCHANNELS) {
4532
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4533
0
                 "UBX: RXM-RAWX: too many measurements (%u)",
4534
0
                 numMeas);
4535
0
        return 0;
4536
0
    }
4537
0
    for (i = 0; i < numMeas; i++) {
4538
0
        int off = 32 * i;
4539
        // pseudorange in meters
4540
0
        double prMes = getled64((const char *)buf, off + 16);
4541
        // carrier phase in cycles
4542
0
        double cpMes = getled64((const char *)buf, off + 24);
4543
        // doppler in Hz, positive towards sat
4544
0
        double doMes = getlef32((const char *)buf, off + 32);
4545
0
        uint8_t gnssId = getub(buf, off + 36);
4546
0
        uint8_t svId = getub(buf, off + 37);
4547
        // reserved in u-blox 8, sigId in u-blox 9 (version 1)
4548
0
        uint8_t sigId = getub(buf, off + 38);
4549
        // GLONASS frequency slot
4550
0
        uint8_t freqId = getub(buf, off + 39);
4551
        // carrier phase locktime in ms, max 64500ms
4552
0
        uint16_t locktime = getleu16(buf, off + 40);
4553
        // carrier-to-noise density ratio dB-Hz
4554
0
        uint8_t cno = getub(buf, off + 42);
4555
0
        uint8_t prStdev = getub(buf, off + 43) & 0x0f;
4556
0
        uint8_t cpStdev = getub(buf, off + 44) & 0x0f;
4557
0
        uint8_t doStdev = getub(buf, off + 45) & 0x0f;
4558
        /* tracking stat
4559
         * bit 0 - prMes valid
4560
         * bit 1 - cpMes valid
4561
         * bit 2 - halfCycle valid
4562
         * bit 3 - halfCycle subtracted from phase
4563
         */
4564
0
        uint8_t trkStat = getub(buf, off + 46);
4565
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
4566
0
                 "UBX: RXM-RAWX: %u:%u:%u freqId %u prMes %f cpMes %f "
4567
0
                 "doMes %f locktime %u\n"
4568
0
                 "cno %u prStdev %u cpStdev %u doStdev %u rtkStat %u\n",
4569
0
                 gnssId, svId, sigId, freqId, prMes, cpMes, doMes, locktime,
4570
0
                 cno, prStdev, cpStdev, doStdev, trkStat);
4571
4572
0
        session->gpsdata.raw.meas[i].gnssid = gnssId;
4573
0
        session->gpsdata.raw.meas[i].sigid = sigId;
4574
4575
        /* some of these are GUESSES as the u-blox codes do not
4576
         * match RINEX codes */
4577
0
        obs_code = sigid2obs(gnssId, sigId);
4578
4579
0
        (void)strlcpy(session->gpsdata.raw.meas[i].obs_code, obs_code,
4580
0
                      sizeof(session->gpsdata.raw.meas[i].obs_code));
4581
4582
0
        session->gpsdata.raw.meas[i].svid = svId;
4583
0
        session->gpsdata.raw.meas[i].freqid = freqId;
4584
0
        session->gpsdata.raw.meas[i].snr = cno;
4585
0
        session->gpsdata.raw.meas[i].satstat = trkStat;
4586
0
        if (trkStat & 1) {
4587
            // prMes valid
4588
0
            session->gpsdata.raw.meas[i].pseudorange = prMes;
4589
0
        } else {
4590
0
            session->gpsdata.raw.meas[i].pseudorange = NAN;
4591
0
        }
4592
0
        if ((trkStat & 2) && (5 >= cpStdev)) {
4593
            // cpMes valid, RTKLIB uses 5 < cpStdev
4594
0
            session->gpsdata.raw.meas[i].carrierphase = cpMes;
4595
0
        } else {
4596
0
            session->gpsdata.raw.meas[i].carrierphase = NAN;
4597
0
        }
4598
0
        session->gpsdata.raw.meas[i].doppler = doMes;
4599
0
        session->gpsdata.raw.meas[i].codephase = NAN;
4600
0
        session->gpsdata.raw.meas[i].deltarange = NAN;
4601
0
        session->gpsdata.raw.meas[i].locktime = locktime;
4602
0
        if (0 == locktime) {
4603
            // possible slip
4604
0
            session->gpsdata.raw.meas[i].lli = 2;
4605
0
        }
4606
0
    }
4607
4608
0
    return RAW_IS;
4609
0
}
4610
4611
/*
4612
 * Raw Subframes - UBX-RXM-SFRB
4613
 * In u-blox 7, only in raw firmware option
4614
 * Not in u-blox 8 or 9
4615
 */
4616
static gps_mask_t ubx_msg_rxm_sfrb(struct gps_device_t *session,
4617
                                   unsigned char *buf, size_t data_len)
4618
0
{
4619
0
    unsigned int i, chan, svid;
4620
0
    uint32_t words[10];
4621
4622
0
    if (42 > data_len) {
4623
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4624
0
                 "UBX: RXM-SFRB: runt payload len %zd", data_len);
4625
0
        return 0;
4626
0
    }
4627
4628
0
    chan = (unsigned int)getub(buf, 0);
4629
0
    svid = (unsigned int)getub(buf, 1);
4630
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4631
0
             "UBX: RXM-SFRB: %u %u\n", chan, svid);
4632
4633
    // UBX does all the parity checking, but still bad data gets through
4634
0
    for (i = 0; i < 10; i++) {
4635
        // bits 24 to 31 undefined, remove them.
4636
0
        words[i] = (uint32_t)getleu32(buf, 4 * i + 2) & 0x00ffffff;
4637
0
    }
4638
4639
    // probably GPS, could be SBAS
4640
0
    return gpsd_interpret_subframe(session, GNSSID_GPS, svid, words);
4641
0
}
4642
4643
/*
4644
 * Raw Subframes - UBX-RXM-SFRBX
4645
 * in u-blox 8, protver 17 and up, time sync firmware only
4646
 * in u-blox F9P and HPG only
4647
 * in u-blox F10N, protVer 27 and up
4648
 * not present  before u-blox8
4649
 */
4650
static gps_mask_t ubx_msg_rxm_sfrbx(struct gps_device_t *session,
4651
                                    unsigned char *buf, size_t data_len)
4652
0
{
4653
0
    unsigned i;
4654
0
    uint32_t words[17];
4655
0
    char *chn_s;
4656
4657
0
    unsigned gnssId = getub(buf, 0);
4658
0
    unsigned svId = getub(buf, 1);
4659
    // reserved in Version 1, and some Version2.  Valid in protVer 27.31 and up
4660
0
    unsigned sigId = getub(buf, 2);
4661
0
    unsigned freqId = getub(buf, 3);
4662
0
    unsigned numWords = getub(buf, 4);
4663
0
    unsigned chn = getub(buf, 5);
4664
0
    unsigned version = getub(buf, 6);
4665
4666
0
    if (1 < version) {
4667
        // receiver channel in version 2 and up.
4668
        // valid range 0 to 13?
4669
0
        chn_s = "chn";
4670
0
    } else {
4671
0
        chn_s = "reserved";
4672
0
    }
4673
4674
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4675
0
             "UBX: RXM-SFRBX: version %u gnssId %u %s %u svId %u "
4676
0
             "sigId %u freqId %u words %u\n",
4677
0
             version, gnssId, chn_s, chn, svId, sigId, freqId, numWords);
4678
0
    GPSD_LOG(LOG_IO, &session->context->errout,
4679
0
             "UBX: RXM-SFRBX:   %s\n",
4680
0
             val2str((gnssId << 8) | sigId, vgnss_sig_ids));
4681
4682
0
    if (!IN(1, version, 2)) {
4683
        // unknown ersion
4684
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4685
0
                 "UBX: RXM-SFRBX: unknown version %u", version);
4686
0
        return 0;
4687
0
    }
4688
0
    if (data_len != (size_t)(8 + (4 * numWords)) ||
4689
0
        16 < numWords) {
4690
        // test numwords directly to shut up Coverity
4691
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4692
0
                 "UBX: RXM-SFRBX: wrong payload len %zd, numwords %u "
4693
0
                 "s/b %u",
4694
0
                 data_len, 8 + (4 * numWords), numWords);
4695
0
        return 0;
4696
0
    }
4697
4698
0
    memset(words, 0, sizeof(words));
4699
0
    for (i = 0; i < numWords; i++) {
4700
        // grab the words, don't mangle them
4701
0
        words[i] = (uint32_t)getleu32(buf, 4 * i + 8);
4702
0
    }
4703
4704
    // do we need freqId or chn?
4705
0
    return gpsd_interpret_subframe_raw(session, gnssId, sigId,
4706
0
                                       svId, words, numWords);
4707
0
}
4708
4709
/**
4710
 * SV Status Info
4711
 *
4712
 * May be good cycle ender
4713
 *
4714
 * Present in u-blox 7
4715
 */
4716
static gps_mask_t ubx_msg_rxm_svsi(struct gps_device_t *session,
4717
                                   unsigned char *buf, size_t data_len)
4718
0
{
4719
0
    unsigned numVis, numSV;
4720
4721
0
    if (8 > data_len) {
4722
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4723
0
                 "UBX: RXM-SVSI: runt payload len %zd", data_len);
4724
0
        return 0;
4725
0
    }
4726
4727
0
    session->driver.ubx.iTOW = getleu32(buf, 0);
4728
0
    session->context->gps_week = getleu16(buf, 4);
4729
0
    numVis = getub(buf, 6);
4730
0
    numSV = getub(buf, 7);
4731
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4732
0
             "UBX: RXM-SVSI: iTOW=%lld week %d numVis %u numSV %u\n",
4733
0
             (long long)session->driver.ubx.iTOW,
4734
0
            session->context->gps_week, numVis, numSV);
4735
0
    return 0;
4736
0
}
4737
4738
/**
4739
 * Unique chip ID
4740
 * UBX-SEC-UNIQID
4741
 *
4742
 * grab the 5 byte serial number / chip id
4743
 */
4744
static gps_mask_t ubx_msg_sec_uniqid(struct gps_device_t *session,
4745
                                     unsigned char *buf,
4746
                                     size_t data_len)
4747
0
{
4748
0
    unsigned version;
4749
4750
0
    if (9 > data_len) {
4751
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4752
0
                 "UBX: SEC-UNIQID: runt payload len %zd\n", data_len);
4753
0
        return 0;
4754
0
    }
4755
4756
0
    version = getub(buf, 0);
4757
0
    switch (version) {
4758
0
    case 1:
4759
        /* string of length 10 bytes
4760
         * PROTVER 18 -> 23 has five bytes of unique id.
4761
         * F10 is PROTVER 34, still has 5 bytes */
4762
0
        (void)snprintf(session->gpsdata.dev.sernum,
4763
0
                       sizeof(session->gpsdata.dev.sernum),
4764
0
                       "%02x%02x%02x%02x%02x",
4765
0
                       getub(buf, 4),
4766
0
                       getub(buf, 5),
4767
0
                       getub(buf, 6),
4768
0
                       getub(buf, 7),
4769
0
                       getub(buf, 8));
4770
0
        break;
4771
0
    case 2:
4772
        /* string of length 12 bytes
4773
         * some PROTVER 34 and beyond (for now) have six bytes of unique id.
4774
         * Such as MAX-M10S. */
4775
0
        (void)snprintf(session->gpsdata.dev.sernum,
4776
0
                       sizeof(session->gpsdata.dev.sernum),
4777
0
                       "%02x%02x%02x%02x%02x%02x",
4778
0
                       getub(buf, 4),
4779
0
                       getub(buf, 5),
4780
0
                       getub(buf, 6),
4781
0
                       getub(buf, 7),
4782
0
                       getub(buf, 8),
4783
0
                       getub(buf, 9));
4784
0
        break;
4785
0
    default:
4786
        // unknown version
4787
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4788
0
                 "UBX: SEC-UNIQID bad version\n");
4789
0
        return 0;
4790
0
    }
4791
4792
    // output chip id at LOG_INF
4793
0
    GPSD_LOG(LOG_INF, &session->context->errout,
4794
0
             "UBX: SEC-UNIQID: %s\n",
4795
0
             session->gpsdata.dev.sernum);
4796
0
    return 0;
4797
0
}
4798
4799
/**
4800
 * Survey-in data - UBX-TIM-SVIN
4801
 * Time Sync products only
4802
 */
4803
static gps_mask_t ubx_msg_tim_svin(struct gps_device_t *session,
4804
                                   unsigned char *buf, size_t data_len UNUSED)
4805
0
{
4806
0
    gps_mask_t mask = ONLINE_SET;
4807
0
    unsigned long dur = getleu32(buf, 0);
4808
0
    long meanX = getles32(buf, 4);
4809
0
    long meanY = getles32(buf, 8);
4810
0
    long meanZ = getles32(buf, 12);
4811
0
    unsigned long meanV = getleu32(buf, 16);
4812
0
    unsigned long obs = getleu32(buf, 20);
4813
0
    unsigned valid = getub(buf, 24);
4814
0
    unsigned active = getub(buf, 25);
4815
    // two reserved bytes
4816
4817
    // casts for 32 bit compatibility
4818
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4819
0
             "UBX: TIM-SVIN: dur=%lu meanX=%ld meanY=%ld meanZ=%ld meanV=%lu "
4820
0
             "obs=%lu valid=%u(%s) active=%u(%s)\n",
4821
0
             dur, meanX, meanY, meanZ, meanV, obs,
4822
0
             valid, val2str(valid, vsvin_valid),
4823
0
             active, val2str(active, vsvin_active));
4824
0
    return mask;
4825
0
}
4826
4827
/**
4828
 * Time Pulse Timedata - UBX-TIM-TP
4829
 */
4830
static gps_mask_t ubx_msg_tim_tp(struct gps_device_t *session,
4831
                                 unsigned char *buf, size_t data_len)
4832
0
{
4833
0
    gps_mask_t mask = ONLINE_SET;
4834
0
    uint32_t towMS;
4835
0
    uint32_t towSubMS;
4836
0
    uint64_t tow_tmp;    // temp to convert towSubMS to nano seconds.
4837
0
    int32_t qErr;
4838
0
    uint16_t week;
4839
0
    uint8_t flags;
4840
0
    uint8_t refInfo;
4841
0
    timespec_t ts_tow;
4842
0
    char buf2[80];
4843
0
    char buf3[80];
4844
0
    const char *warn_msg = "";
4845
4846
0
    static const struct flist_t tim_tp_flags[] = {
4847
0
        {0, 1, "timebase:GNSS"},
4848
0
        {1, 1, "timebase:UTC"},
4849
0
        {0, 2, "UTC:NA"},
4850
0
        {2, 2, "UTC:OK"},
4851
0
        {0, 0x0c, "RAIM:NA"},
4852
0
        {4, 0x0c, "RAIM:inactive"},
4853
0
        {8, 0x0c, "RAIM:active"},
4854
0
        {0x0c, 0x0c, "RAIM:Unk"},
4855
        // qErrValid  9-series, protVer 32 and up.
4856
0
        {0, 0x10, "qErr:Valid"},
4857
0
        {0x10, 0x10, "qErr:Invalid"},
4858
        // TpNotLocked, 9-series, protVer 32 and up.
4859
0
        {0, 0x20, "TP:Locked"},
4860
0
        {0x20, 0x20, "TP:Unlocked"},
4861
0
        {0, 0, NULL},
4862
0
    };
4863
4864
0
    static const struct flist_t tim_tp_refInfo[] = {
4865
0
        {0, 0x0f, "GNSS:GPS"},
4866
0
        {1, 0x0f, "GNSS:GLONASS"},
4867
0
        {2, 0x0f, "GNSS:BeiDou"},
4868
0
        {3, 0x0f, "GNSS:Galileo"},
4869
0
        {4, 0x0f, "GNSS:NavIc"},
4870
0
        {5, 0x0f, "GNSS:Unk5"},
4871
0
        {6, 0x0f, "GNSS:Unk6"},
4872
0
        {7, 0x0f, "GNSS:Unk7"},
4873
0
        {8, 0x0f, "GNSS:Unk8"},
4874
0
        {9, 0x0f, "GNSS:Unk9"},
4875
0
        {10, 0x0f, "GNSS:Unk10"},
4876
0
        {11, 0x0f, "GNSS:Unk11"},
4877
0
        {12, 0x0f, "GNSS:Unk12"},
4878
0
        {13, 0x0f, "GNSS:Unk13"},
4879
0
        {14, 0x0f, "GNSS:Unk14"},
4880
0
        {15, 0x0f, "GNSS:Unk"},
4881
0
        {0x00, 0xf0, "UTC:Unk"},
4882
0
        {0x10, 0xf0, "UTC:CRL"},
4883
0
        {0x20, 0xf0, "UTC:NIST"},
4884
0
        {0x30, 0xf0, "UTC:USNO"},
4885
0
        {0x40, 0xf0, "UTC:BIPM"},
4886
0
        {0x50, 0xf0, "UTC:EL"},
4887
0
        {0x60, 0xf0, "UTC:SU"},
4888
0
        {0x70, 0xf0, "UTC:NTSC"},
4889
0
        {0x80, 0xf0, "UTC:NPLI"},
4890
0
        {0x90, 0xf0, "UTC:Unk9"},
4891
0
        {0xa0, 0xf0, "UTC:Unk10"},
4892
0
        {0xb0, 0xf0, "UTC:Unk11"},
4893
0
        {0xc0, 0xf0, "UTC:Unk12"},
4894
0
        {0xd0, 0xf0, "UTC:Unk13"},
4895
0
        {0xe0, 0xf0, "UTC:Unk14"},
4896
0
        {0xf0, 0xf0, "UTC:Unk"},
4897
0
        {0, 0, NULL},
4898
0
    };
4899
4900
0
    if (16 > data_len) {
4901
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
4902
0
                 "UBX: TIM-TP: runt payload len %zd", data_len);
4903
0
        return 0;
4904
0
    }
4905
4906
0
    towMS = getleu32(buf, 0);
4907
    /* towSubMS is usually zero, but have seen 128, and 4294967168.
4908
     * towSubMs == 1 is 233 femto seconds!
4909
     * towSubMS == 128 is 29.802 pico seconds!
4910
     * towSubMS == 4294967168 is 0.9999999701976775 milli seconds
4911
     */
4912
0
    towSubMS = getleu32(buf, 4);
4913
0
    qErr = getles32(buf, 8);
4914
0
    week = getleu16(buf, 12);
4915
0
    flags = buf[14];
4916
0
    refInfo = buf[15];
4917
4918
0
    MSTOTS(&ts_tow, towMS);
4919
    /* scale towSubMS to nano seconds, add in 500 pico seconds for rounding
4920
     * then remove the u-blox scaling. */
4921
0
    tow_tmp = (((uint64_t)towSubMS * 1000000UL) + 500000UL) >> 32;
4922
0
    ts_tow.tv_nsec += tow_tmp;
4923
0
    TS_NORM(&ts_tow);       // can happen on rounding 0.999999999 to 1.0
4924
4925
    // check that it is close to top of second??
4926
0
    if (3 != (flags & 0x03)) {
4927
0
        warn_msg = " Not locked to UTC";
4928
0
    } else {
4929
        // are we UTC, and towSubMs is zer
4930
4931
        // leap already added!?!?
4932
0
        int saved_leap = session->context->leap_seconds;
4933
        // remove it!
4934
0
        session->context->leap_seconds = 0;
4935
4936
        // good, save qErr and qErr_time
4937
0
        session->gpsdata.qErr = qErr;
4938
        // FIXME?  save as ftow??
4939
0
        session->gpsdata.qErr_time = gpsd_gpstime_resolv(session, week, ts_tow);
4940
4941
        // restore leap
4942
0
        session->context->leap_seconds = saved_leap;
4943
0
    }
4944
4945
    // casts for 32 bit compatibility
4946
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
4947
0
             "UBX: TIM-TP: towMS %lu, towSubMS %ld, qErr %ld week %u "
4948
0
             "flags x%02x, refInfo x%02x\n",
4949
0
             (unsigned long)towMS, (long)towSubMS, (long)qErr,
4950
0
              week, flags, refInfo);
4951
0
    GPSD_LOG(LOG_IO, &session->context->errout,
4952
0
             "UBX: TIM-TP: flags (%s) refInfo (%s) tos_tmp %llu %s\n",
4953
0
             flags2str(flags, tim_tp_flags, buf2, sizeof(buf2)),
4954
0
             flags2str(refInfo, tim_tp_refInfo, buf3, sizeof(buf3)),
4955
0
             (long long unsigned)tow_tmp, warn_msg);
4956
4957
0
    return mask;
4958
0
}
4959
4960
static gps_mask_t ubx_parse(struct gps_device_t * session, unsigned char *buf,
4961
                            size_t len)
4962
0
{
4963
0
    size_t data_len;
4964
0
    unsigned short msgid;
4965
0
    gps_mask_t mask = 0;
4966
0
    unsigned char min_protver = 0;
4967
4968
    // the packet at least contains a head long enough for an empty message
4969
0
    if (UBX_PREFIX_LEN > len) {
4970
0
        return 0;
4971
0
    }
4972
4973
0
    session->cycle_end_reliable = true;
4974
0
    session->driver.ubx.iTOW = -1;        // set by decoder
4975
4976
    // extract message id and length
4977
0
    msgid = getbes16(buf, 2);
4978
0
    data_len = (size_t) getles16(buf, 4);
4979
4980
    /* FIXME: make each case just call one function.
4981
     / then this switch can be turned into a table. */
4982
0
    switch (msgid) {
4983
0
    case UBX_ACK_ACK:
4984
0
        FALLTHROUGH
4985
0
    case UBX_ACK_NAK:
4986
0
        mask = ubx_msg_ack(session, buf, data_len);
4987
0
        break;
4988
4989
    /* UBX-AID-*
4990
     * removed in protVer 32 */
4991
0
    case UBX_CFG_DOSC:
4992
0
        mask = ubx_msg_cfg_dosc(session, &buf[UBX_PREFIX_LEN], data_len);
4993
0
        break;
4994
0
    case UBX_CFG_ESRC:
4995
0
        mask = ubx_msg_cfg_esrc(session, &buf[UBX_PREFIX_LEN], data_len);
4996
0
        break;
4997
0
    case UBX_CFG_NAV5:
4998
        // deprecated in u-blox 10
4999
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: CFG-NAV5\n");
5000
0
        break;
5001
0
    case UBX_CFG_NAVX5:
5002
        // deprecated in u-blox 10
5003
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: CFG-NAVX5\n");
5004
0
        break;
5005
0
    case UBX_CFG_PRT:
5006
        // deprecated in u-blox 10
5007
0
        if (session->driver.ubx.port_id != buf[UBX_PREFIX_LEN + 0] ) {
5008
0
            session->driver.ubx.port_id = buf[UBX_PREFIX_LEN + 0];
5009
0
            GPSD_LOG(LOG_INF, &session->context->errout,
5010
0
                     "UBX: CFG-PRT: port %d\n", session->driver.ubx.port_id);
5011
0
        }
5012
0
        break;
5013
0
    case UBX_CFG_RATE:
5014
        // deprecated in u-blox 10
5015
0
        mask = ubx_msg_cfg_rate(session, &buf[UBX_PREFIX_LEN], data_len);
5016
0
        break;
5017
0
    case UBX_CFG_VALGET:
5018
0
        min_protver = 24;
5019
0
        mask = ubx_msg_cfg_valget(session, &buf[UBX_PREFIX_LEN], data_len);
5020
0
        break;
5021
5022
0
    case UBX_ESF_ALG:
5023
0
        mask = ubx_msg_esf_alg(session, &buf[UBX_PREFIX_LEN], data_len);
5024
0
        break;
5025
0
    case UBX_ESF_INS:
5026
0
        mask = ubx_msg_esf_ins(session, &buf[UBX_PREFIX_LEN], data_len);
5027
0
        break;
5028
0
    case UBX_ESF_MEAS:
5029
0
        mask = ubx_msg_esf_meas(session, &buf[UBX_PREFIX_LEN], data_len);
5030
0
        break;
5031
0
    case UBX_ESF_RAW:
5032
0
        mask = ubx_msg_esf_raw(session, &buf[UBX_PREFIX_LEN], data_len);
5033
0
        break;
5034
0
    case UBX_ESF_STATUS:
5035
0
        mask = ubx_msg_esf_status(session, &buf[UBX_PREFIX_LEN], data_len);
5036
0
        break;
5037
5038
0
    case UBX_HNR_ATT:
5039
0
        min_protver = 19;       // actually 19.2
5040
0
        mask = ubx_msg_hnr_att(session, &buf[UBX_PREFIX_LEN], data_len);
5041
0
        break;
5042
0
    case UBX_HNR_INS:
5043
0
        min_protver = 19;       // actually 19.1
5044
0
        mask = ubx_msg_hnr_ins(session, &buf[UBX_PREFIX_LEN], data_len);
5045
0
        break;
5046
0
    case UBX_HNR_PVT:
5047
0
        min_protver = 19;
5048
0
        mask = ubx_msg_hnr_pvt(session, &buf[UBX_PREFIX_LEN], data_len);
5049
0
        break;
5050
5051
0
    case UBX_INF_DEBUG:
5052
0
        FALLTHROUGH
5053
0
    case UBX_INF_ERROR:
5054
0
        FALLTHROUGH
5055
0
    case UBX_INF_NOTICE:
5056
0
        FALLTHROUGH
5057
0
    case UBX_INF_TEST:
5058
0
        FALLTHROUGH
5059
0
    case UBX_INF_USER:
5060
0
        FALLTHROUGH
5061
0
    case UBX_INF_WARNING:
5062
0
        min_protver = 13;
5063
0
        mask = ubx_msg_inf(session, buf, data_len);
5064
0
        break;
5065
5066
0
    case UBX_LOG_BATCH:
5067
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: LOG-BATCH\n");
5068
0
        mask = ubx_msg_log_batch(session, &buf[UBX_PREFIX_LEN], data_len);
5069
0
        break;
5070
0
    case UBX_LOG_INFO:
5071
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: LOG-INFO\n");
5072
0
        mask = ubx_msg_log_info(session, &buf[UBX_PREFIX_LEN], data_len);
5073
0
        break;
5074
0
    case UBX_LOG_RETRIEVEPOS:
5075
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: LOG-RETRIEVEPOS\n");
5076
0
        mask = ubx_msg_log_retrievepos(session, &buf[UBX_PREFIX_LEN], data_len);
5077
0
        break;
5078
0
    case UBX_LOG_RETRIEVEPOSEXTRA:
5079
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
5080
0
                 "UBX: LOG-RETRIEVEPOSEXTRA\n");
5081
0
        mask = ubx_msg_log_retrieveposextra(session, &buf[UBX_PREFIX_LEN],
5082
0
                                            data_len);
5083
0
        break;
5084
0
    case UBX_LOG_RETRIEVESTRING:
5085
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
5086
0
                 "UBX: LOG-RETRIEVESTRING\n");
5087
0
        mask = ubx_msg_log_retrievestring(session, &buf[UBX_PREFIX_LEN],
5088
0
                                          data_len);
5089
0
        break;
5090
5091
0
    case UBX_MON_BATCH:
5092
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-BATCH\n");
5093
0
        break;
5094
0
    case UBX_MON_COMMS:
5095
0
        mask = ubx_msg_mon_comms(session, &buf[UBX_PREFIX_LEN], data_len);
5096
0
        break;
5097
0
    case UBX_MON_EXCEPT:
5098
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-EXCEPT\n");
5099
0
        break;
5100
0
    case UBX_MON_GNSS:
5101
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-GNSS\n");
5102
0
        break;
5103
0
    case UBX_MON_HW:
5104
0
        min_protver = 12;
5105
0
        mask = ubx_msg_mon_hw(session, &buf[UBX_PREFIX_LEN], data_len);
5106
0
        break;
5107
0
    case UBX_MON_HW2:
5108
         // Deprecated in protVer 32 (9-series, 10-series)
5109
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-HW2\n");
5110
0
        break;
5111
0
    case UBX_MON_HW3:
5112
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-HW3\n");
5113
0
        break;
5114
0
    case UBX_MON_IO:
5115
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-IO\n");
5116
0
        break;
5117
0
    case UBX_MON_IPC:
5118
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-IPC\n");
5119
0
        break;
5120
0
    case UBX_MON_MSGPP:
5121
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-MSGPP\n");
5122
0
        break;
5123
0
    case UBX_MON_PATCH:
5124
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-PATCH\n");
5125
0
        break;
5126
0
    case UBX_MON_RF:
5127
0
        mask = ubx_msg_mon_rf(session, &buf[UBX_PREFIX_LEN], data_len);
5128
0
        break;
5129
0
    case UBX_MON_RXBUF:
5130
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-RXBUF\n");
5131
0
        mask = ubx_msg_mon_rxbuf(session, &buf[UBX_PREFIX_LEN], data_len);
5132
0
        break;
5133
0
    case UBX_MON_RXR:
5134
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-RXR\n");
5135
0
        break;
5136
0
    case UBX_MON_SCHED:
5137
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-SCHED\n");
5138
0
        break;
5139
0
    case UBX_MON_SMGR:
5140
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-SMGR\n");
5141
0
        break;
5142
0
    case UBX_MON_SPAN:
5143
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-SPAN\n");
5144
0
        break;
5145
0
    case UBX_MON_TXBUF:
5146
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-TXBUF\n");
5147
0
        mask = ubx_msg_mon_txbuf(session, &buf[UBX_PREFIX_LEN], data_len);
5148
0
        break;
5149
0
    case UBX_MON_USB:
5150
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MON-USB\n");
5151
0
        break;
5152
0
    case UBX_MON_VER:
5153
0
        mask = ubx_msg_mon_ver(session, &buf[UBX_PREFIX_LEN], data_len);
5154
0
        break;
5155
5156
0
    case UBX_NAV_AOPSTATUS:
5157
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-AOPSTATUS\n");
5158
0
        break;
5159
0
    case UBX_NAV_ATT:
5160
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-ATT\n");
5161
0
        break;
5162
0
    case UBX_NAV_CLOCK:
5163
0
        mask = ubx_msg_nav_clock(session, &buf[UBX_PREFIX_LEN], data_len);
5164
0
        break;
5165
0
    case UBX_NAV_DGPS:
5166
0
        mask = ubx_msg_nav_dgps(session, &buf[UBX_PREFIX_LEN], data_len);
5167
0
        break;
5168
0
    case UBX_NAV_DOP:
5169
        // DOP seems to be the last NAV sent in a cycle, unless NAV-EOE
5170
0
        mask = ubx_msg_nav_dop(session, &buf[UBX_PREFIX_LEN], data_len);
5171
0
        break;
5172
0
    case UBX_NAV_EELL:
5173
0
        min_protver = 18;
5174
0
        mask = ubx_msg_nav_eell(session, &buf[UBX_PREFIX_LEN], data_len);
5175
0
        break;
5176
0
    case UBX_NAV_EKFSTATUS:
5177
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-EKFSTATUS\n");
5178
0
        break;
5179
0
    case UBX_NAV_EOE:
5180
0
        min_protver = 18;
5181
0
        mask = ubx_msg_nav_eoe(session, &buf[UBX_PREFIX_LEN], data_len);
5182
0
        break;
5183
0
    case UBX_NAV_GEOFENCE:
5184
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-GEOFENCE\n");
5185
0
        break;
5186
0
    case UBX_NAV_HPPOSECEF:
5187
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-HPPOSECEF\n");
5188
0
        if (28 > data_len) {
5189
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5190
0
                     "UBX: NAV-HPPOSECEF: runt payload len %zd", data_len);
5191
0
        } else {
5192
0
            mask = ubx_msg_nav_hpposecef(session, &buf[UBX_PREFIX_LEN],
5193
0
                                         data_len);
5194
0
        }
5195
0
        break;
5196
0
    case UBX_NAV_HPPOSLLH:
5197
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-HPPOSLLH\n");
5198
0
        mask = ubx_msg_nav_hpposllh(session, &buf[UBX_PREFIX_LEN], data_len);
5199
0
        break;
5200
0
    case UBX_NAV_ODO:
5201
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-ODO\n");
5202
0
        break;
5203
0
    case UBX_NAV_ORB:
5204
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-ORB\n");
5205
0
        break;
5206
0
    case UBX_NAV_POSECEF:
5207
0
        mask = ubx_msg_nav_posecef(session, &buf[UBX_PREFIX_LEN], data_len);
5208
0
        break;
5209
0
    case UBX_NAV_POSLLH:
5210
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-POSLLH\n");
5211
0
        mask = ubx_msg_nav_posllh(session, &buf[UBX_PREFIX_LEN], data_len);
5212
0
        break;
5213
0
    case UBX_NAV_POSUTM:
5214
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-POSUTM\n");
5215
0
        break;
5216
0
    case UBX_NAV_PVAT:
5217
0
        min_protver = 30;
5218
0
        if (116 > data_len) {
5219
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5220
0
                     "UBX: NAV-PVAT: runt payload len %zd", data_len);
5221
0
        } else {
5222
0
            mask = ubx_msg_nav_pvat(session, &buf[UBX_PREFIX_LEN], data_len);
5223
0
        }
5224
0
        break;
5225
0
    case UBX_NAV_PVT:
5226
0
        min_protver = 14;
5227
        // u-blox 6 and 7 are 84 bytes, u-blox 8 and 9 are 92 bytes
5228
0
        if (84 > data_len) {
5229
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5230
0
                     "UBX: NAV-PVT: runt payload len %zd", data_len);
5231
0
        } else {
5232
0
            mask = ubx_msg_nav_pvt(session, &buf[UBX_PREFIX_LEN], data_len);
5233
0
        }
5234
0
        break;
5235
0
    case UBX_NAV_RELPOSNED:
5236
0
        min_protver = 20;
5237
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-RELPOSNED\n");
5238
0
        mask = ubx_msg_nav_relposned(session, &buf[UBX_PREFIX_LEN], data_len);
5239
0
        break;
5240
0
    case UBX_NAV_RESETODO:
5241
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-RESETODO\n");
5242
0
        break;
5243
0
    case UBX_NAV_SAT:
5244
0
        min_protver = 15;
5245
0
        mask = ubx_msg_nav_sat(session, &buf[UBX_PREFIX_LEN], data_len);
5246
0
        break;
5247
0
    case UBX_NAV_SBAS:
5248
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-SBAS\n");
5249
0
        mask = ubx_msg_nav_sbas(session, &buf[UBX_PREFIX_LEN], data_len);
5250
0
        break;
5251
0
    case UBX_NAV_SIG:
5252
0
        min_protver = 27;
5253
0
        mask = ubx_msg_nav_sig(session, &buf[UBX_PREFIX_LEN], data_len);
5254
0
        break;
5255
0
    case UBX_NAV_SOL:
5256
        /* UBX-NAV-SOL deprecated in u-blox 6,
5257
         * removed in protVer 32 (9 and 10 series).
5258
         * Use UBX-NAV-PVT instead */
5259
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-SOL\n");
5260
0
        mask = ubx_msg_nav_sol(session, &buf[UBX_PREFIX_LEN], data_len);
5261
0
        break;
5262
0
    case UBX_NAV_STATUS:
5263
0
        mask = ubx_msg_nav_status(session, &buf[UBX_PREFIX_LEN], data_len);
5264
0
        break;
5265
0
    case UBX_NAV_SVIN:
5266
0
        if (40 > data_len) {
5267
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5268
0
                     "UBX: NAV-SVIN: runt payload len %zd", data_len);
5269
0
            break;
5270
0
        }
5271
0
        mask = ubx_msg_nav_svin(session, &buf[UBX_PREFIX_LEN], data_len);
5272
0
        break;
5273
0
    case UBX_NAV_SVINFO:
5274
0
        mask = ubx_msg_nav_svinfo(session, &buf[UBX_PREFIX_LEN], data_len);
5275
0
        break;
5276
0
    case UBX_NAV_TIMEBDS:
5277
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-TIMEBDS\n");
5278
0
        break;
5279
0
    case UBX_NAV_TIMEGAL:
5280
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-TIMEGAL\n");
5281
0
        break;
5282
0
    case UBX_NAV_TIMEGLO:
5283
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-TIMEGLO\n");
5284
0
        break;
5285
0
    case UBX_NAV_TIMEGPS:
5286
0
        mask = ubx_msg_nav_timegps(session, &buf[UBX_PREFIX_LEN], data_len);
5287
0
        break;
5288
0
    case UBX_NAV_TIMELS:
5289
0
        mask = ubx_msg_nav_timels(session, &buf[UBX_PREFIX_LEN], data_len);
5290
0
        break;
5291
0
    case UBX_NAV_TIMEQZSS:
5292
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-TIMEQZSS\n");
5293
0
        break;
5294
0
    case UBX_NAV_TIMEUTC:
5295
0
        mask = ubx_msg_nav_timeutc(session, &buf[UBX_PREFIX_LEN], data_len);
5296
0
        break;
5297
0
    case UBX_NAV_VELECEF:
5298
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-VELECEF\n");
5299
0
        mask = ubx_msg_nav_velecef(session, &buf[UBX_PREFIX_LEN], data_len);
5300
0
        break;
5301
0
    case UBX_NAV_VELNED:
5302
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: NAV-VELNED\n");
5303
0
        mask = ubx_msg_nav_velned(session, &buf[UBX_PREFIX_LEN], data_len);
5304
0
        break;
5305
5306
0
    case UBX_MGA_ACK:
5307
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MGA-ACK\n");
5308
0
        break;
5309
0
    case UBX_MGA_DBD:
5310
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: MGA-DBD\n");
5311
0
        break;
5312
5313
0
    case UBX_RXM_ALM:
5314
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-ALM\n");
5315
0
        break;
5316
0
    case UBX_RXM_EPH:
5317
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-EPH\n");
5318
0
        break;
5319
0
    case UBX_RXM_IMES:
5320
        // Removed in protVer 32 (9-series)
5321
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-IMES\n");
5322
0
        break;
5323
0
    case UBX_RXM_MEASX:
5324
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-MEASX\n");
5325
0
        break;
5326
0
    case UBX_RXM_PMREQ:
5327
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-PMREQ\n");
5328
0
        break;
5329
0
    case UBX_RXM_POSREQ:
5330
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-POSREQ\n");
5331
0
        break;
5332
0
    case UBX_RXM_RAW:
5333
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-RAW\n");
5334
0
        break;
5335
0
    case UBX_RXM_RAWX:
5336
0
        mask = ubx_msg_rxm_rawx(session, &buf[UBX_PREFIX_LEN], data_len);
5337
0
        break;
5338
0
    case UBX_RXM_RLM:
5339
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-RLM\n");
5340
0
        break;
5341
0
    case UBX_RXM_RTCM:
5342
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: RXM-RTCM\n");
5343
0
        break;
5344
0
    case UBX_RXM_SFRB:
5345
0
        mask = ubx_msg_rxm_sfrb(session, &buf[UBX_PREFIX_LEN], data_len);
5346
0
        break;
5347
0
    case UBX_RXM_SFRBX:
5348
0
        min_protver = 17;
5349
0
        if (8 > data_len) {
5350
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5351
0
                     "UBX: RXM-SFRBX: runt payload len %zd", data_len);
5352
0
            break;
5353
0
        }
5354
0
        mask = ubx_msg_rxm_sfrbx(session, &buf[UBX_PREFIX_LEN], data_len);
5355
0
        break;
5356
0
    case UBX_RXM_SVSI:
5357
        // Removed in protVer 32 (9-series)
5358
        // Use UBX-NAV-ORB instead
5359
0
        mask = ubx_msg_rxm_svsi(session, &buf[UBX_PREFIX_LEN], data_len);
5360
0
        break;
5361
5362
    // undocumented
5363
    // case UBX_SEC_SESSID:
5364
    //     GPSD_LOG(LOG_PROG, &session->context->errout, "UBX-SEC-SESSID\n");
5365
    //     break;
5366
0
    case UBX_SEC_SIGN:
5367
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: SEC_SIGN\n");
5368
0
        break;
5369
0
    case UBX_SEC_UNIQID:
5370
0
        mask = ubx_msg_sec_uniqid(session, &buf[UBX_PREFIX_LEN], data_len);
5371
0
        break;
5372
0
    case UBX_TIM_DOSC:
5373
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-DOSC\n");
5374
0
        break;
5375
0
    case UBX_TIM_FCHG:
5376
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-FCHG\n");
5377
0
        break;
5378
0
    case UBX_TIM_HOC:
5379
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-HOC\n");
5380
0
        break;
5381
0
    case UBX_TIM_SMEAS:
5382
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-SMEAS\n");
5383
0
        break;
5384
0
    case UBX_TIM_SVIN:
5385
0
        if (28 > data_len) {
5386
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
5387
0
                     "UBX: TIM-SVIN: runt payload len %zd", data_len);
5388
0
            break;
5389
0
        }
5390
0
        mask = ubx_msg_tim_svin(session, &buf[UBX_PREFIX_LEN], data_len);
5391
0
        break;
5392
0
    case UBX_TIM_TM:
5393
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-TM\n");
5394
0
        break;
5395
0
    case UBX_TIM_TM2:
5396
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-TM2\n");
5397
0
        break;
5398
0
    case UBX_TIM_TP:
5399
0
        mask = ubx_msg_tim_tp(session, &buf[UBX_PREFIX_LEN], data_len);
5400
0
        break;
5401
0
    case UBX_TIM_TOS:
5402
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-TOS\n");
5403
0
        break;
5404
0
    case UBX_TIM_VCOCAL:
5405
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-VCOCAL\n");
5406
0
        break;
5407
0
    case UBX_TIM_VRFY:
5408
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX: TIM-VRFY\n");
5409
0
        break;
5410
5411
0
    default:
5412
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
5413
0
                 "UBX: unknown packet id x%04hx (length %zd)\n",
5414
0
                 msgid, len);
5415
0
    }
5416
#ifdef __UNUSED
5417
    // debug
5418
    GPSD_LOG(LOG_PROG, &session->context->errout,
5419
             "UBX: msgid x%04x end x%04x last x%04x iTOW %lld last %lld\n",
5420
             msgid,
5421
             session->driver.ubx.end_msgid,
5422
             session->driver.ubx.last_msgid,
5423
             (long long)session->driver.ubx.iTOW,
5424
             (long long)session->driver.ubx.last_iTOW);
5425
#endif
5426
5427
    // iTOW drives the cycle start/end detection
5428
    // iTOW is in ms, can go forward or backward
5429
0
    if (-1 < session->driver.ubx.iTOW) {
5430
0
        int64_t iTOW_diff;
5431
5432
        // this sentence has a (maybe good) time
5433
        // end of cycle ?
5434
0
        if (session->driver.ubx.end_msgid == msgid) {
5435
            // got known cycle ender.  Assume end of cycle, report it
5436
0
            GPSD_LOG(LOG_PROG, &session->context->errout,
5437
0
                     "UBX: cycle end x%04x iTOW %lld\n",
5438
0
                     msgid, (long long)session->driver.ubx.iTOW);
5439
0
            mask |= REPORT_IS;
5440
0
        }
5441
5442
        // start of cycle?  Start can equal end if only one message per epoch
5443
        // u-blox iTOW can have ms jitter in the same epoch!
5444
0
        iTOW_diff = session->driver.ubx.last_iTOW - session->driver.ubx.iTOW;
5445
0
        if (10 < llabs(iTOW_diff)) {
5446
            // time changed more than 10 ms (100 Hz), cycle start
5447
5448
0
            if (session->driver.ubx.end_msgid !=
5449
0
                session->driver.ubx.last_msgid) {
5450
                // new cycle ender
5451
0
                GPSD_LOG(LOG_PROG, &session->context->errout,
5452
0
                         "UBX: new ender x%04x was x%04x iTOW %lld was %lld\n",
5453
0
                         session->driver.ubx.last_msgid,
5454
0
                         session->driver.ubx.end_msgid,
5455
0
                         (long long)session->driver.ubx.iTOW,
5456
0
                         (long long)session->driver.ubx.last_iTOW);
5457
0
                session->driver.ubx.end_msgid = session->driver.ubx.last_msgid;
5458
0
            }
5459
0
            session->driver.ubx.last_iTOW = session->driver.ubx.iTOW;
5460
0
            mask |= CLEAR_IS;
5461
0
        }
5462
5463
0
        session->driver.ubx.last_msgid = msgid;
5464
        // FIXME: last_time never used...
5465
0
        session->driver.ubx.last_time = session->newdata.time;
5466
0
    } else {
5467
        // no time
5468
        /* debug
5469
        GPSD_LOG(LOG_ERROR, &session->context->errout,
5470
                 "UBX: No time, msgid %x\n", msgid);
5471
         */
5472
0
    }
5473
5474
    // Did protver change?
5475
0
    if (min_protver > session->driver.ubx.protver) {
5476
        // this GPS is at least min_protver
5477
0
        session->driver.ubx.protver = min_protver;
5478
0
    }
5479
0
    if (session->driver.ubx.last_protver != session->driver.ubx.protver) {
5480
        /* Assumption: we just did init, but did not have
5481
         * protver then, so init is not complete.  Finish now.
5482
         * unless user requested passive mode */
5483
0
        if (session->mode == O_OPTIMIZE &&
5484
0
            !session->context->passive) {
5485
0
            ubx_mode(session, MODE_BINARY);
5486
0
        }
5487
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
5488
0
                 "UBX: new PROTVER %u was %u\n",
5489
0
                 session->driver.ubx.protver,
5490
0
                 session->driver.ubx.last_protver);
5491
0
        session->driver.ubx.last_protver = session->driver.ubx.protver;
5492
        // restart init queue
5493
0
        session->queue = 0;
5494
0
    }
5495
5496
0
    if (!session->context->readonly &&
5497
0
        0 <= session->queue &&
5498
0
        100 > session->queue &&
5499
0
        0 < session->driver.ubx.protver) {
5500
0
        unsigned char msg[4] = {0};
5501
5502
0
        GPSD_LOG(LOG_DATA, &session->context->errout,
5503
0
                 "UBX: queue %d\n", session->queue);
5504
5505
        /* handle the init queue.  Some u-blox parts get cranky when they
5506
         * get too many configuration changes at once.
5507
         */
5508
5509
0
        if (50 <= session->queue &&
5510
0
            !session->context->passive) {
5511
            // turn off common NMEA, every 3rd queue turn.
5512
0
            int i = session->queue - 50;
5513
0
            if (0 == (i % 3)) {
5514
0
                int j = i / 3;
5515
0
                if (j < (int)sizeof(nmea_off)) {
5516
0
                    msg[0] = 0xf0;          // class, NMEA
5517
0
                    msg[2] = 0x00;          // rate, off
5518
0
                    msg[1] = nmea_off[j];    // msg id to turn off
5519
0
                    (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5520
0
                }
5521
0
            }
5522
0
        }
5523
5524
0
        switch (session->queue) {
5525
0
        case 0:
5526
            /* need to doi this right away, so there are UBX message
5527
            * to push this queue forward */
5528
0
            if (!session->context->passive) {
5529
                // turn on common UBX-NAV
5530
0
                unsigned i;
5531
5532
0
                msg[0] = 0x01;          // class, UBX-NAV
5533
0
                msg[2] = 0x01;          // rate, one
5534
0
                for (i = 0; i < ROWS(ubx_nav_on); i++) {
5535
0
                    msg[1] = ubx_nav_on[i];          // msg id to turn on
5536
0
                    (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5537
0
                }
5538
0
            }
5539
0
            break;
5540
0
        case 10:
5541
            /* Older u-blox (6-series) may have ignored earlier requests
5542
             * for UBX-MON-VER.  Try again if needed. */
5543
0
            if ('\0' == session->subtype[0]) {
5544
                // request UBX-MON-VER, for  SW and HW Versions
5545
0
                (void)ubx_write(session, UBX_CLASS_MON, 0x04, NULL, 0);
5546
0
            }
5547
0
            break;
5548
0
        case 20:
5549
0
            if (!session->context->passive) {
5550
0
                unsigned i;
5551
5552
0
                msg[0] = 0x01;          // class, UBX-NAV
5553
0
                msg[2] = 0x01;          // rate, one
5554
0
                if (15 > session->driver.ubx.protver) {
5555
                    /* protver 14 or less, or unknown version,
5556
                     * We should have a version now.
5557
                     * Turn on pre-15 UBX-NAV stuff */
5558
5559
0
                    for (i = 0; i < ROWS(ubx_14_nav_on); i++) {
5560
                        // msg id to turn on
5561
0
                        msg[1] = ubx_14_nav_on[i];
5562
0
                        (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5563
0
                    }
5564
0
                } else {
5565
                    /* must be 15 <= session->driver.ubx.protver
5566
                     * turn on 15+ UBX-NAV */
5567
0
                    for (i = 0; i < ROWS(ubx_15_nav_on); i++) {
5568
                        // msg id to turn on
5569
0
                        msg[1] = ubx_15_nav_on[i];
5570
0
                        (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5571
0
                    }
5572
0
                }
5573
0
            }
5574
0
            break;
5575
0
        case 71:
5576
0
            if (!session->context->passive &&
5577
0
                15 <= session->driver.ubx.protver) {
5578
                // good cycle ender, except when it is not the ender...
5579
0
                msg[0] = 0x01;          // class
5580
0
                msg[1] = 0x61;          // msg id  = UBX-NAV-EOE
5581
0
                msg[2] = 0x01;          // every cycle
5582
0
                (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5583
0
            }
5584
0
            break;
5585
0
        case 75:
5586
0
            if (!session->context->passive &&
5587
0
                15 <= session->driver.ubx.protver) {
5588
0
                msg[0] = 0x01;          // class
5589
0
                msg[1] = 0x26;          // msg id  = UBX-NAV-TIMELS
5590
0
                msg[2] = 0xff;          // about every 4 mins if nav rate is 1Hz
5591
0
                (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5592
0
            }
5593
0
            break;
5594
0
        case 80:
5595
0
            if (18 <= session->driver.ubx.protver) {
5596
                // No UNIQ-ID before PROTVER 18
5597
                // UBX-SEC-UNIQID: query for uniq id
5598
0
                (void)ubx_write(session, UBX_CLASS_SEC, 0x03, NULL, 0);
5599
0
            }
5600
0
            break;
5601
0
        case 83:
5602
0
            if (session->context->passive) {
5603
                // do nothing
5604
0
            } else if (27 > session->driver.ubx.protver) {
5605
0
                msg[0] = 0x0a;          // class, UBX-MON
5606
0
                msg[1] = 0x09;          // MON-HW
5607
0
                msg[2] = 0x04;          // every 4
5608
0
                (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5609
0
            } else {
5610
0
                msg[0] = 0x0a;          // class, UBX-MON
5611
0
                msg[1] = 0x38;          // MON-RF
5612
0
                msg[2] = 0x04;          // every 4
5613
0
                (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5614
0
            }
5615
0
            break;
5616
0
        case 87:
5617
0
            if (!session->context->passive &&
5618
0
                15 > session->driver.ubx.protver) {
5619
0
                unsigned i;
5620
5621
                /* protver 14 or less
5622
                 * turn off 15 and above UBX-NAV.  Do we need to? */
5623
0
                msg[0] = 0x01;          // class, UBX-NAV
5624
0
                msg[2] = 0x00;          // rate, off
5625
0
                for (i = 0; i < ROWS(ubx_15_nav_on); i++) {
5626
0
                    msg[1] = ubx_15_nav_on[i];          // msg id to turn off
5627
0
                    (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5628
0
                }
5629
0
            }
5630
0
            break;
5631
0
        case 90:
5632
            // Turn off some clutter, no need to do it early
5633
0
            if (!session->context->passive &&
5634
0
                15 <= session->driver.ubx.protver &&
5635
0
                27 > session->driver.ubx.protver) {
5636
                /* protver 15 or more, and less than 27
5637
                 * Soturn off 14 and below UBX-NAV */
5638
0
                unsigned i;
5639
5640
0
                msg[0] = 0x01;          // class, UBX-NAV
5641
0
                msg[2] = 0x00;          // rate, off
5642
0
                for (i = 0; i < ROWS(ubx_14_nav_on); i++) {
5643
0
                    msg[1] = ubx_14_nav_on[i];          // msg id to turn off
5644
0
                    (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5645
0
                }
5646
0
            }
5647
0
            break;
5648
0
        case 93:
5649
            /* finish up by checking if we overflowed the input buffer
5650
             * request MON-RXBUF/TXBUFF, or MON-COMMS */
5651
0
            if (27 > session->driver.ubx.protver) {
5652
                // MON-RXBUF and MON-TXBUF
5653
0
                (void)ubx_write(session, UBX_CLASS_MON, 0x08, NULL, 0);
5654
0
                (void)ubx_write(session, UBX_CLASS_MON, 0x07, NULL, 0);
5655
0
            } else {
5656
                // MON-COMMS
5657
0
                (void)ubx_write(session, UBX_CLASS_MON, 0x36, NULL, 0);
5658
0
            }
5659
0
            break;
5660
0
        default:
5661
0
            break;
5662
0
        }
5663
0
        session->queue++;
5664
0
    }
5665
0
    return mask | ONLINE_SET;
5666
0
}
5667
5668
static gps_mask_t parse_input(struct gps_device_t *session)
5669
0
{
5670
0
    if (UBX_PACKET == session->lexer.type) {
5671
0
        return ubx_parse(session, session->lexer.outbuffer,
5672
0
                         session->lexer.outbuflen);
5673
0
    }
5674
0
    return generic_parse_input(session);
5675
0
}
5676
5677
// not used by gpsd, it's for gpsctl and friends
5678
static ssize_t ubx_control_send(struct gps_device_t *session, char *msg,
5679
                                size_t data_len)
5680
0
{
5681
0
    return ubx_write(session, (unsigned int)msg[0], (unsigned int)msg[1],
5682
0
                     (unsigned char *)msg + 2,
5683
0
                     (size_t)(data_len - 2)) ? ((ssize_t) (data_len + 7)) : -1;
5684
0
}
5685
5686
static void ubx_init_query(struct gps_device_t *session)
5687
0
{
5688
    // UBX-MON-VER: query for version information
5689
0
    (void)ubx_write(session, UBX_CLASS_MON, 0x04, NULL, 0);
5690
5691
    /* We can't get query for UBX-SEC-UNIQID as we need the protver first.
5692
     * Plus, we want to chain requests so as not to  overflow the receiver
5693
     * inbuffers. */
5694
0
}
5695
5696
static void ubx_event_hook(struct gps_device_t *session, event_t event)
5697
0
{
5698
0
    if (session->context->readonly) {
5699
0
        return;
5700
0
    }
5701
0
    if (event == EVENT_IDENTIFIED) {
5702
0
        GPSD_LOG(LOG_PROG, &session->context->errout, "UBX identified\n");
5703
5704
        // no longer set UBX-CFG-SBAS here, u-blox 9 and 10 do not have it
5705
5706
0
        if (session->context->passive) {
5707
            /* passive mode, do no autoconfig
5708
             * but we really want MON-VER. */
5709
0
            (void)ubx_write(session, UBX_CLASS_MON, 0x04, NULL, 0);
5710
0
        } else if (O_OPTIMIZE == session->mode) {
5711
            // Turn off UBX output, turn on NMEA on this port.
5712
0
            ubx_mode(session, MODE_BINARY);
5713
0
        } else {
5714
            //* Turn off NMEA output, turn on UBX on this port.
5715
0
            ubx_mode(session, MODE_NMEA);
5716
0
        }
5717
0
    } else if (event == EVENT_DEACTIVATE) {
5718
        /* There used to be a hotstart/reset here.
5719
         * That caused u-blox USB to re-enumerate.
5720
         * Sometimes to a new device name.
5721
         * Bad.  Don't do that anymore...
5722
         */
5723
0
    }
5724
0
}
5725
5726
// generate and send a configuration block
5727
static gps_mask_t ubx_cfg_prt(struct gps_device_t *session, speed_t speed,
5728
                              const char parity,
5729
                              const int stopbits, const int mode)
5730
0
{
5731
0
    unsigned long usart_mode = 0;
5732
0
    unsigned char buf[UBX_CFG_LEN];
5733
0
    unsigned long i;
5734
5735
0
    memset(buf, '\0', UBX_CFG_LEN);
5736
5737
    /*
5738
     * When this is called from gpsd, the initial probe for UBX should
5739
     * have picked up the device's port number from the CFG_PRT response.
5740
     */
5741
    // FIXME!  Bad test, port_id == 0 is valid too.  DDC (I2X) = port 0
5742
0
    if (session->driver.ubx.port_id != 0) {
5743
0
        buf[0] = session->driver.ubx.port_id;
5744
0
    }
5745
    /*
5746
     * This default can be hit if we haven't sent a CFG_PRT query yet,
5747
     * which can happen in gpsmon because it doesn't autoprobe.
5748
     *
5749
     * What we'd like to do here is dispatch to USART1_ID or
5750
     * USB_ID intelligently based on whether this is a USB or RS232
5751
     * source.  Unfortunately the GR601-W screws that up by being
5752
     * a USB device with port_id 1.  So we bite the bullet and
5753
     * default to port 1.
5754
     *
5755
     * Without further logic, this means gpsmon wouldn't be able to
5756
     * change the speed on the EVK 6H's USB port.  But! To pick off
5757
     * the EVK 6H on Linux as a special case, we notice that its
5758
     * USB device name is /dev/ttyACMx - it presents as a USB modem.
5759
     *
5760
     * This logic will fail on any USB u-blox device that presents
5761
     * as an ordinary USB serial device (/dev/ttyUSB*) and actually
5762
     * has port ID 3 the way it "ought" to.
5763
     */
5764
0
    else if (strstr(session->gpsdata.dev.path, "/ttyACM") != NULL) {
5765
        // using the built in USB port
5766
        // FIXME!!  USB port has no speed!
5767
        // FIXME!!  maybe we know the portid already?
5768
0
        session->driver.ubx.port_id = buf[0] = USB_ID;
5769
0
    } else {
5770
        // A guess.  Could be UART2, or SPI, or DDC port
5771
0
        session->driver.ubx.port_id = buf[0] = USART1_ID;
5772
0
    }
5773
5774
0
    putle32(buf, 8, speed);
5775
5776
    /*
5777
     * u-blox tech support explains the default contents of the mode
5778
     * field as follows:
5779
     *
5780
     * D0 08 00 00     mode (LSB first)
5781
     *
5782
     * re-ordering bytes: 000008D0
5783
     * dividing into fields: 000000000000000000 00 100 0 11 0 1 0000
5784
     * nStopbits = 00 = 1
5785
     * parity = 100 = none
5786
     * charLen = 11 = 8-bit
5787
     * reserved1 = 1
5788
     *
5789
     * The protocol reference further gives the following subfield values:
5790
     * 01 = 1.5 stop bits (?)
5791
     * 10 = 2 stopbits
5792
     * 000 = even parity
5793
     * 001 = odd parity
5794
     * 10x = no parity
5795
     * 10 = 7 bits
5796
     *
5797
     * Some UBX reference code amplifies this with:
5798
     *
5799
     *   prtcfg.mode = (1<<4) | // compatibility with ANTARIS 4
5800
     *                 (1<<7) | // charLen = 11 = 8 bit
5801
     *                 (1<<6) | // charLen = 11 = 8 bit
5802
     *                 (1<<11); // parity = 10x = none
5803
     */
5804
0
    usart_mode |= (1<<4);       // reserved1 Antaris 4 compatibility bit
5805
0
    usart_mode |= (1<<7);       // high bit of charLen
5806
5807
    // u-blox 5+ binary only supports 8N1
5808
0
    switch (parity) {
5809
0
    case (int)'E':
5810
0
    case 2:
5811
0
        usart_mode |= (1<<7);           // 7E
5812
0
        break;
5813
0
    case (int)'O':
5814
0
    case 1:
5815
0
        usart_mode |= (1<<9) | (1<<7);  // 7O
5816
0
        break;
5817
0
    case (int)'N':
5818
0
    case 0:
5819
0
    default:
5820
0
        usart_mode |= (1<<11) | (3<<6); // 8N
5821
0
        break;
5822
0
    }
5823
5824
0
    if (2 == stopbits) {
5825
0
        usart_mode |= (1<<13);
5826
0
    }
5827
5828
0
    putle32(buf, 4, usart_mode);
5829
5830
    // enable all input protocols by default
5831
    // RTCM3 is protver 20+
5832
0
    buf[12] = NMEA_PROTOCOL_MASK | UBX_PROTOCOL_MASK | RTCM_PROTOCOL_MASK |
5833
0
              RTCM3_PROTOCOL_MASK;
5834
5835
    /* enable all input protocols by default
5836
     * no u-blox has RTCM2 out
5837
     * RTCM3 is protver 20+ */
5838
0
    buf[outProtoMask] = NMEA_PROTOCOL_MASK | UBX_PROTOCOL_MASK |
5839
0
                        RTCM3_PROTOCOL_MASK;
5840
    // FIXME: use VALGET if protver  24+
5841
0
    (void)ubx_write(session, UBX_CLASS_CFG, 0x00, buf, sizeof(buf));
5842
5843
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
5844
0
             "UBX ubx_cfg_prt mode %d port %d PROTVER %d\n", mode, buf[0],
5845
0
             session->driver.ubx.protver);
5846
5847
    // selectively enable output protocols
5848
0
    if (mode == MODE_NMEA) {
5849
        /*
5850
         * We have to club the GR601-W over the head to make it stop emitting
5851
         * UBX after we've told it to start.  But do not mung the
5852
         * protocol out mask, that breaks things.
5853
         */
5854
5855
0
        unsigned char msg[3];
5856
        /* nmea to turn on at rate one (multiplier on measurement rate)
5857
         * u-blox 8 default: RMC, VTG, GGA, GSA GSV, GLL
5858
         * who wanted GST? */
5859
0
        const unsigned char nmea_on[] = {
5860
0
            0x00,          // msg id  = GGA
5861
            // 0x01,          // msg id  = GLL, only need RMC
5862
0
            0x02,          // msg id  = GSA
5863
0
            0x03,          // msg id  = GSV
5864
0
            0x04,          // msg id  = RMC
5865
0
            0x05,          // msg id  = VTG
5866
0
            0x07,          // msg id  = GST, GNSS pseudorange error statistics
5867
0
            0x08,          // msg id  = ZDA, for UTC year
5868
0
            0x09,          // msg id  = GBS, for RAIM errors
5869
0
        };
5870
5871
0
        const unsigned char ubx_nav_off[] = {
5872
0
            0x01,          // msg id = NAV-POSECEF
5873
0
            0x04,          // msg id = UBX-NAV-DOP
5874
0
            0x06,          // msg id = NAV-SOL, deprecated in 6, gone in 9
5875
0
            0x07,          // msg id = NAV-PVT, in u-blox 6 and on
5876
0
            0x11,          // msg id = NAV-VELECEF
5877
0
            0x20,          // msg id = UBX-NAV-TIMEGPS
5878
            // 0x26;       // msg id  = UBX-NAV-TIMELS, allow as low rate
5879
0
            0x30,          // msg id = NAV-SVINFO, in 4 to 8, not 9
5880
0
            0x32,          // msg id = NAV-SBAS, in u-blox 4 to 8, not all 9
5881
0
            0x35,          // msg id = NAV-SAT, in u-blox 8 and up
5882
0
            0x43,          // msg id = NAV-SIG, in u-blox 9 and up
5883
0
            0x61,          // msg id = NAV-EOE
5884
0
        };
5885
5886
        // turn off init queue
5887
0
        session->queue = 0;
5888
5889
        // enable NMEA first, in case we over-run receiver input buffer.
5890
5891
        // turn on rate one NMEA
5892
0
        msg[0] = 0xf0;          // class, NMEA
5893
0
        msg[2] = 0x01;          // rate, one
5894
0
        for (i = 0; i < sizeof(nmea_on); i++) {
5895
0
            msg[1] = nmea_on[i];          // msg id to turn on
5896
0
            (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5897
0
        }
5898
5899
        // Now turn off UBX-NAV, one at a time.
5900
0
        msg[0] = 0x01;          // class, UBX-NAV
5901
0
        msg[2] = 0x00;          // rate off
5902
0
        for (i = 0; i < sizeof(ubx_nav_off); i++) {
5903
0
            msg[1] = ubx_nav_off[i];          // msg id to turn on
5904
0
            (void)ubx_write(session, UBX_CLASS_CFG, 0x01, msg, 3);
5905
0
        }
5906
5907
0
    } else {    // MODE_BINARY
5908
5909
        /*
5910
         * Just enabling the UBX protocol for output is not enough to
5911
         * actually get UBX output; the sentence mix is initially empty.
5912
         * Fix that...
5913
         */
5914
5915
        /* Beware sending too many messages without waiting
5916
         * for u-blox ACK, over running its input buffer.
5917
         *
5918
         * For example, the UBX-MON-VER may fail here, but works in other
5919
         * contexts.
5920
         *
5921
         * Need UBX-MON-VER for protver.  Need protver to properly configure
5922
         * the message set.
5923
         */
5924
0
        unsigned char msg[3] = {0, 0, 0};
5925
        // request SW and HW Versions, prolly already requested at detection
5926
        // ask again as older u-blox are hard of hearing
5927
0
        (void)ubx_write(session, UBX_CLASS_MON, 0x04, msg, 0);
5928
5929
0
        GPSD_LOG(LOG_IO, &session->context->errout, "UBX: init protVer %u\n",
5930
0
                 session->driver.ubx.protver);
5931
5932
        // turn on init queue
5933
0
        session->queue = 1;
5934
0
    }
5935
0
    return 0;
5936
0
}
5937
5938
static void ubx_mode(struct gps_device_t *session, int mode)
5939
0
{
5940
0
    ubx_cfg_prt(session,
5941
0
                gpsd_get_speed(session),
5942
0
                gpsd_get_parity(session),
5943
0
                gpsd_get_stopbits(session),
5944
0
                mode);
5945
0
}
5946
5947
static bool ubx_speed(struct gps_device_t *session,
5948
                      speed_t speed, char parity, int stopbits)
5949
0
{
5950
0
    ubx_cfg_prt(session,
5951
0
                speed,
5952
0
                parity,
5953
0
                stopbits,
5954
0
                (session->lexer.type == UBX_PACKET) ? MODE_BINARY : MODE_NMEA);
5955
0
    return true;
5956
0
}
5957
5958
/* change the sample rate of the GPS */
5959
static bool ubx_rate(struct gps_device_t *session, double cycletime)
5960
0
{
5961
    /* Minimum measurement cycle time currently known from documentation
5962
     * for fastest devices, here in milli seconds. Maintained in
5963
     * struct gps_type_t driver_ubx.
5964
     */
5965
0
    const int64_t min_cycle = TSTOMS(&session->device_type->min_cycle);
5966
    // cycletime in milli seconds
5967
0
    int64_t measRate = (int64_t)(cycletime * MS_IN_SEC);
5968
    // Message to be sent to device
5969
0
    unsigned char msg[6] = {
5970
0
        0x00, 0x00,     // U2: Measurement rate (ms), will be set below
5971
0
        0x01, 0x00,     // U2: Navigation rate (cycles), set to 1
5972
0
        0x00, 0x00,     // U2: Alignment to reference time: 0 = UTC
5973
0
    };
5974
5975
    // check max
5976
0
    if (65535 < measRate) {
5977
0
        measRate = 65535;   // milli seconds
5978
0
    } else if (min_cycle > measRate) {
5979
        /* Clamp cycle time to lowest bound given in documentation.
5980
         * protVer >= 24 has 25 ms min.
5981
         * protVer < 24 has min of 50ms or more.
5982
         */
5983
0
        measRate = min_cycle;
5984
0
    }
5985
    // we now know measRate fits in a U2
5986
5987
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
5988
0
             "UBX rate change, measRate %lld millisecs\n",
5989
0
             (long long) measRate);
5990
0
    msg[0] = (unsigned char)(measRate & 0xff);
5991
0
    msg[1] = (unsigned char)(measRate >> 8);
5992
5993
    // UBX-CFG-RATE deprecated in u-blox 10
5994
0
    return ubx_write(session, UBX_CLASS_CFG, 0x08, msg, 6); // CFG-RATE
5995
0
}
5996
5997
// This is everything we export
5998
// *INDENT-OFF*
5999
const struct gps_type_t driver_ubx = {
6000
    .type_name         = "u-blox",       // Full name of type
6001
    .packet_type       = UBX_PACKET,     // associated lexer packet type
6002
    .flags             = DRIVER_STICKY,  // remember this
6003
    .trigger           = NULL,
6004
    // Number of satellite channels supported by the device
6005
    // ZED-F0T supports 60, ZED-F0P supports 184
6006
    .channels          = 184,
6007
    .probe_detect      = NULL,           // Startup-time device detector
6008
    // Packet getter (using default routine)
6009
    .get_packet        = packet_get1,
6010
    .parse_packet      = parse_input,    // Parse message packets
6011
    // RTCM handler (using default routine)
6012
    .rtcm_writer       = gpsd_write,
6013
    .init_query        = ubx_init_query, // non-perturbing initial query
6014
    .event_hook        = ubx_event_hook, // Fire on various lifetime events
6015
    .speed_switcher    = ubx_speed,      // Speed (baudrate) switch
6016
    .mode_switcher     = ubx_mode,       // Mode switcher
6017
    .rate_switcher     = ubx_rate,       // Message delivery rate switcher
6018
    /* Minimum measurement cycle time currently known from documentation
6019
     * for fastest devices.
6020
     */
6021
    .min_cycle.tv_sec  = 0,
6022
    .min_cycle.tv_nsec = 25000000,          // Maximum 40Hz sample rate
6023
    .control_send      = ubx_control_send,  // how to send a control string
6024
    .time_offset       = NULL,              // no method for NTP fudge factor
6025
};
6026
// *INDENT-ON*
6027
6028
// vim: set expandtab shiftwidth=4