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
|
/*! \file gsmtap.h
* gsmtap header, pseudo-header in front of the actua GSM payload.
* GSMTAP is a generic header format for GSM protocol captures,
* it uses the IANA-assigned UDP port number 4729 and carries
* payload in various formats of GSM interfaces such as Um MAC
* blocks or Um bursts.
*
* Example programs generating GSMTAP data are airprobe
* (http://airprobe.org/) or OsmocomBB (http://bb.osmocom.org/)
*/
#pragma once
#include <stdint.h>
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/* The GSMTAP format definition is maintained in libosmocore,
* specifically the latest version can always be obtained from
* http://cgit.osmocom.org/cgit/libosmocore/tree/include/osmocom/core/gsmtap.h
*
* If you want to introduce new protocol/burst/channel types or extend
* GSMTAP in any way, please contact the GSMTAP maintainer at either the
* public openbsc@lists.osmocom.org mailing list, or privately at
* Harald Welte <laforge@gnumonks.org>.
*
* Your cooperation ensures that all projects will use the same GSMTAP
* definitions and remain compatible with each other.
*/
#define GSMTAP_VERSION 0x02
#define GSMTAP_TYPE_UM 0x01
#define GSMTAP_TYPE_ABIS 0x02
#define GSMTAP_TYPE_UM_BURST 0x03 /* raw burst bits */
#define GSMTAP_TYPE_SIM 0x04
#define GSMTAP_TYPE_TETRA_I1 0x05 /* tetra air interface */
#define GSMTAP_TYPE_TETRA_I1_BURST 0x06 /* tetra air interface */
#define GSMTAP_TYPE_WMX_BURST 0x07 /* WiMAX burst */
#define GSMTAP_TYPE_GB_LLC 0x08 /* GPRS Gb interface: LLC */
#define GSMTAP_TYPE_GB_SNDCP 0x09 /* GPRS Gb interface: SNDCP */
#define GSMTAP_TYPE_GMR1_UM 0x0a /* GMR-1 L2 packets */
#define GSMTAP_TYPE_UMTS_RLC_MAC 0x0b
#define GSMTAP_TYPE_UMTS_RRC 0x0c
#define GSMTAP_TYPE_LTE_RRC 0x0d /* LTE interface */
#define GSMTAP_TYPE_LTE_MAC 0x0e /* LTE MAC interface */
#define GSMTAP_TYPE_LTE_MAC_FRAMED 0x0f /* LTE MAC with context hdr */
#define GSMTAP_TYPE_OSMOCORE_LOG 0x10 /* libosmocore logging */
#define GSMTAP_TYPE_QC_DIAG 0x11 /* Qualcomm DIAG frame */
#define GSMTAP_TYPE_LTE_NAS 0x12 /* LTE Non-Access Stratum */
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/* sub-types for TYPE_UM_BURST */
#define GSMTAP_BURST_UNKNOWN 0x00
#define GSMTAP_BURST_FCCH 0x01
#define GSMTAP_BURST_PARTIAL_SCH 0x02
#define GSMTAP_BURST_SCH 0x03
#define GSMTAP_BURST_CTS_SCH 0x04
#define GSMTAP_BURST_COMPACT_SCH 0x05
#define GSMTAP_BURST_NORMAL 0x06
#define GSMTAP_BURST_DUMMY 0x07
#define GSMTAP_BURST_ACCESS 0x08
#define GSMTAP_BURST_NONE 0x09
/* WiMAX bursts */
#define GSMTAP_BURST_CDMA_CODE 0x10 /* WiMAX CDMA Code Attribute burst */
#define GSMTAP_BURST_FCH 0x11 /* WiMAX FCH burst */
#define GSMTAP_BURST_FFB 0x12 /* WiMAX Fast Feedback burst */
#define GSMTAP_BURST_PDU 0x13 /* WiMAX PDU burst */
#define GSMTAP_BURST_HACK 0x14 /* WiMAX HARQ ACK burst */
#define GSMTAP_BURST_PHY_ATTRIBUTES 0x15 /* WiMAX PHY Attributes burst */
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/* sub-types for TYPE_UM */
#define GSMTAP_CHANNEL_UNKNOWN 0x00
#define GSMTAP_CHANNEL_BCCH 0x01
#define GSMTAP_CHANNEL_CCCH 0x02
#define GSMTAP_CHANNEL_RACH 0x03
#define GSMTAP_CHANNEL_AGCH 0x04
#define GSMTAP_CHANNEL_PCH 0x05
#define GSMTAP_CHANNEL_SDCCH 0x06
#define GSMTAP_CHANNEL_SDCCH4 0x07
#define GSMTAP_CHANNEL_SDCCH8 0x08
#define GSMTAP_CHANNEL_TCH_F 0x09
#define GSMTAP_CHANNEL_TCH_H 0x0a
#define GSMTAP_CHANNEL_PACCH 0x0b
#define GSMTAP_CHANNEL_CBCH52 0x0c
#define GSMTAP_CHANNEL_PDTCH 0x0d
/* for legacy reasons we use a mis-spelled name. PDCH is really the physical channel, but we use it as PDTCH */
#define GSMTAP_CHANNEL_PDCH GSMTAP_CHANNEL_PDTCH
#define GSMTAP_CHANNEL_PTCCH 0x0e
#define GSMTAP_CHANNEL_CBCH51 0x0f
/* GPRS Coding Scheme CS1..4 */
#define GSMTAP_GPRS_CS_BASE 0x20
#define GSMTAP_GPRS_CS(N) (GSMTAP_GPRS_CS_BASE + N)
/* (E) GPRS Coding Scheme MCS0..9 */
#define GSMTAP_GPRS_MCS_BASE 0x30
#define GSMTAP_GPRS_MCS(N) (GSMTAP_GPRS_MCS_BASE + N)
#define GSMTAP_CHANNEL_ACCH 0x80
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/* sub-types for TYPE_TETRA_AIR */
#define GSMTAP_TETRA_BSCH 0x01
#define GSMTAP_TETRA_AACH 0x02
#define GSMTAP_TETRA_SCH_HU 0x03
#define GSMTAP_TETRA_SCH_HD 0x04
#define GSMTAP_TETRA_SCH_F 0x05
#define GSMTAP_TETRA_BNCH 0x06
#define GSMTAP_TETRA_STCH 0x07
#define GSMTAP_TETRA_TCH_F 0x08
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/* sub-types for TYPE_GMR1_UM */
#define GSMTAP_GMR1_UNKNOWN 0x00
#define GSMTAP_GMR1_BCCH 0x01
#define GSMTAP_GMR1_CCCH 0x02 /* either AGCH or PCH */
#define GSMTAP_GMR1_PCH 0x03
#define GSMTAP_GMR1_AGCH 0x04
#define GSMTAP_GMR1_BACH 0x05
#define GSMTAP_GMR1_RACH 0x06
#define GSMTAP_GMR1_CBCH 0x07
#define GSMTAP_GMR1_SDCCH 0x08
#define GSMTAP_GMR1_TACCH 0x09
#define GSMTAP_GMR1_GBCH 0x0a
#define GSMTAP_GMR1_SACCH 0x01 /* to be combined with _TCH{6,9} */
#define GSMTAP_GMR1_FACCH 0x02 /* to be combines with _TCH{3,6,9} */
#define GSMTAP_GMR1_DKAB 0x03 /* to be combined with _TCH3 */
#define GSMTAP_GMR1_TCH3 0x10
#define GSMTAP_GMR1_TCH6 0x14
#define GSMTAP_GMR1_TCH9 0x18
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
#define GSMTAP_UMTS_CH_PCCH 0x01
#define GSMTAP_UMTS_CH_CCCH 0x02
#define GSMTAP_UMTS_CH_DCCH 0x03
/* sub-types for TYPE_LTE_RRC */
#define GSMTAP_LTE_CH_BCCH 0x01
#define GSMTAP_LTE_CH_CCCH 0x02
#define GSMTAP_LTE_CH_DCCH 0x03
#define GSMTAP_LTE_CH_MCCH 0x04
#define GSMTAP_LTE_CH_PCCH 0x05
#define GSMTAP_LTE_CH_DTCH 0x06
#define GSMTAP_LTE_CH_MTCH 0x07
/* flags for the ARFCN */
#define GSMTAP_ARFCN_F_PCS 0x8000
#define GSMTAP_ARFCN_F_UPLINK 0x4000
#define GSMTAP_ARFCN_MASK 0x3fff
/* IANA-assigned well-known UDP port for GSMTAP messages */
#define GSMTAP_UDP_PORT 4729
/* UMTS RRC message types */
enum {
GSMTAP_RRC_SUB_DL_DCCH_Message = 0,
GSMTAP_RRC_SUB_UL_DCCH_Message,
GSMTAP_RRC_SUB_DL_CCCH_Message,
GSMTAP_RRC_SUB_UL_CCCH_Message,
GSMTAP_RRC_SUB_PCCH_Message,
GSMTAP_RRC_SUB_DL_SHCCH_Message,
GSMTAP_RRC_SUB_UL_SHCCH_Message,
GSMTAP_RRC_SUB_BCCH_FACH_Message,
GSMTAP_RRC_SUB_BCCH_BCH_Message,
GSMTAP_RRC_SUB_MCCH_Message,
GSMTAP_RRC_SUB_MSCH_Message,
GSMTAP_RRC_SUB_HandoverToUTRANCommand,
GSMTAP_RRC_SUB_InterRATHandoverInfo,
GSMTAP_RRC_SUB_SystemInformation_BCH,
GSMTAP_RRC_SUB_System_Information_Container,
GSMTAP_RRC_SUB_UE_RadioAccessCapabilityInfo,
GSMTAP_RRC_SUB_MasterInformationBlock,
GSMTAP_RRC_SUB_SysInfoType1,
GSMTAP_RRC_SUB_SysInfoType2,
GSMTAP_RRC_SUB_SysInfoType3,
GSMTAP_RRC_SUB_SysInfoType4,
GSMTAP_RRC_SUB_SysInfoType5,
GSMTAP_RRC_SUB_SysInfoType5bis,
GSMTAP_RRC_SUB_SysInfoType6,
GSMTAP_RRC_SUB_SysInfoType7,
GSMTAP_RRC_SUB_SysInfoType8,
GSMTAP_RRC_SUB_SysInfoType9,
GSMTAP_RRC_SUB_SysInfoType10,
GSMTAP_RRC_SUB_SysInfoType11,
GSMTAP_RRC_SUB_SysInfoType11bis,
GSMTAP_RRC_SUB_SysInfoType12,
GSMTAP_RRC_SUB_SysInfoType13,
GSMTAP_RRC_SUB_SysInfoType13_1,
GSMTAP_RRC_SUB_SysInfoType13_2,
GSMTAP_RRC_SUB_SysInfoType13_3,
GSMTAP_RRC_SUB_SysInfoType13_4,
GSMTAP_RRC_SUB_SysInfoType14,
GSMTAP_RRC_SUB_SysInfoType15,
GSMTAP_RRC_SUB_SysInfoType15bis,
GSMTAP_RRC_SUB_SysInfoType15_1,
GSMTAP_RRC_SUB_SysInfoType15_1bis,
GSMTAP_RRC_SUB_SysInfoType15_2,
GSMTAP_RRC_SUB_SysInfoType15_2bis,
GSMTAP_RRC_SUB_SysInfoType15_2ter,
GSMTAP_RRC_SUB_SysInfoType15_3,
GSMTAP_RRC_SUB_SysInfoType15_3bis,
GSMTAP_RRC_SUB_SysInfoType15_4,
GSMTAP_RRC_SUB_SysInfoType15_5,
GSMTAP_RRC_SUB_SysInfoType15_6,
GSMTAP_RRC_SUB_SysInfoType15_7,
GSMTAP_RRC_SUB_SysInfoType15_8,
GSMTAP_RRC_SUB_SysInfoType16,
GSMTAP_RRC_SUB_SysInfoType17,
GSMTAP_RRC_SUB_SysInfoType18,
GSMTAP_RRC_SUB_SysInfoType19,
GSMTAP_RRC_SUB_SysInfoType20,
GSMTAP_RRC_SUB_SysInfoType21,
GSMTAP_RRC_SUB_SysInfoType22,
GSMTAP_RRC_SUB_SysInfoTypeSB1,
GSMTAP_RRC_SUB_SysInfoTypeSB2,
GSMTAP_RRC_SUB_ToTargetRNC_Container,
GSMTAP_RRC_SUB_TargetRNC_ToSourceRNC_Container,
GSMTAP_RRC_SUB_MAX
};
/* LTE RRC message types */
enum {
GSMTAP_LTE_RRC_SUB_DL_CCCH_Message = 0,
GSMTAP_LTE_RRC_SUB_DL_DCCH_Message,
GSMTAP_LTE_RRC_SUB_UL_CCCH_Message,
GSMTAP_LTE_RRC_SUB_UL_DCCH_Message,
GSMTAP_LTE_RRC_SUB_BCCH_BCH_Message,
GSMTAP_LTE_RRC_SUB_BCCH_DL_SCH_Message,
GSMTAP_LTE_RRC_SUB_PCCH_Message,
GSMTAP_LTE_RRC_SUB_MCCH_Message,
GSMTAP_LTE_RRC_SUB_MAX
};
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
/*! Structure of the GTMTAP pseudo-header */
struct gsmtap_hdr {
uint8_t version; /*!< version, set to 0x01 currently */
uint8_t hdr_len; /*!< length in number of 32bit words */
uint8_t type; /*!< see GSMTAP_TYPE_* */
uint8_t timeslot; /*!< timeslot (0..7 on Um) */
uint16_t arfcn; /*!< ARFCN (frequency) */
int8_t signal_dbm; /*!< signal level in dBm */
int8_t snr_db; /*!< signal/noise ratio in dB */
uint32_t frame_number; /*!< GSM Frame Number (FN) */
uint8_t sub_type; /*!< Type of burst/channel, see above */
uint8_t antenna_nr; /*!< Antenna Number */
uint8_t sub_slot; /*!< sub-slot within timeslot */
uint8_t res; /*!< reserved for future use (RFU) */
} __attribute__((packed));
/*! Structure of the GTMTAP libosmocore logging header */
struct gsmtap_osmocore_log_hdr {
struct {
uint32_t sec;
uint32_t usec;
} ts;
char proc_name[16]; /*!< name of process */
uint32_t pid; /*!< process ID */
uint8_t level; /*!< logging level */
uint8_t _pad[3];
/* TODO: color */
char subsys[16]; /*!< logging sub-system */
struct {
char name[32]; /*!< source file name */
uint32_t line_nr;/*!< line number */
} src_file;
} __attribute__((packed));
|
