blob: 468b2a9b244b4fc1cd9d14bebcc63eaeb6530ef5 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gsm48.c
2 * GSM Mobile Radio Interface Layer 3 messages
Harald Welte4fb20752010-03-02 23:17:33 +01003 * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02004/*
5 * (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welte4fb20752010-03-02 23:17:33 +01006 * (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
7 *
8 * All Rights Reserved
9 *
Harald Weltee08da972017-11-13 01:00:26 +090010 * SPDX-License-Identifier: GPL-2.0+
11 *
Harald Welte4fb20752010-03-02 23:17:33 +010012 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 *
26 */
27
28#include <stdint.h>
29#include <stdio.h>
30#include <string.h>
Maxfe65fa72016-05-10 17:17:05 +020031#include <stdbool.h>
Pau Espin Pedrol45735022017-06-18 14:05:24 +020032#include <inttypes.h>
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010033#include <ctype.h>
Harald Welte61e2bfc2010-03-04 10:53:03 +010034
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010035#include <osmocom/core/utils.h>
Harald Welte95871da2017-05-15 12:11:36 +020036#include <osmocom/core/byteswap.h>
37#include <osmocom/core/bit16gen.h>
38#include <osmocom/core/bit32gen.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010039#include <osmocom/gsm/tlv.h>
40#include <osmocom/gsm/gsm48.h>
Harald Welte94df39e2011-06-26 14:33:57 +020041#include <osmocom/gsm/gsm0502.h>
Maxfb348ee2016-03-30 21:14:53 +020042#include <osmocom/gsm/gsm_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010043#include <osmocom/gsm/protocol/gsm_04_08.h>
Harald Welte2aee7b12011-06-26 14:20:04 +020044#include <osmocom/gsm/protocol/gsm_08_58.h>
Maxfdca25d2016-07-05 16:06:28 +020045#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
Harald Welte4fb20752010-03-02 23:17:33 +010046
Harald Welte96e2a002017-06-12 21:44:18 +020047/*! \addtogroup gsm0408
48 * @{
Neels Hofmeyr87e45502017-06-20 00:17:59 +020049 * GSM Mobile Radion Interface L3 messages / TS 04.08
Harald Welte96e2a002017-06-12 21:44:18 +020050 */
51
Neels Hofmeyr87e45502017-06-20 00:17:59 +020052/*! TLV parser definitions for TS 04.08 CC */
Harald Welte4fb20752010-03-02 23:17:33 +010053const struct tlv_definition gsm48_att_tlvdef = {
54 .def = {
55 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
56 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
57 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
58 [GSM48_IE_UTC] = { TLV_TYPE_TV },
59 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
60 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
61
62 [GSM48_IE_BEARER_CAP] = { TLV_TYPE_TLV },
63 [GSM48_IE_CAUSE] = { TLV_TYPE_TLV },
64 [GSM48_IE_CC_CAP] = { TLV_TYPE_TLV },
65 [GSM48_IE_ALERT] = { TLV_TYPE_TLV },
66 [GSM48_IE_FACILITY] = { TLV_TYPE_TLV },
67 [GSM48_IE_PROGR_IND] = { TLV_TYPE_TLV },
68 [GSM48_IE_AUX_STATUS] = { TLV_TYPE_TLV },
69 [GSM48_IE_NOTIFY] = { TLV_TYPE_TV },
70 [GSM48_IE_KPD_FACILITY] = { TLV_TYPE_TV },
71 [GSM48_IE_SIGNAL] = { TLV_TYPE_TV },
72 [GSM48_IE_CONN_BCD] = { TLV_TYPE_TLV },
73 [GSM48_IE_CONN_SUB] = { TLV_TYPE_TLV },
74 [GSM48_IE_CALLING_BCD] = { TLV_TYPE_TLV },
75 [GSM48_IE_CALLING_SUB] = { TLV_TYPE_TLV },
76 [GSM48_IE_CALLED_BCD] = { TLV_TYPE_TLV },
77 [GSM48_IE_CALLED_SUB] = { TLV_TYPE_TLV },
78 [GSM48_IE_REDIR_BCD] = { TLV_TYPE_TLV },
79 [GSM48_IE_REDIR_SUB] = { TLV_TYPE_TLV },
80 [GSM48_IE_LOWL_COMPAT] = { TLV_TYPE_TLV },
81 [GSM48_IE_HIGHL_COMPAT] = { TLV_TYPE_TLV },
82 [GSM48_IE_USER_USER] = { TLV_TYPE_TLV },
83 [GSM48_IE_SS_VERS] = { TLV_TYPE_TLV },
84 [GSM48_IE_MORE_DATA] = { TLV_TYPE_T },
85 [GSM48_IE_CLIR_SUPP] = { TLV_TYPE_T },
86 [GSM48_IE_CLIR_INVOC] = { TLV_TYPE_T },
87 [GSM48_IE_REV_C_SETUP] = { TLV_TYPE_T },
88 [GSM48_IE_REPEAT_CIR] = { TLV_TYPE_T },
89 [GSM48_IE_REPEAT_SEQ] = { TLV_TYPE_T },
90 /* FIXME: more elements */
91 },
92};
93
Neels Hofmeyr87e45502017-06-20 00:17:59 +020094/*! TLV parser definitions for TS 04.08 RR */
Andreas Eversberg014cb872010-07-12 09:11:00 +020095const struct tlv_definition gsm48_rr_att_tlvdef = {
96 .def = {
97 /* NOTE: Don't add IE 17 = MOBILE_ID here, it already used. */
98 [GSM48_IE_VGCS_TARGET] = { TLV_TYPE_TLV },
99 [GSM48_IE_FRQSHORT_AFTER] = { TLV_TYPE_FIXED, 9 },
100 [GSM48_IE_MUL_RATE_CFG] = { TLV_TYPE_TLV },
101 [GSM48_IE_FREQ_L_AFTER] = { TLV_TYPE_TLV },
102 [GSM48_IE_MSLOT_DESC] = { TLV_TYPE_TLV },
103 [GSM48_IE_CHANMODE_2] = { TLV_TYPE_TV },
104 [GSM48_IE_FRQSHORT_BEFORE] = { TLV_TYPE_FIXED, 9 },
105 [GSM48_IE_CHANMODE_3] = { TLV_TYPE_TV },
106 [GSM48_IE_CHANMODE_4] = { TLV_TYPE_TV },
107 [GSM48_IE_CHANMODE_5] = { TLV_TYPE_TV },
108 [GSM48_IE_CHANMODE_6] = { TLV_TYPE_TV },
109 [GSM48_IE_CHANMODE_7] = { TLV_TYPE_TV },
110 [GSM48_IE_CHANMODE_8] = { TLV_TYPE_TV },
111 [GSM48_IE_FREQ_L_BEFORE] = { TLV_TYPE_TLV },
112 [GSM48_IE_CH_DESC_1_BEFORE] = { TLV_TYPE_FIXED, 3 },
113 [GSM48_IE_CH_DESC_2_BEFORE] = { TLV_TYPE_FIXED, 3 },
114 [GSM48_IE_F_CH_SEQ_BEFORE] = { TLV_TYPE_FIXED, 9 },
115 [GSM48_IE_CLASSMARK3] = { TLV_TYPE_TLV },
116 [GSM48_IE_MA_BEFORE] = { TLV_TYPE_TLV },
117 [GSM48_IE_RR_PACKET_UL] = { TLV_TYPE_TLV },
118 [GSM48_IE_RR_PACKET_DL] = { TLV_TYPE_TLV },
119 [GSM48_IE_CELL_CH_DESC] = { TLV_TYPE_FIXED, 16 },
120 [GSM48_IE_CHANMODE_1] = { TLV_TYPE_TV },
121 [GSM48_IE_CHDES_2_AFTER] = { TLV_TYPE_FIXED, 3 },
122 [GSM48_IE_MODE_SEC_CH] = { TLV_TYPE_TV },
123 [GSM48_IE_F_CH_SEQ_AFTER] = { TLV_TYPE_FIXED, 9 },
124 [GSM48_IE_MA_AFTER] = { TLV_TYPE_TLV },
125 [GSM48_IE_BA_RANGE] = { TLV_TYPE_TLV },
126 [GSM48_IE_GROUP_CHDES] = { TLV_TYPE_TLV },
127 [GSM48_IE_BA_LIST_PREF] = { TLV_TYPE_TLV },
128 [GSM48_IE_MOB_OVSERV_DIF] = { TLV_TYPE_TLV },
129 [GSM48_IE_REALTIME_DIFF] = { TLV_TYPE_TLV },
130 [GSM48_IE_START_TIME] = { TLV_TYPE_FIXED, 2 },
131 [GSM48_IE_TIMING_ADVANCE] = { TLV_TYPE_TV },
132 [GSM48_IE_GROUP_CIP_SEQ] = { TLV_TYPE_SINGLE_TV },
133 [GSM48_IE_CIP_MODE_SET] = { TLV_TYPE_SINGLE_TV },
134 [GSM48_IE_GPRS_RESUMPT] = { TLV_TYPE_SINGLE_TV },
135 [GSM48_IE_SYNC_IND] = { TLV_TYPE_SINGLE_TV },
136 },
137};
138
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200139/*! TLV parser definitions for TS 04.08 MM */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200140const struct tlv_definition gsm48_mm_att_tlvdef = {
141 .def = {
142 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
143 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
144 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
145 [GSM48_IE_UTC] = { TLV_TYPE_TV },
146 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
147 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
Jacob Erlbeck1c3f0882013-09-16 10:29:57 +0200148 [GSM48_IE_NET_DST] = { TLV_TYPE_TLV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200149
150 [GSM48_IE_LOCATION_AREA] = { TLV_TYPE_FIXED, 5 },
151 [GSM48_IE_PRIORITY_LEV] = { TLV_TYPE_SINGLE_TV },
152 [GSM48_IE_FOLLOW_ON_PROC] = { TLV_TYPE_T },
153 [GSM48_IE_CTS_PERMISSION] = { TLV_TYPE_T },
154 },
155};
156
Harald Weltee9e190a2010-03-25 11:44:57 +0800157static const struct value_string rr_cause_names[] = {
158 { GSM48_RR_CAUSE_NORMAL, "Normal event" },
159 { GSM48_RR_CAUSE_ABNORMAL_UNSPEC, "Abnormal release, unspecified" },
160 { GSM48_RR_CAUSE_ABNORMAL_UNACCT, "Abnormal release, channel unacceptable" },
161 { GSM48_RR_CAUSE_ABNORMAL_TIMER, "Abnormal release, timer expired" },
162 { GSM48_RR_CAUSE_ABNORMAL_NOACT, "Abnormal release, no activity on radio path" },
163 { GSM48_RR_CAUSE_PREMPTIVE_REL, "Preemptive release" },
164 { GSM48_RR_CAUSE_HNDOVER_IMP, "Handover impossible, timing advance out of range" },
165 { GSM48_RR_CAUSE_CHAN_MODE_UNACCT, "Channel mode unacceptable" },
166 { GSM48_RR_CAUSE_FREQ_NOT_IMPL, "Frequency not implemented" },
167 { GSM48_RR_CAUSE_CALL_CLEARED, "Call already cleared" },
168 { GSM48_RR_CAUSE_SEMANT_INCORR, "Semantically incorrect message" },
169 { GSM48_RR_CAUSE_INVALID_MAND_INF, "Invalid mandatory information" },
170 { GSM48_RR_CAUSE_MSG_TYPE_N, "Message type non-existant or not implemented" },
171 { GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT, "Message type not compatible with protocol state" },
172 { GSM48_RR_CAUSE_COND_IE_ERROR, "Conditional IE error" },
173 { GSM48_RR_CAUSE_NO_CELL_ALLOC_A, "No cell allocation available" },
174 { GSM48_RR_CAUSE_PROT_ERROR_UNSPC, "Protocol error unspecified" },
175 { 0, NULL },
Harald Welte4fb20752010-03-02 23:17:33 +0100176};
177
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200178/*! return string representation of RR Cause value */
Philippada00422016-10-27 13:30:16 +0200179const char *rr_cause_name(uint8_t cause)
180{
181 return get_value_string(rr_cause_names, cause);
182}
183
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100184/*! Return MCC-MNC-LAC-RAC as string, in a static buffer.
185 * \param[in] rai RAI to encode.
186 * \returns Static string buffer.
187 */
188const char *osmo_rai_name(const struct gprs_ra_id *rai)
189{
190 static char buf[32];
191 snprintf(buf, sizeof(buf), "%s-%s-%u-%u",
192 osmo_mcc_name(rai->mcc), osmo_mnc_name(rai->mnc, rai->mnc_3_digits), rai->lac,
193 rai->rac);
194 return buf;
195}
196
Harald Welte9eb6d882010-03-25 12:00:54 +0800197/* FIXME: convert to value_string */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200198static const char *cc_state_names[32] = {
Harald Welte4fb20752010-03-02 23:17:33 +0100199 "NULL",
200 "INITIATED",
Andreas Eversberg1ef041f2010-04-09 07:52:12 +0200201 "MM_CONNECTION_PEND",
Harald Welte4fb20752010-03-02 23:17:33 +0100202 "MO_CALL_PROC",
203 "CALL_DELIVERED",
204 "illegal state 5",
205 "CALL_PRESENT",
206 "CALL_RECEIVED",
207 "CONNECT_REQUEST",
208 "MO_TERM_CALL_CONF",
209 "ACTIVE",
210 "DISCONNECT_REQ",
211 "DISCONNECT_IND",
212 "illegal state 13",
213 "illegal state 14",
214 "illegal state 15",
215 "illegal state 16",
216 "illegal state 17",
217 "illegal state 18",
218 "RELEASE_REQ",
219 "illegal state 20",
220 "illegal state 21",
221 "illegal state 22",
222 "illegal state 23",
223 "illegal state 24",
224 "illegal state 25",
225 "MO_ORIG_MODIFY",
226 "MO_TERM_MODIFY",
227 "CONNECT_IND",
228 "illegal state 29",
229 "illegal state 30",
230 "illegal state 31",
231};
232
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200233/*! return string representation of CC State */
Harald Welte9eb6d882010-03-25 12:00:54 +0800234const char *gsm48_cc_state_name(uint8_t state)
235{
236 if (state < ARRAY_SIZE(cc_state_names))
237 return cc_state_names[state];
238
239 return "invalid";
240}
241
242static const struct value_string cc_msg_names[] = {
243 { GSM48_MT_CC_ALERTING, "ALERTING" },
244 { GSM48_MT_CC_CALL_PROC, "CALL_PROC" },
245 { GSM48_MT_CC_PROGRESS, "PROGRESS" },
246 { GSM48_MT_CC_ESTAB, "ESTAB" },
247 { GSM48_MT_CC_SETUP, "SETUP" },
248 { GSM48_MT_CC_ESTAB_CONF, "ESTAB_CONF" },
249 { GSM48_MT_CC_CONNECT, "CONNECT" },
250 { GSM48_MT_CC_CALL_CONF, "CALL_CONF" },
251 { GSM48_MT_CC_START_CC, "START_CC" },
252 { GSM48_MT_CC_RECALL, "RECALL" },
253 { GSM48_MT_CC_EMERG_SETUP, "EMERG_SETUP" },
254 { GSM48_MT_CC_CONNECT_ACK, "CONNECT_ACK" },
255 { GSM48_MT_CC_USER_INFO, "USER_INFO" },
256 { GSM48_MT_CC_MODIFY_REJECT, "MODIFY_REJECT" },
257 { GSM48_MT_CC_MODIFY, "MODIFY" },
258 { GSM48_MT_CC_HOLD, "HOLD" },
259 { GSM48_MT_CC_HOLD_ACK, "HOLD_ACK" },
260 { GSM48_MT_CC_HOLD_REJ, "HOLD_REJ" },
261 { GSM48_MT_CC_RETR, "RETR" },
262 { GSM48_MT_CC_RETR_ACK, "RETR_ACK" },
263 { GSM48_MT_CC_RETR_REJ, "RETR_REJ" },
264 { GSM48_MT_CC_MODIFY_COMPL, "MODIFY_COMPL" },
265 { GSM48_MT_CC_DISCONNECT, "DISCONNECT" },
266 { GSM48_MT_CC_RELEASE_COMPL, "RELEASE_COMPL" },
267 { GSM48_MT_CC_RELEASE, "RELEASE" },
268 { GSM48_MT_CC_STOP_DTMF, "STOP_DTMF" },
269 { GSM48_MT_CC_STOP_DTMF_ACK, "STOP_DTMF_ACK" },
270 { GSM48_MT_CC_STATUS_ENQ, "STATUS_ENQ" },
271 { GSM48_MT_CC_START_DTMF, "START_DTMF" },
272 { GSM48_MT_CC_START_DTMF_ACK, "START_DTMF_ACK" },
273 { GSM48_MT_CC_START_DTMF_REJ, "START_DTMF_REJ" },
274 { GSM48_MT_CC_CONG_CTRL, "CONG_CTRL" },
275 { GSM48_MT_CC_FACILITY, "FACILITY" },
276 { GSM48_MT_CC_STATUS, "STATUS" },
277 { GSM48_MT_CC_NOTIFY, "NOTFIY" },
278 { 0, NULL }
Harald Welte61e2bfc2010-03-04 10:53:03 +0100279};
280
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200281/*! return string representation of CC Message Type */
Harald Welte9eb6d882010-03-25 12:00:54 +0800282const char *gsm48_cc_msg_name(uint8_t msgtype)
283{
284 return get_value_string(cc_msg_names, msgtype);
285}
Harald Welte4fb20752010-03-02 23:17:33 +0100286
Philipp72e43f02016-10-27 13:35:20 +0200287
288static const struct value_string rr_msg_names[] = {
289 /* Channel establishment messages */
290 { GSM48_MT_RR_INIT_REQ, "RR INITIALISATION REQUEST" },
291 { GSM48_MT_RR_ADD_ASS, "ADDITIONAL ASSIGNMENT" },
292 { GSM48_MT_RR_IMM_ASS, "IMMEDIATE ASSIGNMENT" },
293 { GSM48_MT_RR_IMM_ASS_EXT, "MMEDIATE ASSIGNMENT EXTENDED" },
294 { GSM48_MT_RR_IMM_ASS_REJ, "IMMEDIATE ASSIGNMENT REJECT" },
295 { GSM48_MT_RR_DTM_ASS_FAIL, "DTM ASSIGNMENT FAILURE" },
296 { GSM48_MT_RR_DTM_REJECT, "DTM REJECT" },
297 { GSM48_MT_RR_DTM_REQUEST, "DTM REQUEST" },
298 { GSM48_MT_RR_PACKET_ASS, "PACKET ASSIGNMENT" },
299
300 /* Ciphering messages */
301 { GSM48_MT_RR_CIPH_M_CMD, "CIPHERING MODE COMMAND" },
302 { GSM48_MT_RR_CIPH_M_COMPL, "CIPHERING MODE COMPLETE" },
303
304 /* Configuration change messages */
305 { GSM48_MT_RR_CFG_CHG_CMD, "CONFIGURATION CHANGE COMMAND" },
306 { GSM48_MT_RR_CFG_CHG_ACK, "CONFIGURATION CHANGE ACK" },
307 { GSM48_MT_RR_CFG_CHG_REJ, "CONFIGURATION CHANGE REJECT" },
308
309 /* Handover messages */
310 { GSM48_MT_RR_ASS_CMD, "ASSIGNMENT COMMAND" },
311 { GSM48_MT_RR_ASS_COMPL, "ASSIGNMENT COMPLETE" },
312 { GSM48_MT_RR_ASS_FAIL, "ASSIGNMENT FAILURE" },
313 { GSM48_MT_RR_HANDO_CMD, "HANDOVER COMMAND" },
314 { GSM48_MT_RR_HANDO_COMPL, "HANDOVER COMPLETE" },
315 { GSM48_MT_RR_HANDO_FAIL, "HANDOVER FAILURE" },
316 { GSM48_MT_RR_HANDO_INFO, "PHYSICAL INFORMATION" },
317 { GSM48_MT_RR_DTM_ASS_CMD, "DTM ASSIGNMENT COMMAND" },
318
319 { GSM48_MT_RR_CELL_CHG_ORDER, "RR-CELL CHANGE ORDER" },
320 { GSM48_MT_RR_PDCH_ASS_CMD, "PDCH ASSIGNMENT COMMAND" },
321
322 /* Channel release messages */
323 { GSM48_MT_RR_CHAN_REL, "CHANNEL RELEASE" },
324 { GSM48_MT_RR_PART_REL, "PARTIAL RELEASE" },
325 { GSM48_MT_RR_PART_REL_COMP, "PARTIAL RELEASE COMPLETE" },
326
327 /* Paging and Notification messages */
328 { GSM48_MT_RR_PAG_REQ_1, "PAGING REQUEST TYPE 1" },
329 { GSM48_MT_RR_PAG_REQ_2, "PAGING REQUEST TYPE 2" },
330 { GSM48_MT_RR_PAG_REQ_3, "PAGING REQUEST TYPE 3" },
331 { GSM48_MT_RR_PAG_RESP, "PAGING RESPONSE" },
332 { GSM48_MT_RR_NOTIF_NCH, "NOTIFICATION/NCH" },
333 { GSM48_MT_RR_NOTIF_FACCH, "(Reserved)" },
334 { GSM48_MT_RR_NOTIF_RESP, "NOTIFICATION/RESPONSE" },
335 { GSM48_MT_RR_PACKET_NOTIF, "PACKET NOTIFICATION" },
336 /* 3G Specific messages */
337 { GSM48_MT_RR_UTRAN_CLSM_CHG, "UTRAN Classmark Change" },
338 { GSM48_MT_RR_CDMA2K_CLSM_CHG, "cdma 2000 Classmark Change" },
339 { GSM48_MT_RR_IS_TO_UTRAN_HANDO, "Inter System to UTRAN Handover Command" },
340 { GSM48_MT_RR_IS_TO_CDMA2K_HANDO, "Inter System to cdma2000 Handover Command" },
341
342 /* System information messages */
343 { GSM48_MT_RR_SYSINFO_8, "SYSTEM INFORMATION TYPE 8" },
344 { GSM48_MT_RR_SYSINFO_1, "SYSTEM INFORMATION TYPE 1" },
345 { GSM48_MT_RR_SYSINFO_2, "SYSTEM INFORMATION TYPE 2" },
346 { GSM48_MT_RR_SYSINFO_3, "SYSTEM INFORMATION TYPE 3" },
347 { GSM48_MT_RR_SYSINFO_4, "SYSTEM INFORMATION TYPE 4" },
348 { GSM48_MT_RR_SYSINFO_5, "SYSTEM INFORMATION TYPE 5" },
349 { GSM48_MT_RR_SYSINFO_6, "SYSTEM INFORMATION TYPE 6" },
350 { GSM48_MT_RR_SYSINFO_7, "SYSTEM INFORMATION TYPE 7" },
351 { GSM48_MT_RR_SYSINFO_2bis, "SYSTEM INFORMATION TYPE 2bis" },
352 { GSM48_MT_RR_SYSINFO_2ter, "SYSTEM INFORMATION TYPE 2ter" },
353 { GSM48_MT_RR_SYSINFO_2quater, "SYSTEM INFORMATION TYPE 2quater" },
354 { GSM48_MT_RR_SYSINFO_5bis, "SYSTEM INFORMATION TYPE 5bis" },
355 { GSM48_MT_RR_SYSINFO_5ter, "SYSTEM INFORMATION TYPE 5ter" },
356 { GSM48_MT_RR_SYSINFO_9, "SYSTEM INFORMATION TYPE 9" },
357 { GSM48_MT_RR_SYSINFO_13, "SYSTEM INFORMATION TYPE 13" },
358 { GSM48_MT_RR_SYSINFO_16, "SYSTEM INFORMATION TYPE 16" },
359 { GSM48_MT_RR_SYSINFO_17, "SYSTEM INFORMATION TYPE 17" },
360 { GSM48_MT_RR_SYSINFO_18, "SYSTEM INFORMATION TYPE 18" },
361 { GSM48_MT_RR_SYSINFO_19, "SYSTEM INFORMATION TYPE 19" },
362 { GSM48_MT_RR_SYSINFO_20, "SYSTEM INFORMATION TYPE 20" },
363
364 /* Miscellaneous messages */
365 { GSM48_MT_RR_CHAN_MODE_MODIF, "CHANNEL MODE MODIFY" },
366 { GSM48_MT_RR_STATUS, "RR STATUS" },
367 { GSM48_MT_RR_CHAN_MODE_MODIF_ACK, "CHANNEL MODE MODIFY ACKNOWLEDGE" },
368 { GSM48_MT_RR_FREQ_REDEF, "FREQUENCY REDEFINITION" },
369 { GSM48_MT_RR_MEAS_REP, "MEASUREMENT REPORT" },
370 { GSM48_MT_RR_CLSM_CHG, "CLASSMARK CHANGE" },
371 { GSM48_MT_RR_CLSM_ENQ, "CLASSMARK ENQUIRY" },
372 { GSM48_MT_RR_EXT_MEAS_REP, "EXTENDED MEASUREMENT REPORT" },
373 { GSM48_MT_RR_EXT_MEAS_REP_ORD, "EXTENDED MEASUREMENT ORDER" },
374 { GSM48_MT_RR_GPRS_SUSP_REQ, "GPRS SUSPENSION REQUEST" },
375 { GSM48_MT_RR_DTM_INFO, "DTM INFORMATION" },
376
377 /* VGCS uplink control messages */
378 { GSM48_MT_RR_VGCS_UPL_GRANT, "VGCS UPLINK GRANT" },
379 { GSM48_MT_RR_UPLINK_RELEASE, "UPLINK RELEASE" },
380 { GSM48_MT_RR_UPLINK_FREE, "0c" },
381 { GSM48_MT_RR_UPLINK_BUSY, "UPLINK BUSY" },
382 { GSM48_MT_RR_TALKER_IND, "TALKER INDICATION" },
383
384 /* Application messages */
385 { GSM48_MT_RR_APP_INFO, "Application Information" },
386 { 0, NULL }
387};
388
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200389/*! return string representation of RR Message Type */
Philipp72e43f02016-10-27 13:35:20 +0200390const char *gsm48_rr_msg_name(uint8_t msgtype)
391{
392 return get_value_string(rr_msg_names, msgtype);
393}
394
395
Maxfb348ee2016-03-30 21:14:53 +0200396const struct value_string gsm48_chan_mode_names[] = {
397 { GSM48_CMODE_SIGN, "SIGNALLING" },
398 { GSM48_CMODE_SPEECH_V1, "SPEECH_V1" },
399 { GSM48_CMODE_SPEECH_EFR, "SPEECH_EFR" },
400 { GSM48_CMODE_SPEECH_AMR, "SPEECH_AMR" },
401 { GSM48_CMODE_DATA_14k5, "DATA_14k5" },
402 { GSM48_CMODE_DATA_12k0, "DATA_12k0" },
403 { GSM48_CMODE_DATA_6k0, "DATA_6k0" },
404 { GSM48_CMODE_DATA_3k6, "DATA_3k6" },
405 { 0, NULL },
406};
407
408const struct value_string gsm_chan_t_names[] = {
409 { GSM_LCHAN_NONE, "NONE" },
410 { GSM_LCHAN_SDCCH, "SDCCH" },
411 { GSM_LCHAN_TCH_F, "TCH_F" },
412 { GSM_LCHAN_TCH_H, "TCH_H" },
413 { GSM_LCHAN_UNKNOWN, "UNKNOWN" },
414 { GSM_LCHAN_CCCH, "CCCH" },
415 { GSM_LCHAN_PDTCH, "PDTCH" },
416 { GSM_LCHAN_CBCH, "CBCH" },
417 { 0, NULL },
418};
419
Harald Welte1a8c4e02015-08-16 17:56:25 +0200420static const struct value_string mi_type_names[] = {
421 { GSM_MI_TYPE_NONE, "NONE" },
422 { GSM_MI_TYPE_IMSI, "IMSI" },
423 { GSM_MI_TYPE_IMEI, "IMEI" },
424 { GSM_MI_TYPE_IMEISV, "IMEI-SV" },
425 { GSM_MI_TYPE_TMSI, "TMSI" },
426 { 0, NULL }
427};
428
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200429/*! return string representation of Mobile Identity Type */
Harald Welte1a8c4e02015-08-16 17:56:25 +0200430const char *gsm48_mi_type_name(uint8_t mi)
431{
432 return get_value_string(mi_type_names, mi);
433}
434
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200435/*! Checks is particular message is cipherable in A/Gb mode according to
Maxfdca25d2016-07-05 16:06:28 +0200436 * 3GPP TS 24.008 § 4.7.1.2
437 * \param[in] hdr Message header
438 * \return true if message can be encrypted, false otherwise
439 */
440bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr)
441{
442 switch(hdr->msg_type) {
443 case GSM48_MT_GMM_ATTACH_REQ:
444 case GSM48_MT_GMM_ATTACH_REJ:
445 case GSM48_MT_GMM_AUTH_CIPH_REQ:
446 case GSM48_MT_GMM_AUTH_CIPH_RESP:
447 case GSM48_MT_GMM_AUTH_CIPH_REJ:
448 case GSM48_MT_GMM_AUTH_CIPH_FAIL:
449 case GSM48_MT_GMM_ID_REQ:
450 case GSM48_MT_GMM_ID_RESP:
451 case GSM48_MT_GMM_RA_UPD_REQ:
452 case GSM48_MT_GMM_RA_UPD_REJ:
453 return false;
454 default:
455 return true;
456 }
457}
458
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100459/* Convert MCC + MNC to BCD representation, legacy implementation.
460 * Instead use osmo_plmn_to_bcd(), which is also capable of converting
461 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100462void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Harald Welte61e2bfc2010-03-04 10:53:03 +0100463{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100464 const struct osmo_plmn_id plmn = {
465 .mcc = mcc,
466 .mnc = mnc,
467 .mnc_3_digits = false,
468 };
469 osmo_plmn_to_bcd(bcd_dst, &plmn);
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100470}
Harald Welte61e2bfc2010-03-04 10:53:03 +0100471
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100472/* Convert given 3-byte BCD buffer to integers, legacy implementation.
473 * Instead use osmo_plmn_from_bcd(), which is also capable of converting
474 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100475void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
476{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100477 struct osmo_plmn_id plmn;
478 osmo_plmn_from_bcd(bcd_src, &plmn);
479 *mcc = plmn.mcc;
480 *mnc = plmn.mnc;
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100481}
482
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100483/*! Encode TS 04.08 Location Area Identifier, legacy implementation.
484 * Instead use gsm48_generate_lai2(), which is capable of three-digit MNC with leading zeros.
485 * \param[out] lai48 caller-provided memory for output
Harald Welte96e2a002017-06-12 21:44:18 +0200486 * \param[in] mcc Mobile Country Code
487 * \param[in] mnc Mobile Network Code
488 * \param[in] lac Location Area Code */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100489void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
490 uint16_t mnc, uint16_t lac)
491{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100492 const struct osmo_location_area_id lai = {
493 .plmn = {
494 .mcc = mcc,
495 .mnc = mnc,
496 .mnc_3_digits = false,
497 },
498 .lac = lac,
499 };
500 gsm48_generate_lai2(lai48, &lai);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100501}
502
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100503/*! Encode TS 04.08 Location Area Identifier.
504 * \param[out] lai48 caller-provided memory for output.
505 * \param[in] lai input of MCC-MNC-LAC. */
506void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai)
507{
508 osmo_plmn_to_bcd(&lai48->digits[0], &lai->plmn);
509 lai48->lac = osmo_htons(lai->lac);
510}
511
512/*! Decode TS 04.08 Location Area Identifier, legacy implementation.
513 * Instead use gsm48_decode_lai2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200514 * \param[in] Location Area Identifier (encoded)
515 * \param[out] mcc Mobile Country Code
516 * \param[out] mnc Mobile Network Code
517 * \param[out] lac Location Area Code
518 * \returns 0
519 *
520 * Attention: this function returns true integers, not hex! */
Harald Welte774a9de2012-07-13 21:35:13 +0200521int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
522 uint16_t *mnc, uint16_t *lac)
523{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100524 struct osmo_location_area_id decoded;
525 gsm48_decode_lai2(lai, &decoded);
526 *mcc = decoded.plmn.mcc;
527 *mnc = decoded.plmn.mnc;
528 *lac = decoded.lac;
Harald Welte774a9de2012-07-13 21:35:13 +0200529 return 0;
530}
531
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100532/*! Decode TS 04.08 Location Area Identifier.
533 * \param[in] Location Area Identifier (encoded).
534 * \param[out] decoded Target buffer to write decoded values of MCC-MNC-LAC.
535 *
536 * Attention: this function returns true integers, not hex! */
537void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded)
538{
539 osmo_plmn_from_bcd(&lai->digits[0], &decoded->plmn);
540 decoded->lac = osmo_ntohs(lai->lac);
541}
542
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200543/*! Set DTX mode in Cell Options IE (3GPP TS 44.018)
Maxfe65fa72016-05-10 17:17:05 +0200544 * \param[in] op Cell Options structure in which DTX parameters will be set
545 * \param[in] full Mode for full-rate channels
546 * \param[in] half Mode for half-rate channels
547 * \param[in] is_bcch Indicates if we should use 10.5.2.3.1 instead of
548 * 10.5.2.3a.2
549 *
550 * There is no space for separate DTX settings for Full and Half rate channels
551 * in BCCH - in this case full setting is used for both and half parameter is
552 * ignored.
553 */
554void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
555 enum gsm48_dtx_mode half, bool is_bcch)
556{
557 if (is_bcch) {
558 switch (full) {
559 case GSM48_DTX_MAY_BE_USED:
560 op->dtx = 0;
561 return;
562 case GSM48_DTX_SHALL_BE_USED:
563 op->dtx = 1;
564 return;
565 case GSM48_DTX_SHALL_NOT_BE_USED:
566 op->dtx = 2;
567 return;
568 }
569 } else {
570 switch (full) {
571 case GSM48_DTX_MAY_BE_USED:
572 op->dtx = (half == GSM48_DTX_SHALL_BE_USED) ? 3 : 0;
573 op->d = (half == GSM48_DTX_SHALL_NOT_BE_USED) ? 0 : 1;
574 return;
575 case GSM48_DTX_SHALL_BE_USED:
576 op->dtx = (half == GSM48_DTX_MAY_BE_USED) ? 3 : 1;
577 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
578 return;
579 case GSM48_DTX_SHALL_NOT_BE_USED:
580 op->dtx = 2;
581 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
582 return;
583 }
584 }
585}
586
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200587/*! Generate TS 04.08 Mobile ID from TMSI
Harald Welte96e2a002017-06-12 21:44:18 +0200588 * \param[out] buf Caller-provided output buffer (7 bytes)
589 * \param[in] tmsi TMSI to be encoded
590 * \returns number of byes encoded (always 7) */
Harald Welte61e2bfc2010-03-04 10:53:03 +0100591int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
592{
Harald Welte95871da2017-05-15 12:11:36 +0200593 uint32_t tmsi_be = osmo_htonl(tmsi);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100594
595 buf[0] = GSM48_IE_MOBILE_ID;
596 buf[1] = GSM48_TMSI_LEN;
597 buf[2] = 0xf0 | GSM_MI_TYPE_TMSI;
Holger Hans Peter Freythercd252e32013-07-03 09:56:53 +0200598 memcpy(&buf[3], &tmsi_be, sizeof(tmsi_be));
Harald Welte61e2bfc2010-03-04 10:53:03 +0100599
600 return 7;
601}
602
Maxebf14922018-02-15 11:42:11 +0100603/*! Generate TS 24.008 §10.5.1.4 Mobile ID
604 * \param[out] buf Caller-provided output buffer
605 * \param[in] id Identity to be encoded
606 * \returns number of bytes used in \a buf */
607uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
608{
609 uint8_t length = strnlen(id, 255), i, off = 0, odd = (length & 1) == 1;
610
611 buf[0] = GSM48_IE_MOBILE_ID;
612 buf[2] = osmo_char2bcd(id[0]) << 4 | mi_type | (odd << 3);
613
614 /* if the length is even we will fill half of the last octet */
615 buf[1] = (length + (odd ? 1 : 2)) >> 1;
616
617 for (i = 1; i < buf[1]; ++i) {
618 uint8_t upper, lower = osmo_char2bcd(id[++off]);
619 if (!odd && off + 1 == length)
620 upper = 0x0f;
621 else
622 upper = osmo_char2bcd(id[++off]) & 0x0f;
623
624 buf[2 + i] = (upper << 4) | lower;
625 }
626
627 return 2 + buf[1];
628}
629
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200630/*! Generate TS 04.08 Mobile ID from IMSI
Harald Welte96e2a002017-06-12 21:44:18 +0200631 * \param[out] buf Caller-provided output buffer
632 * \param[in] imsi IMSI to be encoded
633 * \returns number of bytes used in \a buf */
Harald Welte61e2bfc2010-03-04 10:53:03 +0100634int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
635{
Maxebf14922018-02-15 11:42:11 +0100636 return gsm48_generate_mid(buf, imsi, GSM_MI_TYPE_IMSI);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100637}
Harald Welte9bb553e2010-03-28 18:14:50 +0800638
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200639/*! Convert TS 04.08 Mobile Identity (10.5.1.4) to string
Harald Welte96e2a002017-06-12 21:44:18 +0200640 * \param[out] string Caller-provided buffer for output
641 * \param[in] str_len Length of \a string in bytes
642 * \param[in] mi Mobile Identity to be stringified
643 * \param[in] mi_len Length of \a mi in bytes
644 * \returns length of string written to \a string */
Harald Welte163d0ea2010-04-09 07:57:40 +0200645int gsm48_mi_to_string(char *string, const int str_len, const uint8_t *mi,
646 const int mi_len)
Harald Welte9bb553e2010-03-28 18:14:50 +0800647{
648 int i;
Harald Welte163d0ea2010-04-09 07:57:40 +0200649 uint8_t mi_type;
Harald Welte9bb553e2010-03-28 18:14:50 +0800650 char *str_cur = string;
Harald Welte163d0ea2010-04-09 07:57:40 +0200651 uint32_t tmsi;
Harald Welte9bb553e2010-03-28 18:14:50 +0800652
653 mi_type = mi[0] & GSM_MI_TYPE_MASK;
654
655 switch (mi_type) {
656 case GSM_MI_TYPE_NONE:
657 break;
658 case GSM_MI_TYPE_TMSI:
Holger Freyther45abec22016-05-20 19:21:27 +0000659 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
Harald Welte9bb553e2010-03-28 18:14:50 +0800660 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
Harald Welte95871da2017-05-15 12:11:36 +0200661 tmsi = osmo_load32be(&mi[1]);
Pau Espin Pedrol45735022017-06-18 14:05:24 +0200662 return snprintf(string, str_len, "%"PRIu32, tmsi);
Harald Welte9bb553e2010-03-28 18:14:50 +0800663 }
664 break;
665 case GSM_MI_TYPE_IMSI:
666 case GSM_MI_TYPE_IMEI:
667 case GSM_MI_TYPE_IMEISV:
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200668 *str_cur++ = osmo_bcd2char(mi[0] >> 4);
Harald Welte9bb553e2010-03-28 18:14:50 +0800669
670 for (i = 1; i < mi_len; i++) {
671 if (str_cur + 2 >= string + str_len)
672 return str_cur - string;
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200673 *str_cur++ = osmo_bcd2char(mi[i] & 0xf);
Harald Welte9bb553e2010-03-28 18:14:50 +0800674 /* skip last nibble in last input byte when GSM_EVEN */
675 if( (i != mi_len-1) || (mi[0] & GSM_MI_ODD))
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200676 *str_cur++ = osmo_bcd2char(mi[i] >> 4);
Harald Welte9bb553e2010-03-28 18:14:50 +0800677 }
678 break;
679 default:
680 break;
681 }
682 *str_cur++ = '\0';
683
684 return str_cur - string;
685}
Harald Weltea1c4f762010-05-01 11:59:42 +0200686
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200687/*! Parse TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200688 * \param[out] Caller-provided memory for decoded RA ID
689 * \param[in] buf Input buffer pointing to RAI IE value */
Harald Weltea1c4f762010-05-01 11:59:42 +0200690void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
691{
692 raid->mcc = (buf[0] & 0xf) * 100;
693 raid->mcc += (buf[0] >> 4) * 10;
694 raid->mcc += (buf[1] & 0xf) * 1;
695
696 /* I wonder who came up with the stupidity of encoding the MNC
697 * differently depending on how many digits its decimal number has! */
698 if ((buf[1] >> 4) == 0xf) {
699 raid->mnc = (buf[2] & 0xf) * 10;
700 raid->mnc += (buf[2] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100701 raid->mnc_3_digits = false;
Harald Weltea1c4f762010-05-01 11:59:42 +0200702 } else {
703 raid->mnc = (buf[2] & 0xf) * 100;
704 raid->mnc += (buf[2] >> 4) * 10;
705 raid->mnc += (buf[1] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100706 raid->mnc_3_digits = true;
Harald Weltea1c4f762010-05-01 11:59:42 +0200707 }
708
Harald Welte95871da2017-05-15 12:11:36 +0200709 raid->lac = osmo_load16be(buf + 3);
Harald Weltea1c4f762010-05-01 11:59:42 +0200710 raid->rac = buf[5];
711}
Harald Welte35a93942010-05-01 14:25:22 +0200712
Maxf1ad60e2018-01-05 14:19:33 +0100713/*! Encode a 3GPP TS 24.008 § 10.5.5.15 Routing area identification
714 * \param[out] out Caller-provided packed struct
715 * \param[in] raid Routing Area ID to be encoded
716 */
717void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid)
718{
719 out->lac = osmo_htons(raid->lac);
720 out->rac = raid->rac;
721
722 out->digits[0] = ((raid->mcc / 100) % 10) | (((raid->mcc / 10) % 10) << 4);
723 out->digits[1] = raid->mcc % 10;
724
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100725 if (raid->mnc < 100 && !raid->mnc_3_digits) {
Maxf1ad60e2018-01-05 14:19:33 +0100726 out->digits[1] |= 0xf0;
727 out->digits[2] = ((raid->mnc / 10) % 10) | ((raid->mnc % 10) << 4);
728 } else {
729 out->digits[1] |= (raid->mnc % 10) << 4;
730 out->digits[2] = ((raid->mnc / 100) % 10) | (((raid->mnc / 10) % 10) << 4);
731 }
732}
733
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200734/*! Encode a TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200735 * \param[out] buf Caller-provided output buffer of 6 bytes
736 * \param[in] raid Routing Area ID to be encoded
737 * \returns number of bytes used in \a buf */
Harald Welte35a93942010-05-01 14:25:22 +0200738int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
739{
Maxf1ad60e2018-01-05 14:19:33 +0100740 gsm48_encode_ra((struct gsm48_ra_id *)buf, raid);
Harald Welte35a93942010-05-01 14:25:22 +0200741
742 return 6;
743}
Harald Welte2aee7b12011-06-26 14:20:04 +0200744
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200745/*! Determine number of paging sub-channels
Harald Welte96e2a002017-06-12 21:44:18 +0200746 * \param[in] chan_desc Control Channel Description
747 * \returns number of paging sub-channels
748 *
749 * Uses From Table 10.5.33 of GSM 04.08 to determine the number of
750 * paging sub-channels in the given control channel configuration
751 */
Harald Welte2aee7b12011-06-26 14:20:04 +0200752int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
753{
Harald Welte94df39e2011-06-26 14:33:57 +0200754 unsigned int n_pag_blocks = gsm0502_get_n_pag_blocks(chan_desc);
755
756 if (chan_desc->ccch_conf == RSL_BCCH_CCCH_CONF_1_C)
757 return OSMO_MAX(1, n_pag_blocks) * (chan_desc->bs_pa_mfrms + 2);
758 else
759 return n_pag_blocks * (chan_desc->bs_pa_mfrms + 2);
Harald Welte2aee7b12011-06-26 14:20:04 +0200760}
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100761
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200762/*! TS 04.08 Protocol Descriptor names */
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100763const struct value_string gsm48_pdisc_names[] = {
Harald Welteea0bc962018-01-24 16:17:45 +0100764 { GSM48_PDISC_GROUP_CC, "VGCC" },
765 { GSM48_PDISC_BCAST_CC, "VBCC" },
766 { GSM48_PDISC_PDSS1, "PDSS1" },
767 { GSM48_PDISC_CC, "CC" },
768 { GSM48_PDISC_PDSS2, "PDSS2" },
769 { GSM48_PDISC_MM, "MM" },
770 { GSM48_PDISC_RR, "RR" },
771 { GSM48_PDISC_MM_GPRS, "GMM" },
772 { GSM48_PDISC_SMS, "SMS" },
773 { GSM48_PDISC_SM_GPRS, "SM" },
774 { GSM48_PDISC_NC_SS, "NCSS" },
775 { GSM48_PDISC_LOC, "LCS" },
776 { GSM48_PDISC_EXTEND, "EXTD" },
777 { GSM48_PDISC_MASK, "MASK" },
778 { GSM48_PDISC_USSD, "USSD" },
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100779 { 0, NULL }
780};
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100781
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200782/*! TS 04.08 RR Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100783const struct value_string gsm48_rr_msgtype_names[] = {
784 OSMO_VALUE_STRING(GSM48_MT_RR_INIT_REQ),
785 OSMO_VALUE_STRING(GSM48_MT_RR_ADD_ASS),
786 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS),
787 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_EXT),
788 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_REJ),
789 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_FAIL),
790 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REJECT),
791 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REQUEST),
792 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_ASS),
793
794 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_CMD),
795 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_COMPL),
796
797 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_CMD),
798 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_ACK),
799 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_REJ),
800
801 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_CMD),
802 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_COMPL),
803 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_FAIL),
804 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_CMD),
805 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_COMPL),
806 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_FAIL),
807 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
808 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
809 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_CMD),
810
811 OSMO_VALUE_STRING(GSM48_MT_RR_CELL_CHG_ORDER),
812 OSMO_VALUE_STRING(GSM48_MT_RR_PDCH_ASS_CMD),
813
814 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_REL),
815 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL),
816 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL_COMP),
817
818 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_1),
819 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_2),
820 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_3),
821 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_RESP),
822 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_NCH),
823 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_FACCH),
824 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_RESP),
825 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_NOTIF),
826 OSMO_VALUE_STRING(GSM48_MT_RR_UTRAN_CLSM_CHG),
827 OSMO_VALUE_STRING(GSM48_MT_RR_CDMA2K_CLSM_CHG),
828 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_UTRAN_HANDO),
829 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_CDMA2K_HANDO),
830
831 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_8),
832 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_1),
833 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2),
834 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_3),
835 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_4),
836 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5),
837 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_6),
838 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_7),
839
840 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2bis),
841 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2ter),
842 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2quater),
843 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5bis),
844 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5ter),
845 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_9),
846 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_13),
847
848 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_16),
849 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_17),
850
851 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_18),
852 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_19),
853 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_20),
854
855 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF),
856 OSMO_VALUE_STRING(GSM48_MT_RR_STATUS),
857 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF_ACK),
858 OSMO_VALUE_STRING(GSM48_MT_RR_FREQ_REDEF),
859 OSMO_VALUE_STRING(GSM48_MT_RR_MEAS_REP),
860 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_CHG),
861 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_ENQ),
862 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP),
863 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP_ORD),
864 OSMO_VALUE_STRING(GSM48_MT_RR_GPRS_SUSP_REQ),
865 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_INFO),
866
867 OSMO_VALUE_STRING(GSM48_MT_RR_VGCS_UPL_GRANT),
868 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_RELEASE),
869 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_FREE),
870 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_BUSY),
871 OSMO_VALUE_STRING(GSM48_MT_RR_TALKER_IND),
872 { 0, NULL }
873};
874
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200875/*! TS 04.08 MM Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100876const struct value_string gsm48_mm_msgtype_names[] = {
877 OSMO_VALUE_STRING(GSM48_MT_MM_IMSI_DETACH_IND),
878 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_ACCEPT),
879 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REJECT),
880 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REQUEST),
881
882 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REJ),
883 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REQ),
884 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_RESP),
885 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_FAIL),
886 OSMO_VALUE_STRING(GSM48_MT_MM_ID_REQ),
887 OSMO_VALUE_STRING(GSM48_MT_MM_ID_RESP),
888 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_CMD),
889 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_COMPL),
890
891 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ACC),
892 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REJ),
893 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ABORT),
894 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REQ),
895 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_PROMPT),
896 OSMO_VALUE_STRING(GSM48_MT_MM_CM_REEST_REQ),
897 OSMO_VALUE_STRING(GSM48_MT_MM_ABORT),
898
899 OSMO_VALUE_STRING(GSM48_MT_MM_NULL),
900 OSMO_VALUE_STRING(GSM48_MT_MM_STATUS),
901 OSMO_VALUE_STRING(GSM48_MT_MM_INFO),
902 { 0, NULL }
903};
904
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200905/*! TS 04.08 CC Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100906const struct value_string gsm48_cc_msgtype_names[] = {
907 OSMO_VALUE_STRING(GSM48_MT_CC_ALERTING),
908 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_CONF),
909 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_PROC),
910 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT),
911 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT_ACK),
912 OSMO_VALUE_STRING(GSM48_MT_CC_EMERG_SETUP),
913 OSMO_VALUE_STRING(GSM48_MT_CC_PROGRESS),
914 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB),
915 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB_CONF),
916 OSMO_VALUE_STRING(GSM48_MT_CC_RECALL),
917 OSMO_VALUE_STRING(GSM48_MT_CC_START_CC),
918 OSMO_VALUE_STRING(GSM48_MT_CC_SETUP),
919
920 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY),
921 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_COMPL),
922 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_REJECT),
923 OSMO_VALUE_STRING(GSM48_MT_CC_USER_INFO),
924 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD),
925 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_ACK),
926 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_REJ),
927 OSMO_VALUE_STRING(GSM48_MT_CC_RETR),
928 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_ACK),
929 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_REJ),
930
931 OSMO_VALUE_STRING(GSM48_MT_CC_DISCONNECT),
932 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE),
933 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE_COMPL),
934
935 OSMO_VALUE_STRING(GSM48_MT_CC_CONG_CTRL),
936 OSMO_VALUE_STRING(GSM48_MT_CC_NOTIFY),
937 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS),
938 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS_ENQ),
939 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF),
940 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF),
941 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF_ACK),
942 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_ACK),
943 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_REJ),
944 OSMO_VALUE_STRING(GSM48_MT_CC_FACILITY),
945 { 0, NULL }
946};
947
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200948/*! Compose a string naming the message type for given protocol.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100949 * If the message type string is known, return the message type name, otherwise
950 * return "<protocol discriminator name>:<message type in hex>".
Harald Welte96e2a002017-06-12 21:44:18 +0200951 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
952 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
953 * \returns statically allocated string or string constant.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100954 */
955const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type)
956{
957 static char namebuf[64];
958 const struct value_string *msgt_names;
959
960 switch (pdisc) {
961 case GSM48_PDISC_RR:
962 msgt_names = gsm48_rr_msgtype_names;
963 break;
964 case GSM48_PDISC_MM:
965 msgt_names = gsm48_mm_msgtype_names;
966 break;
967 case GSM48_PDISC_CC:
968 msgt_names = gsm48_cc_msgtype_names;
969 break;
970 default:
971 msgt_names = NULL;
972 break;
973 }
974
975 if (msgt_names)
976 return get_value_string(msgt_names, msg_type);
977
978 snprintf(namebuf, sizeof(namebuf), "%s:0x%02x",
979 gsm48_pdisc_name(pdisc), msg_type);
980 return namebuf;
981}
Harald Welte96e2a002017-06-12 21:44:18 +0200982
Neels Hofmeyraead2412018-04-06 04:31:00 +0200983const struct value_string gsm48_reject_value_names[] = {
984 { GSM48_REJECT_IMSI_UNKNOWN_IN_HLR, "IMSI_UNKNOWN_IN_HLR" },
985 { GSM48_REJECT_ILLEGAL_MS, "ILLEGAL_MS" },
986 { GSM48_REJECT_IMSI_UNKNOWN_IN_VLR, "IMSI_UNKNOWN_IN_VLR" },
987 { GSM48_REJECT_IMEI_NOT_ACCEPTED, "IMEI_NOT_ACCEPTED" },
988 { GSM48_REJECT_ILLEGAL_ME, "ILLEGAL_ME" },
989 { GSM48_REJECT_PLMN_NOT_ALLOWED, "PLMN_NOT_ALLOWED" },
990 { GSM48_REJECT_LOC_NOT_ALLOWED, "LOC_NOT_ALLOWED" },
991 { GSM48_REJECT_ROAMING_NOT_ALLOWED, "ROAMING_NOT_ALLOWED" },
992 { GSM48_REJECT_NETWORK_FAILURE, "NETWORK_FAILURE" },
993 { GSM48_REJECT_SYNCH_FAILURE, "SYNCH_FAILURE" },
994 { GSM48_REJECT_CONGESTION, "CONGESTION" },
995 { GSM48_REJECT_SRV_OPT_NOT_SUPPORTED, "SRV_OPT_NOT_SUPPORTED" },
996 { GSM48_REJECT_RQD_SRV_OPT_NOT_SUPPORTED, "RQD_SRV_OPT_NOT_SUPPORTED" },
997 { GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER, "SRV_OPT_TMP_OUT_OF_ORDER" },
998 { GSM48_REJECT_CALL_CAN_NOT_BE_IDENTIFIED, "CALL_CAN_NOT_BE_IDENTIFIED" },
999 { GSM48_REJECT_INCORRECT_MESSAGE, "INCORRECT_MESSAGE" },
1000 { GSM48_REJECT_INVALID_MANDANTORY_INF, "INVALID_MANDANTORY_INF" },
1001 { GSM48_REJECT_MSG_TYPE_NOT_IMPLEMENTED, "MSG_TYPE_NOT_IMPLEMENTED" },
1002 { GSM48_REJECT_MSG_TYPE_NOT_COMPATIBLE, "MSG_TYPE_NOT_COMPATIBLE" },
1003 { GSM48_REJECT_INF_ELEME_NOT_IMPLEMENTED, "INF_ELEME_NOT_IMPLEMENTED" },
1004 { GSM48_REJECT_CONDTIONAL_IE_ERROR, "CONDTIONAL_IE_ERROR" },
1005 { GSM48_REJECT_MSG_NOT_COMPATIBLE, "MSG_NOT_COMPATIBLE" },
1006 { GSM48_REJECT_PROTOCOL_ERROR, "PROTOCOL_ERROR" },
1007 { GSM48_REJECT_GPRS_NOT_ALLOWED, "GPRS_NOT_ALLOWED" },
1008 { GSM48_REJECT_SERVICES_NOT_ALLOWED, "SERVICES_NOT_ALLOWED" },
1009 { GSM48_REJECT_MS_IDENTITY_NOT_DERVIVABLE, "MS_IDENTITY_NOT_DERVIVABLE" },
1010 { GSM48_REJECT_IMPLICITLY_DETACHED, "IMPLICITLY_DETACHED" },
1011 { GSM48_REJECT_GPRS_NOT_ALLOWED_IN_PLMN, "GPRS_NOT_ALLOWED_IN_PLMN" },
1012 { GSM48_REJECT_MSC_TMP_NOT_REACHABLE, "MSC_TMP_NOT_REACHABLE" },
1013 { 0, NULL }
1014};
1015
Harald Welte96e2a002017-06-12 21:44:18 +02001016/*! @} */