blob: c497c745dc6b2f637840afbd76795219a0265c9e [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>
Harald Welte179f3572019-03-18 18:38:47 +010039#include <osmocom/core/talloc.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010040#include <osmocom/gsm/tlv.h>
41#include <osmocom/gsm/gsm48.h>
Harald Welte94df39e2011-06-26 14:33:57 +020042#include <osmocom/gsm/gsm0502.h>
Maxfb348ee2016-03-30 21:14:53 +020043#include <osmocom/gsm/gsm_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010044#include <osmocom/gsm/protocol/gsm_04_08.h>
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +070045#include <osmocom/gsm/protocol/gsm_04_80.h>
Harald Welte2aee7b12011-06-26 14:20:04 +020046#include <osmocom/gsm/protocol/gsm_08_58.h>
Maxfdca25d2016-07-05 16:06:28 +020047#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
Neels Hofmeyr83025bf2020-05-26 02:45:23 +020048#include <osmocom/gsm/protocol/gsm_23_003.h>
Harald Welte4fb20752010-03-02 23:17:33 +010049
Harald Welte96e2a002017-06-12 21:44:18 +020050/*! \addtogroup gsm0408
51 * @{
Neels Hofmeyr87e45502017-06-20 00:17:59 +020052 * GSM Mobile Radion Interface L3 messages / TS 04.08
Harald Welte96e2a002017-06-12 21:44:18 +020053 */
54
Neels Hofmeyr87e45502017-06-20 00:17:59 +020055/*! TLV parser definitions for TS 04.08 CC */
Harald Welte4fb20752010-03-02 23:17:33 +010056const struct tlv_definition gsm48_att_tlvdef = {
57 .def = {
58 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
59 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
60 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
61 [GSM48_IE_UTC] = { TLV_TYPE_TV },
62 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
63 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
64
65 [GSM48_IE_BEARER_CAP] = { TLV_TYPE_TLV },
66 [GSM48_IE_CAUSE] = { TLV_TYPE_TLV },
67 [GSM48_IE_CC_CAP] = { TLV_TYPE_TLV },
68 [GSM48_IE_ALERT] = { TLV_TYPE_TLV },
69 [GSM48_IE_FACILITY] = { TLV_TYPE_TLV },
70 [GSM48_IE_PROGR_IND] = { TLV_TYPE_TLV },
71 [GSM48_IE_AUX_STATUS] = { TLV_TYPE_TLV },
72 [GSM48_IE_NOTIFY] = { TLV_TYPE_TV },
73 [GSM48_IE_KPD_FACILITY] = { TLV_TYPE_TV },
74 [GSM48_IE_SIGNAL] = { TLV_TYPE_TV },
75 [GSM48_IE_CONN_BCD] = { TLV_TYPE_TLV },
76 [GSM48_IE_CONN_SUB] = { TLV_TYPE_TLV },
77 [GSM48_IE_CALLING_BCD] = { TLV_TYPE_TLV },
78 [GSM48_IE_CALLING_SUB] = { TLV_TYPE_TLV },
79 [GSM48_IE_CALLED_BCD] = { TLV_TYPE_TLV },
80 [GSM48_IE_CALLED_SUB] = { TLV_TYPE_TLV },
81 [GSM48_IE_REDIR_BCD] = { TLV_TYPE_TLV },
82 [GSM48_IE_REDIR_SUB] = { TLV_TYPE_TLV },
83 [GSM48_IE_LOWL_COMPAT] = { TLV_TYPE_TLV },
84 [GSM48_IE_HIGHL_COMPAT] = { TLV_TYPE_TLV },
85 [GSM48_IE_USER_USER] = { TLV_TYPE_TLV },
86 [GSM48_IE_SS_VERS] = { TLV_TYPE_TLV },
87 [GSM48_IE_MORE_DATA] = { TLV_TYPE_T },
88 [GSM48_IE_CLIR_SUPP] = { TLV_TYPE_T },
89 [GSM48_IE_CLIR_INVOC] = { TLV_TYPE_T },
90 [GSM48_IE_REV_C_SETUP] = { TLV_TYPE_T },
91 [GSM48_IE_REPEAT_CIR] = { TLV_TYPE_T },
92 [GSM48_IE_REPEAT_SEQ] = { TLV_TYPE_T },
93 /* FIXME: more elements */
94 },
95};
96
Neels Hofmeyr87e45502017-06-20 00:17:59 +020097/*! TLV parser definitions for TS 04.08 RR */
Andreas Eversberg014cb872010-07-12 09:11:00 +020098const struct tlv_definition gsm48_rr_att_tlvdef = {
99 .def = {
100 /* NOTE: Don't add IE 17 = MOBILE_ID here, it already used. */
101 [GSM48_IE_VGCS_TARGET] = { TLV_TYPE_TLV },
102 [GSM48_IE_FRQSHORT_AFTER] = { TLV_TYPE_FIXED, 9 },
103 [GSM48_IE_MUL_RATE_CFG] = { TLV_TYPE_TLV },
104 [GSM48_IE_FREQ_L_AFTER] = { TLV_TYPE_TLV },
105 [GSM48_IE_MSLOT_DESC] = { TLV_TYPE_TLV },
106 [GSM48_IE_CHANMODE_2] = { TLV_TYPE_TV },
107 [GSM48_IE_FRQSHORT_BEFORE] = { TLV_TYPE_FIXED, 9 },
108 [GSM48_IE_CHANMODE_3] = { TLV_TYPE_TV },
109 [GSM48_IE_CHANMODE_4] = { TLV_TYPE_TV },
110 [GSM48_IE_CHANMODE_5] = { TLV_TYPE_TV },
111 [GSM48_IE_CHANMODE_6] = { TLV_TYPE_TV },
112 [GSM48_IE_CHANMODE_7] = { TLV_TYPE_TV },
113 [GSM48_IE_CHANMODE_8] = { TLV_TYPE_TV },
114 [GSM48_IE_FREQ_L_BEFORE] = { TLV_TYPE_TLV },
115 [GSM48_IE_CH_DESC_1_BEFORE] = { TLV_TYPE_FIXED, 3 },
116 [GSM48_IE_CH_DESC_2_BEFORE] = { TLV_TYPE_FIXED, 3 },
117 [GSM48_IE_F_CH_SEQ_BEFORE] = { TLV_TYPE_FIXED, 9 },
118 [GSM48_IE_CLASSMARK3] = { TLV_TYPE_TLV },
119 [GSM48_IE_MA_BEFORE] = { TLV_TYPE_TLV },
120 [GSM48_IE_RR_PACKET_UL] = { TLV_TYPE_TLV },
121 [GSM48_IE_RR_PACKET_DL] = { TLV_TYPE_TLV },
122 [GSM48_IE_CELL_CH_DESC] = { TLV_TYPE_FIXED, 16 },
123 [GSM48_IE_CHANMODE_1] = { TLV_TYPE_TV },
124 [GSM48_IE_CHDES_2_AFTER] = { TLV_TYPE_FIXED, 3 },
125 [GSM48_IE_MODE_SEC_CH] = { TLV_TYPE_TV },
126 [GSM48_IE_F_CH_SEQ_AFTER] = { TLV_TYPE_FIXED, 9 },
127 [GSM48_IE_MA_AFTER] = { TLV_TYPE_TLV },
128 [GSM48_IE_BA_RANGE] = { TLV_TYPE_TLV },
129 [GSM48_IE_GROUP_CHDES] = { TLV_TYPE_TLV },
130 [GSM48_IE_BA_LIST_PREF] = { TLV_TYPE_TLV },
131 [GSM48_IE_MOB_OVSERV_DIF] = { TLV_TYPE_TLV },
132 [GSM48_IE_REALTIME_DIFF] = { TLV_TYPE_TLV },
133 [GSM48_IE_START_TIME] = { TLV_TYPE_FIXED, 2 },
134 [GSM48_IE_TIMING_ADVANCE] = { TLV_TYPE_TV },
135 [GSM48_IE_GROUP_CIP_SEQ] = { TLV_TYPE_SINGLE_TV },
136 [GSM48_IE_CIP_MODE_SET] = { TLV_TYPE_SINGLE_TV },
137 [GSM48_IE_GPRS_RESUMPT] = { TLV_TYPE_SINGLE_TV },
138 [GSM48_IE_SYNC_IND] = { TLV_TYPE_SINGLE_TV },
139 },
140};
141
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200142/*! TLV parser definitions for TS 04.08 MM */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200143const struct tlv_definition gsm48_mm_att_tlvdef = {
144 .def = {
145 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
146 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
147 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
148 [GSM48_IE_UTC] = { TLV_TYPE_TV },
149 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
150 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
Jacob Erlbeck1c3f0882013-09-16 10:29:57 +0200151 [GSM48_IE_NET_DST] = { TLV_TYPE_TLV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200152
153 [GSM48_IE_LOCATION_AREA] = { TLV_TYPE_FIXED, 5 },
154 [GSM48_IE_PRIORITY_LEV] = { TLV_TYPE_SINGLE_TV },
155 [GSM48_IE_FOLLOW_ON_PROC] = { TLV_TYPE_T },
156 [GSM48_IE_CTS_PERMISSION] = { TLV_TYPE_T },
157 },
158};
159
Harald Weltee9e190a2010-03-25 11:44:57 +0800160static const struct value_string rr_cause_names[] = {
161 { GSM48_RR_CAUSE_NORMAL, "Normal event" },
162 { GSM48_RR_CAUSE_ABNORMAL_UNSPEC, "Abnormal release, unspecified" },
163 { GSM48_RR_CAUSE_ABNORMAL_UNACCT, "Abnormal release, channel unacceptable" },
164 { GSM48_RR_CAUSE_ABNORMAL_TIMER, "Abnormal release, timer expired" },
165 { GSM48_RR_CAUSE_ABNORMAL_NOACT, "Abnormal release, no activity on radio path" },
166 { GSM48_RR_CAUSE_PREMPTIVE_REL, "Preemptive release" },
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +0700167 { GSM48_RR_CAUSE_UTRAN_CFG_UNK, "UTRAN configuration unknown" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800168 { GSM48_RR_CAUSE_HNDOVER_IMP, "Handover impossible, timing advance out of range" },
169 { GSM48_RR_CAUSE_CHAN_MODE_UNACCT, "Channel mode unacceptable" },
170 { GSM48_RR_CAUSE_FREQ_NOT_IMPL, "Frequency not implemented" },
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +0700171 { GSM48_RR_CAUSE_LEAVE_GROUP_CA, "Originator or talker leaving group call area" },
172 { GSM48_RR_CAUSE_LOW_LEVEL_FAIL, "Lower layer failure" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800173 { GSM48_RR_CAUSE_CALL_CLEARED, "Call already cleared" },
174 { GSM48_RR_CAUSE_SEMANT_INCORR, "Semantically incorrect message" },
175 { GSM48_RR_CAUSE_INVALID_MAND_INF, "Invalid mandatory information" },
Vadim Yanitskiy65954ba2020-10-29 18:08:52 +0700176 { GSM48_RR_CAUSE_MSG_TYPE_N, "Message type non-existent or not implemented" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800177 { GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT, "Message type not compatible with protocol state" },
178 { GSM48_RR_CAUSE_COND_IE_ERROR, "Conditional IE error" },
179 { GSM48_RR_CAUSE_NO_CELL_ALLOC_A, "No cell allocation available" },
180 { GSM48_RR_CAUSE_PROT_ERROR_UNSPC, "Protocol error unspecified" },
181 { 0, NULL },
Harald Welte4fb20752010-03-02 23:17:33 +0100182};
183
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200184/*! return string representation of RR Cause value */
Philippada00422016-10-27 13:30:16 +0200185const char *rr_cause_name(uint8_t cause)
186{
187 return get_value_string(rr_cause_names, cause);
188}
189
Harald Welte4a62eda2019-03-18 18:27:00 +0100190/*! Return MCC-MNC-LAC-RAC as string, in a caller-provided output buffer.
191 * \param[out] buf caller-provided output buffer
192 * \param[in] buf_len size of buf in bytes
193 * \param[in] rai RAI to encode.
194 * \returns buf
195 */
196char *osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai)
197{
198 snprintf(buf, buf_len, "%s-%s-%u-%u",
199 osmo_mcc_name(rai->mcc), osmo_mnc_name(rai->mnc, rai->mnc_3_digits), rai->lac,
200 rai->rac);
201 return buf;
202}
203
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100204/*! Return MCC-MNC-LAC-RAC as string, in a static buffer.
205 * \param[in] rai RAI to encode.
206 * \returns Static string buffer.
207 */
208const char *osmo_rai_name(const struct gprs_ra_id *rai)
209{
Harald Welte171ef822019-03-28 10:49:05 +0100210 static __thread char buf[32];
Harald Welte4a62eda2019-03-18 18:27:00 +0100211 return osmo_rai_name_buf(buf, sizeof(buf), rai);
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100212}
213
Harald Welte179f3572019-03-18 18:38:47 +0100214/*! Return MCC-MNC-LAC-RAC as string, in dynamically-allocated output buffer.
215 * \param[in] ctx talloc context from which to allocate output buffer
216 * \param[in] rai RAI to encode.
217 * \returns string representation in dynamically-allocated output buffer.
218 */
219char *osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai)
220{
221 char *buf = talloc_size(ctx, 32);
222 if (!buf)
223 return NULL;
224 return osmo_rai_name_buf(buf, 32, rai);
225}
226
Harald Welte9eb6d882010-03-25 12:00:54 +0800227/* FIXME: convert to value_string */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200228static const char *cc_state_names[32] = {
Harald Welte4fb20752010-03-02 23:17:33 +0100229 "NULL",
230 "INITIATED",
Andreas Eversberg1ef041f2010-04-09 07:52:12 +0200231 "MM_CONNECTION_PEND",
Harald Welte4fb20752010-03-02 23:17:33 +0100232 "MO_CALL_PROC",
233 "CALL_DELIVERED",
234 "illegal state 5",
235 "CALL_PRESENT",
236 "CALL_RECEIVED",
237 "CONNECT_REQUEST",
238 "MO_TERM_CALL_CONF",
239 "ACTIVE",
240 "DISCONNECT_REQ",
241 "DISCONNECT_IND",
242 "illegal state 13",
243 "illegal state 14",
244 "illegal state 15",
245 "illegal state 16",
246 "illegal state 17",
247 "illegal state 18",
248 "RELEASE_REQ",
249 "illegal state 20",
250 "illegal state 21",
251 "illegal state 22",
252 "illegal state 23",
253 "illegal state 24",
254 "illegal state 25",
255 "MO_ORIG_MODIFY",
256 "MO_TERM_MODIFY",
257 "CONNECT_IND",
258 "illegal state 29",
259 "illegal state 30",
260 "illegal state 31",
261};
262
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200263/*! return string representation of CC State */
Harald Welte9eb6d882010-03-25 12:00:54 +0800264const char *gsm48_cc_state_name(uint8_t state)
265{
266 if (state < ARRAY_SIZE(cc_state_names))
267 return cc_state_names[state];
268
269 return "invalid";
270}
271
272static const struct value_string cc_msg_names[] = {
273 { GSM48_MT_CC_ALERTING, "ALERTING" },
274 { GSM48_MT_CC_CALL_PROC, "CALL_PROC" },
275 { GSM48_MT_CC_PROGRESS, "PROGRESS" },
276 { GSM48_MT_CC_ESTAB, "ESTAB" },
277 { GSM48_MT_CC_SETUP, "SETUP" },
278 { GSM48_MT_CC_ESTAB_CONF, "ESTAB_CONF" },
279 { GSM48_MT_CC_CONNECT, "CONNECT" },
280 { GSM48_MT_CC_CALL_CONF, "CALL_CONF" },
281 { GSM48_MT_CC_START_CC, "START_CC" },
282 { GSM48_MT_CC_RECALL, "RECALL" },
283 { GSM48_MT_CC_EMERG_SETUP, "EMERG_SETUP" },
284 { GSM48_MT_CC_CONNECT_ACK, "CONNECT_ACK" },
285 { GSM48_MT_CC_USER_INFO, "USER_INFO" },
286 { GSM48_MT_CC_MODIFY_REJECT, "MODIFY_REJECT" },
287 { GSM48_MT_CC_MODIFY, "MODIFY" },
288 { GSM48_MT_CC_HOLD, "HOLD" },
289 { GSM48_MT_CC_HOLD_ACK, "HOLD_ACK" },
290 { GSM48_MT_CC_HOLD_REJ, "HOLD_REJ" },
291 { GSM48_MT_CC_RETR, "RETR" },
292 { GSM48_MT_CC_RETR_ACK, "RETR_ACK" },
293 { GSM48_MT_CC_RETR_REJ, "RETR_REJ" },
294 { GSM48_MT_CC_MODIFY_COMPL, "MODIFY_COMPL" },
295 { GSM48_MT_CC_DISCONNECT, "DISCONNECT" },
296 { GSM48_MT_CC_RELEASE_COMPL, "RELEASE_COMPL" },
297 { GSM48_MT_CC_RELEASE, "RELEASE" },
298 { GSM48_MT_CC_STOP_DTMF, "STOP_DTMF" },
299 { GSM48_MT_CC_STOP_DTMF_ACK, "STOP_DTMF_ACK" },
300 { GSM48_MT_CC_STATUS_ENQ, "STATUS_ENQ" },
301 { GSM48_MT_CC_START_DTMF, "START_DTMF" },
302 { GSM48_MT_CC_START_DTMF_ACK, "START_DTMF_ACK" },
303 { GSM48_MT_CC_START_DTMF_REJ, "START_DTMF_REJ" },
304 { GSM48_MT_CC_CONG_CTRL, "CONG_CTRL" },
305 { GSM48_MT_CC_FACILITY, "FACILITY" },
306 { GSM48_MT_CC_STATUS, "STATUS" },
307 { GSM48_MT_CC_NOTIFY, "NOTFIY" },
308 { 0, NULL }
Harald Welte61e2bfc2010-03-04 10:53:03 +0100309};
310
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200311/*! return string representation of CC Message Type */
Harald Welte9eb6d882010-03-25 12:00:54 +0800312const char *gsm48_cc_msg_name(uint8_t msgtype)
313{
314 return get_value_string(cc_msg_names, msgtype);
315}
Harald Welte4fb20752010-03-02 23:17:33 +0100316
Philipp72e43f02016-10-27 13:35:20 +0200317
318static const struct value_string rr_msg_names[] = {
319 /* Channel establishment messages */
320 { GSM48_MT_RR_INIT_REQ, "RR INITIALISATION REQUEST" },
321 { GSM48_MT_RR_ADD_ASS, "ADDITIONAL ASSIGNMENT" },
322 { GSM48_MT_RR_IMM_ASS, "IMMEDIATE ASSIGNMENT" },
323 { GSM48_MT_RR_IMM_ASS_EXT, "MMEDIATE ASSIGNMENT EXTENDED" },
324 { GSM48_MT_RR_IMM_ASS_REJ, "IMMEDIATE ASSIGNMENT REJECT" },
325 { GSM48_MT_RR_DTM_ASS_FAIL, "DTM ASSIGNMENT FAILURE" },
326 { GSM48_MT_RR_DTM_REJECT, "DTM REJECT" },
327 { GSM48_MT_RR_DTM_REQUEST, "DTM REQUEST" },
328 { GSM48_MT_RR_PACKET_ASS, "PACKET ASSIGNMENT" },
329
330 /* Ciphering messages */
331 { GSM48_MT_RR_CIPH_M_CMD, "CIPHERING MODE COMMAND" },
332 { GSM48_MT_RR_CIPH_M_COMPL, "CIPHERING MODE COMPLETE" },
333
334 /* Configuration change messages */
335 { GSM48_MT_RR_CFG_CHG_CMD, "CONFIGURATION CHANGE COMMAND" },
336 { GSM48_MT_RR_CFG_CHG_ACK, "CONFIGURATION CHANGE ACK" },
337 { GSM48_MT_RR_CFG_CHG_REJ, "CONFIGURATION CHANGE REJECT" },
338
339 /* Handover messages */
340 { GSM48_MT_RR_ASS_CMD, "ASSIGNMENT COMMAND" },
341 { GSM48_MT_RR_ASS_COMPL, "ASSIGNMENT COMPLETE" },
342 { GSM48_MT_RR_ASS_FAIL, "ASSIGNMENT FAILURE" },
343 { GSM48_MT_RR_HANDO_CMD, "HANDOVER COMMAND" },
344 { GSM48_MT_RR_HANDO_COMPL, "HANDOVER COMPLETE" },
345 { GSM48_MT_RR_HANDO_FAIL, "HANDOVER FAILURE" },
346 { GSM48_MT_RR_HANDO_INFO, "PHYSICAL INFORMATION" },
347 { GSM48_MT_RR_DTM_ASS_CMD, "DTM ASSIGNMENT COMMAND" },
348
349 { GSM48_MT_RR_CELL_CHG_ORDER, "RR-CELL CHANGE ORDER" },
350 { GSM48_MT_RR_PDCH_ASS_CMD, "PDCH ASSIGNMENT COMMAND" },
351
352 /* Channel release messages */
353 { GSM48_MT_RR_CHAN_REL, "CHANNEL RELEASE" },
354 { GSM48_MT_RR_PART_REL, "PARTIAL RELEASE" },
355 { GSM48_MT_RR_PART_REL_COMP, "PARTIAL RELEASE COMPLETE" },
356
357 /* Paging and Notification messages */
358 { GSM48_MT_RR_PAG_REQ_1, "PAGING REQUEST TYPE 1" },
359 { GSM48_MT_RR_PAG_REQ_2, "PAGING REQUEST TYPE 2" },
360 { GSM48_MT_RR_PAG_REQ_3, "PAGING REQUEST TYPE 3" },
361 { GSM48_MT_RR_PAG_RESP, "PAGING RESPONSE" },
362 { GSM48_MT_RR_NOTIF_NCH, "NOTIFICATION/NCH" },
363 { GSM48_MT_RR_NOTIF_FACCH, "(Reserved)" },
364 { GSM48_MT_RR_NOTIF_RESP, "NOTIFICATION/RESPONSE" },
365 { GSM48_MT_RR_PACKET_NOTIF, "PACKET NOTIFICATION" },
366 /* 3G Specific messages */
367 { GSM48_MT_RR_UTRAN_CLSM_CHG, "UTRAN Classmark Change" },
368 { GSM48_MT_RR_CDMA2K_CLSM_CHG, "cdma 2000 Classmark Change" },
369 { GSM48_MT_RR_IS_TO_UTRAN_HANDO, "Inter System to UTRAN Handover Command" },
370 { GSM48_MT_RR_IS_TO_CDMA2K_HANDO, "Inter System to cdma2000 Handover Command" },
371
372 /* System information messages */
373 { GSM48_MT_RR_SYSINFO_8, "SYSTEM INFORMATION TYPE 8" },
374 { GSM48_MT_RR_SYSINFO_1, "SYSTEM INFORMATION TYPE 1" },
375 { GSM48_MT_RR_SYSINFO_2, "SYSTEM INFORMATION TYPE 2" },
376 { GSM48_MT_RR_SYSINFO_3, "SYSTEM INFORMATION TYPE 3" },
377 { GSM48_MT_RR_SYSINFO_4, "SYSTEM INFORMATION TYPE 4" },
378 { GSM48_MT_RR_SYSINFO_5, "SYSTEM INFORMATION TYPE 5" },
379 { GSM48_MT_RR_SYSINFO_6, "SYSTEM INFORMATION TYPE 6" },
380 { GSM48_MT_RR_SYSINFO_7, "SYSTEM INFORMATION TYPE 7" },
381 { GSM48_MT_RR_SYSINFO_2bis, "SYSTEM INFORMATION TYPE 2bis" },
382 { GSM48_MT_RR_SYSINFO_2ter, "SYSTEM INFORMATION TYPE 2ter" },
383 { GSM48_MT_RR_SYSINFO_2quater, "SYSTEM INFORMATION TYPE 2quater" },
384 { GSM48_MT_RR_SYSINFO_5bis, "SYSTEM INFORMATION TYPE 5bis" },
385 { GSM48_MT_RR_SYSINFO_5ter, "SYSTEM INFORMATION TYPE 5ter" },
386 { GSM48_MT_RR_SYSINFO_9, "SYSTEM INFORMATION TYPE 9" },
387 { GSM48_MT_RR_SYSINFO_13, "SYSTEM INFORMATION TYPE 13" },
388 { GSM48_MT_RR_SYSINFO_16, "SYSTEM INFORMATION TYPE 16" },
389 { GSM48_MT_RR_SYSINFO_17, "SYSTEM INFORMATION TYPE 17" },
390 { GSM48_MT_RR_SYSINFO_18, "SYSTEM INFORMATION TYPE 18" },
391 { GSM48_MT_RR_SYSINFO_19, "SYSTEM INFORMATION TYPE 19" },
392 { GSM48_MT_RR_SYSINFO_20, "SYSTEM INFORMATION TYPE 20" },
393
394 /* Miscellaneous messages */
395 { GSM48_MT_RR_CHAN_MODE_MODIF, "CHANNEL MODE MODIFY" },
396 { GSM48_MT_RR_STATUS, "RR STATUS" },
397 { GSM48_MT_RR_CHAN_MODE_MODIF_ACK, "CHANNEL MODE MODIFY ACKNOWLEDGE" },
398 { GSM48_MT_RR_FREQ_REDEF, "FREQUENCY REDEFINITION" },
399 { GSM48_MT_RR_MEAS_REP, "MEASUREMENT REPORT" },
400 { GSM48_MT_RR_CLSM_CHG, "CLASSMARK CHANGE" },
401 { GSM48_MT_RR_CLSM_ENQ, "CLASSMARK ENQUIRY" },
402 { GSM48_MT_RR_EXT_MEAS_REP, "EXTENDED MEASUREMENT REPORT" },
403 { GSM48_MT_RR_EXT_MEAS_REP_ORD, "EXTENDED MEASUREMENT ORDER" },
404 { GSM48_MT_RR_GPRS_SUSP_REQ, "GPRS SUSPENSION REQUEST" },
405 { GSM48_MT_RR_DTM_INFO, "DTM INFORMATION" },
406
407 /* VGCS uplink control messages */
408 { GSM48_MT_RR_VGCS_UPL_GRANT, "VGCS UPLINK GRANT" },
409 { GSM48_MT_RR_UPLINK_RELEASE, "UPLINK RELEASE" },
410 { GSM48_MT_RR_UPLINK_FREE, "0c" },
411 { GSM48_MT_RR_UPLINK_BUSY, "UPLINK BUSY" },
412 { GSM48_MT_RR_TALKER_IND, "TALKER INDICATION" },
413
414 /* Application messages */
415 { GSM48_MT_RR_APP_INFO, "Application Information" },
416 { 0, NULL }
417};
418
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200419/*! return string representation of RR Message Type */
Philipp72e43f02016-10-27 13:35:20 +0200420const char *gsm48_rr_msg_name(uint8_t msgtype)
421{
422 return get_value_string(rr_msg_names, msgtype);
423}
424
425
Maxfb348ee2016-03-30 21:14:53 +0200426const struct value_string gsm48_chan_mode_names[] = {
427 { GSM48_CMODE_SIGN, "SIGNALLING" },
428 { GSM48_CMODE_SPEECH_V1, "SPEECH_V1" },
429 { GSM48_CMODE_SPEECH_EFR, "SPEECH_EFR" },
430 { GSM48_CMODE_SPEECH_AMR, "SPEECH_AMR" },
431 { GSM48_CMODE_DATA_14k5, "DATA_14k5" },
432 { GSM48_CMODE_DATA_12k0, "DATA_12k0" },
433 { GSM48_CMODE_DATA_6k0, "DATA_6k0" },
434 { GSM48_CMODE_DATA_3k6, "DATA_3k6" },
435 { 0, NULL },
436};
437
438const struct value_string gsm_chan_t_names[] = {
439 { GSM_LCHAN_NONE, "NONE" },
440 { GSM_LCHAN_SDCCH, "SDCCH" },
441 { GSM_LCHAN_TCH_F, "TCH_F" },
442 { GSM_LCHAN_TCH_H, "TCH_H" },
443 { GSM_LCHAN_UNKNOWN, "UNKNOWN" },
444 { GSM_LCHAN_CCCH, "CCCH" },
445 { GSM_LCHAN_PDTCH, "PDTCH" },
446 { GSM_LCHAN_CBCH, "CBCH" },
447 { 0, NULL },
448};
449
Harald Welte1a8c4e02015-08-16 17:56:25 +0200450static const struct value_string mi_type_names[] = {
451 { GSM_MI_TYPE_NONE, "NONE" },
452 { GSM_MI_TYPE_IMSI, "IMSI" },
453 { GSM_MI_TYPE_IMEI, "IMEI" },
454 { GSM_MI_TYPE_IMEISV, "IMEI-SV" },
455 { GSM_MI_TYPE_TMSI, "TMSI" },
456 { 0, NULL }
457};
458
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200459/*! return string representation of Mobile Identity Type */
Harald Welte1a8c4e02015-08-16 17:56:25 +0200460const char *gsm48_mi_type_name(uint8_t mi)
461{
462 return get_value_string(mi_type_names, mi);
463}
464
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200465/*! Deprecated, see osmo_mobile_identity instead.
466 * Return a human readable representation of a Mobile Identity in caller-provided buffer.
Harald Welte4a62eda2019-03-18 18:27:00 +0100467 * \param[out] buf caller-provided output buffer
468 * \param[in] buf_len size of buf in bytes
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100469 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
470 * \param[in] mi_len Length of mi.
Harald Welte4a62eda2019-03-18 18:27:00 +0100471 * \return buf
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100472 */
Harald Weltea13fb752020-06-16 08:44:42 +0200473char *osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len)
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100474{
Harald Weltea13fb752020-06-16 08:44:42 +0200475 uint8_t mi_type;
476 uint32_t tmsi;
477 char mi_string[GSM48_MI_SIZE];
478
479 mi_type = (mi && mi_len) ? (mi[0] & GSM_MI_TYPE_MASK) : GSM_MI_TYPE_NONE;
480
481 switch (mi_type) {
482 case GSM_MI_TYPE_TMSI:
483 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
484 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
485 tmsi = osmo_load32be(&mi[1]);
486 snprintf(buf, buf_len, "TMSI-0x%08" PRIX32, tmsi);
487 } else {
488 snprintf(buf, buf_len, "TMSI-invalid");
489 }
490 return buf;
491
492 case GSM_MI_TYPE_IMSI:
493 case GSM_MI_TYPE_IMEI:
494 case GSM_MI_TYPE_IMEISV:
495 osmo_bcd2str(mi_string, sizeof(mi_string), mi, 1, (mi_len * 2) - (mi[0] & GSM_MI_ODD ? 0 : 1), true);
496 snprintf(buf, buf_len, "%s-%s", gsm48_mi_type_name(mi_type), mi_string);
497 return buf;
498
499 default:
Neels Hofmeyr6d670322020-05-26 03:12:29 +0200500 snprintf(buf, buf_len, "unknown");
501 return buf;
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100502 }
503}
504
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200505/*! Deprecated, see osmo_mobile_identity instead.
506 * Return a human readable representation of a Mobile Identity in static buffer.
Harald Welte4a62eda2019-03-18 18:27:00 +0100507 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
508 * \param[in] mi_len Length of mi.
509 * \return A string like "IMSI-1234567", "TMSI-0x1234ABCD" or "unknown", "TMSI-invalid"...
510 */
Harald Weltea13fb752020-06-16 08:44:42 +0200511const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
Harald Welte4a62eda2019-03-18 18:27:00 +0100512{
Harald Welte171ef822019-03-28 10:49:05 +0100513 static __thread char mi_name[10 + GSM48_MI_SIZE + 1];
Harald Weltea13fb752020-06-16 08:44:42 +0200514 return osmo_mi_name_buf(mi_name, sizeof(mi_name), mi, mi_len);
Harald Welte4a62eda2019-03-18 18:27:00 +0100515}
516
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200517/*! Deprecated, see osmo_mobile_identity instead.
518 * Return a human readable representation of a Mobile Identity in dynamically-allocated buffer.
Harald Welte179f3572019-03-18 18:38:47 +0100519 * \param[in] ctx talloc context from which to allocate output buffer
520 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
521 * \param[in] mi_len Length of mi.
522 * \return A string like "IMSI-1234567", "TMSI-0x1234ABCD" or "unknown", "TMSI-invalid" in a
523 * dynamically-allocated output buffer.
524 */
Harald Weltea13fb752020-06-16 08:44:42 +0200525char *osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
Harald Welte179f3572019-03-18 18:38:47 +0100526{
Harald Weltea13fb752020-06-16 08:44:42 +0200527 size_t buf_len = 10 + GSM48_MI_SIZE + 1;
528 char *mi_name = talloc_size(ctx, buf_len);
529 if (!mi_name)
530 return NULL;
531 return osmo_mi_name_buf(mi_name, buf_len, mi, mi_len);
Harald Welte179f3572019-03-18 18:38:47 +0100532}
533
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200534/*! Extract Mobile Identity from encoded bytes (3GPP TS 24.008 10.5.1.4).
535 *
536 * On failure (negative return value), mi->type == GSM_MI_TYPE_NONE, mi->string[] is all-zero and mi->tmsi ==
537 * GSM_RESERVED_TMSI.
538 *
539 * On success, mi->type reflects the decoded Mobile Identity type (GSM_MI_TYPE_IMSI, GSM_MI_TYPE_TMSI, GSM_MI_TYPE_IMEI
540 * or GSM_MI_TYPE_IMEISV).
541 *
542 * On success, mi->string always contains a human readable representation of the Mobile Identity digits: IMSI, IMEI and
543 * IMEISV as digits like "12345678", and TMSI as "0x" and 8 hexadecimal digits like "0x1234abcd".
544 *
545 * mi->tmsi contains the uint32_t TMSI value iff the extracted Mobile Identity was a TMSI, or GSM_RESERVED_TMSI
546 * otherwise.
547 *
548 * \param[out] mi Return buffer for decoded Mobile Identity.
549 * \param[in] mi_data The encoded Mobile Identity octets.
550 * \param[in] mi_len Number of octets in mi_data.
551 * \param[in] allow_hex If false, hexadecimal digits (>9) result in an error return value.
552 * \returns 0 on success, negative on error: -EBADMSG = invalid length indication or invalid data,
553 * -EINVAL = unknown Mobile Identity type.
554 */
555int osmo_mobile_identity_decode(struct osmo_mobile_identity *mi, const uint8_t *mi_data, uint8_t mi_len,
556 bool allow_hex)
557{
558 int rc;
559 int nibbles_len;
560 char *str;
561 size_t str_size;
562
563 if (!mi_data || mi_len < 1)
564 return -EBADMSG;
565
566 nibbles_len = (mi_len - 1) * 2 + ((mi_data[0] & GSM_MI_ODD) ? 1 : 0);
567
568 *mi = (struct osmo_mobile_identity){
569 .type = mi_data[0] & GSM_MI_TYPE_MASK,
570 };
571
572 /* First do length checks */
573 switch (mi->type) {
574 case GSM_MI_TYPE_TMSI:
575 mi->tmsi = GSM_RESERVED_TMSI;
576 if (nibbles_len != (GSM23003_TMSI_NUM_BYTES * 2)) {
577 rc = -EBADMSG;
578 goto return_error;
579 }
580 break;
581
582 case GSM_MI_TYPE_IMSI:
583 if (nibbles_len < GSM23003_IMSI_MIN_DIGITS || nibbles_len > GSM23003_IMSI_MAX_DIGITS) {
584 rc = -EBADMSG;
585 goto return_error;
586 }
587 str = mi->imsi;
588 str_size = sizeof(mi->imsi);
589 break;
590
591 case GSM_MI_TYPE_IMEI:
592 if (nibbles_len != GSM23003_IMEI_NUM_DIGITS && nibbles_len != GSM23003_IMEI_NUM_DIGITS_NO_CHK) {
593 rc = -EBADMSG;
594 goto return_error;
595 }
596 str = mi->imei;
597 str_size = sizeof(mi->imei);
598 break;
599
600 case GSM_MI_TYPE_IMEISV:
601 if (nibbles_len != GSM23003_IMEISV_NUM_DIGITS) {
602 rc = -EBADMSG;
603 goto return_error;
604 }
605 str = mi->imeisv;
606 str_size = sizeof(mi->imeisv);
607 break;
608
609 default:
610 rc = -EINVAL;
611 goto return_error;
612 }
613
614 /* Decode BCD digits */
615 switch (mi->type) {
616 case GSM_MI_TYPE_TMSI:
617 /* MI is a 32bit integer TMSI. Length has been checked above. */
618 if ((mi_data[0] & 0xf0) != 0xf0) {
619 /* A TMSI always has the first nibble == 0xf */
620 rc = -EBADMSG;
621 goto return_error;
622 }
623 mi->tmsi = osmo_load32be(&mi_data[1]);
624 return 0;
625
626 case GSM_MI_TYPE_IMSI:
627 case GSM_MI_TYPE_IMEI:
628 case GSM_MI_TYPE_IMEISV:
629 /* If the length is even, the last nibble (higher nibble of last octet) must be 0xf */
630 if (!(mi_data[0] & GSM_MI_ODD)
631 && ((mi_data[mi_len - 1] & 0xf0) != 0xf0)) {
632 rc = -EBADMSG;
633 goto return_error;
634 }
635 rc = osmo_bcd2str(str, str_size, mi_data, 1, 1 + nibbles_len, allow_hex);
636 /* rc checked below */
637 break;
638
639 default:
640 /* Already handled above, but as future bug paranoia: */
641 rc = -EINVAL;
642 goto return_error;
643 }
644
645 /* check mi->str printing rc */
646 if (rc < 1 || rc >= str_size) {
647 rc = -EBADMSG;
648 goto return_error;
649 }
650 return 0;
651
652return_error:
653 *mi = (struct osmo_mobile_identity){
654 .type = GSM_MI_TYPE_NONE,
655 };
656 return rc;
657}
658
659/*! Return the number of encoded Mobile Identity octets, without actually encoding.
660 * Useful to write tag-length header before encoding the MI.
661 * \param[in] mi Mobile Identity.
662 * \param[out] mi_digits If not NULL, store the number of nibbles of used MI data (i.e. strlen(mi->string) or 8 for a TMSI).
663 * \return octets that osmo_mobile_identity_encode_msgb() will write for this mi.
664 */
665int osmo_mobile_identity_encoded_len(const struct osmo_mobile_identity *mi, int *mi_digits)
666{
667 int mi_nibbles;
668 if (!mi)
669 return -EINVAL;
670 switch (mi->type) {
671 case GSM_MI_TYPE_TMSI:
672 mi_nibbles = GSM23003_TMSI_NUM_BYTES * 2;
673 break;
674 case GSM_MI_TYPE_IMSI:
675 mi_nibbles = strlen(mi->imsi);
676 if (mi_nibbles < GSM23003_IMSI_MIN_DIGITS
677 || mi_nibbles > GSM23003_IMSI_MAX_DIGITS)
678 return -EINVAL;
679 break;
680 case GSM_MI_TYPE_IMEI:
681 mi_nibbles = strlen(mi->imei);
682 if (mi_nibbles < GSM23003_IMEI_NUM_DIGITS_NO_CHK
683 || mi_nibbles > GSM23003_IMEI_NUM_DIGITS)
684 return -EINVAL;
685 break;
686 case GSM_MI_TYPE_IMEISV:
687 mi_nibbles = strlen(mi->imeisv);
688 if (mi_nibbles != GSM23003_IMEISV_NUM_DIGITS)
689 return -EINVAL;
690 break;
691 default:
692 return -ENOTSUP;
693 }
694
695 if (mi_digits)
696 *mi_digits = mi_nibbles;
697
698 /* one type nibble, plus the MI nibbles, plus a filler nibble to complete the last octet:
699 * mi_octets = ceil((float)(mi_nibbles + 1) / 2)
700 */
701 return (mi_nibbles + 2) / 2;
702}
703
704/*! Encode Mobile Identity from uint32_t (TMSI) or digits string (all others) (3GPP TS 24.008 10.5.1.4).
705 *
706 * \param[out] buf Return buffer for encoded Mobile Identity.
707 * \param[in] buflen sizeof(buf).
708 * \param[in] mi Mobile identity to encode.
709 * \param[in] allow_hex If false, hexadecimal digits (>9) result in an error return value.
710 * \returns Amount of bytes written to buf, or negative on error.
711 */
712int osmo_mobile_identity_encode_buf(uint8_t *buf, size_t buflen, const struct osmo_mobile_identity *mi, bool allow_hex)
713{
714 int rc;
715 int nibbles_len;
716 int mi_octets;
717 const char *mi_str;
718
719 if (!buf || !buflen)
720 return -EIO;
721
722 mi_octets = osmo_mobile_identity_encoded_len(mi, &nibbles_len);
723 if (mi_octets < 0)
724 return mi_octets;
725 if (mi_octets > buflen)
726 return -ENOSPC;
727
728 buf[0] = (mi->type & GSM_MI_TYPE_MASK) | ((nibbles_len & 1) ? GSM_MI_ODD : 0);
729
730 switch (mi->type) {
731 case GSM_MI_TYPE_TMSI:
732 buf[0] |= 0xf0;
733 osmo_store32be(mi->tmsi, &buf[1]);
734 return mi_octets;
735
736 case GSM_MI_TYPE_IMSI:
737 mi_str = mi->imsi;
738 break;
739 case GSM_MI_TYPE_IMEI:
740 mi_str = mi->imei;
741 break;
742 case GSM_MI_TYPE_IMEISV:
743 mi_str = mi->imeisv;
744 break;
745 default:
746 return -ENOTSUP;
747 }
748 rc = osmo_str2bcd(buf, buflen, mi_str, 1, -1, allow_hex);
749 if (rc != mi_octets)
750 return -EINVAL;
751 return mi_octets;
752}
753
754/*! Encode Mobile Identity type and BCD digits, appended to a msgb.
755 * Example to add a GSM48_IE_MOBILE_ID IEI with tag and length to a msgb:
756 *
Neels Hofmeyr4247c942020-06-22 17:48:01 +0200757 * struct osmo_mobile_identity mi = { .type = GSM_MI_TYPE_IMSI };
758 * OSMO_STRLCPY_ARRAY(mi.imsi, "1234567890123456");
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200759 * uint8_t *l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);
760 * int rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
761 * if (rc < 0)
762 * goto error;
763 * *l = rc;
764 *
765 * Example to add a BSSGP_IE_IMSI with tag and variable-size length, where the
766 * length needs to be known at the time of writing the IE tag-length header:
767 *
768 * struct osmo_mobile_identity mi = { .type = GSM_MI_TYPE_IMSI, };
769 * OSMO_STRLCPY_ARRAY(mi.imsi, pinfo->imsi);
770 * msgb_tvl_put(msg, BSSGP_IE_IMSI, osmo_mobile_identity_encoded_len(&mi, NULL));
771 * if (osmo_mobile_identity_encode_msgb(msg, &mi, false) < 0)
772 * goto error;
773 */
774int osmo_mobile_identity_encode_msgb(struct msgb *msg, const struct osmo_mobile_identity *mi, bool allow_hex)
775{
776 int rc = osmo_mobile_identity_encode_buf(msg->tail, msgb_tailroom(msg), mi, allow_hex);
777 if (rc < 0)
778 return rc;
779 msgb_put(msg, rc);
780 return rc;
781}
782
783/*! Extract Mobile Identity from a Complete Layer 3 message.
784 *
785 * Determine the Mobile Identity data and call osmo_mobile_identity_decode() to return a decoded struct
786 * osmo_mobile_identity.
787 *
788 * \param[out] mi Return buffer for decoded Mobile Identity.
789 * \param[in] msg The Complete Layer 3 message to extract from (LU, CM Service Req or Paging Resp).
790 * \returns 0 on success, negative on error: return codes as defined in osmo_mobile_identity_decode(), or
791 * -ENOTSUP = not a Complete Layer 3 message,
792 */
793int osmo_mobile_identity_decode_from_l3(struct osmo_mobile_identity *mi, struct msgb *msg, bool allow_hex)
794{
795 const struct gsm48_hdr *gh;
796 int8_t pdisc = 0;
797 uint8_t mtype = 0;
798 const struct gsm48_loc_upd_req *lu;
799 const uint8_t *cm2_buf;
800 uint8_t cm2_len;
801 const uint8_t *mi_start;
802 const struct gsm48_pag_resp *paging_response;
803 const uint8_t *mi_data;
804 uint8_t mi_len;
805 const struct gsm48_imsi_detach_ind *idi;
806
807 *mi = (struct osmo_mobile_identity){
808 .type = GSM_MI_TYPE_NONE,
809 .tmsi = GSM_RESERVED_TMSI,
810 };
811
812 if (msgb_l3len(msg) < sizeof(*gh))
813 return -EBADMSG;
814
815 gh = msgb_l3(msg);
816 pdisc = gsm48_hdr_pdisc(gh);
817 mtype = gsm48_hdr_msg_type(gh);
818
819 switch (pdisc) {
820 case GSM48_PDISC_MM:
821
822 switch (mtype) {
823 case GSM48_MT_MM_LOC_UPD_REQUEST:
824 /* First make sure that lu-> can be dereferenced */
825 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*lu))
826 return -EBADMSG;
827
828 /* Now we know there is enough msgb data to read a lu->mi_len, so also check that */
829 lu = (struct gsm48_loc_upd_req*)gh->data;
830 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*lu) + lu->mi_len)
831 return -EBADMSG;
832 mi_data = lu->mi;
833 mi_len = lu->mi_len;
834 goto got_mi;
835
836 case GSM48_MT_MM_CM_SERV_REQ:
837 case GSM48_MT_MM_CM_REEST_REQ:
838 /* Unfortunately in Phase1 the Classmark2 length is variable, so we cannot
839 * just use gsm48_service_request struct, and need to parse it manually. */
840 if (msgb_l3len(msg) < sizeof(*gh) + 2)
841 return -EBADMSG;
842
843 cm2_len = gh->data[1];
844 cm2_buf = gh->data + 2;
845 goto got_cm2;
846
847 case GSM48_MT_MM_IMSI_DETACH_IND:
848 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*idi))
849 return -EBADMSG;
850 idi = (struct gsm48_imsi_detach_ind*) gh->data;
851 mi_data = idi->mi;
852 mi_len = idi->mi_len;
853 goto got_mi;
854
855 case GSM48_MT_MM_ID_RESP:
856 if (msgb_l3len(msg) < sizeof(*gh) + 2)
857 return -EBADMSG;
858 mi_data = gh->data+1;
859 mi_len = gh->data[0];
860 goto got_mi;
861
862 default:
863 break;
864 }
865 break;
866
867 case GSM48_PDISC_RR:
868
869 switch (mtype) {
870 case GSM48_MT_RR_PAG_RESP:
871 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*paging_response))
872 return -EBADMSG;
873 paging_response = (struct gsm48_pag_resp*)gh->data;
874 cm2_len = paging_response->cm2_len;
875 cm2_buf = (uint8_t*)&paging_response->cm2;
876 goto got_cm2;
877
878 default:
879 break;
880 }
881 break;
882 }
883
884 return -ENOTSUP;
885
886got_cm2:
887 /* MI (Mobile Identity) LV follows the Classmark2 */
888
889 /* There must be at least a mi_len byte after the CM2 */
890 if (cm2_buf + cm2_len + 1 > msg->tail)
891 return -EBADMSG;
892
893 mi_start = cm2_buf + cm2_len;
894 mi_len = mi_start[0];
895 mi_data = mi_start + 1;
896
897got_mi:
898 /* mi_data points at the start of the Mobile Identity coding of mi_len bytes */
899 if (mi_data + mi_len > msg->tail)
900 return -EBADMSG;
901
902 return osmo_mobile_identity_decode(mi, mi_data, mi_len, allow_hex);
903}
904
905/*! Return a human readable representation of a struct osmo_mobile_identity.
906 * Write a string like "IMSI-1234567", "TMSI-0x1234ABCD" or "NONE", "NULL".
907 * \param[out] buf String buffer to write to.
908 * \param[in] buflen sizeof(buf).
909 * \param[in] mi Decoded Mobile Identity data.
910 * \return the strlen() of the string written when buflen is sufficiently large, like snprintf().
911 */
912int osmo_mobile_identity_to_str_buf(char *buf, size_t buflen, const struct osmo_mobile_identity *mi)
913{
914 struct osmo_strbuf sb = { .buf = buf, .len = buflen };
915 if (!mi)
916 return snprintf(buf, buflen, "NULL");
917 OSMO_STRBUF_PRINTF(sb, "%s", gsm48_mi_type_name(mi->type));
918 switch (mi->type) {
919 case GSM_MI_TYPE_TMSI:
920 OSMO_STRBUF_PRINTF(sb, "-0x%08" PRIX32, mi->tmsi);
921 break;
922 case GSM_MI_TYPE_IMSI:
923 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imsi);
924 break;
925 case GSM_MI_TYPE_IMEI:
926 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imei);
927 break;
928 case GSM_MI_TYPE_IMEISV:
929 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imeisv);
930 break;
931 default:
932 break;
933 }
934 return sb.chars_needed;
935}
936
937/*! Like osmo_mobile_identity_to_str_buf(), but return the string in a talloc buffer.
938 * \param[in] ctx Talloc context to allocate from.
939 * \param[in] mi Decoded Mobile Identity data.
940 * \return a string like "IMSI-1234567", "TMSI-0x1234ABCD" or "NONE", "NULL".
941 */
942char *osmo_mobile_identity_to_str_c(void *ctx, const struct osmo_mobile_identity *mi)
943{
944 OSMO_NAME_C_IMPL(ctx, 32, "ERROR", osmo_mobile_identity_to_str_buf, mi)
945}
946
947/*! Compare two osmo_mobile_identity structs, returning typical cmp() result.
948 * \param[in] a Left side osmo_mobile_identity.
949 * \param[in] b Right side osmo_mobile_identity.
950 * \returns 0 if both are equal, -1 if a < b, 1 if a > b.
951 */
952int osmo_mobile_identity_cmp(const struct osmo_mobile_identity *a, const struct osmo_mobile_identity *b)
953{
954 int cmp;
955 if (a == b)
956 return 0;
957 if (!a)
958 return -1;
959 if (!b)
960 return 1;
961 cmp = OSMO_CMP(a->type, b->type);
962 if (cmp)
963 return cmp;
964 switch (a->type) {
965 case GSM_MI_TYPE_TMSI:
966 return OSMO_CMP(a->tmsi, b->tmsi);
967 case GSM_MI_TYPE_IMSI:
968 return strncmp(a->imsi, b->imsi, sizeof(a->imsi));
969 case GSM_MI_TYPE_IMEI:
970 return strncmp(a->imei, b->imei, sizeof(a->imei));
971 case GSM_MI_TYPE_IMEISV:
972 return strncmp(a->imeisv, b->imeisv, sizeof(a->imeisv));
973 default:
974 /* No known type, but both have the same type. */
975 return 0;
976 }
977}
978
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200979/*! Checks is particular message is cipherable in A/Gb mode according to
Maxfdca25d2016-07-05 16:06:28 +0200980 * 3GPP TS 24.008 § 4.7.1.2
981 * \param[in] hdr Message header
982 * \return true if message can be encrypted, false otherwise
983 */
984bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr)
985{
986 switch(hdr->msg_type) {
987 case GSM48_MT_GMM_ATTACH_REQ:
988 case GSM48_MT_GMM_ATTACH_REJ:
989 case GSM48_MT_GMM_AUTH_CIPH_REQ:
990 case GSM48_MT_GMM_AUTH_CIPH_RESP:
991 case GSM48_MT_GMM_AUTH_CIPH_REJ:
992 case GSM48_MT_GMM_AUTH_CIPH_FAIL:
993 case GSM48_MT_GMM_ID_REQ:
994 case GSM48_MT_GMM_ID_RESP:
995 case GSM48_MT_GMM_RA_UPD_REQ:
996 case GSM48_MT_GMM_RA_UPD_REJ:
997 return false;
998 default:
999 return true;
1000 }
1001}
1002
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001003/* Convert MCC + MNC to BCD representation, legacy implementation.
1004 * Instead use osmo_plmn_to_bcd(), which is also capable of converting
1005 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001006void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Harald Welte61e2bfc2010-03-04 10:53:03 +01001007{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001008 const struct osmo_plmn_id plmn = {
1009 .mcc = mcc,
1010 .mnc = mnc,
1011 .mnc_3_digits = false,
1012 };
1013 osmo_plmn_to_bcd(bcd_dst, &plmn);
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001014}
Harald Welte61e2bfc2010-03-04 10:53:03 +01001015
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001016/* Convert given 3-byte BCD buffer to integers, legacy implementation.
1017 * Instead use osmo_plmn_from_bcd(), which is also capable of converting
1018 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001019void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
1020{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001021 struct osmo_plmn_id plmn;
1022 osmo_plmn_from_bcd(bcd_src, &plmn);
1023 *mcc = plmn.mcc;
1024 *mnc = plmn.mnc;
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001025}
1026
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001027/*! Encode TS 04.08 Location Area Identifier, legacy implementation.
1028 * Instead use gsm48_generate_lai2(), which is capable of three-digit MNC with leading zeros.
1029 * \param[out] lai48 caller-provided memory for output
Harald Welte96e2a002017-06-12 21:44:18 +02001030 * \param[in] mcc Mobile Country Code
1031 * \param[in] mnc Mobile Network Code
1032 * \param[in] lac Location Area Code */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001033void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
1034 uint16_t mnc, uint16_t lac)
1035{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001036 const struct osmo_location_area_id lai = {
1037 .plmn = {
1038 .mcc = mcc,
1039 .mnc = mnc,
1040 .mnc_3_digits = false,
1041 },
1042 .lac = lac,
1043 };
1044 gsm48_generate_lai2(lai48, &lai);
Harald Welte61e2bfc2010-03-04 10:53:03 +01001045}
1046
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001047/*! Encode TS 04.08 Location Area Identifier.
1048 * \param[out] lai48 caller-provided memory for output.
1049 * \param[in] lai input of MCC-MNC-LAC. */
1050void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai)
1051{
1052 osmo_plmn_to_bcd(&lai48->digits[0], &lai->plmn);
1053 lai48->lac = osmo_htons(lai->lac);
1054}
1055
1056/*! Decode TS 04.08 Location Area Identifier, legacy implementation.
1057 * Instead use gsm48_decode_lai2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +02001058 * \param[in] Location Area Identifier (encoded)
1059 * \param[out] mcc Mobile Country Code
1060 * \param[out] mnc Mobile Network Code
1061 * \param[out] lac Location Area Code
1062 * \returns 0
1063 *
1064 * Attention: this function returns true integers, not hex! */
Harald Welte774a9de2012-07-13 21:35:13 +02001065int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
1066 uint16_t *mnc, uint16_t *lac)
1067{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001068 struct osmo_location_area_id decoded;
1069 gsm48_decode_lai2(lai, &decoded);
1070 *mcc = decoded.plmn.mcc;
1071 *mnc = decoded.plmn.mnc;
1072 *lac = decoded.lac;
Harald Welte774a9de2012-07-13 21:35:13 +02001073 return 0;
1074}
1075
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001076/*! Decode TS 04.08 Location Area Identifier.
1077 * \param[in] Location Area Identifier (encoded).
1078 * \param[out] decoded Target buffer to write decoded values of MCC-MNC-LAC.
1079 *
1080 * Attention: this function returns true integers, not hex! */
1081void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded)
1082{
1083 osmo_plmn_from_bcd(&lai->digits[0], &decoded->plmn);
1084 decoded->lac = osmo_ntohs(lai->lac);
1085}
1086
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001087/*! Set DTX mode in Cell Options IE (3GPP TS 44.018)
Maxfe65fa72016-05-10 17:17:05 +02001088 * \param[in] op Cell Options structure in which DTX parameters will be set
1089 * \param[in] full Mode for full-rate channels
1090 * \param[in] half Mode for half-rate channels
1091 * \param[in] is_bcch Indicates if we should use 10.5.2.3.1 instead of
1092 * 10.5.2.3a.2
1093 *
1094 * There is no space for separate DTX settings for Full and Half rate channels
1095 * in BCCH - in this case full setting is used for both and half parameter is
1096 * ignored.
1097 */
1098void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
1099 enum gsm48_dtx_mode half, bool is_bcch)
1100{
1101 if (is_bcch) {
1102 switch (full) {
1103 case GSM48_DTX_MAY_BE_USED:
1104 op->dtx = 0;
1105 return;
1106 case GSM48_DTX_SHALL_BE_USED:
1107 op->dtx = 1;
1108 return;
1109 case GSM48_DTX_SHALL_NOT_BE_USED:
1110 op->dtx = 2;
1111 return;
1112 }
1113 } else {
1114 switch (full) {
1115 case GSM48_DTX_MAY_BE_USED:
1116 op->dtx = (half == GSM48_DTX_SHALL_BE_USED) ? 3 : 0;
1117 op->d = (half == GSM48_DTX_SHALL_NOT_BE_USED) ? 0 : 1;
1118 return;
1119 case GSM48_DTX_SHALL_BE_USED:
1120 op->dtx = (half == GSM48_DTX_MAY_BE_USED) ? 3 : 1;
1121 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
1122 return;
1123 case GSM48_DTX_SHALL_NOT_BE_USED:
1124 op->dtx = 2;
1125 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
1126 return;
1127 }
1128 }
1129}
1130
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001131/*! Deprecated, see osmo_mobile_identity instead.
1132 * Generate TS 04.08 Mobile ID from TMSI
Harald Welte96e2a002017-06-12 21:44:18 +02001133 * \param[out] buf Caller-provided output buffer (7 bytes)
1134 * \param[in] tmsi TMSI to be encoded
1135 * \returns number of byes encoded (always 7) */
Harald Welte61e2bfc2010-03-04 10:53:03 +01001136int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
1137{
Harald Weltea13fb752020-06-16 08:44:42 +02001138 uint32_t tmsi_be = osmo_htonl(tmsi);
1139
1140 buf[0] = GSM48_IE_MOBILE_ID;
1141 buf[1] = GSM48_TMSI_LEN;
1142 buf[2] = 0xf0 | GSM_MI_TYPE_TMSI;
1143 memcpy(&buf[3], &tmsi_be, sizeof(tmsi_be));
1144
1145 return 7;
Harald Welte61e2bfc2010-03-04 10:53:03 +01001146}
1147
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001148/*! Deprecated, see osmo_mobile_identity instead.
1149 * Generate TS 24.008 §10.5.1.4 Mobile ID of BCD type from ASCII string
Harald Welte1c3bae12019-01-20 10:37:49 +01001150 * \param[out] buf Caller-provided output buffer of at least GSM48_MID_MAX_SIZE bytes
Maxebf14922018-02-15 11:42:11 +01001151 * \param[in] id Identity to be encoded
Harald Welte1c3bae12019-01-20 10:37:49 +01001152 * \param[in] mi_type Type of identity (e.g. GSM_MI_TYPE_IMSI, IMEI, IMEISV)
Maxebf14922018-02-15 11:42:11 +01001153 * \returns number of bytes used in \a buf */
1154uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
1155{
Harald Weltea13fb752020-06-16 08:44:42 +02001156 uint8_t length = strnlen(id, 16), i, off = 0, odd = (length & 1) == 1;
1157 /* maximum length == 16 (IMEISV) */
1158
1159 buf[0] = GSM48_IE_MOBILE_ID;
1160 buf[2] = osmo_char2bcd(id[0]) << 4 | (mi_type & GSM_MI_TYPE_MASK) | (odd << 3);
1161
1162 /* if the length is even we will fill half of the last octet */
1163 buf[1] = (length + (odd ? 1 : 2)) >> 1;
1164 /* buf[1] maximum = 18/2 = 9 */
1165 OSMO_ASSERT(buf[1] <= 9);
1166
1167 for (i = 1; i < buf[1]; ++i) {
1168 uint8_t upper, lower = osmo_char2bcd(id[++off]);
1169 if (!odd && off + 1 == length)
1170 upper = 0x0f;
1171 else
1172 upper = osmo_char2bcd(id[++off]) & 0x0f;
1173
1174 buf[2 + i] = (upper << 4) | lower;
Maxebf14922018-02-15 11:42:11 +01001175 }
Harald Weltea13fb752020-06-16 08:44:42 +02001176
1177 /* maximum return value: 2 + 9 = 11 */
1178 return 2 + buf[1];
Maxebf14922018-02-15 11:42:11 +01001179}
1180
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001181/*! Deprecated, see osmo_mobile_identity instead.
1182 * Generate TS 04.08 Mobile ID from IMSI
Harald Welte96e2a002017-06-12 21:44:18 +02001183 * \param[out] buf Caller-provided output buffer
1184 * \param[in] imsi IMSI to be encoded
1185 * \returns number of bytes used in \a buf */
Harald Welte61e2bfc2010-03-04 10:53:03 +01001186int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
1187{
Harald Weltea13fb752020-06-16 08:44:42 +02001188 return gsm48_generate_mid(buf, imsi, GSM_MI_TYPE_IMSI);
Harald Welte61e2bfc2010-03-04 10:53:03 +01001189}
Harald Welte9bb553e2010-03-28 18:14:50 +08001190
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001191/*! Deprecated, see osmo_mobile_identity instead.
1192 * Convert TS 04.08 Mobile Identity (10.5.1.4) to string.
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001193 * This function does not validate the Mobile Identity digits, i.e. digits > 9 are returned as 'A'-'F'.
Harald Welte96e2a002017-06-12 21:44:18 +02001194 * \param[out] string Caller-provided buffer for output
1195 * \param[in] str_len Length of \a string in bytes
1196 * \param[in] mi Mobile Identity to be stringified
1197 * \param[in] mi_len Length of \a mi in bytes
Neels Hofmeyr512bf022020-05-25 23:05:04 +02001198 * \returns Return <= 0 on error, > 0 on success.
1199 * WARNING: the return value of this function is not well implemented.
Neels Hofmeyr6aa20ee2018-12-06 00:40:37 +01001200 * Depending on the MI type and amount of output buffer, this may return
1201 * the nr of written bytes, or the written strlen(), or the snprintf()
Neels Hofmeyr512bf022020-05-25 23:05:04 +02001202 * style strlen()-if-the-buffer-were-large-enough.
1203 */
Vadim Yanitskiy0d8da792019-07-25 19:12:23 +07001204int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
Harald Welte9bb553e2010-03-28 18:14:50 +08001205{
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001206 int rc;
Harald Welte163d0ea2010-04-09 07:57:40 +02001207 uint8_t mi_type;
Harald Welte163d0ea2010-04-09 07:57:40 +02001208 uint32_t tmsi;
Harald Welte9bb553e2010-03-28 18:14:50 +08001209
Neels Hofmeyr6adffb92018-12-05 23:30:31 +01001210 mi_type = (mi && mi_len) ? (mi[0] & GSM_MI_TYPE_MASK) : GSM_MI_TYPE_NONE;
Harald Welte9bb553e2010-03-28 18:14:50 +08001211
1212 switch (mi_type) {
Harald Welte9bb553e2010-03-28 18:14:50 +08001213 case GSM_MI_TYPE_TMSI:
Holger Freyther45abec22016-05-20 19:21:27 +00001214 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
Harald Welte9bb553e2010-03-28 18:14:50 +08001215 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
Harald Welte95871da2017-05-15 12:11:36 +02001216 tmsi = osmo_load32be(&mi[1]);
Pau Espin Pedrol45735022017-06-18 14:05:24 +02001217 return snprintf(string, str_len, "%"PRIu32, tmsi);
Harald Welte9bb553e2010-03-28 18:14:50 +08001218 }
1219 break;
1220 case GSM_MI_TYPE_IMSI:
1221 case GSM_MI_TYPE_IMEI:
1222 case GSM_MI_TYPE_IMEISV:
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001223 rc = osmo_bcd2str(string, str_len, mi,
1224 1, mi_len * 2 - ((mi[0] & GSM_MI_ODD) ? 0 : 1), true);
1225 /* osmo_bcd2str() returns snprintf style strlen(), this returns bytes written. */
1226 if (rc < 0)
1227 return 0;
1228 else if (rc < str_len)
1229 return rc + 1;
1230 else
1231 return strlen(string) + 1;
Neels Hofmeyrea2a0ab2018-12-05 23:30:08 +01001232
Harald Welte9bb553e2010-03-28 18:14:50 +08001233 default:
1234 break;
1235 }
Harald Welte9bb553e2010-03-28 18:14:50 +08001236
Neels Hofmeyrea2a0ab2018-12-05 23:30:08 +01001237 if (str_len < 1)
1238 return 0;
1239 *string = '\0';
1240 return 1;
Harald Welte9bb553e2010-03-28 18:14:50 +08001241}
Harald Weltea1c4f762010-05-01 11:59:42 +02001242
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001243/*! Parse TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +02001244 * \param[out] Caller-provided memory for decoded RA ID
1245 * \param[in] buf Input buffer pointing to RAI IE value */
Harald Weltea1c4f762010-05-01 11:59:42 +02001246void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
1247{
1248 raid->mcc = (buf[0] & 0xf) * 100;
1249 raid->mcc += (buf[0] >> 4) * 10;
1250 raid->mcc += (buf[1] & 0xf) * 1;
1251
1252 /* I wonder who came up with the stupidity of encoding the MNC
1253 * differently depending on how many digits its decimal number has! */
1254 if ((buf[1] >> 4) == 0xf) {
1255 raid->mnc = (buf[2] & 0xf) * 10;
1256 raid->mnc += (buf[2] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001257 raid->mnc_3_digits = false;
Harald Weltea1c4f762010-05-01 11:59:42 +02001258 } else {
1259 raid->mnc = (buf[2] & 0xf) * 100;
1260 raid->mnc += (buf[2] >> 4) * 10;
1261 raid->mnc += (buf[1] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001262 raid->mnc_3_digits = true;
Harald Weltea1c4f762010-05-01 11:59:42 +02001263 }
1264
Harald Welte95871da2017-05-15 12:11:36 +02001265 raid->lac = osmo_load16be(buf + 3);
Harald Weltea1c4f762010-05-01 11:59:42 +02001266 raid->rac = buf[5];
1267}
Harald Welte35a93942010-05-01 14:25:22 +02001268
Maxf1ad60e2018-01-05 14:19:33 +01001269/*! Encode a 3GPP TS 24.008 § 10.5.5.15 Routing area identification
1270 * \param[out] out Caller-provided packed struct
1271 * \param[in] raid Routing Area ID to be encoded
1272 */
1273void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid)
1274{
1275 out->lac = osmo_htons(raid->lac);
1276 out->rac = raid->rac;
1277
1278 out->digits[0] = ((raid->mcc / 100) % 10) | (((raid->mcc / 10) % 10) << 4);
1279 out->digits[1] = raid->mcc % 10;
1280
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001281 if (raid->mnc < 100 && !raid->mnc_3_digits) {
Maxf1ad60e2018-01-05 14:19:33 +01001282 out->digits[1] |= 0xf0;
1283 out->digits[2] = ((raid->mnc / 10) % 10) | ((raid->mnc % 10) << 4);
1284 } else {
1285 out->digits[1] |= (raid->mnc % 10) << 4;
1286 out->digits[2] = ((raid->mnc / 100) % 10) | (((raid->mnc / 10) % 10) << 4);
1287 }
1288}
1289
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001290/*! Encode a TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +02001291 * \param[out] buf Caller-provided output buffer of 6 bytes
1292 * \param[in] raid Routing Area ID to be encoded
1293 * \returns number of bytes used in \a buf */
Harald Welte35a93942010-05-01 14:25:22 +02001294int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
1295{
Maxf1ad60e2018-01-05 14:19:33 +01001296 gsm48_encode_ra((struct gsm48_ra_id *)buf, raid);
Harald Welte35a93942010-05-01 14:25:22 +02001297
1298 return 6;
1299}
Harald Welte2aee7b12011-06-26 14:20:04 +02001300
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001301/*! Determine number of paging sub-channels
Harald Welte96e2a002017-06-12 21:44:18 +02001302 * \param[in] chan_desc Control Channel Description
1303 * \returns number of paging sub-channels
1304 *
1305 * Uses From Table 10.5.33 of GSM 04.08 to determine the number of
1306 * paging sub-channels in the given control channel configuration
1307 */
Harald Welte2aee7b12011-06-26 14:20:04 +02001308int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
1309{
Harald Welte94df39e2011-06-26 14:33:57 +02001310 unsigned int n_pag_blocks = gsm0502_get_n_pag_blocks(chan_desc);
1311
1312 if (chan_desc->ccch_conf == RSL_BCCH_CCCH_CONF_1_C)
1313 return OSMO_MAX(1, n_pag_blocks) * (chan_desc->bs_pa_mfrms + 2);
1314 else
1315 return n_pag_blocks * (chan_desc->bs_pa_mfrms + 2);
Harald Welte2aee7b12011-06-26 14:20:04 +02001316}
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001317
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001318/*! TS 04.08 Protocol Descriptor names */
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001319const struct value_string gsm48_pdisc_names[] = {
Harald Welteea0bc962018-01-24 16:17:45 +01001320 { GSM48_PDISC_GROUP_CC, "VGCC" },
1321 { GSM48_PDISC_BCAST_CC, "VBCC" },
1322 { GSM48_PDISC_PDSS1, "PDSS1" },
1323 { GSM48_PDISC_CC, "CC" },
1324 { GSM48_PDISC_PDSS2, "PDSS2" },
1325 { GSM48_PDISC_MM, "MM" },
1326 { GSM48_PDISC_RR, "RR" },
1327 { GSM48_PDISC_MM_GPRS, "GMM" },
1328 { GSM48_PDISC_SMS, "SMS" },
1329 { GSM48_PDISC_SM_GPRS, "SM" },
1330 { GSM48_PDISC_NC_SS, "NCSS" },
1331 { GSM48_PDISC_LOC, "LCS" },
1332 { GSM48_PDISC_EXTEND, "EXTD" },
1333 { GSM48_PDISC_MASK, "MASK" },
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001334 { 0, NULL }
1335};
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001336
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001337/*! TS 04.08 RR Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001338const struct value_string gsm48_rr_msgtype_names[] = {
1339 OSMO_VALUE_STRING(GSM48_MT_RR_INIT_REQ),
1340 OSMO_VALUE_STRING(GSM48_MT_RR_ADD_ASS),
1341 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS),
1342 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_EXT),
1343 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_REJ),
1344 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_FAIL),
1345 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REJECT),
1346 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REQUEST),
1347 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_ASS),
1348
1349 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_CMD),
1350 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_COMPL),
1351
1352 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_CMD),
1353 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_ACK),
1354 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_REJ),
1355
1356 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_CMD),
1357 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_COMPL),
1358 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_FAIL),
1359 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_CMD),
1360 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_COMPL),
1361 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_FAIL),
1362 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
1363 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
1364 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_CMD),
1365
1366 OSMO_VALUE_STRING(GSM48_MT_RR_CELL_CHG_ORDER),
1367 OSMO_VALUE_STRING(GSM48_MT_RR_PDCH_ASS_CMD),
1368
1369 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_REL),
1370 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL),
1371 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL_COMP),
1372
1373 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_1),
1374 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_2),
1375 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_3),
1376 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_RESP),
1377 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_NCH),
1378 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_FACCH),
1379 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_RESP),
1380 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_NOTIF),
1381 OSMO_VALUE_STRING(GSM48_MT_RR_UTRAN_CLSM_CHG),
1382 OSMO_VALUE_STRING(GSM48_MT_RR_CDMA2K_CLSM_CHG),
1383 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_UTRAN_HANDO),
1384 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_CDMA2K_HANDO),
1385
1386 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_8),
1387 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_1),
1388 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2),
1389 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_3),
1390 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_4),
1391 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5),
1392 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_6),
1393 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_7),
1394
1395 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2bis),
1396 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2ter),
1397 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2quater),
1398 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5bis),
1399 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5ter),
1400 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_9),
1401 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_13),
1402
1403 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_16),
1404 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_17),
1405
1406 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_18),
1407 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_19),
1408 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_20),
1409
1410 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF),
1411 OSMO_VALUE_STRING(GSM48_MT_RR_STATUS),
1412 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF_ACK),
1413 OSMO_VALUE_STRING(GSM48_MT_RR_FREQ_REDEF),
1414 OSMO_VALUE_STRING(GSM48_MT_RR_MEAS_REP),
1415 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_CHG),
1416 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_ENQ),
1417 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP),
1418 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP_ORD),
1419 OSMO_VALUE_STRING(GSM48_MT_RR_GPRS_SUSP_REQ),
1420 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_INFO),
1421
1422 OSMO_VALUE_STRING(GSM48_MT_RR_VGCS_UPL_GRANT),
1423 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_RELEASE),
1424 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_FREE),
1425 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_BUSY),
1426 OSMO_VALUE_STRING(GSM48_MT_RR_TALKER_IND),
1427 { 0, NULL }
1428};
1429
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001430/*! TS 04.08 MM Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001431const struct value_string gsm48_mm_msgtype_names[] = {
1432 OSMO_VALUE_STRING(GSM48_MT_MM_IMSI_DETACH_IND),
1433 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_ACCEPT),
1434 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REJECT),
1435 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REQUEST),
1436
1437 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REJ),
1438 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REQ),
1439 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_RESP),
1440 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_FAIL),
1441 OSMO_VALUE_STRING(GSM48_MT_MM_ID_REQ),
1442 OSMO_VALUE_STRING(GSM48_MT_MM_ID_RESP),
1443 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_CMD),
1444 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_COMPL),
1445
1446 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ACC),
1447 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REJ),
1448 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ABORT),
1449 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REQ),
1450 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_PROMPT),
1451 OSMO_VALUE_STRING(GSM48_MT_MM_CM_REEST_REQ),
1452 OSMO_VALUE_STRING(GSM48_MT_MM_ABORT),
1453
1454 OSMO_VALUE_STRING(GSM48_MT_MM_NULL),
1455 OSMO_VALUE_STRING(GSM48_MT_MM_STATUS),
1456 OSMO_VALUE_STRING(GSM48_MT_MM_INFO),
1457 { 0, NULL }
1458};
1459
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001460/*! TS 04.08 CC Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001461const struct value_string gsm48_cc_msgtype_names[] = {
1462 OSMO_VALUE_STRING(GSM48_MT_CC_ALERTING),
1463 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_CONF),
1464 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_PROC),
1465 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT),
1466 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT_ACK),
1467 OSMO_VALUE_STRING(GSM48_MT_CC_EMERG_SETUP),
1468 OSMO_VALUE_STRING(GSM48_MT_CC_PROGRESS),
1469 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB),
1470 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB_CONF),
1471 OSMO_VALUE_STRING(GSM48_MT_CC_RECALL),
1472 OSMO_VALUE_STRING(GSM48_MT_CC_START_CC),
1473 OSMO_VALUE_STRING(GSM48_MT_CC_SETUP),
1474
1475 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY),
1476 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_COMPL),
1477 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_REJECT),
1478 OSMO_VALUE_STRING(GSM48_MT_CC_USER_INFO),
1479 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD),
1480 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_ACK),
1481 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_REJ),
1482 OSMO_VALUE_STRING(GSM48_MT_CC_RETR),
1483 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_ACK),
1484 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_REJ),
1485
1486 OSMO_VALUE_STRING(GSM48_MT_CC_DISCONNECT),
1487 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE),
1488 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE_COMPL),
1489
1490 OSMO_VALUE_STRING(GSM48_MT_CC_CONG_CTRL),
1491 OSMO_VALUE_STRING(GSM48_MT_CC_NOTIFY),
1492 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS),
1493 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS_ENQ),
1494 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF),
1495 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF),
1496 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF_ACK),
1497 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_ACK),
1498 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_REJ),
1499 OSMO_VALUE_STRING(GSM48_MT_CC_FACILITY),
1500 { 0, NULL }
1501};
1502
Keith3cdaa8d2018-08-31 20:09:18 +02001503/*! TS 04.08 10.5..4.11 Call Control Cause Values */
1504const struct value_string gsm48_cc_cause_names[] = {
1505 { GSM48_CC_CAUSE_UNASSIGNED_NR, "UNASSIGNED_NR" },
1506 { GSM48_CC_CAUSE_NO_ROUTE, "NO_ROUTE" },
1507 { GSM48_CC_CAUSE_CHAN_UNACCEPT, "CHAN_UNACCEPT" },
1508 { GSM48_CC_CAUSE_OP_DET_BARRING, "OP_DET_BARRING" },
1509 { GSM48_CC_CAUSE_NORM_CALL_CLEAR, "NORM_CALL_CLEAR" },
1510 { GSM48_CC_CAUSE_USER_BUSY, "USER_BUSY" },
1511 { GSM48_CC_CAUSE_USER_NOTRESPOND, "USER_NOTRESPOND" },
1512 { GSM48_CC_CAUSE_USER_ALERTING_NA, "USER_ALERTING_NA" },
1513 { GSM48_CC_CAUSE_CALL_REJECTED, "CALL_REJECTED" },
1514 { GSM48_CC_CAUSE_NUMBER_CHANGED, "NUMBER_CHANGED" },
1515 { GSM48_CC_CAUSE_PRE_EMPTION, "PRE_EMPTION" },
1516 { GSM48_CC_CAUSE_NONSE_USER_CLR, "NONSE_USER_CLR" },
1517 { GSM48_CC_CAUSE_DEST_OOO, "DEST_OOO" },
1518 { GSM48_CC_CAUSE_INV_NR_FORMAT, "INV_NR_FORMAT" },
1519 { GSM48_CC_CAUSE_FACILITY_REJ, "FACILITY_REJ" },
1520 { GSM48_CC_CAUSE_RESP_STATUS_INQ, "RESP_STATUS_INQ" },
1521 { GSM48_CC_CAUSE_NORMAL_UNSPEC, "NORMAL_UNSPEC" },
1522 { GSM48_CC_CAUSE_NO_CIRCUIT_CHAN, "NO_CIRCUIT_CHAN" },
1523 { GSM48_CC_CAUSE_NETWORK_OOO, "NETWORK_OOO" },
1524 { GSM48_CC_CAUSE_TEMP_FAILURE, "TEMP_FAILURE" },
1525 { GSM48_CC_CAUSE_SWITCH_CONG, "SWITCH_CONG" },
1526 { GSM48_CC_CAUSE_ACC_INF_DISCARD, "ACC_INF_DISCARD" },
1527 { GSM48_CC_CAUSE_REQ_CHAN_UNAVAIL, "REQ_CHAN_UNAVAIL" },
1528 { GSM48_CC_CAUSE_RESOURCE_UNAVAIL, "RESOURCE_UNAVAIL" },
1529 { GSM48_CC_CAUSE_QOS_UNAVAIL, "QOS_UNAVAIL" },
1530 { GSM48_CC_CAUSE_REQ_FAC_NOT_SUBSC, "REQ_FAC_NOT_SUBSC" },
1531 { GSM48_CC_CAUSE_INC_BARRED_CUG, "INC_BARRED_CUG" },
1532 { GSM48_CC_CAUSE_BEARER_CAP_UNAUTH, "BEARER_CAP_UNAUTH" },
1533 { GSM48_CC_CAUSE_BEARER_CA_UNAVAIL, "BEARER_CA_UNAVAIL" },
1534 { GSM48_CC_CAUSE_SERV_OPT_UNAVAIL, "SERV_OPT_UNAVAIL" },
1535 { GSM48_CC_CAUSE_BEARERSERV_UNIMPL, "BEARERSERV_UNIMPL" },
1536 { GSM48_CC_CAUSE_ACM_GE_ACM_MAX, "ACM_GE_ACM_MAX" },
1537 { GSM48_CC_CAUSE_REQ_FAC_NOTIMPL, "REQ_FAC_NOTIMPL" },
1538 { GSM48_CC_CAUSE_RESTR_BCAP_AVAIL, "RESTR_BCAP_AVAIL" },
1539 { GSM48_CC_CAUSE_SERV_OPT_UNIMPL, "SERV_OPT_UNIMPL" },
1540 { GSM48_CC_CAUSE_INVAL_TRANS_ID, "INVAL_TRANS_ID" },
1541 { GSM48_CC_CAUSE_USER_NOT_IN_CUG, "USER_NOT_IN_CUG" },
1542 { GSM48_CC_CAUSE_INCOMPAT_DEST, "INCOMPAT_DEST" },
1543 { GSM48_CC_CAUSE_INVAL_TRANS_NET, "INVAL_TRANS_NET" },
1544 { GSM48_CC_CAUSE_SEMANTIC_INCORR, "SEMANTIC_INCORR" },
1545 { GSM48_CC_CAUSE_INVAL_MAND_INF, "INVAL_MAND_INF" },
1546 { GSM48_CC_CAUSE_MSGTYPE_NOTEXIST, "MSGTYPE_NOTEXIST" },
1547 { GSM48_CC_CAUSE_MSGTYPE_INCOMPAT, "MSGTYPE_INCOMPAT" },
1548 { GSM48_CC_CAUSE_IE_NOTEXIST, "IE_NOTEXIST" },
1549 { GSM48_CC_CAUSE_COND_IE_ERR, "COND_IE_ERR" },
1550 { GSM48_CC_CAUSE_MSG_INCOMP_STATE, "MSG_INCOMP_STATE" },
1551 { GSM48_CC_CAUSE_RECOVERY_TIMER, "RECOVERY_TIMER" },
1552 { GSM48_CC_CAUSE_PROTO_ERR, "PROTO_ERR" },
1553 { GSM48_CC_CAUSE_INTERWORKING, "INTERWORKING" },
1554 { 0 , NULL }
1555};
1556
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +07001557/*! TS 04.80, section 3.4 Messages for supplementary services control */
1558const struct value_string gsm48_nc_ss_msgtype_names[] = {
1559 OSMO_VALUE_STRING(GSM0480_MTYPE_RELEASE_COMPLETE),
1560 OSMO_VALUE_STRING(GSM0480_MTYPE_FACILITY),
1561 OSMO_VALUE_STRING(GSM0480_MTYPE_REGISTER),
1562 { 0, NULL }
1563};
1564
Harald Welte4a62eda2019-03-18 18:27:00 +01001565/*! Compose a string naming the message type for given protocol, in a caller-provided buffer.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001566 * If the message type string is known, return the message type name, otherwise
1567 * return "<protocol discriminator name>:<message type in hex>".
Harald Welte4a62eda2019-03-18 18:27:00 +01001568 * \param[out] buf caller-allcated output string buffer
1569 * \param[in] buf_len size of buf in bytes
Harald Welte96e2a002017-06-12 21:44:18 +02001570 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1571 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
Harald Welte4a62eda2019-03-18 18:27:00 +01001572 * \returns buf
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001573 */
Harald Welte4a62eda2019-03-18 18:27:00 +01001574char *gsm48_pdisc_msgtype_name_buf(char *buf, size_t buf_len, uint8_t pdisc, uint8_t msg_type)
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001575{
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001576 const struct value_string *msgt_names;
1577
1578 switch (pdisc) {
1579 case GSM48_PDISC_RR:
1580 msgt_names = gsm48_rr_msgtype_names;
1581 break;
1582 case GSM48_PDISC_MM:
1583 msgt_names = gsm48_mm_msgtype_names;
1584 break;
1585 case GSM48_PDISC_CC:
1586 msgt_names = gsm48_cc_msgtype_names;
1587 break;
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +07001588 case GSM48_PDISC_NC_SS:
1589 msgt_names = gsm48_nc_ss_msgtype_names;
1590 break;
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001591 default:
1592 msgt_names = NULL;
1593 break;
1594 }
1595
1596 if (msgt_names)
Harald Welte4a62eda2019-03-18 18:27:00 +01001597 snprintf(buf, buf_len, "%s", get_value_string(msgt_names, msg_type));
1598 else
1599 snprintf(buf, buf_len, "%s:0x%02x", gsm48_pdisc_name(pdisc), msg_type);
1600 return buf;
1601}
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001602
Harald Welte4a62eda2019-03-18 18:27:00 +01001603/*! Compose a string naming the message type for given protocol, in a static buffer.
1604 * If the message type string is known, return the message type name, otherwise
1605 * return "<protocol discriminator name>:<message type in hex>".
1606 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1607 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
1608 * \returns statically allocated string or string constant.
1609 */
1610const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type)
1611{
Harald Welte171ef822019-03-28 10:49:05 +01001612 static __thread char namebuf[64];
Harald Welte4a62eda2019-03-18 18:27:00 +01001613 return gsm48_pdisc_msgtype_name_buf(namebuf, sizeof(namebuf), pdisc, msg_type);
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001614}
Harald Welte96e2a002017-06-12 21:44:18 +02001615
Harald Welte179f3572019-03-18 18:38:47 +01001616/*! Compose a string naming the message type for given protocol, in a dynamically-allocated buffer.
1617 * If the message type string is known, return the message type name, otherwise
1618 * return "<protocol discriminator name>:<message type in hex>".
1619 * \param[in] ctx talloc context from which to allocate output buffer
1620 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1621 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
1622 * \returns string representation in dynamically allocated output buffer.
1623 */
1624char *gsm48_pdisc_msgtype_name_c(const void *ctx, uint8_t pdisc, uint8_t msg_type)
1625{
1626 char *namebuf = talloc_size(ctx, 64);
1627 if (!namebuf)
1628 return NULL;
1629 return gsm48_pdisc_msgtype_name_buf(namebuf, 64, pdisc, msg_type);
1630}
1631
Neels Hofmeyraead2412018-04-06 04:31:00 +02001632const struct value_string gsm48_reject_value_names[] = {
1633 { GSM48_REJECT_IMSI_UNKNOWN_IN_HLR, "IMSI_UNKNOWN_IN_HLR" },
1634 { GSM48_REJECT_ILLEGAL_MS, "ILLEGAL_MS" },
1635 { GSM48_REJECT_IMSI_UNKNOWN_IN_VLR, "IMSI_UNKNOWN_IN_VLR" },
1636 { GSM48_REJECT_IMEI_NOT_ACCEPTED, "IMEI_NOT_ACCEPTED" },
1637 { GSM48_REJECT_ILLEGAL_ME, "ILLEGAL_ME" },
1638 { GSM48_REJECT_PLMN_NOT_ALLOWED, "PLMN_NOT_ALLOWED" },
1639 { GSM48_REJECT_LOC_NOT_ALLOWED, "LOC_NOT_ALLOWED" },
1640 { GSM48_REJECT_ROAMING_NOT_ALLOWED, "ROAMING_NOT_ALLOWED" },
1641 { GSM48_REJECT_NETWORK_FAILURE, "NETWORK_FAILURE" },
1642 { GSM48_REJECT_SYNCH_FAILURE, "SYNCH_FAILURE" },
1643 { GSM48_REJECT_CONGESTION, "CONGESTION" },
1644 { GSM48_REJECT_SRV_OPT_NOT_SUPPORTED, "SRV_OPT_NOT_SUPPORTED" },
1645 { GSM48_REJECT_RQD_SRV_OPT_NOT_SUPPORTED, "RQD_SRV_OPT_NOT_SUPPORTED" },
1646 { GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER, "SRV_OPT_TMP_OUT_OF_ORDER" },
1647 { GSM48_REJECT_CALL_CAN_NOT_BE_IDENTIFIED, "CALL_CAN_NOT_BE_IDENTIFIED" },
1648 { GSM48_REJECT_INCORRECT_MESSAGE, "INCORRECT_MESSAGE" },
1649 { GSM48_REJECT_INVALID_MANDANTORY_INF, "INVALID_MANDANTORY_INF" },
1650 { GSM48_REJECT_MSG_TYPE_NOT_IMPLEMENTED, "MSG_TYPE_NOT_IMPLEMENTED" },
1651 { GSM48_REJECT_MSG_TYPE_NOT_COMPATIBLE, "MSG_TYPE_NOT_COMPATIBLE" },
1652 { GSM48_REJECT_INF_ELEME_NOT_IMPLEMENTED, "INF_ELEME_NOT_IMPLEMENTED" },
1653 { GSM48_REJECT_CONDTIONAL_IE_ERROR, "CONDTIONAL_IE_ERROR" },
1654 { GSM48_REJECT_MSG_NOT_COMPATIBLE, "MSG_NOT_COMPATIBLE" },
1655 { GSM48_REJECT_PROTOCOL_ERROR, "PROTOCOL_ERROR" },
1656 { GSM48_REJECT_GPRS_NOT_ALLOWED, "GPRS_NOT_ALLOWED" },
1657 { GSM48_REJECT_SERVICES_NOT_ALLOWED, "SERVICES_NOT_ALLOWED" },
1658 { GSM48_REJECT_MS_IDENTITY_NOT_DERVIVABLE, "MS_IDENTITY_NOT_DERVIVABLE" },
1659 { GSM48_REJECT_IMPLICITLY_DETACHED, "IMPLICITLY_DETACHED" },
1660 { GSM48_REJECT_GPRS_NOT_ALLOWED_IN_PLMN, "GPRS_NOT_ALLOWED_IN_PLMN" },
1661 { GSM48_REJECT_MSC_TMP_NOT_REACHABLE, "MSC_TMP_NOT_REACHABLE" },
1662 { 0, NULL }
1663};
1664
Vadim Yanitskiy30cfeeb2018-08-03 05:44:00 +07001665/*! Wrap a given \ref msg with \ref gsm48_hdr structure
1666 * \param[out] msg A message to be wrapped
1667 * \param[in] pdisc GSM TS 04.07 protocol discriminator 1/2,
1668 * sub-pdisc, trans_id or skip_ind 1/2,
1669 * see section 11.2.3.1 for details
1670 * \param[in] msg_type GSM TS 04.08 message type
1671 * @return pointer to pushed header within \ref msg
1672 */
1673struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
1674 uint8_t pdisc, uint8_t msg_type)
1675{
1676 struct gsm48_hdr *gh;
1677
1678 gh = (struct gsm48_hdr *) msgb_push(msg, sizeof(*gh));
1679 gh->proto_discr = pdisc;
1680 gh->msg_type = msg_type;
1681
1682 return gh;
1683}
1684
Neels Hofmeyr92f3f5e2019-01-05 00:39:13 +01001685const struct value_string osmo_lu_type_names[] = {
1686 { GSM48_LUPD_NORMAL, "NORMAL" },
1687 { GSM48_LUPD_PERIODIC, "PERIODIC" },
1688 { GSM48_LUPD_IMSI_ATT, "IMSI-ATTACH" },
1689 { GSM48_LUPD_RESERVED, "RESERVED" },
1690 {}
1691};
1692
Neels Hofmeyrf8963f92019-01-10 23:33:32 +01001693const struct value_string osmo_cm_service_type_names[] = {
1694 { GSM48_CMSERV_MO_CALL_PACKET, "MO-Call" },
1695 { GSM48_CMSERV_EMERGENCY, "Emergency-Call" },
1696 { GSM48_CMSERV_SMS, "Short-Messaging-Service" },
1697 { GSM48_CMSERV_SUP_SERV, "Supplementary-Service" },
1698 { GSM48_CMSERV_VGCS, "Voice-Group-Call" },
1699 { GSM48_CMSERV_VBS, "Voice-Broadcast-Call" },
1700 { GSM48_CMSERV_LOC_SERV, "Location-Service" },
1701 {}
1702};
1703
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001704bool osmo_gsm48_classmark1_is_r99(const struct gsm48_classmark1 *cm1)
1705{
1706 return cm1->rev_lev >= 2;
1707}
1708
1709bool osmo_gsm48_classmark2_is_r99(const struct gsm48_classmark2 *cm2, uint8_t cm2_len)
1710{
1711 if (!cm2_len)
1712 return false;
1713 return cm2->rev_lev >= 2;
1714}
1715
1716/*! Return true if any of Classmark 1 or Classmark 2 are present and indicate R99 capability.
1717 * \param[in] cm Classmarks.
1718 * \returns True if R99 or later, false if pre-R99 or no Classmarks are present.
1719 */
1720bool osmo_gsm48_classmark_is_r99(const struct osmo_gsm48_classmark *cm)
1721{
1722 if (cm->classmark1_set)
1723 return osmo_gsm48_classmark1_is_r99(&cm->classmark1);
1724 return osmo_gsm48_classmark2_is_r99(&cm->classmark2, cm->classmark2_len);
1725}
1726
1727/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1728 * \param[in] cm Classmarks.
1729 * \returns A statically allocated string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3"
1730 */
Harald Welte4a62eda2019-03-18 18:27:00 +01001731char *osmo_gsm48_classmark_a5_name_buf(char *buf, size_t buf_len, const struct osmo_gsm48_classmark *cm)
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001732{
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001733 char cm1[42] = "no-cm1";
1734 char cm2[42] = " no-cm2";
Neels Hofmeyr9e6f5f12019-03-11 05:07:56 +01001735 char cm3[42] = " no-cm3";
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001736
1737 if (cm->classmark1_set)
1738 snprintf(cm1, sizeof(cm1), "cm1{a5/1=%s}",
1739 cm->classmark1.a5_1 ? "not-supported":"supported" /* inverted logic */);
1740
1741 if (cm->classmark2_len >= 3)
1742 snprintf(cm2, sizeof(cm2), " cm2{0x%x=%s%s}",
1743 cm->classmark2.a5_2 + (cm->classmark2.a5_3 << 1),
1744 cm->classmark2.a5_2 ? " A5/2" : "",
1745 cm->classmark2.a5_3 ? " A5/3" : "");
1746
1747 if (cm->classmark3_len >= 1)
1748 snprintf(cm3, sizeof(cm3), " cm3{0x%x=%s%s%s%s}",
1749 cm->classmark3[0],
1750 cm->classmark3[0] & (1 << 0) ? " A5/4" : "",
1751 cm->classmark3[0] & (1 << 1) ? " A5/5" : "",
1752 cm->classmark3[0] & (1 << 2) ? " A5/6" : "",
1753 cm->classmark3[0] & (1 << 3) ? " A5/7" : "");
1754
Harald Welte4a62eda2019-03-18 18:27:00 +01001755 snprintf(buf, buf_len, "%s%s%s", cm1, cm2, cm3);
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001756 return buf;
1757}
1758
Harald Welte4a62eda2019-03-18 18:27:00 +01001759/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1760 * \param[in] cm Classmarks.
1761 * \returns A statically allocated string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3"
1762 */
1763const char *osmo_gsm48_classmark_a5_name(const struct osmo_gsm48_classmark *cm)
1764{
Harald Welte171ef822019-03-28 10:49:05 +01001765 static __thread char buf[128];
Harald Welte4a62eda2019-03-18 18:27:00 +01001766 return osmo_gsm48_classmark_a5_name_buf(buf, sizeof(buf), cm);
1767}
1768
Harald Welte179f3572019-03-18 18:38:47 +01001769/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1770 * \param[in] ctx talloc context from which to allocate output buffer
1771 * \param[in] cm Classmarks.
1772 * \returns string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3" in dynamically-allocated
1773 * output buffer.
1774 */
1775char *osmo_gsm48_classmark_a5_name_c(const void *ctx, const struct osmo_gsm48_classmark *cm)
1776{
1777 char *buf = talloc_size(ctx, 128);
1778 if (!buf)
1779 return NULL;
1780 return osmo_gsm48_classmark_a5_name_buf(buf, 128, cm);
1781}
Harald Welte4a62eda2019-03-18 18:27:00 +01001782
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001783/*! Overwrite dst with the Classmark information present in src.
1784 * Add an new Classmark and overwrite in dst what src has to offer, but where src has no Classmark information, leave
1785 * dst unchanged. (For Classmark 2 and 3, dst will exactly match any non-zero Classmark length from src, hence may end
1786 * up with a shorter Classmark after this call.)
1787 * \param[out] dst The target Classmark storage to be updated.
1788 * \param[in] src The new Classmark information to read from.
1789 */
1790void osmo_gsm48_classmark_update(struct osmo_gsm48_classmark *dst, const struct osmo_gsm48_classmark *src)
1791{
1792 if (src->classmark1_set) {
1793 dst->classmark1 = src->classmark1;
1794 dst->classmark1_set = true;
1795 }
1796 if (src->classmark2_len) {
1797 dst->classmark2_len = src->classmark2_len;
1798 dst->classmark2 = src->classmark2;
1799 }
1800 if (src->classmark3_len) {
1801 dst->classmark3_len = src->classmark3_len;
1802 memcpy(dst->classmark3, src->classmark3, OSMO_MIN(sizeof(dst->classmark3), src->classmark3_len));
1803 }
1804}
1805
1806
1807/*! Determine if the given Classmark (1/2/3) value permits a given A5/n cipher.
1808 * \param[in] cm Classmarks.
1809 * \param[in] a5 The N in A5/N for which to query whether support is indicated.
1810 * \return 1 when the given A5/n is permitted, 0 when not (or a5 > 7), and negative if the respective MS Classmark is
1811 * not known, where the negative number indicates the classmark type: -2 means Classmark 2 is not available. The
1812 * idea is that when e.g. A5/3 is requested and the corresponding Classmark 3 is not available, that the caller
1813 * can react by obtaining Classmark 3 and calling again once it is available.
1814 */
1815int osmo_gsm48_classmark_supports_a5(const struct osmo_gsm48_classmark *cm, uint8_t a5)
1816{
1817 switch (a5) {
1818 case 0:
1819 /* all phones must implement A5/0, see 3GPP TS 43.020 4.9 */
1820 return 1;
1821 case 1:
1822 /* 3GPP TS 43.020 4.9 requires A5/1 to be suppored by all phones and actually states:
1823 * "The network shall not provide service to an MS which indicates that it does not
1824 * support the ciphering algorithm A5/1.". However, let's be more tolerant based
1825 * on policy here */
1826 /* See 3GPP TS 24.008 10.5.1.7 */
1827 if (!cm->classmark1_set)
1828 return -1;
1829 /* Inverted logic for this bit! */
1830 return cm->classmark1.a5_1 ? 0 : 1;
1831 case 2:
1832 /* See 3GPP TS 24.008 10.5.1.6 */
1833 if (cm->classmark2_len < 3)
1834 return -2;
1835 return cm->classmark2.a5_2 ? 1 : 0;
1836 case 3:
1837 if (cm->classmark2_len < 3)
1838 return -2;
1839 return cm->classmark2.a5_3 ? 1 : 0;
1840 case 4:
1841 case 5:
1842 case 6:
1843 case 7:
1844 /* See 3GPP TS 24.008 10.5.1.7 */
1845 if (!cm->classmark3_len)
1846 return -3;
1847 return (cm->classmark3[0] & (1 << (a5-4))) ? 1 : 0;
1848 default:
1849 return 0;
1850 }
1851}
1852
Pau Espin Pedrolb99f4ca2019-10-31 13:35:22 +01001853/*! Decode power class from Classmark1/2 RF power capability field.
1854 * \param[in] rf_power_cap The RF power capability field (3 bits).
1855 * \param[in] band the band of the arfcn from where the classmark was received
1856 * \return the MS power class on success, negative on error.
1857 */
1858int8_t osmo_gsm48_rfpowercap2powerclass(enum gsm_band band, uint8_t rf_power_cap)
1859{
1860 switch (band) {
1861 case GSM_BAND_1800:
1862 case GSM_BAND_1900:
1863 if (rf_power_cap > 2)
1864 return -1;
1865 return rf_power_cap + 1;
1866 default:
1867 if (rf_power_cap > 4)
1868 return -1;
1869 return rf_power_cap + 1;
1870 }
1871}
1872
1873
Harald Welte96e2a002017-06-12 21:44:18 +02001874/*! @} */