Coverage Report

Created: 2025-11-11 06:08

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