blob: 5322061714eef91386489041e50f59c61d4332b2 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*
2 * (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02003 * (C) 2009,2010 by On-Waves
4 * All Rights Reserved
5 *
Harald Weltee08da972017-11-13 01:00:26 +09006 * SPDX-License-Identifier: GPL-2.0+
7 *
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02008 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
23
Alexander Chemeris22630e62020-05-13 00:44:04 +030024#include <string.h>
25
Harald Welte95871da2017-05-15 12:11:36 +020026#include <osmocom/core/byteswap.h>
Philipp Maier2908dbf2020-06-05 14:16:11 +020027#include <osmocom/core/endian.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010028#include <osmocom/gsm/gsm0808.h>
Philipp Maierfa896ab2017-03-27 16:55:32 +020029#include <osmocom/gsm/gsm0808_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010030#include <osmocom/gsm/protocol/gsm_08_08.h>
31#include <osmocom/gsm/gsm48.h>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020032
Harald Welte96e2a002017-06-12 21:44:18 +020033/*! \addtogroup gsm0808
34 * @{
Harald Welte37b61652017-10-16 18:46:03 +020035 * \file gsm0808.c
36 * Helper functions regarding the TS 08.08 / 48.008 A interface, primarily
37 * message generation/encoding.
Harald Welte96e2a002017-06-12 21:44:18 +020038 */
39
Alexander Chemeris22630e62020-05-13 00:44:04 +030040/*! Char buffer to return strings from functions */
41static __thread char str_buff[512];
42
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010043/*! Create "Complete L3 Info" for AoIP, legacy implementation.
44 * Instead use gsm0808_create_layer3_aoip2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +020045 * \param[in] msg_l3 msgb containing Layer 3 Message
46 * \param[in] nc Mobile Network Code
47 * \param[in] cc Mobile Country Code
48 * \param[in] lac Location Area Code
49 * \param[in] _ci Cell Identity
50 * \param[in] scl Speech Codec List
51 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +020052struct msgb *gsm0808_create_layer3_aoip(const struct msgb *msg_l3, uint16_t nc,
53 uint16_t cc, int lac, uint16_t _ci,
54 const struct gsm0808_speech_codec_list
55 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020056{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010057 struct osmo_cell_global_id cgi = {
58 .lai = {
59 .plmn = {
60 .mcc = cc,
61 .mnc = nc,
62 },
63 .lac = lac,
64 },
65 .cell_identity = _ci,
66 };
67 return gsm0808_create_layer3_2(msg_l3, &cgi, scl);
68}
69
70/*! Create "Complete L3 Info" for AoIP.
71 * \param[in] msg_l3 msgb containing Layer 3 Message -- not modified by this call.
72 * \param[in] cell MCC, MNC, LAC, CI to identify the cell.
73 * \param[in] scl Speech Codec List, optional.
74 * \returns newly allocated msgb with Complete L3 Info message */
75struct msgb *gsm0808_create_layer3_2(const struct msgb *msg_l3, const struct osmo_cell_global_id *cell,
76 const struct gsm0808_speech_codec_list *scl)
77{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020078 struct msgb* msg;
Harald Welte65c2d362012-01-21 14:26:01 +010079 struct {
80 uint8_t ident;
81 struct gsm48_loc_area_id lai;
82 uint16_t ci;
83 } __attribute__ ((packed)) lai_ci;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020084
85 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
86 "bssmap cmpl l3");
87 if (!msg)
88 return NULL;
89
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020090 /* create layer 3 header */
Harald Welte65c2d362012-01-21 14:26:01 +010091 msgb_v_put(msg, BSS_MAP_MSG_COMPLETE_LAYER_3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020092
93 /* create the cell header */
Harald Welte65c2d362012-01-21 14:26:01 +010094 lai_ci.ident = CELL_IDENT_WHOLE_GLOBAL;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010095 gsm48_generate_lai2(&lai_ci.lai, &cell->lai);
96 lai_ci.ci = osmo_htons(cell->cell_identity);
Harald Welte65c2d362012-01-21 14:26:01 +010097 msgb_tlv_put(msg, GSM0808_IE_CELL_IDENTIFIER, sizeof(lai_ci),
98 (uint8_t *) &lai_ci);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020099
100 /* copy the layer3 data */
Harald Welte65c2d362012-01-21 14:26:01 +0100101 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION,
102 msgb_l3len(msg_l3), msg_l3->l3h);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200103
Philipp Maierfa896ab2017-03-27 16:55:32 +0200104 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
105 if (scl)
106 gsm0808_enc_speech_codec_list(msg, scl);
107
Harald Welte65c2d362012-01-21 14:26:01 +0100108 /* push the bssmap header */
109 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200110
111 return msg;
112}
113
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100114/*! Create "Complete L3 Info" for A, legacy implementation.
115 * Instead use gsm0808_create_layer3_2() with the scl parameter passed as NULL,
116 * which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200117 * \param[in] msg_l3 msgb containing Layer 3 Message
118 * \param[in] nc Mobile Network Code
119 * \param[in] cc Mobile Country Code
120 * \param[in] lac Location Area Code
121 * \param[in] _ci Cell Identity
122 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200123struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
124 uint16_t cc, int lac, uint16_t _ci)
125{
Neels Hofmeyr4eeb8082018-03-23 01:47:14 +0100126 struct osmo_cell_global_id cgi = {
127 .lai = {
128 .plmn = {
129 .mcc = cc,
130 .mnc = nc,
131 },
132 .lac = lac,
133 },
134 .cell_identity = _ci,
135 };
136 return gsm0808_create_layer3_2(msg_l3, &cgi, NULL);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200137}
138
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200139/*! Create BSSMAP RESET message
Harald Welte96e2a002017-06-12 21:44:18 +0200140 * \returns callee-allocated msgb with BSSMAP Reset message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200141struct msgb *gsm0808_create_reset(void)
142{
Harald Welte65c2d362012-01-21 14:26:01 +0100143 uint8_t cause = GSM0808_CAUSE_EQUIPMENT_FAILURE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200144 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
145 "bssmap: reset");
146 if (!msg)
147 return NULL;
148
Harald Welte65c2d362012-01-21 14:26:01 +0100149 msgb_v_put(msg, BSS_MAP_MSG_RESET);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100150 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100151 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
152
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200153 return msg;
154}
155
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200156/*! Create BSSMAP RESET ACK message
Harald Welte96e2a002017-06-12 21:44:18 +0200157 * \returns callee-allocated msgb with BSSMAP Reset ACK message */
Harald Weltea62fe312013-06-19 15:14:37 +0200158struct msgb *gsm0808_create_reset_ack(void)
159{
160 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
161 "bssmap: reset ack");
162 if (!msg)
163 return NULL;
164
165 msgb_v_put(msg, BSS_MAP_MSG_RESET_ACKNOWLEDGE);
166 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
167
168 return msg;
169}
170
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200171/*! Create BSSMAP Clear Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200172 * \returns callee-allocated msgb with BSSMAP Clear Complete message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200173struct msgb *gsm0808_create_clear_complete(void)
174{
175 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
176 "bssmap: clear complete");
Harald Welte65c2d362012-01-21 14:26:01 +0100177 uint8_t val = BSS_MAP_MSG_CLEAR_COMPLETE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200178 if (!msg)
179 return NULL;
180
Harald Welte65c2d362012-01-21 14:26:01 +0100181 msg->l3h = msg->data;
182 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200183
184 return msg;
185}
186
Harald Welted1365e12019-02-18 13:44:30 +0100187/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
188 * This is quite different from most (all?) other gsm0808_create_* which have l3h
189 * point to the BSSAP header. However, we have to keep this for backwards compatibility.
190 * Use gsm0808_create_clear_command2() for a 'modern' implementation.
Philipp Maier1a146c82018-10-30 09:36:49 +0100191 * \param[in] cause TS 08.08 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200192 * \returns callee-allocated msgb with BSSMAP Clear Command message */
Philipp Maier1a146c82018-10-30 09:36:49 +0100193struct msgb *gsm0808_create_clear_command(uint8_t cause)
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200194{
195 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
196 "bssmap: clear command");
197 if (!msg)
198 return NULL;
199
Holger Hans Peter Freytheraeebe392010-10-27 12:36:05 +0200200 msg->l3h = msgb_tv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 4);
201 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100202 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100203
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200204 return msg;
205}
206
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100207/*! Create BSSMAP Clear Command message.
208 * \param[in] cause TS 08.08 cause value.
209 * \param[in] csfb_ind indicate that the call was established in an CSFB context.
210 * \returns callee-allocated msgb with BSSMAP Clear Command message. */
211struct msgb *gsm0808_create_clear_command2(uint8_t cause, bool csfb_ind)
212{
Harald Welte10ba47d2019-02-18 12:36:54 +0100213 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
214 "bssmap: clear command");
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100215 if (!msg)
216 return NULL;
217
Harald Welte10ba47d2019-02-18 12:36:54 +0100218 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
219 gsm0808_enc_cause(msg, cause);
220
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100221 if (csfb_ind)
222 msgb_v_put(msg, GSM0808_IE_CSFB_INDICATION);
223
Harald Welte10ba47d2019-02-18 12:36:54 +0100224 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
225
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100226 return msg;
227}
228
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200229/*! Create BSSMAP Cipher Mode Command message
Harald Welte96e2a002017-06-12 21:44:18 +0200230 * \param[in] ei Mandatory Encryption Information
231 * \param[in] cipher_response_mode optional 1-byte Cipher Response Mode
232 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
Philipp Maierb478dd32017-03-29 15:50:05 +0200233struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,
234 const uint8_t *cipher_response_mode)
235{
236 /* See also: 3GPP TS 48.008 3.2.1.30 CIPHER MODE COMMAND */
237 struct msgb *msg;
238
239 /* Mandatory emelent! */
240 OSMO_ASSERT(ei);
241
242 msg =
243 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
244 "cipher-mode-command");
245 if (!msg)
246 return NULL;
247
248 /* Message Type 3.2.2.1 */
249 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_CMD);
250
251 /* Encryption Information 3.2.2.10 */
252 gsm0808_enc_encrypt_info(msg, ei);
253
254 /* Cipher Response Mode 3.2.2.34 */
255 if (cipher_response_mode)
256 msgb_tv_put(msg, GSM0808_IE_CIPHER_RESPONSE_MODE,
257 *cipher_response_mode);
258
259 /* pre-pend the header */
260 msg->l3h =
261 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
262
263 return msg;
264}
265
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200266/*! Create BSSMAP Cipher Mode Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200267 * \param[in] layer3 L3 Message to be included
268 * \param[in] alg_id Chosen Encrpytion Algorithm
269 * \returns callee-allocated msgb with BSSMAP Cipher Mode Complete message */
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200270struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id)
271{
272 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
273 "cipher-complete");
274 if (!msg)
275 return NULL;
276
277 /* send response with BSS override for A5/1... cheating */
Harald Welte65c2d362012-01-21 14:26:01 +0100278 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_COMPLETE);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200279
280 /* include layer3 in case we have at least two octets */
281 if (layer3 && msgb_l3len(layer3) > 2) {
Harald Welte65c2d362012-01-21 14:26:01 +0100282 msg->l4h = msgb_tlv_put(msg, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS,
283 msgb_l3len(layer3), layer3->l3h);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200284 }
285
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700286 /* Optional Chosen Encryption Algorithm IE */
287 if (alg_id > 0)
288 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, alg_id);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200289
Harald Welte65c2d362012-01-21 14:26:01 +0100290 /* pre-pend the header */
291 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
292
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200293 return msg;
294}
295
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200296/*! Create BSSMAP Cipher Mode Reject message
Maxaa934632018-11-07 13:16:54 +0100297 * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200298 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
Maxaa934632018-11-07 13:16:54 +0100299struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200300{
301 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
Maxaa934632018-11-07 13:16:54 +0100302 "bssmap: cipher mode reject");
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200303 if (!msg)
304 return NULL;
305
Harald Welte62e40852017-12-17 20:50:34 +0100306 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
Maxaa934632018-11-07 13:16:54 +0100307
Philipp Maier4f4905f2018-11-30 13:36:12 +0100308 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100309
310 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200311
312 return msg;
313}
314
Maxed651d22018-11-07 15:25:05 +0100315/*! Create BSSMAP Cipher Mode Reject message
316 * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class
317 * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)
318 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
319struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)
320{
Philipp Maier4f4905f2018-11-30 13:36:12 +0100321 uint16_t cause;
Maxed651d22018-11-07 15:25:05 +0100322 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
323 "bssmap: cipher mode reject");
324 if (!msg)
325 return NULL;
326
Philipp Maier4f4905f2018-11-30 13:36:12 +0100327 /* Set cause code class in the upper byte */
328 cause = 0x80 | (class << 4);
329 cause = cause << 8;
330
331 /* Set cause code extension in the lower byte */
332 cause |= ext;
Maxed651d22018-11-07 15:25:05 +0100333
334 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
335
Philipp Maier4f4905f2018-11-30 13:36:12 +0100336 gsm0808_enc_cause(msg, cause);
Maxed651d22018-11-07 15:25:05 +0100337
338 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
339
340 return msg;
341}
342
Harald Welte64e807c2018-05-29 21:00:56 +0200343/*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).
344 * \param[in] config LCLS Configuration
345 * \param[in] control LCLS Connection Status Control
346 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
Max45f89c92018-12-19 19:35:26 +0100347struct msgb *gsm0808_create_lcls_conn_ctrl(enum gsm0808_lcls_config config,
348 enum gsm0808_lcls_control control)
Harald Welte64e807c2018-05-29 21:00:56 +0200349{
Max45f89c92018-12-19 19:35:26 +0100350 struct msgb *msg;
351
352 /* According to NOTE 1 in §3.2.1.91 at least one of the parameters is required */
353 if (config == GSM0808_LCLS_CFG_NA && control == GSM0808_LCLS_CSC_NA)
354 return NULL;
355
356 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "bssmap: LCLS CONN CTRL");
Harald Welte64e807c2018-05-29 21:00:56 +0200357 if (!msg)
358 return NULL;
359
360 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL);
Max45f89c92018-12-19 19:35:26 +0100361 if (config != GSM0808_LCLS_CFG_NA)
362 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, config);
363 if (control != GSM0808_LCLS_CSC_NA)
364 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, control);
Harald Welte64e807c2018-05-29 21:00:56 +0200365 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
366
367 return msg;
368}
369
370/*! Create BSSMAP LCLS CONNECT CONTROL ACK message (TS 48.008 3.2.1.92).
371 * \param[in] status LCLS BSS Status
372 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
373struct msgb *gsm0808_create_lcls_conn_ctrl_ack(enum gsm0808_lcls_status status)
374{
375 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
376 "bssmap: LCLS CONN CTRL ACK");
377 if (!msg)
378 return NULL;
379
380 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK);
381 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
382 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
383
384 return msg;
385}
386
387/*! Create BSSMAP LCLS NOTIFICATION message (TS 48.008 3.2.1.93).
388 * \param[in] status LCLS BSS Status
389 * \param[in] break_req Include the LCLS BREAK REQ IE (true) or not (false)
390 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
391struct msgb *gsm0808_create_lcls_notification(enum gsm0808_lcls_status status, bool break_req)
392{
393 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
394 "bssmap: LCLS NOTIFICATION");
395 if (!msg)
396 return NULL;
397
398 msgb_v_put(msg, BSS_MAP_MSG_LCLS_NOTIFICATION);
399 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
400 if (break_req)
401 msgb_v_put(msg, GSM0808_IE_LCLS_BREAK_REQ);
402 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
403
404 return msg;
405}
406
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200407/*! Create BSSMAP Classmark Request message
408 * \returns callee-allocated msgb with BSSMAP Classmark Request message */
409struct msgb *gsm0808_create_classmark_request()
410{
411 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
412 "classmark-request");
413 if (!msg)
414 return NULL;
415
416 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_RQST);
417 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
418 return msg;
419}
Harald Welte64e807c2018-05-29 21:00:56 +0200420
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200421/*! Create BSSMAP Classmark Update message
Harald Welte96e2a002017-06-12 21:44:18 +0200422 * \param[in] cm2 Classmark 2
423 * \param[in] cm2_len length (in octets) of \a cm2
424 * \param[in] cm3 Classmark 3
425 * \param[in] cm3_len length (in octets) of \a cm3
426 * \returns callee-allocated msgb with BSSMAP Classmark Update message */
Harald Welte07b625d2012-01-23 10:02:58 +0100427struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,
428 const uint8_t *cm3, uint8_t cm3_len)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200429{
430 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
431 "classmark-update");
432 if (!msg)
433 return NULL;
434
Harald Welte65c2d362012-01-21 14:26:01 +0100435 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_UPDATE);
Harald Welte07b625d2012-01-23 10:02:58 +0100436 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2, cm2_len, cm2);
437 if (cm3)
438 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
439 cm3_len, cm3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200440
Harald Welte65c2d362012-01-21 14:26:01 +0100441 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
442
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200443 return msg;
444}
445
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200446/*! Create BSSMAP SAPI N Reject message
Harald Welte96e2a002017-06-12 21:44:18 +0200447 * \param[in] link_id Link Identifier
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700448 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
Harald Welte96e2a002017-06-12 21:44:18 +0200449 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700450struct msgb *gsm0808_create_sapi_reject_cause(uint8_t link_id, uint16_t cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200451{
452 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
453 "bssmap: sapi 'n' reject");
454 if (!msg)
455 return NULL;
456
Harald Welte65c2d362012-01-21 14:26:01 +0100457 msgb_v_put(msg, BSS_MAP_MSG_SAPI_N_REJECT);
Alexander Chemerisa5b1b862020-05-12 01:03:08 +0300458 msgb_tv_put(msg, GSM0808_IE_DLCI, link_id);
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700459 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100460
461 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200462
463 return msg;
464}
465
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700466/*! Create BSSMAP SAPI N Reject message (with hard-coded cause "BSS not equipped").
467 * DEPRECATED: use gsm0808_create_sapi_reject_cause() instead.
468 * \param[in] link_id Link Identifier
469 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
470 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
471struct msgb *gsm0808_create_sapi_reject(uint8_t link_id)
472{
473 return gsm0808_create_sapi_reject_cause(link_id, GSM0808_CAUSE_BSS_NOT_EQUIPPED);
474}
475
Max52074322018-11-30 10:44:07 +0100476/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
477 * This is identical to gsm0808_create_ass(), but adds KC and LCLS IEs.
Harald Welte96e2a002017-06-12 21:44:18 +0200478 * \param[in] ct Channel Type
479 * \param[in] cic Circuit Identity Code (Classic A only)
480 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
481 * \param[in] scl Speech Codec List (AoIP only)
Max49c06682018-11-21 22:10:26 +0100482 * \param[in] ci Call Identifier (Optional), §3.2.2.105
Max52074322018-11-30 10:44:07 +0100483 * \param[in] kc Kc128 ciphering key (Optional, A5/4), §3.2.2.109
484 * \param[in] lcls Optional LCLS parameters
Harald Welte96e2a002017-06-12 21:44:18 +0200485 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
Max52074322018-11-30 10:44:07 +0100486struct msgb *gsm0808_create_ass2(const struct gsm0808_channel_type *ct,
487 const uint16_t *cic,
488 const struct sockaddr_storage *ss,
489 const struct gsm0808_speech_codec_list *scl,
490 const uint32_t *ci,
491 const uint8_t *kc, const struct osmo_lcls *lcls)
Philipp Maierc6144a22017-03-29 17:53:43 +0200492{
493 /* See also: 3GPP TS 48.008 3.2.1.1 ASSIGNMENT REQUEST */
494 struct msgb *msg;
495 uint16_t cic_sw;
496 uint32_t ci_sw;
497
498 /* Mandatory emelent! */
499 OSMO_ASSERT(ct);
500
501 msg =
502 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
503 "bssmap: ass req");
504 if (!msg)
505 return NULL;
506
507 /* Message Type 3.2.2.1 */
508 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_RQST);
509
510 /* Channel Type 3.2.2.11 */
511 gsm0808_enc_channel_type(msg, ct);
512
513 /* Circuit Identity Code 3.2.2.2 */
514 if (cic) {
Harald Welte95871da2017-05-15 12:11:36 +0200515 cic_sw = osmo_htons(*cic);
Philipp Maierc6144a22017-03-29 17:53:43 +0200516 msgb_tv_fixed_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE,
517 sizeof(cic_sw), (uint8_t *) & cic_sw);
518 }
519
520 /* AoIP: AoIP Transport Layer Address (MGW) 3.2.2.102 */
521 if (ss) {
522 gsm0808_enc_aoip_trasp_addr(msg, ss);
523 }
524
525 /* AoIP: Codec List (MSC Preferred) 3.2.2.103 */
526 if (scl)
527 gsm0808_enc_speech_codec_list(msg, scl);
528
529 /* AoIP: Call Identifier 3.2.2.105 */
530 if (ci) {
Philipp Maier2908dbf2020-06-05 14:16:11 +0200531 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
532 the least significant byte should be transmitted first.
533 On x86, this would mean that the endieness is already
534 correct, however a platform independed implementation
535 is required: */
536#ifndef OSMO_IS_LITTLE_ENDIAN
537 ci_sw = osmo_swab32(*ci);
538#else
539 ci_sw = *ci;
540#endif
Philipp Maierc6144a22017-03-29 17:53:43 +0200541 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, sizeof(ci_sw),
542 (uint8_t *) & ci_sw);
543 }
544
Max52074322018-11-30 10:44:07 +0100545 if (kc)
546 msgb_tv_fixed_put(msg, GSM0808_IE_KC_128, 16, kc);
547
Max47022152018-12-19 18:51:00 +0100548 if (lcls)
549 gsm0808_enc_lcls(msg, lcls);
Max52074322018-11-30 10:44:07 +0100550
Philipp Maierc6144a22017-03-29 17:53:43 +0200551 /* push the bssmap header */
552 msg->l3h =
553 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
554
555 return msg;
556}
557
Max52074322018-11-30 10:44:07 +0100558/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
559 * \param[in] ct Channel Type
560 * \param[in] cic Circuit Identity Code (Classic A only)
561 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
562 * \param[in] scl Speech Codec List (AoIP only)
563 * \param[in] ci Call Identifier (Optional), §3.2.2.105
564 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
565struct msgb *gsm0808_create_ass(const struct gsm0808_channel_type *ct,
566 const uint16_t *cic,
567 const struct sockaddr_storage *ss,
568 const struct gsm0808_speech_codec_list *scl,
569 const uint32_t *ci)
570{
571 return gsm0808_create_ass2(ct, cic, ss, scl, ci, NULL, NULL);
572}
573
Max414c8f52019-01-08 14:44:24 +0100574/*! Create BSSMAP Assignment Completed message as per 3GPP TS 48.008 §3.2.1.2
Harald Welte96e2a002017-06-12 21:44:18 +0200575 * \param[in] rr_cause GSM 04.08 RR Cause value
576 * \param[in] chosen_channel Chosen Channel
577 * \param[in] encr_alg_id Encryption Algorithm ID
578 * \param[in] speech_mode Speech Mode
579 * \param[in] ss Socket Address of BSS-side RTP socket
580 * \param[in] sc Speech Codec (current)
581 * \param[in] scl Speech Codec List (permitted)
Max414c8f52019-01-08 14:44:24 +0100582 * \param[in] lcls_bss_status §3.2.2.119 LCLS-BSS-Status, optional
Harald Welte96e2a002017-06-12 21:44:18 +0200583 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Max414c8f52019-01-08 14:44:24 +0100584struct msgb *gsm0808_create_ass_compl2(uint8_t rr_cause, uint8_t chosen_channel,
Philipp Maierfa896ab2017-03-27 16:55:32 +0200585 uint8_t encr_alg_id, uint8_t speech_mode,
586 const struct sockaddr_storage *ss,
587 const struct gsm0808_speech_codec *sc,
Max414c8f52019-01-08 14:44:24 +0100588 const struct gsm0808_speech_codec_list *scl,
589 enum gsm0808_lcls_status lcls_bss_status)
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200590{
Harald Welte65c2d362012-01-21 14:26:01 +0100591 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
592 "bssmap: ass compl");
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200593 if (!msg)
594 return NULL;
595
Harald Welte65c2d362012-01-21 14:26:01 +0100596 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_COMPLETE);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200597
598 /* write 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100599 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, rr_cause);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200600
601 /* write cirtcuit identity code 3.2.2.2 */
602 /* write cell identifier 3.2.2.17 */
603 /* write chosen channel 3.2.2.33 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100604 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, chosen_channel);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200605
606 /* write chosen encryption algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700607 if (encr_alg_id > 0)
608 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, encr_alg_id);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200609
610 /* write circuit pool 3.2.2.45 */
611 /* write speech version chosen: 3.2.2.51 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100612 if (speech_mode != 0)
613 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, speech_mode);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200614
Philipp Maierfa896ab2017-03-27 16:55:32 +0200615 /* AoIP: AoIP Transport Layer Address (BSS) 3.2.2.102 */
616 if (ss)
617 gsm0808_enc_aoip_trasp_addr(msg, ss);
618
619 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
620 if (sc)
621 gsm0808_enc_speech_codec(msg, sc);
622
623 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
624 if (scl)
625 gsm0808_enc_speech_codec_list(msg, scl);
626
Max414c8f52019-01-08 14:44:24 +0100627 /* FIXME: write LSA identifier 3.2.2.15 - see 3GPP TS 43.073 */
628
629 /* LCLS-BSS-Status 3.2.2.119 */
630 if (lcls_bss_status != GSM0808_LCLS_STS_NA)
631 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, lcls_bss_status);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200632
Harald Welte65c2d362012-01-21 14:26:01 +0100633 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200634
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200635 return msg;
636}
637
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200638/*! Create BSSMAP Assignment Completed message
Harald Welte96e2a002017-06-12 21:44:18 +0200639 * \param[in] rr_cause GSM 04.08 RR Cause value
640 * \param[in] chosen_channel Chosen Channel
641 * \param[in] encr_alg_id Encryption Algorithm ID
642 * \param[in] speech_mode Speech Mode
Max414c8f52019-01-08 14:44:24 +0100643 * \param[in] ss Socket Address of BSS-side RTP socket
644 * \param[in] sc Speech Codec (current)
645 * \param[in] scl Speech Codec List (permitted)
646 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
647struct msgb *gsm0808_create_ass_compl(uint8_t rr_cause, uint8_t chosen_channel,
648 uint8_t encr_alg_id, uint8_t speech_mode,
649 const struct sockaddr_storage *ss,
650 const struct gsm0808_speech_codec *sc,
651 const struct gsm0808_speech_codec_list *scl)
652{
653 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id, speech_mode,
654 ss, sc, scl, GSM0808_LCLS_STS_NA);
655}
656
657/*! Create BSSMAP Assignment Completed message
658 * \param[in] rr_cause GSM 04.08 RR Cause value
659 * \param[in] chosen_channel Chosen Channel
660 * \param[in] encr_alg_id Encryption Algorithm ID
661 * \param[in] speech_mode Speech Mode
Harald Welte96e2a002017-06-12 21:44:18 +0200662 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200663struct msgb *gsm0808_create_assignment_completed(uint8_t rr_cause,
664 uint8_t chosen_channel,
665 uint8_t encr_alg_id,
666 uint8_t speech_mode)
667{
Max414c8f52019-01-08 14:44:24 +0100668 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id,
669 speech_mode, NULL, NULL, NULL, GSM0808_LCLS_STS_NA);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200670}
671
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200672/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200673 * \param[in] cause BSSMAP Cause value
674 * \param[in] rr_cause GSM 04.08 RR Cause value
675 * \param[in] scl Optional Speech Cdec List (AoIP)
676 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200677struct msgb *gsm0808_create_ass_fail(uint8_t cause, const uint8_t *rr_cause,
678 const struct gsm0808_speech_codec_list
679 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200680{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200681 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
682 "bssmap: ass fail");
683 if (!msg)
684 return NULL;
685
Harald Welte65c2d362012-01-21 14:26:01 +0100686 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_FAILURE);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100687 gsm0808_enc_cause(msg, cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200688
689 /* RR cause 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100690 if (rr_cause)
691 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, *rr_cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200692
693 /* Circuit pool 3.22.45 */
694 /* Circuit pool list 3.2.2.46 */
695
Philipp Maierfa896ab2017-03-27 16:55:32 +0200696 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
697 if (scl)
698 gsm0808_enc_speech_codec_list(msg, scl);
699
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200700 /* update the size */
Harald Welte65c2d362012-01-21 14:26:01 +0100701 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
702
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200703 return msg;
704}
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +0200705
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200706/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200707 * \param[in] cause BSSMAP Cause value
708 * \param[in] rr_cause GSM 04.08 RR Cause value
709 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200710struct msgb *gsm0808_create_assignment_failure(uint8_t cause,
711 uint8_t *rr_cause)
712{
713 return gsm0808_create_ass_fail(cause, rr_cause, NULL);
714}
715
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200716/*! Create BSSMAP Clear Request message
Harald Welte96e2a002017-06-12 21:44:18 +0200717 * \param[in] cause BSSMAP Cause value
718 * \returns callee-allocated msgb with BSSMAP Clear Request message */
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100719struct msgb *gsm0808_create_clear_rqst(uint8_t cause)
720{
721 struct msgb *msg;
722
723 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
724 "bssmap: clear rqst");
725 if (!msg)
726 return NULL;
727
Harald Welte65c2d362012-01-21 14:26:01 +0100728 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_RQST);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100729 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100730 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100731
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100732 return msg;
733}
734
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200735/*! Create BSSMAP PAGING message
Harald Welte96e2a002017-06-12 21:44:18 +0200736 * \param[in] imsi Mandatory paged IMSI in string representation
737 * \param[in] tmsi Optional paged TMSI
Stefan Sperling3953f412018-08-28 15:06:30 +0200738 * \param[in] cil Mandatory Cell Identity List (where to page)
Harald Welte96e2a002017-06-12 21:44:18 +0200739 * \param[in] chan_needed Channel Type needed
740 * \returns callee-allocated msgb with BSSMAP PAGING message */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100741struct msgb *gsm0808_create_paging2(const char *imsi, const uint32_t *tmsi,
742 const struct gsm0808_cell_id_list2 *cil,
743 const uint8_t *chan_needed)
Philipp Maier3d48ec02017-03-29 17:37:55 +0200744{
745 struct msgb *msg;
Harald Weltea13fb752020-06-16 08:44:42 +0200746 uint8_t mid_buf[GSM48_MI_SIZE + 2];
747 int mid_len;
Philipp Maier3d48ec02017-03-29 17:37:55 +0200748 uint32_t tmsi_sw;
749
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100750 /* Mandatory elements! */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200751 OSMO_ASSERT(imsi);
752 OSMO_ASSERT(cil);
753
754 /* Malformed IMSI */
755 OSMO_ASSERT(strlen(imsi) <= GSM48_MI_SIZE);
756
757 msg =
758 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "paging");
759 if (!msg)
760 return NULL;
761
762 /* Message Type 3.2.2.1 */
763 msgb_v_put(msg, BSS_MAP_MSG_PAGING);
764
Stefan Sperling3953f412018-08-28 15:06:30 +0200765 /* mandatory IMSI 3.2.2.6 */
Harald Weltea13fb752020-06-16 08:44:42 +0200766 mid_len = gsm48_generate_mid_from_imsi(mid_buf, imsi);
767 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200768
769 /* TMSI 3.2.2.7 */
770 if (tmsi) {
Harald Welte95871da2017-05-15 12:11:36 +0200771 tmsi_sw = osmo_htonl(*tmsi);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200772 msgb_tlv_put(msg, GSM0808_IE_TMSI, sizeof(*tmsi),
773 (uint8_t *) & tmsi_sw);
774 }
775
Stefan Sperling3953f412018-08-28 15:06:30 +0200776 /* mandatory Cell Identifier List 3.2.2.27 */
777 gsm0808_enc_cell_id_list2(msg, cil);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200778
779 /* Channel Needed 3.2.2.36 */
780 if (chan_needed) {
781 msgb_tv_put(msg, GSM0808_IE_CHANNEL_NEEDED,
782 (*chan_needed) & 0x03);
783 }
784
785 /* pre-pend the header */
786 msg->l3h =
787 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
788
789 return msg;
790}
791
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100792/*! DEPRECATED: Use gsm0808_create_paging2 instead.
793 * Create BSSMAP PAGING message.
794 * \param[in] imsi Mandatory paged IMSI in string representation
795 * \param[in] tmsi Optional paged TMSI
796 * \param[in] cil Cell Identity List (where to page)
797 * \param[in] chan_needed Channel Type needed
798 * \returns callee-allocated msgb with BSSMAP PAGING message */
799struct msgb *gsm0808_create_paging(const char *imsi, const uint32_t *tmsi,
800 const struct gsm0808_cell_id_list *cil,
801 const uint8_t *chan_needed)
802{
803 struct gsm0808_cell_id_list2 cil2 = {};
804
805 /* Mandatory emelents! */
806 OSMO_ASSERT(cil);
807
808 if (cil->id_list_len > GSM0808_CELL_ID_LIST2_MAXLEN)
809 return NULL;
810
811 cil2.id_discr = cil->id_discr;
812 memcpy(cil2.id_list, cil->id_list_lac, cil->id_list_len * sizeof(cil2.id_list[0].lac));
813 cil2.id_list_len = cil->id_list_len;
814
815 return gsm0808_create_paging2(imsi, tmsi, &cil2, chan_needed);
816}
817
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100818static uint8_t put_old_bss_to_new_bss_information(struct msgb *msg,
819 const struct gsm0808_old_bss_to_new_bss_info *i)
820{
821 uint8_t *old_tail;
822 uint8_t *tlv_len;
823
824 msgb_put_u8(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION);
825 tlv_len = msgb_put(msg, 1);
826 old_tail = msg->tail;
827
828 if (i->extra_information_present) {
829 uint8_t val = 0;
830 if (i->extra_information.prec)
831 val |= 1 << 0;
832 if (i->extra_information.lcs)
833 val |= 1 << 1;
834 if (i->extra_information.ue_prob)
835 val |= 1 << 2;
836 msgb_tlv_put(msg, GSM0808_FE_IE_EXTRA_INFORMATION, 1, &val);
837 }
838
839 if (i->current_channel_type_2_present) {
840 uint8_t val[2] = {
841 i->current_channel_type_2.mode,
842 i->current_channel_type_2.field,
843 };
844 msgb_tlv_put(msg, GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2, 2, val);
845 }
846
847 *tlv_len = (uint8_t) (msg->tail - old_tail);
848 return *tlv_len + 2;
849}
850
851/*! Create BSSMAP HANDOVER REQUIRED message.
852 * \param[in] params All information to be encoded.
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200853 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED message. */
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100854struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params)
855{
856 struct msgb *msg;
857
858 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED");
859 if (!msg)
860 return NULL;
861
862 /* Message Type, 3.2.2.1 */
863 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED);
864
865 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +0100866 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100867
868 /* Cell Identifier List, 3.2.2.27 */
869 gsm0808_enc_cell_id_list2(msg, &params->cil);
870
871 /* Current Channel Type 1, 3.2.2.49 */
872 if (params->current_channel_type_1_present)
873 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
874
875 /* Speech Version (Used), 3.2.2.51 */
876 if (params->speech_version_used_present)
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200877 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100878
879 if (params->old_bss_to_new_bss_info_present)
880 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
881
882 /* pre-pend the header */
883 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
884
885 return msg;
886}
887
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100888/*! Create BSSMAP HANDOVER REQUIRED REJECT message.
889 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED REJECT message. */
890struct msgb *gsm0808_create_handover_required_reject(const struct gsm0808_handover_required_reject *params)
891{
892 struct msgb *msg;
893
894 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED-REJECT");
895 if (!msg)
896 return NULL;
897
898 /* Message Type, 3.2.2.1 */
899 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT);
900
901 /* Cause, 3.2.2.5 */
902 gsm0808_enc_cause(msg, params->cause);
903
904 /* prepend the header */
905 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
906
907 return msg;
908}
909
910/*! Create BSSMAP HANDOVER REQUEST message, 3GPP TS 48.008 3.2.1.8.
911 * Sent from the MSC to the potential new target cell during inter-BSC handover, or to the target MSC during inter-MSC
912 * handover.
913 */
914struct msgb *gsm0808_create_handover_request(const struct gsm0808_handover_request *params)
915{
916 struct msgb *msg;
917
918 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST");
919 if (!msg)
920 return NULL;
921
922 /* Message Type, 3.2.2.1 */
923 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST);
924
925 /* Channel Type 3.2.2.11 */
926 gsm0808_enc_channel_type(msg, &params->channel_type);
927
928 /* Encryption Information 3.2.2.10 */
929 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
930
931 /* Classmark Information 1 3.2.2.30 or Classmark Information 2 3.2.2.19 (Classmark 2 wins) */
932 if (params->classmark_information.classmark2_len) {
933 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2,
934 params->classmark_information.classmark2_len,
935 (const uint8_t*)&params->classmark_information.classmark2);
936 } else if (params->classmark_information.classmark1_set) {
937 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1,
938 sizeof(params->classmark_information.classmark1),
939 (const uint8_t*)&params->classmark_information.classmark1);
940 }
941 /* (Classmark 3 possibly follows below) */
942
943 /* Cell Identifier (Serving) , 3.2.2.17 */
944 gsm0808_enc_cell_id(msg, &params->cell_identifier_serving);
945
946 /* Cell Identifier (Target) , 3.2.2.17 */
947 gsm0808_enc_cell_id(msg, &params->cell_identifier_target);
948
949 /* Cause, 3.2.2.5 */
950 gsm0808_enc_cause(msg, params->cause);
951
952 /* Classmark Information 3 3.2.2.20 */
953 if (params->classmark_information.classmark3_len) {
954 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
955 params->classmark_information.classmark3_len,
956 (const uint8_t*)&params->classmark_information.classmark3);
957 }
958
959 /* Current Channel type 1 3.2.2.49 */
960 if (params->current_channel_type_1_present)
961 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
962
963 /* Speech Version (Used), 3.2.2.51 */
964 if (params->speech_version_used) {
965 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
966 }
967
968 /* Chosen Encryption Algorithm (Serving) 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700969 if (params->chosen_encryption_algorithm_serving > 0)
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100970 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encryption_algorithm_serving);
971
972 /* Old BSS to New BSS Information 3.2.2.58 */
973 if (params->old_bss_to_new_bss_info_raw && params->old_bss_to_new_bss_info_raw_len) {
974 msgb_tlv_put(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION,
975 params->old_bss_to_new_bss_info_raw_len,
976 params->old_bss_to_new_bss_info_raw);
977 } else if (params->old_bss_to_new_bss_info_present) {
978 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
979 }
980
981 /* IMSI 3.2.2.6 */
982 if (params->imsi) {
Harald Weltea13fb752020-06-16 08:44:42 +0200983 uint8_t mid_buf[GSM48_MI_SIZE + 2];
984 int mid_len = gsm48_generate_mid_from_imsi(mid_buf, params->imsi);
985 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100986 }
987
988 if (params->aoip_transport_layer)
989 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
990
991 if (params->codec_list_msc_preferred)
992 gsm0808_enc_speech_codec_list(msg, params->codec_list_msc_preferred);
993
994 if (params->call_id_present) {
995 uint8_t val[4];
996 osmo_store32le(params->call_id, val);
997 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, 4, val);
998 }
999
1000 if (params->global_call_reference && params->global_call_reference_len) {
1001 msgb_tlv_put(msg, GSM0808_IE_GLOBAL_CALL_REF,
1002 params->global_call_reference_len, params->global_call_reference);
1003 }
1004
1005 /* prepend header with final length */
1006 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1007
1008 return msg;
1009}
1010
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001011/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.
1012 * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.
1013 * l3_info is the RR Handover Command that the MO BSC sends to the MS to move over. */
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001014struct msgb *gsm0808_create_handover_request_ack2(const struct gsm0808_handover_request_ack *params)
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001015{
1016 struct msgb *msg;
1017
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001018 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001019 if (!msg)
1020 return NULL;
1021
1022 /* Message Type, 3.2.2.1 */
1023 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE);
1024
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001025 /* Layer 3 Information, 3.2.2.24 -- it is actually mandatory, but rather compose a nonstandard message than
1026 * segfault or return NULL without a log message. */
1027 if (params->l3_info && params->l3_info_len)
1028 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001029
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001030 if (params->chosen_channel_present)
1031 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001032 if (params->chosen_encr_alg > 0)
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001033 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1034
1035 if (params->chosen_speech_version != 0)
1036 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->chosen_speech_version);
1037
1038 if (params->aoip_transport_layer)
1039 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1040
1041 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1042 if (params->speech_codec_chosen_present)
1043 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001044
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001045 /* prepend header with final length */
1046 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1047
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001048 return msg;
1049}
1050
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001051/*! Same as gsm0808_create_handover_request_ack2() but with less parameters.
1052 * In particular, this lacks the AoIP Transport Layer address. */
1053struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,
1054 uint8_t chosen_channel, uint8_t chosen_encr_alg,
1055 uint8_t chosen_speech_version)
1056{
1057 struct gsm0808_handover_request_ack params = {
1058 .l3_info = l3_info,
1059 .l3_info_len = l3_info_len,
1060 .chosen_channel = chosen_channel,
1061 .chosen_encr_alg = chosen_encr_alg,
1062 .chosen_speech_version = chosen_speech_version,
1063 };
1064
1065 return gsm0808_create_handover_request_ack2(&params);
1066}
1067
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001068/*! Create BSSMAP HANDOVER COMMAND message, 3GPP TS 48.008 3.2.1.11.
1069 * Sent from the MSC to the old BSS to transmit the RR Handover Command received from the new BSS. */
1070struct msgb *gsm0808_create_handover_command(const struct gsm0808_handover_command *params)
1071{
1072 struct msgb *msg;
1073
1074 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMMAND");
1075 if (!msg)
1076 return NULL;
1077
1078 /* Message Type, 3.2.2.1 */
1079 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_CMD);
1080
1081 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
1082
1083 if (params->cell_identifier.id_discr != CELL_IDENT_NO_CELL)
1084 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1085
1086 if (params->new_bss_to_old_bss_info_raw
1087 && params->new_bss_to_old_bss_info_raw_len)
1088 msgb_tlv_put(msg, GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO, params->new_bss_to_old_bss_info_raw_len,
1089 params->new_bss_to_old_bss_info_raw);
1090
1091 /* prepend header with final length */
1092 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1093
1094 return msg;
1095}
1096
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001097/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.
1098 * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has
1099 * received the Handover Detect message. */
1100struct msgb *gsm0808_create_handover_detect()
1101{
1102 struct msgb *msg;
1103
1104 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1105 if (!msg)
1106 return NULL;
1107
1108 /* Message Type, 3.2.2.1 */
1109 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);
1110
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001111 /* prepend header with final length */
1112 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1113
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001114 return msg;
1115}
1116
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001117/*! Create BSSMAP HANDOVER SUCCEEDED message, 3GPP TS 48.008 3.2.1.13.
1118 * Sent from the MSC back to the old BSS to notify that the MS has successfully accessed the new BSS. */
1119struct msgb *gsm0808_create_handover_succeeded()
1120{
1121 struct msgb *msg;
1122
1123 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1124 if (!msg)
1125 return NULL;
1126
1127 /* Message Type, 3.2.2.1 */
1128 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_SUCCEEDED);
1129
1130 /* prepend header with final length */
1131 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1132
1133 return msg;
1134}
1135
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001136/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.
1137 * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */
1138struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)
1139{
1140 struct msgb *msg;
1141
1142 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");
1143 if (!msg)
1144 return NULL;
1145
1146 /* Message Type, 3.2.2.1 */
1147 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);
1148
1149 /* RR Cause, 3.2.2.22 */
1150 if (params->rr_cause_present)
1151 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1152
1153 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1154 if (params->speech_codec_chosen_present)
1155 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1156
1157 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1158 if (params->codec_list_bss_supported.len)
1159 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1160
1161 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001162 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001163 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1164
1165 /* LCLS-BSS-Status 3.2.2.119 */
1166 if (params->lcls_bss_status_present)
1167 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1168
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001169 /* prepend header with final length */
1170 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1171
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001172 return msg;
1173}
1174
1175/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.
1176 * Sent from the MT BSC back to the MSC when the handover has failed. */
1177struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)
1178{
1179 struct msgb *msg;
1180
1181 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");
1182 if (!msg)
1183 return NULL;
1184
1185 /* Message Type, 3.2.2.1 */
1186 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);
1187
1188 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001189 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001190
1191 /* RR Cause, 3.2.2.22 */
1192 if (params->rr_cause_present)
1193 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1194
1195 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1196 if (params->codec_list_bss_supported.len)
1197 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1198
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001199 /* prepend header with final length */
1200 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1201
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001202 return msg;
1203}
1204
Philipp Maier225bdf42018-10-30 14:56:59 +01001205/*! Create BSSMAP HANDOVER PERFORMED message, 3GPP TS 48.008 3.2.1.25.
1206 * \param[in] params All information to be encoded.
1207 * \returns callee-allocated msgb with BSSMAP HANDOVER PERFORMED message */
1208struct msgb *gsm0808_create_handover_performed(const struct gsm0808_handover_performed *params)
1209{
1210 struct msgb *msg;
1211
1212 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-PERFORMED");
1213 if (!msg)
1214 return NULL;
1215
1216 /* Message Type, 3.2.2.1 */
1217 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_PERFORMED);
1218
1219 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001220 gsm0808_enc_cause(msg, params->cause);
Philipp Maier225bdf42018-10-30 14:56:59 +01001221
1222 /* Cell Identifier, 3.2.2.17 */
1223 gsm0808_enc_cell_id(msg, &params->cell_id);
1224
1225 /* Chosen Channel 3.2.2.33 */
1226 if (params->chosen_channel_present)
1227 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1228
1229 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001230 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Philipp Maier225bdf42018-10-30 14:56:59 +01001231 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1232
1233 /* Speech Version (chosen) 3.2.2.51 */
1234 if (params->speech_version_chosen_present)
1235 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_chosen);
1236
1237 /* AoIP: Speech Codec (chosen) 3.2.2.104 */
1238 if (params->speech_codec_chosen_present)
1239 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1240
1241 /* LCLS-BSS-Status 3.2.2.119 */
1242 if (params->lcls_bss_status_present)
1243 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1244
1245 /* prepend header with final length */
1246 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1247
1248 return msg;
1249}
1250
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001251/*! Create BSSMAP COMMON ID message, 3GPP TS 48.008 3.2.1.68.
1252 * \param[in] imsi IMSI digits (decimal string).
1253 * \param[in] selected_plmn_id Selected PLMN ID to encode, or NULL to not encode this IE.
1254 * \param[in] last_used_eutran_plnm_id Last used E-UTRAN PLMN ID to encode, or NULL to not encode this IE.
1255 * \returns callee-allocated msgb with BSSMAP COMMON ID message, or NULL if encoding failed. */
Harald Welte1bd726a2020-06-21 22:04:52 +02001256struct msgb *gsm0808_create_common_id(const char *imsi,
1257 const struct osmo_plmn_id *selected_plmn_id,
1258 const struct osmo_plmn_id *last_used_eutran_plnm_id)
1259{
1260 struct msgb *msg;
Harald Welte1bd726a2020-06-21 22:04:52 +02001261 uint8_t *out;
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001262 struct osmo_mobile_identity mi;
1263 int rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001264
1265 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "COMMON-ID");
1266 if (!msg)
1267 return NULL;
1268
1269 /* Message Type, 3.2.2.1 */
1270 msgb_v_put(msg, BSS_MAP_MSG_COMMON_ID);
1271
1272 /* mandatory IMSI 3.2.2.6 */
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001273 mi = (struct osmo_mobile_identity){ .type = GSM_MI_TYPE_IMSI };
1274 OSMO_STRLCPY_ARRAY(mi.imsi, imsi);
1275 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1276 rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
1277 if (rc < 0) {
1278 msgb_free(msg);
1279 return NULL;
1280 }
1281 /* write the MI value length */
1282 *out = rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001283
1284 /* not implemented: SNA Access Information */
1285
1286 /* Selected PLMN ID */
1287 if (selected_plmn_id) {
1288 msgb_v_put(msg, GSM0808_IE_SELECTED_PLMN_ID);
1289 out = msgb_put(msg, 3);
1290 osmo_plmn_to_bcd(out, selected_plmn_id);
1291 }
1292
1293 /* Last used E-UTRAN PLMN ID */
1294 if (last_used_eutran_plnm_id) {
1295 msgb_v_put(msg, GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID);
1296 out = msgb_put(msg, 3);
1297 osmo_plmn_to_bcd(out, last_used_eutran_plnm_id);
1298 }
1299
1300 /* prepend header with final length */
1301 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1302
1303 return msg;
1304}
1305
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001306/*! Prepend a DTAP header to given Message Buffer
Harald Welte96e2a002017-06-12 21:44:18 +02001307 * \param[in] msgb Message Buffer
1308 * \param[in] link_id Link Identifier */
Holger Hans Peter Freyther9a3dec02010-05-16 08:15:40 +08001309void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id)
1310{
1311 uint8_t *hh = msgb_push(msg, 3);
1312 hh[0] = BSSAP_MSG_DTAP;
1313 hh[1] = link_id;
1314 hh[2] = msg->len - 3;
1315}
1316
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001317/*! Create BSSMAP DTAP message
Harald Welte96e2a002017-06-12 21:44:18 +02001318 * \param[in] msg_l3 Messge Buffer containing Layer3 message
1319 * \param[in] link_id Link Identifier
1320 * \returns callee-allocated msgb with BSSMAP DTAP message */
Holger Hans Peter Freytherc25c6682010-11-04 12:26:06 +01001321struct msgb *gsm0808_create_dtap(struct msgb *msg_l3, uint8_t link_id)
1322{
1323 struct dtap_header *header;
1324 uint8_t *data;
1325 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
1326 "dtap");
1327 if (!msg)
1328 return NULL;
1329
1330 /* DTAP header */
1331 msg->l3h = msgb_put(msg, sizeof(*header));
1332 header = (struct dtap_header *) &msg->l3h[0];
1333 header->type = BSSAP_MSG_DTAP;
1334 header->link_id = link_id;
1335 header->length = msgb_l3len(msg_l3);
1336
1337 /* Payload */
1338 data = msgb_put(msg, header->length);
1339 memcpy(data, msg_l3->l3h, header->length);
1340
1341 return msg;
1342}
1343
Harald Welte92107df2014-06-21 23:16:20 +02001344/* As per 3GPP TS 48.008 version 11.7.0 Release 11 */
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001345static const struct tlv_definition bss_att_tlvdef = {
1346 .def = {
Harald Welte92107df2014-06-21 23:16:20 +02001347 [GSM0808_IE_CIRCUIT_IDENTITY_CODE] = { TLV_TYPE_FIXED, 2 },
1348 [GSM0808_IE_CONNECTION_RELEASE_RQSTED] = { TLV_TYPE_TV },
1349 [GSM0808_IE_RESOURCE_AVAILABLE] = { TLV_TYPE_FIXED, 21 },
1350 [GSM0808_IE_CAUSE] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001351 [GSM0808_IE_IMSI] = { TLV_TYPE_TLV },
1352 [GSM0808_IE_TMSI] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001353 [GSM0808_IE_NUMBER_OF_MSS] = { TLV_TYPE_TV },
Dmitri Soloviev29099422013-07-11 09:25:37 +02001354 [GSM0808_IE_LAYER_3_HEADER_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001355 [GSM0808_IE_ENCRYPTION_INFORMATION] = { TLV_TYPE_TLV },
1356 [GSM0808_IE_CHANNEL_TYPE] = { TLV_TYPE_TLV },
1357 [GSM0808_IE_PERIODICITY] = { TLV_TYPE_TV },
1358 [GSM0808_IE_EXTENDED_RESOURCE_INDICATOR]= { TLV_TYPE_TV },
1359 [GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE] = { TLV_TYPE_FIXED, 4 },
1360 [GSM0808_IE_LSA_IDENTIFIER] = { TLV_TYPE_TLV },
1361 [GSM0808_IE_LSA_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther715e9452014-08-21 14:17:45 +02001362 [GSM0808_IE_LSA_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001363 [GSM0808_IE_CELL_IDENTIFIER] = { TLV_TYPE_TLV },
1364 [GSM0808_IE_PRIORITY] = { TLV_TYPE_TLV },
1365 [GSM0808_IE_CLASSMARK_INFORMATION_T2] = { TLV_TYPE_TLV },
1366 [GSM0808_IE_CLASSMARK_INFORMATION_T3] = { TLV_TYPE_TLV },
1367 [GSM0808_IE_INTERFERENCE_BAND_TO_USE] = { TLV_TYPE_TV },
1368 [GSM0808_IE_RR_CAUSE] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001369 [GSM0808_IE_LAYER_3_INFORMATION] = { TLV_TYPE_TLV },
1370 [GSM0808_IE_DLCI] = { TLV_TYPE_TV },
1371 [GSM0808_IE_DOWNLINK_DTX_FLAG] = { TLV_TYPE_TV },
1372 [GSM0808_IE_CELL_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
1373 [GSM0808_IE_CELL_ID_LIST_SEGMENT] = { TLV_TYPE_TLV },
1374 [GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS] = { TLV_TYPE_TLV },
1375 [GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE] = { TLV_TYPE_TLV },
1376 [GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS] = { TLV_TYPE_TLV },
1377 [GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS] = { TLV_TYPE_TLV },
1378 [GSM0808_IE_RESPONSE_RQST] = { TLV_TYPE_T },
1379 [GSM0808_IE_RESOURCE_INDICATION_METHOD] = { TLV_TYPE_TV },
1380 [GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1] = { TLV_TYPE_TV },
1381 [GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST] = { TLV_TYPE_TLV },
1382 [GSM0808_IE_DIAGNOSTIC] = { TLV_TYPE_TLV },
1383 [GSM0808_IE_CHOSEN_CHANNEL] = { TLV_TYPE_TV },
1384 [GSM0808_IE_CIPHER_RESPONSE_MODE] = { TLV_TYPE_TV },
1385 [GSM0808_IE_LAYER_3_MESSAGE_CONTENTS] = { TLV_TYPE_TLV },
1386 [GSM0808_IE_CHANNEL_NEEDED] = { TLV_TYPE_TV },
1387 [GSM0808_IE_TRACE_TYPE] = { TLV_TYPE_TV },
1388 [GSM0808_IE_TRIGGERID] = { TLV_TYPE_TLV },
1389 [GSM0808_IE_TRACE_REFERENCE] = { TLV_TYPE_TV },
1390 [GSM0808_IE_TRANSACTIONID] = { TLV_TYPE_TLV },
1391 [GSM0808_IE_MOBILE_IDENTITY] = { TLV_TYPE_TLV },
1392 [GSM0808_IE_OMCID] = { TLV_TYPE_TLV },
1393 [GSM0808_IE_FORWARD_INDICATOR] = { TLV_TYPE_TV },
Holger Hans Peter Freytherc2b7f922010-08-04 18:50:43 +08001394 [GSM0808_IE_CHOSEN_ENCR_ALG] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001395 [GSM0808_IE_CIRCUIT_POOL] = { TLV_TYPE_TV },
1396 [GSM0808_IE_CIRCUIT_POOL_LIST] = { TLV_TYPE_TLV },
1397 [GSM0808_IE_TIME_INDICATION] = { TLV_TYPE_TV },
1398 [GSM0808_IE_RESOURCE_SITUATION] = { TLV_TYPE_TLV },
1399 [GSM0808_IE_CURRENT_CHANNEL_TYPE_1] = { TLV_TYPE_TV },
1400 [GSM0808_IE_QUEUEING_INDICATOR] = { TLV_TYPE_TV },
1401 [GSM0808_IE_SPEECH_VERSION] = { TLV_TYPE_TV },
1402 [GSM0808_IE_ASSIGNMENT_REQUIREMENT] = { TLV_TYPE_TV },
1403 [GSM0808_IE_TALKER_FLAG] = { TLV_TYPE_T },
1404 [GSM0808_IE_GROUP_CALL_REFERENCE] = { TLV_TYPE_TLV },
1405 [GSM0808_IE_EMLPP_PRIORITY] = { TLV_TYPE_TV },
1406 [GSM0808_IE_CONFIG_EVO_INDI] = { TLV_TYPE_TV },
1407 [GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION] = { TLV_TYPE_TLV },
1408 [GSM0808_IE_LCS_QOS] = { TLV_TYPE_TLV },
1409 [GSM0808_IE_LSA_ACCESS_CTRL_SUPPR] = { TLV_TYPE_TV },
1410 [GSM0808_IE_LCS_PRIORITY] = { TLV_TYPE_TLV },
1411 [GSM0808_IE_LOCATION_TYPE] = { TLV_TYPE_TLV },
1412 [GSM0808_IE_LOCATION_ESTIMATE] = { TLV_TYPE_TLV },
1413 [GSM0808_IE_POSITIONING_DATA] = { TLV_TYPE_TLV },
1414 [GSM0808_IE_LCS_CAUSE] = { TLV_TYPE_TLV },
1415 [GSM0808_IE_APDU] = { TLV_TYPE_TLV },
1416 [GSM0808_IE_NETWORK_ELEMENT_IDENTITY] = { TLV_TYPE_TLV },
1417 [GSM0808_IE_GPS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1418 [GSM0808_IE_DECIPHERING_KEYS] = { TLV_TYPE_TLV },
1419 [GSM0808_IE_RETURN_ERROR_RQST] = { TLV_TYPE_TLV },
1420 [GSM0808_IE_RETURN_ERROR_CAUSE] = { TLV_TYPE_TLV },
1421 [GSM0808_IE_SEGMENTATION] = { TLV_TYPE_TLV },
1422 [GSM0808_IE_SERVICE_HANDOVER] = { TLV_TYPE_TLV },
1423 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS] = { TLV_TYPE_TLV },
1424 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000] = { TLV_TYPE_TLV },
1425 [GSM0808_IE_GERAN_CLASSMARK] = { TLV_TYPE_TLV },
1426 [GSM0808_IE_GERAN_BSC_CONTAINER] = { TLV_TYPE_TLV },
1427 [GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO] = { TLV_TYPE_TLV },
1428 [GSM0800_IE_INTER_SYSTEM_INFO] = { TLV_TYPE_TLV },
1429 [GSM0808_IE_SNA_ACCESS_INFO] = { TLV_TYPE_TLV },
1430 [GSM0808_IE_VSTK_RAND_INFO] = { TLV_TYPE_TLV },
1431 [GSM0808_IE_PAGING_INFO] = { TLV_TYPE_TV },
1432 [GSM0808_IE_IMEI] = { TLV_TYPE_TLV },
1433 [GSM0808_IE_VELOCITY_ESTIMATE] = { TLV_TYPE_TLV },
1434 [GSM0808_IE_VGCS_FEATURE_FLAGS] = { TLV_TYPE_TLV },
1435 [GSM0808_IE_TALKER_PRIORITY] = { TLV_TYPE_TV },
1436 [GSM0808_IE_EMERGENCY_SET_INDICATION] = { TLV_TYPE_T },
1437 [GSM0808_IE_TALKER_IDENTITY] = { TLV_TYPE_TLV },
1438 [GSM0808_IE_SMS_TO_VGCS] = { TLV_TYPE_TLV },
1439 [GSM0808_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
1440 [GSM0808_IE_VGCS_VBS_CELL_STATUS] = { TLV_TYPE_TLV },
1441 [GSM0808_IE_GANSS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1442 [GSM0808_IE_GANSS_POSITIONING_DATA] = { TLV_TYPE_TLV },
1443 [GSM0808_IE_GANSS_LOCATION_TYPE] = { TLV_TYPE_TLV },
1444 [GSM0808_IE_APP_DATA] = { TLV_TYPE_TLV },
1445 [GSM0808_IE_DATA_IDENTITY] = { TLV_TYPE_TLV },
1446 [GSM0808_IE_APP_DATA_INFO] = { TLV_TYPE_TLV },
1447 [GSM0808_IE_MSISDN] = { TLV_TYPE_TLV },
1448 [GSM0808_IE_AOIP_TRASP_ADDR] = { TLV_TYPE_TLV },
1449 [GSM0808_IE_SPEECH_CODEC_LIST] = { TLV_TYPE_TLV },
1450 [GSM0808_IE_SPEECH_CODEC] = { TLV_TYPE_TLV },
1451 [GSM0808_IE_CALL_ID] = { TLV_TYPE_FIXED, 4 },
1452 [GSM0808_IE_CALL_ID_LIST] = { TLV_TYPE_TLV },
1453 [GSM0808_IE_A_IF_SEL_FOR_RESET] = { TLV_TYPE_TV },
1454 [GSM0808_IE_KC_128] = { TLV_TYPE_FIXED, 16 },
1455 [GSM0808_IE_CSG_IDENTIFIER] = { TLV_TYPE_TLV },
1456 [GSM0808_IE_REDIR_ATTEMPT_FLAG] = { TLV_TYPE_T },
1457 [GSM0808_IE_REROUTE_REJ_CAUSE] = { TLV_TYPE_TV },
1458 [GSM0808_IE_SEND_SEQ_NUM] = { TLV_TYPE_TV },
1459 [GSM0808_IE_REROUTE_COMPL_OUTCOME] = { TLV_TYPE_TV },
1460 [GSM0808_IE_GLOBAL_CALL_REF] = { TLV_TYPE_TLV },
1461 [GSM0808_IE_LCLS_CONFIG] = { TLV_TYPE_TV },
1462 [GSM0808_IE_LCLS_CONN_STATUS_CTRL] = { TLV_TYPE_TV },
1463 [GSM0808_IE_LCLS_CORR_NOT_NEEDED] = { TLV_TYPE_TV },
1464 [GSM0808_IE_LCLS_BSS_STATUS] = { TLV_TYPE_TV },
1465 [GSM0808_IE_LCLS_BREAK_REQ] = { TLV_TYPE_TV },
1466 [GSM0808_IE_CSFB_INDICATION] = { TLV_TYPE_T },
1467 [GSM0808_IE_CS_TO_PS_SRVCC] = { TLV_TYPE_T },
1468 [GSM0808_IE_SRC_ENB_TO_TGT_ENB_TRANSP] = { TLV_TYPE_TLV },
1469 [GSM0808_IE_CS_TO_PS_SRVCC_IND] = { TLV_TYPE_T },
1470 [GSM0808_IE_CN_TO_MS_TRANSP_INFO] = { TLV_TYPE_TLV },
1471 [GSM0808_IE_SELECTED_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
1472 [GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol18506c82019-04-16 15:47:59 +02001473
1474 /* Osmocom extensions */
1475 [GSM0808_IE_OSMO_OSMUX_SUPPORT] = { TLV_TYPE_T },
1476 [GSM0808_IE_OSMO_OSMUX_CID] = { TLV_TYPE_TV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001477 },
1478};
1479
Harald Weltef4d45ab2011-07-16 12:13:00 +02001480const struct tlv_definition *gsm0808_att_tlvdef(void)
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001481{
1482 return &bss_att_tlvdef;
1483}
Harald Welte9b837e62011-07-11 17:43:19 +02001484
Pau Espin Pedrol392f6072019-11-27 12:07:04 +01001485const struct value_string gsm0406_dlci_sapi_names[] = {
1486 { DLCI_SAPI_RR_MM_CC, "RR/MM/CC" },
1487 { DLCI_SAPI_SMS, "SMS" },
1488 { 0, NULL }
1489};
1490
Harald Welte9b837e62011-07-11 17:43:19 +02001491static const struct value_string gsm0808_msgt_names[] = {
1492 { BSS_MAP_MSG_ASSIGMENT_RQST, "ASSIGNMENT REQ" },
1493 { BSS_MAP_MSG_ASSIGMENT_COMPLETE, "ASSIGNMENT COMPL" },
1494 { BSS_MAP_MSG_ASSIGMENT_FAILURE, "ASSIGNMENT FAIL" },
Harald Welte92107df2014-06-21 23:16:20 +02001495 { BSS_MAP_MSG_CHAN_MOD_RQST, "CHANNEL MODIFY REQUEST" },
Harald Welte9b837e62011-07-11 17:43:19 +02001496
1497 { BSS_MAP_MSG_HANDOVER_RQST, "HANDOVER REQ" },
1498 { BSS_MAP_MSG_HANDOVER_REQUIRED, "HANDOVER REQUIRED" },
1499 { BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE,"HANDOVER REQ ACK" },
1500 { BSS_MAP_MSG_HANDOVER_CMD, "HANDOVER CMD" },
1501 { BSS_MAP_MSG_HANDOVER_COMPLETE, "HANDOVER COMPLETE" },
1502 { BSS_MAP_MSG_HANDOVER_SUCCEEDED, "HANDOVER SUCCESS" },
1503 { BSS_MAP_MSG_HANDOVER_FAILURE, "HANDOVER FAILURE" },
1504 { BSS_MAP_MSG_HANDOVER_PERFORMED, "HANDOVER PERFORMED" },
1505 { BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE, "HANDOVER CAND ENQ" },
1506 { BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE, "HANDOVER CAND RESP" },
1507 { BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT, "HANDOVER REQ REJ" },
1508 { BSS_MAP_MSG_HANDOVER_DETECT, "HANDOVER DETECT" },
Harald Welte92107df2014-06-21 23:16:20 +02001509 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED, "INT HANDOVER REQ" },
1510 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED_REJ,"INT HANDOVER REQ REJ" },
1511 { BSS_MAP_MSG_INT_HANDOVER_CMD, "INT HANDOVER CMD" },
1512 { BSS_MAP_MSG_INT_HANDOVER_ENQUIRY, "INT HANDOVER ENQ" },
Harald Welte9b837e62011-07-11 17:43:19 +02001513
1514 { BSS_MAP_MSG_CLEAR_CMD, "CLEAR COMMAND" },
1515 { BSS_MAP_MSG_CLEAR_COMPLETE, "CLEAR COMPLETE" },
1516 { BSS_MAP_MSG_CLEAR_RQST, "CLEAR REQUEST" },
1517 { BSS_MAP_MSG_SAPI_N_REJECT, "SAPI N REJECT" },
1518 { BSS_MAP_MSG_CONFUSION, "CONFUSION" },
1519
1520 { BSS_MAP_MSG_SUSPEND, "SUSPEND" },
1521 { BSS_MAP_MSG_RESUME, "RESUME" },
1522 { BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION, "CONN ORIENT INFO" },
1523 { BSS_MAP_MSG_PERFORM_LOCATION_RQST, "PERFORM LOC REQ" },
1524 { BSS_MAP_MSG_LSA_INFORMATION, "LSA INFORMATION" },
1525 { BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE, "PERFORM LOC RESP" },
1526 { BSS_MAP_MSG_PERFORM_LOCATION_ABORT, "PERFORM LOC ABORT" },
1527 { BSS_MAP_MSG_COMMON_ID, "COMMON ID" },
Harald Welte92107df2014-06-21 23:16:20 +02001528 { BSS_MAP_MSG_REROUTE_CMD, "REROUTE COMMAND" },
1529 { BSS_MAP_MSG_REROUTE_COMPLETE, "REROUTE COMPLETE" },
Harald Welte9b837e62011-07-11 17:43:19 +02001530
1531 { BSS_MAP_MSG_RESET, "RESET" },
1532 { BSS_MAP_MSG_RESET_ACKNOWLEDGE, "RESET ACK" },
1533 { BSS_MAP_MSG_OVERLOAD, "OVERLOAD" },
1534 { BSS_MAP_MSG_RESET_CIRCUIT, "RESET CIRCUIT" },
1535 { BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE, "RESET CIRCUIT ACK" },
1536 { BSS_MAP_MSG_MSC_INVOKE_TRACE, "MSC INVOKE TRACE" },
1537 { BSS_MAP_MSG_BSS_INVOKE_TRACE, "BSS INVOKE TRACE" },
1538 { BSS_MAP_MSG_CONNECTIONLESS_INFORMATION, "CONNLESS INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02001539 { BSS_MAP_MSG_RESET_IP_RSRC, "RESET IP RESOURCE" },
1540 { BSS_MAP_MSG_RESET_IP_RSRC_ACK, "RESET IP RESOURCE ACK" },
Harald Welte9b837e62011-07-11 17:43:19 +02001541
1542 { BSS_MAP_MSG_BLOCK, "BLOCK" },
1543 { BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE, "BLOCK ACK" },
1544 { BSS_MAP_MSG_UNBLOCK, "UNBLOCK" },
1545 { BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE, "UNBLOCK ACK" },
1546 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK, "CIRC GROUP BLOCK" },
1547 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE, "CIRC GORUP BLOCK ACK" },
1548 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK, "CIRC GROUP UNBLOCK" },
1549 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE, "CIRC GROUP UNBLOCK ACK" },
1550 { BSS_MAP_MSG_UNEQUIPPED_CIRCUIT, "UNEQUIPPED CIRCUIT" },
1551 { BSS_MAP_MSG_CHANGE_CIRCUIT, "CHANGE CIRCUIT" },
1552 { BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE, "CHANGE CIRCUIT ACK" },
1553
1554 { BSS_MAP_MSG_RESOURCE_RQST, "RESOURCE REQ" },
1555 { BSS_MAP_MSG_RESOURCE_INDICATION, "RESOURCE IND" },
1556 { BSS_MAP_MSG_PAGING, "PAGING" },
1557 { BSS_MAP_MSG_CIPHER_MODE_CMD, "CIPHER MODE CMD" },
1558 { BSS_MAP_MSG_CLASSMARK_UPDATE, "CLASSMARK UPDATE" },
1559 { BSS_MAP_MSG_CIPHER_MODE_COMPLETE, "CIPHER MODE COMPLETE" },
1560 { BSS_MAP_MSG_QUEUING_INDICATION, "QUEUING INDICATION" },
1561 { BSS_MAP_MSG_COMPLETE_LAYER_3, "COMPLETE LAYER 3" },
1562 { BSS_MAP_MSG_CLASSMARK_RQST, "CLASSMARK REQ" },
1563 { BSS_MAP_MSG_CIPHER_MODE_REJECT, "CIPHER MODE REJECT" },
1564 { BSS_MAP_MSG_LOAD_INDICATION, "LOAD IND" },
1565
Harald Welte92107df2014-06-21 23:16:20 +02001566 { BSS_MAP_MSG_VGCS_VBS_SETUP, "VGCS/VBS SETUP" },
1567 { BSS_MAP_MSG_VGCS_VBS_SETUP_ACK, "VGCS/VBS SETUP ACK" },
1568 { BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE, "VGCS/VBS SETUP REFUSE" },
1569 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST, "VGCS/VBS ASSIGN REQ" },
1570 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT, "VGCS/VBS ASSIGN RES" },
1571 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE, "VGCS/VBS ASSIGN FAIL" },
1572 { BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION, "VGCS/VBS QUEUING IND" },
1573 { BSS_MAP_MSG_UPLINK_RQST, "UPLINK REQ" },
1574 { BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE, "UPLINK REQ ACK" },
1575 { BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION, "UPLINK REQ CONF" },
1576 { BSS_MAP_MSG_UPLINK_RELEASE_INDICATION,"UPLINK REL IND" },
1577 { BSS_MAP_MSG_UPLINK_REJECT_CMD, "UPLINK REJ CMD" },
1578 { BSS_MAP_MSG_UPLINK_RELEASE_CMD, "UPLINK REL CMD" },
1579 { BSS_MAP_MSG_UPLINK_SEIZED_CMD, "UPLINK SEIZED CMD" },
1580 { BSS_MAP_MSG_VGCS_ADDL_INFO, "VGCS ADDL INFO" },
1581 { BSS_MAP_MSG_NOTIFICATION_DATA, "NOTIF DATA" },
1582 { BSS_MAP_MSG_UPLINK_APP_DATA, "UPLINK APP DATA" },
1583
1584 { BSS_MAP_MSG_LCLS_CONNECT_CTRL, "LCLS-CONNECT-CONTROL" },
1585 { BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK, "CLS-CONNECT-CONTROL-ACK" },
1586 { BSS_MAP_MSG_LCLS_NOTIFICATION, "LCLS-NOTIFICATION" },
Harald Welte9b837e62011-07-11 17:43:19 +02001587
1588 { 0, NULL }
1589};
1590
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001591/*! Return string name of BSSMAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001592const char *gsm0808_bssmap_name(uint8_t msg_type)
1593{
1594 return get_value_string(gsm0808_msgt_names, msg_type);
1595}
1596
1597static const struct value_string gsm0808_bssap_names[] = {
1598 { BSSAP_MSG_BSS_MANAGEMENT, "MANAGEMENT" },
1599 { BSSAP_MSG_DTAP, "DTAP" },
Neels Hofmeyr90fdb082017-03-01 14:59:44 +01001600 { 0, NULL }
Harald Welte9b837e62011-07-11 17:43:19 +02001601};
1602
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001603/*! Return string name of BSSAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001604const char *gsm0808_bssap_name(uint8_t msg_type)
1605{
1606 return get_value_string(gsm0808_bssap_names, msg_type);
1607}
Harald Welte96e2a002017-06-12 21:44:18 +02001608
Neels Hofmeyrffad5742018-01-12 05:34:03 +01001609const struct value_string gsm0808_speech_codec_type_names[] = {
1610 { GSM0808_SCT_FR1, "FR1" },
1611 { GSM0808_SCT_FR2, "FR2" },
1612 { GSM0808_SCT_FR3, "FR3" },
1613 { GSM0808_SCT_FR4, "FR4" },
1614 { GSM0808_SCT_FR5, "FR5" },
1615 { GSM0808_SCT_HR1, "HR1" },
1616 { GSM0808_SCT_HR3, "HR3" },
1617 { GSM0808_SCT_HR4, "HR4" },
1618 { GSM0808_SCT_HR6, "HR6" },
1619 { GSM0808_SCT_CSD, "CSD" },
1620 { 0, NULL }
1621};
1622
Philipp Maiercdd05812018-07-12 18:21:07 +02001623const struct value_string gsm0808_permitted_speech_names[] = {
1624 { GSM0808_PERM_FR1, "FR1" },
1625 { GSM0808_PERM_FR2, "FR2" },
1626 { GSM0808_PERM_FR3, "FR3" },
1627 { GSM0808_PERM_FR4, "FR4" },
1628 { GSM0808_PERM_FR5, "FR5" },
1629 { GSM0808_PERM_HR1, "HR1" },
1630 { GSM0808_PERM_HR2, "HR2" },
1631 { GSM0808_PERM_HR3, "HR3" },
1632 { GSM0808_PERM_HR4, "HR4" },
1633 { GSM0808_PERM_HR6, "HR6" },
1634 { 0, NULL }
1635};
1636
Pau Espin Pedrolf2cda622018-07-06 17:16:41 +02001637const struct value_string gsm0808_chosen_enc_alg_names[] = {
1638 { GSM0808_ALG_ID_A5_0, "A5/0" },
1639 { GSM0808_ALG_ID_A5_1, "A5/1" },
1640 { GSM0808_ALG_ID_A5_2, "A5/2" },
1641 { GSM0808_ALG_ID_A5_3, "A5/3" },
1642 { GSM0808_ALG_ID_A5_4, "A5/4" },
1643 { GSM0808_ALG_ID_A5_5, "A5/5" },
1644 { GSM0808_ALG_ID_A5_6, "A5/6" },
1645 { GSM0808_ALG_ID_A5_7, "A5/7" },
1646 { 0, NULL }
1647};
1648
Philipp Maierdbb76592018-03-29 12:55:26 +02001649static const struct value_string gsm0808_cause_names[] = {
1650 { GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE, "RADIO INTERFACE MESSAGE FAILURE" },
1651 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, "RADIO INTERFACE FAILURE" },
1652 { GSM0808_CAUSE_UPLINK_QUALITY, "UPLINK QUALITY" },
1653 { GSM0808_CAUSE_UPLINK_STRENGTH, "UPLINK STRENGTH" },
1654 { GSM0808_CAUSE_DOWNLINK_QUALITY, "DOWNLINK QUALITY" },
1655 { GSM0808_CAUSE_DOWNLINK_STRENGTH, "DOWNLINK STRENGTH" },
1656 { GSM0808_CAUSE_DISTANCE, "DISTANCE" },
1657 { GSM0808_CAUSE_O_AND_M_INTERVENTION, "O AND M INTERVENTION" },
1658 { GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION, "RESPONSE TO MSC INVOCATION" },
1659 { GSM0808_CAUSE_CALL_CONTROL, "CALL CONTROL" },
1660 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION, "RADIO INTERFACE FAILURE REVERSION" },
1661 { GSM0808_CAUSE_HANDOVER_SUCCESSFUL, "HANDOVER SUCCESSFUL" },
1662 { GSM0808_CAUSE_BETTER_CELL, "BETTER CELL" },
1663 { GSM0808_CAUSE_DIRECTED_RETRY, "DIRECTED RETRY" },
1664 { GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL, "JOINED GROUP CALL CHANNEL" },
1665 { GSM0808_CAUSE_TRAFFIC, "TRAFFIC" },
1666 { GSM0808_CAUSE_REDUCE_LOAD_IN_SERVING_CELL, "REDUCE LOAD IN SERVING CELL" },
1667 { GSM0808_CAUSE_TRAFFIC_LOAD_IN_TGT_HIGHER_THAN_IN_SRC_CELL, "TRAFFIC LOAD IN TGT HIGHER THAN IN SRC CELL" },
1668 { GSM0808_CAUSE_RELOCATION_TRIGGERED, "RELOCATION TRIGGERED" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001669 { GSM0808_CAUSE_REQUESTED_OPT_NOT_AUTHORISED, "REQUESTED OPT NOT AUTHORISED" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001670 { GSM0808_CAUSE_ALT_CHAN_CONFIG_REQUESTED, "ALT CHAN CONFIG REQUESTED" },
1671 { GSM0808_CAUSE_RESP_TO_INT_HO_ENQ_MSG, "RESP TO INT HO ENQ MSG" },
1672 { GSM0808_CAUSE_INT_HO_ENQUIRY_REJECT, "INT HO ENQUIRY REJECT" },
1673 { GSM0808_CAUSE_REDUNDANCY_LEVEL_NOT_ADEQUATE, "REDUNDANCY LEVEL NOT ADEQUATE" },
1674 { GSM0808_CAUSE_EQUIPMENT_FAILURE, "EQUIPMENT FAILURE" },
1675 { GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE, "NO RADIO RESOURCE AVAILABLE" },
1676 { GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, "RQSTED TERRESTRIAL RESOURCE UNAVAILABLE" },
1677 { GSM0808_CAUSE_CCCH_OVERLOAD, "CCCH OVERLOAD" },
1678 { GSM0808_CAUSE_PROCESSOR_OVERLOAD, "PROCESSOR OVERLOAD" },
1679 { GSM0808_CAUSE_BSS_NOT_EQUIPPED, "BSS NOT EQUIPPED" },
1680 { GSM0808_CAUSE_MS_NOT_EQUIPPED, "MS NOT EQUIPPED" },
1681 { GSM0808_CAUSE_INVALID_CELL, "INVALID CELL" },
1682 { GSM0808_CAUSE_TRAFFIC_LOAD, "TRAFFIC LOAD" },
1683 { GSM0808_CAUSE_PREEMPTION, "PREEMPTION" },
1684 { GSM0808_CAUSE_DTM_HO_SGSN_FAILURE, "DTM HO SGSN FAILURE" },
1685 { GSM0808_CAUSE_DTM_HO_PS_ALLOC_FAILURE, "DTM HO PS ALLOC FAILURE" },
1686 { GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE, "RQSTED TRANSCODING RATE ADAPTION UNAVAILABLE" },
1687 { GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH, "CIRCUIT POOL MISMATCH" },
1688 { GSM0808_CAUSE_SWITCH_CIRCUIT_POOL, "SWITCH CIRCUIT POOL" },
1689 { GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, "RQSTED SPEECH VERSION UNAVAILABLE" },
1690 { GSM0808_CAUSE_LSA_NOT_ALLOWED, "LSA NOT ALLOWED" },
1691 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_UNAVAIL, "REQ CODEC TYPE OR CONFIG UNAVAIL" },
1692 { GSM0808_CAUSE_REQ_A_IF_TYPE_UNAVAIL, "REQ A IF TYPE UNAVAIL" },
1693 { GSM0808_CAUSE_INVALID_CSG_CELL, "INVALID CSG CELL" },
1694 { GSM0808_CAUSE_REQ_REDUND_LEVEL_NOT_AVAIL, "REQ REDUND LEVEL NOT AVAIL" },
1695 { GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED, "CIPHERING ALGORITHM NOT SUPPORTED" },
1696 { GSM0808_CAUSE_GERAN_IU_MODE_FAILURE, "GERAN IU MODE FAILURE" },
1697 { GSM0808_CAUSE_INC_RELOC_NOT_SUPP_DT_PUESBINE_FEATURE, "INC RELOC NOT SUPP DT PUESBINE FEATURE" },
1698 { GSM0808_CAUSE_ACCESS_RESTRICTED_DUE_TO_SHARED_NETWORKS, "ACCESS RESTRICTED DUE TO SHARED NETWORKS" },
1699 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, "REQ CODEC TYPE OR CONFIG NOT SUPP" },
1700 { GSM0808_CAUSE_REQ_A_IF_TYPE_NOT_SUPP, "REQ A IF TYPE NOT SUPP" },
1701 { GSM0808_CAUSE_REQ_REDUND_LVL_NOT_SUPP, "REQ REDUND LVL NOT SUPP" },
1702 { GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED, "TERRESTRIAL CIRCUIT ALREADY ALLOCATED" },
1703 { GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS, "INVALID MESSAGE CONTENTS" },
1704 { GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING, "INFORMATION ELEMENT OR FIELD MISSING" },
1705 { GSM0808_CAUSE_INCORRECT_VALUE, "INCORRECT VALUE" },
1706 { GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE, "UNKNOWN MESSAGE TYPE" },
1707 { GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT, "UNKNOWN INFORMATION ELEMENT" },
1708 { GSM0808_CAUSE_DTM_HO_INVALID_PS_IND, "DTM HO INVALID PS IND" },
1709 { GSM0808_CAUSE_CALL_ID_ALREADY_ALLOC, "CALL ID ALREADY ALLOC" },
1710 { GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC, "PROTOCOL ERROR BETWEEN BSS AND MSC" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001711 { GSM0808_CAUSE_VGCS_VBS_CALL_NON_EXISTENT, "VGCS VBS CALL NON EXISTENT" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001712 { GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY, "DTM HO TIMER EXPIRY" },
1713 { 0, NULL }
1714};
1715
Maxaa934632018-11-07 13:16:54 +01001716static const struct value_string gsm0808_cause_class_names[] = {
1717 { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },
1718 { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },
1719 { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },
1720 { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },
1721 { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },
1722 { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },
1723 { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },
1724 { GSM0808_CAUSE_CLASS_INTW, "Interworking" },
1725 { 0, NULL }
1726};
1727
1728/*! Return string name of BSSMAP Cause Class name */
1729const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)
1730{
1731 return get_value_string(gsm0808_cause_class_names, class);
1732}
1733
Philipp Maierdbb76592018-03-29 12:55:26 +02001734/*! Return string name of BSSMAP Cause name */
Maxaa934632018-11-07 13:16:54 +01001735const char *gsm0808_cause_name(enum gsm0808_cause cause)
Philipp Maierdbb76592018-03-29 12:55:26 +02001736{
1737 return get_value_string(gsm0808_cause_names, cause);
1738}
1739
Alexander Chemerisfdfe25b2020-05-12 23:21:56 +03001740enum gsm0808_cause gsm0808_get_cause(const struct tlv_parsed *tp)
1741{
1742 const uint8_t *buf = TLVP_VAL_MINLEN(tp, GSM0808_IE_CAUSE, 1);
1743
1744 if (!buf)
1745 return -EBADMSG;
1746
1747 if (TLVP_LEN(tp, GSM0808_IE_CAUSE) > 1) {
1748 if (!gsm0808_cause_ext(buf[0]))
1749 return -EINVAL;
1750 return buf[1];
1751 }
1752
1753 return buf[0];
1754}
1755
Alexander Chemeris22630e62020-05-13 00:44:04 +03001756const char *gsm0808_diagnostics_octet_location_str(uint8_t pointer)
1757{
1758 switch (pointer) {
1759 case 0:
1760 return "Error location not determined";
1761 case 1:
1762 return "The first octet of the message received (i.e. the message type) was found erroneous (unknown)";
1763 case 0xfd:
1764 return "The first octet of the BSSAP header (Discrimination) was found erroneous";
1765 case 0xfe:
1766 return "(DTAP only) The DLCI (second) octet of the BSSAP header was found erroneous";
1767 case 0xff:
1768 return "The last octet of the BSSAP header (length indicator) was found erroneous";
1769 default:
1770 snprintf(str_buff, sizeof(str_buff), "The %d octet of the message received was found erroneous", pointer);
1771 return str_buff;
1772 }
1773}
1774
1775const char *gsm0808_diagnostics_bit_location_str(uint8_t bit_pointer)
1776{
1777 if (bit_pointer == 0) {
1778 return "No particular part of the octet is indicated";
1779 } else if (bit_pointer > 8) {
1780 return "Reserved value";
1781 }
1782
1783 snprintf(str_buff, sizeof(str_buff),
1784 "An error was provoked by the field whose most significant bit is in bit position %d",
1785 bit_pointer);
1786 return str_buff;
1787}
1788
Harald Welteebd362d2018-06-02 14:11:19 +02001789const struct value_string gsm0808_lcls_config_names[] = {
1790 { GSM0808_LCLS_CFG_BOTH_WAY, "Connect both-way" },
1791 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL,
1792 "Connect both-way, bi-cast UL to CN" },
1793 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL,
1794 "Connect both-way, send access DL from CN" },
1795 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL_BLOCK_LOCAL_DL,
1796 "Connect both-way, send access DL from CN, block local DL" },
1797 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL,
1798 "Connect both-way, bi-cast UL to CN, send access DL from CN" },
1799 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL_BLOCK_LOCAL_DL,
1800 "Connect both-way, bi-cast UL to CN, send access DL from CN, block local DL" },
Max961db7c2018-11-08 11:40:23 +01001801 { GSM0808_LCLS_CFG_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001802 { 0, NULL }
1803};
1804
1805const struct value_string gsm0808_lcls_control_names[] = {
1806 { GSM0808_LCLS_CSC_CONNECT, "Connect" },
1807 { GSM0808_LCLS_CSC_DO_NOT_CONNECT, "Do not connect" },
1808 { GSM0808_LCLS_CSC_RELEASE_LCLS, "Release LCLS" },
1809 { GSM0808_LCLS_CSC_BICAST_UL_AT_HANDOVER, "Bi-cast UL at Handover" },
1810 { GSM0808_LCLS_CSC_BICAST_UL_AND_RECV_DL_AT_HANDOVER, "Bi-cast UL and receive DL at Handover" },
Max961db7c2018-11-08 11:40:23 +01001811 { GSM0808_LCLS_CSC_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001812 { 0, NULL }
1813};
1814
1815const struct value_string gsm0808_lcls_status_names[] = {
1816 { GSM0808_LCLS_STS_NOT_YET_LS, "Call not yet locally switched" },
1817 { GSM0808_LCLS_STS_NOT_POSSIBLE_LS, "Call not possible to be locally switched" },
1818 { GSM0808_LCLS_STS_NO_LONGER_LS, "Call is no longer locally switched" },
1819 { GSM0808_LCLS_STS_REQ_LCLS_NOT_SUPP, "Requested LCLS configuration is not supported" },
1820 { GSM0808_LCLS_STS_LOCALLY_SWITCHED, "Call is locally switched with requested LCLS config" },
Max961db7c2018-11-08 11:40:23 +01001821 { GSM0808_LCLS_STS_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001822 { 0, NULL }
1823};
1824
Harald Welte96e2a002017-06-12 21:44:18 +02001825/*! @} */