Coverage Report

Created: 2026-10-17 06:30

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gpsd/gpsd-3.27.6~dev/drivers/driver_navcom.c
Line
Count
Source
1
/*
2
 * Driver for Navcom receivers using proprietary NCT messages,
3
 * a binary protocol.
4
 *
5
 * Vendor website: http://www.navcomtech.com/
6
 * Technical references: Technical Reference Manual P/N 96-3120001-3001
7
 *
8
 * Tested with two SF-2040G models
9
 *
10
 * At this stage, this driver implements the following commands:
11
 *
12
 * 0x20: Data Request (tell the unit which responses you want)
13
 * 0x3f: LED Configuration (controls the front panel LEDs -- for testing)
14
 * 0x1c: Test Support Block (again, blinks the front panel lights)
15
 *
16
 * and it understands the following responses:
17
 *
18
 * 0x06: Acknowledgement (without error)
19
 * 0x15: Negative Acknowledge
20
 * 0x86: Channel Status
21
 * 0xae: Identification Block
22
 * 0xb0: Raw Meas. Data Block
23
 * 0xb1: PVT Block
24
 * 0xb5: Pseudorange Noise Statistics
25
 * 0xd3: LBM DSP Status Block
26
 * 0xef: Clock Drift and Offset
27
 *
28
 * By Diego Berge. Contact via web form at http://www.navlost.eu/contact
29
 *
30
 * Week counters are not limited to 10 bits. It's unknown what
31
 * the firmware is doing to disambiguate them, if anything; it might just
32
 * be adding a fixed offset based on a hidden epoch value, in which case
33
 * unhappy things will occur on the next rollover.
34
 *
35
 * This file is Copyright 2010 by the GPSD project
36
 * SPDX-License-Identifier: BSD-2-clause
37
 */
38
39
#include "../include/gpsd_config.h"  // must be before all includes
40
41
#include <math.h>
42
#include <stdbool.h>
43
#include <stdio.h>
44
#include <string.h>
45
46
#include "../include/gpsd.h"
47
48
#if defined(NAVCOM_ENABLE)
49
#include "../include/bits.h"
50
#include "../include/timespec.h"
51
52
// Have data which is 24 bits long
53
0
#define getles3224(buf,off)  (int32_t)(((uint32_t)getub((buf), (off)+2)<<24 | (uint32_t)getub((buf), (off)+1)<<16 | (uint32_t)getub((buf), (off))<<8)>>8)
54
#define getleu3224(buf,off) (uint32_t)(((uint32_t)getub((buf), (off)+2)<<24 | (uint32_t)getub((buf), (off)+1)<<16 | (uint32_t)getub((buf), (off))<<8)>>8)
55
56
/* And just to be difficult, Navcom is little endian but the GPS data stream
57
   is big endian.  Some messages contain raw GPS data */
58
0
#define getles16_be(buf, off)   (int16_t)((((uint16_t)getub(buf, (off)) << 8) \
59
0
                                    | (uint16_t)getub(buf, (off)+1)))
60
0
#define getleu16_be(buf, off)   (uint16_t)((((uint16_t)getub(buf, (off)) << 8) \
61
0
                                    | (uint16_t)getub(buf, (off)+1)))
62
0
#define getles32_be(buf, off)   (int32_t)((((uint16_t)getleu16_be(buf, (off)) << 16) \
63
0
                                    | getleu16_be(buf, (off)+2)))
64
0
#define getleu32_be(buf, off)   (uint32_t)((((uint16_t)getleu16_be(buf, (off)) << 16) \
65
0
                                    | getleu16_be(buf, (off)+2)))
66
0
#define getles3224_be(buf,off)     (int32_t)(((uint32_t)getub((buf), (off))<<24 \
67
0
                                    | (uint32_t)getub((buf), (off)+1)<<16 \
68
0
                                    | (uint32_t)getub((buf), (off)+2)<<8)>>8)
69
70
#define NAVCOM_CHANNELS 12
71
72
static uint8_t checksum(unsigned char *buf, size_t len)
73
0
{
74
0
    size_t n;
75
0
    uint8_t csum = (uint8_t)0x00;
76
0
    for (n = 0; n < len; n++) {
77
0
        csum ^= buf[n];
78
0
    }
79
0
    return csum;
80
0
}
81
82
static bool navcom_send_cmd(struct gps_device_t *session, unsigned char *cmd,
83
                            size_t len)
84
0
{
85
0
    return (gpsd_write(session, (const char *)cmd, len) == (ssize_t) len);
86
0
}
87
88
// Data Request
89
static void navcom_cmd_0x20(struct gps_device_t *session, uint8_t block_id,
90
                            uint16_t rate)
91
0
{
92
0
    unsigned char msg[18];
93
0
    putbyte(msg, 0, 0x02);
94
0
    putbyte(msg, 1, 0x99);
95
0
    putbyte(msg, 2, 0x66);
96
0
    putbyte(msg, 3, 0x20);      // Cmd ID
97
0
    putle16(msg, 4, 0x000e);    // Length
98
0
    putbyte(msg, 6, 0x00);      // Action
99
0
    putbyte(msg, 7, 0x01);      // Count of blocks
100
0
    putbyte(msg, 8, block_id);  // Data Block ID
101
0
    putbyte(msg, 9, 0x02);      // Logical Ports
102
0
    putle16(msg, 10, rate);     // Data rate
103
0
    putbyte(msg, 12, 0x71);
104
0
    putbyte(msg, 13, 0x00);
105
0
    putle16(msg, 14, 0x0000);
106
0
    putbyte(msg, 16, checksum(msg + 3, 13));
107
0
    putbyte(msg, 17, 0x03);
108
0
    (void)navcom_send_cmd(session, msg, 18);
109
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
110
0
             "Navcom: sent command 0x20 (Data Request) "
111
0
             "- data block id = %02x at rate %02x\n", block_id, rate);
112
0
}
113
114
// cppcheck-suppress unusedFunction
115
static void UNUSED navcom_cmd_0x3f(struct gps_device_t *session)
116
// Changes the LED settings in the receiver
117
0
{
118
0
    unsigned char msg[12];
119
0
    putbyte(msg, 0, 0x02);
120
0
    putbyte(msg, 1, 0x99);
121
0
    putbyte(msg, 2, 0x66);
122
0
    putbyte(msg, 3, 0x3f);      // Cmd ID
123
0
    putle16(msg, 4, 0x0008);
124
0
    putbyte(msg, 6, 0x01);      // Action
125
0
    putbyte(msg, 7, 0x00);      // Reserved
126
0
    putbyte(msg, 8, 0x02);      // Link LED setting
127
0
    putbyte(msg, 9, 0x0a);      // Battery LED setting
128
0
    putbyte(msg, 10, checksum(msg + 3, 7));
129
0
    putbyte(msg, 11, 0x03);
130
0
    (void)navcom_send_cmd(session, msg, 12);
131
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
132
0
             "Navcom: sent command 0x3f (LED Configuration Block)\n");
133
0
}
134
135
// Test Support Block - Blinks the LEDs
136
static void navcom_cmd_0x1c(struct gps_device_t *session, uint8_t mode,
137
                            uint8_t length)
138
0
{
139
0
    unsigned char msg[12];
140
0
    putbyte(msg, 0, 0x02);
141
0
    putbyte(msg, 1, 0x99);
142
0
    putbyte(msg, 2, 0x66);
143
0
    putbyte(msg, 3, 0x1c);      // Cmd ID
144
0
    putle16(msg, 4, 0x0008);
145
0
    putbyte(msg, 6, 0x04);      // Use ACK/NAK
146
0
    putbyte(msg, 7, mode);      // 0x01 or 0x02
147
0
    putbyte(msg, 8, length);    // Only if mode == 0x01
148
0
    putbyte(msg, 9, 0x00);
149
0
    putbyte(msg, 10, checksum(msg + 3, 7));
150
0
    putbyte(msg, 11, 0x03);
151
0
    (void)navcom_send_cmd(session, msg, 12);
152
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
153
0
             "Navcom: sent command 0x1c (Test Support Block)\n");
154
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
155
0
             "Navcom: command 0x1c mode = %02x, length = %u\n",
156
0
             mode, length);
157
0
}
158
159
// Serial Port Configuration
160
static void navcom_cmd_0x11(struct gps_device_t *session,
161
                            uint8_t port_selection)
