blob: d9a5527345f3e2b596a101be67a19bde965e4aa8 [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>
Harald Welte61e2bfc2010-03-04 10:53:03 +010033
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010034#include <osmocom/core/utils.h>
Harald Welte95871da2017-05-15 12:11:36 +020035#include <osmocom/core/byteswap.h>
36#include <osmocom/core/bit16gen.h>
37#include <osmocom/core/bit32gen.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010038#include <osmocom/gsm/tlv.h>
39#include <osmocom/gsm/gsm48.h>
Harald Welte94df39e2011-06-26 14:33:57 +020040#include <osmocom/gsm/gsm0502.h>
Maxfb348ee2016-03-30 21:14:53 +020041#include <osmocom/gsm/gsm_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010042#include <osmocom/gsm/protocol/gsm_04_08.h>
Harald Welte2aee7b12011-06-26 14:20:04 +020043#include <osmocom/gsm/protocol/gsm_08_58.h>
Maxfdca25d2016-07-05 16:06:28 +020044#include <osmocom/gsm/protocol/gsm_04_08_gprs.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 },
123 [GSM48_IE_MA_AFTER] = { TLV_TYPE_TLV },
124 [GSM48_IE_BA_RANGE] = { TLV_TYPE_TLV },
125 [GSM48_IE_GROUP_CHDES] = { TLV_TYPE_TLV },
126 [GSM48_IE_BA_LIST_PREF] = { TLV_TYPE_TLV },
127 [GSM48_IE_MOB_OVSERV_DIF] = { TLV_TYPE_TLV },
128 [GSM48_IE_REALTIME_DIFF] = { TLV_TYPE_TLV },
129 [GSM48_IE_START_TIME] = { TLV_TYPE_FIXED, 2 },
130 [GSM48_IE_TIMING_ADVANCE] = { TLV_TYPE_TV },
131 [GSM48_IE_GROUP_CIP_SEQ] = { TLV_TYPE_SINGLE_TV },
132 [GSM48_IE_CIP_MODE_SET] = { TLV_TYPE_SINGLE_TV },
133 [GSM48_IE_GPRS_RESUMPT] = { TLV_TYPE_SINGLE_TV },
134 [GSM48_IE_SYNC_IND] = { TLV_TYPE_SINGLE_TV },
135 },
136};
137
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200138/*! TLV parser definitions for TS 04.08 MM */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200139const struct tlv_definition gsm48_mm_att_tlvdef = {
140 .def = {
141 [GSM48_IE_MOBILE_ID] = { TLV_TYPE_TLV },
142 [GSM48_IE_NAME_LONG] = { TLV_TYPE_TLV },
143 [GSM48_IE_NAME_SHORT] = { TLV_TYPE_TLV },
144 [GSM48_IE_UTC] = { TLV_TYPE_TV },
145 [GSM48_IE_NET_TIME_TZ] = { TLV_TYPE_FIXED, 7 },
146 [GSM48_IE_LSA_IDENT] = { TLV_TYPE_TLV },
Jacob Erlbeck1c3f0882013-09-16 10:29:57 +0200147 [GSM48_IE_NET_DST] = { TLV_TYPE_TLV },
Andreas Eversberg014cb872010-07-12 09:11:00 +0200148
149 [GSM48_IE_LOCATION_AREA] = { TLV_TYPE_FIXED, 5 },
150 [GSM48_IE_PRIORITY_LEV] = { TLV_TYPE_SINGLE_TV },
151 [GSM48_IE_FOLLOW_ON_PROC] = { TLV_TYPE_T },
152 [GSM48_IE_CTS_PERMISSION] = { TLV_TYPE_T },
153 },
154};
155
Harald Weltee9e190a2010-03-25 11:44:57 +0800156static const struct value_string rr_cause_names[] = {
157 { GSM48_RR_CAUSE_NORMAL, "Normal event" },
158 { GSM48_RR_CAUSE_ABNORMAL_UNSPEC, "Abnormal release, unspecified" },
159 { GSM48_RR_CAUSE_ABNORMAL_UNACCT, "Abnormal release, channel unacceptable" },
160 { GSM48_RR_CAUSE_ABNORMAL_TIMER, "Abnormal release, timer expired" },
161 { GSM48_RR_CAUSE_ABNORMAL_NOACT, "Abnormal release, no activity on radio path" },
162 { GSM48_RR_CAUSE_PREMPTIVE_REL, "Preemptive release" },
163 { GSM48_RR_CAUSE_HNDOVER_IMP, "Handover impossible, timing advance out of range" },
164 { GSM48_RR_CAUSE_CHAN_MODE_UNACCT, "Channel mode unacceptable" },
165 { GSM48_RR_CAUSE_FREQ_NOT_IMPL, "Frequency not implemented" },
166 { GSM48_RR_CAUSE_CALL_CLEARED, "Call already cleared" },
167 { GSM48_RR_CAUSE_SEMANT_INCORR, "Semantically incorrect message" },
168 { GSM48_RR_CAUSE_INVALID_MAND_INF, "Invalid mandatory information" },
169 { GSM48_RR_CAUSE_MSG_TYPE_N, "Message type non-existant or not implemented" },
170 { GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT, "Message type not compatible with protocol state" },
171 { GSM48_RR_CAUSE_COND_IE_ERROR, "Conditional IE error" },
172 { GSM48_RR_CAUSE_NO_CELL_ALLOC_A, "No cell allocation available" },
173 { GSM48_RR_CAUSE_PROT_ERROR_UNSPC, "Protocol error unspecified" },
174 { 0, NULL },
Harald Welte4fb20752010-03-02 23:17:33 +0100175};
176
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200177/*! return string representation of RR Cause value */
Philippada00422016-10-27 13:30:16 +0200178const char *rr_cause_name(uint8_t cause)
179{
180 return get_value_string(rr_cause_names, cause);
181}
182
Harald Welte9eb6d882010-03-25 12:00:54 +0800183/* FIXME: convert to value_string */
Andreas Eversberg014cb872010-07-12 09:11:00 +0200184static const char *cc_state_names[32] = {
Harald Welte4fb20752010-03-02 23:17:33 +0100185 "NULL",
186 "INITIATED",
Andreas Eversberg1ef041f2010-04-09 07:52:12 +0200187 "MM_CONNECTION_PEND",
Harald Welte4fb20752010-03-02 23:17:33 +0100188 "MO_CALL_PROC",
189 "CALL_DELIVERED",
190 "illegal state 5",
191 "CALL_PRESENT",
192 "CALL_RECEIVED",
193 "CONNECT_REQUEST",
194 "MO_TERM_CALL_CONF",
195 "ACTIVE",
196 "DISCONNECT_REQ",
197 "DISCONNECT_IND",
198 "illegal state 13",
199 "illegal state 14",
200 "illegal state 15",
201 "illegal state 16",
202 "illegal state 17",
203 "illegal state 18",
204 "RELEASE_REQ",
205 "illegal state 20",
206 "illegal state 21",
207 "illegal state 22",
208 "illegal state 23",
209 "illegal state 24",
210 "illegal state 25",
211 "MO_ORIG_MODIFY",
212 "MO_TERM_MODIFY",
213 "CONNECT_IND",
214 "illegal state 29",
215 "illegal state 30",
216 "illegal state 31",
217};
218
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200219/*! return string representation of CC State */
Harald Welte9eb6d882010-03-25 12:00:54 +0800220const char *gsm48_cc_state_name(uint8_t state)
221{
222 if (state < ARRAY_SIZE(cc_state_names))
223 return cc_state_names[state];
224
225 return "invalid";
226}
227
228static const struct value_string cc_msg_names[] = {
229 { GSM48_MT_CC_ALERTING, "ALERTING" },
230 { GSM48_MT_CC_CALL_PROC, "CALL_PROC" },
231 { GSM48_MT_CC_PROGRESS, "PROGRESS" },
232 { GSM48_MT_CC_ESTAB, "ESTAB" },
233 { GSM48_MT_CC_SETUP, "SETUP" },
234 { GSM48_MT_CC_ESTAB_CONF, "ESTAB_CONF" },
235 { GSM48_MT_CC_CONNECT, "CONNECT" },
236 { GSM48_MT_CC_CALL_CONF, "CALL_CONF" },
237 { GSM48_MT_CC_START_CC, "START_CC" },
238 { GSM48_MT_CC_RECALL, "RECALL" },
239 { GSM48_MT_CC_EMERG_SETUP, "EMERG_SETUP" },
240 { GSM48_MT_CC_CONNECT_ACK, "CONNECT_ACK" },
241 { GSM48_MT_CC_USER_INFO, "USER_INFO" },
242 { GSM48_MT_CC_MODIFY_REJECT, "MODIFY_REJECT" },
243 { GSM48_MT_CC_MODIFY, "MODIFY" },
244 { GSM48_MT_CC_HOLD, "HOLD" },
245 { GSM48_MT_CC_HOLD_ACK, "HOLD_ACK" },
246 { GSM48_MT_CC_HOLD_REJ, "HOLD_REJ" },
247 { GSM48_MT_CC_RETR, "RETR" },
248 { GSM48_MT_CC_RETR_ACK, "RETR_ACK" },
249 { GSM48_MT_CC_RETR_REJ, "RETR_REJ" },
250 { GSM48_MT_CC_MODIFY_COMPL, "MODIFY_COMPL" },
251 { GSM48_MT_CC_DISCONNECT, "DISCONNECT" },
252 { GSM48_MT_CC_RELEASE_COMPL, "RELEASE_COMPL" },
253 { GSM48_MT_CC_RELEASE, "RELEASE" },
254 { GSM48_MT_CC_STOP_DTMF, "STOP_DTMF" },
255 { GSM48_MT_CC_STOP_DTMF_ACK, "STOP_DTMF_ACK" },
256 { GSM48_MT_CC_STATUS_ENQ, "STATUS_ENQ" },
257 { GSM48_MT_CC_START_DTMF, "START_DTMF" },
258 { GSM48_MT_CC_START_DTMF_ACK, "START_DTMF_ACK" },
259 { GSM48_MT_CC_START_DTMF_REJ, "START_DTMF_REJ" },
260 { GSM48_MT_CC_CONG_CTRL, "CONG_CTRL" },
261 { GSM48_MT_CC_FACILITY, "FACILITY" },
262 { GSM48_MT_CC_STATUS, "STATUS" },
263 { GSM48_MT_CC_NOTIFY, "NOTFIY" },
264 { 0, NULL }
Harald Welte61e2bfc2010-03-04 10:53:03 +0100265};
266
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200267/*! return string representation of CC Message Type */
Harald Welte9eb6d882010-03-25 12:00:54 +0800268const char *gsm48_cc_msg_name(uint8_t msgtype)
269{
270 return get_value_string(cc_msg_names, msgtype);
271}
Harald Welte4fb20752010-03-02 23:17:33 +0100272
Philipp72e43f02016-10-27 13:35:20 +0200273
274static const struct value_string rr_msg_names[] = {
275 /* Channel establishment messages */
276 { GSM48_MT_RR_INIT_REQ, "RR INITIALISATION REQUEST" },
277 { GSM48_MT_RR_ADD_ASS, "ADDITIONAL ASSIGNMENT" },
278 { GSM48_MT_RR_IMM_ASS, "IMMEDIATE ASSIGNMENT" },
279 { GSM48_MT_RR_IMM_ASS_EXT, "MMEDIATE ASSIGNMENT EXTENDED" },
280 { GSM48_MT_RR_IMM_ASS_REJ, "IMMEDIATE ASSIGNMENT REJECT" },
281 { GSM48_MT_RR_DTM_ASS_FAIL, "DTM ASSIGNMENT FAILURE" },
282 { GSM48_MT_RR_DTM_REJECT, "DTM REJECT" },
283 { GSM48_MT_RR_DTM_REQUEST, "DTM REQUEST" },
284 { GSM48_MT_RR_PACKET_ASS, "PACKET ASSIGNMENT" },
285
286 /* Ciphering messages */
287 { GSM48_MT_RR_CIPH_M_CMD, "CIPHERING MODE COMMAND" },
288 { GSM48_MT_RR_CIPH_M_COMPL, "CIPHERING MODE COMPLETE" },
289
290 /* Configuration change messages */
291 { GSM48_MT_RR_CFG_CHG_CMD, "CONFIGURATION CHANGE COMMAND" },
292 { GSM48_MT_RR_CFG_CHG_ACK, "CONFIGURATION CHANGE ACK" },
293 { GSM48_MT_RR_CFG_CHG_REJ, "CONFIGURATION CHANGE REJECT" },
294
295 /* Handover messages */
296 { GSM48_MT_RR_ASS_CMD, "ASSIGNMENT COMMAND" },
297 { GSM48_MT_RR_ASS_COMPL, "ASSIGNMENT COMPLETE" },
298 { GSM48_MT_RR_ASS_FAIL, "ASSIGNMENT FAILURE" },
299 { GSM48_MT_RR_HANDO_CMD, "HANDOVER COMMAND" },
300 { GSM48_MT_RR_HANDO_COMPL, "HANDOVER COMPLETE" },
301 { GSM48_MT_RR_HANDO_FAIL, "HANDOVER FAILURE" },
302 { GSM48_MT_RR_HANDO_INFO, "PHYSICAL INFORMATION" },
303 { GSM48_MT_RR_DTM_ASS_CMD, "DTM ASSIGNMENT COMMAND" },
304
305 { GSM48_MT_RR_CELL_CHG_ORDER, "RR-CELL CHANGE ORDER" },
306 { GSM48_MT_RR_PDCH_ASS_CMD, "PDCH ASSIGNMENT COMMAND" },
307
308 /* Channel release messages */
309 { GSM48_MT_RR_CHAN_REL, "CHANNEL RELEASE" },
310 { GSM48_MT_RR_PART_REL, "PARTIAL RELEASE" },
311 { GSM48_MT_RR_PART_REL_COMP, "PARTIAL RELEASE COMPLETE" },
312
313 /* Paging and Notification messages */
314 { GSM48_MT_RR_PAG_REQ_1, "PAGING REQUEST TYPE 1" },
315 { GSM48_MT_RR_PAG_REQ_2, "PAGING REQUEST TYPE 2" },
316 { GSM48_MT_RR_PAG_REQ_3, "PAGING REQUEST TYPE 3" },
317 { GSM48_MT_RR_PAG_RESP, "PAGING RESPONSE" },
318 { GSM48_MT_RR_NOTIF_NCH, "NOTIFICATION/NCH" },
319 { GSM48_MT_RR_NOTIF_FACCH, "(Reserved)" },
320 { GSM48_MT_RR_NOTIF_RESP, "NOTIFICATION/RESPONSE" },
321 { GSM48_MT_RR_PACKET_NOTIF, "PACKET NOTIFICATION" },
322 /* 3G Specific messages */
323 { GSM48_MT_RR_UTRAN_CLSM_CHG, "UTRAN Classmark Change" },
324 { GSM48_MT_RR_CDMA2K_CLSM_CHG, "cdma 2000 Classmark Change" },
325 { GSM48_MT_RR_IS_TO_UTRAN_HANDO, "Inter System to UTRAN Handover Command" },
326 { GSM48_MT_RR_IS_TO_CDMA2K_HANDO, "Inter System to cdma2000 Handover Command" },
327
328 /* System information messages */
329 { GSM48_MT_RR_SYSINFO_8, "SYSTEM INFORMATION TYPE 8" },
330 { GSM48_MT_RR_SYSINFO_1, "SYSTEM INFORMATION TYPE 1" },
331 { GSM48_MT_RR_SYSINFO_2, "SYSTEM INFORMATION TYPE 2" },
332 { GSM48_MT_RR_SYSINFO_3, "SYSTEM INFORMATION TYPE 3" },
333 { GSM48_MT_RR_SYSINFO_4, "SYSTEM INFORMATION TYPE 4" },
334 { GSM48_MT_RR_SYSINFO_5, "SYSTEM INFORMATION TYPE 5" },
335 { GSM48_MT_RR_SYSINFO_6, "SYSTEM INFORMATION TYPE 6" },
336 { GSM48_MT_RR_SYSINFO_7, "SYSTEM INFORMATION TYPE 7" },
337 { GSM48_MT_RR_SYSINFO_2bis, "SYSTEM INFORMATION TYPE 2bis" },
338 { GSM48_MT_RR_SYSINFO_2ter, "SYSTEM INFORMATION TYPE 2ter" },
339 { GSM48_MT_RR_SYSINFO_2quater, "SYSTEM INFORMATION TYPE 2quater" },
340 { GSM48_MT_RR_SYSINFO_5bis, "SYSTEM INFORMATION TYPE 5bis" },
341 { GSM48_MT_RR_SYSINFO_5ter, "SYSTEM INFORMATION TYPE 5ter" },
342 { GSM48_MT_RR_SYSINFO_9, "SYSTEM INFORMATION TYPE 9" },
343 { GSM48_MT_RR_SYSINFO_13, "SYSTEM INFORMATION TYPE 13" },
344 { GSM48_MT_RR_SYSINFO_16, "SYSTEM INFORMATION TYPE 16" },
345 { GSM48_MT_RR_SYSINFO_17, "SYSTEM INFORMATION TYPE 17" },
346 { GSM48_MT_RR_SYSINFO_18, "SYSTEM INFORMATION TYPE 18" },
347 { GSM48_MT_RR_SYSINFO_19, "SYSTEM INFORMATION TYPE 19" },
348 { GSM48_MT_RR_SYSINFO_20, "SYSTEM INFORMATION TYPE 20" },
349
350 /* Miscellaneous messages */
351 { GSM48_MT_RR_CHAN_MODE_MODIF, "CHANNEL MODE MODIFY" },
352 { GSM48_MT_RR_STATUS, "RR STATUS" },
353 { GSM48_MT_RR_CHAN_MODE_MODIF_ACK, "CHANNEL MODE MODIFY ACKNOWLEDGE" },
354 { GSM48_MT_RR_FREQ_REDEF, "FREQUENCY REDEFINITION" },
355 { GSM48_MT_RR_MEAS_REP, "MEASUREMENT REPORT" },
356 { GSM48_MT_RR_CLSM_CHG, "CLASSMARK CHANGE" },
357 { GSM48_MT_RR_CLSM_ENQ, "CLASSMARK ENQUIRY" },
358 { GSM48_MT_RR_EXT_MEAS_REP, "EXTENDED MEASUREMENT REPORT" },
359 { GSM48_MT_RR_EXT_MEAS_REP_ORD, "EXTENDED MEASUREMENT ORDER" },
360 { GSM48_MT_RR_GPRS_SUSP_REQ, "GPRS SUSPENSION REQUEST" },
361 { GSM48_MT_RR_DTM_INFO, "DTM INFORMATION" },
362
363 /* VGCS uplink control messages */
364 { GSM48_MT_RR_VGCS_UPL_GRANT, "VGCS UPLINK GRANT" },
365 { GSM48_MT_RR_UPLINK_RELEASE, "UPLINK RELEASE" },
366 { GSM48_MT_RR_UPLINK_FREE, "0c" },
367 { GSM48_MT_RR_UPLINK_BUSY, "UPLINK BUSY" },
368 { GSM48_MT_RR_TALKER_IND, "TALKER INDICATION" },
369
370 /* Application messages */
371 { GSM48_MT_RR_APP_INFO, "Application Information" },
372 { 0, NULL }
373};
374
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200375/*! return string representation of RR Message Type */
Philipp72e43f02016-10-27 13:35:20 +0200376const char *gsm48_rr_msg_name(uint8_t msgtype)
377{
378 return get_value_string(rr_msg_names, msgtype);
379}
380
381
Maxfb348ee2016-03-30 21:14:53 +0200382const struct value_string gsm48_chan_mode_names[] = {
383 { GSM48_CMODE_SIGN, "SIGNALLING" },
384 { GSM48_CMODE_SPEECH_V1, "SPEECH_V1" },
385 { GSM48_CMODE_SPEECH_EFR, "SPEECH_EFR" },
386 { GSM48_CMODE_SPEECH_AMR, "SPEECH_AMR" },
387 { GSM48_CMODE_DATA_14k5, "DATA_14k5" },
388 { GSM48_CMODE_DATA_12k0, "DATA_12k0" },
389 { GSM48_CMODE_DATA_6k0, "DATA_6k0" },
390 { GSM48_CMODE_DATA_3k6, "DATA_3k6" },
391 { 0, NULL },
392};
393
394const struct value_string gsm_chan_t_names[] = {
395 { GSM_LCHAN_NONE, "NONE" },
396 { GSM_LCHAN_SDCCH, "SDCCH" },
397 { GSM_LCHAN_TCH_F, "TCH_F" },
398 { GSM_LCHAN_TCH_H, "TCH_H" },
399 { GSM_LCHAN_UNKNOWN, "UNKNOWN" },
400 { GSM_LCHAN_CCCH, "CCCH" },
401 { GSM_LCHAN_PDTCH, "PDTCH" },
402 { GSM_LCHAN_CBCH, "CBCH" },
403 { 0, NULL },
404};
405
Harald Welte1a8c4e02015-08-16 17:56:25 +0200406static const struct value_string mi_type_names[] = {
407 { GSM_MI_TYPE_NONE, "NONE" },
408 { GSM_MI_TYPE_IMSI, "IMSI" },
409 { GSM_MI_TYPE_IMEI, "IMEI" },
410 { GSM_MI_TYPE_IMEISV, "IMEI-SV" },
411 { GSM_MI_TYPE_TMSI, "TMSI" },
412 { 0, NULL }
413};
414
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200415/*! return string representation of Mobile Identity Type */
Harald Welte1a8c4e02015-08-16 17:56:25 +0200416const char *gsm48_mi_type_name(uint8_t mi)
417{
418 return get_value_string(mi_type_names, mi);
419}
420
Harald Welte61e2bfc2010-03-04 10:53:03 +0100421static void to_bcd(uint8_t *bcd, uint16_t val)
422{
423 bcd[2] = val % 10;
424 val = val / 10;
425 bcd[1] = val % 10;
426 val = val / 10;
427 bcd[0] = val % 10;
Harald Welte61e2bfc2010-03-04 10:53:03 +0100428}
Harald Welte4fb20752010-03-02 23:17:33 +0100429
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200430/*! Checks is particular message is cipherable in A/Gb mode according to
Maxfdca25d2016-07-05 16:06:28 +0200431 * 3GPP TS 24.008 § 4.7.1.2
432 * \param[in] hdr Message header
433 * \return true if message can be encrypted, false otherwise
434 */
435bool gsm48_hdr_gmm_cipherable(const struct gsm48_hdr *hdr)
436{
437 switch(hdr->msg_type) {
438 case GSM48_MT_GMM_ATTACH_REQ:
439 case GSM48_MT_GMM_ATTACH_REJ:
440 case GSM48_MT_GMM_AUTH_CIPH_REQ:
441 case GSM48_MT_GMM_AUTH_CIPH_RESP:
442 case GSM48_MT_GMM_AUTH_CIPH_REJ:
443 case GSM48_MT_GMM_AUTH_CIPH_FAIL:
444 case GSM48_MT_GMM_ID_REQ:
445 case GSM48_MT_GMM_ID_RESP:
446 case GSM48_MT_GMM_RA_UPD_REQ:
447 case GSM48_MT_GMM_RA_UPD_REJ:
448 return false;
449 default:
450 return true;
451 }
452}
453
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200454/* Convert MCC + MNC to BCD representation
Harald Welte96e2a002017-06-12 21:44:18 +0200455 * \param[out] bcd_dst caller-allocated memory for output
456 * \param[in] mcc Mobile Country Code
457 * \param[in] mnc Mobile Network Code
458 *
459 * Convert given mcc and mnc to BCD and write to *bcd_dst, which must be an
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100460 * allocated buffer of (at least) 3 bytes length. */
461void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Harald Welte61e2bfc2010-03-04 10:53:03 +0100462{
463 uint8_t bcd[3];
464
465 to_bcd(bcd, mcc);
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100466 bcd_dst[0] = bcd[0] | (bcd[1] << 4);
467 bcd_dst[1] = bcd[2];
Harald Welte61e2bfc2010-03-04 10:53:03 +0100468
469 to_bcd(bcd, mnc);
470 /* FIXME: do we need three-digit MNC? See Table 10.5.3 */
Andreas Eversberged00fe42010-07-12 09:12:46 +0200471 if (mnc > 99) {
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100472 bcd_dst[1] |= bcd[2] << 4;
473 bcd_dst[2] = bcd[0] | (bcd[1] << 4);
Andreas Eversberged00fe42010-07-12 09:12:46 +0200474 } else {
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100475 bcd_dst[1] |= 0xf << 4;
476 bcd_dst[2] = bcd[1] | (bcd[2] << 4);
Andreas Eversberged00fe42010-07-12 09:12:46 +0200477 }
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100478}
Harald Welte61e2bfc2010-03-04 10:53:03 +0100479
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100480/* Convert given 3-byte BCD buffer to integers and write results to *mcc and
481 * *mnc. The first three BCD digits result in the MCC and the remaining ones in
482 * the MNC. */
483void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
484{
485 *mcc = (bcd_src[0] & 0x0f) * 100
486 + (bcd_src[0] >> 4) * 10
487 + (bcd_src[1] & 0x0f);
488
489 if ((bcd_src[1] & 0xf0) == 0xf0) {
490 *mnc = (bcd_src[2] & 0x0f) * 10
491 + (bcd_src[2] >> 4);
492 } else {
493 *mnc = (bcd_src[2] & 0x0f) * 100
494 + (bcd_src[2] >> 4) * 10
495 + (bcd_src[1] >> 4);
496 }
497}
498
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200499/*! Encode TS 04.08 Location Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200500 * \param[out] caller-provided memory for output
501 * \param[in] mcc Mobile Country Code
502 * \param[in] mnc Mobile Network Code
503 * \param[in] lac Location Area Code */
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100504void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
505 uint16_t mnc, uint16_t lac)
506{
507 gsm48_mcc_mnc_to_bcd(&lai48->digits[0], mcc, mnc);
Harald Welte95871da2017-05-15 12:11:36 +0200508 lai48->lac = osmo_htons(lac);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100509}
510
Max3c38e602018-02-15 15:42:32 +0100511/*! Encode TS 24.008 §10.5.1.5 Mobile Station Classmark 1
512 * \param[out] cm caller-provided memory for output
513 * \param[in] rev_lv Revision level
514 * \param[in] es_ind ES IND "Controlled Early Classmark Sending" option
515 * \param[in] a5_1 A5/1 algorithm supported
516 * \param[in] pwr_lv RF power capability
517 */
518void gsm48_encode_classmark1(struct gsm48_classmark1 *cm, uint8_t rev_lv, bool es_ind, bool a5_1, uint8_t rf_pwr)
519{
520 memset(cm, 0, sizeof(*cm));
521 cm->rev_lev = rev_lv;
522 cm->es_ind = es_ind;
523 cm->a5_1 = !a5_1;
524 cm->pwr_lev = rf_pwr;
525}
526
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200527/*! Decode TS 04.08 Location Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200528 * \param[in] Location Area Identifier (encoded)
529 * \param[out] mcc Mobile Country Code
530 * \param[out] mnc Mobile Network Code
531 * \param[out] lac Location Area Code
532 * \returns 0
533 *
534 * Attention: this function returns true integers, not hex! */
Harald Welte774a9de2012-07-13 21:35:13 +0200535int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
536 uint16_t *mnc, uint16_t *lac)
537{
Neels Hofmeyrbdccc1b2016-03-15 13:28:10 +0100538 gsm48_mcc_mnc_from_bcd(&lai->digits[0], mcc, mnc);
Harald Welte95871da2017-05-15 12:11:36 +0200539 *lac = osmo_ntohs(lai->lac);
Harald Welte774a9de2012-07-13 21:35:13 +0200540 return 0;
541}
542
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200543/*! Set DTX mode in Cell Options IE (3GPP TS 44.018)
Maxfe65fa72016-05-10 17:17:05 +0200544 * \param[in] op Cell Options structure in which DTX parameters will be set
545 * \param[in] full Mode for full-rate channels
546 * \param[in] half Mode for half-rate channels
547 * \param[in] is_bcch Indicates if we should use 10.5.2.3.1 instead of
548 * 10.5.2.3a.2
549 *
550 * There is no space for separate DTX settings for Full and Half rate channels
551 * in BCCH - in this case full setting is used for both and half parameter is
552 * ignored.
553 */
554void gsm48_set_dtx(struct gsm48_cell_options *op, enum gsm48_dtx_mode full,
555 enum gsm48_dtx_mode half, bool is_bcch)
556{
557 if (is_bcch) {
558 switch (full) {
559 case GSM48_DTX_MAY_BE_USED:
560 op->dtx = 0;
561 return;
562 case GSM48_DTX_SHALL_BE_USED:
563 op->dtx = 1;
564 return;
565 case GSM48_DTX_SHALL_NOT_BE_USED:
566 op->dtx = 2;
567 return;
568 }
569 } else {
570 switch (full) {
571 case GSM48_DTX_MAY_BE_USED:
572 op->dtx = (half == GSM48_DTX_SHALL_BE_USED) ? 3 : 0;
573 op->d = (half == GSM48_DTX_SHALL_NOT_BE_USED) ? 0 : 1;
574 return;
575 case GSM48_DTX_SHALL_BE_USED:
576 op->dtx = (half == GSM48_DTX_MAY_BE_USED) ? 3 : 1;
577 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
578 return;
579 case GSM48_DTX_SHALL_NOT_BE_USED:
580 op->dtx = 2;
581 op->d = (half == GSM48_DTX_SHALL_BE_USED) ? 1 : 0;
582 return;
583 }
584 }
585}
586
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200587/*! Generate TS 04.08 Mobile ID from TMSI
Harald Welte96e2a002017-06-12 21:44:18 +0200588 * \param[out] buf Caller-provided output buffer (7 bytes)
589 * \param[in] tmsi TMSI to be encoded
590 * \returns number of byes encoded (always 7) */
Harald Welte61e2bfc2010-03-04 10:53:03 +0100591int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
592{
Harald Welte95871da2017-05-15 12:11:36 +0200593 uint32_t tmsi_be = osmo_htonl(tmsi);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100594
595 buf[0] = GSM48_IE_MOBILE_ID;
596 buf[1] = GSM48_TMSI_LEN;
597 buf[2] = 0xf0 | GSM_MI_TYPE_TMSI;
Holger Hans Peter Freythercd252e32013-07-03 09:56:53 +0200598 memcpy(&buf[3], &tmsi_be, sizeof(tmsi_be));
Harald Welte61e2bfc2010-03-04 10:53:03 +0100599
600 return 7;
601}
602
Maxebf14922018-02-15 11:42:11 +0100603/*! Generate TS 24.008 §10.5.1.4 Mobile ID
604 * \param[out] buf Caller-provided output buffer
605 * \param[in] id Identity to be encoded
606 * \returns number of bytes used in \a buf */
607uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
608{
609 uint8_t length = strnlen(id, 255), i, off = 0, odd = (length & 1) == 1;
610
611 buf[0] = GSM48_IE_MOBILE_ID;
612 buf[2] = osmo_char2bcd(id[0]) << 4 | mi_type | (odd << 3);
613
614 /* if the length is even we will fill half of the last octet */
615 buf[1] = (length + (odd ? 1 : 2)) >> 1;
616
617 for (i = 1; i < buf[1]; ++i) {
618 uint8_t upper, lower = osmo_char2bcd(id[++off]);
619 if (!odd && off + 1 == length)
620 upper = 0x0f;
621 else
622 upper = osmo_char2bcd(id[++off]) & 0x0f;
623
624 buf[2 + i] = (upper << 4) | lower;
625 }
626
627 return 2 + buf[1];
628}
629
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200630/*! Generate TS 04.08 Mobile ID from IMSI
Harald Welte96e2a002017-06-12 21:44:18 +0200631 * \param[out] buf Caller-provided output buffer
632 * \param[in] imsi IMSI to be encoded
633 * \returns number of bytes used in \a buf */
Harald Welte61e2bfc2010-03-04 10:53:03 +0100634int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
635{
Maxebf14922018-02-15 11:42:11 +0100636 return gsm48_generate_mid(buf, imsi, GSM_MI_TYPE_IMSI);
Harald Welte61e2bfc2010-03-04 10:53:03 +0100637}
Harald Welte9bb553e2010-03-28 18:14:50 +0800638
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200639/*! Convert TS 04.08 Mobile Identity (10.5.1.4) to string
Harald Welte96e2a002017-06-12 21:44:18 +0200640 * \param[out] string Caller-provided buffer for output
641 * \param[in] str_len Length of \a string in bytes
642 * \param[in] mi Mobile Identity to be stringified
643 * \param[in] mi_len Length of \a mi in bytes
644 * \returns length of string written to \a string */
Harald Welte163d0ea2010-04-09 07:57:40 +0200645int gsm48_mi_to_string(char *string, const int str_len, const uint8_t *mi,
646 const int mi_len)
Harald Welte9bb553e2010-03-28 18:14:50 +0800647{
648 int i;
Harald Welte163d0ea2010-04-09 07:57:40 +0200649 uint8_t mi_type;
Harald Welte9bb553e2010-03-28 18:14:50 +0800650 char *str_cur = string;
Harald Welte163d0ea2010-04-09 07:57:40 +0200651 uint32_t tmsi;
Harald Welte9bb553e2010-03-28 18:14:50 +0800652
653 mi_type = mi[0] & GSM_MI_TYPE_MASK;
654
655 switch (mi_type) {
656 case GSM_MI_TYPE_NONE:
657 break;
658 case GSM_MI_TYPE_TMSI:
Holger Freyther45abec22016-05-20 19:21:27 +0000659 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
Harald Welte9bb553e2010-03-28 18:14:50 +0800660 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
Harald Welte95871da2017-05-15 12:11:36 +0200661 tmsi = osmo_load32be(&mi[1]);
Pau Espin Pedrol45735022017-06-18 14:05:24 +0200662 return snprintf(string, str_len, "%"PRIu32, tmsi);
Harald Welte9bb553e2010-03-28 18:14:50 +0800663 }
664 break;
665 case GSM_MI_TYPE_IMSI:
666 case GSM_MI_TYPE_IMEI:
667 case GSM_MI_TYPE_IMEISV:
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200668 *str_cur++ = osmo_bcd2char(mi[0] >> 4);
Harald Welte9bb553e2010-03-28 18:14:50 +0800669
670 for (i = 1; i < mi_len; i++) {
671 if (str_cur + 2 >= string + str_len)
672 return str_cur - string;
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200673 *str_cur++ = osmo_bcd2char(mi[i] & 0xf);
Harald Welte9bb553e2010-03-28 18:14:50 +0800674 /* skip last nibble in last input byte when GSM_EVEN */
675 if( (i != mi_len-1) || (mi[0] & GSM_MI_ODD))
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +0200676 *str_cur++ = osmo_bcd2char(mi[i] >> 4);
Harald Welte9bb553e2010-03-28 18:14:50 +0800677 }
678 break;
679 default:
680 break;
681 }
682 *str_cur++ = '\0';
683
684 return str_cur - string;
685}
Harald Weltea1c4f762010-05-01 11:59:42 +0200686
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200687/*! Parse TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200688 * \param[out] Caller-provided memory for decoded RA ID
689 * \param[in] buf Input buffer pointing to RAI IE value */
Harald Weltea1c4f762010-05-01 11:59:42 +0200690void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
691{
692 raid->mcc = (buf[0] & 0xf) * 100;
693 raid->mcc += (buf[0] >> 4) * 10;
694 raid->mcc += (buf[1] & 0xf) * 1;
695
696 /* I wonder who came up with the stupidity of encoding the MNC
697 * differently depending on how many digits its decimal number has! */
698 if ((buf[1] >> 4) == 0xf) {
699 raid->mnc = (buf[2] & 0xf) * 10;
700 raid->mnc += (buf[2] >> 4) * 1;
701 } else {
702 raid->mnc = (buf[2] & 0xf) * 100;
703 raid->mnc += (buf[2] >> 4) * 10;
704 raid->mnc += (buf[1] >> 4) * 1;
705 }
706
Harald Welte95871da2017-05-15 12:11:36 +0200707 raid->lac = osmo_load16be(buf + 3);
Harald Weltea1c4f762010-05-01 11:59:42 +0200708 raid->rac = buf[5];
709}
Harald Welte35a93942010-05-01 14:25:22 +0200710
Maxf1ad60e2018-01-05 14:19:33 +0100711/*! Encode a 3GPP TS 24.008 § 10.5.5.15 Routing area identification
712 * \param[out] out Caller-provided packed struct
713 * \param[in] raid Routing Area ID to be encoded
714 */
715void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid)
716{
717 out->lac = osmo_htons(raid->lac);
718 out->rac = raid->rac;
719
720 out->digits[0] = ((raid->mcc / 100) % 10) | (((raid->mcc / 10) % 10) << 4);
721 out->digits[1] = raid->mcc % 10;
722
723 if (raid->mnc < 100) {
724 out->digits[1] |= 0xf0;
725 out->digits[2] = ((raid->mnc / 10) % 10) | ((raid->mnc % 10) << 4);
726 } else {
727 out->digits[1] |= (raid->mnc % 10) << 4;
728 out->digits[2] = ((raid->mnc / 100) % 10) | (((raid->mnc / 10) % 10) << 4);
729 }
730}
731
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200732/*! Encode a TS 04.08 Routing Area Identifier
Harald Welte96e2a002017-06-12 21:44:18 +0200733 * \param[out] buf Caller-provided output buffer of 6 bytes
734 * \param[in] raid Routing Area ID to be encoded
735 * \returns number of bytes used in \a buf */
Harald Welte35a93942010-05-01 14:25:22 +0200736int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
737{
Maxf1ad60e2018-01-05 14:19:33 +0100738 gsm48_encode_ra((struct gsm48_ra_id *)buf, raid);
Harald Welte35a93942010-05-01 14:25:22 +0200739
740 return 6;
741}
Harald Welte2aee7b12011-06-26 14:20:04 +0200742
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200743/*! Determine number of paging sub-channels
Harald Welte96e2a002017-06-12 21:44:18 +0200744 * \param[in] chan_desc Control Channel Description
745 * \returns number of paging sub-channels
746 *
747 * Uses From Table 10.5.33 of GSM 04.08 to determine the number of
748 * paging sub-channels in the given control channel configuration
749 */
Harald Welte2aee7b12011-06-26 14:20:04 +0200750int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
751{
Harald Welte94df39e2011-06-26 14:33:57 +0200752 unsigned int n_pag_blocks = gsm0502_get_n_pag_blocks(chan_desc);
753
754 if (chan_desc->ccch_conf == RSL_BCCH_CCCH_CONF_1_C)
755 return OSMO_MAX(1, n_pag_blocks) * (chan_desc->bs_pa_mfrms + 2);
756 else
757 return n_pag_blocks * (chan_desc->bs_pa_mfrms + 2);
Harald Welte2aee7b12011-06-26 14:20:04 +0200758}
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100759
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200760/*! TS 04.08 Protocol Descriptor names */
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100761const struct value_string gsm48_pdisc_names[] = {
Harald Welteea0bc962018-01-24 16:17:45 +0100762 { GSM48_PDISC_GROUP_CC, "VGCC" },
763 { GSM48_PDISC_BCAST_CC, "VBCC" },
764 { GSM48_PDISC_PDSS1, "PDSS1" },
765 { GSM48_PDISC_CC, "CC" },
766 { GSM48_PDISC_PDSS2, "PDSS2" },
767 { GSM48_PDISC_MM, "MM" },
768 { GSM48_PDISC_RR, "RR" },
769 { GSM48_PDISC_MM_GPRS, "GMM" },
770 { GSM48_PDISC_SMS, "SMS" },
771 { GSM48_PDISC_SM_GPRS, "SM" },
772 { GSM48_PDISC_NC_SS, "NCSS" },
773 { GSM48_PDISC_LOC, "LCS" },
774 { GSM48_PDISC_EXTEND, "EXTD" },
775 { GSM48_PDISC_MASK, "MASK" },
776 { GSM48_PDISC_USSD, "USSD" },
Neels Hofmeyrdbd994c2017-03-09 23:07:02 +0100777 { 0, NULL }
778};
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100779
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200780/*! TS 04.08 RR Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100781const struct value_string gsm48_rr_msgtype_names[] = {
782 OSMO_VALUE_STRING(GSM48_MT_RR_INIT_REQ),
783 OSMO_VALUE_STRING(GSM48_MT_RR_ADD_ASS),
784 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS),
785 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_EXT),
786 OSMO_VALUE_STRING(GSM48_MT_RR_IMM_ASS_REJ),
787 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_FAIL),
788 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REJECT),
789 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_REQUEST),
790 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_ASS),
791
792 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_CMD),
793 OSMO_VALUE_STRING(GSM48_MT_RR_CIPH_M_COMPL),
794
795 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_CMD),
796 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_ACK),
797 OSMO_VALUE_STRING(GSM48_MT_RR_CFG_CHG_REJ),
798
799 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_CMD),
800 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_COMPL),
801 OSMO_VALUE_STRING(GSM48_MT_RR_ASS_FAIL),
802 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_CMD),
803 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_COMPL),
804 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_FAIL),
805 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
806 OSMO_VALUE_STRING(GSM48_MT_RR_HANDO_INFO),
807 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_ASS_CMD),
808
809 OSMO_VALUE_STRING(GSM48_MT_RR_CELL_CHG_ORDER),
810 OSMO_VALUE_STRING(GSM48_MT_RR_PDCH_ASS_CMD),
811
812 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_REL),
813 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL),
814 OSMO_VALUE_STRING(GSM48_MT_RR_PART_REL_COMP),
815
816 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_1),
817 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_2),
818 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_REQ_3),
819 OSMO_VALUE_STRING(GSM48_MT_RR_PAG_RESP),
820 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_NCH),
821 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_FACCH),
822 OSMO_VALUE_STRING(GSM48_MT_RR_NOTIF_RESP),
823 OSMO_VALUE_STRING(GSM48_MT_RR_PACKET_NOTIF),
824 OSMO_VALUE_STRING(GSM48_MT_RR_UTRAN_CLSM_CHG),
825 OSMO_VALUE_STRING(GSM48_MT_RR_CDMA2K_CLSM_CHG),
826 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_UTRAN_HANDO),
827 OSMO_VALUE_STRING(GSM48_MT_RR_IS_TO_CDMA2K_HANDO),
828
829 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_8),
830 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_1),
831 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2),
832 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_3),
833 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_4),
834 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5),
835 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_6),
836 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_7),
837
838 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2bis),
839 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2ter),
840 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_2quater),
841 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5bis),
842 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_5ter),
843 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_9),
844 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_13),
845
846 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_16),
847 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_17),
848
849 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_18),
850 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_19),
851 OSMO_VALUE_STRING(GSM48_MT_RR_SYSINFO_20),
852
853 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF),
854 OSMO_VALUE_STRING(GSM48_MT_RR_STATUS),
855 OSMO_VALUE_STRING(GSM48_MT_RR_CHAN_MODE_MODIF_ACK),
856 OSMO_VALUE_STRING(GSM48_MT_RR_FREQ_REDEF),
857 OSMO_VALUE_STRING(GSM48_MT_RR_MEAS_REP),
858 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_CHG),
859 OSMO_VALUE_STRING(GSM48_MT_RR_CLSM_ENQ),
860 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP),
861 OSMO_VALUE_STRING(GSM48_MT_RR_EXT_MEAS_REP_ORD),
862 OSMO_VALUE_STRING(GSM48_MT_RR_GPRS_SUSP_REQ),
863 OSMO_VALUE_STRING(GSM48_MT_RR_DTM_INFO),
864
865 OSMO_VALUE_STRING(GSM48_MT_RR_VGCS_UPL_GRANT),
866 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_RELEASE),
867 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_FREE),
868 OSMO_VALUE_STRING(GSM48_MT_RR_UPLINK_BUSY),
869 OSMO_VALUE_STRING(GSM48_MT_RR_TALKER_IND),
870 { 0, NULL }
871};
872
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200873/*! TS 04.08 MM Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100874const struct value_string gsm48_mm_msgtype_names[] = {
875 OSMO_VALUE_STRING(GSM48_MT_MM_IMSI_DETACH_IND),
876 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_ACCEPT),
877 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REJECT),
878 OSMO_VALUE_STRING(GSM48_MT_MM_LOC_UPD_REQUEST),
879
880 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REJ),
881 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_REQ),
882 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_RESP),
883 OSMO_VALUE_STRING(GSM48_MT_MM_AUTH_FAIL),
884 OSMO_VALUE_STRING(GSM48_MT_MM_ID_REQ),
885 OSMO_VALUE_STRING(GSM48_MT_MM_ID_RESP),
886 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_CMD),
887 OSMO_VALUE_STRING(GSM48_MT_MM_TMSI_REALL_COMPL),
888
889 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ACC),
890 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REJ),
891 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_ABORT),
892 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_REQ),
893 OSMO_VALUE_STRING(GSM48_MT_MM_CM_SERV_PROMPT),
894 OSMO_VALUE_STRING(GSM48_MT_MM_CM_REEST_REQ),
895 OSMO_VALUE_STRING(GSM48_MT_MM_ABORT),
896
897 OSMO_VALUE_STRING(GSM48_MT_MM_NULL),
898 OSMO_VALUE_STRING(GSM48_MT_MM_STATUS),
899 OSMO_VALUE_STRING(GSM48_MT_MM_INFO),
900 { 0, NULL }
901};
902
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200903/*! TS 04.08 CC Message Type names */
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100904const struct value_string gsm48_cc_msgtype_names[] = {
905 OSMO_VALUE_STRING(GSM48_MT_CC_ALERTING),
906 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_CONF),
907 OSMO_VALUE_STRING(GSM48_MT_CC_CALL_PROC),
908 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT),
909 OSMO_VALUE_STRING(GSM48_MT_CC_CONNECT_ACK),
910 OSMO_VALUE_STRING(GSM48_MT_CC_EMERG_SETUP),
911 OSMO_VALUE_STRING(GSM48_MT_CC_PROGRESS),
912 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB),
913 OSMO_VALUE_STRING(GSM48_MT_CC_ESTAB_CONF),
914 OSMO_VALUE_STRING(GSM48_MT_CC_RECALL),
915 OSMO_VALUE_STRING(GSM48_MT_CC_START_CC),
916 OSMO_VALUE_STRING(GSM48_MT_CC_SETUP),
917
918 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY),
919 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_COMPL),
920 OSMO_VALUE_STRING(GSM48_MT_CC_MODIFY_REJECT),
921 OSMO_VALUE_STRING(GSM48_MT_CC_USER_INFO),
922 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD),
923 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_ACK),
924 OSMO_VALUE_STRING(GSM48_MT_CC_HOLD_REJ),
925 OSMO_VALUE_STRING(GSM48_MT_CC_RETR),
926 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_ACK),
927 OSMO_VALUE_STRING(GSM48_MT_CC_RETR_REJ),
928
929 OSMO_VALUE_STRING(GSM48_MT_CC_DISCONNECT),
930 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE),
931 OSMO_VALUE_STRING(GSM48_MT_CC_RELEASE_COMPL),
932
933 OSMO_VALUE_STRING(GSM48_MT_CC_CONG_CTRL),
934 OSMO_VALUE_STRING(GSM48_MT_CC_NOTIFY),
935 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS),
936 OSMO_VALUE_STRING(GSM48_MT_CC_STATUS_ENQ),
937 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF),
938 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF),
939 OSMO_VALUE_STRING(GSM48_MT_CC_STOP_DTMF_ACK),
940 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_ACK),
941 OSMO_VALUE_STRING(GSM48_MT_CC_START_DTMF_REJ),
942 OSMO_VALUE_STRING(GSM48_MT_CC_FACILITY),
943 { 0, NULL }
944};
945
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200946/*! Compose a string naming the message type for given protocol.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100947 * If the message type string is known, return the message type name, otherwise
948 * return "<protocol discriminator name>:<message type in hex>".
Harald Welte96e2a002017-06-12 21:44:18 +0200949 * \param[in] pdisc protocol discriminator like GSM48_PDISC_MM
950 * \param[in] msg_type message type like GSM48_MT_MM_LOC_UPD_REQUEST
951 * \returns statically allocated string or string constant.
Neels Hofmeyr00ab9ed2017-03-09 23:27:56 +0100952 */
953const char *gsm48_pdisc_msgtype_name(uint8_t pdisc, uint8_t msg_type)
954{
955 static char namebuf[64];
956 const struct value_string *msgt_names;
957
958 switch (pdisc) {
959 case GSM48_PDISC_RR:
960 msgt_names = gsm48_rr_msgtype_names;
961 break;
962 case GSM48_PDISC_MM:
963 msgt_names = gsm48_mm_msgtype_names;
964 break;
965 case GSM48_PDISC_CC:
966 msgt_names = gsm48_cc_msgtype_names;
967 break;
968 default:
969 msgt_names = NULL;
970 break;
971 }
972
973 if (msgt_names)
974 return get_value_string(msgt_names, msg_type);
975
976 snprintf(namebuf, sizeof(namebuf), "%s:0x%02x",
977 gsm48_pdisc_name(pdisc), msg_type);
978 return namebuf;
979}
Harald Welte96e2a002017-06-12 21:44:18 +0200980
981/*! @} */