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