libosmocore  0.10.2
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
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 
51 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
52 
53 /* sub-types for TYPE_UM_BURST */
54 #define GSMTAP_BURST_UNKNOWN 0x00
55 #define GSMTAP_BURST_FCCH 0x01
56 #define GSMTAP_BURST_PARTIAL_SCH 0x02
57 #define GSMTAP_BURST_SCH 0x03
58 #define GSMTAP_BURST_CTS_SCH 0x04
59 #define GSMTAP_BURST_COMPACT_SCH 0x05
60 #define GSMTAP_BURST_NORMAL 0x06
61 #define GSMTAP_BURST_DUMMY 0x07
62 #define GSMTAP_BURST_ACCESS 0x08
63 #define GSMTAP_BURST_NONE 0x09
64 /* WiMAX bursts */
65 #define GSMTAP_BURST_CDMA_CODE 0x10 /* WiMAX CDMA Code Attribute burst */
66 #define GSMTAP_BURST_FCH 0x11 /* WiMAX FCH burst */
67 #define GSMTAP_BURST_FFB 0x12 /* WiMAX Fast Feedback burst */
68 #define GSMTAP_BURST_PDU 0x13 /* WiMAX PDU burst */
69 #define GSMTAP_BURST_HACK 0x14 /* WiMAX HARQ ACK burst */
70 #define GSMTAP_BURST_PHY_ATTRIBUTES 0x15 /* WiMAX PHY Attributes burst */
71 
72 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
73 
74 /* sub-types for TYPE_UM */
75 #define GSMTAP_CHANNEL_UNKNOWN 0x00
76 #define GSMTAP_CHANNEL_BCCH 0x01
77 #define GSMTAP_CHANNEL_CCCH 0x02
78 #define GSMTAP_CHANNEL_RACH 0x03
79 #define GSMTAP_CHANNEL_AGCH 0x04
80 #define GSMTAP_CHANNEL_PCH 0x05
81 #define GSMTAP_CHANNEL_SDCCH 0x06
82 #define GSMTAP_CHANNEL_SDCCH4 0x07
83 #define GSMTAP_CHANNEL_SDCCH8 0x08
84 #define GSMTAP_CHANNEL_TCH_F 0x09
85 #define GSMTAP_CHANNEL_TCH_H 0x0a
86 #define GSMTAP_CHANNEL_PACCH 0x0b
87 #define GSMTAP_CHANNEL_CBCH52 0x0c
88 #define GSMTAP_CHANNEL_PDTCH 0x0d
89 /* for legacy reasons we use a mis-spelled name. PDCH is really the physical channel, but we use it as PDTCH */
90 #define GSMTAP_CHANNEL_PDCH GSMTAP_CHANNEL_PDTCH
91 #define GSMTAP_CHANNEL_PTCCH 0x0e
92 #define GSMTAP_CHANNEL_CBCH51 0x0f
93 
94 /* GPRS Coding Scheme CS1..4 */
95 #define GSMTAP_GPRS_CS_BASE 0x20
96 #define GSMTAP_GPRS_CS(N) (GSMTAP_GPRS_CS_BASE + N)
97 /* (E) GPRS Coding Scheme MCS0..9 */
98 #define GSMTAP_GPRS_MCS_BASE 0x30
99 #define GSMTAP_GPRS_MCS(N) (GSMTAP_GPRS_MCS_BASE + N)
100 
101 #define GSMTAP_CHANNEL_ACCH 0x80
102 
103 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
104 
105 /* sub-types for TYPE_TETRA_AIR */
106 #define GSMTAP_TETRA_BSCH 0x01
107 #define GSMTAP_TETRA_AACH 0x02
108 #define GSMTAP_TETRA_SCH_HU 0x03
109 #define GSMTAP_TETRA_SCH_HD 0x04
110 #define GSMTAP_TETRA_SCH_F 0x05
111 #define GSMTAP_TETRA_BNCH 0x06
112 #define GSMTAP_TETRA_STCH 0x07
113 #define GSMTAP_TETRA_TCH_F 0x08
115 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
117 /* sub-types for TYPE_GMR1_UM */
118 #define GSMTAP_GMR1_UNKNOWN 0x00
119 #define GSMTAP_GMR1_BCCH 0x01
120 #define GSMTAP_GMR1_CCCH 0x02 /* either AGCH or PCH */
121 #define GSMTAP_GMR1_PCH 0x03
122 #define GSMTAP_GMR1_AGCH 0x04
123 #define GSMTAP_GMR1_BACH 0x05
124 #define GSMTAP_GMR1_RACH 0x06
125 #define GSMTAP_GMR1_CBCH 0x07
126 #define GSMTAP_GMR1_SDCCH 0x08
127 #define GSMTAP_GMR1_TACCH 0x09
128 #define GSMTAP_GMR1_GBCH 0x0a
129 
130 #define GSMTAP_GMR1_SACCH 0x01 /* to be combined with _TCH{6,9} */
131 #define GSMTAP_GMR1_FACCH 0x02 /* to be combines with _TCH{3,6,9} */
132 #define GSMTAP_GMR1_DKAB 0x03 /* to be combined with _TCH3 */
133 #define GSMTAP_GMR1_TCH3 0x10
134 #define GSMTAP_GMR1_TCH6 0x14
135 #define GSMTAP_GMR1_TCH9 0x18
136 
137 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
138 
139 #define GSMTAP_UMTS_CH_PCCH 0x01
140 #define GSMTAP_UMTS_CH_CCCH 0x02
141 #define GSMTAP_UMTS_CH_DCCH 0x03
142 
143 /* sub-types for TYPE_LTE_RRC */
144 #define GSMTAP_LTE_CH_BCCH 0x01
145 #define GSMTAP_LTE_CH_CCCH 0x02
146 #define GSMTAP_LTE_CH_DCCH 0x03
147 #define GSMTAP_LTE_CH_MCCH 0x04
148 #define GSMTAP_LTE_CH_PCCH 0x05
149 #define GSMTAP_LTE_CH_DTCH 0x06
150 #define GSMTAP_LTE_CH_MTCH 0x07
151 
152 /* flags for the ARFCN */
153 #define GSMTAP_ARFCN_F_PCS 0x8000
154 #define GSMTAP_ARFCN_F_UPLINK 0x4000
155 #define GSMTAP_ARFCN_MASK 0x3fff
156 
157 /* IANA-assigned well-known UDP port for GSMTAP messages */
158 #define GSMTAP_UDP_PORT 4729
159 
160 /* UMTS RRC message types */
161 enum {
224 
226 };
227 
228 /* LTE RRC message types */
229 enum {
238 
240 };
241 
242 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
244 struct gsmtap_hdr {
245  uint8_t version;
246  uint8_t hdr_len;
247  uint8_t type;
248  uint8_t timeslot;
250  uint16_t arfcn;
251  int8_t signal_dbm;
252  int8_t snr_db;
254  uint32_t frame_number;
256  uint8_t sub_type;
257  uint8_t antenna_nr;
258  uint8_t sub_slot;
259  uint8_t res;
261 } __attribute__((packed));
262 
265  struct {
266  uint32_t sec;
267  uint32_t usec;
268  } ts;
269  char proc_name[16];
270  uint32_t pid;
271  uint8_t level;
272  uint8_t _pad[3];
273  /* TODO: color */
274  char subsys[16];
275  struct {
276  char name[32];
277  uint32_t line_nr;
278  } src_file;
279 } __attribute__((packed));
uint16_t arfcn
ARFCN (frequency)
Definition: gsmtap.h:250
Definition: gsmtap.h:168
uint8_t _pad[3]
Definition: gsmtap.h:118
Definition: gsmtap.h:199
uint8_t hdr_len
length in number of 32bit words
Definition: gsmtap.h:246
uint8_t level
logging level
Definition: gsmtap.h:271
Definition: gsmtap.h:211
Definition: gsmtap.h:166
Definition: gsmtap.h:182
Definition: gsmtap.h:200
uint32_t line_nr
line number
Definition: gsmtap.h:277
Definition: gsmtap.h:232
Definition: gsmtap.h:208
uint8_t version
version, set to 0x01 currently
Definition: gsmtap.h:245
char subsys[16]
logging sub-system
Definition: gsmtap.h:120
Definition: gsmtap.h:184
Definition: gsmtap.h:167
Definition: gsmtap.h:206
Definition: gsmtap.h:170
Definition: gsmtap.h:216
Definition: gsmtap.h:239
Definition: gsmtap.h:210
int8_t signal_dbm
signal level in dBm
Definition: gsmtap.h:251
uint32_t frame_number
GSM Frame Number (FN)
Definition: gsmtap.h:254
Definition: gsmtap.h:218
Definition: gsmtap.h:230
Definition: gsmtap.h:189
Definition: gsmtap.h:217
Definition: gsmtap.h:194
struct @6 src_file
uint8_t sub_slot
sub-slot within timeslot
Definition: gsmtap.h:258
Definition: gsmtap.h:219
uint32_t pid
process ID
Definition: gsmtap.h:270
char name[32]
source file name
Definition: gsmtap.h:122
Definition: gsmtap.h:171
Definition: gsmtap.h:207
Definition: gsmtap.h:195
Definition: gsmtap.h:183
Definition: gsmtap.h:203
Definition: gsmtap.h:185
Definition: gsmtap.h:234
Definition: gsmtap.h:164
Definition: gsmtap.h:225
uint8_t timeslot
timeslot (0..7 on Um)
Definition: gsmtap.h:248
Definition: gsmtap.h:236
Definition: gsmtap.h:179
uint8_t sub_type
Type of burst/channel, see above.
Definition: gsmtap.h:256
Definition: gsmtap.h:213
Definition: gsmtap.h:186
Definition: gsmtap.h:212
uint32_t sec
Definition: gsmtap.h:266
Definition: gsmtap.h:165
Definition: gsmtap.h:188
Definition: gsmtap.h:205
char proc_name[16]
name of process
Definition: gsmtap.h:115
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:247
Definition: gsmtap.h:202
Definition: gsmtap.h:190
Definition: gsmtap.h:196
Definition: gsmtap.h:220
Definition: gsmtap.h:222
uint8_t antenna_nr
Antenna Number.
Definition: gsmtap.h:257
Definition: gsmtap.h:169
Definition: gsmtap.h:187
Definition: gsmtap.h:231
Definition: gsmtap.h:215
Definition: gsmtap.h:198
Definition: gsmtap.h:201
Definition: gsmtap.h:197
struct @5 ts
Definition: gsmtap.h:209
Definition: gsmtap.h:181
Definition: gsmtap.h:233
Definition: gsmtap.h:214
Definition: gsmtap.h:221
Structure of the GTMTAP pseudo-header.
Definition: gsmtap.h:244
uint8_t res
reserved for future use (RFU)
Definition: gsmtap.h:259
Definition: gsmtap.h:192
Structure of the GTMTAP libosmocore logging header.
Definition: gsmtap.h:264
uint32_t usec
Definition: gsmtap.h:267
Definition: gsmtap.h:172
struct gsmtap_hdr __attribute__((packed))
Definition: gsmtap.h:162
Definition: gsmtap.h:163
Definition: gsmtap.h:237
Definition: gsmtap.h:180
int8_t snr_db
signal/noise ratio in dB
Definition: gsmtap.h:252
Definition: gsmtap.h:204
Definition: gsmtap.h:174
Definition: gsmtap.h:175
Definition: gsmtap.h:191
Definition: gsmtap.h:193