blob: fe2fdfe4cd0818eb35d102c35a6d3e11b2b9a6d7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
|
/* $Id$ */
#ifndef _GPSD_RTCM2_H_
#define _GPSD_RTCM2_H_
/*****************************************************************************
This is a decoder for RTCM-104 2.x, an obscure and complicated serial
protocol used for broadcasting pseudorange corrections from
differential-GPS reference stations. The applicable
standard is
RTCM RECOMMENDED STANDARDS FOR DIFFERENTIAL NAVSTAR GPS SERVICE,
RTCM PAPER 194-93/SC 104-STD
Ordering instructions are accessible from <http://www.rtcm.org/>
under "Publications". This describes version 2.1 of the RTCM specification.
RTCM-104 was later incrementally revised up to a 2.3 level before being
completely redesigned as level 3.0.
Also applicable is ITU-R M.823: "Technical characteristics of
differential transmissions for global navigation satellite systems
from maritime radio beacons in the frequency band 283.5 - 315 kHz in
region 1 and 285 - 325 kHz in regions 2 & 3."
The RTCM 2.x protocol uses as a transport layer the GPS satellite
downlink protocol described in IS-GPS-200, the Navstar GPS Interface
Specification. This code relies on the lower-level packet-assembly
code for that protocol in isgps.c.
The lower layer's job is done when it has assembled a message of up to
33 words of clean parity-checked data. At this point this upper layer
takes over. struct rtcm2_msg_t is overlaid on the buffer and the bitfields
are used to extract pieces of it. Those pieces are copied and (where
necessary) reassembled into a struct rtcm2_t.
This code and the contents of isgps.c are evolved from code by Wolfgang
Rupprecht. Wolfgang's decoder was loosely based on one written by
John Sager in 1999 (in particular the dump function emits a close
descendant of Sager's dump format). Here are John Sager's original
notes:
The RTCM decoder prints a legible representation of the input data.
The RTCM SC-104 specification is copyrighted, so I cannot
quote it - in fact, I have never read it! Most of the information
used to develop the decoder came from publication ITU-R M.823.
This is a specification of the data transmitted from LF DGPS
beacons in the 300kHz band. M.823 contains most of those parts of
RTCM SC-104 directly relevant to the air interface (there
are one or two annoying and vital omissions!). Information
about the serial interface format was gleaned from studying
the output of a beacon receiver test program made available on
Starlink's website.
*****************************************************************************/
/*
* Structures for interpreting words in an RTCM-104 2.x message (after
* parity checking and removing inversion). Note, these structures
* are overlayed on the raw data in order to decode them into
* bitfields; this will fail horribly if your C compiler ever
* introduces padding between or before bit fields, or between
* 8-bit-aligned bitfields and character arrays.
*
* (In practice, the only class of machines on which this is likely
* to fail are word-aligned architectures without barrel shifters.
* Very few of these are left in 2008.)
*
* The RTCM 2.1 standard is less explicit than it should be about signed-integer
* representations. Two's complement is specified for prc and rrc (msg1wX),
* but not everywhere.
*/
#define ZCOUNT_SCALE 0.6 /* sec */
#define PCSMALL 0.02 /* meters */
#define PCLARGE 0.32 /* meters */
#define RRSMALL 0.002 /* meters/sec */
#define RRLARGE 0.032 /* meters/sec */
#define MAXPCSMALL (0x7FFF * PCSMALL) /* 16-bits signed */
#define MAXRRSMALL (0x7F * RRSMALL) /* 8-bits signed */
#define XYZ_SCALE 0.01 /* meters */
#define DXYZ_SCALE 0.1 /* meters */
#define LA_SCALE (90.0/32767.0) /* degrees */
#define LO_SCALE (180.0/32767.0) /* degrees */
#define FREQ_SCALE 0.1 /* kHz */
#define FREQ_OFFSET 190.0 /* kHz */
#define CNR_OFFSET 24 /* dB */
#define TU_SCALE 5 /* minutes */
#pragma pack(1)
#ifndef WORDS_BIGENDIAN /* little-endian, like x86 */
struct rtcm2_msg_t {
struct rtcm2_msghw1 { /* header word 1 */
uint parity:6;
uint refstaid:10; /* reference station ID */
uint msgtype:6; /* RTCM message type */
uint preamble:8; /* fixed at 01100110 */
uint _pad:2;
} w1;
struct rtcm2_msghw2 { /* header word 2 */
uint parity:6;
uint stathlth:3; /* station health */
uint frmlen:5;
uint sqnum:3;
uint zcnt:13;
uint _pad:2;
} w2;
union {
/* msg 1 - differential gps corrections */
struct rtcm2_msg1 {
struct b_correction_t {
struct { /* msg 1 word 3 */
uint parity:6;
int pc1:16;
uint satident1:5; /* satellite ID */
uint udre1:2;
uint scale1:1;
uint _pad:2;
} w3;
struct { /* msg 1 word 4 */
uint parity:6;
uint satident2:5; /* satellite ID */
uint udre2:2;
uint scale2:1;
uint issuedata1:8;
int rangerate1:8;
uint _pad:2;
} w4;
struct { /* msg 1 word 5 */
uint parity:6;
int rangerate2:8;
int pc2:16;
uint _pad:2;
} w5;
struct { /* msg 1 word 6 */
uint parity:6;
int pc3_h:8;
uint satident3:5; /* satellite ID */
uint udre3:2;
uint scale3:1;
uint issuedata2:8;
uint _pad:2;
} w6;
struct { /* msg 1 word 7 */
uint parity:6;
uint issuedata3:8;
int rangerate3:8;
uint pc3_l:8; /* NOTE: uint for low byte */
uint _pad:2;
} w7;
} corrections[(RTCM2_WORDS_MAX - 2) / 5];
} type1;
/* msg 3 - reference station parameters */
struct rtcm2_msg3 {
struct {
uint parity:6;
uint x_h:24;
uint _pad:2;
} w3;
struct {
uint parity:6;
uint y_h:16;
uint x_l:8;
uint _pad:2;
} w4;
struct {
uint parity:6;
uint z_h:8;
uint y_l:16;
uint _pad:2;
} w5;
struct {
uint parity:6;
uint z_l:24;
uint _pad:2;
} w6;
} type3;
/* msg 4 - reference station datum */
struct rtcm2_msg4 {
struct {
uint parity:6;
uint datum_alpha_char2:8;
uint datum_alpha_char1:8;
uint spare:4;
uint dat:1;
uint dgnss:3;
uint _pad:2;
} w3;
struct {
uint parity:6;
uint datum_sub_div_char2:8;
uint datum_sub_div_char1:8;
uint datum_sub_div_char3:8;
uint _pad:2;
} w4;
struct {
uint parity:6;
uint dy_h:8;
uint dx:16;
uint _pad:2;
} w5;
struct {
uint parity:6;
uint dz:24;
uint dy_l:8;
uint _pad:2;
} w6;
} type4;
/* msg 5 - constellation health */
struct rtcm2_msg5 {
struct b_health_t {
uint parity:6;
uint unassigned:2;
uint time_unhealthy:4;
uint loss_warn:1;
uint new_nav_data:1;
uint health_enable:1;
uint cn0:5;
uint data_health:3;
uint issue_of_data_link:1;
uint sat_id:5;
uint reserved:1;
uint _pad:2;
} health[MAXHEALTH];
} type5;
/* msg 6 - null message */
/* msg 7 - beacon almanac */
struct rtcm2_msg7 {
struct b_station_t {
struct {
uint parity:6;
int lon_h:8;
int lat:16;
uint _pad:2;
} w3;
struct {
uint parity:6;
uint freq_h:6;
uint range:10;
uint lon_l:8;
uint _pad:2;
} w4;
struct {
uint parity:6;
uint encoding:1;
uint sync_type:1;
uint mod_mode:1;
uint bit_rate:3;
/*
* ITU-R M.823-2 page 9 and RTCM-SC104 v2.1 pages
* 4-21 and 4-22 are in conflict over the next two
* field sizes. ITU says 9+3, RTCM says 10+2.
* The latter correctly decodes the USCG station
* id's so I'll use that one here. -wsr
*/
uint station_id:10;
uint health:2;
uint freq_l:6;
uint _pad:2;
} w5;
} almanac[(RTCM2_WORDS_MAX - 2)/3];
} type7;
/* msg 16 - text msg */
struct rtcm2_msg16 {
struct {
uint parity:6;
uint byte3:8;
uint byte2:8;
uint byte1:8;
uint _pad:2;
} txt[RTCM2_WORDS_MAX-2];
} type16;
/* unknown message */
isgps30bits_t rtcm2_msgunk[RTCM2_WORDS_MAX-2];
} msg_type;
};
#endif /* LITTLE_ENDIAN */
#ifdef WORDS_BIGENDIAN
/* This struct was generated from the above using invert-bitfields.pl */
#ifndef S_SPLINT_S /* splint thinks it's a duplicate definition */
struct rtcm2_msg_t {
struct rtcm2_msghw1 { /* header word 1 */
uint _pad:2;
uint preamble:8; /* fixed at 01100110 */
uint msgtype:6; /* RTCM message type */
uint refstaid:10; /* reference station ID */
uint parity:6;
} w1;
struct rtcm2_msghw2 { /* header word 2 */
uint _pad:2;
uint zcnt:13;
uint sqnum:3;
uint frmlen:5;
uint stathlth:3; /* station health */
uint parity:6;
} w2;
union {
/* msg 1 - differential gps corrections */
struct rtcm2_msg1 {
struct b_correction_t {
struct { /* msg 1 word 3 */
uint _pad:2;
uint scale1:1;
uint udre1:2;
uint satident1:5; /* satellite ID */
int pc1:16;
uint parity:6;
} w3;
struct { /* msg 1 word 4 */
uint _pad:2;
int rangerate1:8;
uint issuedata1:8;
uint scale2:1;
uint udre2:2;
uint satident2:5; /* satellite ID */
uint parity:6;
} w4;
struct { /* msg 1 word 5 */
uint _pad:2;
int pc2:16;
int rangerate2:8;
uint parity:6;
} w5;
struct { /* msg 1 word 6 */
uint _pad:2;
uint issuedata2:8;
uint scale3:1;
uint udre3:2;
uint satident3:5; /* satellite ID */
int pc3_h:8;
uint parity:6;
} w6;
struct { /* msg 1 word 7 */
uint _pad:2;
uint pc3_l:8; /* NOTE: uint for low byte */
int rangerate3:8;
uint issuedata3:8;
uint parity:6;
} w7;
} corrections[(RTCM2_WORDS_MAX - 2) / 5];
} type1;
/* msg 3 - reference station parameters */
struct rtcm2_msg3 {
struct {
uint _pad:2;
uint x_h:24;
uint parity:6;
} w3;
struct {
uint _pad:2;
uint x_l:8;
uint y_h:16;
uint parity:6;
} w4;
struct {
uint _pad:2;
uint y_l:16;
uint z_h:8;
uint parity:6;
} w5;
struct {
uint _pad:2;
uint z_l:24;
uint parity:6;
} w6;
} type3;
/* msg 4 - reference station datum */
struct rtcm2_msg4 {
struct {
uint _pad:2;
uint dgnss:3;
uint dat:1;
uint spare:4;
uint datum_alpha_char1:8;
uint datum_alpha_char2:8;
uint parity:6;
} w3;
struct {
uint _pad:2;
uint datum_sub_div_char3:8;
uint datum_sub_div_char1:8;
uint datum_sub_div_char2:8;
uint parity:6;
} w4;
struct {
uint _pad:2;
uint dx:16;
uint dy_h:8;
uint parity:6;
} w5;
struct {
uint _pad:2;
uint dy_l:8;
uint dz:24;
uint parity:6;
} w6;
} type4;
/* msg 5 - constellation health */
struct rtcm2_msg5 {
struct b_health_t {
uint _pad:2;
uint reserved:1;
uint sat_id:5;
uint issue_of_data_link:1;
uint data_health:3;
uint cn0:5;
uint health_enable:1;
uint new_nav_data:1;
uint loss_warn:1;
uint time_unhealthy:4;
uint unassigned:2;
uint parity:6;
} health[MAXHEALTH];
} type5;
/* msg 6 - null message */
/* msg 7 - beacon almanac */
struct rtcm2_msg7 {
struct b_station_t {
struct {
uint _pad:2;
int lat:16;
int lon_h:8;
uint parity:6;
} w3;
struct {
uint _pad:2;
uint lon_l:8;
uint range:10;
uint freq_h:6;
uint parity:6;
} w4;
struct {
uint _pad:2;
uint freq_l:6;
uint health:2;
uint station_id:10;
/* see comments in LE struct above. */
uint bit_rate:3;
uint mod_mode:1;
uint sync_type:1;
uint encoding:1;
uint parity:6;
} w5;
} almanac[(RTCM2_WORDS_MAX - 2)/3];
} type7;
/* msg 16 - text msg */
struct rtcm2_msg16 {
struct {
uint _pad:2;
uint byte1:8;
uint byte2:8;
uint byte3:8;
uint parity:6;
} txt[RTCM2_WORDS_MAX-2];
} type16;
/* unknown message */
isgps30bits_t rtcm2_msgunk[RTCM2_WORDS_MAX-2];
} msg_type;
};
#endif /* S_SPLINT_S */
#endif /* BIG ENDIAN */
#endif /* _GPSD_RTCM2_H_ */
|