162
0
{
163
    /* NOTE - We only allow changing one port at a time,
164
     * although the message supports doing both at once. */
165
0
    unsigned char msg[12];
166
0
    putbyte(msg, 0, 0x02);
167
0
    putbyte(msg, 1, 0x99);
168
0
    putbyte(msg, 2, 0x66);
169
0
    putbyte(msg, 3, 0x11);      // Cmd ID
170
0
    putle16(msg, 4, 0x0008);    // Length
171
0
    putbyte(msg, 6, 0x04);      // Action - Use ACK/NAK)
172
0
    putbyte(msg, 7, port_selection);
173
0
    putbyte(msg, 8, 0x00);      // Reserved
174
0
    putbyte(msg, 9, 0x00);      // Reserved
175
0
    putbyte(msg, 10, checksum(msg + 3, 7));
176
0
    putbyte(msg, 11, 0x03);
177
0
    (void)navcom_send_cmd(session, msg, 12);
178
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
179
0
             "Navcom: sent command 0x11 (Serial Port Configuration)\n");
180
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
181
0
             "Navcom: serial port selection: 0x%02x\n", port_selection);
182
0
}
183
184
static void navcom_event_hook(struct gps_device_t *session, event_t event)
185
0
{
186
0
    if (session->context->readonly) {
187
0
        return;
188
0
    }
189
190
    // Request the following messages:
191
0
    if (event == EVENT_IDENTIFIED) {
192
        /* NOTE - Channel Status allows us to know into which of the
193
         * unit's various serial ports we are connected.
194
         * Its value gets updated every time we receive a 0x06 (Ack)
195
         * message.  Note that if commands are being fed into the
196
         * unit from more than one port (which is entirely possible
197
         * although not necessarily a bright idea), there is a good
198
         * chance that we might misidentify our port */
199
0
        navcom_cmd_0x1c(session, 0x02, 0);      // Test Support Block
200
0
        navcom_cmd_0x20(session, 0xae, 0x0000); // Identification Block
201
0
        navcom_cmd_0x20(session, 0x86, 0x000a); // Channel Status
202
0
        navcom_cmd_0x1c(session, 0x01, 5);      // Blink LEDs on receiver
203
        // Identification Block - send every 10 min
204
0
        navcom_cmd_0x20(session, 0xae, 0x1770);
205
0
        navcom_cmd_0x20(session, 0xb1, 0x4000); // PVT Block
206
        // Pseudorange Noise Statistics - send every 20s
207
0
        navcom_cmd_0x20(session, 0xb5, 0x00c8);
208
0
        navcom_cmd_0x20(session, 0xb0, 0x4000); // Raw Meas Data Block
209
        // Packed Ephemeris Data - send once
210
0
        navcom_cmd_0x20(session, 0x81, 0x0000);
211
0
        navcom_cmd_0x20(session, 0x81, 0x4000); // Packed Ephemeris Data
212
0
        navcom_cmd_0x20(session, 0x86, 0x4000); // Channel Status
213
0
        navcom_cmd_0x20(session, 0x83, 0x4000); // Ionosphere and UTC Data
214
        // Clock Drift - send every 5 min
215
0
        navcom_cmd_0x20(session, 0xef, 0x0bb8);
216
0
    }
217
0
}
218
219
// Ionosphere and UTC Data
220
static gps_mask_t handle_0x83(struct gps_device_t *session)
221
0
{
222
    /* NOTE - At the present moment this is only being used
223
     * for determining the GPS-UTC time difference,
224
     * for which the iono data is not needed as far
225
     * as we are concerned.  However, I am still
226
     * reporting it (if debuglevel >= LOG_DATA) as a
227
     * matter of interest */
228
// 2^-30
229
0
#define SF_A0 (0.000000000931322574615478515625)
230
// 2^-50
231
0
#define SF_A1 (0.000000000000000888178419700125)
232
// 2^12
233
0
#define SF_TOT (4096)
234
// 2^-30
235
0
#define SF_ALPHA0 (0.000000000931322574615478515625)
236
// 2^-27
237
0
#define SF_ALPHA1 (0.000000007450580596923828125)
238
// 2^-24
239
0
#define SF_ALPHA2 (0.000000059604644775390625)
240
// 2^-24
241
0
#define SF_ALPHA3 (0.000000059604644775390625)
242
// 2^11
243
0
#define SF_BETA0 (2048)
244
// 2^14
245
0
#define SF_BETA1 (16384)
246
// 2^16
247
0
#define SF_BETA2 (65536)
248
// 2^16
249
0
#define SF_BETA3 (65536)
250
0
    unsigned char *buf = session->lexer.outbuffer + 3;
251
0
    uint16_t week = getleu16(buf, 3);
252
0
    uint32_t tow = getleu32(buf, 5);
253
0
    int8_t alpha0 = getsb(buf, 9);
254
0
    int8_t alpha1 = getsb(buf, 10);
255
0
    int8_t alpha2 = getsb(buf, 11);
256
0
    int8_t alpha3 = getsb(buf, 12);
257
0
    int8_t beta0 = getsb(buf, 13);
258
0
    int8_t beta1 = getsb(buf, 14);
259
0
    int8_t beta2 = getsb(buf, 15);
260
0
    int8_t beta3 = getsb(buf, 16);
261
0
    int32_t a1 = getles32(buf, 17);
262
0
    int32_t a0 = getles32(buf, 21);
263
0
    uint8_t tot = getub(buf, 25);
264
0
    uint8_t wnt = getub(buf, 26);
265
0
    int8_t dtls = getsb(buf, 27);
266
0
    uint8_t wnlsf = getub(buf, 28);
267
0
    uint8_t dn = getub(buf, 29);
268
0
    int8_t dtlsf = getsb(buf, 30);
269
270
    // Ref.: ICD-GPS-200C 20.3.3.5.2.4
271
0
    if ((week % 256) * 604800 + tow / 1000.0 < wnlsf * 604800 + dn * 86400) {
272
        // Effectivity time is in the future, use dtls
273
0
        session->context->leap_seconds = (int)dtls;
274
0
    } else {
275
        // Effectivity time is not in the future, use dtlsf
276
0
        session->context->leap_seconds = (int)dtlsf;
277
0
    }
278
279
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
280
0
             "Navcom: received packet type 0x83 (Ionosphere and UTC Data)\n");
281
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
282
0
             "Navcom: Scaled parameters follow:\n");
283
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
284
0
             "Navcom: GPS Week: %u, GPS Time of Week: %u (GPS Time: %f)\n",
285
0
             week, tow, week * 604800 + tow / 1000.0);
286
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
287
0
             "Navcom: a0: %12.4E, a1: %12.4E, a2: %12.4E, a3: %12.4E, "
288
0
             "b0: %12.4E, b1: %12.4E, b2: %12.4E, b3: %12.4E\n",
289
0
             (double)alpha0 * SF_ALPHA0, (double)alpha1 * SF_ALPHA1,
290
0
             (double)alpha2 * SF_ALPHA2, (double)alpha3 * SF_ALPHA3,
291
0
             (double)beta0 * SF_BETA0, (double)beta1 * SF_BETA1,
292
0
             (double)beta2 * SF_BETA2, (double)beta3 * SF_BETA3);
293
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
294
0
             "Navcom: A0: %19.12E, A1: %19.12E\n", (double)a0 * SF_A0,
295
0
             (double)a1 * SF_A1);
296
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
297
0
             "Navcom: UTC Ref. Time: %lu, UTC Ref. Week: %u, dTls: %d\n",
298
0
             (unsigned long)tot * SF_TOT, wnt, dtls);
299
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
300
0
             "Navcom: Week of leap seconds: %u, Day number of leap seconds: %u, dTlsf: %d\n",
301
0
             wnlsf, dn, dtlsf);
302
303
0
    return 0;     // No flag for update of leap seconds (Not part of a fix)
304
305
0
#undef SF_A0
306
0
#undef SF_A1
307
0
#undef SF_TOT
308
0
#undef SF_ALPHA0
309
0
#undef SF_ALPHA1
310
0
#undef SF_ALPHA2
311
0
#undef SF_ALPHA3
312
0
#undef SF_BETA0
313
0
#undef SF_BETA1
314
0
#undef SF_BETA2
315
0
#undef SF_BETA3
316
0
}
317
318
// Acknowledgement (without error)
319
static gps_mask_t handle_0x06(struct gps_device_t *session)
320
0
{
321
0
    unsigned char *buf = session->lexer.outbuffer + 3;
322
0
    uint8_t cmd_id = getub(buf, 3);
323
0
    uint8_t port = getub(buf, 4);
324
325
    // This tells us which serial port was used last
326
0
    session->driver.navcom.physical_port = port;
327
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
328
0
             "Navcom: received packet type 0x06 (Acknowledgement (without "
329
0
             "error))\n");
330
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
331
0
             "Navcom: acknowledged command id 0x%02x on port %c\n",
332
0
             cmd_id, (port == 0 ? 'A' : (port == 1 ? 'B' : '?')));
