blob: 529dbdfe9335ac97bac1286ec2ac81a17050d044 [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 *
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020018 */
19
Andreas Eversberg532b8e92023-06-09 15:24:59 +020020#include "config.h"
21
Alexander Chemeris22630e62020-05-13 00:44:04 +030022#include <string.h>
23
Harald Welte95871da2017-05-15 12:11:36 +020024#include <osmocom/core/byteswap.h>
Philipp Maier2908dbf2020-06-05 14:16:11 +020025#include <osmocom/core/endian.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010026#include <osmocom/gsm/gsm0808.h>
Neels Hofmeyr5b214e22020-09-18 18:00:50 +020027#include <osmocom/gsm/gsm0808_lcs.h>
Philipp Maierfa896ab2017-03-27 16:55:32 +020028#include <osmocom/gsm/gsm0808_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010029#include <osmocom/gsm/protocol/gsm_08_08.h>
30#include <osmocom/gsm/gsm48.h>
Neels Hofmeyr5b214e22020-09-18 18:00:50 +020031#include <osmocom/gsm/gad.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 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700105 if (scl) {
106 if (gsm0808_enc_speech_codec_list2(msg, scl) < 0)
107 goto exit_free;
108 }
Philipp Maierfa896ab2017-03-27 16:55:32 +0200109
Harald Welte65c2d362012-01-21 14:26:01 +0100110 /* push the bssmap header */
111 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200112
113 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700114
115exit_free:
116 msgb_free(msg);
117 return NULL;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200118}
119
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100120/*! Create "Complete L3 Info" for A, legacy implementation.
121 * Instead use gsm0808_create_layer3_2() with the scl parameter passed as NULL,
122 * which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200123 * \param[in] msg_l3 msgb containing Layer 3 Message
124 * \param[in] nc Mobile Network Code
125 * \param[in] cc Mobile Country Code
126 * \param[in] lac Location Area Code
127 * \param[in] _ci Cell Identity
128 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200129struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
130 uint16_t cc, int lac, uint16_t _ci)
131{
Neels Hofmeyr4eeb8082018-03-23 01:47:14 +0100132 struct osmo_cell_global_id cgi = {
133 .lai = {
134 .plmn = {
135 .mcc = cc,
136 .mnc = nc,
137 },
138 .lac = lac,
139 },
140 .cell_identity = _ci,
141 };
142 return gsm0808_create_layer3_2(msg_l3, &cgi, NULL);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200143}
144
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200145/*! Create BSSMAP RESET message
Harald Welte96e2a002017-06-12 21:44:18 +0200146 * \returns callee-allocated msgb with BSSMAP Reset message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200147struct msgb *gsm0808_create_reset(void)
148{
Harald Welte65c2d362012-01-21 14:26:01 +0100149 uint8_t cause = GSM0808_CAUSE_EQUIPMENT_FAILURE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200150 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
151 "bssmap: reset");
152 if (!msg)
153 return NULL;
154
Harald Welte65c2d362012-01-21 14:26:01 +0100155 msgb_v_put(msg, BSS_MAP_MSG_RESET);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100156 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100157 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
158
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200159 return msg;
160}
161
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200162/*! Create BSSMAP RESET ACK message
Harald Welte96e2a002017-06-12 21:44:18 +0200163 * \returns callee-allocated msgb with BSSMAP Reset ACK message */
Harald Weltea62fe312013-06-19 15:14:37 +0200164struct msgb *gsm0808_create_reset_ack(void)
165{
166 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
167 "bssmap: reset ack");
168 if (!msg)
169 return NULL;
170
171 msgb_v_put(msg, BSS_MAP_MSG_RESET_ACKNOWLEDGE);
172 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
173
174 return msg;
175}
176
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200177/*! Create BSSMAP Clear Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200178 * \returns callee-allocated msgb with BSSMAP Clear Complete message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200179struct msgb *gsm0808_create_clear_complete(void)
180{
181 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
182 "bssmap: clear complete");
Harald Welte65c2d362012-01-21 14:26:01 +0100183 uint8_t val = BSS_MAP_MSG_CLEAR_COMPLETE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200184 if (!msg)
185 return NULL;
186
Harald Welte65c2d362012-01-21 14:26:01 +0100187 msg->l3h = msg->data;
188 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200189
190 return msg;
191}
192
Harald Welted1365e12019-02-18 13:44:30 +0100193/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
194 * This is quite different from most (all?) other gsm0808_create_* which have l3h
195 * point to the BSSAP header. However, we have to keep this for backwards compatibility.
196 * Use gsm0808_create_clear_command2() for a 'modern' implementation.
Philipp Maier1a146c82018-10-30 09:36:49 +0100197 * \param[in] cause TS 08.08 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200198 * \returns callee-allocated msgb with BSSMAP Clear Command message */
Philipp Maier1a146c82018-10-30 09:36:49 +0100199struct msgb *gsm0808_create_clear_command(uint8_t cause)
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200200{
201 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
202 "bssmap: clear command");
203 if (!msg)
204 return NULL;
205
Holger Hans Peter Freytheraeebe392010-10-27 12:36:05 +0200206 msg->l3h = msgb_tv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 4);
207 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100208 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100209
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200210 return msg;
211}
212
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100213/*! Create BSSMAP Clear Command message.
214 * \param[in] cause TS 08.08 cause value.
215 * \param[in] csfb_ind indicate that the call was established in an CSFB context.
216 * \returns callee-allocated msgb with BSSMAP Clear Command message. */
217struct msgb *gsm0808_create_clear_command2(uint8_t cause, bool csfb_ind)
218{
Harald Welte10ba47d2019-02-18 12:36:54 +0100219 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
220 "bssmap: clear command");
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100221 if (!msg)
222 return NULL;
223
Harald Welte10ba47d2019-02-18 12:36:54 +0100224 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
225 gsm0808_enc_cause(msg, cause);
226
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100227 if (csfb_ind)
228 msgb_v_put(msg, GSM0808_IE_CSFB_INDICATION);
229
Harald Welte10ba47d2019-02-18 12:36:54 +0100230 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
231
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100232 return msg;
233}
234
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200235/*! Superseded by gsm0808_create_cipher2() to include Kc128.
236 * Create BSSMAP Cipher Mode Command message (without Kc128).
Harald Welte96e2a002017-06-12 21:44:18 +0200237 * \param[in] ei Mandatory Encryption Information
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200238 * \param[in] kc128 optional kc128 key for A5/4
Harald Welte96e2a002017-06-12 21:44:18 +0200239 * \param[in] cipher_response_mode optional 1-byte Cipher Response Mode
240 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
Philipp Maierb478dd32017-03-29 15:50:05 +0200241struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,
242 const uint8_t *cipher_response_mode)
243{
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200244 struct gsm0808_cipher_mode_command cmc = {
245 .ei = *ei,
246 .cipher_response_mode_present = (cipher_response_mode != NULL),
247 .cipher_response_mode = (cipher_response_mode ? *cipher_response_mode : 0),
248 };
249 return gsm0808_create_cipher2(&cmc);
250}
251
252/*! Create BSSMAP Cipher Mode Command message.
253 * \param[in] cmc Information to encode.
254 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
255struct msgb *gsm0808_create_cipher2(const struct gsm0808_cipher_mode_command *cmc)
256{
Philipp Maierb478dd32017-03-29 15:50:05 +0200257 /* See also: 3GPP TS 48.008 3.2.1.30 CIPHER MODE COMMAND */
258 struct msgb *msg;
259
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200260 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "cipher-mode-command");
Philipp Maierb478dd32017-03-29 15:50:05 +0200261 if (!msg)
262 return NULL;
263
264 /* Message Type 3.2.2.1 */
265 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_CMD);
266
267 /* Encryption Information 3.2.2.10 */
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200268 gsm0808_enc_encrypt_info(msg, &cmc->ei);
Philipp Maierb478dd32017-03-29 15:50:05 +0200269
270 /* Cipher Response Mode 3.2.2.34 */
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200271 if (cmc->cipher_response_mode_present)
Philipp Maierb478dd32017-03-29 15:50:05 +0200272 msgb_tv_put(msg, GSM0808_IE_CIPHER_RESPONSE_MODE,
Neels Hofmeyr4a9756c2021-06-10 00:48:15 +0200273 cmc->cipher_response_mode);
274
275 /* Kc128 3.2.2.109 */
276 if (cmc->kc128_present)
277 gsm0808_enc_kc128(msg, cmc->kc128);
Philipp Maierb478dd32017-03-29 15:50:05 +0200278
279 /* pre-pend the header */
280 msg->l3h =
281 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
282
283 return msg;
284}
285
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200286/*! Create BSSMAP Cipher Mode Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200287 * \param[in] layer3 L3 Message to be included
288 * \param[in] alg_id Chosen Encrpytion Algorithm
289 * \returns callee-allocated msgb with BSSMAP Cipher Mode Complete message */
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200290struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id)
291{
292 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
293 "cipher-complete");
294 if (!msg)
295 return NULL;
296
297 /* send response with BSS override for A5/1... cheating */
Harald Welte65c2d362012-01-21 14:26:01 +0100298 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_COMPLETE);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200299
300 /* include layer3 in case we have at least two octets */
301 if (layer3 && msgb_l3len(layer3) > 2) {
Harald Welte65c2d362012-01-21 14:26:01 +0100302 msg->l4h = msgb_tlv_put(msg, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS,
303 msgb_l3len(layer3), layer3->l3h);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200304 }
305
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700306 /* Optional Chosen Encryption Algorithm IE */
307 if (alg_id > 0)
308 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, alg_id);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200309
Harald Welte65c2d362012-01-21 14:26:01 +0100310 /* pre-pend the header */
311 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
312
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200313 return msg;
314}
315
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200316/*! Create BSSMAP Cipher Mode Reject message
Maxaa934632018-11-07 13:16:54 +0100317 * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200318 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
Maxaa934632018-11-07 13:16:54 +0100319struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200320{
321 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
Maxaa934632018-11-07 13:16:54 +0100322 "bssmap: cipher mode reject");
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200323 if (!msg)
324 return NULL;
325
Harald Welte62e40852017-12-17 20:50:34 +0100326 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
Maxaa934632018-11-07 13:16:54 +0100327
Philipp Maier4f4905f2018-11-30 13:36:12 +0100328 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100329
330 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200331
332 return msg;
333}
334
Maxed651d22018-11-07 15:25:05 +0100335/*! Create BSSMAP Cipher Mode Reject message
336 * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class
337 * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)
338 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
339struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)
340{
Philipp Maier4f4905f2018-11-30 13:36:12 +0100341 uint16_t cause;
Maxed651d22018-11-07 15:25:05 +0100342 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
343 "bssmap: cipher mode reject");
344 if (!msg)
345 return NULL;
346
Philipp Maier4f4905f2018-11-30 13:36:12 +0100347 /* Set cause code class in the upper byte */
348 cause = 0x80 | (class << 4);
349 cause = cause << 8;
350
351 /* Set cause code extension in the lower byte */
352 cause |= ext;
Maxed651d22018-11-07 15:25:05 +0100353
354 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
355
Philipp Maier4f4905f2018-11-30 13:36:12 +0100356 gsm0808_enc_cause(msg, cause);
Maxed651d22018-11-07 15:25:05 +0100357
358 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
359
360 return msg;
361}
362
Harald Welte64e807c2018-05-29 21:00:56 +0200363/*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).
364 * \param[in] config LCLS Configuration
365 * \param[in] control LCLS Connection Status Control
366 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
Max45f89c92018-12-19 19:35:26 +0100367struct msgb *gsm0808_create_lcls_conn_ctrl(enum gsm0808_lcls_config config,
368 enum gsm0808_lcls_control control)
Harald Welte64e807c2018-05-29 21:00:56 +0200369{
Max45f89c92018-12-19 19:35:26 +0100370 struct msgb *msg;
371
372 /* According to NOTE 1 in §3.2.1.91 at least one of the parameters is required */
373 if (config == GSM0808_LCLS_CFG_NA && control == GSM0808_LCLS_CSC_NA)
374 return NULL;
375
376 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "bssmap: LCLS CONN CTRL");
Harald Welte64e807c2018-05-29 21:00:56 +0200377 if (!msg)
378 return NULL;
379
380 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL);
Max45f89c92018-12-19 19:35:26 +0100381 if (config != GSM0808_LCLS_CFG_NA)
382 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, config);
383 if (control != GSM0808_LCLS_CSC_NA)
Keith Whytee8525442022-10-06 01:01:47 +0100384 msgb_tv_put(msg, GSM0808_IE_LCLS_CONN_STATUS_CTRL, control);
Harald Welte64e807c2018-05-29 21:00:56 +0200385 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
386
387 return msg;
388}
389
390/*! Create BSSMAP LCLS CONNECT CONTROL ACK message (TS 48.008 3.2.1.92).
391 * \param[in] status LCLS BSS Status
392 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
393struct msgb *gsm0808_create_lcls_conn_ctrl_ack(enum gsm0808_lcls_status status)
394{
395 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
396 "bssmap: LCLS CONN CTRL ACK");
397 if (!msg)
398 return NULL;
399
400 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK);
401 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
402 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
403
404 return msg;
405}
406
407/*! Create BSSMAP LCLS NOTIFICATION message (TS 48.008 3.2.1.93).
408 * \param[in] status LCLS BSS Status
409 * \param[in] break_req Include the LCLS BREAK REQ IE (true) or not (false)
410 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
411struct msgb *gsm0808_create_lcls_notification(enum gsm0808_lcls_status status, bool break_req)
412{
413 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
414 "bssmap: LCLS NOTIFICATION");
415 if (!msg)
416 return NULL;
417
418 msgb_v_put(msg, BSS_MAP_MSG_LCLS_NOTIFICATION);
419 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
420 if (break_req)
421 msgb_v_put(msg, GSM0808_IE_LCLS_BREAK_REQ);
422 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
423
424 return msg;
425}
426
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200427/*! Create BSSMAP Classmark Request message
428 * \returns callee-allocated msgb with BSSMAP Classmark Request message */
Harald Weltee61d4592022-11-03 11:05:58 +0100429struct msgb *gsm0808_create_classmark_request(void)
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200430{
431 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
432 "classmark-request");
433 if (!msg)
434 return NULL;
435
436 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_RQST);
437 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
438 return msg;
439}
Harald Welte64e807c2018-05-29 21:00:56 +0200440
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200441/*! Create BSSMAP Classmark Update message
Harald Welte96e2a002017-06-12 21:44:18 +0200442 * \param[in] cm2 Classmark 2
443 * \param[in] cm2_len length (in octets) of \a cm2
444 * \param[in] cm3 Classmark 3
445 * \param[in] cm3_len length (in octets) of \a cm3
446 * \returns callee-allocated msgb with BSSMAP Classmark Update message */
Harald Welte07b625d2012-01-23 10:02:58 +0100447struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,
448 const uint8_t *cm3, uint8_t cm3_len)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200449{
450 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
451 "classmark-update");
452 if (!msg)
453 return NULL;
454
Harald Welte65c2d362012-01-21 14:26:01 +0100455 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_UPDATE);
Harald Welte07b625d2012-01-23 10:02:58 +0100456 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2, cm2_len, cm2);
457 if (cm3)
458 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
459 cm3_len, cm3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200460
Harald Welte65c2d362012-01-21 14:26:01 +0100461 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
462
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200463 return msg;
464}
465
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200466/*! Create BSSMAP SAPI N Reject message
Harald Welte96e2a002017-06-12 21:44:18 +0200467 * \param[in] link_id Link Identifier
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700468 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
Harald Welte96e2a002017-06-12 21:44:18 +0200469 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700470struct msgb *gsm0808_create_sapi_reject_cause(uint8_t link_id, uint16_t cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200471{
472 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
473 "bssmap: sapi 'n' reject");
474 if (!msg)
475 return NULL;
476
Harald Welte65c2d362012-01-21 14:26:01 +0100477 msgb_v_put(msg, BSS_MAP_MSG_SAPI_N_REJECT);
Alexander Chemerisa5b1b862020-05-12 01:03:08 +0300478 msgb_tv_put(msg, GSM0808_IE_DLCI, link_id);
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700479 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100480
481 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200482
483 return msg;
484}
485
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700486/*! Create BSSMAP SAPI N Reject message (with hard-coded cause "BSS not equipped").
487 * DEPRECATED: use gsm0808_create_sapi_reject_cause() instead.
488 * \param[in] link_id Link Identifier
489 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
490 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
491struct msgb *gsm0808_create_sapi_reject(uint8_t link_id)
492{
493 return gsm0808_create_sapi_reject_cause(link_id, GSM0808_CAUSE_BSS_NOT_EQUIPPED);
494}
495
Max52074322018-11-30 10:44:07 +0100496/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
497 * This is identical to gsm0808_create_ass(), but adds KC and LCLS IEs.
Harald Welte96e2a002017-06-12 21:44:18 +0200498 * \param[in] ct Channel Type
499 * \param[in] cic Circuit Identity Code (Classic A only)
500 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
501 * \param[in] scl Speech Codec List (AoIP only)
Max49c06682018-11-21 22:10:26 +0100502 * \param[in] ci Call Identifier (Optional), §3.2.2.105
Max52074322018-11-30 10:44:07 +0100503 * \param[in] kc Kc128 ciphering key (Optional, A5/4), §3.2.2.109
504 * \param[in] lcls Optional LCLS parameters
Harald Welte96e2a002017-06-12 21:44:18 +0200505 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
Max52074322018-11-30 10:44:07 +0100506struct msgb *gsm0808_create_ass2(const struct gsm0808_channel_type *ct,
507 const uint16_t *cic,
508 const struct sockaddr_storage *ss,
509 const struct gsm0808_speech_codec_list *scl,
510 const uint32_t *ci,
511 const uint8_t *kc, const struct osmo_lcls *lcls)
Philipp Maierc6144a22017-03-29 17:53:43 +0200512{
513 /* See also: 3GPP TS 48.008 3.2.1.1 ASSIGNMENT REQUEST */
514 struct msgb *msg;
Philipp Maierc6144a22017-03-29 17:53:43 +0200515
516 /* Mandatory emelent! */
517 OSMO_ASSERT(ct);
518
519 msg =
520 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
521 "bssmap: ass req");
522 if (!msg)
523 return NULL;
524
525 /* Message Type 3.2.2.1 */
526 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_RQST);
527
528 /* Channel Type 3.2.2.11 */
529 gsm0808_enc_channel_type(msg, ct);
530
531 /* Circuit Identity Code 3.2.2.2 */
Vadim Yanitskiy1c4fc222021-02-05 03:58:24 +0100532 if (cic)
533 msgb_tv16_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE, *cic);
Philipp Maierc6144a22017-03-29 17:53:43 +0200534
535 /* AoIP: AoIP Transport Layer Address (MGW) 3.2.2.102 */
536 if (ss) {
537 gsm0808_enc_aoip_trasp_addr(msg, ss);
538 }
539
540 /* AoIP: Codec List (MSC Preferred) 3.2.2.103 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700541 if (scl) {
542 if (gsm0808_enc_speech_codec_list2(msg, scl) < 0)
543 goto exit_free;
544 }
Philipp Maierc6144a22017-03-29 17:53:43 +0200545
546 /* AoIP: Call Identifier 3.2.2.105 */
547 if (ci) {
Philipp Maier2908dbf2020-06-05 14:16:11 +0200548 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
Vadim Yanitskiy1c4fc222021-02-05 03:58:24 +0100549 * the least significant byte shall be transmitted first. */
550 msgb_v_put(msg, GSM0808_IE_CALL_ID);
551 osmo_store32le(*ci, msgb_put(msg, sizeof(*ci)));
Philipp Maierc6144a22017-03-29 17:53:43 +0200552 }
553
Max52074322018-11-30 10:44:07 +0100554 if (kc)
555 msgb_tv_fixed_put(msg, GSM0808_IE_KC_128, 16, kc);
556
Max47022152018-12-19 18:51:00 +0100557 if (lcls)
558 gsm0808_enc_lcls(msg, lcls);
Max52074322018-11-30 10:44:07 +0100559
Philipp Maierc6144a22017-03-29 17:53:43 +0200560 /* push the bssmap header */
561 msg->l3h =
562 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
563
564 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700565
566exit_free:
567 msgb_free(msg);
568 return NULL;
Philipp Maierc6144a22017-03-29 17:53:43 +0200569}
570
Max52074322018-11-30 10:44:07 +0100571/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
572 * \param[in] ct Channel Type
573 * \param[in] cic Circuit Identity Code (Classic A only)
574 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
575 * \param[in] scl Speech Codec List (AoIP only)
576 * \param[in] ci Call Identifier (Optional), §3.2.2.105
577 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
578struct msgb *gsm0808_create_ass(const struct gsm0808_channel_type *ct,
579 const uint16_t *cic,
580 const struct sockaddr_storage *ss,
581 const struct gsm0808_speech_codec_list *scl,
582 const uint32_t *ci)
583{
584 return gsm0808_create_ass2(ct, cic, ss, scl, ci, NULL, NULL);
585}
586
Max414c8f52019-01-08 14:44:24 +0100587/*! Create BSSMAP Assignment Completed message as per 3GPP TS 48.008 §3.2.1.2
Harald Welte96e2a002017-06-12 21:44:18 +0200588 * \param[in] rr_cause GSM 04.08 RR Cause value
589 * \param[in] chosen_channel Chosen Channel
590 * \param[in] encr_alg_id Encryption Algorithm ID
591 * \param[in] speech_mode Speech Mode
592 * \param[in] ss Socket Address of BSS-side RTP socket
593 * \param[in] sc Speech Codec (current)
594 * \param[in] scl Speech Codec List (permitted)
Max414c8f52019-01-08 14:44:24 +0100595 * \param[in] lcls_bss_status §3.2.2.119 LCLS-BSS-Status, optional
Harald Welte96e2a002017-06-12 21:44:18 +0200596 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Max414c8f52019-01-08 14:44:24 +0100597struct msgb *gsm0808_create_ass_compl2(uint8_t rr_cause, uint8_t chosen_channel,
Philipp Maierfa896ab2017-03-27 16:55:32 +0200598 uint8_t encr_alg_id, uint8_t speech_mode,
599 const struct sockaddr_storage *ss,
600 const struct gsm0808_speech_codec *sc,
Max414c8f52019-01-08 14:44:24 +0100601 const struct gsm0808_speech_codec_list *scl,
602 enum gsm0808_lcls_status lcls_bss_status)
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200603{
Harald Welte65c2d362012-01-21 14:26:01 +0100604 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
605 "bssmap: ass compl");
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200606 if (!msg)
607 return NULL;
608
Harald Welte65c2d362012-01-21 14:26:01 +0100609 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_COMPLETE);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200610
611 /* write 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100612 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, rr_cause);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200613
614 /* write cirtcuit identity code 3.2.2.2 */
615 /* write cell identifier 3.2.2.17 */
616 /* write chosen channel 3.2.2.33 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100617 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, chosen_channel);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200618
619 /* write chosen encryption algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700620 if (encr_alg_id > 0)
621 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, encr_alg_id);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200622
623 /* write circuit pool 3.2.2.45 */
624 /* write speech version chosen: 3.2.2.51 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100625 if (speech_mode != 0)
626 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, speech_mode);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200627
Philipp Maierfa896ab2017-03-27 16:55:32 +0200628 /* AoIP: AoIP Transport Layer Address (BSS) 3.2.2.102 */
629 if (ss)
630 gsm0808_enc_aoip_trasp_addr(msg, ss);
631
632 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700633 if (sc) {
634 if (gsm0808_enc_speech_codec2(msg, sc) < 0)
635 goto exit_free;
636 }
Philipp Maierfa896ab2017-03-27 16:55:32 +0200637
638 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700639 if (scl) {
640 if (gsm0808_enc_speech_codec_list2(msg, scl) < 0)
641 goto exit_free;
642 }
Philipp Maierfa896ab2017-03-27 16:55:32 +0200643
Max414c8f52019-01-08 14:44:24 +0100644 /* FIXME: write LSA identifier 3.2.2.15 - see 3GPP TS 43.073 */
645
646 /* LCLS-BSS-Status 3.2.2.119 */
647 if (lcls_bss_status != GSM0808_LCLS_STS_NA)
648 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, lcls_bss_status);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200649
Harald Welte65c2d362012-01-21 14:26:01 +0100650 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200651
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200652 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700653
654exit_free:
655 msgb_free(msg);
656 return NULL;
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200657}
658
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200659/*! Create BSSMAP Assignment Completed message
Harald Welte96e2a002017-06-12 21:44:18 +0200660 * \param[in] rr_cause GSM 04.08 RR Cause value
661 * \param[in] chosen_channel Chosen Channel
662 * \param[in] encr_alg_id Encryption Algorithm ID
663 * \param[in] speech_mode Speech Mode
Max414c8f52019-01-08 14:44:24 +0100664 * \param[in] ss Socket Address of BSS-side RTP socket
665 * \param[in] sc Speech Codec (current)
666 * \param[in] scl Speech Codec List (permitted)
667 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
668struct msgb *gsm0808_create_ass_compl(uint8_t rr_cause, uint8_t chosen_channel,
669 uint8_t encr_alg_id, uint8_t speech_mode,
670 const struct sockaddr_storage *ss,
671 const struct gsm0808_speech_codec *sc,
672 const struct gsm0808_speech_codec_list *scl)
673{
674 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id, speech_mode,
675 ss, sc, scl, GSM0808_LCLS_STS_NA);
676}
677
678/*! Create BSSMAP Assignment Completed message
679 * \param[in] rr_cause GSM 04.08 RR Cause value
680 * \param[in] chosen_channel Chosen Channel
681 * \param[in] encr_alg_id Encryption Algorithm ID
682 * \param[in] speech_mode Speech Mode
Harald Welte96e2a002017-06-12 21:44:18 +0200683 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200684struct msgb *gsm0808_create_assignment_completed(uint8_t rr_cause,
685 uint8_t chosen_channel,
686 uint8_t encr_alg_id,
687 uint8_t speech_mode)
688{
Max414c8f52019-01-08 14:44:24 +0100689 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id,
690 speech_mode, NULL, NULL, NULL, GSM0808_LCLS_STS_NA);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200691}
692
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200693/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200694 * \param[in] cause BSSMAP Cause value
695 * \param[in] rr_cause GSM 04.08 RR Cause value
696 * \param[in] scl Optional Speech Cdec List (AoIP)
697 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200698struct msgb *gsm0808_create_ass_fail(uint8_t cause, const uint8_t *rr_cause,
699 const struct gsm0808_speech_codec_list
700 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200701{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200702 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
703 "bssmap: ass fail");
704 if (!msg)
705 return NULL;
706
Harald Welte65c2d362012-01-21 14:26:01 +0100707 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_FAILURE);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100708 gsm0808_enc_cause(msg, cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200709
710 /* RR cause 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100711 if (rr_cause)
712 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, *rr_cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200713
714 /* Circuit pool 3.22.45 */
715 /* Circuit pool list 3.2.2.46 */
716
Philipp Maierfa896ab2017-03-27 16:55:32 +0200717 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700718 if (scl) {
719 if (gsm0808_enc_speech_codec_list2(msg, scl) < 0)
720 goto exit_free;
721 }
Philipp Maierfa896ab2017-03-27 16:55:32 +0200722
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200723 /* update the size */
Harald Welte65c2d362012-01-21 14:26:01 +0100724 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
725
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200726 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +0700727
728exit_free:
729 msgb_free(msg);
730 return NULL;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200731}
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +0200732
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200733/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200734 * \param[in] cause BSSMAP Cause value
735 * \param[in] rr_cause GSM 04.08 RR Cause value
736 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200737struct msgb *gsm0808_create_assignment_failure(uint8_t cause,
738 uint8_t *rr_cause)
739{
740 return gsm0808_create_ass_fail(cause, rr_cause, NULL);
741}
742
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200743/*! Create BSSMAP Clear Request message
Harald Welte96e2a002017-06-12 21:44:18 +0200744 * \param[in] cause BSSMAP Cause value
745 * \returns callee-allocated msgb with BSSMAP Clear Request message */
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100746struct msgb *gsm0808_create_clear_rqst(uint8_t cause)
747{
748 struct msgb *msg;
749
750 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
751 "bssmap: clear rqst");
752 if (!msg)
753 return NULL;
754
Harald Welte65c2d362012-01-21 14:26:01 +0100755 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_RQST);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100756 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100757 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100758
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100759 return msg;
760}
761
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200762/*! Create BSSMAP PAGING message
Harald Welte96e2a002017-06-12 21:44:18 +0200763 * \param[in] imsi Mandatory paged IMSI in string representation
764 * \param[in] tmsi Optional paged TMSI
Stefan Sperling3953f412018-08-28 15:06:30 +0200765 * \param[in] cil Mandatory Cell Identity List (where to page)
Harald Welte96e2a002017-06-12 21:44:18 +0200766 * \param[in] chan_needed Channel Type needed
767 * \returns callee-allocated msgb with BSSMAP PAGING message */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100768struct msgb *gsm0808_create_paging2(const char *imsi, const uint32_t *tmsi,
769 const struct gsm0808_cell_id_list2 *cil,
770 const uint8_t *chan_needed)
Philipp Maier3d48ec02017-03-29 17:37:55 +0200771{
772 struct msgb *msg;
Harald Weltea13fb752020-06-16 08:44:42 +0200773 uint8_t mid_buf[GSM48_MI_SIZE + 2];
774 int mid_len;
Philipp Maier3d48ec02017-03-29 17:37:55 +0200775 uint32_t tmsi_sw;
776
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100777 /* Mandatory elements! */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200778 OSMO_ASSERT(imsi);
779 OSMO_ASSERT(cil);
780
781 /* Malformed IMSI */
782 OSMO_ASSERT(strlen(imsi) <= GSM48_MI_SIZE);
783
784 msg =
785 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "paging");
786 if (!msg)
787 return NULL;
788
789 /* Message Type 3.2.2.1 */
790 msgb_v_put(msg, BSS_MAP_MSG_PAGING);
791
Stefan Sperling3953f412018-08-28 15:06:30 +0200792 /* mandatory IMSI 3.2.2.6 */
Harald Weltea13fb752020-06-16 08:44:42 +0200793 mid_len = gsm48_generate_mid_from_imsi(mid_buf, imsi);
794 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200795
796 /* TMSI 3.2.2.7 */
797 if (tmsi) {
Harald Welte95871da2017-05-15 12:11:36 +0200798 tmsi_sw = osmo_htonl(*tmsi);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200799 msgb_tlv_put(msg, GSM0808_IE_TMSI, sizeof(*tmsi),
800 (uint8_t *) & tmsi_sw);
801 }
802
Stefan Sperling3953f412018-08-28 15:06:30 +0200803 /* mandatory Cell Identifier List 3.2.2.27 */
804 gsm0808_enc_cell_id_list2(msg, cil);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200805
806 /* Channel Needed 3.2.2.36 */
807 if (chan_needed) {
808 msgb_tv_put(msg, GSM0808_IE_CHANNEL_NEEDED,
809 (*chan_needed) & 0x03);
810 }
811
812 /* pre-pend the header */
813 msg->l3h =
814 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
815
816 return msg;
817}
818
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100819/*! DEPRECATED: Use gsm0808_create_paging2 instead.
820 * Create BSSMAP PAGING message.
821 * \param[in] imsi Mandatory paged IMSI in string representation
822 * \param[in] tmsi Optional paged TMSI
823 * \param[in] cil Cell Identity List (where to page)
824 * \param[in] chan_needed Channel Type needed
825 * \returns callee-allocated msgb with BSSMAP PAGING message */
826struct msgb *gsm0808_create_paging(const char *imsi, const uint32_t *tmsi,
827 const struct gsm0808_cell_id_list *cil,
828 const uint8_t *chan_needed)
829{
830 struct gsm0808_cell_id_list2 cil2 = {};
831
Pau Espin Pedrol49766ab2021-04-19 12:14:36 +0200832 /* Mandatory elements! */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100833 OSMO_ASSERT(cil);
834
835 if (cil->id_list_len > GSM0808_CELL_ID_LIST2_MAXLEN)
836 return NULL;
837
838 cil2.id_discr = cil->id_discr;
839 memcpy(cil2.id_list, cil->id_list_lac, cil->id_list_len * sizeof(cil2.id_list[0].lac));
840 cil2.id_list_len = cil->id_list_len;
841
842 return gsm0808_create_paging2(imsi, tmsi, &cil2, chan_needed);
843}
844
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100845static uint8_t put_old_bss_to_new_bss_information(struct msgb *msg,
846 const struct gsm0808_old_bss_to_new_bss_info *i)
847{
848 uint8_t *old_tail;
849 uint8_t *tlv_len;
850
851 msgb_put_u8(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION);
852 tlv_len = msgb_put(msg, 1);
853 old_tail = msg->tail;
854
855 if (i->extra_information_present) {
856 uint8_t val = 0;
857 if (i->extra_information.prec)
858 val |= 1 << 0;
859 if (i->extra_information.lcs)
860 val |= 1 << 1;
861 if (i->extra_information.ue_prob)
862 val |= 1 << 2;
863 msgb_tlv_put(msg, GSM0808_FE_IE_EXTRA_INFORMATION, 1, &val);
864 }
865
866 if (i->current_channel_type_2_present) {
867 uint8_t val[2] = {
868 i->current_channel_type_2.mode,
869 i->current_channel_type_2.field,
870 };
871 msgb_tlv_put(msg, GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2, 2, val);
872 }
873
Pau Espin Pedrol1b625cb2021-04-14 21:27:31 +0200874 if (i->last_eutran_plmn_id_present) {
875 msgb_put_u8(msg, GSM0808_FE_IE_LAST_USED_EUTRAN_PLMN_ID);
876 osmo_plmn_to_bcd(msgb_put(msg, 3), &i->last_eutran_plmn_id);
877 }
878
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100879 *tlv_len = (uint8_t) (msg->tail - old_tail);
880 return *tlv_len + 2;
881}
882
883/*! Create BSSMAP HANDOVER REQUIRED message.
884 * \param[in] params All information to be encoded.
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200885 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED message. */
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100886struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params)
887{
888 struct msgb *msg;
889
890 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED");
891 if (!msg)
892 return NULL;
893
894 /* Message Type, 3.2.2.1 */
895 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED);
896
897 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +0100898 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100899
900 /* Cell Identifier List, 3.2.2.27 */
901 gsm0808_enc_cell_id_list2(msg, &params->cil);
902
903 /* Current Channel Type 1, 3.2.2.49 */
904 if (params->current_channel_type_1_present)
905 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
906
907 /* Speech Version (Used), 3.2.2.51 */
908 if (params->speech_version_used_present)
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200909 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100910
911 if (params->old_bss_to_new_bss_info_present)
912 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
913
914 /* pre-pend the header */
915 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
916
917 return msg;
918}
919
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100920/*! Create BSSMAP HANDOVER REQUIRED REJECT message.
921 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED REJECT message. */
922struct msgb *gsm0808_create_handover_required_reject(const struct gsm0808_handover_required_reject *params)
923{
924 struct msgb *msg;
925
926 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED-REJECT");
927 if (!msg)
928 return NULL;
929
930 /* Message Type, 3.2.2.1 */
931 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT);
932
933 /* Cause, 3.2.2.5 */
934 gsm0808_enc_cause(msg, params->cause);
935
936 /* prepend the header */
937 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
938
939 return msg;
940}
941
942/*! Create BSSMAP HANDOVER REQUEST message, 3GPP TS 48.008 3.2.1.8.
943 * Sent from the MSC to the potential new target cell during inter-BSC handover, or to the target MSC during inter-MSC
944 * handover.
945 */
946struct msgb *gsm0808_create_handover_request(const struct gsm0808_handover_request *params)
947{
948 struct msgb *msg;
949
950 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST");
951 if (!msg)
952 return NULL;
953
954 /* Message Type, 3.2.2.1 */
955 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST);
956
957 /* Channel Type 3.2.2.11 */
958 gsm0808_enc_channel_type(msg, &params->channel_type);
959
960 /* Encryption Information 3.2.2.10 */
961 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
962
963 /* Classmark Information 1 3.2.2.30 or Classmark Information 2 3.2.2.19 (Classmark 2 wins) */
964 if (params->classmark_information.classmark2_len) {
965 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2,
966 params->classmark_information.classmark2_len,
967 (const uint8_t*)&params->classmark_information.classmark2);
968 } else if (params->classmark_information.classmark1_set) {
969 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1,
970 sizeof(params->classmark_information.classmark1),
971 (const uint8_t*)&params->classmark_information.classmark1);
972 }
973 /* (Classmark 3 possibly follows below) */
974
975 /* Cell Identifier (Serving) , 3.2.2.17 */
976 gsm0808_enc_cell_id(msg, &params->cell_identifier_serving);
977
978 /* Cell Identifier (Target) , 3.2.2.17 */
979 gsm0808_enc_cell_id(msg, &params->cell_identifier_target);
980
981 /* Cause, 3.2.2.5 */
982 gsm0808_enc_cause(msg, params->cause);
983
984 /* Classmark Information 3 3.2.2.20 */
985 if (params->classmark_information.classmark3_len) {
986 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
987 params->classmark_information.classmark3_len,
988 (const uint8_t*)&params->classmark_information.classmark3);
989 }
990
991 /* Current Channel type 1 3.2.2.49 */
992 if (params->current_channel_type_1_present)
993 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
994
995 /* Speech Version (Used), 3.2.2.51 */
996 if (params->speech_version_used) {
997 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
998 }
999
1000 /* Chosen Encryption Algorithm (Serving) 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001001 if (params->chosen_encryption_algorithm_serving > 0)
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001002 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encryption_algorithm_serving);
1003
1004 /* Old BSS to New BSS Information 3.2.2.58 */
1005 if (params->old_bss_to_new_bss_info_raw && params->old_bss_to_new_bss_info_raw_len) {
1006 msgb_tlv_put(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION,
1007 params->old_bss_to_new_bss_info_raw_len,
1008 params->old_bss_to_new_bss_info_raw);
1009 } else if (params->old_bss_to_new_bss_info_present) {
1010 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
1011 }
1012
1013 /* IMSI 3.2.2.6 */
1014 if (params->imsi) {
Harald Weltea13fb752020-06-16 08:44:42 +02001015 uint8_t mid_buf[GSM48_MI_SIZE + 2];
1016 int mid_len = gsm48_generate_mid_from_imsi(mid_buf, params->imsi);
1017 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001018 }
1019
1020 if (params->aoip_transport_layer)
1021 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1022
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001023 if (params->codec_list_msc_preferred) {
1024 if (gsm0808_enc_speech_codec_list2(msg, params->codec_list_msc_preferred) < 0)
1025 goto exit_free;
1026 }
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001027
1028 if (params->call_id_present) {
1029 uint8_t val[4];
1030 osmo_store32le(params->call_id, val);
1031 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, 4, val);
1032 }
1033
Neels Hofmeyre4378b72021-06-10 00:54:35 +02001034 if (params->more_items && params->kc128_present)
1035 gsm0808_enc_kc128(msg, params->kc128);
1036
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001037 if (params->global_call_reference && params->global_call_reference_len) {
1038 msgb_tlv_put(msg, GSM0808_IE_GLOBAL_CALL_REF,
1039 params->global_call_reference_len, params->global_call_reference);
1040 }
1041
1042 /* prepend header with final length */
1043 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1044
1045 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001046
1047exit_free:
1048 msgb_free(msg);
1049 return NULL;
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001050}
1051
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001052/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.
1053 * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.
1054 * 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 +01001055struct msgb *gsm0808_create_handover_request_ack2(const struct gsm0808_handover_request_ack *params)
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001056{
1057 struct msgb *msg;
1058
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001059 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001060 if (!msg)
1061 return NULL;
1062
1063 /* Message Type, 3.2.2.1 */
1064 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE);
1065
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001066 /* Layer 3 Information, 3.2.2.24 -- it is actually mandatory, but rather compose a nonstandard message than
1067 * segfault or return NULL without a log message. */
1068 if (params->l3_info && params->l3_info_len)
1069 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001070
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001071 if (params->chosen_channel_present)
1072 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001073 if (params->chosen_encr_alg > 0)
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001074 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1075
1076 if (params->chosen_speech_version != 0)
1077 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->chosen_speech_version);
1078
1079 if (params->aoip_transport_layer)
1080 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1081
Neels Hofmeyra25a6dc2022-02-23 14:25:22 +01001082 /* AoIP: add Codec List (BSS Supported) 3.2.2.103.
1083 * (codec_list_bss_supported was added to struct gsm0808_handover_request_ack later than speech_codec_chosen
1084 * below, but it needs to come before it in the message coding). */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001085 if (params->more_items && params->codec_list_bss_supported.len) {
1086 if (gsm0808_enc_speech_codec_list2(msg, &params->codec_list_bss_supported) < 0)
1087 goto exit_free;
1088 }
Neels Hofmeyra25a6dc2022-02-23 14:25:22 +01001089
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001090 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001091 if (params->speech_codec_chosen_present) {
1092 if (gsm0808_enc_speech_codec2(msg, &params->speech_codec_chosen) < 0)
1093 goto exit_free;
1094 }
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001095
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001096 /* prepend header with final length */
1097 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1098
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001099 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001100
1101exit_free:
1102 msgb_free(msg);
1103 return NULL;
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001104}
1105
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001106/*! Same as gsm0808_create_handover_request_ack2() but with less parameters.
1107 * In particular, this lacks the AoIP Transport Layer address. */
1108struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,
1109 uint8_t chosen_channel, uint8_t chosen_encr_alg,
1110 uint8_t chosen_speech_version)
1111{
1112 struct gsm0808_handover_request_ack params = {
1113 .l3_info = l3_info,
1114 .l3_info_len = l3_info_len,
1115 .chosen_channel = chosen_channel,
1116 .chosen_encr_alg = chosen_encr_alg,
1117 .chosen_speech_version = chosen_speech_version,
1118 };
1119
1120 return gsm0808_create_handover_request_ack2(&params);
1121}
1122
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001123/*! Create BSSMAP HANDOVER COMMAND message, 3GPP TS 48.008 3.2.1.11.
1124 * Sent from the MSC to the old BSS to transmit the RR Handover Command received from the new BSS. */
1125struct msgb *gsm0808_create_handover_command(const struct gsm0808_handover_command *params)
1126{
1127 struct msgb *msg;
1128
1129 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMMAND");
1130 if (!msg)
1131 return NULL;
1132
1133 /* Message Type, 3.2.2.1 */
1134 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_CMD);
1135
1136 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
1137
1138 if (params->cell_identifier.id_discr != CELL_IDENT_NO_CELL)
1139 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1140
1141 if (params->new_bss_to_old_bss_info_raw
1142 && params->new_bss_to_old_bss_info_raw_len)
1143 msgb_tlv_put(msg, GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO, params->new_bss_to_old_bss_info_raw_len,
1144 params->new_bss_to_old_bss_info_raw);
1145
1146 /* prepend header with final length */
1147 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1148
1149 return msg;
1150}
1151
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001152/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.
1153 * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has
1154 * received the Handover Detect message. */
Harald Weltee61d4592022-11-03 11:05:58 +01001155struct msgb *gsm0808_create_handover_detect(void)
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001156{
1157 struct msgb *msg;
1158
1159 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1160 if (!msg)
1161 return NULL;
1162
1163 /* Message Type, 3.2.2.1 */
1164 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);
1165
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001166 /* prepend header with final length */
1167 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1168
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001169 return msg;
1170}
1171
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001172/*! Create BSSMAP HANDOVER SUCCEEDED message, 3GPP TS 48.008 3.2.1.13.
1173 * Sent from the MSC back to the old BSS to notify that the MS has successfully accessed the new BSS. */
Harald Weltee61d4592022-11-03 11:05:58 +01001174struct msgb *gsm0808_create_handover_succeeded(void)
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001175{
1176 struct msgb *msg;
1177
1178 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1179 if (!msg)
1180 return NULL;
1181
1182 /* Message Type, 3.2.2.1 */
1183 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_SUCCEEDED);
1184
1185 /* prepend header with final length */
1186 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1187
1188 return msg;
1189}
1190
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001191/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.
1192 * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */
1193struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)
1194{
1195 struct msgb *msg;
1196
1197 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");
1198 if (!msg)
1199 return NULL;
1200
1201 /* Message Type, 3.2.2.1 */
1202 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);
1203
1204 /* RR Cause, 3.2.2.22 */
1205 if (params->rr_cause_present)
1206 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1207
1208 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001209 if (params->speech_codec_chosen_present) {
1210 if (gsm0808_enc_speech_codec2(msg, &params->speech_codec_chosen) < 0)
1211 goto exit_free;
1212 }
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001213
1214 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001215 if (params->codec_list_bss_supported.len) {
1216 if (gsm0808_enc_speech_codec_list2(msg, &params->codec_list_bss_supported) < 0)
1217 goto exit_free;
1218 }
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001219
1220 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001221 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001222 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1223
1224 /* LCLS-BSS-Status 3.2.2.119 */
1225 if (params->lcls_bss_status_present)
1226 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1227
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001228 /* prepend header with final length */
1229 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1230
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001231 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001232
1233exit_free:
1234 msgb_free(msg);
1235 return NULL;
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001236}
1237
1238/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.
1239 * Sent from the MT BSC back to the MSC when the handover has failed. */
1240struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)
1241{
1242 struct msgb *msg;
1243
1244 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");
1245 if (!msg)
1246 return NULL;
1247
1248 /* Message Type, 3.2.2.1 */
1249 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);
1250
1251 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001252 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001253
1254 /* RR Cause, 3.2.2.22 */
1255 if (params->rr_cause_present)
1256 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1257
1258 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001259 if (params->codec_list_bss_supported.len) {
1260 if (gsm0808_enc_speech_codec_list2(msg, &params->codec_list_bss_supported) < 0)
1261 goto exit_free;
1262 }
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001263
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001264 /* prepend header with final length */
1265 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1266
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001267 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001268
1269exit_free:
1270 msgb_free(msg);
1271 return NULL;
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001272}
1273
Philipp Maier225bdf42018-10-30 14:56:59 +01001274/*! Create BSSMAP HANDOVER PERFORMED message, 3GPP TS 48.008 3.2.1.25.
1275 * \param[in] params All information to be encoded.
1276 * \returns callee-allocated msgb with BSSMAP HANDOVER PERFORMED message */
1277struct msgb *gsm0808_create_handover_performed(const struct gsm0808_handover_performed *params)
1278{
1279 struct msgb *msg;
1280
1281 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-PERFORMED");
1282 if (!msg)
1283 return NULL;
1284
1285 /* Message Type, 3.2.2.1 */
1286 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_PERFORMED);
1287
1288 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001289 gsm0808_enc_cause(msg, params->cause);
Philipp Maier225bdf42018-10-30 14:56:59 +01001290
1291 /* Cell Identifier, 3.2.2.17 */
1292 gsm0808_enc_cell_id(msg, &params->cell_id);
1293
1294 /* Chosen Channel 3.2.2.33 */
1295 if (params->chosen_channel_present)
1296 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1297
1298 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001299 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Philipp Maier225bdf42018-10-30 14:56:59 +01001300 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1301
1302 /* Speech Version (chosen) 3.2.2.51 */
1303 if (params->speech_version_chosen_present)
1304 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_chosen);
1305
1306 /* AoIP: Speech Codec (chosen) 3.2.2.104 */
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001307 if (params->speech_codec_chosen_present) {
1308 if (gsm0808_enc_speech_codec2(msg, &params->speech_codec_chosen) < 0)
1309 goto exit_free;
1310 }
Philipp Maier225bdf42018-10-30 14:56:59 +01001311
1312 /* LCLS-BSS-Status 3.2.2.119 */
1313 if (params->lcls_bss_status_present)
1314 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1315
1316 /* prepend header with final length */
1317 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1318
1319 return msg;
Vadim Yanitskiy6db830f2022-12-14 00:45:25 +07001320
1321exit_free:
1322 msgb_free(msg);
1323 return NULL;
Philipp Maier225bdf42018-10-30 14:56:59 +01001324}
1325
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001326/*! Create BSSMAP COMMON ID message, 3GPP TS 48.008 3.2.1.68.
1327 * \param[in] imsi IMSI digits (decimal string).
1328 * \param[in] selected_plmn_id Selected PLMN ID to encode, or NULL to not encode this IE.
1329 * \param[in] last_used_eutran_plnm_id Last used E-UTRAN PLMN ID to encode, or NULL to not encode this IE.
1330 * \returns callee-allocated msgb with BSSMAP COMMON ID message, or NULL if encoding failed. */
Harald Welte1bd726a2020-06-21 22:04:52 +02001331struct msgb *gsm0808_create_common_id(const char *imsi,
1332 const struct osmo_plmn_id *selected_plmn_id,
1333 const struct osmo_plmn_id *last_used_eutran_plnm_id)
1334{
1335 struct msgb *msg;
Harald Welte1bd726a2020-06-21 22:04:52 +02001336 uint8_t *out;
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001337 struct osmo_mobile_identity mi;
1338 int rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001339
1340 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "COMMON-ID");
1341 if (!msg)
1342 return NULL;
1343
1344 /* Message Type, 3.2.2.1 */
1345 msgb_v_put(msg, BSS_MAP_MSG_COMMON_ID);
1346
1347 /* mandatory IMSI 3.2.2.6 */
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001348 mi = (struct osmo_mobile_identity){ .type = GSM_MI_TYPE_IMSI };
1349 OSMO_STRLCPY_ARRAY(mi.imsi, imsi);
1350 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1351 rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
1352 if (rc < 0) {
1353 msgb_free(msg);
1354 return NULL;
1355 }
1356 /* write the MI value length */
1357 *out = rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001358
1359 /* not implemented: SNA Access Information */
1360
1361 /* Selected PLMN ID */
1362 if (selected_plmn_id) {
1363 msgb_v_put(msg, GSM0808_IE_SELECTED_PLMN_ID);
1364 out = msgb_put(msg, 3);
1365 osmo_plmn_to_bcd(out, selected_plmn_id);
1366 }
1367
1368 /* Last used E-UTRAN PLMN ID */
1369 if (last_used_eutran_plnm_id) {
1370 msgb_v_put(msg, GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID);
1371 out = msgb_put(msg, 3);
1372 osmo_plmn_to_bcd(out, last_used_eutran_plnm_id);
1373 }
1374
1375 /* prepend header with final length */
1376 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1377
1378 return msg;
1379}
1380
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001381/*! Prepend a DTAP header to given Message Buffer
Harald Welte96e2a002017-06-12 21:44:18 +02001382 * \param[in] msgb Message Buffer
1383 * \param[in] link_id Link Identifier */
Holger Hans Peter Freyther9a3dec02010-05-16 08:15:40 +08001384void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id)
1385{
1386 uint8_t *hh = msgb_push(msg, 3);
1387 hh[0] = BSSAP_MSG_DTAP;
1388 hh[1] = link_id;
1389 hh[2] = msg->len - 3;
1390}
1391
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001392/*! Create BSSMAP DTAP message
Harald Welte96e2a002017-06-12 21:44:18 +02001393 * \param[in] msg_l3 Messge Buffer containing Layer3 message
1394 * \param[in] link_id Link Identifier
1395 * \returns callee-allocated msgb with BSSMAP DTAP message */
Holger Hans Peter Freytherc25c6682010-11-04 12:26:06 +01001396struct msgb *gsm0808_create_dtap(struct msgb *msg_l3, uint8_t link_id)
1397{
1398 struct dtap_header *header;
1399 uint8_t *data;
1400 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
1401 "dtap");
1402 if (!msg)
1403 return NULL;
1404
1405 /* DTAP header */
1406 msg->l3h = msgb_put(msg, sizeof(*header));
1407 header = (struct dtap_header *) &msg->l3h[0];
1408 header->type = BSSAP_MSG_DTAP;
1409 header->link_id = link_id;
1410 header->length = msgb_l3len(msg_l3);
1411
1412 /* Payload */
1413 data = msgb_put(msg, header->length);
1414 memcpy(data, msg_l3->l3h, header->length);
1415
1416 return msg;
1417}
1418
Neels Hofmeyr5b214e22020-09-18 18:00:50 +02001419struct msgb *gsm0808_create_perform_location_request(const struct gsm0808_perform_location_request *params)
1420{
1421 struct msgb *msg;
1422 uint8_t *out;
1423 int rc;
1424
1425 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-REQUEST");
1426 if (!msg)
1427 return NULL;
1428
1429 /* Message Type, 3.2.2.1 */
1430 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_RQST);
1431
1432 /* Location Type 3.2.2.63 */
1433 osmo_bssmap_le_ie_enc_location_type(msg, &params->location_type);
1434
1435 if (params->imsi.type == GSM_MI_TYPE_IMSI) {
1436 /* IMSI 3.2.2.6 */
1437 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1438 rc = osmo_mobile_identity_encode_msgb(msg, &params->imsi, false);
1439 if (rc < 0) {
1440 msgb_free(msg);
1441 return NULL;
1442 }
1443 /* write the MI value length */
1444 *out = rc;
1445 }
1446
1447 /* prepend header with final length */
1448 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1449
1450 return msg;
1451}
1452
1453struct msgb *gsm0808_create_perform_location_response(const struct gsm0808_perform_location_response *params)
1454{
1455 struct msgb *msg;
1456
1457 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-RESPONSE");
1458 if (!msg)
1459 return NULL;
1460
1461 /* Message Type, 3.2.2.1 */
1462 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE);
1463
1464 if (params->location_estimate_present) {
1465 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LOCATION_ESTIMATE);
1466 int rc = osmo_gad_raw_write(msg, &params->location_estimate);
1467 if (rc < 0) {
1468 msgb_free(msg);
1469 return NULL;
1470 }
1471 *l = rc;
1472 }
1473
1474 if (params->lcs_cause.present) {
1475 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LCS_CAUSE);
1476 int rc = osmo_lcs_cause_enc(msg, &params->lcs_cause);
1477 if (rc < 0) {
1478 msgb_free(msg);
1479 return NULL;
1480 }
1481 *l = rc;
1482 }
1483
1484 /* prepend header with final length */
1485 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1486
1487 return msg;
1488}
1489
1490int gsm0808_enc_lcs_cause(struct msgb *msg, const struct lcs_cause_ie *lcs_cause)
1491{
1492 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LCS_CAUSE);
1493 int rc = osmo_lcs_cause_enc(msg, lcs_cause);
1494 if (rc <= 0)
1495 return rc;
1496 *l = rc;
1497 return rc + 2;
1498}
1499
1500struct msgb *gsm0808_create_perform_location_abort(const struct lcs_cause_ie *lcs_cause)
1501{
1502 struct msgb *msg;
1503
1504 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-ABORT");
1505 if (!msg)
1506 return NULL;
1507
1508 /* Message Type, 3.2.2.1 */
1509 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_ABORT);
1510
1511 gsm0808_enc_lcs_cause(msg, lcs_cause);
1512
1513 /* prepend header with final length */
1514 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1515
1516 return msg;
1517}
1518
Andreas Eversberg532b8e92023-06-09 15:24:59 +02001519/*! Create BSSMAP VGCS/VBS SETUP message, 3GPP TS 48.008 3.2.1.50.
1520 * Sent from the MSC to the BSC to request VGCS/VBS call. */
1521struct msgb *gsm0808_create_vgcs_vbs_setup(const struct gsm0808_vgcs_vbs_setup *params)
1522{
1523 struct msgb *msg;
1524
1525 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-SETUP");
1526 if (!msg)
1527 return NULL;
1528
1529 /* Message Type, 3.2.2.1 */
1530 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_SETUP);
1531
1532 /* Group Call Reference, 3.2.2.55 */
1533 gsm0808_enc_group_callref(msg, &params->callref);
1534
1535 /* Priority, 3.2.2.18 */
1536 if (params->priority_present)
1537 gsm0808_enc_priority(msg, &params->priority);
1538
1539 /* VGCS Feature Flags, 3.2.2.88 */
1540 if (params->vgcs_feature_flags_present)
1541 gsm0808_enc_vgcs_feature_flags(msg, &params->flags);
1542
1543 /* prepend header with final length */
1544 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1545
1546 return msg;
1547}
1548
1549/*! Create BSSMAP VGCS/VBS SETUP ACK message, 3GPP TS 48.008 3.2.1.51.
1550 * Sent from the BSC to the MSC to confirm VGCS/VBS call. */
1551struct msgb *gsm0808_create_vgcs_vbs_setup_ack(const struct gsm0808_vgcs_vbs_setup_ack *params)
1552{
1553 struct msgb *msg;
1554
1555 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-SETUP-ACK");
1556 if (!msg)
1557 return NULL;
1558
1559 /* Message Type, 3.2.2.1 */
1560 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_SETUP_ACK);
1561
1562 /* VGCS Feature Flags, 3.2.2.88 */
1563 if (params->vgcs_feature_flags_present)
1564 gsm0808_enc_vgcs_feature_flags(msg, &params->flags);
1565
1566 /* prepend header with final length */
1567 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1568
1569 return msg;
1570}
1571
1572/*! Create BSSMAP VGCS/VBS SETUP REFUSE message, 3GPP TS 48.008 3.2.1.52.
1573 * Sent from the BSC to the MSC to reject VGCS/VBS call. */
1574struct msgb *gsm0808_create_vgcs_vbs_setup_refuse(enum gsm0808_cause cause)
1575{
1576 struct msgb *msg;
1577
1578 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-SETUP-REFUSE");
1579 if (!msg)
1580 return NULL;
1581
1582 /* Message Type, 3.2.2.1 */
1583 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE);
1584
1585 /* Cause, 3.2.2.5 */
1586 gsm0808_enc_cause(msg, cause);
1587
1588 /* prepend header with final length */
1589 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1590
1591 return msg;
1592}
1593
1594/*! Create BSSMAP VGCS/VBS ASSIGNMENT REQUEST message, 3GPP TS 48.008 3.2.1.53.
1595 * Sent from the MSC to the BSC to assign radio resources for a VGCS/VBS. */
1596struct msgb *gsm0808_create_vgcs_vbs_assign_req(const struct gsm0808_vgcs_vbs_assign_req *params)
1597{
1598 struct msgb *msg;
1599
1600 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-ASSIGNMENT-REQUEST");
1601 if (!msg)
1602 return NULL;
1603
1604 /* Message Type, 3.2.2.1 */
1605 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST);
1606
1607 /* Channel Type, 3.2.2.11 */
1608 gsm0808_enc_channel_type(msg, &params->channel_type);
1609
1610 /* Assignment Requrirement, 3.2.2.52 */
1611 gsm0808_enc_assign_req(msg, params->ass_req);
1612
1613 /* Cell Identifier, 3.2.2.17 */
1614 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1615
1616 /* Group Call Reference, 3.2.2.55 */
1617 gsm0808_enc_group_callref(msg, &params->callref);
1618
1619 /* Priority, 3.2.2.18 */
1620 if (params->priority_present)
1621 gsm0808_enc_priority(msg, &params->priority);
1622
1623 /* Circuit Identity Code, 3.2.2.2 */
1624 if (params->cic_present)
1625 msgb_tv16_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE, params->cic);
1626
1627 /* Downlink DTX Flag, 3.2.2.26 */
1628 if (params->downlink_dtx_flag_present)
1629 msgb_tv_put(msg, GSM0808_IE_DOWNLINK_DTX_FLAG, params->downlink_dtx_flag);
1630
1631 /* Encryption Information, 3.2.2.10 */
1632 if (params->encryption_information_present)
1633 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
1634
1635 /* VSTK_RAND Imformation, 3.2.2.83 */
1636 if (params->vstk_rand_present)
1637 msgb_tlv_put(msg, GSM0808_IE_VSTK_RAND_INFO, sizeof(params->vstk_rand), params->vstk_rand);
1638
1639 /* VSTK Information, 3.2.2.84 */
1640 if (params->vstk_present)
1641 msgb_tlv_put(msg, GSM0808_IE_VSTK_INFO, sizeof(params->vstk), params->vstk);
1642
1643 /* Cell Identifier List Segment, 3.2.2.27a */
1644 if (params->cils_present)
1645 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEGMENT, &params->cils);
1646
1647 /* AoIP Transport Layer Address (MGW), 3.2.2.102 */
1648 if (params->aoip_transport_layer_present)
1649 gsm0808_enc_aoip_trasp_addr(msg, &params->aoip_transport_layer);
1650
1651 /* Call Identifier, 3.2.2.105 */
1652 if (params->call_id_present) {
1653 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
1654 * the least significant byte shall be transmitted first. */
1655 msgb_v_put(msg, GSM0808_IE_CALL_ID);
1656 osmo_store32le(params->call_id, msgb_put(msg, sizeof(uint32_t)));
1657 }
1658
1659 /* Codec List (MSC Preferred) 3.2.2.103 */
1660 if (params->codec_list_present) {
1661 if (gsm0808_enc_speech_codec_list2(msg, &params->codec_list_msc_preferred) < 0)
1662 goto exit_free;
1663 }
1664
1665 /* prepend header with final length */
1666 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1667
1668 return msg;
1669
1670exit_free:
1671 msgb_free(msg);
1672 return NULL;
1673}
1674
1675/*! Create BSSMAP VGCS/VBS ASSIGNMENT RESULT message, 3GPP TS 48.008 3.2.1.54.
1676 * Sent from the BSC to the MSC to indicate assignment/deassingment of radio resources for a VGCS/VBS. */
1677struct msgb *gsm0808_create_vgcs_vbs_assign_res(const struct gsm0808_vgcs_vbs_assign_res *params)
1678{
1679 struct msgb *msg;
1680
1681 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-ASSIGNMENT-RESULT");
1682 if (!msg)
1683 return NULL;
1684
1685 /* Message Type, 3.2.2.1 */
1686 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT);
1687
1688 /* Channel Type, 3.2.2.11 */
1689 gsm0808_enc_channel_type(msg, &params->channel_type);
1690
1691 /* Cell Identifier, 3.2.2.17 */
1692 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1693
1694 /* Chosen Channel, 3.2.2.33 */
1695 if (params->chosen_channel_present)
1696 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1697
1698 /* Circuit Identity Code, 3.2.2.2 */
1699 if (params->cic_present)
1700 msgb_tv16_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE, params->cic);
1701
1702 /* Circuit Pool, 3.2.2.45 */
1703 if (params->circuit_pool_present)
1704 msgb_tv_put(msg, GSM0808_IE_CIRCUIT_POOL, params->circuit_pool);
1705
1706 /* AoIP Transport Layer Address (BSS), 3.2.2.102 */
1707 if (params->aoip_transport_layer_present)
1708 gsm0808_enc_aoip_trasp_addr(msg, &params->aoip_transport_layer);
1709
1710 /* Codec (MSC Chosen) 3.2.2.103 */
1711 if (params->codec_present) {
1712 if (gsm0808_enc_speech_codec2(msg, &params->codec_msc_chosen) < 0)
1713 goto exit_free;
1714 }
1715
1716 /* Call Identifier, 3.2.2.105 */
1717 if (params->call_id_present) {
1718 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
1719 * the least significant byte shall be transmitted first. */
1720 msgb_v_put(msg, GSM0808_IE_CALL_ID);
1721 osmo_store32le(params->call_id, msgb_put(msg, sizeof(uint32_t)));
1722 }
1723
1724 /* prepend header with final length */
1725 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1726
1727 return msg;
1728
1729exit_free:
1730 msgb_free(msg);
1731 return NULL;
1732}
1733
1734/*! Create BSSMAP VGCS/VBS ASSIGNMENT FAILURE message, 3GPP TS 48.008 3.2.1.55.
1735 * Sent from the BSC to the MSC to indicate assignment failure for a VGCS/VBS. */
1736struct msgb *gsm0808_create_vgcs_vbs_assign_fail(const struct gsm0808_vgcs_vbs_assign_fail *params)
1737{
1738 struct msgb *msg;
1739
1740 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-ASSIGNMENT-RESULT");
1741 if (!msg)
1742 return NULL;
1743
1744 /* Message Type, 3.2.2.1 */
1745 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE);
1746
1747 /* Cause, 3.2.2.5 */
1748 gsm0808_enc_cause(msg, params->cause);
1749
1750 /* Circuit Pool, 3.2.2.45 */
1751 if (params->circuit_pool_present)
1752 msgb_tv_put(msg, GSM0808_IE_CIRCUIT_POOL, params->circuit_pool);
1753
1754 /* Circuit Pool List, 3.2.2.46 */
1755 if (params->circuit_pool_present)
1756 msgb_tlv_put(msg, GSM0808_IE_CIRCUIT_POOL_LIST, params->cpl.list_len, params->cpl.pool);
1757
1758 /* Codec List (BSS Supported) 3.2.2.103 */
Andreas Eversberg209bc382023-07-19 10:26:27 +02001759 if (params->codec_list_present) {
1760 if (gsm0808_enc_speech_codec_list2(msg, &params->codec_list_bss_supported) < 0)
1761 goto exit_free;
1762 }
Andreas Eversberg532b8e92023-06-09 15:24:59 +02001763
1764 /* prepend header with final length */
1765 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1766
1767 return msg;
Andreas Eversberg209bc382023-07-19 10:26:27 +02001768
1769exit_free:
1770 msgb_free(msg);
1771 return NULL;
Andreas Eversberg532b8e92023-06-09 15:24:59 +02001772}
1773
1774/*! Create BSSMAP VGCS/VBS QUEUING INDICATION message, 3GPP TS 48.008 3.2.1.56.
1775 * Sent from the BSC to the MSC to indicate delay in assignment for a VGCS/VBS. */
1776struct msgb *gsm0808_create_vgcs_queuing_ind(void)
1777{
1778 struct msgb *msg;
1779 uint8_t val = BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION;
1780
1781 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-QUEUING-INDICATION");
1782 if (!msg)
1783 return NULL;
1784
1785 msg->l3h = msg->data;
1786 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
1787
1788 return msg;
1789}
1790
1791/*! Create BSSMAP (VGCS) UPLINK REQUEST message, 3GPP TS 48.008 3.2.1.57.
1792 * Sent from the BSC to the MSC to indicate that a mobile requested access to uplink. */
1793struct msgb *gsm0808_create_uplink_request(const struct gsm0808_uplink_request *params)
1794{
1795 struct msgb *msg;
1796 int rc;
1797
1798 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-REQUEST");
1799 if (!msg)
1800 return NULL;
1801
1802 /* Message Type, 3.2.2.1 */
1803 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_RQST);
1804
1805 /* Talker Priority, 3.2.2.89 */
1806 if (params->talker_priority_present)
1807 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->talker_priority);
1808
1809 /* Cell Identifier, 3.2.2.17 */
1810 if (params->cell_identifier_present)
1811 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1812
1813 /* Layer 3 Information, 3.2.2.24 */
1814 if (params->l3_present)
1815 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3.l3_len, params->l3.l3);
1816
1817 /* Mobile Identity, 3.2.2.41 */
1818 if (params->mi_present) {
1819 rc = osmo_mobile_identity_encode_msgb(msg, &params->mi, false);
1820 if (rc < 0) {
1821 msgb_free(msg);
1822 return NULL;
1823 }
1824 }
1825
1826 /* prepend header with final length */
1827 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1828
1829 return msg;
1830}
1831
1832/*! Create BSSMAP (VGCS) UPLINK REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.58.
1833 * Sent from the MSC to the BSC to indicate that access to uplink was granted. */
1834struct msgb *gsm0808_create_uplink_request_ack(const struct gsm0808_uplink_request_ack *params)
1835{
1836 struct msgb *msg;
1837
1838 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-REQUEST-ACKNOWLEDGE");
1839 if (!msg)
1840 return NULL;
1841
1842 /* Message Type, 3.2.2.1 */
1843 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE);
1844
1845 /* Talker Priority, 3.2.2.89 */
1846 if (params->talker_priority_present)
1847 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->talker_priority);
1848
1849 /* Emergency set indication, 3.2.2.90 */
1850 if (params->emerg_set_ind_present)
1851 msgb_v_put(msg, GSM0808_IE_EMERGENCY_SET_INDICATION);
1852
1853 /* Talker Identity, 3.2.2.91 */
1854 if (params->talker_identity_present)
1855 gsm0808_enc_talker_identity(msg, &params->talker_identity);
1856
1857 /* prepend header with final length */
1858 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1859
1860 return msg;
1861}
1862
1863/*! Create BSSMAP (VGCS) UPLINK CONFIRM message, 3GPP TS 48.008 3.2.1.59.
1864 * Sent from the BSC to the MSC to indicate that access to uplink was has been successfully established. */
1865struct msgb *gsm0808_create_uplink_request_cnf(const struct gsm0808_uplink_request_cnf *params)
1866{
1867 struct msgb *msg;
1868
1869 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-REQUEST-CONFIRM");
1870 if (!msg)
1871 return NULL;
1872
1873 /* Message Type, 3.2.2.1 */
1874 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION);
1875
1876 /* Cell Identifier, 3.2.2.17 */
1877 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1878
1879 /* Talker Identity, 3.2.2.91 */
1880 if (params->talker_identity_present)
1881 gsm0808_enc_talker_identity(msg, &params->talker_identity);
1882
1883 /* Layer 3 Information, 3.2.2.24 */
1884 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3.l3_len, params->l3.l3);
1885
1886 /* prepend header with final length */
1887 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1888
1889 return msg;
1890}
1891
1892/*! Create BSSMAP (VGCS) UPLINK APPLICATION DATA message, 3GPP TS 48.008 3.2.1.59a.
1893 * Sent from the BSC to the MSC to pass L3 info from the talker. */
1894struct msgb *gsm0808_create_uplink_app_data(const struct gsm0808_uplink_app_data *params)
1895{
1896 struct msgb *msg;
1897 uint8_t val;
1898
1899 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-APPLICATION-DATA");
1900 if (!msg)
1901 return NULL;
1902
1903 /* Message Type, 3.2.2.1 */
1904 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_APP_DATA);
1905
1906 /* Cell Identifier, 3.2.2.17 */
1907 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1908
1909 /* Layer 3 Information, 3.2.2.24 */
1910 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3.l3_len, params->l3.l3);
1911
1912 /* Application Data Information, 3.2.2.100 */
1913 val = params->bt_ind;
1914 msgb_tlv_put(msg, GSM0808_IE_APP_DATA_INFO, 1, &val);
1915
1916 /* prepend header with final length */
1917 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1918
1919 return msg;
1920}
1921
1922/*! Create BSSMAP (VGCS) UPLINK RELEASE INDICATION message, 3GPP TS 48.008 3.2.1.60.
1923 * Sent from the BSC to the MSC to indicate that the uplink has been released. */
1924struct msgb *gsm0808_create_uplink_release_ind(const struct gsm0808_uplink_release_ind *params)
1925{
1926 struct msgb *msg;
1927
1928 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-RELEASE-INDICATION");
1929 if (!msg)
1930 return NULL;
1931
1932 /* Message Type, 3.2.2.1 */
1933 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_RELEASE_INDICATION);
1934
1935 /* Cause, 3.2.2.5 */
1936 gsm0808_enc_cause(msg, params->cause);
1937
1938 /* Talker Priority, 3.2.2.89 */
1939 if (params->talker_priority_present)
1940 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->talker_priority);
1941
1942 /* prepend header with final length */
1943 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1944
1945 return msg;
1946}
1947
1948/*! Create BSSMAP (VGCS) UPLINK REJECT COMMAND message, 3GPP TS 48.008 3.2.1.61.
1949 * Sent from the MSC to the BSC to indicate that the uplink is not available for allocation. */
1950struct msgb *gsm0808_create_uplink_reject_cmd(const struct gsm0808_uplink_reject_cmd *params)
1951{
1952 struct msgb *msg;
1953
1954 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-REJECT-COMMAND");
1955 if (!msg)
1956 return NULL;
1957
1958 /* Message Type, 3.2.2.1 */
1959 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_REJECT_CMD);
1960
1961 /* Cause, 3.2.2.5 */
1962 gsm0808_enc_cause(msg, params->cause);
1963
1964 /* Talker Priority, 3.2.2.89 */
1965 if (params->current_talker_priority_present)
1966 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->current_talker_priority);
1967
1968 /* Talker Priority, 3.2.2.89 */
1969 if (params->rejected_talker_priority_present)
1970 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->rejected_talker_priority);
1971
1972 /* Talker Identity, 3.2.2.91 */
1973 if (params->talker_identity_present)
1974 gsm0808_enc_talker_identity(msg, &params->talker_identity);
1975
1976 /* prepend header with final length */
1977 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1978
1979 return msg;
1980}
1981
1982/*! Create BSSMAP (VGCS) UPLINK RELEASE COMMAND message, 3GPP TS 48.008 3.2.1.62.
1983 * Sent from the MSC to the BSC to indicate that the uplink is available for allocation. */
1984struct msgb *gsm0808_create_uplink_release_cmd(const enum gsm0808_cause cause)
1985{
1986 struct msgb *msg;
1987
1988 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-RELEASE-COMMAND");
1989 if (!msg)
1990 return NULL;
1991
1992 /* Message Type, 3.2.2.1 */
1993 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_RELEASE_CMD);
1994
1995 /* Cause, 3.2.2.5 */
1996 gsm0808_enc_cause(msg, cause);
1997
1998 /* prepend header with final length */
1999 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2000
2001 return msg;
2002}
2003
2004/*! Create BSSMAP (VGCS) UPLINK SEIZED COMMAND message, 3GPP TS 48.008 3.2.1.62.
2005 * Sent from the MSC to the BSC to indicate that the uplink is no longer available for allocation. */
2006struct msgb *gsm0808_create_uplink_seized_cmd(const struct gsm0808_uplink_seized_cmd *params)
2007{
2008 struct msgb *msg;
2009
2010 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-UPLINK-SEIZED-COMMAND");
2011 if (!msg)
2012 return NULL;
2013
2014 /* Message Type, 3.2.2.1 */
2015 msgb_v_put(msg, BSS_MAP_MSG_UPLINK_SEIZED_CMD);
2016
2017 /* Cause, 3.2.2.5 */
2018 gsm0808_enc_cause(msg, params->cause);
2019
2020 /* Talker Priority, 3.2.2.89 */
2021 if (params->talker_priority_present)
2022 msgb_tv_put(msg, GSM0808_IE_TALKER_PRIORITY, params->talker_priority);
2023
2024 /* Emergency set indication, 3.2.2.90 */
2025 if (params->emerg_set_ind_present)
2026 msgb_v_put(msg, GSM0808_IE_EMERGENCY_SET_INDICATION);
2027
2028 /* Talker Identity, 3.2.2.91 */
2029 if (params->talker_identity_present)
2030 gsm0808_enc_talker_identity(msg, &params->talker_identity);
2031
2032 /* prepend header with final length */
2033 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2034
2035 return msg;
2036}
2037
2038/*! Create BSSMAP VGCS ADDITIONAL INFORMATION message, 3GPP TS 48.008 3.2.1.78.
2039 * Sent from the MSC to the BSC to transfer talker identity. */
2040struct msgb *gsm0808_create_vgcs_additional_info(const struct gsm0808_talker_identity *ti)
2041{
2042 struct msgb *msg;
2043
2044 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS-ADDITIONAL-INFO");
2045 if (!msg)
2046 return NULL;
2047
2048 /* Message Type, 3.2.2.1 */
2049 msgb_v_put(msg, BSS_MAP_MSG_VGCS_ADDL_INFO);
2050
2051 /* Talker Identity, 3.2.2.91 */
2052 gsm0808_enc_talker_identity(msg, ti);
2053
2054 /* prepend header with final length */
2055 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2056
2057 return msg;
2058}
2059
2060/*! Create BSSMAP VGCS/VBS AREA CELL INFO message, 3GPP TS 48.008 3.2.1.79.
2061 * Sent from the BSC to the MSC to transfer additional infos about cells. */
2062struct msgb *gsm0808_create_vgcs_vbs_area_cell_info(const struct gsm0808_vgcs_vbs_area_cell_info *params)
2063{
2064 struct msgb *msg;
2065
2066 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-AREA-CELL-INFO");
2067 if (!msg)
2068 return NULL;
2069
2070 /* Message Type, 3.2.2.1 */
2071 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST);
2072
2073 /* Cell Identifier List Segment, 3.2.2.27a */
2074 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEGMENT, &params->cils);
2075
2076 /* Assignment Requrirement, 3.2.2.52 */
2077 if (params->ass_req_present)
2078 gsm0808_enc_assign_req(msg, params->ass_req);
2079
2080 /* prepend header with final length */
2081 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2082
2083 return msg;
2084}
2085
2086/*! Create BSSMAP VGCS/VBS ASSIGNMENT STATUS message, 3GPP TS 48.008 3.2.1.80.
2087 * Sent from the BSC to the MSC to indicate assignment status for each cell. */
2088struct msgb *gsm0808_create_vgcs_vbs_assign_stat(const struct gsm0808_vgcs_vbs_assign_stat *params)
2089{
2090 struct msgb *msg;
2091 uint8_t val;
2092
2093 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS/VBS-ASSIGNMENT-STATUS");
2094 if (!msg)
2095 return NULL;
2096
2097 /* Message Type, 3.2.2.1 */
2098 msgb_v_put(msg, BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_STATUS);
2099
2100 /* Cell Identifier List Segment, 3.2.2.27b */
2101 if (params->cils_est_present)
2102 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS, &params->cils_est);
2103 /* Cell Identifier List Segment, 3.2.2.27c */
2104 if (params->cils_tbe_present)
2105 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE, &params->cils_tbe);
2106 /* Cell Identifier List Segment, 3.2.2.27e */
2107 if (params->cils_rel_present)
2108 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS, &params->cils_rel);
2109 /* Cell Identifier List Segment, 3.2.2.27f */
2110 if (params->cils_ne_present)
2111 gsm0808_enc_cell_id_list_segment(msg, GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS, &params->cils_ne);
2112
2113 /* VGCS/VBS Cell Status, 3.2.2.94 */
2114 if (params->cell_status_present) {
2115 val = params->cell_status;
2116 msgb_tlv_put(msg, GSM0808_IE_VGCS_VBS_CELL_STATUS, 1, &val);
2117 }
2118
2119 /* prepend header with final length */
2120 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2121
2122 return msg;
2123}
2124
2125/*! Create BSSMAP VGCS SMS message, 3GPP TS 48.008 3.2.1.81.
2126 * Sent from the MSC to the BSC to send an SMS to VGCS. */
2127struct msgb *gsm0808_create_vgcs_sms(const struct gsm0808_sms_to_vgcs *sms)
2128{
2129 struct msgb *msg;
2130
2131 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS-SMS");
2132 if (!msg)
2133 return NULL;
2134
2135 /* SMS to VGCS, 3.2.2.92 */
2136 msgb_tlv_put(msg, GSM0808_IE_VGCS_VBS_CELL_STATUS, sms->sms_len, sms->sms);
2137
2138 /* prepend header with final length */
2139 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2140
2141 return msg;
2142}
2143
2144/*! Create BSSMAP (VGCS/VBS) NOTIFICATION DATA message, 3GPP TS 48.008 3.2.1.82.
2145 * Sent from the MSC to the BSC to send application specific data. */
2146struct msgb *gsm0808_create_notification_data(const struct gsm0808_notification_data *params)
2147{
2148 struct msgb *msg;
2149
2150 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-VGCS-SMS");
2151 if (!msg)
2152 return NULL;
2153
2154 /* Message Type, 3.2.2.1 */
2155 msgb_v_put(msg, BSS_MAP_MSG_NOTIFICATION_DATA);
2156
2157 /* Application Data, 3.2.2.98 */
2158 msgb_tlv_put(msg, GSM0808_IE_APP_DATA, params->app_data.data_len, params->app_data.data);
2159
2160 /* Data Identity, 3.2.2.99 */
2161 gsm0808_enc_data_identity(msg, &params->data_ident);
2162
2163 /* MSISDN, 3.2.2.101 */
2164 if (params->msisdn_present)
2165 gsm0808_enc_msisdn(msg, params->msisdn);
2166
2167 /* prepend header with final length */
2168 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
2169
2170 return msg;
2171}
2172
2173/* Note that EMERGENCY RESET INDICATION and EMERGENCY RESET COMMAND cannot be implemented, due to lack of
2174 * message type information in the specifications. */
2175
Harald Welte92107df2014-06-21 23:16:20 +02002176/* As per 3GPP TS 48.008 version 11.7.0 Release 11 */
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02002177static const struct tlv_definition bss_att_tlvdef = {
2178 .def = {
Harald Welte92107df2014-06-21 23:16:20 +02002179 [GSM0808_IE_CIRCUIT_IDENTITY_CODE] = { TLV_TYPE_FIXED, 2 },
2180 [GSM0808_IE_CONNECTION_RELEASE_RQSTED] = { TLV_TYPE_TV },
2181 [GSM0808_IE_RESOURCE_AVAILABLE] = { TLV_TYPE_FIXED, 21 },
2182 [GSM0808_IE_CAUSE] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02002183 [GSM0808_IE_IMSI] = { TLV_TYPE_TLV },
2184 [GSM0808_IE_TMSI] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02002185 [GSM0808_IE_NUMBER_OF_MSS] = { TLV_TYPE_TV },
Dmitri Soloviev29099422013-07-11 09:25:37 +02002186 [GSM0808_IE_LAYER_3_HEADER_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02002187 [GSM0808_IE_ENCRYPTION_INFORMATION] = { TLV_TYPE_TLV },
2188 [GSM0808_IE_CHANNEL_TYPE] = { TLV_TYPE_TLV },
2189 [GSM0808_IE_PERIODICITY] = { TLV_TYPE_TV },
2190 [GSM0808_IE_EXTENDED_RESOURCE_INDICATOR]= { TLV_TYPE_TV },
2191 [GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE] = { TLV_TYPE_FIXED, 4 },
2192 [GSM0808_IE_LSA_IDENTIFIER] = { TLV_TYPE_TLV },
2193 [GSM0808_IE_LSA_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther715e9452014-08-21 14:17:45 +02002194 [GSM0808_IE_LSA_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02002195 [GSM0808_IE_CELL_IDENTIFIER] = { TLV_TYPE_TLV },
2196 [GSM0808_IE_PRIORITY] = { TLV_TYPE_TLV },
2197 [GSM0808_IE_CLASSMARK_INFORMATION_T2] = { TLV_TYPE_TLV },
2198 [GSM0808_IE_CLASSMARK_INFORMATION_T3] = { TLV_TYPE_TLV },
2199 [GSM0808_IE_INTERFERENCE_BAND_TO_USE] = { TLV_TYPE_TV },
2200 [GSM0808_IE_RR_CAUSE] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02002201 [GSM0808_IE_LAYER_3_INFORMATION] = { TLV_TYPE_TLV },
2202 [GSM0808_IE_DLCI] = { TLV_TYPE_TV },
2203 [GSM0808_IE_DOWNLINK_DTX_FLAG] = { TLV_TYPE_TV },
2204 [GSM0808_IE_CELL_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
2205 [GSM0808_IE_CELL_ID_LIST_SEGMENT] = { TLV_TYPE_TLV },
2206 [GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS] = { TLV_TYPE_TLV },
2207 [GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE] = { TLV_TYPE_TLV },
2208 [GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS] = { TLV_TYPE_TLV },
2209 [GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS] = { TLV_TYPE_TLV },
2210 [GSM0808_IE_RESPONSE_RQST] = { TLV_TYPE_T },
2211 [GSM0808_IE_RESOURCE_INDICATION_METHOD] = { TLV_TYPE_TV },
2212 [GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1] = { TLV_TYPE_TV },
2213 [GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST] = { TLV_TYPE_TLV },
2214 [GSM0808_IE_DIAGNOSTIC] = { TLV_TYPE_TLV },
2215 [GSM0808_IE_CHOSEN_CHANNEL] = { TLV_TYPE_TV },
2216 [GSM0808_IE_CIPHER_RESPONSE_MODE] = { TLV_TYPE_TV },
2217 [GSM0808_IE_LAYER_3_MESSAGE_CONTENTS] = { TLV_TYPE_TLV },
2218 [GSM0808_IE_CHANNEL_NEEDED] = { TLV_TYPE_TV },
2219 [GSM0808_IE_TRACE_TYPE] = { TLV_TYPE_TV },
2220 [GSM0808_IE_TRIGGERID] = { TLV_TYPE_TLV },
2221 [GSM0808_IE_TRACE_REFERENCE] = { TLV_TYPE_TV },
2222 [GSM0808_IE_TRANSACTIONID] = { TLV_TYPE_TLV },
2223 [GSM0808_IE_MOBILE_IDENTITY] = { TLV_TYPE_TLV },
2224 [GSM0808_IE_OMCID] = { TLV_TYPE_TLV },
2225 [GSM0808_IE_FORWARD_INDICATOR] = { TLV_TYPE_TV },
Holger Hans Peter Freytherc2b7f922010-08-04 18:50:43 +08002226 [GSM0808_IE_CHOSEN_ENCR_ALG] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02002227 [GSM0808_IE_CIRCUIT_POOL] = { TLV_TYPE_TV },
2228 [GSM0808_IE_CIRCUIT_POOL_LIST] = { TLV_TYPE_TLV },
2229 [GSM0808_IE_TIME_INDICATION] = { TLV_TYPE_TV },
2230 [GSM0808_IE_RESOURCE_SITUATION] = { TLV_TYPE_TLV },
2231 [GSM0808_IE_CURRENT_CHANNEL_TYPE_1] = { TLV_TYPE_TV },
2232 [GSM0808_IE_QUEUEING_INDICATOR] = { TLV_TYPE_TV },
2233 [GSM0808_IE_SPEECH_VERSION] = { TLV_TYPE_TV },
2234 [GSM0808_IE_ASSIGNMENT_REQUIREMENT] = { TLV_TYPE_TV },
2235 [GSM0808_IE_TALKER_FLAG] = { TLV_TYPE_T },
2236 [GSM0808_IE_GROUP_CALL_REFERENCE] = { TLV_TYPE_TLV },
2237 [GSM0808_IE_EMLPP_PRIORITY] = { TLV_TYPE_TV },
2238 [GSM0808_IE_CONFIG_EVO_INDI] = { TLV_TYPE_TV },
2239 [GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION] = { TLV_TYPE_TLV },
2240 [GSM0808_IE_LCS_QOS] = { TLV_TYPE_TLV },
2241 [GSM0808_IE_LSA_ACCESS_CTRL_SUPPR] = { TLV_TYPE_TV },
2242 [GSM0808_IE_LCS_PRIORITY] = { TLV_TYPE_TLV },
2243 [GSM0808_IE_LOCATION_TYPE] = { TLV_TYPE_TLV },
2244 [GSM0808_IE_LOCATION_ESTIMATE] = { TLV_TYPE_TLV },
2245 [GSM0808_IE_POSITIONING_DATA] = { TLV_TYPE_TLV },
2246 [GSM0808_IE_LCS_CAUSE] = { TLV_TYPE_TLV },
Pau Espin Pedrolfffd7c32022-03-18 13:45:42 +01002247 [GSM0808_IE_LCS_CLIENT_TYPE] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02002248 [GSM0808_IE_APDU] = { TLV_TYPE_TLV },
2249 [GSM0808_IE_NETWORK_ELEMENT_IDENTITY] = { TLV_TYPE_TLV },
2250 [GSM0808_IE_GPS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
2251 [GSM0808_IE_DECIPHERING_KEYS] = { TLV_TYPE_TLV },
2252 [GSM0808_IE_RETURN_ERROR_RQST] = { TLV_TYPE_TLV },
2253 [GSM0808_IE_RETURN_ERROR_CAUSE] = { TLV_TYPE_TLV },
2254 [GSM0808_IE_SEGMENTATION] = { TLV_TYPE_TLV },
2255 [GSM0808_IE_SERVICE_HANDOVER] = { TLV_TYPE_TLV },
2256 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS] = { TLV_TYPE_TLV },
2257 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000] = { TLV_TYPE_TLV },
2258 [GSM0808_IE_GERAN_CLASSMARK] = { TLV_TYPE_TLV },
2259 [GSM0808_IE_GERAN_BSC_CONTAINER] = { TLV_TYPE_TLV },
2260 [GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO] = { TLV_TYPE_TLV },
2261 [GSM0800_IE_INTER_SYSTEM_INFO] = { TLV_TYPE_TLV },
2262 [GSM0808_IE_SNA_ACCESS_INFO] = { TLV_TYPE_TLV },
2263 [GSM0808_IE_VSTK_RAND_INFO] = { TLV_TYPE_TLV },
Pau Espin Pedrol3cf47592022-03-18 14:13:01 +01002264 [GSM0808_IE_VSTK_INFO] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02002265 [GSM0808_IE_PAGING_INFO] = { TLV_TYPE_TV },
2266 [GSM0808_IE_IMEI] = { TLV_TYPE_TLV },
2267 [GSM0808_IE_VELOCITY_ESTIMATE] = { TLV_TYPE_TLV },
2268 [GSM0808_IE_VGCS_FEATURE_FLAGS] = { TLV_TYPE_TLV },
2269 [GSM0808_IE_TALKER_PRIORITY] = { TLV_TYPE_TV },
2270 [GSM0808_IE_EMERGENCY_SET_INDICATION] = { TLV_TYPE_T },
2271 [GSM0808_IE_TALKER_IDENTITY] = { TLV_TYPE_TLV },
2272 [GSM0808_IE_SMS_TO_VGCS] = { TLV_TYPE_TLV },
2273 [GSM0808_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
2274 [GSM0808_IE_VGCS_VBS_CELL_STATUS] = { TLV_TYPE_TLV },
2275 [GSM0808_IE_GANSS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
2276 [GSM0808_IE_GANSS_POSITIONING_DATA] = { TLV_TYPE_TLV },
2277 [GSM0808_IE_GANSS_LOCATION_TYPE] = { TLV_TYPE_TLV },
2278 [GSM0808_IE_APP_DATA] = { TLV_TYPE_TLV },
2279 [GSM0808_IE_DATA_IDENTITY] = { TLV_TYPE_TLV },
2280 [GSM0808_IE_APP_DATA_INFO] = { TLV_TYPE_TLV },
2281 [GSM0808_IE_MSISDN] = { TLV_TYPE_TLV },
2282 [GSM0808_IE_AOIP_TRASP_ADDR] = { TLV_TYPE_TLV },
2283 [GSM0808_IE_SPEECH_CODEC_LIST] = { TLV_TYPE_TLV },
2284 [GSM0808_IE_SPEECH_CODEC] = { TLV_TYPE_TLV },
2285 [GSM0808_IE_CALL_ID] = { TLV_TYPE_FIXED, 4 },
2286 [GSM0808_IE_CALL_ID_LIST] = { TLV_TYPE_TLV },
2287 [GSM0808_IE_A_IF_SEL_FOR_RESET] = { TLV_TYPE_TV },
2288 [GSM0808_IE_KC_128] = { TLV_TYPE_FIXED, 16 },
2289 [GSM0808_IE_CSG_IDENTIFIER] = { TLV_TYPE_TLV },
2290 [GSM0808_IE_REDIR_ATTEMPT_FLAG] = { TLV_TYPE_T },
2291 [GSM0808_IE_REROUTE_REJ_CAUSE] = { TLV_TYPE_TV },
2292 [GSM0808_IE_SEND_SEQ_NUM] = { TLV_TYPE_TV },
2293 [GSM0808_IE_REROUTE_COMPL_OUTCOME] = { TLV_TYPE_TV },
2294 [GSM0808_IE_GLOBAL_CALL_REF] = { TLV_TYPE_TLV },
2295 [GSM0808_IE_LCLS_CONFIG] = { TLV_TYPE_TV },
2296 [GSM0808_IE_LCLS_CONN_STATUS_CTRL] = { TLV_TYPE_TV },
2297 [GSM0808_IE_LCLS_CORR_NOT_NEEDED] = { TLV_TYPE_TV },
2298 [GSM0808_IE_LCLS_BSS_STATUS] = { TLV_TYPE_TV },
2299 [GSM0808_IE_LCLS_BREAK_REQ] = { TLV_TYPE_TV },
2300 [GSM0808_IE_CSFB_INDICATION] = { TLV_TYPE_T },
2301 [GSM0808_IE_CS_TO_PS_SRVCC] = { TLV_TYPE_T },
2302 [GSM0808_IE_SRC_ENB_TO_TGT_ENB_TRANSP] = { TLV_TYPE_TLV },
2303 [GSM0808_IE_CS_TO_PS_SRVCC_IND] = { TLV_TYPE_T },
2304 [GSM0808_IE_CN_TO_MS_TRANSP_INFO] = { TLV_TYPE_TLV },
2305 [GSM0808_IE_SELECTED_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
2306 [GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol3cf47592022-03-18 14:13:01 +01002307 [GSM0808_IE_OLD_LAI] = { TLV_TYPE_FIXED, 5 },
2308 [GSM0808_IE_ATTACH_INDICATOR] = { TLV_TYPE_T },
2309 [GSM0808_IE_SELECTED_OPERATOR] = { TLV_TYPE_FIXED, 3 },
2310 [GSM0808_IE_PS_REGISTERED_OPERATOR] = { TLV_TYPE_FIXED, 3 },
2311 [GSM0808_IE_CS_REGISTERED_OPERATOR] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol18506c82019-04-16 15:47:59 +02002312
2313 /* Osmocom extensions */
2314 [GSM0808_IE_OSMO_OSMUX_SUPPORT] = { TLV_TYPE_T },
2315 [GSM0808_IE_OSMO_OSMUX_CID] = { TLV_TYPE_TV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02002316 },
2317};
2318
Harald Weltef4d45ab2011-07-16 12:13:00 +02002319const struct tlv_definition *gsm0808_att_tlvdef(void)
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02002320{
2321 return &bss_att_tlvdef;
2322}
Harald Welte9b837e62011-07-11 17:43:19 +02002323
Pau Espin Pedrolcde47792021-04-19 12:24:02 +02002324/* As per 3GPP TS 48.008 version 16.0.0 Release 16 § 3.2.2.58 Old BSS to New BSS Information */
2325const struct tlv_definition gsm0808_old_bss_to_new_bss_info_att_tlvdef = {
2326 .def = {
2327 [GSM0808_FE_IE_EXTRA_INFORMATION] = { TLV_TYPE_TLV },
2328 [GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2] = { TLV_TYPE_TLV },
2329 [GSM0808_FE_IE_TARGET_CELL_RADIO_INFORMATION] = { TLV_TYPE_TLV },
2330 [GSM0808_FE_IE_GPRS_SUSPEND_INFORMATION] = { TLV_TYPE_TLV },
2331 [GSM0808_FE_IE_MULTIRATE_CONFIGURATION_INFORMATION] = { TLV_TYPE_TLV },
2332 [GSM0808_FE_IE_DUAL_TRANSFER_MODE_INFORMATION] = { TLV_TYPE_TLV },
2333 [GSM0808_FE_IE_INTER_RAT_HANDOVER_INFO] = { TLV_TYPE_TLV },
2334 [GSM0808_FE_IE_CDMA2000_CAPABILITY_INFORMATION] = { TLV_TYPE_TLV },
2335 [GSM0808_FE_IE_DOWNLINK_CELL_LOAD_INFORMATION] = { TLV_TYPE_TLV },
2336 [GSM0808_FE_IE_UPLINK_CELL_LOAD_INFORMATION] = { TLV_TYPE_TLV },
2337 [GSM0808_FE_IE_CELL_LOAD_INFORMATION_GROUP] = { TLV_TYPE_TLV },
2338 [GSM0808_FE_IE_CELL_LOAD_INFORMATION] = { TLV_TYPE_TLV },
2339 [GSM0808_FE_IE_PS_INDICATION] = { TLV_TYPE_TLV },
2340 [GSM0808_FE_IE_DTM_HANDOVER_COMMAND_INDICATION] = { TLV_TYPE_TLV },
2341 [GSM0808_FE_IE_D_RNTI] = { TLV_TYPE_TLV },
2342 [GSM0808_FE_IE_IRAT_MEASUREMENT_CONFIGURATION] = { TLV_TYPE_TLV },
2343 [GSM0808_FE_IE_SOURCE_CELL_ID] = { TLV_TYPE_TLV },
2344 [GSM0808_FE_IE_IRAT_MEASUREMENT_CONFIGURATION_EXTENDED_E_ARFCNS] = { TLV_TYPE_TLV },
2345 [GSM0808_FE_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
2346 [GSM0808_FE_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
2347 },
2348};
2349
Pau Espin Pedrol392f6072019-11-27 12:07:04 +01002350const struct value_string gsm0406_dlci_sapi_names[] = {
2351 { DLCI_SAPI_RR_MM_CC, "RR/MM/CC" },
2352 { DLCI_SAPI_SMS, "SMS" },
2353 { 0, NULL }
2354};
2355
Harald Welte9b837e62011-07-11 17:43:19 +02002356static const struct value_string gsm0808_msgt_names[] = {
2357 { BSS_MAP_MSG_ASSIGMENT_RQST, "ASSIGNMENT REQ" },
2358 { BSS_MAP_MSG_ASSIGMENT_COMPLETE, "ASSIGNMENT COMPL" },
2359 { BSS_MAP_MSG_ASSIGMENT_FAILURE, "ASSIGNMENT FAIL" },
Harald Welte92107df2014-06-21 23:16:20 +02002360 { BSS_MAP_MSG_CHAN_MOD_RQST, "CHANNEL MODIFY REQUEST" },
Harald Welte9b837e62011-07-11 17:43:19 +02002361
2362 { BSS_MAP_MSG_HANDOVER_RQST, "HANDOVER REQ" },
2363 { BSS_MAP_MSG_HANDOVER_REQUIRED, "HANDOVER REQUIRED" },
2364 { BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE,"HANDOVER REQ ACK" },
2365 { BSS_MAP_MSG_HANDOVER_CMD, "HANDOVER CMD" },
2366 { BSS_MAP_MSG_HANDOVER_COMPLETE, "HANDOVER COMPLETE" },
2367 { BSS_MAP_MSG_HANDOVER_SUCCEEDED, "HANDOVER SUCCESS" },
2368 { BSS_MAP_MSG_HANDOVER_FAILURE, "HANDOVER FAILURE" },
2369 { BSS_MAP_MSG_HANDOVER_PERFORMED, "HANDOVER PERFORMED" },
2370 { BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE, "HANDOVER CAND ENQ" },
2371 { BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE, "HANDOVER CAND RESP" },
2372 { BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT, "HANDOVER REQ REJ" },
2373 { BSS_MAP_MSG_HANDOVER_DETECT, "HANDOVER DETECT" },
Harald Welte92107df2014-06-21 23:16:20 +02002374 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED, "INT HANDOVER REQ" },
2375 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED_REJ,"INT HANDOVER REQ REJ" },
2376 { BSS_MAP_MSG_INT_HANDOVER_CMD, "INT HANDOVER CMD" },
2377 { BSS_MAP_MSG_INT_HANDOVER_ENQUIRY, "INT HANDOVER ENQ" },
Harald Welte9b837e62011-07-11 17:43:19 +02002378
2379 { BSS_MAP_MSG_CLEAR_CMD, "CLEAR COMMAND" },
2380 { BSS_MAP_MSG_CLEAR_COMPLETE, "CLEAR COMPLETE" },
2381 { BSS_MAP_MSG_CLEAR_RQST, "CLEAR REQUEST" },
2382 { BSS_MAP_MSG_SAPI_N_REJECT, "SAPI N REJECT" },
2383 { BSS_MAP_MSG_CONFUSION, "CONFUSION" },
2384
2385 { BSS_MAP_MSG_SUSPEND, "SUSPEND" },
2386 { BSS_MAP_MSG_RESUME, "RESUME" },
2387 { BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION, "CONN ORIENT INFO" },
2388 { BSS_MAP_MSG_PERFORM_LOCATION_RQST, "PERFORM LOC REQ" },
2389 { BSS_MAP_MSG_LSA_INFORMATION, "LSA INFORMATION" },
2390 { BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE, "PERFORM LOC RESP" },
2391 { BSS_MAP_MSG_PERFORM_LOCATION_ABORT, "PERFORM LOC ABORT" },
2392 { BSS_MAP_MSG_COMMON_ID, "COMMON ID" },
Harald Welte92107df2014-06-21 23:16:20 +02002393 { BSS_MAP_MSG_REROUTE_CMD, "REROUTE COMMAND" },
2394 { BSS_MAP_MSG_REROUTE_COMPLETE, "REROUTE COMPLETE" },
Harald Welte9b837e62011-07-11 17:43:19 +02002395
2396 { BSS_MAP_MSG_RESET, "RESET" },
2397 { BSS_MAP_MSG_RESET_ACKNOWLEDGE, "RESET ACK" },
2398 { BSS_MAP_MSG_OVERLOAD, "OVERLOAD" },
2399 { BSS_MAP_MSG_RESET_CIRCUIT, "RESET CIRCUIT" },
2400 { BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE, "RESET CIRCUIT ACK" },
2401 { BSS_MAP_MSG_MSC_INVOKE_TRACE, "MSC INVOKE TRACE" },
2402 { BSS_MAP_MSG_BSS_INVOKE_TRACE, "BSS INVOKE TRACE" },
2403 { BSS_MAP_MSG_CONNECTIONLESS_INFORMATION, "CONNLESS INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02002404 { BSS_MAP_MSG_RESET_IP_RSRC, "RESET IP RESOURCE" },
2405 { BSS_MAP_MSG_RESET_IP_RSRC_ACK, "RESET IP RESOURCE ACK" },
Harald Welte9b837e62011-07-11 17:43:19 +02002406
2407 { BSS_MAP_MSG_BLOCK, "BLOCK" },
2408 { BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE, "BLOCK ACK" },
2409 { BSS_MAP_MSG_UNBLOCK, "UNBLOCK" },
2410 { BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE, "UNBLOCK ACK" },
2411 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK, "CIRC GROUP BLOCK" },
2412 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE, "CIRC GORUP BLOCK ACK" },
2413 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK, "CIRC GROUP UNBLOCK" },
2414 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE, "CIRC GROUP UNBLOCK ACK" },
2415 { BSS_MAP_MSG_UNEQUIPPED_CIRCUIT, "UNEQUIPPED CIRCUIT" },
2416 { BSS_MAP_MSG_CHANGE_CIRCUIT, "CHANGE CIRCUIT" },
2417 { BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE, "CHANGE CIRCUIT ACK" },
2418
2419 { BSS_MAP_MSG_RESOURCE_RQST, "RESOURCE REQ" },
2420 { BSS_MAP_MSG_RESOURCE_INDICATION, "RESOURCE IND" },
2421 { BSS_MAP_MSG_PAGING, "PAGING" },
2422 { BSS_MAP_MSG_CIPHER_MODE_CMD, "CIPHER MODE CMD" },
2423 { BSS_MAP_MSG_CLASSMARK_UPDATE, "CLASSMARK UPDATE" },
2424 { BSS_MAP_MSG_CIPHER_MODE_COMPLETE, "CIPHER MODE COMPLETE" },
2425 { BSS_MAP_MSG_QUEUING_INDICATION, "QUEUING INDICATION" },
2426 { BSS_MAP_MSG_COMPLETE_LAYER_3, "COMPLETE LAYER 3" },
2427 { BSS_MAP_MSG_CLASSMARK_RQST, "CLASSMARK REQ" },
2428 { BSS_MAP_MSG_CIPHER_MODE_REJECT, "CIPHER MODE REJECT" },
2429 { BSS_MAP_MSG_LOAD_INDICATION, "LOAD IND" },
2430
Harald Welte92107df2014-06-21 23:16:20 +02002431 { BSS_MAP_MSG_VGCS_VBS_SETUP, "VGCS/VBS SETUP" },
2432 { BSS_MAP_MSG_VGCS_VBS_SETUP_ACK, "VGCS/VBS SETUP ACK" },
2433 { BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE, "VGCS/VBS SETUP REFUSE" },
2434 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST, "VGCS/VBS ASSIGN REQ" },
2435 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT, "VGCS/VBS ASSIGN RES" },
2436 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE, "VGCS/VBS ASSIGN FAIL" },
Andreas Eversberg532b8e92023-06-09 15:24:59 +02002437 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_STATUS, "VGCS/VBS ASSIGN STATUS" },
Harald Welte92107df2014-06-21 23:16:20 +02002438 { BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION, "VGCS/VBS QUEUING IND" },
Andreas Eversberg532b8e92023-06-09 15:24:59 +02002439 { BSS_MAP_MSG_VGCS_VBS_AREA_CELL_INFO, "VGCS/VBS AREA CELL INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02002440 { BSS_MAP_MSG_UPLINK_RQST, "UPLINK REQ" },
2441 { BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE, "UPLINK REQ ACK" },
2442 { BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION, "UPLINK REQ CONF" },
2443 { BSS_MAP_MSG_UPLINK_RELEASE_INDICATION,"UPLINK REL IND" },
2444 { BSS_MAP_MSG_UPLINK_REJECT_CMD, "UPLINK REJ CMD" },
2445 { BSS_MAP_MSG_UPLINK_RELEASE_CMD, "UPLINK REL CMD" },
2446 { BSS_MAP_MSG_UPLINK_SEIZED_CMD, "UPLINK SEIZED CMD" },
2447 { BSS_MAP_MSG_VGCS_ADDL_INFO, "VGCS ADDL INFO" },
Andreas Eversberg532b8e92023-06-09 15:24:59 +02002448 { BSS_MAP_MSG_VGCS_SMS, "VGCS SMS" },
Harald Welte92107df2014-06-21 23:16:20 +02002449 { BSS_MAP_MSG_NOTIFICATION_DATA, "NOTIF DATA" },
2450 { BSS_MAP_MSG_UPLINK_APP_DATA, "UPLINK APP DATA" },
2451
2452 { BSS_MAP_MSG_LCLS_CONNECT_CTRL, "LCLS-CONNECT-CONTROL" },
Keith Whyte486d9842022-10-06 03:16:15 +01002453 { BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK, "LCLS-CONNECT-CONTROL-ACK" },
Harald Welte92107df2014-06-21 23:16:20 +02002454 { BSS_MAP_MSG_LCLS_NOTIFICATION, "LCLS-NOTIFICATION" },
Harald Welte9b837e62011-07-11 17:43:19 +02002455
2456 { 0, NULL }
2457};
2458
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002459/*! Return string name of BSSMAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02002460const char *gsm0808_bssmap_name(uint8_t msg_type)
2461{
2462 return get_value_string(gsm0808_msgt_names, msg_type);
2463}
2464
2465static const struct value_string gsm0808_bssap_names[] = {
2466 { BSSAP_MSG_BSS_MANAGEMENT, "MANAGEMENT" },
2467 { BSSAP_MSG_DTAP, "DTAP" },
Neels Hofmeyr90fdb082017-03-01 14:59:44 +01002468 { 0, NULL }
Harald Welte9b837e62011-07-11 17:43:19 +02002469};
2470
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002471/*! Return string name of BSSAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02002472const char *gsm0808_bssap_name(uint8_t msg_type)
2473{
2474 return get_value_string(gsm0808_bssap_names, msg_type);
2475}
Harald Welte96e2a002017-06-12 21:44:18 +02002476
Neels Hofmeyrffad5742018-01-12 05:34:03 +01002477const struct value_string gsm0808_speech_codec_type_names[] = {
2478 { GSM0808_SCT_FR1, "FR1" },
2479 { GSM0808_SCT_FR2, "FR2" },
2480 { GSM0808_SCT_FR3, "FR3" },
2481 { GSM0808_SCT_FR4, "FR4" },
2482 { GSM0808_SCT_FR5, "FR5" },
2483 { GSM0808_SCT_HR1, "HR1" },
2484 { GSM0808_SCT_HR3, "HR3" },
2485 { GSM0808_SCT_HR4, "HR4" },
2486 { GSM0808_SCT_HR6, "HR6" },
Vadim Yanitskiyf93ef0c2023-07-25 03:23:08 +07002487 { GSM0808_SCT_EXT, "Codec Extension" },
Neels Hofmeyrffad5742018-01-12 05:34:03 +01002488 { GSM0808_SCT_CSD, "CSD" },
2489 { 0, NULL }
2490};
2491
Philipp Maiercdd05812018-07-12 18:21:07 +02002492const struct value_string gsm0808_permitted_speech_names[] = {
2493 { GSM0808_PERM_FR1, "FR1" },
2494 { GSM0808_PERM_FR2, "FR2" },
2495 { GSM0808_PERM_FR3, "FR3" },
2496 { GSM0808_PERM_FR4, "FR4" },
2497 { GSM0808_PERM_FR5, "FR5" },
2498 { GSM0808_PERM_HR1, "HR1" },
2499 { GSM0808_PERM_HR2, "HR2" },
2500 { GSM0808_PERM_HR3, "HR3" },
2501 { GSM0808_PERM_HR4, "HR4" },
2502 { GSM0808_PERM_HR6, "HR6" },
2503 { 0, NULL }
2504};
2505
Pau Espin Pedrolf2cda622018-07-06 17:16:41 +02002506const struct value_string gsm0808_chosen_enc_alg_names[] = {
2507 { GSM0808_ALG_ID_A5_0, "A5/0" },
2508 { GSM0808_ALG_ID_A5_1, "A5/1" },
2509 { GSM0808_ALG_ID_A5_2, "A5/2" },
2510 { GSM0808_ALG_ID_A5_3, "A5/3" },
2511 { GSM0808_ALG_ID_A5_4, "A5/4" },
2512 { GSM0808_ALG_ID_A5_5, "A5/5" },
2513 { GSM0808_ALG_ID_A5_6, "A5/6" },
2514 { GSM0808_ALG_ID_A5_7, "A5/7" },
2515 { 0, NULL }
2516};
2517
Philipp Maierdbb76592018-03-29 12:55:26 +02002518static const struct value_string gsm0808_cause_names[] = {
2519 { GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE, "RADIO INTERFACE MESSAGE FAILURE" },
2520 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, "RADIO INTERFACE FAILURE" },
2521 { GSM0808_CAUSE_UPLINK_QUALITY, "UPLINK QUALITY" },
2522 { GSM0808_CAUSE_UPLINK_STRENGTH, "UPLINK STRENGTH" },
2523 { GSM0808_CAUSE_DOWNLINK_QUALITY, "DOWNLINK QUALITY" },
2524 { GSM0808_CAUSE_DOWNLINK_STRENGTH, "DOWNLINK STRENGTH" },
2525 { GSM0808_CAUSE_DISTANCE, "DISTANCE" },
2526 { GSM0808_CAUSE_O_AND_M_INTERVENTION, "O AND M INTERVENTION" },
2527 { GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION, "RESPONSE TO MSC INVOCATION" },
2528 { GSM0808_CAUSE_CALL_CONTROL, "CALL CONTROL" },
2529 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION, "RADIO INTERFACE FAILURE REVERSION" },
2530 { GSM0808_CAUSE_HANDOVER_SUCCESSFUL, "HANDOVER SUCCESSFUL" },
2531 { GSM0808_CAUSE_BETTER_CELL, "BETTER CELL" },
2532 { GSM0808_CAUSE_DIRECTED_RETRY, "DIRECTED RETRY" },
2533 { GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL, "JOINED GROUP CALL CHANNEL" },
2534 { GSM0808_CAUSE_TRAFFIC, "TRAFFIC" },
2535 { GSM0808_CAUSE_REDUCE_LOAD_IN_SERVING_CELL, "REDUCE LOAD IN SERVING CELL" },
2536 { GSM0808_CAUSE_TRAFFIC_LOAD_IN_TGT_HIGHER_THAN_IN_SRC_CELL, "TRAFFIC LOAD IN TGT HIGHER THAN IN SRC CELL" },
2537 { GSM0808_CAUSE_RELOCATION_TRIGGERED, "RELOCATION TRIGGERED" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02002538 { GSM0808_CAUSE_REQUESTED_OPT_NOT_AUTHORISED, "REQUESTED OPT NOT AUTHORISED" },
Philipp Maierdbb76592018-03-29 12:55:26 +02002539 { GSM0808_CAUSE_ALT_CHAN_CONFIG_REQUESTED, "ALT CHAN CONFIG REQUESTED" },
2540 { GSM0808_CAUSE_RESP_TO_INT_HO_ENQ_MSG, "RESP TO INT HO ENQ MSG" },
2541 { GSM0808_CAUSE_INT_HO_ENQUIRY_REJECT, "INT HO ENQUIRY REJECT" },
2542 { GSM0808_CAUSE_REDUNDANCY_LEVEL_NOT_ADEQUATE, "REDUNDANCY LEVEL NOT ADEQUATE" },
2543 { GSM0808_CAUSE_EQUIPMENT_FAILURE, "EQUIPMENT FAILURE" },
2544 { GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE, "NO RADIO RESOURCE AVAILABLE" },
2545 { GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, "RQSTED TERRESTRIAL RESOURCE UNAVAILABLE" },
2546 { GSM0808_CAUSE_CCCH_OVERLOAD, "CCCH OVERLOAD" },
2547 { GSM0808_CAUSE_PROCESSOR_OVERLOAD, "PROCESSOR OVERLOAD" },
2548 { GSM0808_CAUSE_BSS_NOT_EQUIPPED, "BSS NOT EQUIPPED" },
2549 { GSM0808_CAUSE_MS_NOT_EQUIPPED, "MS NOT EQUIPPED" },
2550 { GSM0808_CAUSE_INVALID_CELL, "INVALID CELL" },
2551 { GSM0808_CAUSE_TRAFFIC_LOAD, "TRAFFIC LOAD" },
2552 { GSM0808_CAUSE_PREEMPTION, "PREEMPTION" },
2553 { GSM0808_CAUSE_DTM_HO_SGSN_FAILURE, "DTM HO SGSN FAILURE" },
2554 { GSM0808_CAUSE_DTM_HO_PS_ALLOC_FAILURE, "DTM HO PS ALLOC FAILURE" },
2555 { GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE, "RQSTED TRANSCODING RATE ADAPTION UNAVAILABLE" },
2556 { GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH, "CIRCUIT POOL MISMATCH" },
2557 { GSM0808_CAUSE_SWITCH_CIRCUIT_POOL, "SWITCH CIRCUIT POOL" },
2558 { GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, "RQSTED SPEECH VERSION UNAVAILABLE" },
2559 { GSM0808_CAUSE_LSA_NOT_ALLOWED, "LSA NOT ALLOWED" },
2560 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_UNAVAIL, "REQ CODEC TYPE OR CONFIG UNAVAIL" },
2561 { GSM0808_CAUSE_REQ_A_IF_TYPE_UNAVAIL, "REQ A IF TYPE UNAVAIL" },
2562 { GSM0808_CAUSE_INVALID_CSG_CELL, "INVALID CSG CELL" },
2563 { GSM0808_CAUSE_REQ_REDUND_LEVEL_NOT_AVAIL, "REQ REDUND LEVEL NOT AVAIL" },
2564 { GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED, "CIPHERING ALGORITHM NOT SUPPORTED" },
2565 { GSM0808_CAUSE_GERAN_IU_MODE_FAILURE, "GERAN IU MODE FAILURE" },
2566 { GSM0808_CAUSE_INC_RELOC_NOT_SUPP_DT_PUESBINE_FEATURE, "INC RELOC NOT SUPP DT PUESBINE FEATURE" },
2567 { GSM0808_CAUSE_ACCESS_RESTRICTED_DUE_TO_SHARED_NETWORKS, "ACCESS RESTRICTED DUE TO SHARED NETWORKS" },
2568 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, "REQ CODEC TYPE OR CONFIG NOT SUPP" },
2569 { GSM0808_CAUSE_REQ_A_IF_TYPE_NOT_SUPP, "REQ A IF TYPE NOT SUPP" },
2570 { GSM0808_CAUSE_REQ_REDUND_LVL_NOT_SUPP, "REQ REDUND LVL NOT SUPP" },
2571 { GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED, "TERRESTRIAL CIRCUIT ALREADY ALLOCATED" },
2572 { GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS, "INVALID MESSAGE CONTENTS" },
2573 { GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING, "INFORMATION ELEMENT OR FIELD MISSING" },
2574 { GSM0808_CAUSE_INCORRECT_VALUE, "INCORRECT VALUE" },
2575 { GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE, "UNKNOWN MESSAGE TYPE" },
2576 { GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT, "UNKNOWN INFORMATION ELEMENT" },
2577 { GSM0808_CAUSE_DTM_HO_INVALID_PS_IND, "DTM HO INVALID PS IND" },
2578 { GSM0808_CAUSE_CALL_ID_ALREADY_ALLOC, "CALL ID ALREADY ALLOC" },
2579 { GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC, "PROTOCOL ERROR BETWEEN BSS AND MSC" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02002580 { GSM0808_CAUSE_VGCS_VBS_CALL_NON_EXISTENT, "VGCS VBS CALL NON EXISTENT" },
Philipp Maierdbb76592018-03-29 12:55:26 +02002581 { GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY, "DTM HO TIMER EXPIRY" },
2582 { 0, NULL }
2583};
2584
Maxaa934632018-11-07 13:16:54 +01002585static const struct value_string gsm0808_cause_class_names[] = {
2586 { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },
2587 { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },
2588 { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },
2589 { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },
2590 { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },
2591 { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },
2592 { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },
2593 { GSM0808_CAUSE_CLASS_INTW, "Interworking" },
2594 { 0, NULL }
2595};
2596
2597/*! Return string name of BSSMAP Cause Class name */
2598const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)
2599{
2600 return get_value_string(gsm0808_cause_class_names, class);
2601}
2602
Philipp Maierdbb76592018-03-29 12:55:26 +02002603/*! Return string name of BSSMAP Cause name */
Maxaa934632018-11-07 13:16:54 +01002604const char *gsm0808_cause_name(enum gsm0808_cause cause)
Philipp Maierdbb76592018-03-29 12:55:26 +02002605{
2606 return get_value_string(gsm0808_cause_names, cause);
2607}
2608
Alexander Chemerisfdfe25b2020-05-12 23:21:56 +03002609enum gsm0808_cause gsm0808_get_cause(const struct tlv_parsed *tp)
2610{
2611 const uint8_t *buf = TLVP_VAL_MINLEN(tp, GSM0808_IE_CAUSE, 1);
2612
2613 if (!buf)
2614 return -EBADMSG;
2615
2616 if (TLVP_LEN(tp, GSM0808_IE_CAUSE) > 1) {
2617 if (!gsm0808_cause_ext(buf[0]))
2618 return -EINVAL;
2619 return buf[1];
2620 }
2621
2622 return buf[0];
2623}
2624
Alexander Chemeris22630e62020-05-13 00:44:04 +03002625const char *gsm0808_diagnostics_octet_location_str(uint8_t pointer)
2626{
2627 switch (pointer) {
2628 case 0:
2629 return "Error location not determined";
2630 case 1:
2631 return "The first octet of the message received (i.e. the message type) was found erroneous (unknown)";
2632 case 0xfd:
2633 return "The first octet of the BSSAP header (Discrimination) was found erroneous";
2634 case 0xfe:
2635 return "(DTAP only) The DLCI (second) octet of the BSSAP header was found erroneous";
2636 case 0xff:
2637 return "The last octet of the BSSAP header (length indicator) was found erroneous";
2638 default:
2639 snprintf(str_buff, sizeof(str_buff), "The %d octet of the message received was found erroneous", pointer);
2640 return str_buff;
2641 }
2642}
2643
2644const char *gsm0808_diagnostics_bit_location_str(uint8_t bit_pointer)
2645{
2646 if (bit_pointer == 0) {
2647 return "No particular part of the octet is indicated";
2648 } else if (bit_pointer > 8) {
2649 return "Reserved value";
2650 }
2651
2652 snprintf(str_buff, sizeof(str_buff),
2653 "An error was provoked by the field whose most significant bit is in bit position %d",
2654 bit_pointer);
2655 return str_buff;
2656}
2657
Harald Welteebd362d2018-06-02 14:11:19 +02002658const struct value_string gsm0808_lcls_config_names[] = {
2659 { GSM0808_LCLS_CFG_BOTH_WAY, "Connect both-way" },
2660 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL,
2661 "Connect both-way, bi-cast UL to CN" },
2662 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL,
2663 "Connect both-way, send access DL from CN" },
2664 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL_BLOCK_LOCAL_DL,
2665 "Connect both-way, send access DL from CN, block local DL" },
2666 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL,
2667 "Connect both-way, bi-cast UL to CN, send access DL from CN" },
2668 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL_BLOCK_LOCAL_DL,
2669 "Connect both-way, bi-cast UL to CN, send access DL from CN, block local DL" },
Max961db7c2018-11-08 11:40:23 +01002670 { GSM0808_LCLS_CFG_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02002671 { 0, NULL }
2672};
2673
2674const struct value_string gsm0808_lcls_control_names[] = {
2675 { GSM0808_LCLS_CSC_CONNECT, "Connect" },
2676 { GSM0808_LCLS_CSC_DO_NOT_CONNECT, "Do not connect" },
2677 { GSM0808_LCLS_CSC_RELEASE_LCLS, "Release LCLS" },
2678 { GSM0808_LCLS_CSC_BICAST_UL_AT_HANDOVER, "Bi-cast UL at Handover" },
2679 { GSM0808_LCLS_CSC_BICAST_UL_AND_RECV_DL_AT_HANDOVER, "Bi-cast UL and receive DL at Handover" },
Max961db7c2018-11-08 11:40:23 +01002680 { GSM0808_LCLS_CSC_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02002681 { 0, NULL }
2682};
2683
2684const struct value_string gsm0808_lcls_status_names[] = {
2685 { GSM0808_LCLS_STS_NOT_YET_LS, "Call not yet locally switched" },
2686 { GSM0808_LCLS_STS_NOT_POSSIBLE_LS, "Call not possible to be locally switched" },
2687 { GSM0808_LCLS_STS_NO_LONGER_LS, "Call is no longer locally switched" },
2688 { GSM0808_LCLS_STS_REQ_LCLS_NOT_SUPP, "Requested LCLS configuration is not supported" },
2689 { GSM0808_LCLS_STS_LOCALLY_SWITCHED, "Call is locally switched with requested LCLS config" },
Max961db7c2018-11-08 11:40:23 +01002690 { GSM0808_LCLS_STS_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02002691 { 0, NULL }
2692};
2693
Neels Hofmeyr593d20d2022-09-07 02:26:47 +02002694/* Convert one S0-S15 bit to its set of AMR modes, for HR AMR and FR AMR.
2695 * This is 3GPP TS 28.062 Table 7.11.3.1.3-2: "Preferred Configurations", with some configurations removed as specified
2696 * in 3GPP TS 48.008 3.2.2.103:
2697 *
2698 * FR_AMR is coded ‘0011’.
2699 * S11, S13 and S15 are reserved and coded with zeroes.
2700 *
2701 * HR_AMR is coded ‘0100’.
2702 * S6 - S7 and S11 – S15 are reserved and coded with zeroes.
2703 *
2704 * Meaning: for FR, exclude all Optimisation Mode configurations.
2705 * For HR, exclude all that are not supported by HR AMR -- drop all that include at least one of
2706 * 10.2 or 12.2.
2707 *
2708 * Also, for HR, drop 12.2k from S1.
2709 *
2710 * The first array dimension is 0 for half rate and 1 for full rate.
2711 * The second array dimension is the configuration number (0..15) aka Sn.
2712 * The values are bitmask combinations of (1 << GSM0808_AMR_MODE_nnnn).
2713 *
2714 * For example, accumulate all modes that are possible in a given my_s15_s0:
2715 *
2716 * uint8_t modes = 0;
2717 * for (s_bit = 0; s_bit < 15; s_bit++)
2718 * if (my_s15_s0 & (1 << s_bit))
2719 * modes |= gsm0808_amr_modes_from_cfg[full_rate ? 1 : 0][s_bit];
2720 * for (i = 0; i < 8; i++)
2721 * if (modes & (1 << i))
2722 * printf(" %s", gsm0808_amr_mode_name(i));
2723 */
2724const uint8_t gsm0808_amr_modes_from_cfg[2][16] = {
2725#define B(X) (1 << (GSM0808_AMR_MODE_##X))
2726 /* HR */
2727 {
2728 /* Sn = modes */
2729 [0] = B(4_75),
2730 [1] = B(4_75) | B(5_90) | B(7_40),
2731 [2] = B(5_90),
2732 [3] = B(6_70),
2733 [4] = B(7_40),
2734 [5] = B(7_95),
2735 [6] = 0,
2736 [7] = 0,
2737
2738 [8] = B(4_75) | B(5_90),
2739 [9] = B(4_75) | B(5_90) | B(6_70),
2740 [10] = B(4_75) | B(5_90) | B(6_70) | B(7_40),
2741 [11] = 0,
2742 [12] = 0,
2743 [13] = 0,
2744 [14] = 0,
2745 [15] = 0,
2746 },
2747 /* FR */
2748 {
2749 /* Sn = modes */
2750 [0] = B(4_75),
2751 [1] = B(4_75) | B(5_90) | B(7_40) | B(12_2),
2752 [2] = B(5_90),
2753 [3] = B(6_70),
2754 [4] = B(7_40),
2755 [5] = B(7_95),
2756 [6] = B(10_2),
2757 [7] = B(12_2),
2758
2759 [8] = B(4_75) | B(5_90),
2760 [9] = B(4_75) | B(5_90) | B(6_70),
2761 [10] = B(4_75) | B(5_90) | B(6_70) | B(7_40),
2762 [11] = 0,
2763 [12] = B(4_75) | B(5_90) | B(6_70) | B(10_2),
2764 [13] = 0,
2765 [14] = B(4_75) | B(5_90) | B(7_95) | B(12_2),
2766 [15] = 0,
2767 }
2768};
2769
2770/* AMR mode names from GSM0808_AMR_MODE_*, for use with gsm0808_amr_modes_from_cfg.
2771 *
2772 * For example:
2773 * printf("S9: ");
2774 * uint8_t s9_modes = gsm0808_amr_modes_from_cfg[full_rate ? 1 : 0][9];
2775 * for (bit = 0; bit < 8; bit++)
2776 * if (s9_modes & (1 << bit))
2777 * printf("%s,", gsm0808_amr_mode_name(bit));
2778 */
2779const struct value_string gsm0808_amr_mode_names[] = {
2780 { GSM0808_AMR_MODE_4_75, "4.75" },
2781 { GSM0808_AMR_MODE_5_15, "5.15" },
2782 { GSM0808_AMR_MODE_5_90, "5.90" },
2783 { GSM0808_AMR_MODE_6_70, "6.70" },
2784 { GSM0808_AMR_MODE_7_40, "7.40" },
2785 { GSM0808_AMR_MODE_7_95, "7.95" },
2786 { GSM0808_AMR_MODE_10_2, "10.2" },
2787 { GSM0808_AMR_MODE_12_2, "12.2" },
2788 {}
2789};
2790
Harald Welte96e2a002017-06-12 21:44:18 +02002791/*! @} */