libosmocore  1.7.0.61-0d9b6.202211030053
Osmocom core library
gsmtap.h
Go to the documentation of this file.
1 
12 #pragma once
13 
14 #include <stdint.h>
15 
16 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
17 
18 /* The GSMTAP format definition is maintained in libosmocore,
19  * specifically the latest version can always be obtained from
20  * http://cgit.osmocom.org/cgit/libosmocore/tree/include/osmocom/core/gsmtap.h
21  *
22  * If you want to introduce new protocol/burst/channel types or extend
23  * GSMTAP in any way, please contact the GSMTAP maintainer at either the
24  * public openbsc@lists.osmocom.org mailing list, or privately at
25  * Harald Welte <laforge@gnumonks.org>.
26  *
27  * Your cooperation ensures that all projects will use the same GSMTAP
28  * definitions and remain compatible with each other.
29  */
30 
31 #define GSMTAP_VERSION 0x02
32 
33 #define GSMTAP_TYPE_UM 0x01
34 #define GSMTAP_TYPE_ABIS 0x02
35 #define GSMTAP_TYPE_UM_BURST 0x03 /* raw burst bits */
36 #define GSMTAP_TYPE_SIM 0x04 /* ISO 7816 smart card interface */
37 #define GSMTAP_TYPE_TETRA_I1 0x05 /* tetra air interface */
38 #define GSMTAP_TYPE_TETRA_I1_BURST 0x06 /* tetra air interface */
39 #define GSMTAP_TYPE_WMX_BURST 0x07 /* WiMAX burst */
40 #define GSMTAP_TYPE_GB_LLC 0x08 /* GPRS Gb interface: LLC */
41 #define GSMTAP_TYPE_GB_SNDCP 0x09 /* GPRS Gb interface: SNDCP */
42 #define GSMTAP_TYPE_GMR1_UM 0x0a /* GMR-1 L2 packets */
43 #define GSMTAP_TYPE_UMTS_RLC_MAC 0x0b
44 #define GSMTAP_TYPE_UMTS_RRC 0x0c
45 #define GSMTAP_TYPE_LTE_RRC 0x0d /* LTE interface */
46 #define GSMTAP_TYPE_LTE_MAC 0x0e /* LTE MAC interface */
47 #define GSMTAP_TYPE_LTE_MAC_FRAMED 0x0f /* LTE MAC with context hdr */
48 #define GSMTAP_TYPE_OSMOCORE_LOG 0x10 /* libosmocore logging */
49 #define GSMTAP_TYPE_QC_DIAG 0x11 /* Qualcomm DIAG frame */
50 #define GSMTAP_TYPE_LTE_NAS 0x12 /* LTE Non-Access Stratum */
51 #define GSMTAP_TYPE_E1T1 0x13 /* E1/T1 Lines */
52 
53 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
54 
55 /* sub-types for TYPE_UM_BURST */
56 #define GSMTAP_BURST_UNKNOWN 0x00
57 #define GSMTAP_BURST_FCCH 0x01
58 #define GSMTAP_BURST_PARTIAL_SCH 0x02
59 #define GSMTAP_BURST_SCH 0x03
60 #define GSMTAP_BURST_CTS_SCH 0x04
61 #define GSMTAP_BURST_COMPACT_SCH 0x05
62 #define GSMTAP_BURST_NORMAL 0x06
63 #define GSMTAP_BURST_DUMMY 0x07
64 #define GSMTAP_BURST_ACCESS 0x08
65 #define GSMTAP_BURST_NONE 0x09
66 /* WiMAX bursts */
67 #define GSMTAP_BURST_CDMA_CODE 0x10 /* WiMAX CDMA Code Attribute burst */
68 #define GSMTAP_BURST_FCH 0x11 /* WiMAX FCH burst */
69 #define GSMTAP_BURST_FFB 0x12 /* WiMAX Fast Feedback burst */
70 #define GSMTAP_BURST_PDU 0x13 /* WiMAX PDU burst */
71 #define GSMTAP_BURST_HACK 0x14 /* WiMAX HARQ ACK burst */
72 #define GSMTAP_BURST_PHY_ATTRIBUTES 0x15 /* WiMAX PHY Attributes burst */
73 
74 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
75 
76 /* sub-types for TYPE_UM */
77 #define GSMTAP_CHANNEL_UNKNOWN 0x00
78 #define GSMTAP_CHANNEL_BCCH 0x01
79 #define GSMTAP_CHANNEL_CCCH 0x02
80 #define GSMTAP_CHANNEL_RACH 0x03
81 #define GSMTAP_CHANNEL_AGCH 0x04
82 #define GSMTAP_CHANNEL_PCH 0x05
83 #define GSMTAP_CHANNEL_SDCCH 0x06
84 #define GSMTAP_CHANNEL_SDCCH4 0x07
85 #define GSMTAP_CHANNEL_SDCCH8 0x08
86 #define GSMTAP_CHANNEL_FACCH_F 0x09 /* Actually, it's FACCH/F (signaling) */
87 #define GSMTAP_CHANNEL_FACCH_H 0x0a /* Actually, it's FACCH/H (signaling) */
88 #define GSMTAP_CHANNEL_PACCH 0x0b
89 #define GSMTAP_CHANNEL_CBCH52 0x0c
90 #define GSMTAP_CHANNEL_PDTCH 0x0d
91 /* for legacy reasons we use a mis-spelled name. PDCH is really the physical channel, but we use it as PDTCH */
92 #define GSMTAP_CHANNEL_PDCH GSMTAP_CHANNEL_PDTCH
93 #define GSMTAP_CHANNEL_PTCCH 0x0e
94 #define GSMTAP_CHANNEL_CBCH51 0x0f
95 #define GSMTAP_CHANNEL_VOICE_F 0x10 /* voice codec payload (FR/EFR/AMR) */
96 #define GSMTAP_CHANNEL_VOICE_H 0x11 /* voice codec payload (HR/AMR) */
97 #define GSMTAP_CHANNEL_TCH_F GSMTAP_CHANNEL_FACCH_F /* We used the wrong naming in 2008 when we were young */
98 #define GSMTAP_CHANNEL_TCH_H GSMTAP_CHANNEL_FACCH_H /* We used the wrong naming in 2008 when we were young */
99 
100 /* GPRS Coding Scheme CS1..4 */
101 #define GSMTAP_GPRS_CS_BASE 0x20
102 #define GSMTAP_GPRS_CS(N) (GSMTAP_GPRS_CS_BASE + N)
103 /* (E) GPRS Coding Scheme MCS0..9 */
104 #define GSMTAP_GPRS_MCS_BASE 0x30
105 #define GSMTAP_GPRS_MCS(N) (GSMTAP_GPRS_MCS_BASE + N)
106 
107 #define GSMTAP_CHANNEL_ACCH 0x80
108 
109 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
110 
111 /* sub-types for GSMTAP_TYPE_SIM */
112 #define GSMTAP_SIM_APDU 0x00 /* APDU data (complete APDU) */
113 #define GSMTAP_SIM_ATR 0x01 /* card ATR data */
114 #define GSMTAP_SIM_PPS_REQ 0x02 /* PPS request data */
115 #define GSMTAP_SIM_PPS_RSP 0x03 /* PPS response data */
116 #define GSMTAP_SIM_TPDU_HDR 0x04 /* TPDU command header */
117 #define GSMTAP_SIM_TPDU_CMD 0x05 /* TPDU command body */
118 #define GSMTAP_SIM_TPDU_RSP 0x06 /* TPDU response body */
119 #define GSMTAP_SIM_TPDU_SW 0x07 /* TPDU response trailer */
121 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
123 /* sub-types for TYPE_TETRA_AIR */
124 #define GSMTAP_TETRA_BSCH 0x01
125 #define GSMTAP_TETRA_AACH 0x02
126 #define GSMTAP_TETRA_SCH_HU 0x03
127 #define GSMTAP_TETRA_SCH_HD 0x04
128 #define GSMTAP_TETRA_SCH_F 0x05
129 #define GSMTAP_TETRA_BNCH 0x06
130 #define GSMTAP_TETRA_STCH 0x07
131 #define GSMTAP_TETRA_TCH_F 0x08
132 #define GSMTAP_TETRA_DMO_SCH_S 0x09
133 #define GSMTAP_TETRA_DMO_SCH_H 0x0a
134 #define GSMTAP_TETRA_DMO_SCH_F 0x0b
135 #define GSMTAP_TETRA_DMO_STCH 0x0c
136 #define GSMTAP_TETRA_DMO_TCH 0x0d
137 
138 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
139 
140 /* sub-types for TYPE_GMR1_UM */
141 #define GSMTAP_GMR1_UNKNOWN 0x00
142 #define GSMTAP_GMR1_BCCH 0x01
143 #define GSMTAP_GMR1_CCCH 0x02 /* either AGCH or PCH */
144 #define GSMTAP_GMR1_PCH 0x03
145 #define GSMTAP_GMR1_AGCH 0x04
146 #define GSMTAP_GMR1_BACH 0x05
147 #define GSMTAP_GMR1_RACH 0x06
148 #define GSMTAP_GMR1_CBCH 0x07
149 #define GSMTAP_GMR1_SDCCH 0x08
150 #define GSMTAP_GMR1_TACCH 0x09
151 #define GSMTAP_GMR1_GBCH 0x0a
152 
153 #define GSMTAP_GMR1_SACCH 0x01 /* to be combined with _TCH{6,9} */
154 #define GSMTAP_GMR1_FACCH 0x02 /* to be combines with _TCH{3,6,9} */
155 #define GSMTAP_GMR1_DKAB 0x03 /* to be combined with _TCH3 */
156 #define GSMTAP_GMR1_TCH3 0x10
157 #define GSMTAP_GMR1_TCH6 0x14
158 #define GSMTAP_GMR1_TCH9 0x18
159 
160 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
161 
162 #define GSMTAP_UMTS_CH_PCCH 0x01
163 #define GSMTAP_UMTS_CH_CCCH 0x02
164 #define GSMTAP_UMTS_CH_DCCH 0x03
165 
166 /* sub-types for TYPE_LTE_RRC */
167 #define GSMTAP_LTE_CH_BCCH 0x01
168 #define GSMTAP_LTE_CH_CCCH 0x02
169 #define GSMTAP_LTE_CH_DCCH 0x03
170 #define GSMTAP_LTE_CH_MCCH 0x04
171 #define GSMTAP_LTE_CH_PCCH 0x05
172 #define GSMTAP_LTE_CH_DTCH 0x06
173 #define GSMTAP_LTE_CH_MTCH 0x07
174 
175 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
176 /* sub-types for TYPE_E1T1 */
177 #define GSMTAP_E1T1_LAPD 0x01 /* Q.921 LAPD */
178 #define GSMTAP_E1T1_FR 0x02 /* Frame Relay */
179 #define GSMTAP_E1T1_RAW 0x03 /* raw/transparent B-channel */
180 #define GSMTAP_E1T1_TRAU16 0x04 /* 16k TRAU frames; sub-slot 0-3 */
181 #define GSMTAP_E1T1_TRAU8 0x05 /* 8k TRAU frames; sub-slot 0-7 */
182 
183 /* flags for the ARFCN */
184 #define GSMTAP_ARFCN_F_PCS 0x8000
185 #define GSMTAP_ARFCN_F_UPLINK 0x4000
186 #define GSMTAP_ARFCN_MASK 0x3fff
187 
188 /* IANA-assigned well-known UDP port for GSMTAP messages */
189 #define GSMTAP_UDP_PORT 4729
190 
191 /* UMTS RRC message types */
192 enum {
255 
257 };
258 
259 /* LTE RRC message types */
260 enum {
284 
286 };
287 
288 /* LTE NAS message types */
289 enum {
292 
294 };
295 
296 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
298 struct gsmtap_hdr {
299  uint8_t version;
300  uint8_t hdr_len;
301  uint8_t type;
302  uint8_t timeslot;
304  uint16_t arfcn;
305  int8_t signal_dbm;
306  int8_t snr_db;
308  uint32_t frame_number;
310  uint8_t sub_type;
311  uint8_t antenna_nr;
312  uint8_t sub_slot;
313  uint8_t res;
315 } __attribute__((packed));
316 
319  struct {
320  uint32_t sec;
321  uint32_t usec;
322  } ts;
323  char proc_name[16];
324  uint32_t pid;
325  uint8_t level;
326  uint8_t _pad[3];
327  /* TODO: color */
328  char subsys[16];
329  struct {
330  char name[32];
331  uint32_t line_nr;
332  } src_file;
333 } __attribute__((packed));
334 
346  /* TODO: Revisit the types below; their usage; ... */
356 };
uint16_t arfcn
ARFCN (frequency)
Definition: gsmtap.h:304
Definition: gsmtap.h:199
uint8_t _pad[3]
Definition: gsmtap.h:127
Definition: gsmtap.h:230
uint8_t hdr_len
length in number of 32bit words
Definition: gsmtap.h:300
uint8_t level
logging level
Definition: gsmtap.h:325
Definition: gsmtap.h:242
Definition: gsmtap.h:349
Definition: gsmtap.h:197
Definition: gsmtap.h:213
Definition: gsmtap.h:231
uint32_t line_nr
line number
Definition: gsmtap.h:331
Definition: gsmtap.h:263
Definition: gsmtap.h:239
uint8_t version
version, set to 0x01 currently
Definition: gsmtap.h:299
char subsys[16]
logging sub-system
Definition: gsmtap.h:129
Definition: gsmtap.h:215
Definition: gsmtap.h:354
Definition: gsmtap.h:198
Definition: gsmtap.h:237
Definition: gsmtap.h:201
Definition: gsmtap.h:247
gsmtap_um_voice_type
First byte of type==GSMTAP_TYPE_UM sub_type==GSMTAP_CHANNEL_VOICE payload.
Definition: gsmtap.h:336
Definition: gsmtap.h:285
Definition: gsmtap.h:241
int8_t signal_dbm
signal level in dBm
Definition: gsmtap.h:305
uint32_t frame_number
GSM Frame Number (FN)
Definition: gsmtap.h:308
Definition: gsmtap.h:353
Definition: gsmtap.h:249
Definition: gsmtap.h:261
Definition: gsmtap.h:220
Definition: gsmtap.h:248
Definition: gsmtap.h:225
uint8_t sub_slot
sub-slot within timeslot
Definition: gsmtap.h:312
Definition: gsmtap.h:250
uint32_t pid
process ID
Definition: gsmtap.h:324
char name[32]
source file name
Definition: gsmtap.h:131
Definition: gsmtap.h:272
Definition: gsmtap.h:352
Definition: gsmtap.h:202
Definition: gsmtap.h:238
Definition: gsmtap.h:226
Definition: gsmtap.h:214
Definition: gsmtap.h:234
Definition: gsmtap.h:216
33 payload bytes; Reference is RFC3551 Section 4.5.8.1
Definition: gsmtap.h:341
enum gsmtap_um_voice_type __attribute__
Definition: gsmtap.h:265
Definition: gsmtap.h:348
Definition: gsmtap.h:195
1 byte TOC + 112 bits (14 octets) = 15 octets payload; Reference is RFC5993 Section 5...
Definition: gsmtap.h:339
Definition: gsmtap.h:350
Definition: gsmtap.h:256
struct @7 src_file
uint8_t timeslot
timeslot (0..7 on Um)
Definition: gsmtap.h:302
Definition: gsmtap.h:267
Definition: gsmtap.h:210
uint8_t sub_type
Type of burst/channel, see above.
Definition: gsmtap.h:310
Definition: gsmtap.h:244
Definition: gsmtap.h:293
Definition: gsmtap.h:217
Definition: gsmtap.h:243
uint32_t sec
Definition: gsmtap.h:320
Definition: gsmtap.h:196
Definition: gsmtap.h:219
Definition: gsmtap.h:236
Definition: gsmtap.h:282
char proc_name[16]
name of process
Definition: gsmtap.h:124
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:301
Definition: gsmtap.h:233
Definition: gsmtap.h:221
Definition: gsmtap.h:227
Definition: gsmtap.h:251
Definition: gsmtap.h:253
uint8_t antenna_nr
Antenna Number.
Definition: gsmtap.h:311
Definition: gsmtap.h:200
Definition: gsmtap.h:218
Definition: gsmtap.h:262
Definition: gsmtap.h:246
Definition: gsmtap.h:229
Definition: gsmtap.h:232
Definition: gsmtap.h:228
Definition: gsmtap.h:240
Definition: gsmtap.h:212
Definition: gsmtap.h:291
31 payload bytes; Reference is RFC3551 Section 4.5.9 + ETSI TS 101 318
Definition: gsmtap.h:343
Definition: gsmtap.h:264
Definition: gsmtap.h:245
Definition: gsmtap.h:351
Definition: gsmtap.h:252
Structure of the GSMTAP pseudo-header.
Definition: gsmtap.h:298
struct @6 ts
uint8_t res
reserved for future use (RFU)
Definition: gsmtap.h:313
1 byte TOC + 5..31 bytes = 6..32 bytes payload; RFC4867 octet-aligned
Definition: gsmtap.h:345
Definition: gsmtap.h:347
Definition: gsmtap.h:355
Definition: gsmtap.h:290
Definition: gsmtap.h:223
Structure of the GSMTAP libosmocore logging header.
Definition: gsmtap.h:318
uint32_t usec
Definition: gsmtap.h:321
Definition: gsmtap.h:203
Definition: gsmtap.h:193
Definition: gsmtap.h:194
Definition: gsmtap.h:268
Definition: gsmtap.h:211
int8_t snr_db
signal/noise ratio in dB
Definition: gsmtap.h:306
Definition: gsmtap.h:235
Definition: gsmtap.h:205
Definition: gsmtap.h:206
Definition: gsmtap.h:222
Definition: gsmtap.h:224