333
0
    return 0;                   // Nothing updated
334
0
}
335
336
// Negative Acknowledge*/
337
static gps_mask_t handle_0x15(struct gps_device_t *session)
338
0
{
339
0
    unsigned n;
340
0
    unsigned char *buf = session->lexer.outbuffer + 3;
341
0
    unsigned msg_len = getleu16(buf, 1);
342
0
    uint8_t port, cmd_id = getub(buf, 3);
343
344
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
345
0
             "Navcom: received packet type 0x15 (Negative Acknowledge)\n");
346
347
0
    if (18 < msg_len) {
348
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
349
0
                 "Navcom: 0x15 too long %u\n", msg_len);
350
0
        return 0;
351
0
    }
352
0
    for (n = 4; n < (msg_len - 2); n += 2) {
353
0
        uint8_t err_id = getub(buf, n);
354
0
        uint8_t err_desc = getub(buf, n + 1);
355
0
        GPSD_LOG(LOG_DATA, &session->context->errout,
356
0
                 "Navcom: error id = 0x%02x, error description = 0x%02x\n",
357
0
                 err_id, err_desc);
358
0
    }
359
0
    port = getub(buf, n);
360
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
361
0
             "Navcom: negative acknowledge was for command id 0x%02x "
362
0
             "on port %c\n",
363
0
             cmd_id, (port == 0 ? 'A' : (port == 1 ? 'B' : '?')));
364
0
    return 0;                   // Nothing updated*/
365
0
}
366
367
// PVT Block*/
368
static gps_mask_t handle_0xb1(struct gps_device_t *session)
369
0
{
370
0
    gps_mask_t mask = 0;
371
0
    unsigned char *buf = session->lexer.outbuffer + 3;
372
0
    uint16_t week;
373
0
    uint32_t tow;
374
0
    timespec_t ts_tow = {0, 0};      // pacify codacy
375
0
    int32_t lat, lon;
376
0
    char ts_buf[TIMESPEC_LEN];
377
    // Resolution of lat/lon values (2^-11)*/
378
0
#define LL_RES (0.00048828125)
379
0
    uint8_t lat_fraction, lon_fraction;
380
    // Resolution of lat/lon fractions (2^-15)*/
381
0
#define LL_FRAC_RES (0.000030517578125)
382
0
    uint8_t nav_mode;
383
0
    int32_t ellips_height, altitude;
384
    // Resolution of height and altitude values (2.0^-10)*/
385
0
#define EL_RES (0.0009765625)
386
0
    double vel_north, vel_east, vel_up;
387
0
    uint8_t gdop, pdop, hdop, vdop, tdop;
388
    // This value means "undefined"*/
389
0
#define DOP_UNDEFINED (255)
390
391
0
    int16_t ant_height_adj;
392
0
    int32_t set_delta_up;
393
    /* Resolution of delta north, east, and up,
394
     * and ant. height adjustment values (1mm) */
395
0
#define D_RES (0.001)
396
397
#ifdef __UNUSED__
398
    /* Other values provided by the PVT block which we
399
     * may want to provide in the future.
400
     */
401
    uint8_t dgps_conf;
402
    uint16_t max_dgps_age;
403
    uint8_t ext_nav_mode;
404
    int32_t set_delta_north, set_delta_east;
405
    uint8_t nav_failure_code;
406
#endif  // __UNUSED__*/
407
408
    // Timestamp
409
0
    week = (uint16_t) getleu16(buf, 3);
410
0
    tow = (uint32_t) getleu32(buf, 5);        // tow in ms
411
0
    MSTOTS(&ts_tow, tow);
412
0
    session->newdata.time = gpsd_gpstime_resolv(session, week, ts_tow);
413
414
    // Get latitude, longitude
415
0
    lat = getles32(buf, 13);
416
0
    lon = getles32(buf, 17);
417
0
    lat_fraction = (uint8_t) (getub(buf, 21) >> 4);
418
0
    lon_fraction = (uint8_t) (getub(buf, 21) & 0x0f);
419
420
0
    session->newdata.latitude =
421
0
        (double)(lat * LL_RES + lat_fraction * LL_FRAC_RES) / 3600;
422
0
    session->newdata.longitude =
423
0
        (double)(lon * LL_RES + lon_fraction * LL_FRAC_RES) / 3600;
424
425
    // Nav mode
426
0
    nav_mode = (uint8_t) getub(buf, 22);
427
0
    if (-nav_mode & 0x80) {
428
0
        session->newdata.status = STATUS_UNK;
429
0
        session->newdata.mode = MODE_NO_FIX;
430
0
    } else {
431
0
        session->newdata.mode = ((nav_mode & 0x40)!=0 ? MODE_3D : MODE_2D);
432
0
        session->newdata.status =
433
0
            ((nav_mode & 0x03)!=0 ? STATUS_DGPS : STATUS_GPS);
434
0
    }
435
436
    // altHAE
437
0
    ellips_height = getles32(buf, 23);
438
    // altMSL
439
0
    altitude = getles32(buf, 27);
440
441
0
    ant_height_adj = getles16(buf, 51);
442
0
    set_delta_up = getles32(buf, 79);
443
444
0
    session->newdata.altMSL = (double)(altitude * EL_RES)
445
0
        + (ant_height_adj * D_RES) + (set_delta_up * D_RES);
446
0
    session->newdata.altHAE = (double)(ellips_height) * EL_RES
447
0
        + (ant_height_adj * D_RES) + (set_delta_up * D_RES);
448
    // Let gpsd_error_model() deal with geoid_sep
449
450
    // Speed Data
451
0
    vel_north = (double)getles3224(buf, 31);
452
0
    vel_east = (double)getles3224(buf, 34);
453
0
    vel_up = (double)getles3224(buf, 37);
454
455
0
    session->newdata.NED.velN = vel_north * 0.1;
456
0
    session->newdata.NED.velE = vel_east * 0.1;
457
0
    session->newdata.NED.velD = -vel_up * 0.1;
458
459
    // Quality indicators
460
    // UNUSED fom = getub(buf, 40);     * FOM is DRMS
461
0
    gdop = getub(buf, 41);
462
0
    pdop = getub(buf, 42);
463
0
    hdop = getub(buf, 43);
464
0
    vdop = getub(buf, 44);
465
0
    tdop = getub(buf, 45);
466
    // UNUSED tfom = getub(buf, 46);    * tfom == 10 * TDOP
467
468
    // let gpsd_error_model() do the error estimates
469
470
0
    if (gdop != DOP_UNDEFINED) {
471
0
        session->gpsdata.dop.gdop = gdop / 10.0;
472
0
        mask |= DOP_SET;
473
0
    }
474
0
    if (pdop != DOP_UNDEFINED) {
475
0
        session->gpsdata.dop.pdop = pdop / 10.0;
476
0
        mask |= DOP_SET;
477
0
    }
478
0
    if (hdop != DOP_UNDEFINED) {
479
0
        session->gpsdata.dop.hdop = hdop / 10.0;
480
0
        mask |= DOP_SET;
481
0
    }
482
0
    if (vdop != DOP_UNDEFINED) {
483
0
        session->gpsdata.dop.vdop = vdop / 10.0;
484
0
        mask |= DOP_SET;
485
0
    }
486
0
    if (tdop != DOP_UNDEFINED) {
487
0
        session->gpsdata.dop.tdop = tdop / 10.0;
488
0
        mask |= DOP_SET;
489
0
    }
490
491
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
492
0
             "Navcom: received packet type 0xb1 (PVT Report)\n");
493
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
494
0
             "Navcom: navigation mode %s (0x%02x) - %s - %s\n",
495
0
             ((-nav_mode & 0x80)!='\0' ? "invalid" : "valid"), nav_mode,
496
0
             ((nav_mode & 0x40)!='\0' ? "3D" : "2D"),
497
0
             ((nav_mode & 0x03)!='\0' ? "DGPS" : "GPS"));
498
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
499
0
             "Navcom: velocities: north = %f east = %f up = %f\n",
500
0
             session->newdata.NED.velN,
501
0
             session->newdata.NED.velE,
502
0
             -session->newdata.NED.velD);
503
0
#undef D_RES
504
0
#undef LL_RES
505
0
#undef LL_FRAC_RES
506
0
#undef EL_RES
507
0
#undef VEL_RES
508
0
#undef DOP_UNDEFINED
509
510
0
    mask |= LATLON_SET | ALTITUDE_SET | STATUS_SET | MODE_SET | USED_IS |
511
0
           HERR_SET | TIMERR_SET | VNED_SET | TIME_SET | NTPTIME_IS;
512
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
513
0
             "PVT 0xb1: time=%s, lat=%.2f lon=%.2f altHAE=%.2f "
