blob: 59393d19aed613b058aee0e4208f9eab7a66b80b [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 *
Harald Welte4fb20752010-03-02 23:17:33 +010022 */
23
24#include <stdint.h>
25#include <stdio.h>
26#include <string.h>
Maxfe65fa72016-05-10 17:17:05 +020027#include <stdbool.h>
Pau Espin Pedrol45735022017-06-18 14:05:24 +020028#include <inttypes.h>
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010029#include <ctype.h>
Harald Welte61e2bfc2010-03-04 10:53:03 +010030
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010031#include <osmocom/core/utils.h>
Harald Welte95871da2017-05-15 12:11:36 +020032#include <osmocom/core/byteswap.h>
33#include <osmocom/core/bit16gen.h>
34#include <osmocom/core/bit32gen.h>
Harald Welte179f3572019-03-18 18:38:47 +010035#include <osmocom/core/talloc.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010036#include <osmocom/gsm/tlv.h>
37#include <osmocom/gsm/gsm48.h>
Harald Welte94df39e2011-06-26 14:33:57 +020038#include <osmocom/gsm/gsm0502.h>
Maxfb348ee2016-03-30 21:14:53 +020039#include <osmocom/gsm/gsm_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010040#include <osmocom/gsm/protocol/gsm_04_08.h>
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +070041#include <osmocom/gsm/protocol/gsm_04_80.h>
Harald Welte2aee7b12011-06-26 14:20:04 +020042#include <osmocom/gsm/protocol/gsm_08_58.h>
Maxfdca25d2016-07-05 16:06:28 +020043#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
Neels Hofmeyr83025bf2020-05-26 02:45:23 +020044#include <osmocom/gsm/protocol/gsm_23_003.h>
Harald Welte4fb20752010-03-02 23:17:33 +010045
Harald Welte96e2a002017-06-12 21:44:18 +020046/*! \addtogroup gsm0408
47 * @{
Neels Hofmeyr87e45502017-06-20 00:17:59 +020048 * GSM Mobile Radion Interface L3 messages / TS 04.08
Harald Welte96e2a002017-06-12 21:44:18 +020049 */
50
Neels Hofmeyr87e45502017-06-20 00:17:59 +020051/*! TLV parser definitions for TS 04.08 CC */
Harald Welte4fb20752010-03-02 23:17:33 +010052const struct tlv_definition gsm48_att_tlvdef = {
53 .def = {
54 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
55 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
56 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
57 [GSM48_IE_UTC] = { TLV_TYPE_TV },
58 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
59 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
60
61 [GSM48_IE_BEARER_CAP] = { TLV_TYPE_TLV },
62 [GSM48_IE_CAUSE] = { TLV_TYPE_TLV },
63 [GSM48_IE_CC_CAP] = { TLV_TYPE_TLV },
64 [GSM48_IE_ALERT] = { TLV_TYPE_TLV },
65 [GSM48_IE_FACILITY] = { TLV_TYPE_TLV },
66 [GSM48_IE_PROGR_IND] = { TLV_TYPE_TLV },
67 [GSM48_IE_AUX_STATUS] = { TLV_TYPE_TLV },
68 [GSM48_IE_NOTIFY] = { TLV_TYPE_TV },
69 [GSM48_IE_KPD_FACILITY] = { TLV_TYPE_TV },
70 [GSM48_IE_SIGNAL] = { TLV_TYPE_TV },
71 [GSM48_IE_CONN_BCD] = { TLV_TYPE_TLV },
72 [GSM48_IE_CONN_SUB] = { TLV_TYPE_TLV },
73 [GSM48_IE_CALLING_BCD] = { TLV_TYPE_TLV },
74 [GSM48_IE_CALLING_SUB] = { TLV_TYPE_TLV },
75 [GSM48_IE_CALLED_BCD] = { TLV_TYPE_TLV },
76 [GSM48_IE_CALLED_SUB] = { TLV_TYPE_TLV },
77 [GSM48_IE_REDIR_BCD] = { TLV_TYPE_TLV },
78 [GSM48_IE_REDIR_SUB] = { TLV_TYPE_TLV },
79 [GSM48_IE_LOWL_COMPAT] = { TLV_TYPE_TLV },
80 [GSM48_IE_HIGHL_COMPAT] = { TLV_TYPE_TLV },
81 [GSM48_IE_USER_USER] = { TLV_TYPE_TLV },
82 [GSM48_IE_SS_VERS] = { TLV_TYPE_TLV },
83 [GSM48_IE_MORE_DATA] = { TLV_TYPE_T },
84 [GSM48_IE_CLIR_SUPP] = { TLV_TYPE_T },
85 [GSM48_IE_CLIR_INVOC] = { TLV_TYPE_T },
86 [GSM48_IE_REV_C_SETUP] = { TLV_TYPE_T },
87 [GSM48_IE_REPEAT_CIR] = { TLV_TYPE_T },
88 [GSM48_IE_REPEAT_SEQ] = { TLV_TYPE_T },
89 /* FIXME: more elements */
90 },
91};
92
Neels Hofmeyr87e45502017-06-20 00:17:59 +020093/*! TLV parser definitions for TS 04.08 RR */
Andreas Eversberg014cb872010-07-12 09:11:00 +020094const struct tlv_definition gsm48_rr_att_tlvdef = {
95 .def = {
96 /* NOTE: Don't add IE 17 = MOBILE_ID here, it already used. */
97 [GSM48_IE_VGCS_TARGET] = { TLV_TYPE_TLV },
98 [GSM48_IE_FRQSHORT_AFTER] = { TLV_TYPE_FIXED, 9 },
99 [GSM48_IE_MUL_RATE_CFG] = { TLV_TYPE_TLV },
100 [GSM48_IE_FREQ_L_AFTER] = { TLV_TYPE_TLV },
101 [GSM48_IE_MSLOT_DESC] = { TLV_TYPE_TLV },
102 [GSM48_IE_CHANMODE_2] = { TLV_TYPE_TV },
103 [GSM48_IE_FRQSHORT_BEFORE] = { TLV_TYPE_FIXED, 9 },
104 [GSM48_IE_CHANMODE_3] = { TLV_TYPE_TV },
105 [GSM48_IE_CHANMODE_4] = { TLV_TYPE_TV },
106 [GSM48_IE_CHANMODE_5] = { TLV_TYPE_TV },
107 [GSM48_IE_CHANMODE_6] = { TLV_TYPE_TV },
108 [GSM48_IE_CHANMODE_7] = { TLV_TYPE_TV },
109 [GSM48_IE_CHANMODE_8] = { TLV_TYPE_TV },
110 [GSM48_IE_FREQ_L_BEFORE] = { TLV_TYPE_TLV },
111 [GSM48_IE_CH_DESC_1_BEFORE] = { TLV_TYPE_FIXED, 3 },
112 [GSM48_IE_CH_DESC_2_BEFORE] = { TLV_TYPE_FIXED, 3 },
113 [GSM48_IE_F_CH_SEQ_BEFORE] = { TLV_TYPE_FIXED, 9 },
114 [GSM48_IE_CLASSMARK3] = { TLV_TYPE_TLV },
115 [GSM48_IE_MA_BEFORE] = { TLV_TYPE_TLV },
116 [GSM48_IE_RR_PACKET_UL] = { TLV_TYPE_TLV },
117 [GSM48_IE_RR_PACKET_DL] = { TLV_TYPE_TLV },
118 [GSM48_IE_CELL_CH_DESC] = { TLV_TYPE_FIXED, 16 },
119 [GSM48_IE_CHANMODE_1] = { TLV_TYPE_TV },
120 [GSM48_IE_CHDES_2_AFTER] = { TLV_TYPE_FIXED, 3 },
121 [GSM48_IE_MODE_SEC_CH] = { TLV_TYPE_TV },
122 [GSM48_IE_F_CH_SEQ_AFTER] = { TLV_TYPE_FIXED, 9 },
Neels Hofmeyr4b44ac42021-04-19 23:33:34 +0200123 [GSM48_IE_EXTENDED_TSC_SET] = { TLV_TYPE_TV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200124 [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 },
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +0100132 [GSM48_IE_GROUP_CIP_SEQ_HO] = { TLV_TYPE_SINGLE_TV },
133 [GSM48_IE_CIP_MODE_SET_HO] = { TLV_TYPE_SINGLE_TV },
134 [GSM48_IE_GPRS_RESUMPT_HO] = { TLV_TYPE_SINGLE_TV },
135 [GSM48_IE_SYNC_IND_HO] = { TLV_TYPE_SINGLE_TV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200136 },
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 },
Pau Espin Pedrol559a6ee2023-03-22 13:17:09 +0100151 [GSM48_IE_PRIORITY_LEV_HO] = { TLV_TYPE_SINGLE_TV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200152 [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" },
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +0700164 { GSM48_RR_CAUSE_UTRAN_CFG_UNK, "UTRAN configuration unknown" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800165 { GSM48_RR_CAUSE_HNDOVER_IMP, "Handover impossible, timing advance out of range" },
166 { GSM48_RR_CAUSE_CHAN_MODE_UNACCT, "Channel mode unacceptable" },
167 { GSM48_RR_CAUSE_FREQ_NOT_IMPL, "Frequency not implemented" },
Vadim Yanitskiyf5f0d432020-10-29 18:21:53 +0700168 { GSM48_RR_CAUSE_LEAVE_GROUP_CA, "Originator or talker leaving group call area" },
169 { GSM48_RR_CAUSE_LOW_LEVEL_FAIL, "Lower layer failure" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800170 { GSM48_RR_CAUSE_CALL_CLEARED, "Call already cleared" },
171 { GSM48_RR_CAUSE_SEMANT_INCORR, "Semantically incorrect message" },
172 { GSM48_RR_CAUSE_INVALID_MAND_INF, "Invalid mandatory information" },
Vadim Yanitskiy65954ba2020-10-29 18:08:52 +0700173 { GSM48_RR_CAUSE_MSG_TYPE_N, "Message type non-existent or not implemented" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800174 { GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT, "Message type not compatible with protocol state" },
175 { GSM48_RR_CAUSE_COND_IE_ERROR, "Conditional IE error" },
176 { GSM48_RR_CAUSE_NO_CELL_ALLOC_A, "No cell allocation available" },
177 { GSM48_RR_CAUSE_PROT_ERROR_UNSPC, "Protocol error unspecified" },
178 { 0, NULL },
Harald Welte4fb20752010-03-02 23:17:33 +0100179};
180
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200181/*! return string representation of RR Cause value */
Philippada00422016-10-27 13:30:16 +0200182const char *rr_cause_name(uint8_t cause)
183{
184 return get_value_string(rr_cause_names, cause);
185}
186
Harald Welte4a62eda2019-03-18 18:27:00 +0100187/*! Return MCC-MNC-LAC-RAC as string, in a caller-provided output buffer.
188 * \param[out] buf caller-provided output buffer
189 * \param[in] buf_len size of buf in bytes
190 * \param[in] rai RAI to encode.
191 * \returns buf
192 */
193char *osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai)
194{
195 snprintf(buf, buf_len, "%s-%s-%u-%u",
196 osmo_mcc_name(rai->mcc), osmo_mnc_name(rai->mnc, rai->mnc_3_digits), rai->lac,
197 rai->rac);
198 return buf;
199}
200
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100201/*! Return MCC-MNC-LAC-RAC as string, in a static buffer.
202 * \param[in] rai RAI to encode.
203 * \returns Static string buffer.
204 */
205const char *osmo_rai_name(const struct gprs_ra_id *rai)
206{
Harald Welte171ef822019-03-28 10:49:05 +0100207 static __thread char buf[32];
Harald Welte4a62eda2019-03-18 18:27:00 +0100208 return osmo_rai_name_buf(buf, sizeof(buf), rai);
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100209}
210
Harald Welte179f3572019-03-18 18:38:47 +0100211/*! Return MCC-MNC-LAC-RAC as string, in dynamically-allocated output buffer.
212 * \param[in] ctx talloc context from which to allocate output buffer
213 * \param[in] rai RAI to encode.
214 * \returns string representation in dynamically-allocated output buffer.
215 */
216char *osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai)
217{
218 char *buf = talloc_size(ctx, 32);
219 if (!buf)
220 return NULL;
221 return osmo_rai_name_buf(buf, 32, rai);
222}
223
Harald Welte9eb6d882010-03-25 12:00:54 +0800224/* FIXME: convert to value_string */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200225static const char *cc_state_names[32] = {
Harald Welte4fb20752010-03-02 23:17:33 +0100226 "NULL",
227 "INITIATED",
Andreas Eversberg1ef041f2010-04-09 07:52:12 +0200228 "MM_CONNECTION_PEND",
Harald Welte4fb20752010-03-02 23:17:33 +0100229 "MO_CALL_PROC",
230 "CALL_DELIVERED",
231 "illegal state 5",
232 "CALL_PRESENT",
233 "CALL_RECEIVED",
234 "CONNECT_REQUEST",
235 "MO_TERM_CALL_CONF",
236 "ACTIVE",
237 "DISCONNECT_REQ",
238 "DISCONNECT_IND",
239 "illegal state 13",
240 "illegal state 14",
241 "illegal state 15",
242 "illegal state 16",
243 "illegal state 17",
244 "illegal state 18",
245 "RELEASE_REQ",
246 "illegal state 20",
247 "illegal state 21",
248 "illegal state 22",
249 "illegal state 23",
250 "illegal state 24",
251 "illegal state 25",
252 "MO_ORIG_MODIFY",
253 "MO_TERM_MODIFY",
254 "CONNECT_IND",
255 "illegal state 29",
256 "illegal state 30",
257 "illegal state 31",
258};
259
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200260/*! return string representation of CC State */
Harald Welte9eb6d882010-03-25 12:00:54 +0800261const char *gsm48_cc_state_name(uint8_t state)
262{
263 if (state < ARRAY_SIZE(cc_state_names))
264 return cc_state_names[state];
265
266 return "invalid";
267}
268
269static const struct value_string cc_msg_names[] = {
270 { GSM48_MT_CC_ALERTING, "ALERTING" },
271 { GSM48_MT_CC_CALL_PROC, "CALL_PROC" },
272 { GSM48_MT_CC_PROGRESS, "PROGRESS" },
273 { GSM48_MT_CC_ESTAB, "ESTAB" },
274 { GSM48_MT_CC_SETUP, "SETUP" },
275 { GSM48_MT_CC_ESTAB_CONF, "ESTAB_CONF" },
276 { GSM48_MT_CC_CONNECT, "CONNECT" },
277 { GSM48_MT_CC_CALL_CONF, "CALL_CONF" },
278 { GSM48_MT_CC_START_CC, "START_CC" },
279 { GSM48_MT_CC_RECALL, "RECALL" },
280 { GSM48_MT_CC_EMERG_SETUP, "EMERG_SETUP" },
281 { GSM48_MT_CC_CONNECT_ACK, "CONNECT_ACK" },
282 { GSM48_MT_CC_USER_INFO, "USER_INFO" },
283 { GSM48_MT_CC_MODIFY_REJECT, "MODIFY_REJECT" },
284 { GSM48_MT_CC_MODIFY, "MODIFY" },
285 { GSM48_MT_CC_HOLD, "HOLD" },
286 { GSM48_MT_CC_HOLD_ACK, "HOLD_ACK" },
287 { GSM48_MT_CC_HOLD_REJ, "HOLD_REJ" },
288 { GSM48_MT_CC_RETR, "RETR" },
289 { GSM48_MT_CC_RETR_ACK, "RETR_ACK" },
290 { GSM48_MT_CC_RETR_REJ, "RETR_REJ" },
291 { GSM48_MT_CC_MODIFY_COMPL, "MODIFY_COMPL" },
292 { GSM48_MT_CC_DISCONNECT, "DISCONNECT" },
293 { GSM48_MT_CC_RELEASE_COMPL, "RELEASE_COMPL" },
294 { GSM48_MT_CC_RELEASE, "RELEASE" },
295 { GSM48_MT_CC_STOP_DTMF, "STOP_DTMF" },
296 { GSM48_MT_CC_STOP_DTMF_ACK, "STOP_DTMF_ACK" },
297 { GSM48_MT_CC_STATUS_ENQ, "STATUS_ENQ" },
298 { GSM48_MT_CC_START_DTMF, "START_DTMF" },
299 { GSM48_MT_CC_START_DTMF_ACK, "START_DTMF_ACK" },
300 { GSM48_MT_CC_START_DTMF_REJ, "START_DTMF_REJ" },
301 { GSM48_MT_CC_CONG_CTRL, "CONG_CTRL" },
302 { GSM48_MT_CC_FACILITY, "FACILITY" },
303 { GSM48_MT_CC_STATUS, "STATUS" },
304 { GSM48_MT_CC_NOTIFY, "NOTFIY" },
305 { 0, NULL }
Harald Welte61e2bfc2010-03-04 10:53:03 +0100306};
307
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200308/*! return string representation of CC Message Type */
Harald Welte9eb6d882010-03-25 12:00:54 +0800309const char *gsm48_cc_msg_name(uint8_t msgtype)
310{
311 return get_value_string(cc_msg_names, msgtype);
312}
Harald Welte4fb20752010-03-02 23:17:33 +0100313
Philipp72e43f02016-10-27 13:35:20 +0200314
315static const struct value_string rr_msg_names[] = {
316 /* Channel establishment messages */
317 { GSM48_MT_RR_INIT_REQ, "RR INITIALISATION REQUEST" },
318 { GSM48_MT_RR_ADD_ASS, "ADDITIONAL ASSIGNMENT" },
319 { GSM48_MT_RR_IMM_ASS, "IMMEDIATE ASSIGNMENT" },
320 { GSM48_MT_RR_IMM_ASS_EXT, "MMEDIATE ASSIGNMENT EXTENDED" },
321 { GSM48_MT_RR_IMM_ASS_REJ, "IMMEDIATE ASSIGNMENT REJECT" },
322 { GSM48_MT_RR_DTM_ASS_FAIL, "DTM ASSIGNMENT FAILURE" },
323 { GSM48_MT_RR_DTM_REJECT, "DTM REJECT" },
324 { GSM48_MT_RR_DTM_REQUEST, "DTM REQUEST" },
325 { GSM48_MT_RR_PACKET_ASS, "PACKET ASSIGNMENT" },
326
327 /* Ciphering messages */
328 { GSM48_MT_RR_CIPH_M_CMD, "CIPHERING MODE COMMAND" },
329 { GSM48_MT_RR_CIPH_M_COMPL, "CIPHERING MODE COMPLETE" },
330
331 /* Configuration change messages */
332 { GSM48_MT_RR_CFG_CHG_CMD, "CONFIGURATION CHANGE COMMAND" },
333 { GSM48_MT_RR_CFG_CHG_ACK, "CONFIGURATION CHANGE ACK" },
334 { GSM48_MT_RR_CFG_CHG_REJ, "CONFIGURATION CHANGE REJECT" },
335
336 /* Handover messages */
337 { GSM48_MT_RR_ASS_CMD, "ASSIGNMENT COMMAND" },
338 { GSM48_MT_RR_ASS_COMPL, "ASSIGNMENT COMPLETE" },
339 { GSM48_MT_RR_ASS_FAIL, "ASSIGNMENT FAILURE" },
340 { GSM48_MT_RR_HANDO_CMD, "HANDOVER COMMAND" },
341 { GSM48_MT_RR_HANDO_COMPL, "HANDOVER COMPLETE" },
342 { GSM48_MT_RR_HANDO_FAIL, "HANDOVER FAILURE" },
343 { GSM48_MT_RR_HANDO_INFO, "PHYSICAL INFORMATION" },
344 { GSM48_MT_RR_DTM_ASS_CMD, "DTM ASSIGNMENT COMMAND" },
345
346 { GSM48_MT_RR_CELL_CHG_ORDER, "RR-CELL CHANGE ORDER" },
347 { GSM48_MT_RR_PDCH_ASS_CMD, "PDCH ASSIGNMENT COMMAND" },
348
349 /* Channel release messages */
350 { GSM48_MT_RR_CHAN_REL, "CHANNEL RELEASE" },
351 { GSM48_MT_RR_PART_REL, "PARTIAL RELEASE" },
352 { GSM48_MT_RR_PART_REL_COMP, "PARTIAL RELEASE COMPLETE" },
353
354 /* Paging and Notification messages */
355 { GSM48_MT_RR_PAG_REQ_1, "PAGING REQUEST TYPE 1" },
356 { GSM48_MT_RR_PAG_REQ_2, "PAGING REQUEST TYPE 2" },
357 { GSM48_MT_RR_PAG_REQ_3, "PAGING REQUEST TYPE 3" },
358 { GSM48_MT_RR_PAG_RESP, "PAGING RESPONSE" },
359 { GSM48_MT_RR_NOTIF_NCH, "NOTIFICATION/NCH" },
360 { GSM48_MT_RR_NOTIF_FACCH, "(Reserved)" },
361 { GSM48_MT_RR_NOTIF_RESP, "NOTIFICATION/RESPONSE" },
362 { GSM48_MT_RR_PACKET_NOTIF, "PACKET NOTIFICATION" },
363 /* 3G Specific messages */
364 { GSM48_MT_RR_UTRAN_CLSM_CHG, "UTRAN Classmark Change" },
365 { GSM48_MT_RR_CDMA2K_CLSM_CHG, "cdma 2000 Classmark Change" },
366 { GSM48_MT_RR_IS_TO_UTRAN_HANDO, "Inter System to UTRAN Handover Command" },
367 { GSM48_MT_RR_IS_TO_CDMA2K_HANDO, "Inter System to cdma2000 Handover Command" },
368
369 /* System information messages */
370 { GSM48_MT_RR_SYSINFO_8, "SYSTEM INFORMATION TYPE 8" },
371 { GSM48_MT_RR_SYSINFO_1, "SYSTEM INFORMATION TYPE 1" },
372 { GSM48_MT_RR_SYSINFO_2, "SYSTEM INFORMATION TYPE 2" },
373 { GSM48_MT_RR_SYSINFO_3, "SYSTEM INFORMATION TYPE 3" },
374 { GSM48_MT_RR_SYSINFO_4, "SYSTEM INFORMATION TYPE 4" },
375 { GSM48_MT_RR_SYSINFO_5, "SYSTEM INFORMATION TYPE 5" },
376 { GSM48_MT_RR_SYSINFO_6, "SYSTEM INFORMATION TYPE 6" },
377 { GSM48_MT_RR_SYSINFO_7, "SYSTEM INFORMATION TYPE 7" },
378 { GSM48_MT_RR_SYSINFO_2bis, "SYSTEM INFORMATION TYPE 2bis" },
379 { GSM48_MT_RR_SYSINFO_2ter, "SYSTEM INFORMATION TYPE 2ter" },
380 { GSM48_MT_RR_SYSINFO_2quater, "SYSTEM INFORMATION TYPE 2quater" },
381 { GSM48_MT_RR_SYSINFO_5bis, "SYSTEM INFORMATION TYPE 5bis" },
382 { GSM48_MT_RR_SYSINFO_5ter, "SYSTEM INFORMATION TYPE 5ter" },
383 { GSM48_MT_RR_SYSINFO_9, "SYSTEM INFORMATION TYPE 9" },
384 { GSM48_MT_RR_SYSINFO_13, "SYSTEM INFORMATION TYPE 13" },
385 { GSM48_MT_RR_SYSINFO_16, "SYSTEM INFORMATION TYPE 16" },
386 { GSM48_MT_RR_SYSINFO_17, "SYSTEM INFORMATION TYPE 17" },
387 { GSM48_MT_RR_SYSINFO_18, "SYSTEM INFORMATION TYPE 18" },
388 { GSM48_MT_RR_SYSINFO_19, "SYSTEM INFORMATION TYPE 19" },
389 { GSM48_MT_RR_SYSINFO_20, "SYSTEM INFORMATION TYPE 20" },
390
391 /* Miscellaneous messages */
392 { GSM48_MT_RR_CHAN_MODE_MODIF, "CHANNEL MODE MODIFY" },
393 { GSM48_MT_RR_STATUS, "RR STATUS" },
394 { GSM48_MT_RR_CHAN_MODE_MODIF_ACK, "CHANNEL MODE MODIFY ACKNOWLEDGE" },
395 { GSM48_MT_RR_FREQ_REDEF, "FREQUENCY REDEFINITION" },
396 { GSM48_MT_RR_MEAS_REP, "MEASUREMENT REPORT" },
397 { GSM48_MT_RR_CLSM_CHG, "CLASSMARK CHANGE" },
398 { GSM48_MT_RR_CLSM_ENQ, "CLASSMARK ENQUIRY" },
399 { GSM48_MT_RR_EXT_MEAS_REP, "EXTENDED MEASUREMENT REPORT" },
400 { GSM48_MT_RR_EXT_MEAS_REP_ORD, "EXTENDED MEASUREMENT ORDER" },
401 { GSM48_MT_RR_GPRS_SUSP_REQ, "GPRS SUSPENSION REQUEST" },
402 { GSM48_MT_RR_DTM_INFO, "DTM INFORMATION" },
403
404 /* VGCS uplink control messages */
405 { GSM48_MT_RR_VGCS_UPL_GRANT, "VGCS UPLINK GRANT" },
406 { GSM48_MT_RR_UPLINK_RELEASE, "UPLINK RELEASE" },
407 { GSM48_MT_RR_UPLINK_FREE, "0c" },
408 { GSM48_MT_RR_UPLINK_BUSY, "UPLINK BUSY" },
409 { GSM48_MT_RR_TALKER_IND, "TALKER INDICATION" },
410
411 /* Application messages */
412 { GSM48_MT_RR_APP_INFO, "Application Information" },
413 { 0, NULL }
414};
415
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200416/*! return string representation of RR Message Type */
Philipp72e43f02016-10-27 13:35:20 +0200417const char *gsm48_rr_msg_name(uint8_t msgtype)
418{
419 return get_value_string(rr_msg_names, msgtype);
420}
421
Max600d4ee2023-01-23 21:49:52 +0300422/* 3GPP TS 44.018 Table 10.4.2 */
423static const struct value_string rr_msg_type_short_names[] = {
424 { GSM48_MT_RR_SH_SI10, "System Information Type 10" },
425 { GSM48_MT_RR_SH_FACCH, "Notification/FACCH" },
426 { GSM48_MT_RR_SH_UL_FREE, "Uplink Free" },
427 { GSM48_MT_RR_SH_MEAS_REP, "Enhanced Measurement Report (uplink)" },
428 { GSM48_MT_RR_SH_MEAS_INFO, "Measurement Information (downlink)" },
429 { GSM48_MT_RR_SH_VGCS_RECON, "VBS/VGCS Reconfigure" },
430 { GSM48_MT_RR_SH_VGCS_RECON2, "VBS/VGCS Reconfigure2" },
431 { GSM48_MT_RR_SH_VGCS_INFO, "VGCS Additional Information" },
432 { GSM48_MT_RR_SH_VGCS_SMS, "VGCS SMS Information" },
433 { GSM48_MT_RR_SH_SI10bis, "System Information Type 10bis" },
434 { GSM48_MT_RR_SH_SI10ter, "System Information Type 10ter" },
435 { GSM48_MT_RR_SH_VGCS_NEIGH, "VGCS Neighbour Cell Information" },
436 { GSM48_MT_RR_SH_APP_DATA, "Notify Application Data" },
437 { 0, NULL }
438};
439
440/*! return string representation of RR Message Type using the RR short protocol discriminator */
Maxbc127282023-01-26 14:40:23 +0300441const char *gsm48_rr_short_pd_msg_name(uint8_t msgtype)
Max600d4ee2023-01-23 21:49:52 +0300442{
443 return get_value_string(rr_msg_type_short_names, msgtype);
444}
Philipp72e43f02016-10-27 13:35:20 +0200445
Maxfb348ee2016-03-30 21:14:53 +0200446const struct value_string gsm48_chan_mode_names[] = {
447 { GSM48_CMODE_SIGN, "SIGNALLING" },
448 { GSM48_CMODE_SPEECH_V1, "SPEECH_V1" },
449 { GSM48_CMODE_SPEECH_EFR, "SPEECH_EFR" },
450 { GSM48_CMODE_SPEECH_AMR, "SPEECH_AMR" },
Vadim Yanitskiy1c88ff92023-03-23 06:33:51 +0700451 { GSM48_CMODE_SPEECH_V4, "SPEECH_V4" },
452 { GSM48_CMODE_SPEECH_V5, "SPEECH_V5" },
453 { GSM48_CMODE_SPEECH_V6, "SPEECH_V6" },
454
Maxfb348ee2016-03-30 21:14:53 +0200455 { GSM48_CMODE_DATA_14k5, "DATA_14k5" },
456 { GSM48_CMODE_DATA_12k0, "DATA_12k0" },
457 { GSM48_CMODE_DATA_6k0, "DATA_6k0" },
458 { GSM48_CMODE_DATA_3k6, "DATA_3k6" },
Vadim Yanitskiy1c88ff92023-03-23 06:33:51 +0700459
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200460 { GSM48_CMODE_SPEECH_V1_VAMOS, "SPEECH_V1_VAMOS" },
461 { GSM48_CMODE_SPEECH_V2_VAMOS, "SPEECH_V2_VAMOS" },
462 { GSM48_CMODE_SPEECH_V3_VAMOS, "SPEECH_V3_VAMOS" },
463 { GSM48_CMODE_SPEECH_V5_VAMOS, "SPEECH_V5_VAMOS" },
Maxfb348ee2016-03-30 21:14:53 +0200464 { 0, NULL },
465};
466
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200467/*! Translate GSM48_CMODE_SPEECH_* to its corresponding GSM48_CMODE_SPEECH_*_VAMOS mode.
468 * If the mode has no equivalent VAMOS mode, return a negative value.
469 */
470enum gsm48_chan_mode gsm48_chan_mode_to_vamos(enum gsm48_chan_mode mode)
471{
472 switch (mode) {
473 case GSM48_CMODE_SPEECH_V1:
474 case GSM48_CMODE_SPEECH_V1_VAMOS:
475 return GSM48_CMODE_SPEECH_V1_VAMOS;
476 case GSM48_CMODE_SPEECH_EFR:
477 case GSM48_CMODE_SPEECH_V2_VAMOS:
478 return GSM48_CMODE_SPEECH_V2_VAMOS;
479 case GSM48_CMODE_SPEECH_AMR:
480 case GSM48_CMODE_SPEECH_V3_VAMOS:
481 return GSM48_CMODE_SPEECH_V3_VAMOS;
482 case GSM48_CMODE_SPEECH_V5_VAMOS:
483 return GSM48_CMODE_SPEECH_V5_VAMOS;
484 default:
485 return -1;
486 }
487}
488
489/*! Translate GSM48_CMODE_SPEECH_*_VAMOS to its corresponding GSM48_CMODE_SPEECH_* non-vamos mode.
Neels Hofmeyr208c5b62021-05-29 21:31:07 +0000490 * If the mode is not a VAMOS mode, return the unchanged mode.
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200491 */
492enum gsm48_chan_mode gsm48_chan_mode_to_non_vamos(enum gsm48_chan_mode mode)
493{
494 switch (mode) {
495 case GSM48_CMODE_SPEECH_V1_VAMOS:
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200496 return GSM48_CMODE_SPEECH_V1;
497 case GSM48_CMODE_SPEECH_V2_VAMOS:
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200498 return GSM48_CMODE_SPEECH_EFR;
499 case GSM48_CMODE_SPEECH_V3_VAMOS:
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200500 return GSM48_CMODE_SPEECH_AMR;
Vadim Yanitskiy1c88ff92023-03-23 06:33:51 +0700501 case GSM48_CMODE_SPEECH_V5_VAMOS:
502 return GSM48_CMODE_SPEECH_V5;
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200503 default:
Neels Hofmeyr208c5b62021-05-29 21:31:07 +0000504 return mode;
Neels Hofmeyra9da9f72021-04-16 15:36:58 +0200505 }
506}
507
Maxfb348ee2016-03-30 21:14:53 +0200508const struct value_string gsm_chan_t_names[] = {
509 { GSM_LCHAN_NONE, "NONE" },
510 { GSM_LCHAN_SDCCH, "SDCCH" },
511 { GSM_LCHAN_TCH_F, "TCH_F" },
512 { GSM_LCHAN_TCH_H, "TCH_H" },
513 { GSM_LCHAN_UNKNOWN, "UNKNOWN" },
514 { GSM_LCHAN_CCCH, "CCCH" },
515 { GSM_LCHAN_PDTCH, "PDTCH" },
516 { GSM_LCHAN_CBCH, "CBCH" },
517 { 0, NULL },
518};
519
Harald Welte1a8c4e02015-08-16 17:56:25 +0200520static const struct value_string mi_type_names[] = {
521 { GSM_MI_TYPE_NONE, "NONE" },
522 { GSM_MI_TYPE_IMSI, "IMSI" },
523 { GSM_MI_TYPE_IMEI, "IMEI" },
524 { GSM_MI_TYPE_IMEISV, "IMEI-SV" },
525 { GSM_MI_TYPE_TMSI, "TMSI" },
526 { 0, NULL }
527};
528
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200529/*! return string representation of Mobile Identity Type */
Harald Welte1a8c4e02015-08-16 17:56:25 +0200530const char *gsm48_mi_type_name(uint8_t mi)
531{
532 return get_value_string(mi_type_names, mi);
533}
534
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200535/*! Deprecated, see osmo_mobile_identity instead.
536 * Return a human readable representation of a Mobile Identity in caller-provided buffer.
Harald Welte4a62eda2019-03-18 18:27:00 +0100537 * \param[out] buf caller-provided output buffer
538 * \param[in] buf_len size of buf in bytes
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100539 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
540 * \param[in] mi_len Length of mi.
Harald Welte4a62eda2019-03-18 18:27:00 +0100541 * \return buf
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100542 */
Harald Weltea13fb752020-06-16 08:44:42 +0200543char *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 +0100544{
Harald Weltea13fb752020-06-16 08:44:42 +0200545 uint8_t mi_type;
546 uint32_t tmsi;
547 char mi_string[GSM48_MI_SIZE];
548
549 mi_type = (mi && mi_len) ? (mi[0] & GSM_MI_TYPE_MASK) : GSM_MI_TYPE_NONE;
550
551 switch (mi_type) {
552 case GSM_MI_TYPE_TMSI:
553 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
554 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
555 tmsi = osmo_load32be(&mi[1]);
556 snprintf(buf, buf_len, "TMSI-0x%08" PRIX32, tmsi);
557 } else {
558 snprintf(buf, buf_len, "TMSI-invalid");
559 }
560 return buf;
561
562 case GSM_MI_TYPE_IMSI:
563 case GSM_MI_TYPE_IMEI:
564 case GSM_MI_TYPE_IMEISV:
565 osmo_bcd2str(mi_string, sizeof(mi_string), mi, 1, (mi_len * 2) - (mi[0] & GSM_MI_ODD ? 0 : 1), true);
566 snprintf(buf, buf_len, "%s-%s", gsm48_mi_type_name(mi_type), mi_string);
567 return buf;
568
569 default:
Neels Hofmeyr6d670322020-05-26 03:12:29 +0200570 snprintf(buf, buf_len, "unknown");
571 return buf;
Neels Hofmeyr02fd83d2019-01-05 00:38:54 +0100572 }
573}
574
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200575/*! Deprecated, see osmo_mobile_identity instead.
576 * Return a human readable representation of a Mobile Identity in static buffer.
Harald Welte4a62eda2019-03-18 18:27:00 +0100577 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
578 * \param[in] mi_len Length of mi.
579 * \return A string like "IMSI-1234567", "TMSI-0x1234ABCD" or "unknown", "TMSI-invalid"...
580 */
Harald Weltea13fb752020-06-16 08:44:42 +0200581const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
Harald Welte4a62eda2019-03-18 18:27:00 +0100582{
Harald Welte171ef822019-03-28 10:49:05 +0100583 static __thread char mi_name[10 + GSM48_MI_SIZE + 1];
Harald Weltea13fb752020-06-16 08:44:42 +0200584 return osmo_mi_name_buf(mi_name, sizeof(mi_name), mi, mi_len);
Harald Welte4a62eda2019-03-18 18:27:00 +0100585}
586
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200587/*! Deprecated, see osmo_mobile_identity instead.
588 * Return a human readable representation of a Mobile Identity in dynamically-allocated buffer.
Harald Welte179f3572019-03-18 18:38:47 +0100589 * \param[in] ctx talloc context from which to allocate output buffer
590 * \param[in] mi Mobile Identity buffer containing 3GPP TS 04.08 style MI type and data.
591 * \param[in] mi_len Length of mi.
592 * \return A string like "IMSI-1234567", "TMSI-0x1234ABCD" or "unknown", "TMSI-invalid" in a
593 * dynamically-allocated output buffer.
594 */
Harald Weltea13fb752020-06-16 08:44:42 +0200595char *osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
Harald Welte179f3572019-03-18 18:38:47 +0100596{
Harald Weltea13fb752020-06-16 08:44:42 +0200597 size_t buf_len = 10 + GSM48_MI_SIZE + 1;
598 char *mi_name = talloc_size(ctx, buf_len);
599 if (!mi_name)
600 return NULL;
601 return osmo_mi_name_buf(mi_name, buf_len, mi, mi_len);
Harald Welte179f3572019-03-18 18:38:47 +0100602}
603
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200604/*! Extract Mobile Identity from encoded bytes (3GPP TS 24.008 10.5.1.4).
605 *
606 * On failure (negative return value), mi->type == GSM_MI_TYPE_NONE, mi->string[] is all-zero and mi->tmsi ==
607 * GSM_RESERVED_TMSI.
608 *
609 * On success, mi->type reflects the decoded Mobile Identity type (GSM_MI_TYPE_IMSI, GSM_MI_TYPE_TMSI, GSM_MI_TYPE_IMEI
610 * or GSM_MI_TYPE_IMEISV).
611 *
612 * On success, mi->string always contains a human readable representation of the Mobile Identity digits: IMSI, IMEI and
613 * IMEISV as digits like "12345678", and TMSI as "0x" and 8 hexadecimal digits like "0x1234abcd".
614 *
615 * mi->tmsi contains the uint32_t TMSI value iff the extracted Mobile Identity was a TMSI, or GSM_RESERVED_TMSI
616 * otherwise.
617 *
618 * \param[out] mi Return buffer for decoded Mobile Identity.
619 * \param[in] mi_data The encoded Mobile Identity octets.
620 * \param[in] mi_len Number of octets in mi_data.
621 * \param[in] allow_hex If false, hexadecimal digits (>9) result in an error return value.
622 * \returns 0 on success, negative on error: -EBADMSG = invalid length indication or invalid data,
623 * -EINVAL = unknown Mobile Identity type.
624 */
625int osmo_mobile_identity_decode(struct osmo_mobile_identity *mi, const uint8_t *mi_data, uint8_t mi_len,
626 bool allow_hex)
627{
628 int rc;
629 int nibbles_len;
Pau Espin Pedrol6fe865d2021-07-15 13:08:08 +0200630 char *str = NULL; /* initialize to avoid uninitialized false warnings on some gcc versions (11.1.0) */
631 size_t str_size = 0; /* initialize to avoid uninitialized false warnings on some gcc versions (11.1.0) */
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200632
633 if (!mi_data || mi_len < 1)
634 return -EBADMSG;
635
636 nibbles_len = (mi_len - 1) * 2 + ((mi_data[0] & GSM_MI_ODD) ? 1 : 0);
637
638 *mi = (struct osmo_mobile_identity){
639 .type = mi_data[0] & GSM_MI_TYPE_MASK,
640 };
641
642 /* First do length checks */
643 switch (mi->type) {
644 case GSM_MI_TYPE_TMSI:
645 mi->tmsi = GSM_RESERVED_TMSI;
646 if (nibbles_len != (GSM23003_TMSI_NUM_BYTES * 2)) {
647 rc = -EBADMSG;
648 goto return_error;
649 }
650 break;
651
652 case GSM_MI_TYPE_IMSI:
653 if (nibbles_len < GSM23003_IMSI_MIN_DIGITS || nibbles_len > GSM23003_IMSI_MAX_DIGITS) {
654 rc = -EBADMSG;
655 goto return_error;
656 }
657 str = mi->imsi;
658 str_size = sizeof(mi->imsi);
659 break;
660
661 case GSM_MI_TYPE_IMEI:
662 if (nibbles_len != GSM23003_IMEI_NUM_DIGITS && nibbles_len != GSM23003_IMEI_NUM_DIGITS_NO_CHK) {
663 rc = -EBADMSG;
664 goto return_error;
665 }
666 str = mi->imei;
667 str_size = sizeof(mi->imei);
668 break;
669
670 case GSM_MI_TYPE_IMEISV:
671 if (nibbles_len != GSM23003_IMEISV_NUM_DIGITS) {
672 rc = -EBADMSG;
673 goto return_error;
674 }
675 str = mi->imeisv;
676 str_size = sizeof(mi->imeisv);
677 break;
678
679 default:
680 rc = -EINVAL;
681 goto return_error;
682 }
683
684 /* Decode BCD digits */
685 switch (mi->type) {
686 case GSM_MI_TYPE_TMSI:
687 /* MI is a 32bit integer TMSI. Length has been checked above. */
688 if ((mi_data[0] & 0xf0) != 0xf0) {
689 /* A TMSI always has the first nibble == 0xf */
690 rc = -EBADMSG;
691 goto return_error;
692 }
693 mi->tmsi = osmo_load32be(&mi_data[1]);
694 return 0;
695
696 case GSM_MI_TYPE_IMSI:
697 case GSM_MI_TYPE_IMEI:
698 case GSM_MI_TYPE_IMEISV:
699 /* If the length is even, the last nibble (higher nibble of last octet) must be 0xf */
700 if (!(mi_data[0] & GSM_MI_ODD)
701 && ((mi_data[mi_len - 1] & 0xf0) != 0xf0)) {
702 rc = -EBADMSG;
703 goto return_error;
704 }
705 rc = osmo_bcd2str(str, str_size, mi_data, 1, 1 + nibbles_len, allow_hex);
Pau Espin Pedrol6fe865d2021-07-15 13:08:08 +0200706 /* check mi->str printing rc */
707 if (rc < 1 || rc >= str_size) {
708 rc = -EBADMSG;
709 goto return_error;
710 }
711 return 0;
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200712
713 default:
714 /* Already handled above, but as future bug paranoia: */
715 rc = -EINVAL;
716 goto return_error;
717 }
718
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200719return_error:
720 *mi = (struct osmo_mobile_identity){
721 .type = GSM_MI_TYPE_NONE,
722 };
723 return rc;
724}
725
726/*! Return the number of encoded Mobile Identity octets, without actually encoding.
727 * Useful to write tag-length header before encoding the MI.
728 * \param[in] mi Mobile Identity.
729 * \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).
730 * \return octets that osmo_mobile_identity_encode_msgb() will write for this mi.
731 */
732int osmo_mobile_identity_encoded_len(const struct osmo_mobile_identity *mi, int *mi_digits)
733{
734 int mi_nibbles;
735 if (!mi)
736 return -EINVAL;
737 switch (mi->type) {
738 case GSM_MI_TYPE_TMSI:
739 mi_nibbles = GSM23003_TMSI_NUM_BYTES * 2;
740 break;
741 case GSM_MI_TYPE_IMSI:
742 mi_nibbles = strlen(mi->imsi);
743 if (mi_nibbles < GSM23003_IMSI_MIN_DIGITS
744 || mi_nibbles > GSM23003_IMSI_MAX_DIGITS)
745 return -EINVAL;
746 break;
747 case GSM_MI_TYPE_IMEI:
748 mi_nibbles = strlen(mi->imei);
749 if (mi_nibbles < GSM23003_IMEI_NUM_DIGITS_NO_CHK
750 || mi_nibbles > GSM23003_IMEI_NUM_DIGITS)
751 return -EINVAL;
752 break;
753 case GSM_MI_TYPE_IMEISV:
754 mi_nibbles = strlen(mi->imeisv);
755 if (mi_nibbles != GSM23003_IMEISV_NUM_DIGITS)
756 return -EINVAL;
757 break;
758 default:
759 return -ENOTSUP;
760 }
761
762 if (mi_digits)
763 *mi_digits = mi_nibbles;
764
765 /* one type nibble, plus the MI nibbles, plus a filler nibble to complete the last octet:
766 * mi_octets = ceil((float)(mi_nibbles + 1) / 2)
767 */
768 return (mi_nibbles + 2) / 2;
769}
770
771/*! Encode Mobile Identity from uint32_t (TMSI) or digits string (all others) (3GPP TS 24.008 10.5.1.4).
772 *
773 * \param[out] buf Return buffer for encoded Mobile Identity.
774 * \param[in] buflen sizeof(buf).
775 * \param[in] mi Mobile identity to encode.
776 * \param[in] allow_hex If false, hexadecimal digits (>9) result in an error return value.
777 * \returns Amount of bytes written to buf, or negative on error.
778 */
779int osmo_mobile_identity_encode_buf(uint8_t *buf, size_t buflen, const struct osmo_mobile_identity *mi, bool allow_hex)
780{
781 int rc;
782 int nibbles_len;
783 int mi_octets;
784 const char *mi_str;
785
786 if (!buf || !buflen)
787 return -EIO;
788
789 mi_octets = osmo_mobile_identity_encoded_len(mi, &nibbles_len);
790 if (mi_octets < 0)
791 return mi_octets;
792 if (mi_octets > buflen)
793 return -ENOSPC;
794
795 buf[0] = (mi->type & GSM_MI_TYPE_MASK) | ((nibbles_len & 1) ? GSM_MI_ODD : 0);
796
797 switch (mi->type) {
798 case GSM_MI_TYPE_TMSI:
799 buf[0] |= 0xf0;
800 osmo_store32be(mi->tmsi, &buf[1]);
801 return mi_octets;
802
803 case GSM_MI_TYPE_IMSI:
804 mi_str = mi->imsi;
805 break;
806 case GSM_MI_TYPE_IMEI:
807 mi_str = mi->imei;
808 break;
809 case GSM_MI_TYPE_IMEISV:
810 mi_str = mi->imeisv;
811 break;
812 default:
813 return -ENOTSUP;
814 }
815 rc = osmo_str2bcd(buf, buflen, mi_str, 1, -1, allow_hex);
816 if (rc != mi_octets)
817 return -EINVAL;
818 return mi_octets;
819}
820
821/*! Encode Mobile Identity type and BCD digits, appended to a msgb.
822 * Example to add a GSM48_IE_MOBILE_ID IEI with tag and length to a msgb:
823 *
Neels Hofmeyr4247c942020-06-22 17:48:01 +0200824 * struct osmo_mobile_identity mi = { .type = GSM_MI_TYPE_IMSI };
825 * OSMO_STRLCPY_ARRAY(mi.imsi, "1234567890123456");
Neels Hofmeyr83025bf2020-05-26 02:45:23 +0200826 * uint8_t *l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);
827 * int rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
828 * if (rc < 0)
829 * goto error;
830 * *l = rc;
831 *
832 * Example to add a BSSGP_IE_IMSI with tag and variable-size length, where the
833 * length needs to be known at the time of writing the IE tag-length header:
834 *
835 * struct osmo_mobile_identity mi = { .type = GSM_MI_TYPE_IMSI, };
836 * OSMO_STRLCPY_ARRAY(mi.imsi, pinfo->imsi);
837 * msgb_tvl_put(msg, BSSGP_IE_IMSI, osmo_mobile_identity_encoded_len(&mi, NULL));
838 * if (osmo_mobile_identity_encode_msgb(msg, &mi, false) < 0)
839 * goto error;
840 */
841int osmo_mobile_identity_encode_msgb(struct msgb *msg, const struct osmo_mobile_identity *mi, bool allow_hex)
842{
843 int rc = osmo_mobile_identity_encode_buf(msg->tail, msgb_tailroom(msg), mi, allow_hex);
844 if (rc < 0)
845 return rc;
846 msgb_put(msg, rc);
847 return rc;
848}
849
850/*! Extract Mobile Identity from a Complete Layer 3 message.
851 *
852 * Determine the Mobile Identity data and call osmo_mobile_identity_decode() to return a decoded struct
853 * osmo_mobile_identity.
854 *
855 * \param[out] mi Return buffer for decoded Mobile Identity.
856 * \param[in] msg The Complete Layer 3 message to extract from (LU, CM Service Req or Paging Resp).
857 * \returns 0 on success, negative on error: return codes as defined in osmo_mobile_identity_decode(), or
858 * -ENOTSUP = not a Complete Layer 3 message,
859 */
860int osmo_mobile_identity_decode_from_l3(struct osmo_mobile_identity *mi, struct msgb *msg, bool allow_hex)
861{
862 const struct gsm48_hdr *gh;
863 int8_t pdisc = 0;
864 uint8_t mtype = 0;
865 const struct gsm48_loc_upd_req *lu;
866 const uint8_t *cm2_buf;
867 uint8_t cm2_len;
868 const uint8_t *mi_start;
869 const struct gsm48_pag_resp *paging_response;
870 const uint8_t *mi_data;
871 uint8_t mi_len;
872 const struct gsm48_imsi_detach_ind *idi;
873
874 *mi = (struct osmo_mobile_identity){
875 .type = GSM_MI_TYPE_NONE,
876 .tmsi = GSM_RESERVED_TMSI,
877 };
878
879 if (msgb_l3len(msg) < sizeof(*gh))
880 return -EBADMSG;
881
882 gh = msgb_l3(msg);
883 pdisc = gsm48_hdr_pdisc(gh);
884 mtype = gsm48_hdr_msg_type(gh);
885
886 switch (pdisc) {
887 case GSM48_PDISC_MM:
888
889 switch (mtype) {
890 case GSM48_MT_MM_LOC_UPD_REQUEST:
891 /* First make sure that lu-> can be dereferenced */
892 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*lu))
893 return -EBADMSG;
894
895 /* Now we know there is enough msgb data to read a lu->mi_len, so also check that */
896 lu = (struct gsm48_loc_upd_req*)gh->data;
897 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*lu) + lu->mi_len)
898 return -EBADMSG;
899 mi_data = lu->mi;
900 mi_len = lu->mi_len;
901 goto got_mi;
902
903 case GSM48_MT_MM_CM_SERV_REQ:
904 case GSM48_MT_MM_CM_REEST_REQ:
905 /* Unfortunately in Phase1 the Classmark2 length is variable, so we cannot
906 * just use gsm48_service_request struct, and need to parse it manually. */
907 if (msgb_l3len(msg) < sizeof(*gh) + 2)
908 return -EBADMSG;
909
910 cm2_len = gh->data[1];
911 cm2_buf = gh->data + 2;
912 goto got_cm2;
913
914 case GSM48_MT_MM_IMSI_DETACH_IND:
915 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*idi))
916 return -EBADMSG;
917 idi = (struct gsm48_imsi_detach_ind*) gh->data;
918 mi_data = idi->mi;
919 mi_len = idi->mi_len;
920 goto got_mi;
921
922 case GSM48_MT_MM_ID_RESP:
923 if (msgb_l3len(msg) < sizeof(*gh) + 2)
924 return -EBADMSG;
925 mi_data = gh->data+1;
926 mi_len = gh->data[0];
927 goto got_mi;
928
929 default:
930 break;
931 }
932 break;
933
934 case GSM48_PDISC_RR:
935
936 switch (mtype) {
937 case GSM48_MT_RR_PAG_RESP:
938 if (msgb_l3len(msg) < sizeof(*gh) + sizeof(*paging_response))
939 return -EBADMSG;
940 paging_response = (struct gsm48_pag_resp*)gh->data;
941 cm2_len = paging_response->cm2_len;
942 cm2_buf = (uint8_t*)&paging_response->cm2;
943 goto got_cm2;
944
945 default:
946 break;
947 }
948 break;
949 }
950
951 return -ENOTSUP;
952
953got_cm2:
954 /* MI (Mobile Identity) LV follows the Classmark2 */
955
956 /* There must be at least a mi_len byte after the CM2 */
957 if (cm2_buf + cm2_len + 1 > msg->tail)
958 return -EBADMSG;
959
960 mi_start = cm2_buf + cm2_len;
961 mi_len = mi_start[0];
962 mi_data = mi_start + 1;
963
964got_mi:
965 /* mi_data points at the start of the Mobile Identity coding of mi_len bytes */
966 if (mi_data + mi_len > msg->tail)
967 return -EBADMSG;
968
969 return osmo_mobile_identity_decode(mi, mi_data, mi_len, allow_hex);
970}
971
972/*! Return a human readable representation of a struct osmo_mobile_identity.
973 * Write a string like "IMSI-1234567", "TMSI-0x1234ABCD" or "NONE", "NULL".
974 * \param[out] buf String buffer to write to.
975 * \param[in] buflen sizeof(buf).
976 * \param[in] mi Decoded Mobile Identity data.
977 * \return the strlen() of the string written when buflen is sufficiently large, like snprintf().
978 */
979int osmo_mobile_identity_to_str_buf(char *buf, size_t buflen, const struct osmo_mobile_identity *mi)
980{
981 struct osmo_strbuf sb = { .buf = buf, .len = buflen };
982 if (!mi)
983 return snprintf(buf, buflen, "NULL");
984 OSMO_STRBUF_PRINTF(sb, "%s", gsm48_mi_type_name(mi->type));
985 switch (mi->type) {
986 case GSM_MI_TYPE_TMSI:
987 OSMO_STRBUF_PRINTF(sb, "-0x%08" PRIX32, mi->tmsi);
988 break;
989 case GSM_MI_TYPE_IMSI:
990 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imsi);
991 break;
992 case GSM_MI_TYPE_IMEI:
993 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imei);
994 break;
995 case GSM_MI_TYPE_IMEISV:
996 OSMO_STRBUF_PRINTF(sb, "-%s", mi->imeisv);
997 break;
998 default:
999 break;
1000 }
1001 return sb.chars_needed;
1002}
1003
1004/*! Like osmo_mobile_identity_to_str_buf(), but return the string in a talloc buffer.
1005 * \param[in] ctx Talloc context to allocate from.
1006 * \param[in] mi Decoded Mobile Identity data.
1007 * \return a string like "IMSI-1234567", "TMSI-0x1234ABCD" or "NONE", "NULL".
1008 */
1009char *osmo_mobile_identity_to_str_c(void *ctx, const struct osmo_mobile_identity *mi)
1010{
1011 OSMO_NAME_C_IMPL(ctx, 32, "ERROR", osmo_mobile_identity_to_str_buf, mi)
1012}
1013
1014/*! Compare two osmo_mobile_identity structs, returning typical cmp() result.
1015 * \param[in] a Left side osmo_mobile_identity.
1016 * \param[in] b Right side osmo_mobile_identity.
1017 * \returns 0 if both are equal, -1 if a < b, 1 if a > b.
1018 */
1019int osmo_mobile_identity_cmp(const struct osmo_mobile_identity *a, const struct osmo_mobile_identity *b)
1020{
1021 int cmp;
1022 if (a == b)
1023 return 0;
1024 if (!a)
1025 return -1;
1026 if (!b)
1027 return 1;
1028 cmp = OSMO_CMP(a->type, b->type);
1029 if (cmp)
1030 return cmp;
1031 switch (a->type) {
1032 case GSM_MI_TYPE_TMSI:
1033 return OSMO_CMP(a->tmsi, b->tmsi);
1034 case GSM_MI_TYPE_IMSI:
1035 return strncmp(a->imsi, b->imsi, sizeof(a->imsi));
1036 case GSM_MI_TYPE_IMEI:
1037 return strncmp(a->imei, b->imei, sizeof(a->imei));
1038 case GSM_MI_TYPE_IMEISV:
1039 return strncmp(a->imeisv, b->imeisv, sizeof(a->imeisv));
1040 default:
1041 /* No known type, but both have the same type. */
1042 return 0;
1043 }
1044}
1045
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001046/*! Checks is particular message is cipherable in A/Gb mode according to
Maxfdca25d2016-07-05 16:06:28 +02001047 * 3GPP TS 24.008 § 4.7.1.2
1048 * \param[in] hdr Message header
1049 * \return true if message can be encrypted, false otherwise
1050 */
1051bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr)
1052{
1053 switch(hdr->msg_type) {
1054 case GSM48_MT_GMM_ATTACH_REQ:
1055 case GSM48_MT_GMM_ATTACH_REJ:
1056 case GSM48_MT_GMM_AUTH_CIPH_REQ:
1057 case GSM48_MT_GMM_AUTH_CIPH_RESP:
1058 case GSM48_MT_GMM_AUTH_CIPH_REJ:
1059 case GSM48_MT_GMM_AUTH_CIPH_FAIL:
1060 case GSM48_MT_GMM_ID_REQ:
1061 case GSM48_MT_GMM_ID_RESP:
1062 case GSM48_MT_GMM_RA_UPD_REQ:
1063 case GSM48_MT_GMM_RA_UPD_REJ:
1064 return false;
1065 default:
1066 return true;
1067 }
1068}
1069
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001070/* Convert MCC + MNC to BCD representation, legacy implementation.
1071 * Instead use osmo_plmn_to_bcd(), which is also capable of converting
1072 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001073void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Harald Welte61e2bfc2010-03-04 10:53:03 +01001074{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001075 const struct osmo_plmn_id plmn = {
1076 .mcc = mcc,
1077 .mnc = mnc,
1078 .mnc_3_digits = false,
1079 };
1080 osmo_plmn_to_bcd(bcd_dst, &plmn);
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001081}
Harald Welte61e2bfc2010-03-04 10:53:03 +01001082
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001083/* Convert given 3-byte BCD buffer to integers, legacy implementation.
1084 * Instead use osmo_plmn_from_bcd(), which is also capable of converting
1085 * 3-digit MNC that have leading zeros. For parameters, also see there. */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001086void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
1087{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001088 struct osmo_plmn_id plmn;
1089 osmo_plmn_from_bcd(bcd_src, &plmn);
1090 *mcc = plmn.mcc;
1091 *mnc = plmn.mnc;
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001092}
1093
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001094/*! Encode TS 04.08 Location Area Identifier, legacy implementation.
1095 * Instead use gsm48_generate_lai2(), which is capable of three-digit MNC with leading zeros.
1096 * \param[out] lai48 caller-provided memory for output
Harald Welte96e2a002017-06-12 21:44:18 +02001097 * \param[in] mcc Mobile Country Code
1098 * \param[in] mnc Mobile Network Code
1099 * \param[in] lac Location Area Code */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +01001100void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
1101 uint16_t mnc, uint16_t lac)
1102{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001103 const struct osmo_location_area_id lai = {
1104 .plmn = {
1105 .mcc = mcc,
1106 .mnc = mnc,
1107 .mnc_3_digits = false,
1108 },
1109 .lac = lac,
1110 };
1111 gsm48_generate_lai2(lai48, &lai);
Harald Welte61e2bfc2010-03-04 10:53:03 +01001112}
1113
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001114/*! Encode TS 04.08 Location Area Identifier.
1115 * \param[out] lai48 caller-provided memory for output.
1116 * \param[in] lai input of MCC-MNC-LAC. */
1117void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai)
1118{
1119 osmo_plmn_to_bcd(&lai48->digits[0], &lai->plmn);
1120 lai48->lac = osmo_htons(lai->lac);
1121}
1122
1123/*! Decode TS 04.08 Location Area Identifier, legacy implementation.
1124 * Instead use gsm48_decode_lai2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +02001125 * \param[in] Location Area Identifier (encoded)
1126 * \param[out] mcc Mobile Country Code
1127 * \param[out] mnc Mobile Network Code
1128 * \param[out] lac Location Area Code
1129 * \returns 0
1130 *
1131 * Attention: this function returns true integers, not hex! */
Harald Welte774a9de2012-07-13 21:35:13 +02001132int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
1133 uint16_t *mnc, uint16_t *lac)
1134{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001135 struct osmo_location_area_id decoded;
1136 gsm48_decode_lai2(lai, &decoded);
1137 *mcc = decoded.plmn.mcc;
1138 *mnc = decoded.plmn.mnc;
1139 *lac = decoded.lac;
Harald Welte774a9de2012-07-13 21:35:13 +02001140 return 0;
1141}
1142
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001143/*! Decode TS 04.08 Location Area Identifier.
1144 * \param[in] Location Area Identifier (encoded).
1145 * \param[out] decoded Target buffer to write decoded values of MCC-MNC-LAC.
1146 *
1147 * Attention: this function returns true integers, not hex! */
1148void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded)
1149{
1150 osmo_plmn_from_bcd(&lai->digits[0], &decoded->plmn);
1151 decoded->lac = osmo_ntohs(lai->lac);
1152}
1153
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001154/*! Set DTX mode in Cell Options IE (3GPP TS 44.018)
Maxfe65fa72016-05-10 17:17:05 +02001155 * \param[in] op Cell Options structure in which DTX parameters will be set
1156 * \param[in] full Mode for full-rate channels
1157 * \param[in] half Mode for half-rate channels
1158 * \param[in] is_bcch Indicates if we should use 10.5.2.3.1 instead of
1159 * 10.5.2.3a.2
1160 *
1161 * There is no space for separate DTX settings for Full and Half rate channels
1162 * in BCCH - in this case full setting is used for both and half parameter is
1163 * ignored.
1164 */
1165void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
1166 enum gsm48_dtx_mode half, bool is_bcch)
1167{
1168 if (is_bcch) {
1169 switch (full) {
1170 case GSM48_DTX_MAY_BE_USED:
1171 op->dtx = 0;
1172 return;
1173 case GSM48_DTX_SHALL_BE_USED:
1174 op->dtx = 1;
1175 return;
1176 case GSM48_DTX_SHALL_NOT_BE_USED:
1177 op->dtx = 2;
1178 return;
1179 }
1180 } else {
1181 switch (full) {
1182 case GSM48_DTX_MAY_BE_USED:
1183 op->dtx = (half == GSM48_DTX_SHALL_BE_USED) ? 3 : 0;
1184 op->d = (half == GSM48_DTX_SHALL_NOT_BE_USED) ? 0 : 1;
1185 return;
1186 case GSM48_DTX_SHALL_BE_USED:
1187 op->dtx = (half == GSM48_DTX_MAY_BE_USED) ? 3 : 1;
1188 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
1189 return;
1190 case GSM48_DTX_SHALL_NOT_BE_USED:
1191 op->dtx = 2;
1192 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
1193 return;
1194 }
1195 }
1196}
1197
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001198/*! Deprecated, see osmo_mobile_identity instead.
1199 * Generate TS 04.08 Mobile ID from TMSI
Harald Welte96e2a002017-06-12 21:44:18 +02001200 * \param[out] buf Caller-provided output buffer (7 bytes)
1201 * \param[in] tmsi TMSI to be encoded
1202 * \returns number of byes encoded (always 7) */
Harald Welte61e2bfc2010-03-04 10:53:03 +01001203int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
1204{
Harald Weltea13fb752020-06-16 08:44:42 +02001205 uint32_t tmsi_be = osmo_htonl(tmsi);
1206
1207 buf[0] = GSM48_IE_MOBILE_ID;
1208 buf[1] = GSM48_TMSI_LEN;
1209 buf[2] = 0xf0 | GSM_MI_TYPE_TMSI;
1210 memcpy(&buf[3], &tmsi_be, sizeof(tmsi_be));
1211
1212 return 7;
Harald Welte61e2bfc2010-03-04 10:53:03 +01001213}
1214
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001215/*! Deprecated, see osmo_mobile_identity instead.
1216 * Generate TS 24.008 §10.5.1.4 Mobile ID of BCD type from ASCII string
Harald Welte1c3bae12019-01-20 10:37:49 +01001217 * \param[out] buf Caller-provided output buffer of at least GSM48_MID_MAX_SIZE bytes
Maxebf14922018-02-15 11:42:11 +01001218 * \param[in] id Identity to be encoded
Harald Welte1c3bae12019-01-20 10:37:49 +01001219 * \param[in] mi_type Type of identity (e.g. GSM_MI_TYPE_IMSI, IMEI, IMEISV)
Maxebf14922018-02-15 11:42:11 +01001220 * \returns number of bytes used in \a buf */
1221uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
1222{
Harald Weltea13fb752020-06-16 08:44:42 +02001223 uint8_t length = strnlen(id, 16), i, off = 0, odd = (length & 1) == 1;
1224 /* maximum length == 16 (IMEISV) */
1225
1226 buf[0] = GSM48_IE_MOBILE_ID;
1227 buf[2] = osmo_char2bcd(id[0]) << 4 | (mi_type & GSM_MI_TYPE_MASK) | (odd << 3);
1228
1229 /* if the length is even we will fill half of the last octet */
1230 buf[1] = (length + (odd ? 1 : 2)) >> 1;
1231 /* buf[1] maximum = 18/2 = 9 */
1232 OSMO_ASSERT(buf[1] <= 9);
1233
1234 for (i = 1; i < buf[1]; ++i) {
1235 uint8_t upper, lower = osmo_char2bcd(id[++off]);
1236 if (!odd && off + 1 == length)
1237 upper = 0x0f;
1238 else
1239 upper = osmo_char2bcd(id[++off]) & 0x0f;
1240
1241 buf[2 + i] = (upper << 4) | lower;
Maxebf14922018-02-15 11:42:11 +01001242 }
Harald Weltea13fb752020-06-16 08:44:42 +02001243
1244 /* maximum return value: 2 + 9 = 11 */
1245 return 2 + buf[1];
Maxebf14922018-02-15 11:42:11 +01001246}
1247
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001248/*! Deprecated, see osmo_mobile_identity instead.
1249 * Generate TS 04.08 Mobile ID from IMSI
Harald Welte96e2a002017-06-12 21:44:18 +02001250 * \param[out] buf Caller-provided output buffer
1251 * \param[in] imsi IMSI to be encoded
1252 * \returns number of bytes used in \a buf */
Harald Welte61e2bfc2010-03-04 10:53:03 +01001253int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
1254{
Harald Weltea13fb752020-06-16 08:44:42 +02001255 return gsm48_generate_mid(buf, imsi, GSM_MI_TYPE_IMSI);
Harald Welte61e2bfc2010-03-04 10:53:03 +01001256}
Harald Welte9bb553e2010-03-28 18:14:50 +08001257
Neels Hofmeyr83025bf2020-05-26 02:45:23 +02001258/*! Deprecated, see osmo_mobile_identity instead.
1259 * Convert TS 04.08 Mobile Identity (10.5.1.4) to string.
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001260 * 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 +02001261 * \param[out] string Caller-provided buffer for output
1262 * \param[in] str_len Length of \a string in bytes
1263 * \param[in] mi Mobile Identity to be stringified
1264 * \param[in] mi_len Length of \a mi in bytes
Neels Hofmeyr512bf022020-05-25 23:05:04 +02001265 * \returns Return <= 0 on error, > 0 on success.
1266 * WARNING: the return value of this function is not well implemented.
Neels Hofmeyr6aa20ee2018-12-06 00:40:37 +01001267 * Depending on the MI type and amount of output buffer, this may return
1268 * the nr of written bytes, or the written strlen(), or the snprintf()
Neels Hofmeyr512bf022020-05-25 23:05:04 +02001269 * style strlen()-if-the-buffer-were-large-enough.
1270 */
Vadim Yanitskiy0d8da792019-07-25 19:12:23 +07001271int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
Harald Welte9bb553e2010-03-28 18:14:50 +08001272{
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001273 int rc;
Harald Welte163d0ea2010-04-09 07:57:40 +02001274 uint8_t mi_type;
Harald Welte163d0ea2010-04-09 07:57:40 +02001275 uint32_t tmsi;
Harald Welte9bb553e2010-03-28 18:14:50 +08001276
Neels Hofmeyr6adffb92018-12-05 23:30:31 +01001277 mi_type = (mi && mi_len) ? (mi[0] & GSM_MI_TYPE_MASK) : GSM_MI_TYPE_NONE;
Harald Welte9bb553e2010-03-28 18:14:50 +08001278
1279 switch (mi_type) {
Harald Welte9bb553e2010-03-28 18:14:50 +08001280 case GSM_MI_TYPE_TMSI:
Holger Freyther45abec22016-05-20 19:21:27 +00001281 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
Harald Welte9bb553e2010-03-28 18:14:50 +08001282 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
Harald Welte95871da2017-05-15 12:11:36 +02001283 tmsi = osmo_load32be(&mi[1]);
Pau Espin Pedrol45735022017-06-18 14:05:24 +02001284 return snprintf(string, str_len, "%"PRIu32, tmsi);
Harald Welte9bb553e2010-03-28 18:14:50 +08001285 }
1286 break;
1287 case GSM_MI_TYPE_IMSI:
1288 case GSM_MI_TYPE_IMEI:
1289 case GSM_MI_TYPE_IMEISV:
Neels Hofmeyr627e0112018-12-05 21:32:40 +01001290 rc = osmo_bcd2str(string, str_len, mi,
1291 1, mi_len * 2 - ((mi[0] & GSM_MI_ODD) ? 0 : 1), true);
1292 /* osmo_bcd2str() returns snprintf style strlen(), this returns bytes written. */
1293 if (rc < 0)
1294 return 0;
1295 else if (rc < str_len)
1296 return rc + 1;
1297 else
1298 return strlen(string) + 1;
Neels Hofmeyrea2a0ab2018-12-05 23:30:08 +01001299
Harald Welte9bb553e2010-03-28 18:14:50 +08001300 default:
1301 break;
1302 }
Harald Welte9bb553e2010-03-28 18:14:50 +08001303
Neels Hofmeyrea2a0ab2018-12-05 23:30:08 +01001304 if (str_len < 1)
1305 return 0;
1306 *string = '\0';
1307 return 1;
Harald Welte9bb553e2010-03-28 18:14:50 +08001308}
Harald Weltea1c4f762010-05-01 11:59:42 +02001309
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001310/*! Parse TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +02001311 * \param[out] Caller-provided memory for decoded RA ID
1312 * \param[in] buf Input buffer pointing to RAI IE value */
Harald Weltea1c4f762010-05-01 11:59:42 +02001313void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
1314{
1315 raid->mcc = (buf[0] & 0xf) * 100;
1316 raid->mcc += (buf[0] >> 4) * 10;
1317 raid->mcc += (buf[1] & 0xf) * 1;
1318
1319 /* I wonder who came up with the stupidity of encoding the MNC
1320 * differently depending on how many digits its decimal number has! */
1321 if ((buf[1] >> 4) == 0xf) {
1322 raid->mnc = (buf[2] & 0xf) * 10;
1323 raid->mnc += (buf[2] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001324 raid->mnc_3_digits = false;
Harald Weltea1c4f762010-05-01 11:59:42 +02001325 } else {
1326 raid->mnc = (buf[2] & 0xf) * 100;
1327 raid->mnc += (buf[2] >> 4) * 10;
1328 raid->mnc += (buf[1] >> 4) * 1;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001329 raid->mnc_3_digits = true;
Harald Weltea1c4f762010-05-01 11:59:42 +02001330 }
1331
Harald Welte95871da2017-05-15 12:11:36 +02001332 raid->lac = osmo_load16be(buf + 3);
Harald Weltea1c4f762010-05-01 11:59:42 +02001333 raid->rac = buf[5];
1334}
Harald Welte35a93942010-05-01 14:25:22 +02001335
Maxf1ad60e2018-01-05 14:19:33 +01001336/*! Encode a 3GPP TS 24.008 § 10.5.5.15 Routing area identification
1337 * \param[out] out Caller-provided packed struct
1338 * \param[in] raid Routing Area ID to be encoded
1339 */
1340void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid)
1341{
1342 out->lac = osmo_htons(raid->lac);
1343 out->rac = raid->rac;
1344
1345 out->digits[0] = ((raid->mcc / 100) % 10) | (((raid->mcc / 10) % 10) << 4);
1346 out->digits[1] = raid->mcc % 10;
1347
Neels Hofmeyrc4fce142018-02-20 13:47:08 +01001348 if (raid->mnc < 100 && !raid->mnc_3_digits) {
Maxf1ad60e2018-01-05 14:19:33 +01001349 out->digits[1] |= 0xf0;
1350 out->digits[2] = ((raid->mnc / 10) % 10) | ((raid->mnc % 10) << 4);
1351 } else {
1352 out->digits[1] |= (raid->mnc % 10) << 4;
1353 out->digits[2] = ((raid->mnc / 100) % 10) | (((raid->mnc / 10) % 10) << 4);
1354 }
1355}
1356
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001357/*! Encode a TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +02001358 * \param[out] buf Caller-provided output buffer of 6 bytes
1359 * \param[in] raid Routing Area ID to be encoded
1360 * \returns number of bytes used in \a buf */
Harald Welte35a93942010-05-01 14:25:22 +02001361int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
1362{
Maxf1ad60e2018-01-05 14:19:33 +01001363 gsm48_encode_ra((struct gsm48_ra_id *)buf, raid);
Harald Welte35a93942010-05-01 14:25:22 +02001364
1365 return 6;
1366}
Harald Welte2aee7b12011-06-26 14:20:04 +02001367
Philipp Maierd11a5d52021-02-03 22:11:46 +01001368/*! Compare a TS 04.08 Routing Area Identifier
1369 * \param[in] raid1 first Routing Area ID to compare.
1370 * \param[in] raid2 second Routing Area ID to compare.
1371 * \returns true if raid1 and raid2 match, false otherwise. */
1372bool gsm48_ra_equal(const struct gprs_ra_id *raid1, const struct gprs_ra_id *raid2)
1373{
1374 if (raid1->mcc != raid2->mcc)
1375 return false;
1376 if (raid1->mnc != raid2->mnc)
1377 return false;
1378 if (raid1->mnc_3_digits != raid2->mnc_3_digits)
1379 return false;
1380 if (raid1->lac != raid2->lac)
1381 return false;
1382 if (raid1->rac != raid2->rac)
1383 return false;
1384 return true;
1385}
1386
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001387/*! Determine number of paging sub-channels
Harald Welte96e2a002017-06-12 21:44:18 +02001388 * \param[in] chan_desc Control Channel Description
1389 * \returns number of paging sub-channels
1390 *
1391 * Uses From Table 10.5.33 of GSM 04.08 to determine the number of
1392 * paging sub-channels in the given control channel configuration
1393 */
Pau Espin Pedrol6ca0a432022-11-24 17:09:03 +01001394int gsm48_number_of_paging_subchannels(const struct gsm48_control_channel_descr *chan_desc)
Harald Welte2aee7b12011-06-26 14:20:04 +02001395{
Harald Welte94df39e2011-06-26 14:33:57 +02001396 unsigned int n_pag_blocks = gsm0502_get_n_pag_blocks(chan_desc);
1397
1398 if (chan_desc->ccch_conf == RSL_BCCH_CCCH_CONF_1_C)
1399 return OSMO_MAX(1, n_pag_blocks) * (chan_desc->bs_pa_mfrms + 2);
1400 else
1401 return n_pag_blocks * (chan_desc->bs_pa_mfrms + 2);
Harald Welte2aee7b12011-06-26 14:20:04 +02001402}
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001403
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001404/*! TS 04.08 Protocol Descriptor names */
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001405const struct value_string gsm48_pdisc_names[] = {
Harald Welteea0bc962018-01-24 16:17:45 +01001406 { GSM48_PDISC_GROUP_CC, "VGCC" },
1407 { GSM48_PDISC_BCAST_CC, "VBCC" },
1408 { GSM48_PDISC_PDSS1, "PDSS1" },
1409 { GSM48_PDISC_CC, "CC" },
1410 { GSM48_PDISC_PDSS2, "PDSS2" },
1411 { GSM48_PDISC_MM, "MM" },
1412 { GSM48_PDISC_RR, "RR" },
1413 { GSM48_PDISC_MM_GPRS, "GMM" },
1414 { GSM48_PDISC_SMS, "SMS" },
1415 { GSM48_PDISC_SM_GPRS, "SM" },
1416 { GSM48_PDISC_NC_SS, "NCSS" },
1417 { GSM48_PDISC_LOC, "LCS" },
1418 { GSM48_PDISC_EXTEND, "EXTD" },
1419 { GSM48_PDISC_MASK, "MASK" },
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +01001420 { 0, NULL }
1421};
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001422
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001423/*! TS 04.08 RR Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001424const struct value_string gsm48_rr_msgtype_names[] = {
1425 OSMO_VALUE_STRING(GSM48_MT_RR_INIT_REQ),
1426 OSMO_VALUE_STRING(GSM48_MT_RR_ADD_ASS),
1427 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS),
1428 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_EXT),
1429 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_REJ),
1430 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_FAIL),
1431 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REJECT),
1432 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REQUEST),
1433 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_ASS),
1434
1435 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_CMD),
1436 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_COMPL),
1437
1438 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_CMD),
1439 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_ACK),
1440 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_REJ),
1441
1442 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_CMD),
1443 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_COMPL),
1444 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_FAIL),
1445 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_CMD),
1446 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_COMPL),
1447 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_FAIL),
1448 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
1449 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
1450 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_CMD),
1451
1452 OSMO_VALUE_STRING(GSM48_MT_RR_CELL_CHG_ORDER),
1453 OSMO_VALUE_STRING(GSM48_MT_RR_PDCH_ASS_CMD),
1454
1455 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_REL),
1456 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL),
1457 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL_COMP),
1458
1459 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_1),
1460 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_2),
1461 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_3),
1462 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_RESP),
1463 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_NCH),
1464 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_FACCH),
1465 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_RESP),
1466 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_NOTIF),
1467 OSMO_VALUE_STRING(GSM48_MT_RR_UTRAN_CLSM_CHG),
1468 OSMO_VALUE_STRING(GSM48_MT_RR_CDMA2K_CLSM_CHG),
1469 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_UTRAN_HANDO),
1470 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_CDMA2K_HANDO),
1471
1472 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_8),
1473 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_1),
1474 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2),
1475 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_3),
1476 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_4),
1477 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5),
1478 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_6),
1479 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_7),
1480
1481 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2bis),
1482 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2ter),
1483 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2quater),
1484 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5bis),
1485 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5ter),
1486 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_9),
1487 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_13),
1488
1489 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_16),
1490 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_17),
1491
1492 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_18),
1493 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_19),
1494 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_20),
1495
1496 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF),
1497 OSMO_VALUE_STRING(GSM48_MT_RR_STATUS),
1498 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF_ACK),
1499 OSMO_VALUE_STRING(GSM48_MT_RR_FREQ_REDEF),
1500 OSMO_VALUE_STRING(GSM48_MT_RR_MEAS_REP),
1501 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_CHG),
1502 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_ENQ),
1503 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP),
1504 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP_ORD),
1505 OSMO_VALUE_STRING(GSM48_MT_RR_GPRS_SUSP_REQ),
1506 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_INFO),
1507
1508 OSMO_VALUE_STRING(GSM48_MT_RR_VGCS_UPL_GRANT),
1509 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_RELEASE),
1510 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_FREE),
1511 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_BUSY),
1512 OSMO_VALUE_STRING(GSM48_MT_RR_TALKER_IND),
1513 { 0, NULL }
1514};
1515
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001516/*! TS 04.08 MM Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001517const struct value_string gsm48_mm_msgtype_names[] = {
1518 OSMO_VALUE_STRING(GSM48_MT_MM_IMSI_DETACH_IND),
1519 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_ACCEPT),
1520 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REJECT),
1521 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REQUEST),
1522
1523 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REJ),
1524 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REQ),
1525 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_RESP),
1526 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_FAIL),
1527 OSMO_VALUE_STRING(GSM48_MT_MM_ID_REQ),
1528 OSMO_VALUE_STRING(GSM48_MT_MM_ID_RESP),
1529 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_CMD),
1530 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_COMPL),
1531
1532 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ACC),
1533 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REJ),
1534 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ABORT),
1535 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REQ),
1536 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_PROMPT),
1537 OSMO_VALUE_STRING(GSM48_MT_MM_CM_REEST_REQ),
1538 OSMO_VALUE_STRING(GSM48_MT_MM_ABORT),
1539
1540 OSMO_VALUE_STRING(GSM48_MT_MM_NULL),
1541 OSMO_VALUE_STRING(GSM48_MT_MM_STATUS),
1542 OSMO_VALUE_STRING(GSM48_MT_MM_INFO),
1543 { 0, NULL }
1544};
1545
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001546/*! TS 04.08 CC Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001547const struct value_string gsm48_cc_msgtype_names[] = {
1548 OSMO_VALUE_STRING(GSM48_MT_CC_ALERTING),
1549 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_CONF),
1550 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_PROC),
1551 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT),
1552 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT_ACK),
1553 OSMO_VALUE_STRING(GSM48_MT_CC_EMERG_SETUP),
1554 OSMO_VALUE_STRING(GSM48_MT_CC_PROGRESS),
1555 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB),
1556 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB_CONF),
1557 OSMO_VALUE_STRING(GSM48_MT_CC_RECALL),
1558 OSMO_VALUE_STRING(GSM48_MT_CC_START_CC),
1559 OSMO_VALUE_STRING(GSM48_MT_CC_SETUP),
1560
1561 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY),
1562 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_COMPL),
1563 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_REJECT),
1564 OSMO_VALUE_STRING(GSM48_MT_CC_USER_INFO),
1565 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD),
1566 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_ACK),
1567 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_REJ),
1568 OSMO_VALUE_STRING(GSM48_MT_CC_RETR),
1569 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_ACK),
1570 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_REJ),
1571
1572 OSMO_VALUE_STRING(GSM48_MT_CC_DISCONNECT),
1573 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE),
1574 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE_COMPL),
1575
1576 OSMO_VALUE_STRING(GSM48_MT_CC_CONG_CTRL),
1577 OSMO_VALUE_STRING(GSM48_MT_CC_NOTIFY),
1578 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS),
1579 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS_ENQ),
1580 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF),
1581 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF),
1582 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF_ACK),
1583 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_ACK),
1584 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_REJ),
1585 OSMO_VALUE_STRING(GSM48_MT_CC_FACILITY),
1586 { 0, NULL }
1587};
1588
Keith3cdaa8d2018-08-31 20:09:18 +02001589/*! TS 04.08 10.5..4.11 Call Control Cause Values */
1590const struct value_string gsm48_cc_cause_names[] = {
1591 { GSM48_CC_CAUSE_UNASSIGNED_NR, "UNASSIGNED_NR" },
1592 { GSM48_CC_CAUSE_NO_ROUTE, "NO_ROUTE" },
1593 { GSM48_CC_CAUSE_CHAN_UNACCEPT, "CHAN_UNACCEPT" },
1594 { GSM48_CC_CAUSE_OP_DET_BARRING, "OP_DET_BARRING" },
1595 { GSM48_CC_CAUSE_NORM_CALL_CLEAR, "NORM_CALL_CLEAR" },
1596 { GSM48_CC_CAUSE_USER_BUSY, "USER_BUSY" },
1597 { GSM48_CC_CAUSE_USER_NOTRESPOND, "USER_NOTRESPOND" },
1598 { GSM48_CC_CAUSE_USER_ALERTING_NA, "USER_ALERTING_NA" },
1599 { GSM48_CC_CAUSE_CALL_REJECTED, "CALL_REJECTED" },
1600 { GSM48_CC_CAUSE_NUMBER_CHANGED, "NUMBER_CHANGED" },
1601 { GSM48_CC_CAUSE_PRE_EMPTION, "PRE_EMPTION" },
1602 { GSM48_CC_CAUSE_NONSE_USER_CLR, "NONSE_USER_CLR" },
1603 { GSM48_CC_CAUSE_DEST_OOO, "DEST_OOO" },
1604 { GSM48_CC_CAUSE_INV_NR_FORMAT, "INV_NR_FORMAT" },
1605 { GSM48_CC_CAUSE_FACILITY_REJ, "FACILITY_REJ" },
1606 { GSM48_CC_CAUSE_RESP_STATUS_INQ, "RESP_STATUS_INQ" },
1607 { GSM48_CC_CAUSE_NORMAL_UNSPEC, "NORMAL_UNSPEC" },
1608 { GSM48_CC_CAUSE_NO_CIRCUIT_CHAN, "NO_CIRCUIT_CHAN" },
1609 { GSM48_CC_CAUSE_NETWORK_OOO, "NETWORK_OOO" },
1610 { GSM48_CC_CAUSE_TEMP_FAILURE, "TEMP_FAILURE" },
1611 { GSM48_CC_CAUSE_SWITCH_CONG, "SWITCH_CONG" },
1612 { GSM48_CC_CAUSE_ACC_INF_DISCARD, "ACC_INF_DISCARD" },
1613 { GSM48_CC_CAUSE_REQ_CHAN_UNAVAIL, "REQ_CHAN_UNAVAIL" },
1614 { GSM48_CC_CAUSE_RESOURCE_UNAVAIL, "RESOURCE_UNAVAIL" },
1615 { GSM48_CC_CAUSE_QOS_UNAVAIL, "QOS_UNAVAIL" },
1616 { GSM48_CC_CAUSE_REQ_FAC_NOT_SUBSC, "REQ_FAC_NOT_SUBSC" },
1617 { GSM48_CC_CAUSE_INC_BARRED_CUG, "INC_BARRED_CUG" },
1618 { GSM48_CC_CAUSE_BEARER_CAP_UNAUTH, "BEARER_CAP_UNAUTH" },
1619 { GSM48_CC_CAUSE_BEARER_CA_UNAVAIL, "BEARER_CA_UNAVAIL" },
1620 { GSM48_CC_CAUSE_SERV_OPT_UNAVAIL, "SERV_OPT_UNAVAIL" },
1621 { GSM48_CC_CAUSE_BEARERSERV_UNIMPL, "BEARERSERV_UNIMPL" },
1622 { GSM48_CC_CAUSE_ACM_GE_ACM_MAX, "ACM_GE_ACM_MAX" },
1623 { GSM48_CC_CAUSE_REQ_FAC_NOTIMPL, "REQ_FAC_NOTIMPL" },
1624 { GSM48_CC_CAUSE_RESTR_BCAP_AVAIL, "RESTR_BCAP_AVAIL" },
1625 { GSM48_CC_CAUSE_SERV_OPT_UNIMPL, "SERV_OPT_UNIMPL" },
1626 { GSM48_CC_CAUSE_INVAL_TRANS_ID, "INVAL_TRANS_ID" },
1627 { GSM48_CC_CAUSE_USER_NOT_IN_CUG, "USER_NOT_IN_CUG" },
1628 { GSM48_CC_CAUSE_INCOMPAT_DEST, "INCOMPAT_DEST" },
1629 { GSM48_CC_CAUSE_INVAL_TRANS_NET, "INVAL_TRANS_NET" },
1630 { GSM48_CC_CAUSE_SEMANTIC_INCORR, "SEMANTIC_INCORR" },
1631 { GSM48_CC_CAUSE_INVAL_MAND_INF, "INVAL_MAND_INF" },
1632 { GSM48_CC_CAUSE_MSGTYPE_NOTEXIST, "MSGTYPE_NOTEXIST" },
1633 { GSM48_CC_CAUSE_MSGTYPE_INCOMPAT, "MSGTYPE_INCOMPAT" },
1634 { GSM48_CC_CAUSE_IE_NOTEXIST, "IE_NOTEXIST" },
1635 { GSM48_CC_CAUSE_COND_IE_ERR, "COND_IE_ERR" },
1636 { GSM48_CC_CAUSE_MSG_INCOMP_STATE, "MSG_INCOMP_STATE" },
1637 { GSM48_CC_CAUSE_RECOVERY_TIMER, "RECOVERY_TIMER" },
1638 { GSM48_CC_CAUSE_PROTO_ERR, "PROTO_ERR" },
1639 { GSM48_CC_CAUSE_INTERWORKING, "INTERWORKING" },
1640 { 0 , NULL }
1641};
1642
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +07001643/*! TS 04.80, section 3.4 Messages for supplementary services control */
1644const struct value_string gsm48_nc_ss_msgtype_names[] = {
1645 OSMO_VALUE_STRING(GSM0480_MTYPE_RELEASE_COMPLETE),
1646 OSMO_VALUE_STRING(GSM0480_MTYPE_FACILITY),
1647 OSMO_VALUE_STRING(GSM0480_MTYPE_REGISTER),
1648 { 0, NULL }
1649};
1650
Harald Welte4a62eda2019-03-18 18:27:00 +01001651/*! Compose a string naming the message type for given protocol, in a caller-provided buffer.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001652 * If the message type string is known, return the message type name, otherwise
1653 * return "<protocol discriminator name>:<message type in hex>".
Harald Welte4a62eda2019-03-18 18:27:00 +01001654 * \param[out] buf caller-allcated output string buffer
1655 * \param[in] buf_len size of buf in bytes
Harald Welte96e2a002017-06-12 21:44:18 +02001656 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1657 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
Harald Welte4a62eda2019-03-18 18:27:00 +01001658 * \returns buf
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001659 */
Harald Welte4a62eda2019-03-18 18:27:00 +01001660char *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 +01001661{
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001662 const struct value_string *msgt_names;
1663
1664 switch (pdisc) {
1665 case GSM48_PDISC_RR:
1666 msgt_names = gsm48_rr_msgtype_names;
1667 break;
1668 case GSM48_PDISC_MM:
1669 msgt_names = gsm48_mm_msgtype_names;
1670 break;
1671 case GSM48_PDISC_CC:
1672 msgt_names = gsm48_cc_msgtype_names;
1673 break;
Vadim Yanitskiy8d41d722018-04-17 11:17:28 +07001674 case GSM48_PDISC_NC_SS:
1675 msgt_names = gsm48_nc_ss_msgtype_names;
1676 break;
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001677 default:
1678 msgt_names = NULL;
1679 break;
1680 }
1681
1682 if (msgt_names)
Harald Welte4a62eda2019-03-18 18:27:00 +01001683 snprintf(buf, buf_len, "%s", get_value_string(msgt_names, msg_type));
1684 else
1685 snprintf(buf, buf_len, "%s:0x%02x", gsm48_pdisc_name(pdisc), msg_type);
1686 return buf;
1687}
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001688
Harald Welte4a62eda2019-03-18 18:27:00 +01001689/*! Compose a string naming the message type for given protocol, in a static buffer.
1690 * If the message type string is known, return the message type name, otherwise
1691 * return "<protocol discriminator name>:<message type in hex>".
1692 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1693 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
1694 * \returns statically allocated string or string constant.
1695 */
1696const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type)
1697{
Harald Welte171ef822019-03-28 10:49:05 +01001698 static __thread char namebuf[64];
Harald Welte4a62eda2019-03-18 18:27:00 +01001699 return gsm48_pdisc_msgtype_name_buf(namebuf, sizeof(namebuf), pdisc, msg_type);
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +01001700}
Harald Welte96e2a002017-06-12 21:44:18 +02001701
Harald Welte179f3572019-03-18 18:38:47 +01001702/*! Compose a string naming the message type for given protocol, in a dynamically-allocated buffer.
1703 * If the message type string is known, return the message type name, otherwise
1704 * return "<protocol discriminator name>:<message type in hex>".
1705 * \param[in] ctx talloc context from which to allocate output buffer
1706 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
1707 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
1708 * \returns string representation in dynamically allocated output buffer.
1709 */
1710char *gsm48_pdisc_msgtype_name_c(const void *ctx, uint8_t pdisc, uint8_t msg_type)
1711{
1712 char *namebuf = talloc_size(ctx, 64);
1713 if (!namebuf)
1714 return NULL;
1715 return gsm48_pdisc_msgtype_name_buf(namebuf, 64, pdisc, msg_type);
1716}
1717
Neels Hofmeyraead2412018-04-06 04:31:00 +02001718const struct value_string gsm48_reject_value_names[] = {
1719 { GSM48_REJECT_IMSI_UNKNOWN_IN_HLR, "IMSI_UNKNOWN_IN_HLR" },
1720 { GSM48_REJECT_ILLEGAL_MS, "ILLEGAL_MS" },
1721 { GSM48_REJECT_IMSI_UNKNOWN_IN_VLR, "IMSI_UNKNOWN_IN_VLR" },
1722 { GSM48_REJECT_IMEI_NOT_ACCEPTED, "IMEI_NOT_ACCEPTED" },
1723 { GSM48_REJECT_ILLEGAL_ME, "ILLEGAL_ME" },
1724 { GSM48_REJECT_PLMN_NOT_ALLOWED, "PLMN_NOT_ALLOWED" },
1725 { GSM48_REJECT_LOC_NOT_ALLOWED, "LOC_NOT_ALLOWED" },
1726 { GSM48_REJECT_ROAMING_NOT_ALLOWED, "ROAMING_NOT_ALLOWED" },
1727 { GSM48_REJECT_NETWORK_FAILURE, "NETWORK_FAILURE" },
1728 { GSM48_REJECT_SYNCH_FAILURE, "SYNCH_FAILURE" },
1729 { GSM48_REJECT_CONGESTION, "CONGESTION" },
1730 { GSM48_REJECT_SRV_OPT_NOT_SUPPORTED, "SRV_OPT_NOT_SUPPORTED" },
1731 { GSM48_REJECT_RQD_SRV_OPT_NOT_SUPPORTED, "RQD_SRV_OPT_NOT_SUPPORTED" },
1732 { GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER, "SRV_OPT_TMP_OUT_OF_ORDER" },
1733 { GSM48_REJECT_CALL_CAN_NOT_BE_IDENTIFIED, "CALL_CAN_NOT_BE_IDENTIFIED" },
1734 { GSM48_REJECT_INCORRECT_MESSAGE, "INCORRECT_MESSAGE" },
1735 { GSM48_REJECT_INVALID_MANDANTORY_INF, "INVALID_MANDANTORY_INF" },
1736 { GSM48_REJECT_MSG_TYPE_NOT_IMPLEMENTED, "MSG_TYPE_NOT_IMPLEMENTED" },
1737 { GSM48_REJECT_MSG_TYPE_NOT_COMPATIBLE, "MSG_TYPE_NOT_COMPATIBLE" },
1738 { GSM48_REJECT_INF_ELEME_NOT_IMPLEMENTED, "INF_ELEME_NOT_IMPLEMENTED" },
1739 { GSM48_REJECT_CONDTIONAL_IE_ERROR, "CONDTIONAL_IE_ERROR" },
1740 { GSM48_REJECT_MSG_NOT_COMPATIBLE, "MSG_NOT_COMPATIBLE" },
1741 { GSM48_REJECT_PROTOCOL_ERROR, "PROTOCOL_ERROR" },
1742 { GSM48_REJECT_GPRS_NOT_ALLOWED, "GPRS_NOT_ALLOWED" },
1743 { GSM48_REJECT_SERVICES_NOT_ALLOWED, "SERVICES_NOT_ALLOWED" },
1744 { GSM48_REJECT_MS_IDENTITY_NOT_DERVIVABLE, "MS_IDENTITY_NOT_DERVIVABLE" },
1745 { GSM48_REJECT_IMPLICITLY_DETACHED, "IMPLICITLY_DETACHED" },
1746 { GSM48_REJECT_GPRS_NOT_ALLOWED_IN_PLMN, "GPRS_NOT_ALLOWED_IN_PLMN" },
1747 { GSM48_REJECT_MSC_TMP_NOT_REACHABLE, "MSC_TMP_NOT_REACHABLE" },
1748 { 0, NULL }
1749};
1750
Vadim Yanitskiy30cfeeb2018-08-03 05:44:00 +07001751/*! Wrap a given \ref msg with \ref gsm48_hdr structure
1752 * \param[out] msg A message to be wrapped
1753 * \param[in] pdisc GSM TS 04.07 protocol discriminator 1/2,
1754 * sub-pdisc, trans_id or skip_ind 1/2,
1755 * see section 11.2.3.1 for details
1756 * \param[in] msg_type GSM TS 04.08 message type
1757 * @return pointer to pushed header within \ref msg
1758 */
1759struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
1760 uint8_t pdisc, uint8_t msg_type)
1761{
1762 struct gsm48_hdr *gh;
1763
1764 gh = (struct gsm48_hdr *) msgb_push(msg, sizeof(*gh));
1765 gh->proto_discr = pdisc;
1766 gh->msg_type = msg_type;
1767
1768 return gh;
1769}
1770
Neels Hofmeyr92f3f5e2019-01-05 00:39:13 +01001771const struct value_string osmo_lu_type_names[] = {
1772 { GSM48_LUPD_NORMAL, "NORMAL" },
1773 { GSM48_LUPD_PERIODIC, "PERIODIC" },
1774 { GSM48_LUPD_IMSI_ATT, "IMSI-ATTACH" },
1775 { GSM48_LUPD_RESERVED, "RESERVED" },
1776 {}
1777};
1778
Neels Hofmeyrf8963f92019-01-10 23:33:32 +01001779const struct value_string osmo_cm_service_type_names[] = {
1780 { GSM48_CMSERV_MO_CALL_PACKET, "MO-Call" },
1781 { GSM48_CMSERV_EMERGENCY, "Emergency-Call" },
1782 { GSM48_CMSERV_SMS, "Short-Messaging-Service" },
1783 { GSM48_CMSERV_SUP_SERV, "Supplementary-Service" },
1784 { GSM48_CMSERV_VGCS, "Voice-Group-Call" },
1785 { GSM48_CMSERV_VBS, "Voice-Broadcast-Call" },
1786 { GSM48_CMSERV_LOC_SERV, "Location-Service" },
1787 {}
1788};
1789
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001790bool osmo_gsm48_classmark1_is_r99(const struct gsm48_classmark1 *cm1)
1791{
1792 return cm1->rev_lev >= 2;
1793}
1794
1795bool osmo_gsm48_classmark2_is_r99(const struct gsm48_classmark2 *cm2, uint8_t cm2_len)
1796{
1797 if (!cm2_len)
1798 return false;
1799 return cm2->rev_lev >= 2;
1800}
1801
1802/*! Return true if any of Classmark 1 or Classmark 2 are present and indicate R99 capability.
1803 * \param[in] cm Classmarks.
1804 * \returns True if R99 or later, false if pre-R99 or no Classmarks are present.
1805 */
1806bool osmo_gsm48_classmark_is_r99(const struct osmo_gsm48_classmark *cm)
1807{
1808 if (cm->classmark1_set)
1809 return osmo_gsm48_classmark1_is_r99(&cm->classmark1);
1810 return osmo_gsm48_classmark2_is_r99(&cm->classmark2, cm->classmark2_len);
1811}
1812
1813/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1814 * \param[in] cm Classmarks.
1815 * \returns A statically allocated string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3"
1816 */
Harald Welte4a62eda2019-03-18 18:27:00 +01001817char *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 +01001818{
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001819 char cm1[42] = "no-cm1";
1820 char cm2[42] = " no-cm2";
Neels Hofmeyr9e6f5f12019-03-11 05:07:56 +01001821 char cm3[42] = " no-cm3";
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001822
1823 if (cm->classmark1_set)
1824 snprintf(cm1, sizeof(cm1), "cm1{a5/1=%s}",
1825 cm->classmark1.a5_1 ? "not-supported":"supported" /* inverted logic */);
1826
1827 if (cm->classmark2_len >= 3)
1828 snprintf(cm2, sizeof(cm2), " cm2{0x%x=%s%s}",
1829 cm->classmark2.a5_2 + (cm->classmark2.a5_3 << 1),
1830 cm->classmark2.a5_2 ? " A5/2" : "",
1831 cm->classmark2.a5_3 ? " A5/3" : "");
1832
1833 if (cm->classmark3_len >= 1)
1834 snprintf(cm3, sizeof(cm3), " cm3{0x%x=%s%s%s%s}",
1835 cm->classmark3[0],
1836 cm->classmark3[0] & (1 << 0) ? " A5/4" : "",
1837 cm->classmark3[0] & (1 << 1) ? " A5/5" : "",
1838 cm->classmark3[0] & (1 << 2) ? " A5/6" : "",
1839 cm->classmark3[0] & (1 << 3) ? " A5/7" : "");
1840
Harald Welte4a62eda2019-03-18 18:27:00 +01001841 snprintf(buf, buf_len, "%s%s%s", cm1, cm2, cm3);
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001842 return buf;
1843}
1844
Harald Welte4a62eda2019-03-18 18:27:00 +01001845/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1846 * \param[in] cm Classmarks.
1847 * \returns A statically allocated string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3"
1848 */
1849const char *osmo_gsm48_classmark_a5_name(const struct osmo_gsm48_classmark *cm)
1850{
Harald Welte171ef822019-03-28 10:49:05 +01001851 static __thread char buf[128];
Harald Welte4a62eda2019-03-18 18:27:00 +01001852 return osmo_gsm48_classmark_a5_name_buf(buf, sizeof(buf), cm);
1853}
1854
Harald Welte179f3572019-03-18 18:38:47 +01001855/*! Return a string representation of A5 cipher algorithms indicated by Classmark 1, 2 and 3.
1856 * \param[in] ctx talloc context from which to allocate output buffer
1857 * \param[in] cm Classmarks.
1858 * \returns string like "cm1{a5/1=supported} cm2{0x23= A5/2 A5/3} no-cm3" in dynamically-allocated
1859 * output buffer.
1860 */
1861char *osmo_gsm48_classmark_a5_name_c(const void *ctx, const struct osmo_gsm48_classmark *cm)
1862{
1863 char *buf = talloc_size(ctx, 128);
1864 if (!buf)
1865 return NULL;
1866 return osmo_gsm48_classmark_a5_name_buf(buf, 128, cm);
1867}
Harald Welte4a62eda2019-03-18 18:27:00 +01001868
Neels Hofmeyr7740d262019-01-16 16:53:26 +01001869/*! Overwrite dst with the Classmark information present in src.
1870 * Add an new Classmark and overwrite in dst what src has to offer, but where src has no Classmark information, leave
1871 * dst unchanged. (For Classmark 2 and 3, dst will exactly match any non-zero Classmark length from src, hence may end
1872 * up with a shorter Classmark after this call.)
1873 * \param[out] dst The target Classmark storage to be updated.
1874 * \param[in] src The new Classmark information to read from.
1875 */
1876void osmo_gsm48_classmark_update(struct osmo_gsm48_classmark *dst, const struct osmo_gsm48_classmark *src)
1877{
1878 if (src->classmark1_set) {
1879 dst->classmark1 = src->classmark1;
1880 dst->classmark1_set = true;
1881 }
1882 if (src->classmark2_len) {
1883 dst->classmark2_len = src->classmark2_len;
1884 dst->classmark2 = src->classmark2;
1885 }
1886 if (src->classmark3_len) {
1887 dst->classmark3_len = src->classmark3_len;
1888 memcpy(dst->classmark3, src->classmark3, OSMO_MIN(sizeof(dst->classmark3), src->classmark3_len));
1889 }
1890}
1891
1892
1893/*! Determine if the given Classmark (1/2/3) value permits a given A5/n cipher.
1894 * \param[in] cm Classmarks.
1895 * \param[in] a5 The N in A5/N for which to query whether support is indicated.
1896 * \return 1 when the given A5/n is permitted, 0 when not (or a5 > 7), and negative if the respective MS Classmark is
1897 * not known, where the negative number indicates the classmark type: -2 means Classmark 2 is not available. The
1898 * idea is that when e.g. A5/3 is requested and the corresponding Classmark 3 is not available, that the caller
1899 * can react by obtaining Classmark 3 and calling again once it is available.
1900 */
1901int osmo_gsm48_classmark_supports_a5(const struct osmo_gsm48_classmark *cm, uint8_t a5)
1902{
1903 switch (a5) {
1904 case 0:
1905 /* all phones must implement A5/0, see 3GPP TS 43.020 4.9 */
1906 return 1;
1907 case 1:
1908 /* 3GPP TS 43.020 4.9 requires A5/1 to be suppored by all phones and actually states:
1909 * "The network shall not provide service to an MS which indicates that it does not
1910 * support the ciphering algorithm A5/1.". However, let's be more tolerant based
1911 * on policy here */
1912 /* See 3GPP TS 24.008 10.5.1.7 */
1913 if (!cm->classmark1_set)
1914 return -1;
1915 /* Inverted logic for this bit! */
1916 return cm->classmark1.a5_1 ? 0 : 1;
1917 case 2:
1918 /* See 3GPP TS 24.008 10.5.1.6 */
1919 if (cm->classmark2_len < 3)
1920 return -2;
1921 return cm->classmark2.a5_2 ? 1 : 0;
1922 case 3:
1923 if (cm->classmark2_len < 3)
1924 return -2;
1925 return cm->classmark2.a5_3 ? 1 : 0;
1926 case 4:
1927 case 5:
1928 case 6:
1929 case 7:
1930 /* See 3GPP TS 24.008 10.5.1.7 */
1931 if (!cm->classmark3_len)
1932 return -3;
1933 return (cm->classmark3[0] & (1 << (a5-4))) ? 1 : 0;
1934 default:
1935 return 0;
1936 }
1937}
1938
Pau Espin Pedrolb99f4ca2019-10-31 13:35:22 +01001939/*! Decode power class from Classmark1/2 RF power capability field.
1940 * \param[in] rf_power_cap The RF power capability field (3 bits).
1941 * \param[in] band the band of the arfcn from where the classmark was received
1942 * \return the MS power class on success, negative on error.
1943 */
1944int8_t osmo_gsm48_rfpowercap2powerclass(enum gsm_band band, uint8_t rf_power_cap)
1945{
1946 switch (band) {
1947 case GSM_BAND_1800:
1948 case GSM_BAND_1900:
1949 if (rf_power_cap > 2)
1950 return -1;
1951 return rf_power_cap + 1;
1952 default:
1953 if (rf_power_cap > 4)
1954 return -1;
1955 return rf_power_cap + 1;
1956 }
1957}
1958
1959
Harald Welte96e2a002017-06-12 21:44:18 +02001960/*! @} */