libosmocore  0.9.3.20160317
Osmocom core library
gsmtap.h
1 #pragma once
2 
3 /* gsmtap header, pseudo-header in front of the actua GSM payload */
4 
5 /* GSMTAP is a generic header format for GSM protocol captures,
6  * it uses the IANA-assigned UDP port number 4729 and carries
7  * payload in various formats of GSM interfaces such as Um MAC
8  * blocks or Um bursts.
9  *
10  * Example programs generating GSMTAP data are airprobe
11  * (http://airprobe.org/) or OsmocomBB (http://bb.osmocom.org/)
12  */
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 
48 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
49 
50 /* sub-types for TYPE_UM_BURST */
51 #define GSMTAP_BURST_UNKNOWN 0x00
52 #define GSMTAP_BURST_FCCH 0x01
53 #define GSMTAP_BURST_PARTIAL_SCH 0x02
54 #define GSMTAP_BURST_SCH 0x03
55 #define GSMTAP_BURST_CTS_SCH 0x04
56 #define GSMTAP_BURST_COMPACT_SCH 0x05
57 #define GSMTAP_BURST_NORMAL 0x06
58 #define GSMTAP_BURST_DUMMY 0x07
59 #define GSMTAP_BURST_ACCESS 0x08
60 #define GSMTAP_BURST_NONE 0x09
61 /* WiMAX bursts */
62 #define GSMTAP_BURST_CDMA_CODE 0x10 /* WiMAX CDMA Code Attribute burst */
63 #define GSMTAP_BURST_FCH 0x11 /* WiMAX FCH burst */
64 #define GSMTAP_BURST_FFB 0x12 /* WiMAX Fast Feedback burst */
65 #define GSMTAP_BURST_PDU 0x13 /* WiMAX PDU burst */
66 #define GSMTAP_BURST_HACK 0x14 /* WiMAX HARQ ACK burst */
67 #define GSMTAP_BURST_PHY_ATTRIBUTES 0x15 /* WiMAX PHY Attributes burst */
68 
69 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
70 
71 /* sub-types for TYPE_UM */
72 #define GSMTAP_CHANNEL_UNKNOWN 0x00
73 #define GSMTAP_CHANNEL_BCCH 0x01
74 #define GSMTAP_CHANNEL_CCCH 0x02
75 #define GSMTAP_CHANNEL_RACH 0x03
76 #define GSMTAP_CHANNEL_AGCH 0x04
77 #define GSMTAP_CHANNEL_PCH 0x05
78 #define GSMTAP_CHANNEL_SDCCH 0x06
79 #define GSMTAP_CHANNEL_SDCCH4 0x07
80 #define GSMTAP_CHANNEL_SDCCH8 0x08
81 #define GSMTAP_CHANNEL_TCH_F 0x09
82 #define GSMTAP_CHANNEL_TCH_H 0x0a
83 #define GSMTAP_CHANNEL_PACCH 0x0b
84 #define GSMTAP_CHANNEL_CBCH52 0x0c
85 #define GSMTAP_CHANNEL_PDCH 0x0d
86 #define GSMTAP_CHANNEL_PTCCH 0x0e
87 #define GSMTAP_CHANNEL_CBCH51 0x0f
88 
89 /* GPRS Coding Scheme CS1..4 */
90 #define GSMTAP_GPRS_CS_BASE 0x20
91 #define GSMTAP_GPRS_CS(N) (GSMTAP_GPRS_CS_BASE + N)
92 /* (E) GPRS Coding Scheme MCS0..9 */
93 #define GSMTAP_GPRS_MCS_BASE 0x30
94 #define GSMTAP_GPRS_MCS(N) (GSMTAP_GPRS_MCS_BASE + N)
95 
96 #define GSMTAP_CHANNEL_ACCH 0x80
97 
98 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
99 
100 /* sub-types for TYPE_TETRA_AIR */
101 #define GSMTAP_TETRA_BSCH 0x01
102 #define GSMTAP_TETRA_AACH 0x02
103 #define GSMTAP_TETRA_SCH_HU 0x03
104 #define GSMTAP_TETRA_SCH_HD 0x04
105 #define GSMTAP_TETRA_SCH_F 0x05
106 #define GSMTAP_TETRA_BNCH 0x06
107 #define GSMTAP_TETRA_STCH 0x07
108 #define GSMTAP_TETRA_TCH_F 0x08
109 
110 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
111 
112 /* sub-types for TYPE_GMR1_UM */
113 #define GSMTAP_GMR1_UNKNOWN 0x00
114 #define GSMTAP_GMR1_BCCH 0x01
115 #define GSMTAP_GMR1_CCCH 0x02 /* either AGCH or PCH */
116 #define GSMTAP_GMR1_PCH 0x03
117 #define GSMTAP_GMR1_AGCH 0x04
118 #define GSMTAP_GMR1_BACH 0x05
119 #define GSMTAP_GMR1_RACH 0x06
120 #define GSMTAP_GMR1_CBCH 0x07
121 #define GSMTAP_GMR1_SDCCH 0x08
122 #define GSMTAP_GMR1_TACCH 0x09
123 #define GSMTAP_GMR1_GBCH 0x0a
124 
125 #define GSMTAP_GMR1_SACCH 0x01 /* to be combined with _TCH{6,9} */
126 #define GSMTAP_GMR1_FACCH 0x02 /* to be combines with _TCH{3,6,9} */
127 #define GSMTAP_GMR1_DKAB 0x03 /* to be combined with _TCH3 */
128 #define GSMTAP_GMR1_TCH3 0x10
129 #define GSMTAP_GMR1_TCH6 0x14
130 #define GSMTAP_GMR1_TCH9 0x18
131 
132 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
133 
134 #define GSMTAP_UMTS_CH_PCCH 0x01
135 #define GSMTAP_UMTS_CH_CCCH 0x02
136 #define GSMTAP_UMTS_CH_DCCH 0x03
137 
138 /* sub-types for TYPE_LTE_RRC */
139 #define GSMTAP_LTE_CH_BCCH 0x01
140 #define GSMTAP_LTE_CH_CCCH 0x02
141 #define GSMTAP_LTE_CH_DCCH 0x03
142 #define GSMTAP_LTE_CH_MCCH 0x04
143 #define GSMTAP_LTE_CH_PCCH 0x05
144 #define GSMTAP_LTE_CH_DTCH 0x06
145 #define GSMTAP_LTE_CH_MTCH 0x07
146 
147 /* flags for the ARFCN */
148 #define GSMTAP_ARFCN_F_PCS 0x8000
149 #define GSMTAP_ARFCN_F_UPLINK 0x4000
150 #define GSMTAP_ARFCN_MASK 0x3fff
151 
152 /* IANA-assigned well-known UDP port for GSMTAP messages */
153 #define GSMTAP_UDP_PORT 4729
154 
155 /* UMTS RRC message types */
156 enum {
157  GSMTAP_RRC_SUB_DL_DCCH_Message = 0,
158  GSMTAP_RRC_SUB_UL_DCCH_Message,
159  GSMTAP_RRC_SUB_DL_CCCH_Message,
160  GSMTAP_RRC_SUB_UL_CCCH_Message,
161  GSMTAP_RRC_SUB_PCCH_Message,
162  GSMTAP_RRC_SUB_DL_SHCCH_Message,
163  GSMTAP_RRC_SUB_UL_SHCCH_Message,
164  GSMTAP_RRC_SUB_BCCH_FACH_Message,
165  GSMTAP_RRC_SUB_BCCH_BCH_Message,
166  GSMTAP_RRC_SUB_MCCH_Message,
167  GSMTAP_RRC_SUB_MSCH_Message,
168  GSMTAP_RRC_SUB_HandoverToUTRANCommand,
169  GSMTAP_RRC_SUB_InterRATHandoverInfo,
170  GSMTAP_RRC_SUB_SystemInformation_BCH,
171  GSMTAP_RRC_SUB_System_Information_Container,
172  GSMTAP_RRC_SUB_UE_RadioAccessCapabilityInfo,
173  GSMTAP_RRC_SUB_MasterInformationBlock,
174  GSMTAP_RRC_SUB_SysInfoType1,
175  GSMTAP_RRC_SUB_SysInfoType2,
176  GSMTAP_RRC_SUB_SysInfoType3,
177  GSMTAP_RRC_SUB_SysInfoType4,
178  GSMTAP_RRC_SUB_SysInfoType5,
179  GSMTAP_RRC_SUB_SysInfoType5bis,
180  GSMTAP_RRC_SUB_SysInfoType6,
181  GSMTAP_RRC_SUB_SysInfoType7,
182  GSMTAP_RRC_SUB_SysInfoType8,
183  GSMTAP_RRC_SUB_SysInfoType9,
184  GSMTAP_RRC_SUB_SysInfoType10,
185  GSMTAP_RRC_SUB_SysInfoType11,
186  GSMTAP_RRC_SUB_SysInfoType11bis,
187  GSMTAP_RRC_SUB_SysInfoType12,
188  GSMTAP_RRC_SUB_SysInfoType13,
189  GSMTAP_RRC_SUB_SysInfoType13_1,
190  GSMTAP_RRC_SUB_SysInfoType13_2,
191  GSMTAP_RRC_SUB_SysInfoType13_3,
192  GSMTAP_RRC_SUB_SysInfoType13_4,
193  GSMTAP_RRC_SUB_SysInfoType14,
194  GSMTAP_RRC_SUB_SysInfoType15,
195  GSMTAP_RRC_SUB_SysInfoType15bis,
196  GSMTAP_RRC_SUB_SysInfoType15_1,
197  GSMTAP_RRC_SUB_SysInfoType15_1bis,
198  GSMTAP_RRC_SUB_SysInfoType15_2,
199  GSMTAP_RRC_SUB_SysInfoType15_2bis,
200  GSMTAP_RRC_SUB_SysInfoType15_2ter,
201  GSMTAP_RRC_SUB_SysInfoType15_3,
202  GSMTAP_RRC_SUB_SysInfoType15_3bis,
203  GSMTAP_RRC_SUB_SysInfoType15_4,
204  GSMTAP_RRC_SUB_SysInfoType15_5,
205  GSMTAP_RRC_SUB_SysInfoType15_6,
206  GSMTAP_RRC_SUB_SysInfoType15_7,
207  GSMTAP_RRC_SUB_SysInfoType15_8,
208  GSMTAP_RRC_SUB_SysInfoType16,
209  GSMTAP_RRC_SUB_SysInfoType17,
210  GSMTAP_RRC_SUB_SysInfoType18,
211  GSMTAP_RRC_SUB_SysInfoType19,
212  GSMTAP_RRC_SUB_SysInfoType20,
213  GSMTAP_RRC_SUB_SysInfoType21,
214  GSMTAP_RRC_SUB_SysInfoType22,
215  GSMTAP_RRC_SUB_SysInfoTypeSB1,
216  GSMTAP_RRC_SUB_SysInfoTypeSB2,
217  GSMTAP_RRC_SUB_ToTargetRNC_Container,
218  GSMTAP_RRC_SUB_TargetRNC_ToSourceRNC_Container,
219 
220  GSMTAP_RRC_SUB_MAX
221 };
222 
223 /* LTE RRC message types */
224 enum {
225  GSMTAP_LTE_RRC_SUB_DL_CCCH_Message = 0,
226  GSMTAP_LTE_RRC_SUB_DL_DCCH_Message,
227  GSMTAP_LTE_RRC_SUB_UL_CCCH_Message,
228  GSMTAP_LTE_RRC_SUB_UL_DCCH_Message,
229  GSMTAP_LTE_RRC_SUB_BCCH_BCH_Message,
230  GSMTAP_LTE_RRC_SUB_BCCH_DL_SCH_Message,
231  GSMTAP_LTE_RRC_SUB_PCCH_Message,
232  GSMTAP_LTE_RRC_SUB_MCCH_Message,
233 
234  GSMTAP_LTE_RRC_SUB_MAX
235 };
236 
237 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
238 struct gsmtap_hdr {
239  uint8_t version; /* version, set to 0x01 currently */
240  uint8_t hdr_len; /* length in number of 32bit words */
241  uint8_t type; /* see GSMTAP_TYPE_* */
242  uint8_t timeslot; /* timeslot (0..7 on Um) */
243 
244  uint16_t arfcn; /* ARFCN (frequency) */
245  int8_t signal_dbm; /* signal level in dBm */
246  int8_t snr_db; /* signal/noise ratio in dB */
247 
248  uint32_t frame_number; /* GSM Frame Number (FN) */
249 
250  uint8_t sub_type; /* Type of burst/channel, see above */
251  uint8_t antenna_nr; /* Antenna Number */
252  uint8_t sub_slot; /* sub-slot within timeslot */
253  uint8_t res; /* reserved for future use (RFU) */
254 
255 } __attribute__((packed));
Definition: gsmtap.h:238