514
0
             "altMSL %.2f mode=%d status=%d gdop=%.2f pdop=%.2f hdop=%.2f "
515
0
             "vdop=%.2f tdop=%.2f mask={%s}\n",
516
0
             timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)),
517
0
             session->newdata.latitude,
518
0
             session->newdata.longitude,
519
0
             session->newdata.altHAE,
520
0
             session->newdata.altMSL,
521
0
             session->newdata.mode,
522
0
             session->newdata.status,
523
0
             session->gpsdata.dop.gdop,
524
0
             session->gpsdata.dop.pdop,
525
0
             session->gpsdata.dop.hdop,
526
0
             session->gpsdata.dop.vdop, session->gpsdata.dop.tdop,
527
0
             gps_maskdump(mask));
528
0
    return mask | CLEAR_IS | REPORT_IS;
529
0
}
530
531
// Packed Ephemeris Data
532
static gps_mask_t handle_0x81(struct gps_device_t *session)
533
0
{
534
    // Scale factors for everything
535
    // 2^-31
536
0
#define SF_TGD       (.000000000465661287307739257812)
537
    // 2^4
538
0
#define SF_TOC     (16)
539
    // 2^-55
540
0
#define SF_AF2       (.000000000000000027755575615628)
541
    // 2^-43
542
0
#define SF_AF1       (.000000000000113686837721616029)
543
    // 2^-31
544
0
#define SF_AF0       (.000000000465661287307739257812)
545
    // 2^-5
546
0
#define SF_CRS       (.031250000000000000000000000000)
547
    // 2^-43
548
0
#define SF_DELTA_N   (.000000000000113686837721616029)
549
    // 2^-31
550
0
#define SF_M0   (.000000000465661287307739257812)
551
    // 2^-29
552
0
#define SF_CUC       (.000000001862645149230957031250)
553
    // 2^-33
554
0
#define SF_E     (.000000000116415321826934814453)
555
    // 2^-29
556
0
#define SF_CUS       (.000000001862645149230957031250)
557
    // 2^-19
558
0
#define SF_SQRT_A    (.000001907348632812500000000000)
559
    // 2^4
560
0
#define SF_TOE     (16)
561
    // 2^-29
562
0
#define SF_CIC       (.000000001862645149230957031250)
563
    // 2^-31
564
0
#define SF_OMEGA0    (.000000000465661287307739257812)
565
    // 2^-29
566
0
#define SF_CIS       (.000000001862645149230957031250)
567
    // 2^-31
568
0
#define SF_I0   (.000000000465661287307739257812)
569
    // 2^-5
570
0
#define SF_CRC       (.031250000000000000000000000000)
571
    // 2^-31
572
0
#define SF_OMEGA     (.000000000465661287307739257812)
573
    // 2^-43
574
0
#define SF_OMEGADOT  (.000000000000113686837721616029)
575
    // 2^-43
576
0
#define SF_IDOT      (.000000000000113686837721616029)
577
578
0
    char ts_buf[TIMESPEC_LEN];
579
0
    unsigned char *buf = session->lexer.outbuffer + 3;
580
0
    uint8_t prn = getub(buf, 3);
581
0
    uint16_t week = getleu16(buf, 4);
582
0
    uint32_t tow = getleu32(buf, 6);
583
0
    uint16_t iodc = getleu16(buf, 10);
584
    /* And now the fun starts... everything that follows is
585
     * raw GPS data minus parity */
586
    // Subframe 1, words 3 to 10 minus parity
587
0
    uint16_t wn = (getleu16_be(buf, 12) & 0xffc0) >> 6;
588
0
    uint8_t cl2 = (getub(buf, 13) & 0x30) >> 4;
589
0
    uint8_t ura = getub(buf, 13) & 0x0f;
590
0
    uint8_t svh = (getub(buf, 14) & 0xfc) >> 2;
591
    /* We already have IODC from earlier in the message, so
592
     * we do not decode again */
593
//    uint16_t iodc = (getub(buf, 14)&0x03)<<8;*/
594
0
    uint8_t l2pd = (getub(buf, 15) & 0x80) >> 7;
595
0
    int8_t tgd = getsb(buf, 26);
596
//    iodc |= getub(buf, 27);*/
597
0
    uint16_t toc = getleu16_be(buf, 28);
598
0
    int8_t af2 = getsb(buf, 30);
599
0
    int16_t af1 = getles16_be(buf, 31);
600
0
    int32_t af0 = getles3224_be(buf, 33) >> 2;
601
    // Subframe 2, words 3 to 10 minus parity
602
0
    uint8_t iode = getub(buf, 36);
603
0
    int16_t crs = getles16_be(buf, 37);
604
0
    int16_t delta_n = getles16_be(buf, 39);
605
0
    int32_t m0 = getles32_be(buf, 41);
606
0
    int16_t cuc = getles16_be(buf, 45);
607
0
    uint32_t e = getleu32_be(buf, 47);
608
0
    int16_t cus = getles16_be(buf, 51);
609
0
    uint32_t sqrt_a = getleu32_be(buf, 53);
610
0
    uint16_t toe = getleu16_be(buf, 57);
611
    // NOTE - Fit interval & AODO not collected
612
    // Subframe 3, words 3 to 10 minus parity
613
0
    int16_t cic = getles16_be(buf, 60);
614
0
    int32_t Omega0 = getles32_be(buf, 62);
615
0
    int16_t cis = getles16_be(buf, 66);
616
0
    int32_t i0 = getles32_be(buf, 68);
617
0
    int16_t crc = getles16_be(buf, 72);
618
0
    int32_t omega = getles32_be(buf, 74);
619
0
    int32_t Omegadot = getles3224_be(buf, 78);
620
    /* Question: What is the proper way of shifting a signed int 2 bits to
621
     * the right, preserving sign? Answer: integer division by 4. */
622
0
    int16_t idot = (int16_t) (((getles16_be(buf, 82) & 0xfffc) / 4) |
623
0
                              ((getub(buf, 82) & 80) ? 0xc000 : 0x0000));
624
0
    session->context->gps_week = (unsigned short)wn;
625
0
    DTOTS(&session->context->gps_tow, (double)(toc * SF_TOC));
626
    // leap second?
627
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
628
0
             "Navcom: received packet type 0x81 (Packed Ephemeris Data)\n");
629
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
630
0
             "Navcom: PRN: %u, Week: %u, TOW: %s "
631
0
             "SV clock bias/drift/drift rate: %#19.12E/%#19.12E/%#19.12E\n",
632
0
             prn,
633
0
             session->context->gps_week,
634
0
             timespec_str(&session->context->gps_tow, ts_buf, sizeof(ts_buf)),
635
0
             ((double)af0) * SF_AF0,
636
0
             ((double)af1) * SF_AF1, ((double)af2) * SF_AF2);
637
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
638
0
             "Navcom: IODE (!AODE): %u Crs: %19.12e, Delta n: %19.12e, M0: %19.12e\n",
639
0
             iode, (double)crs * SF_CRS,
640
0
             (double)delta_n * SF_DELTA_N * GPS_PI,
641
0
             (double)m0 * SF_M0 * GPS_PI);
642
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
643
0
             "Navcom: Cuc: %19.12e, Eccentricity: %19.12e, Cus: %19.12e, A^1/2: %19.12e\n",
644
0
             (double)cuc * SF_CUC, (double)e * SF_E, (double)cus * SF_CUS,
645
0
             (double)sqrt_a * SF_SQRT_A);
646
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
647
0
             "Navcom: TOE: %u, Cic: %19.12e, Omega %19.12e, Cis: %19.12e\n",
648
0
             toe * SF_TOE, (double)cic * SF_CIC,
649
0
             (double)Omega0 * SF_OMEGA0 * GPS_PI, (double)cis * SF_CIS);
650
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
651
0
             "Navcom: i0: %19.12e, Crc: %19.12e, omega: %19.12e, Omega dot: %19.12e\n",
652
0
             (double)i0 * SF_I0 * GPS_PI, (double)crc * SF_CRC,
653
0
             (double)omega * SF_OMEGA * GPS_PI,
654
0
             (double)Omegadot * SF_OMEGADOT * GPS_PI);
655
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
656
0
             "Navcom: IDOT: %19.12e, Codes on L2: 0x%x, GPS Week: %u, L2 P data flag: %x\n",
657
0
             (double)idot * SF_IDOT * GPS_PI, cl2,
658
0
             week - (week % 1024) + wn, l2pd);
659
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
660
0
             "Navcom: SV accuracy: 0x%x, SV health: 0x%x, TGD: %f, IODC (!AODC): %u\n",
661
0
             ura, svh, (double)tgd * SF_TGD, iodc);
662
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
663
0
             "Navcom: Transmission time: %u\n", tow);
664
665
0
#undef SF_TGD
666
0
#undef SF_TOC
667
0
#undef SF_AF2
668
0
#undef SF_AF1
669
0
#undef SF_AF0
670
0
#undef SF_CRS
671
0
#undef SF_DELTA_N
672
0
#undef SF_M0
673
0
#undef SF_CUC
674
0
#undef SF_E
675
0
#undef SF_CUS
676
0
#undef SF_SQRT_A
677
0
#undef SF_TOE
678
0
#undef SF_CIC
679
0
#undef SF_OMEGA0
680
0
#undef SF_CIS
681
0
#undef SF_I0
682
0
#undef SF_CRC
683
0
#undef SF_OMEGA
684
0
#undef SF_OMEGADOT
685
0
#undef SF_IDOT
686
687
0
    return 0;
688
0
}
689
690
// Channel Status
691
static gps_mask_t handle_0x86(struct gps_device_t *session)
692
0
{
693
0
    size_t n, i, nsu;
694
0
    unsigned char *buf = session->lexer.outbuffer + 3;
695
0
    unsigned msg_len = getleu16(buf, 1);
696
0
    unsigned short week = getleu16(buf, 3);
697
0
    uint32_t tow = getleu32(buf, 5);
698
0
    uint8_t eng_status = getub(buf, 9);
699
0
    uint16_t sol_status = getleu16(buf, 10);
700
0
    uint8_t sats_visible = getub(buf, 12);
701
    //uint8_t sats_tracked = getub(buf, 13);
702
    //uint8_t used_sats = getub(buf, 14);
703
    //uint8_t pdop = getub(buf, 15);
704
0
    timespec_t ts_tow;
705
706
0
    MSTOTS(&ts_tow, tow);
707
708
    // Timestamp
709
0
    session->gpsdata.skyview_time = gpsd_gpstime_resolv(session, week, ts_tow);
710
711
    // Give this driver a single point of truth about DOPs
712
    //session->gpsdata.dop.pdop = (int)pdop / 10.0;
713
714
    // Satellite count
715
0
    session->gpsdata.satellites_visible = sats_visible;
716
0
    if (MAXCHANNELS < session->gpsdata.satellites_visible) {
717
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
718
0
                "NAVCOM: too many satellites %d\n",
719
0
                 session->gpsdata.satellites_visible);
720
0
        session->gpsdata.satellites_visible = MAXCHANNELS;
721
0
    }
722
723
    // Fix mode
724
0
    switch (sol_status & 0x05) {
725
0
    case 0x05:
726
0
        session->newdata.status = STATUS_DGPS;
727
0
        break;
728
0
    case 0x01:
729
0
        session->newdata.status = STATUS_GPS;
730
0
        break;
731
0
    default:
732
0
        session->newdata.status = STATUS_UNK;
733
0
    }
734
735
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
736
0
             "Navcom: engine status 0x%x almanac %s time 0x%x pos 0x%x\n",
737
0
             eng_status & 0x07, ((eng_status & 0x08) ? "valid" : "invalid"),
738
0
             eng_status & 0x30 >> 4, eng_status & 0xc0 >> 6);
739
740
    // Satellite details
741
0
    i = nsu = 0;
742
0
    if (298 < msg_len) {
743
        /* pasify coverity
744
         * msg_len = 18 + (14 * nsat)
745
         * assume 20 sats max */
746
0
        msg_len = 298;
747
0
    }
748
0
    for (n = 17; n < msg_len; n += 14) {
749
0
        uint8_t prn, ele, ca_snr, p2_snr, log_channel, hw_channel, s, stat;
750
0
        uint16_t azm, dgps_age;
751
0
        if (i >= MAXCHANNELS) {
752
0
            GPSD_LOG(LOG_ERROR, &session->context->errout,
753
0
                     "Navcom: packet type 0x86: too many satellites!\n");
754
0
            gpsd_zero_satellites(&session->gpsdata);
755
0
            return 0;
756
0
        }
757
0
        prn = getub(buf, n);
758
        /*
759
         * This field is described in the Technical Reference as follows:
760
         *
761
         * Channel Tracking Status:
762
         * B0-B1: C/A tracking status
763
         * B2-B3: P1 tracking status
764
         * B4-B5: P2 tracking status
765
         *    00 Acquisition or reacquisition
766
         *    01 Code loop locked
767
         *    02 Costas loop locked
768
         *    11 Full tracking with aiding and active
769
         *       multipath reduction - all data is valid
770
         * B6=1: C/A Bit sync
771
         * B7=1: C/A Frame sync
772
         *
773
         * By observation, the satellite is in use if this status is 0xff.
774
         * But errors here are not very serious, all they can affect is
775
         * the coverance-matrix calculation for error modeling.
776
         */
777
0
        stat = getub(buf, n + 1);
778
0
        log_channel = getub(buf, n + 2);
779
0
        ele = getub(buf, n + 5);
780
0
        azm = getleu16(buf, n + 6);
781
0
        ca_snr = getub(buf, n + 8);
782
0
        p2_snr = getub(buf, n + 10);
783
0
        dgps_age = getleu16(buf, n + 11);
784
0
        hw_channel = getub(buf, n + 13);
785
0
        s = (unsigned char)0;
786
        /* NOTE - In theory, I think one would check for hw channel number to
787
         * see if one is dealing with a GPS or other satellite, but the
788
         * channel numbers reported bear no resemblance to what the spec
789
         * says should be.  So I check for the fact that if all three
790
         * values below are zero, one is not interested in this satellite */
791
0
        if (!(ele == 0 && azm == 0 && dgps_age == 0)) {
792
0
            session->gpsdata.skyview[i].PRN = (short)prn;
793
0
            session->gpsdata.skyview[i].elevation = (double)ele;
794
0
            session->gpsdata.skyview[i].azimuth = (double)azm;
795
0
            s = session->gpsdata.skyview[i].ss =
796
0
                (p2_snr ? p2_snr : ca_snr) / 4.0;
797
0
            session->gpsdata.skyview[i++].used = (stat == 0xff);
798
0
            if (0xff == stat) {
799
0
                nsu++;
800
0
            }
801
0
        }
802
0
        session->gpsdata.satellites_used = nsu;
803
0
        GPSD_LOG(LOG_DATA, &session->context->errout,
804
0
                 "Navcom: prn = %3u, ele = %02u, azm = %03u, snr = %d (%s), "
805
0
                 "dgps age = %.1fs, log ch = %d, hw ch = 0x%02x\n",
806
0
                 prn, ele, azm, s, (p2_snr ? "P2" : "C/A"),
807
0
                 (double)dgps_age * 0.1, log_channel & 0x3f, hw_channel);
808
0
        GPSD_LOG(LOG_DATA, &session->context->errout,
809
0
                 "Navcom:           sol. valid = %c, clock = %s, pos. = %s, "
810
0
                 "height = %s, err. code = 0x%x\n",
811
0
                 ((sol_status & 0x01) ? 'Y' : 'N'),
812
0
                 ((sol_status & 0x02) ? "stable" : "unstable"),
813
0
                 ((sol_status & 0x04) ? "dgps" : "unaided"),
814
0
                 ((sol_status & 0x08) ? "solved" : "constrained"),
815
0
                 ((sol_status & 0x01) ? 0x00 : sol_status & 0x0f00 >> 8));
816
0
    }
817
818
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
819
0
             "CS 0x86: visible=%d, used=%d, mask={SATELLITE|STATUS}\n",
820
0
             session->gpsdata.satellites_visible,
821
0
             session->gpsdata.satellites_used);
822
0
    return SATELLITE_SET | STATUS_SET;
823
0
}
824
825
/* Raw Meas. Data Block
826
 * Size 4 + 8 + (16 * numSat) = 524
827
 */
828
static gps_mask_t handle_0xb0(struct gps_device_t *session)
829
0
{
830
0
    char ts_buf[TIMESPEC_LEN];
831
    /* L1 wavelength (299792458m/s / 1575420000Hz)
832
     * from their Technical reference Manual */
833
0
#define LAMBDA_L1 (299792458.0 / 1575420000.0)
834
0
    unsigned n;
835
0
    unsigned char *buf = session->lexer.outbuffer + 3;
836
0
    unsigned msg_len = getleu16(buf, 1);
837
0
    uint16_t week = getleu16(buf, 3);
838
0
    uint32_t tow = getleu32(buf, 5);
839
0
    uint8_t tm_slew_acc = getub(buf, 9);
840
0
    uint8_t status = getub(buf, 10);
841
842
0
    session->context->gps_week = (unsigned short)week;
843
0
    MSTOTS(&session->context->gps_tow, tow);
844
845
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
846
0
             "Navcom: received packet type 0xb0 (Raw Meas. Data Block)\n");
847
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
848
0
             "Navcom: week = %u, tow = %s "
849
0
             "time slew accumulator = %u (1/1023mS), status = 0x%02x "
850
0
             "(%sclock %s - %u blocks follow) msg_len %u\n",
851
0
             session->context->gps_week,
852
0
             timespec_str(&session->context->gps_tow, ts_buf, sizeof(ts_buf)),
853
0
             tm_slew_acc, status,
854
0
             ((status & 0x80) ? "channel time set - " : ""),
855
0
             ((status & 0x40) ? "stable" : "not stable"), status & 0x0f,
856
0
             msg_len);
857
858
0
    if (530 < msg_len) {
859
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
860
0
                 "Navcom: received packet type 0xb0, length %u too long\n",
861
0
                 msg_len);
862
0
        return 0;
863
0
    }
864
865
0
    for (n = 11; n < (msg_len - 1); n += 16) {
866
0
        uint8_t sv_status = getub(buf, n);
867
0
        uint8_t ch_status = getub(buf, n + 1);
868
0
        uint32_t ca_pseudorange = getleu32(buf, n + 2);
869
        // integer division by 16 is a sign-preserving right shift of 4 bits
870
0
        int32_t l1_phase = getles3224(buf, n + 6) / 16;
871
0
        uint8_t l1_slips = (uint8_t) (getles3224(buf, n + 6) & 0x0f);
872
0
        int16_t p1_ca_pseudorange = getles16(buf, n + 9);
873
0
        int16_t p2_ca_pseudorange = getles16(buf, n + 11);
874
0
        int32_t l2_phase = getles3224(buf, n + 13) / 16;
875
0
        uint8_t l2_slips = (uint8_t) (getles3224(buf, n + 13) & 0x0f);
876
0
        double c1 =
877
0
            ((sv_status & 0x80) ? (double)ca_pseudorange / 16.0 *
878
0
             LAMBDA_L1 : NAN);
879
0
        double l1 =
880
0
            ((sv_status & 0x80) ? (double)ca_pseudorange / 16.0 +
881
0
             (double)l1_phase / 256.0 : NAN);
882
0
        double l2 =
883
0
            ((sv_status & 0x20)
884
0
             ? ((double)ca_pseudorange / 16.0 +
885
0
                (double)p2_ca_pseudorange / 16.0) * (120.0 / 154.0)
886
0
             + (double)l2_phase / 256.0 : NAN);
887
0
        double p1 =
888
0
            ((sv_status & 0x40) ? c1 +
889
0
             (double)p1_ca_pseudorange / 16.0 * LAMBDA_L1 : NAN);
890
0
        double p2 =
891
0
            ((sv_status & 0x20) ? c1 +
892
0
             (double)p2_ca_pseudorange / 16.0 * LAMBDA_L1 : NAN);
893
0
        GPSD_LOG(LOG_SPIN, &session->context->errout,
894
0
                 "Navcom: >> sv status = 0x%02x (PRN %u - C/A & L1 %s "
895
0
                 "- P1 %s - P2 & L2 %s)\n",
896
0
                 sv_status, (sv_status & 0x1f),
897
0
                 ((sv_status & 0x80) ? "valid" : "invalid"),
898
0
                 ((sv_status & 0x40) ? "valid" : "invalid"),
899
0
                 ((sv_status & 0x20) ? "valid" : "invalid"));
900
0
        GPSD_LOG(LOG_SPIN, &session->context->errout,
901
0
                 "Navcom: >>> ch status = 0x%02x "
902
0
                 "(Logical channel: %u - CA C/No: %u dBHz) "
903
0
                 "sL1: %u, sL2: %u\n", ch_status, ch_status & 0x0f,
904
0
                 ((ch_status & 0xf0) >> 4) + 35, l1_slips, l2_slips);
905
0
        GPSD_LOG(LOG_SPIN, &session->context->errout,
906
0
                 "Navcom: >>> C1: %14.3f L1: %14.3f L2: %14.3f "
907
0
                 "P1: %14.3f P2: %14.3f\n",
908
0
                 c1, l1, l2, p1, p2);
909
0
    }
910
0
#undef LAMBDA_L1
911
0
    return 0;               // FIXME: use raw measurements
912
0
}
913
914
// Pseudorange Noise Statistics
915
static gps_mask_t handle_0xb5(struct gps_device_t *session)
916
0
{
917
0
    if (sizeof(double) == 8) {
918
0
        gps_mask_t mask = TIME_SET;
919
0
        char *buf = (char *)session->lexer.outbuffer + 3;
920
0
        uint16_t week = getleu16(buf, 3);
921
0
        uint32_t tow = getleu32(buf, 5);
922
0
        timespec_t ts_tow;
923
#ifdef __UNUSED__
924
        double rms = getled64(buf, 9);
925
        /* Reason why it's unused is these figures do not agree
926
         * with those obtained from the PVT report (handle_0xb1).
927
         * The figures from 0xb1 do agree with the values reported
928
         * by Navcom's PC utility */
929
        // let gpsd_error_model() handle this
930
        //double ellips_maj = getled64(buf, 17);
931
        //double ellips_min = getled64(buf, 25);
932
        //double ellips_azm = getled64(buf, 33);
933
        double lat_sd = getled64(buf, 41);
934
        double lon_sd = getled64(buf, 49);
935
        double alt_sd = getled64(buf, 57);
936
        double hrms = sqrt(pow(lat_sd, 2) + pow(lon_sd, 2));
937
        // Navcom doc unclear, this is likely sep?
938
        session->newdata.sep = rms * 1.96;
939
        session->newdata.eph = hrms * 1.96;
940
        session->newdata.epv = alt_sd * 1.96;
941
        mask |= HERR_SET;
942
#endif  //  __UNUSED__
943
0
        MSTOTS(&ts_tow, tow);
944
0
        session->newdata.time = gpsd_gpstime_resolv(session,
945
0
                                                  (unsigned short)week,
946
0
                                                  ts_tow);
947
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
948
0
                 "Navcom: received packet type 0xb5 (Pseudorange Noise Statistics)\n");
949
0
        GPSD_LOG(LOG_DATA, &session->context->errout,
950
0
                 "Navcom: sep = %f\n", session->newdata.sep);
951
0
        return mask;
952
0
    } else {
953
        // Ignore this message block
954
0
        if (!session->driver.navcom.warned) {
955
0
            GPSD_LOG(LOG_WARN, &session->context->errout,
956
0
                     "Navcom: received packet type 0xb5 (Pseudorange "
957
0
                     "Noise Statistics) ignored "
958
0
                     " - sizeof(double) == 64 bits required\n");
959
0
            session->driver.navcom.warned = true;
960
0
        }
961
0
        return 0;               // Block ignored - wrong sizeof(double)
962
0
    }
963
0
}
964
965
// LBM DSP Status Block
966
static gps_mask_t handle_0xd3(struct gps_device_t *session UNUSED)
967
0
{
968
    /* This block contains status information about the
969
     * unit's L-band (Inmarsat) module.  There is nothing
970
     * interesting in it for our purposes so we do not deal
971
     * with it.  This callback is purely to a) stop
972
     * "unrecognised packet" messages appearing in the log
973
     * and b) explain what it is for the curious */
974
0
    return 0;                   // Nothing updated
975
0
}
976
977
// Identification Block
978
static gps_mask_t handle_0xae(struct gps_device_t *session)
979
0
{
980
0
    char *engconfstr, *asicstr;
981
0
    unsigned char *buf = session->lexer.outbuffer + 3;
982
0
    size_t msg_len = (size_t) getleu16(buf, 1);
983
0
    uint8_t engconf = getub(buf, 3);
984
0
    uint8_t asic = getub(buf, 4);
985
0
    uint8_t swvermaj = getub(buf, 5);
986
0
    uint8_t swvermin = getub(buf, 6);
987
0
    uint16_t dcser = getleu16(buf, 7);
988
0
    uint8_t dcclass = getub(buf, 9);
989
0
    uint16_t rfcser = getleu16(buf, 10);
990
0
    uint8_t rfcclass = getub(buf, 12);
991
0
    uint8_t softtm[17] = {0};
992
0
    uint8_t bootstr[17] = {0};
993
0
    uint8_t ioptm[17] = {0};
994
0
    uint8_t iopvermaj = (uint8_t) 0x00;
995
0
    uint8_t iopvermin = (uint8_t) 0x00;
996
0
    uint8_t picver = (uint8_t) 0x00;
997
0
    uint8_t slsbn = (uint8_t) 0x00;
998
0
    uint8_t iopsbn = (uint8_t) 0x00;
999
1000
0
    memcpy(softtm, &buf[13], 16);
1001
0
    memcpy(bootstr, &buf[29], 16);
1002
0
    if (0x0037 == msg_len) {    // No IOP
1003
0
        slsbn = getub(buf, 53);
1004
0
    } else {                    // IOP Present
1005
0
        iopvermaj = getub(buf, 53);
1006
0
        iopvermin = getub(buf, 54);
1007
0
        memcpy(ioptm, &buf[55], 16);
1008
0
        picver = getub(buf, 71);
1009
0
        slsbn = getub(buf, 72);
1010
0
        iopsbn = getub(buf, 73);
1011
0
    }
1012
1013
0
    switch (engconf) {
1014
0
    case 0x00:
1015
0
        engconfstr = "Unknown/Undefined";
1016
0
        break;
1017
0
    case 0x01:
1018
0
        engconfstr = "NCT 2000 S";
1019
0
        break;
1020
0
    case 0x02:
1021
0
        engconfstr = "NCT 2000 D";
1022
0
        break;
1023
0
    case 0x03:
1024
0
        engconfstr = "Startfire Single";
1025
0
        break;
1026
0
    case 0x04:
1027
0
        engconfstr = "Starfire Dual";
1028
0
        break;
1029
0
    case 0x05:
1030
0
        engconfstr = "Pole Mount RTK (Internal Radio)";
1031
0
        break;
1032
0
    case 0x06:
1033
0
        engconfstr = "Pole Mount GIS (LBM)";
1034
0
        break;
1035
0
    case 0x07:
1036
0
        engconfstr = "Black Box RTK (Internal Radio)";
1037
0
        break;
1038
0
    case 0x08:
1039
0
        engconfstr = "Black Box GIS (LBM)";
1040
0
        break;
1041
0
    case 0x80:
1042
0
        engconfstr = "R100";
1043
0
        break;
1044
0
    case 0x81:
1045
0
        engconfstr = "R200";
1046
0
        break;
1047
0
    case 0x82:
1048
0
        engconfstr = "R210";
1049
0
        break;
1050
0
    case 0x83:
1051
0
        engconfstr = "R300";
1052
0
        break;
1053
0
    case 0x84:
1054
0
        engconfstr = "R310";
1055
0
        break;
1056
0
    default:
1057
0
        engconfstr = "?";
1058
0
    }
1059
1060
0
    switch (asic) {
1061
0
    case 0x01:
1062
0
        asicstr = "A-ASIC";
1063
0
        break;
1064
0
    case 0x02:
1065
0
        asicstr = "B-ASIC";
1066
0
        break;
1067
0
    case 0x03:
1068
0
        asicstr = "C-ASIC";
1069
0
        break;
1070
0
    case 0x04:
1071
0
        asicstr = "M-ASIC";
1072
0
        break;
1073
0
    default:
1074
0
        asicstr = "?";
1075
0
    }
1076
1077
0
    GPSD_LOG(LOG_PROG, &session->context->errout,
1078
0
             "Navcom: received packet type 0xae (Identification Block)\n");
1079
0
    if (0x0037 == msg_len) {
1080
0
        GPSD_LOG(LOG_INF, &session->context->errout, "Navcom: ID Data: "
1081
0
                 "%s %s Ver. %u.%u.%u, DC S/N: %u.%u, RF S/N: %u.%u, "
1082
0
                 "Build ID: %s, Boot software: %s\n",
1083
0
                 engconfstr, asicstr, swvermaj, swvermin, slsbn, dcser,
1084
0
                 dcclass, rfcser, rfcclass, softtm, bootstr);
1085
0
    } else {
1086
0
        GPSD_LOG(LOG_INF, &session->context->errout, "Navcom: ID Data: "
1087
0
                 "%s %s Ver. %u.%u.%u, DC S/N: %u.%u, RF S/N: %u.%u, "
1088
0
                 "Build ID: %s, Boot software: %s, "
1089
0
                 "IOP Ver.: %u.%u.%u, PIC: %u, IOP Build ID: %s\n",
1090
0
                 engconfstr, asicstr, swvermaj, swvermin, slsbn, dcser,
1091
0
                 dcclass, rfcser, rfcclass, softtm, bootstr, iopvermaj,
1092
0
                 iopvermin, iopsbn, picver, ioptm);
1093
0
    }
1094
1095
0
    (void)snprintf(session->subtype, sizeof(session->subtype),
1096
0
                   "%s %s Ver. %u.%u.%u S/N %u.%u %u.%u",
1097
0
                   engconfstr, asicstr, swvermaj, swvermin, slsbn, dcser,
1098
0
                   dcclass, rfcser, rfcclass);
1099
0
    return DEVICEID_SET;
1100
0
}
1101
1102
// Clock Drift and Offset
1103
static gps_mask_t handle_0xef(struct gps_device_t *session)
1104
0
{
1105
0
    unsigned char *buf = session->lexer.outbuffer + 3;
1106
    //uint16_t week = getleu16(buf, 3);
1107
    //uint32_t tow = getleu32(buf, 5);
1108
0
    int8_t osc_temp = getsb(buf, 9);
1109
0
    uint8_t nav_status = getub(buf, 10);
1110
0
    double nav_clock_offset;
1111
0
    float nav_clock_drift;
1112
0
    float osc_filter_drift_est;
1113
0
    char ts_buf[TIMESPEC_LEN];
1114
0
    int32_t time_slew = (int32_t) getles32(buf, 27);
1115
0
    if (sizeof(double) == 8) {
1116
0
        nav_clock_offset = getled64((char *)buf, 11);
1117
0
    } else {
1118
0
        nav_clock_offset = NAN;
1119
0
    }
1120
0
    if (sizeof(float) == 4) {
1121
0
        nav_clock_drift = getlef32((char *)buf, 19);
1122
0
        osc_filter_drift_est = getlef32((char *)buf, 23);
1123
0
    } else {
1124
0
        nav_clock_drift = NAN;
1125
0
        osc_filter_drift_est = NAN;
1126
0
    }
1127
1128
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
1129
0
             "Navcom: oscillator temp. = %d, nav. status = 0x%02x, "
1130
0
             "nav. clock offset = %f, nav. clock drift = %f, "
1131
0
             "osc. filter drift est. = %f, acc.time slew value = %d\n",
1132
0
             osc_temp, nav_status, nav_clock_offset, nav_clock_drift,
1133
0
             osc_filter_drift_est, time_slew);
1134
0
    GPSD_LOG(LOG_DATA, &session->context->errout,
1135
0
             "CDO 0xef: time=%s mask={TIME}\n",
1136
0
             timespec_str(&session->newdata.time, ts_buf, sizeof(ts_buf)));
1137
0
    return 0;
1138
0
}
1139
1140
1141
gps_mask_t navcom_parse(struct gps_device_t * session, unsigned char *buf,
1142
                        size_t len)
1143
0
{
1144
0
    unsigned char cmd_id;
1145
0
    unsigned msg_len;
1146
0
    unsigned bad_len = 0;
1147
0
    gps_mask_t mask = 0;
1148
1149
0
    if (7 > len) {
1150
        // min msg: STX, 0x99, 0x66, cmd_id, msg_len(2), ..., checksum
1151
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1152
0
                 "Navcom: too short, len %zu\n", len);
1153
0
        return 0;
1154
0
    }
1155
    // Navcom checksum already checked in gpsd/parser.c
1156
1157
0
    cmd_id = (unsigned char)getub(buf, 3);
1158
    //payload = &buf[6];
1159
0
    msg_len = getleu16(buf, 4);
1160
1161
0
    if (4 > msg_len ||
1162
0
        (msg_len + 4) > len) {
1163
        /* min payload: cmd_id, msg_len(2), cksum
1164
         * Fuzzers love to do this. */
1165
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1166
0
                 "Navcom: bad lenghts, msg_len %u len %zu\n", msg_len, len);
1167
0
        return 0;
1168
0
    }
1169
1170
0
    GPSD_LOG(LOG_RAW, &session->context->errout,
1171
0
             "Navcom: packet type x%02x msg_len %u len %zu\n",
1172
0
             cmd_id, msg_len, len);
1173
1174
0
    session->cycle_end_reliable = true;
1175
1176
0
    switch (cmd_id) {
1177
0
    case 0x06:
1178
0
        if (6 > msg_len) {
1179
0
            bad_len = 6;
1180
0
            break;
1181
0
        }
1182
0
        mask = handle_0x06(session);
1183
0
        break;
1184
0
    case 0x15:
1185
0
        if (6 > msg_len) {
1186
            // 6 + n * 2
1187
0
            bad_len = 6;
1188
0
            break;
1189
0
        }
1190
0
        mask = handle_0x15(session);
1191
0
        break;
1192
0
    case 0x81:    // Packed Ephemeris Data
1193
0
        if (86 > msg_len) {
1194
0
            bad_len = 86;
1195
0
            break;
1196
0
        }
1197
0
        mask = handle_0x81(session);
1198
0
        break;
1199
0
    case 0x83:
1200
0
        if (32 > msg_len) {
1201
0
            bad_len = 32;
1202
0
            break;
1203
0
        }
1204
0
        mask = handle_0x83(session);
1205
0
        break;
1206
0
    case 0x86:
1207
0
        if (18 > msg_len) {
1208
            // 18 + (14 * N)
1209
0
            bad_len = 18;
1210
0
            break;
1211
0
        }
1212
0
        mask = handle_0x86(session);
1213
0
        break;
1214
0
    case 0xae:
1215
0
        if (55 > msg_len ||
1216
0
            75 > msg_len) {
1217
0
            bad_len = 55;
1218
0
            break;
1219
0
        }
1220
0
        mask = handle_0xae(session);
1221
0
        break;
1222
0
    case 0xb0:
1223
0
        if (12 > msg_len) {
1224
            // 4 + 8 + (16 * N)
1225
0
            bad_len = 12;
1226
0
            break;
1227
0
        }
1228
0
        mask = handle_0xb0(session);
1229
0
        break;
1230
0
    case 0xb1:
1231
0
        if (86 > msg_len) {
1232
0
            bad_len = 86;
1233
0
            break;
1234
0
        }
1235
0
        mask = handle_0xb1(session);
1236
0
        break;
1237
0
    case 0xb5:
1238
0
        if (66 > msg_len) {
1239
0
            bad_len = 66;
1240
0
            break;
1241
0
        }
1242
0
        mask = handle_0xb5(session);
1243
0
        break;
1244
0
    case 0xd3:
1245
0
        if (70 > msg_len) {
1246
0
            bad_len = 70;
1247
0
            break;
1248
0
        }
1249
0
        mask = handle_0xd3(session);
1250
0
        break;
1251
0
    case 0xef:
1252
0
        if (32 > msg_len) {
1253
0
            bad_len = 32;
1254
0
            break;
1255
0
        }
1256
0
        mask = handle_0xef(session);
1257
0
        break;
1258
0
    case 0x44:    // Packed Almanac Loading
1259
0
        FALLTHROUGH
1260
0
    default:
1261
0
        GPSD_LOG(LOG_PROG, &session->context->errout,
1262
0
                 "Navcom: received packet type 0x%02x, msg_len %d - "
1263
0
                 "unknown or unimplemented\n",
1264
0
                 cmd_id, msg_len);
1265
0
        break;
1266
0
    }
1267
0
    if (bad_len) {
1268
0
        GPSD_LOG(LOG_WARN, &session->context->errout,
1269
0
                 "Navcom: %u: runt payload len %u s/b %zd",
1270
0
                 cmd_id, bad_len, session->lexer.outbuflen);
1271
0
    }
1272
0
    return mask;
1273
0
}
1274
1275
1276
static gps_mask_t navcom_parse_input(struct gps_device_t *session)
1277
0
{
1278
0
    if (NAVCOM_PACKET == session->lexer.type) {
1279
0
        return navcom_parse(session, session->lexer.outbuffer,
1280
0
                          session->lexer.outbuflen);
1281
0
    }
1282
0
    if (NMEA_PACKET == session->lexer.type) {
1283
0
        return nmea_parse((char *)session->lexer.outbuffer, session);
1284
0
    }
1285
0
    return 0;
1286
0
}
1287
1288
static ssize_t navcom_control_send(struct gps_device_t *session,
1289
                                   char *buf, size_t len)
1290
0
{
1291
0
    putbyte(session->msgbuf, 0, 0x02);
1292
0
    putbyte(session->msgbuf, 1, 0x99);
1293
0
    putbyte(session->msgbuf, 2, 0x66);
1294
0
    putbyte(session->msgbuf, 3, buf[0]);        // Cmd ID
1295
0
    putle16(session->msgbuf, 4, len + 4);       // Length
1296
0
    memcpy(session->msgbuf, buf + 6, len - 1);
1297
0
    putbyte(session->msgbuf, 6 + len,
1298
0
            checksum((unsigned char *)session->msgbuf + 3, len + 5));
1299
0
    putbyte(session->msgbuf, 7 + len, 0x03);
1300
0
    session->msgbuflen = len + 9;
1301
0
    return gpsd_write(session, session->msgbuf, session->msgbuflen);
1302
0
}
1303
1304
static bool navcom_speed(struct gps_device_t *session,
1305
                         speed_t speed, char parity, int stopbits)
1306
0
{
1307
    // parity and stopbit switching aren't implemented
1308
0
    if (parity != session->gpsdata.dev.parity
1309
0
        || stopbits != (int)session->gpsdata.dev.parity) {
1310
0
        return false;
1311
0
    } else {
1312
0
        uint8_t port, port_selection;
1313
0
        uint8_t baud;
1314
0
        if (session->driver.navcom.physical_port == (uint8_t) 0xFF) {
1315
            // We still don't know which port we're connected to
1316
0
            return false;
1317
0
        }
1318
0
        switch (speed) {
1319
            /* NOTE - The spec says that certain baud combinations
1320
             * on ports A and B are not allowed, those are
1321
             * 1200/115200, 2400/57600, and 2400/115200.
1322
             * To try and minimise the possibility of those
1323
             * occurring, we do not allow baud rates below
1324
             * 4800.  We could also disallow 57600 and 115200
1325
             * to totally prevent this, but I do not consider
1326
             * that reasonable.  Finding which baud speed the
1327
             * other port is set at would also be too much
1328
             * trouble, so we do not do it. */
1329
0
        case 4800:
1330
0
            baud = 0x04;
1331
0
            break;
1332
0
        case 9600:
1333
0
            baud = 0x06;
1334
0
            break;
1335
0
        case 19200:
1336
0
            baud = 0x08;
1337
0
            break;
1338
0
        case 38400:
1339
0
            baud = 0x0a;
1340
0
            break;
1341
0
        case 57600:
1342
0
            baud = 0x0c;
1343
0
            break;
1344
0
        case 115200:
1345
0
            baud = 0x0e;
1346
0
            break;
1347
0
        default:
1348
            // Unsupported speed
1349
0
            return false;
1350
0
        }
1351
1352
        // Proceed to construct our message
1353
0
        port = session->driver.navcom.physical_port;
1354
0
        port_selection = (port ? port : (uint8_t) 0xff) | baud;
1355
1356
        // Send it off
1357
0
        navcom_cmd_0x11(session, port_selection);
1358
1359
        /* And cheekily return true, even though we have
1360
         * no way to know if the speed change succeeded
1361
         * until and if we receive an ACK (message 0x06),
1362
         * which will be at the new baud speed if the
1363
         * command was successful.  Bottom line, the client
1364
         * should requery gpsd to see if the new speed is
1365
         * different than the old one */
1366
        return true;
1367
0
    }
1368
0
}
1369
1370
// this is everything we export
1371
// *INDENT-OFF*
1372
const struct gps_type_t driver_navcom =
1373
{
1374
    .type_name      = "Navcom NCT",             // full name of type
1375
    .packet_type    = NAVCOM_PACKET,            // lexer packet type
1376
    .flags          = DRIVER_STICKY,            // remember this
1377
    .trigger        = NULL,                     // none
1378
    .channels       = NAVCOM_CHANNELS,     // 12 L1 + 12 L2 + 2 Inmarsat L-Band
1379
    .probe_detect   = NULL,                     // no probe
1380
    .get_packet     = packet_get1,              // use generic one
1381
    .parse_packet   = navcom_parse_input,       // parse message packets
1382
    .rtcm_writer    = gpsd_write,               // send RTCM data straight
1383
    .init_query     = NULL,                     // non-perturbing query
1384
    .event_hook     = navcom_event_hook,        // lifetime event handler
1385
    .speed_switcher = navcom_speed,             // we do change baud rates
1386
    .mode_switcher  = NULL,                     // there is not a mode switcher
1387
    .rate_switcher  = NULL,                     // no sample-rate switcher
1388
    .min_cycle.tv_sec  = 1,             // not relevant, no rate switch
1389
    .min_cycle.tv_nsec = 0,             // not relevant, no rate switch
1390
    .control_send   = navcom_control_send,      // how to send a control string
1391
    .time_offset     = NULL,            // no method for NTP fudge factor
1392
};
1393
// *INDENT-ON*
1394
1395
#endif  // defined(NAVCOM_ENABLE)
1396
// vim: set expandtab shiftwidth=4