blob: 01c3cee504e231a7ef2f79df2ba28b9ce93ea038 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*
2 * (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02003 * (C) 2009,2010 by On-Waves
4 * All Rights Reserved
5 *
Harald Weltee08da972017-11-13 01:00:26 +09006 * SPDX-License-Identifier: GPL-2.0+
7 *
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02008 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
23
Alexander Chemeris22630e62020-05-13 00:44:04 +030024#include <string.h>
25
Harald Welte95871da2017-05-15 12:11:36 +020026#include <osmocom/core/byteswap.h>
Philipp Maier2908dbf2020-06-05 14:16:11 +020027#include <osmocom/core/endian.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010028#include <osmocom/gsm/gsm0808.h>
Neels Hofmeyr5b214e22020-09-18 18:00:50 +020029#include <osmocom/gsm/gsm0808_lcs.h>
Philipp Maierfa896ab2017-03-27 16:55:32 +020030#include <osmocom/gsm/gsm0808_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010031#include <osmocom/gsm/protocol/gsm_08_08.h>
32#include <osmocom/gsm/gsm48.h>
Neels Hofmeyr5b214e22020-09-18 18:00:50 +020033#include <osmocom/gsm/gad.h>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020034
Harald Welte96e2a002017-06-12 21:44:18 +020035/*! \addtogroup gsm0808
36 * @{
Harald Welte37b61652017-10-16 18:46:03 +020037 * \file gsm0808.c
38 * Helper functions regarding the TS 08.08 / 48.008 A interface, primarily
39 * message generation/encoding.
Harald Welte96e2a002017-06-12 21:44:18 +020040 */
41
Alexander Chemeris22630e62020-05-13 00:44:04 +030042/*! Char buffer to return strings from functions */
43static __thread char str_buff[512];
44
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010045/*! Create "Complete L3 Info" for AoIP, legacy implementation.
46 * Instead use gsm0808_create_layer3_aoip2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +020047 * \param[in] msg_l3 msgb containing Layer 3 Message
48 * \param[in] nc Mobile Network Code
49 * \param[in] cc Mobile Country Code
50 * \param[in] lac Location Area Code
51 * \param[in] _ci Cell Identity
52 * \param[in] scl Speech Codec List
53 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +020054struct msgb *gsm0808_create_layer3_aoip(const struct msgb *msg_l3, uint16_t nc,
55 uint16_t cc, int lac, uint16_t _ci,
56 const struct gsm0808_speech_codec_list
57 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020058{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010059 struct osmo_cell_global_id cgi = {
60 .lai = {
61 .plmn = {
62 .mcc = cc,
63 .mnc = nc,
64 },
65 .lac = lac,
66 },
67 .cell_identity = _ci,
68 };
69 return gsm0808_create_layer3_2(msg_l3, &cgi, scl);
70}
71
72/*! Create "Complete L3 Info" for AoIP.
73 * \param[in] msg_l3 msgb containing Layer 3 Message -- not modified by this call.
74 * \param[in] cell MCC, MNC, LAC, CI to identify the cell.
75 * \param[in] scl Speech Codec List, optional.
76 * \returns newly allocated msgb with Complete L3 Info message */
77struct msgb *gsm0808_create_layer3_2(const struct msgb *msg_l3, const struct osmo_cell_global_id *cell,
78 const struct gsm0808_speech_codec_list *scl)
79{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020080 struct msgb* msg;
Harald Welte65c2d362012-01-21 14:26:01 +010081 struct {
82 uint8_t ident;
83 struct gsm48_loc_area_id lai;
84 uint16_t ci;
85 } __attribute__ ((packed)) lai_ci;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020086
87 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
88 "bssmap cmpl l3");
89 if (!msg)
90 return NULL;
91
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020092 /* create layer 3 header */
Harald Welte65c2d362012-01-21 14:26:01 +010093 msgb_v_put(msg, BSS_MAP_MSG_COMPLETE_LAYER_3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020094
95 /* create the cell header */
Harald Welte65c2d362012-01-21 14:26:01 +010096 lai_ci.ident = CELL_IDENT_WHOLE_GLOBAL;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010097 gsm48_generate_lai2(&lai_ci.lai, &cell->lai);
98 lai_ci.ci = osmo_htons(cell->cell_identity);
Harald Welte65c2d362012-01-21 14:26:01 +010099 msgb_tlv_put(msg, GSM0808_IE_CELL_IDENTIFIER, sizeof(lai_ci),
100 (uint8_t *) &lai_ci);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200101
102 /* copy the layer3 data */
Harald Welte65c2d362012-01-21 14:26:01 +0100103 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION,
104 msgb_l3len(msg_l3), msg_l3->l3h);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200105
Philipp Maierfa896ab2017-03-27 16:55:32 +0200106 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
107 if (scl)
108 gsm0808_enc_speech_codec_list(msg, scl);
109
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;
114}
115
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100116/*! Create "Complete L3 Info" for A, legacy implementation.
117 * Instead use gsm0808_create_layer3_2() with the scl parameter passed as NULL,
118 * which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200119 * \param[in] msg_l3 msgb containing Layer 3 Message
120 * \param[in] nc Mobile Network Code
121 * \param[in] cc Mobile Country Code
122 * \param[in] lac Location Area Code
123 * \param[in] _ci Cell Identity
124 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200125struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
126 uint16_t cc, int lac, uint16_t _ci)
127{
Neels Hofmeyr4eeb8082018-03-23 01:47:14 +0100128 struct osmo_cell_global_id cgi = {
129 .lai = {
130 .plmn = {
131 .mcc = cc,
132 .mnc = nc,
133 },
134 .lac = lac,
135 },
136 .cell_identity = _ci,
137 };
138 return gsm0808_create_layer3_2(msg_l3, &cgi, NULL);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200139}
140
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200141/*! Create BSSMAP RESET message
Harald Welte96e2a002017-06-12 21:44:18 +0200142 * \returns callee-allocated msgb with BSSMAP Reset message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200143struct msgb *gsm0808_create_reset(void)
144{
Harald Welte65c2d362012-01-21 14:26:01 +0100145 uint8_t cause = GSM0808_CAUSE_EQUIPMENT_FAILURE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200146 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
147 "bssmap: reset");
148 if (!msg)
149 return NULL;
150
Harald Welte65c2d362012-01-21 14:26:01 +0100151 msgb_v_put(msg, BSS_MAP_MSG_RESET);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100152 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100153 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
154
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200155 return msg;
156}
157
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200158/*! Create BSSMAP RESET ACK message
Harald Welte96e2a002017-06-12 21:44:18 +0200159 * \returns callee-allocated msgb with BSSMAP Reset ACK message */
Harald Weltea62fe312013-06-19 15:14:37 +0200160struct msgb *gsm0808_create_reset_ack(void)
161{
162 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
163 "bssmap: reset ack");
164 if (!msg)
165 return NULL;
166
167 msgb_v_put(msg, BSS_MAP_MSG_RESET_ACKNOWLEDGE);
168 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
169
170 return msg;
171}
172
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200173/*! Create BSSMAP Clear Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200174 * \returns callee-allocated msgb with BSSMAP Clear Complete message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200175struct msgb *gsm0808_create_clear_complete(void)
176{
177 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
178 "bssmap: clear complete");
Harald Welte65c2d362012-01-21 14:26:01 +0100179 uint8_t val = BSS_MAP_MSG_CLEAR_COMPLETE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200180 if (!msg)
181 return NULL;
182
Harald Welte65c2d362012-01-21 14:26:01 +0100183 msg->l3h = msg->data;
184 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200185
186 return msg;
187}
188
Harald Welted1365e12019-02-18 13:44:30 +0100189/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
190 * This is quite different from most (all?) other gsm0808_create_* which have l3h
191 * point to the BSSAP header. However, we have to keep this for backwards compatibility.
192 * Use gsm0808_create_clear_command2() for a 'modern' implementation.
Philipp Maier1a146c82018-10-30 09:36:49 +0100193 * \param[in] cause TS 08.08 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200194 * \returns callee-allocated msgb with BSSMAP Clear Command message */
Philipp Maier1a146c82018-10-30 09:36:49 +0100195struct msgb *gsm0808_create_clear_command(uint8_t cause)
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200196{
197 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
198 "bssmap: clear command");
199 if (!msg)
200 return NULL;
201
Holger Hans Peter Freytheraeebe392010-10-27 12:36:05 +0200202 msg->l3h = msgb_tv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 4);
203 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100204 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100205
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200206 return msg;
207}
208
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100209/*! Create BSSMAP Clear Command message.
210 * \param[in] cause TS 08.08 cause value.
211 * \param[in] csfb_ind indicate that the call was established in an CSFB context.
212 * \returns callee-allocated msgb with BSSMAP Clear Command message. */
213struct msgb *gsm0808_create_clear_command2(uint8_t cause, bool csfb_ind)
214{
Harald Welte10ba47d2019-02-18 12:36:54 +0100215 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
216 "bssmap: clear command");
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100217 if (!msg)
218 return NULL;
219
Harald Welte10ba47d2019-02-18 12:36:54 +0100220 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
221 gsm0808_enc_cause(msg, cause);
222
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100223 if (csfb_ind)
224 msgb_v_put(msg, GSM0808_IE_CSFB_INDICATION);
225
Harald Welte10ba47d2019-02-18 12:36:54 +0100226 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
227
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100228 return msg;
229}
230
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200231/*! Create BSSMAP Cipher Mode Command message
Harald Welte96e2a002017-06-12 21:44:18 +0200232 * \param[in] ei Mandatory Encryption Information
233 * \param[in] cipher_response_mode optional 1-byte Cipher Response Mode
234 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
Philipp Maierb478dd32017-03-29 15:50:05 +0200235struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,
236 const uint8_t *cipher_response_mode)
237{
238 /* See also: 3GPP TS 48.008 3.2.1.30 CIPHER MODE COMMAND */
239 struct msgb *msg;
240
241 /* Mandatory emelent! */
242 OSMO_ASSERT(ei);
243
244 msg =
245 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
246 "cipher-mode-command");
247 if (!msg)
248 return NULL;
249
250 /* Message Type 3.2.2.1 */
251 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_CMD);
252
253 /* Encryption Information 3.2.2.10 */
254 gsm0808_enc_encrypt_info(msg, ei);
255
256 /* Cipher Response Mode 3.2.2.34 */
257 if (cipher_response_mode)
258 msgb_tv_put(msg, GSM0808_IE_CIPHER_RESPONSE_MODE,
259 *cipher_response_mode);
260
261 /* pre-pend the header */
262 msg->l3h =
263 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
264
265 return msg;
266}
267
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200268/*! Create BSSMAP Cipher Mode Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200269 * \param[in] layer3 L3 Message to be included
270 * \param[in] alg_id Chosen Encrpytion Algorithm
271 * \returns callee-allocated msgb with BSSMAP Cipher Mode Complete message */
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200272struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id)
273{
274 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
275 "cipher-complete");
276 if (!msg)
277 return NULL;
278
279 /* send response with BSS override for A5/1... cheating */
Harald Welte65c2d362012-01-21 14:26:01 +0100280 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_COMPLETE);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200281
282 /* include layer3 in case we have at least two octets */
283 if (layer3 && msgb_l3len(layer3) > 2) {
Harald Welte65c2d362012-01-21 14:26:01 +0100284 msg->l4h = msgb_tlv_put(msg, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS,
285 msgb_l3len(layer3), layer3->l3h);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200286 }
287
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700288 /* Optional Chosen Encryption Algorithm IE */
289 if (alg_id > 0)
290 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, alg_id);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200291
Harald Welte65c2d362012-01-21 14:26:01 +0100292 /* pre-pend the header */
293 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
294
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200295 return msg;
296}
297
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200298/*! Create BSSMAP Cipher Mode Reject message
Maxaa934632018-11-07 13:16:54 +0100299 * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200300 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
Maxaa934632018-11-07 13:16:54 +0100301struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200302{
303 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
Maxaa934632018-11-07 13:16:54 +0100304 "bssmap: cipher mode reject");
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200305 if (!msg)
306 return NULL;
307
Harald Welte62e40852017-12-17 20:50:34 +0100308 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
Maxaa934632018-11-07 13:16:54 +0100309
Philipp Maier4f4905f2018-11-30 13:36:12 +0100310 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100311
312 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200313
314 return msg;
315}
316
Maxed651d22018-11-07 15:25:05 +0100317/*! Create BSSMAP Cipher Mode Reject message
318 * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class
319 * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)
320 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
321struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)
322{
Philipp Maier4f4905f2018-11-30 13:36:12 +0100323 uint16_t cause;
Maxed651d22018-11-07 15:25:05 +0100324 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
325 "bssmap: cipher mode reject");
326 if (!msg)
327 return NULL;
328
Philipp Maier4f4905f2018-11-30 13:36:12 +0100329 /* Set cause code class in the upper byte */
330 cause = 0x80 | (class << 4);
331 cause = cause << 8;
332
333 /* Set cause code extension in the lower byte */
334 cause |= ext;
Maxed651d22018-11-07 15:25:05 +0100335
336 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
337
Philipp Maier4f4905f2018-11-30 13:36:12 +0100338 gsm0808_enc_cause(msg, cause);
Maxed651d22018-11-07 15:25:05 +0100339
340 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
341
342 return msg;
343}
344
Harald Welte64e807c2018-05-29 21:00:56 +0200345/*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).
346 * \param[in] config LCLS Configuration
347 * \param[in] control LCLS Connection Status Control
348 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
Max45f89c92018-12-19 19:35:26 +0100349struct msgb *gsm0808_create_lcls_conn_ctrl(enum gsm0808_lcls_config config,
350 enum gsm0808_lcls_control control)
Harald Welte64e807c2018-05-29 21:00:56 +0200351{
Max45f89c92018-12-19 19:35:26 +0100352 struct msgb *msg;
353
354 /* According to NOTE 1 in §3.2.1.91 at least one of the parameters is required */
355 if (config == GSM0808_LCLS_CFG_NA && control == GSM0808_LCLS_CSC_NA)
356 return NULL;
357
358 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "bssmap: LCLS CONN CTRL");
Harald Welte64e807c2018-05-29 21:00:56 +0200359 if (!msg)
360 return NULL;
361
362 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL);
Max45f89c92018-12-19 19:35:26 +0100363 if (config != GSM0808_LCLS_CFG_NA)
364 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, config);
365 if (control != GSM0808_LCLS_CSC_NA)
366 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, control);
Harald Welte64e807c2018-05-29 21:00:56 +0200367 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
368
369 return msg;
370}
371
372/*! Create BSSMAP LCLS CONNECT CONTROL ACK message (TS 48.008 3.2.1.92).
373 * \param[in] status LCLS BSS Status
374 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
375struct msgb *gsm0808_create_lcls_conn_ctrl_ack(enum gsm0808_lcls_status status)
376{
377 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
378 "bssmap: LCLS CONN CTRL ACK");
379 if (!msg)
380 return NULL;
381
382 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK);
383 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
384 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
385
386 return msg;
387}
388
389/*! Create BSSMAP LCLS NOTIFICATION message (TS 48.008 3.2.1.93).
390 * \param[in] status LCLS BSS Status
391 * \param[in] break_req Include the LCLS BREAK REQ IE (true) or not (false)
392 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
393struct msgb *gsm0808_create_lcls_notification(enum gsm0808_lcls_status status, bool break_req)
394{
395 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
396 "bssmap: LCLS NOTIFICATION");
397 if (!msg)
398 return NULL;
399
400 msgb_v_put(msg, BSS_MAP_MSG_LCLS_NOTIFICATION);
401 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
402 if (break_req)
403 msgb_v_put(msg, GSM0808_IE_LCLS_BREAK_REQ);
404 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
405
406 return msg;
407}
408
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200409/*! Create BSSMAP Classmark Request message
410 * \returns callee-allocated msgb with BSSMAP Classmark Request message */
411struct msgb *gsm0808_create_classmark_request()
412{
413 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
414 "classmark-request");
415 if (!msg)
416 return NULL;
417
418 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_RQST);
419 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
420 return msg;
421}
Harald Welte64e807c2018-05-29 21:00:56 +0200422
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200423/*! Create BSSMAP Classmark Update message
Harald Welte96e2a002017-06-12 21:44:18 +0200424 * \param[in] cm2 Classmark 2
425 * \param[in] cm2_len length (in octets) of \a cm2
426 * \param[in] cm3 Classmark 3
427 * \param[in] cm3_len length (in octets) of \a cm3
428 * \returns callee-allocated msgb with BSSMAP Classmark Update message */
Harald Welte07b625d2012-01-23 10:02:58 +0100429struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,
430 const uint8_t *cm3, uint8_t cm3_len)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200431{
432 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
433 "classmark-update");
434 if (!msg)
435 return NULL;
436
Harald Welte65c2d362012-01-21 14:26:01 +0100437 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_UPDATE);
Harald Welte07b625d2012-01-23 10:02:58 +0100438 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2, cm2_len, cm2);
439 if (cm3)
440 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
441 cm3_len, cm3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200442
Harald Welte65c2d362012-01-21 14:26:01 +0100443 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
444
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200445 return msg;
446}
447
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200448/*! Create BSSMAP SAPI N Reject message
Harald Welte96e2a002017-06-12 21:44:18 +0200449 * \param[in] link_id Link Identifier
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700450 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
Harald Welte96e2a002017-06-12 21:44:18 +0200451 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700452struct msgb *gsm0808_create_sapi_reject_cause(uint8_t link_id, uint16_t cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200453{
454 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
455 "bssmap: sapi 'n' reject");
456 if (!msg)
457 return NULL;
458
Harald Welte65c2d362012-01-21 14:26:01 +0100459 msgb_v_put(msg, BSS_MAP_MSG_SAPI_N_REJECT);
Alexander Chemerisa5b1b862020-05-12 01:03:08 +0300460 msgb_tv_put(msg, GSM0808_IE_DLCI, link_id);
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700461 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100462
463 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200464
465 return msg;
466}
467
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700468/*! Create BSSMAP SAPI N Reject message (with hard-coded cause "BSS not equipped").
469 * DEPRECATED: use gsm0808_create_sapi_reject_cause() instead.
470 * \param[in] link_id Link Identifier
471 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
472 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
473struct msgb *gsm0808_create_sapi_reject(uint8_t link_id)
474{
475 return gsm0808_create_sapi_reject_cause(link_id, GSM0808_CAUSE_BSS_NOT_EQUIPPED);
476}
477
Max52074322018-11-30 10:44:07 +0100478/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
479 * This is identical to gsm0808_create_ass(), but adds KC and LCLS IEs.
Harald Welte96e2a002017-06-12 21:44:18 +0200480 * \param[in] ct Channel Type
481 * \param[in] cic Circuit Identity Code (Classic A only)
482 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
483 * \param[in] scl Speech Codec List (AoIP only)
Max49c06682018-11-21 22:10:26 +0100484 * \param[in] ci Call Identifier (Optional), §3.2.2.105
Max52074322018-11-30 10:44:07 +0100485 * \param[in] kc Kc128 ciphering key (Optional, A5/4), §3.2.2.109
486 * \param[in] lcls Optional LCLS parameters
Harald Welte96e2a002017-06-12 21:44:18 +0200487 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
Max52074322018-11-30 10:44:07 +0100488struct msgb *gsm0808_create_ass2(const struct gsm0808_channel_type *ct,
489 const uint16_t *cic,
490 const struct sockaddr_storage *ss,
491 const struct gsm0808_speech_codec_list *scl,
492 const uint32_t *ci,
493 const uint8_t *kc, const struct osmo_lcls *lcls)
Philipp Maierc6144a22017-03-29 17:53:43 +0200494{
495 /* See also: 3GPP TS 48.008 3.2.1.1 ASSIGNMENT REQUEST */
496 struct msgb *msg;
Philipp Maierc6144a22017-03-29 17:53:43 +0200497
498 /* Mandatory emelent! */
499 OSMO_ASSERT(ct);
500
501 msg =
502 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
503 "bssmap: ass req");
504 if (!msg)
505 return NULL;
506
507 /* Message Type 3.2.2.1 */
508 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_RQST);
509
510 /* Channel Type 3.2.2.11 */
511 gsm0808_enc_channel_type(msg, ct);
512
513 /* Circuit Identity Code 3.2.2.2 */
Vadim Yanitskiy1c4fc222021-02-05 03:58:24 +0100514 if (cic)
515 msgb_tv16_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE, *cic);
Philipp Maierc6144a22017-03-29 17:53:43 +0200516
517 /* AoIP: AoIP Transport Layer Address (MGW) 3.2.2.102 */
518 if (ss) {
519 gsm0808_enc_aoip_trasp_addr(msg, ss);
520 }
521
522 /* AoIP: Codec List (MSC Preferred) 3.2.2.103 */
523 if (scl)
524 gsm0808_enc_speech_codec_list(msg, scl);
525
526 /* AoIP: Call Identifier 3.2.2.105 */
527 if (ci) {
Philipp Maier2908dbf2020-06-05 14:16:11 +0200528 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
Vadim Yanitskiy1c4fc222021-02-05 03:58:24 +0100529 * the least significant byte shall be transmitted first. */
530 msgb_v_put(msg, GSM0808_IE_CALL_ID);
531 osmo_store32le(*ci, msgb_put(msg, sizeof(*ci)));
Philipp Maierc6144a22017-03-29 17:53:43 +0200532 }
533
Max52074322018-11-30 10:44:07 +0100534 if (kc)
535 msgb_tv_fixed_put(msg, GSM0808_IE_KC_128, 16, kc);
536
Max47022152018-12-19 18:51:00 +0100537 if (lcls)
538 gsm0808_enc_lcls(msg, lcls);
Max52074322018-11-30 10:44:07 +0100539
Philipp Maierc6144a22017-03-29 17:53:43 +0200540 /* push the bssmap header */
541 msg->l3h =
542 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
543
544 return msg;
545}
546
Max52074322018-11-30 10:44:07 +0100547/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
548 * \param[in] ct Channel Type
549 * \param[in] cic Circuit Identity Code (Classic A only)
550 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
551 * \param[in] scl Speech Codec List (AoIP only)
552 * \param[in] ci Call Identifier (Optional), §3.2.2.105
553 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
554struct msgb *gsm0808_create_ass(const struct gsm0808_channel_type *ct,
555 const uint16_t *cic,
556 const struct sockaddr_storage *ss,
557 const struct gsm0808_speech_codec_list *scl,
558 const uint32_t *ci)
559{
560 return gsm0808_create_ass2(ct, cic, ss, scl, ci, NULL, NULL);
561}
562
Max414c8f52019-01-08 14:44:24 +0100563/*! Create BSSMAP Assignment Completed message as per 3GPP TS 48.008 §3.2.1.2
Harald Welte96e2a002017-06-12 21:44:18 +0200564 * \param[in] rr_cause GSM 04.08 RR Cause value
565 * \param[in] chosen_channel Chosen Channel
566 * \param[in] encr_alg_id Encryption Algorithm ID
567 * \param[in] speech_mode Speech Mode
568 * \param[in] ss Socket Address of BSS-side RTP socket
569 * \param[in] sc Speech Codec (current)
570 * \param[in] scl Speech Codec List (permitted)
Max414c8f52019-01-08 14:44:24 +0100571 * \param[in] lcls_bss_status §3.2.2.119 LCLS-BSS-Status, optional
Harald Welte96e2a002017-06-12 21:44:18 +0200572 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Max414c8f52019-01-08 14:44:24 +0100573struct msgb *gsm0808_create_ass_compl2(uint8_t rr_cause, uint8_t chosen_channel,
Philipp Maierfa896ab2017-03-27 16:55:32 +0200574 uint8_t encr_alg_id, uint8_t speech_mode,
575 const struct sockaddr_storage *ss,
576 const struct gsm0808_speech_codec *sc,
Max414c8f52019-01-08 14:44:24 +0100577 const struct gsm0808_speech_codec_list *scl,
578 enum gsm0808_lcls_status lcls_bss_status)
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200579{
Harald Welte65c2d362012-01-21 14:26:01 +0100580 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
581 "bssmap: ass compl");
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200582 if (!msg)
583 return NULL;
584
Harald Welte65c2d362012-01-21 14:26:01 +0100585 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_COMPLETE);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200586
587 /* write 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100588 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, rr_cause);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200589
590 /* write cirtcuit identity code 3.2.2.2 */
591 /* write cell identifier 3.2.2.17 */
592 /* write chosen channel 3.2.2.33 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100593 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, chosen_channel);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200594
595 /* write chosen encryption algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700596 if (encr_alg_id > 0)
597 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, encr_alg_id);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200598
599 /* write circuit pool 3.2.2.45 */
600 /* write speech version chosen: 3.2.2.51 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100601 if (speech_mode != 0)
602 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, speech_mode);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200603
Philipp Maierfa896ab2017-03-27 16:55:32 +0200604 /* AoIP: AoIP Transport Layer Address (BSS) 3.2.2.102 */
605 if (ss)
606 gsm0808_enc_aoip_trasp_addr(msg, ss);
607
608 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
609 if (sc)
610 gsm0808_enc_speech_codec(msg, sc);
611
612 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
613 if (scl)
614 gsm0808_enc_speech_codec_list(msg, scl);
615
Max414c8f52019-01-08 14:44:24 +0100616 /* FIXME: write LSA identifier 3.2.2.15 - see 3GPP TS 43.073 */
617
618 /* LCLS-BSS-Status 3.2.2.119 */
619 if (lcls_bss_status != GSM0808_LCLS_STS_NA)
620 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, lcls_bss_status);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200621
Harald Welte65c2d362012-01-21 14:26:01 +0100622 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200623
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200624 return msg;
625}
626
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200627/*! Create BSSMAP Assignment Completed message
Harald Welte96e2a002017-06-12 21:44:18 +0200628 * \param[in] rr_cause GSM 04.08 RR Cause value
629 * \param[in] chosen_channel Chosen Channel
630 * \param[in] encr_alg_id Encryption Algorithm ID
631 * \param[in] speech_mode Speech Mode
Max414c8f52019-01-08 14:44:24 +0100632 * \param[in] ss Socket Address of BSS-side RTP socket
633 * \param[in] sc Speech Codec (current)
634 * \param[in] scl Speech Codec List (permitted)
635 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
636struct msgb *gsm0808_create_ass_compl(uint8_t rr_cause, uint8_t chosen_channel,
637 uint8_t encr_alg_id, uint8_t speech_mode,
638 const struct sockaddr_storage *ss,
639 const struct gsm0808_speech_codec *sc,
640 const struct gsm0808_speech_codec_list *scl)
641{
642 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id, speech_mode,
643 ss, sc, scl, GSM0808_LCLS_STS_NA);
644}
645
646/*! Create BSSMAP Assignment Completed message
647 * \param[in] rr_cause GSM 04.08 RR Cause value
648 * \param[in] chosen_channel Chosen Channel
649 * \param[in] encr_alg_id Encryption Algorithm ID
650 * \param[in] speech_mode Speech Mode
Harald Welte96e2a002017-06-12 21:44:18 +0200651 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200652struct msgb *gsm0808_create_assignment_completed(uint8_t rr_cause,
653 uint8_t chosen_channel,
654 uint8_t encr_alg_id,
655 uint8_t speech_mode)
656{
Max414c8f52019-01-08 14:44:24 +0100657 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id,
658 speech_mode, NULL, NULL, NULL, GSM0808_LCLS_STS_NA);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200659}
660
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200661/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200662 * \param[in] cause BSSMAP Cause value
663 * \param[in] rr_cause GSM 04.08 RR Cause value
664 * \param[in] scl Optional Speech Cdec List (AoIP)
665 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200666struct msgb *gsm0808_create_ass_fail(uint8_t cause, const uint8_t *rr_cause,
667 const struct gsm0808_speech_codec_list
668 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200669{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200670 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
671 "bssmap: ass fail");
672 if (!msg)
673 return NULL;
674
Harald Welte65c2d362012-01-21 14:26:01 +0100675 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_FAILURE);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100676 gsm0808_enc_cause(msg, cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200677
678 /* RR cause 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100679 if (rr_cause)
680 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, *rr_cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200681
682 /* Circuit pool 3.22.45 */
683 /* Circuit pool list 3.2.2.46 */
684
Philipp Maierfa896ab2017-03-27 16:55:32 +0200685 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
686 if (scl)
687 gsm0808_enc_speech_codec_list(msg, scl);
688
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200689 /* update the size */
Harald Welte65c2d362012-01-21 14:26:01 +0100690 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
691
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200692 return msg;
693}
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +0200694
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200695/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200696 * \param[in] cause BSSMAP Cause value
697 * \param[in] rr_cause GSM 04.08 RR Cause value
698 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200699struct msgb *gsm0808_create_assignment_failure(uint8_t cause,
700 uint8_t *rr_cause)
701{
702 return gsm0808_create_ass_fail(cause, rr_cause, NULL);
703}
704
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200705/*! Create BSSMAP Clear Request message
Harald Welte96e2a002017-06-12 21:44:18 +0200706 * \param[in] cause BSSMAP Cause value
707 * \returns callee-allocated msgb with BSSMAP Clear Request message */
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100708struct msgb *gsm0808_create_clear_rqst(uint8_t cause)
709{
710 struct msgb *msg;
711
712 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
713 "bssmap: clear rqst");
714 if (!msg)
715 return NULL;
716
Harald Welte65c2d362012-01-21 14:26:01 +0100717 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_RQST);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100718 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100719 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100720
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100721 return msg;
722}
723
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200724/*! Create BSSMAP PAGING message
Harald Welte96e2a002017-06-12 21:44:18 +0200725 * \param[in] imsi Mandatory paged IMSI in string representation
726 * \param[in] tmsi Optional paged TMSI
Stefan Sperling3953f412018-08-28 15:06:30 +0200727 * \param[in] cil Mandatory Cell Identity List (where to page)
Harald Welte96e2a002017-06-12 21:44:18 +0200728 * \param[in] chan_needed Channel Type needed
729 * \returns callee-allocated msgb with BSSMAP PAGING message */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100730struct msgb *gsm0808_create_paging2(const char *imsi, const uint32_t *tmsi,
731 const struct gsm0808_cell_id_list2 *cil,
732 const uint8_t *chan_needed)
Philipp Maier3d48ec02017-03-29 17:37:55 +0200733{
734 struct msgb *msg;
Harald Weltea13fb752020-06-16 08:44:42 +0200735 uint8_t mid_buf[GSM48_MI_SIZE + 2];
736 int mid_len;
Philipp Maier3d48ec02017-03-29 17:37:55 +0200737 uint32_t tmsi_sw;
738
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100739 /* Mandatory elements! */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200740 OSMO_ASSERT(imsi);
741 OSMO_ASSERT(cil);
742
743 /* Malformed IMSI */
744 OSMO_ASSERT(strlen(imsi) <= GSM48_MI_SIZE);
745
746 msg =
747 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "paging");
748 if (!msg)
749 return NULL;
750
751 /* Message Type 3.2.2.1 */
752 msgb_v_put(msg, BSS_MAP_MSG_PAGING);
753
Stefan Sperling3953f412018-08-28 15:06:30 +0200754 /* mandatory IMSI 3.2.2.6 */
Harald Weltea13fb752020-06-16 08:44:42 +0200755 mid_len = gsm48_generate_mid_from_imsi(mid_buf, imsi);
756 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200757
758 /* TMSI 3.2.2.7 */
759 if (tmsi) {
Harald Welte95871da2017-05-15 12:11:36 +0200760 tmsi_sw = osmo_htonl(*tmsi);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200761 msgb_tlv_put(msg, GSM0808_IE_TMSI, sizeof(*tmsi),
762 (uint8_t *) & tmsi_sw);
763 }
764
Stefan Sperling3953f412018-08-28 15:06:30 +0200765 /* mandatory Cell Identifier List 3.2.2.27 */
766 gsm0808_enc_cell_id_list2(msg, cil);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200767
768 /* Channel Needed 3.2.2.36 */
769 if (chan_needed) {
770 msgb_tv_put(msg, GSM0808_IE_CHANNEL_NEEDED,
771 (*chan_needed) & 0x03);
772 }
773
774 /* pre-pend the header */
775 msg->l3h =
776 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
777
778 return msg;
779}
780
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100781/*! DEPRECATED: Use gsm0808_create_paging2 instead.
782 * Create BSSMAP PAGING message.
783 * \param[in] imsi Mandatory paged IMSI in string representation
784 * \param[in] tmsi Optional paged TMSI
785 * \param[in] cil Cell Identity List (where to page)
786 * \param[in] chan_needed Channel Type needed
787 * \returns callee-allocated msgb with BSSMAP PAGING message */
788struct msgb *gsm0808_create_paging(const char *imsi, const uint32_t *tmsi,
789 const struct gsm0808_cell_id_list *cil,
790 const uint8_t *chan_needed)
791{
792 struct gsm0808_cell_id_list2 cil2 = {};
793
794 /* Mandatory emelents! */
795 OSMO_ASSERT(cil);
796
797 if (cil->id_list_len > GSM0808_CELL_ID_LIST2_MAXLEN)
798 return NULL;
799
800 cil2.id_discr = cil->id_discr;
801 memcpy(cil2.id_list, cil->id_list_lac, cil->id_list_len * sizeof(cil2.id_list[0].lac));
802 cil2.id_list_len = cil->id_list_len;
803
804 return gsm0808_create_paging2(imsi, tmsi, &cil2, chan_needed);
805}
806
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100807static uint8_t put_old_bss_to_new_bss_information(struct msgb *msg,
808 const struct gsm0808_old_bss_to_new_bss_info *i)
809{
810 uint8_t *old_tail;
811 uint8_t *tlv_len;
812
813 msgb_put_u8(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION);
814 tlv_len = msgb_put(msg, 1);
815 old_tail = msg->tail;
816
817 if (i->extra_information_present) {
818 uint8_t val = 0;
819 if (i->extra_information.prec)
820 val |= 1 << 0;
821 if (i->extra_information.lcs)
822 val |= 1 << 1;
823 if (i->extra_information.ue_prob)
824 val |= 1 << 2;
825 msgb_tlv_put(msg, GSM0808_FE_IE_EXTRA_INFORMATION, 1, &val);
826 }
827
828 if (i->current_channel_type_2_present) {
829 uint8_t val[2] = {
830 i->current_channel_type_2.mode,
831 i->current_channel_type_2.field,
832 };
833 msgb_tlv_put(msg, GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2, 2, val);
834 }
835
Pau Espin Pedrol1b625cb2021-04-14 21:27:31 +0200836 if (i->last_eutran_plmn_id_present) {
837 msgb_put_u8(msg, GSM0808_FE_IE_LAST_USED_EUTRAN_PLMN_ID);
838 osmo_plmn_to_bcd(msgb_put(msg, 3), &i->last_eutran_plmn_id);
839 }
840
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100841 *tlv_len = (uint8_t) (msg->tail - old_tail);
842 return *tlv_len + 2;
843}
844
845/*! Create BSSMAP HANDOVER REQUIRED message.
846 * \param[in] params All information to be encoded.
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200847 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED message. */
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100848struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params)
849{
850 struct msgb *msg;
851
852 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED");
853 if (!msg)
854 return NULL;
855
856 /* Message Type, 3.2.2.1 */
857 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED);
858
859 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +0100860 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100861
862 /* Cell Identifier List, 3.2.2.27 */
863 gsm0808_enc_cell_id_list2(msg, &params->cil);
864
865 /* Current Channel Type 1, 3.2.2.49 */
866 if (params->current_channel_type_1_present)
867 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
868
869 /* Speech Version (Used), 3.2.2.51 */
870 if (params->speech_version_used_present)
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200871 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100872
873 if (params->old_bss_to_new_bss_info_present)
874 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
875
876 /* pre-pend the header */
877 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
878
879 return msg;
880}
881
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100882/*! Create BSSMAP HANDOVER REQUIRED REJECT message.
883 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED REJECT message. */
884struct msgb *gsm0808_create_handover_required_reject(const struct gsm0808_handover_required_reject *params)
885{
886 struct msgb *msg;
887
888 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED-REJECT");
889 if (!msg)
890 return NULL;
891
892 /* Message Type, 3.2.2.1 */
893 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT);
894
895 /* Cause, 3.2.2.5 */
896 gsm0808_enc_cause(msg, params->cause);
897
898 /* prepend the header */
899 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
900
901 return msg;
902}
903
904/*! Create BSSMAP HANDOVER REQUEST message, 3GPP TS 48.008 3.2.1.8.
905 * Sent from the MSC to the potential new target cell during inter-BSC handover, or to the target MSC during inter-MSC
906 * handover.
907 */
908struct msgb *gsm0808_create_handover_request(const struct gsm0808_handover_request *params)
909{
910 struct msgb *msg;
911
912 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST");
913 if (!msg)
914 return NULL;
915
916 /* Message Type, 3.2.2.1 */
917 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST);
918
919 /* Channel Type 3.2.2.11 */
920 gsm0808_enc_channel_type(msg, &params->channel_type);
921
922 /* Encryption Information 3.2.2.10 */
923 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
924
925 /* Classmark Information 1 3.2.2.30 or Classmark Information 2 3.2.2.19 (Classmark 2 wins) */
926 if (params->classmark_information.classmark2_len) {
927 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2,
928 params->classmark_information.classmark2_len,
929 (const uint8_t*)&params->classmark_information.classmark2);
930 } else if (params->classmark_information.classmark1_set) {
931 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1,
932 sizeof(params->classmark_information.classmark1),
933 (const uint8_t*)&params->classmark_information.classmark1);
934 }
935 /* (Classmark 3 possibly follows below) */
936
937 /* Cell Identifier (Serving) , 3.2.2.17 */
938 gsm0808_enc_cell_id(msg, &params->cell_identifier_serving);
939
940 /* Cell Identifier (Target) , 3.2.2.17 */
941 gsm0808_enc_cell_id(msg, &params->cell_identifier_target);
942
943 /* Cause, 3.2.2.5 */
944 gsm0808_enc_cause(msg, params->cause);
945
946 /* Classmark Information 3 3.2.2.20 */
947 if (params->classmark_information.classmark3_len) {
948 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
949 params->classmark_information.classmark3_len,
950 (const uint8_t*)&params->classmark_information.classmark3);
951 }
952
953 /* Current Channel type 1 3.2.2.49 */
954 if (params->current_channel_type_1_present)
955 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
956
957 /* Speech Version (Used), 3.2.2.51 */
958 if (params->speech_version_used) {
959 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
960 }
961
962 /* Chosen Encryption Algorithm (Serving) 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +0700963 if (params->chosen_encryption_algorithm_serving > 0)
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100964 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encryption_algorithm_serving);
965
966 /* Old BSS to New BSS Information 3.2.2.58 */
967 if (params->old_bss_to_new_bss_info_raw && params->old_bss_to_new_bss_info_raw_len) {
968 msgb_tlv_put(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION,
969 params->old_bss_to_new_bss_info_raw_len,
970 params->old_bss_to_new_bss_info_raw);
971 } else if (params->old_bss_to_new_bss_info_present) {
972 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
973 }
974
975 /* IMSI 3.2.2.6 */
976 if (params->imsi) {
Harald Weltea13fb752020-06-16 08:44:42 +0200977 uint8_t mid_buf[GSM48_MI_SIZE + 2];
978 int mid_len = gsm48_generate_mid_from_imsi(mid_buf, params->imsi);
979 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100980 }
981
982 if (params->aoip_transport_layer)
983 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
984
985 if (params->codec_list_msc_preferred)
986 gsm0808_enc_speech_codec_list(msg, params->codec_list_msc_preferred);
987
988 if (params->call_id_present) {
989 uint8_t val[4];
990 osmo_store32le(params->call_id, val);
991 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, 4, val);
992 }
993
994 if (params->global_call_reference && params->global_call_reference_len) {
995 msgb_tlv_put(msg, GSM0808_IE_GLOBAL_CALL_REF,
996 params->global_call_reference_len, params->global_call_reference);
997 }
998
999 /* prepend header with final length */
1000 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1001
1002 return msg;
1003}
1004
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001005/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.
1006 * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.
1007 * 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 +01001008struct msgb *gsm0808_create_handover_request_ack2(const struct gsm0808_handover_request_ack *params)
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001009{
1010 struct msgb *msg;
1011
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001012 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001013 if (!msg)
1014 return NULL;
1015
1016 /* Message Type, 3.2.2.1 */
1017 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE);
1018
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001019 /* Layer 3 Information, 3.2.2.24 -- it is actually mandatory, but rather compose a nonstandard message than
1020 * segfault or return NULL without a log message. */
1021 if (params->l3_info && params->l3_info_len)
1022 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001023
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001024 if (params->chosen_channel_present)
1025 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001026 if (params->chosen_encr_alg > 0)
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001027 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1028
1029 if (params->chosen_speech_version != 0)
1030 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->chosen_speech_version);
1031
1032 if (params->aoip_transport_layer)
1033 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1034
1035 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1036 if (params->speech_codec_chosen_present)
1037 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001038
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001039 /* prepend header with final length */
1040 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1041
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001042 return msg;
1043}
1044
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001045/*! Same as gsm0808_create_handover_request_ack2() but with less parameters.
1046 * In particular, this lacks the AoIP Transport Layer address. */
1047struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,
1048 uint8_t chosen_channel, uint8_t chosen_encr_alg,
1049 uint8_t chosen_speech_version)
1050{
1051 struct gsm0808_handover_request_ack params = {
1052 .l3_info = l3_info,
1053 .l3_info_len = l3_info_len,
1054 .chosen_channel = chosen_channel,
1055 .chosen_encr_alg = chosen_encr_alg,
1056 .chosen_speech_version = chosen_speech_version,
1057 };
1058
1059 return gsm0808_create_handover_request_ack2(&params);
1060}
1061
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001062/*! Create BSSMAP HANDOVER COMMAND message, 3GPP TS 48.008 3.2.1.11.
1063 * Sent from the MSC to the old BSS to transmit the RR Handover Command received from the new BSS. */
1064struct msgb *gsm0808_create_handover_command(const struct gsm0808_handover_command *params)
1065{
1066 struct msgb *msg;
1067
1068 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMMAND");
1069 if (!msg)
1070 return NULL;
1071
1072 /* Message Type, 3.2.2.1 */
1073 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_CMD);
1074
1075 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
1076
1077 if (params->cell_identifier.id_discr != CELL_IDENT_NO_CELL)
1078 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1079
1080 if (params->new_bss_to_old_bss_info_raw
1081 && params->new_bss_to_old_bss_info_raw_len)
1082 msgb_tlv_put(msg, GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO, params->new_bss_to_old_bss_info_raw_len,
1083 params->new_bss_to_old_bss_info_raw);
1084
1085 /* prepend header with final length */
1086 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1087
1088 return msg;
1089}
1090
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001091/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.
1092 * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has
1093 * received the Handover Detect message. */
1094struct msgb *gsm0808_create_handover_detect()
1095{
1096 struct msgb *msg;
1097
1098 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1099 if (!msg)
1100 return NULL;
1101
1102 /* Message Type, 3.2.2.1 */
1103 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);
1104
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001105 /* prepend header with final length */
1106 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1107
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001108 return msg;
1109}
1110
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001111/*! Create BSSMAP HANDOVER SUCCEEDED message, 3GPP TS 48.008 3.2.1.13.
1112 * Sent from the MSC back to the old BSS to notify that the MS has successfully accessed the new BSS. */
1113struct msgb *gsm0808_create_handover_succeeded()
1114{
1115 struct msgb *msg;
1116
1117 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1118 if (!msg)
1119 return NULL;
1120
1121 /* Message Type, 3.2.2.1 */
1122 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_SUCCEEDED);
1123
1124 /* prepend header with final length */
1125 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1126
1127 return msg;
1128}
1129
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001130/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.
1131 * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */
1132struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)
1133{
1134 struct msgb *msg;
1135
1136 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");
1137 if (!msg)
1138 return NULL;
1139
1140 /* Message Type, 3.2.2.1 */
1141 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);
1142
1143 /* RR Cause, 3.2.2.22 */
1144 if (params->rr_cause_present)
1145 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1146
1147 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1148 if (params->speech_codec_chosen_present)
1149 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1150
1151 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1152 if (params->codec_list_bss_supported.len)
1153 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1154
1155 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001156 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001157 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1158
1159 /* LCLS-BSS-Status 3.2.2.119 */
1160 if (params->lcls_bss_status_present)
1161 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1162
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001163 /* prepend header with final length */
1164 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1165
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001166 return msg;
1167}
1168
1169/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.
1170 * Sent from the MT BSC back to the MSC when the handover has failed. */
1171struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)
1172{
1173 struct msgb *msg;
1174
1175 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");
1176 if (!msg)
1177 return NULL;
1178
1179 /* Message Type, 3.2.2.1 */
1180 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);
1181
1182 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001183 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001184
1185 /* RR Cause, 3.2.2.22 */
1186 if (params->rr_cause_present)
1187 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1188
1189 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1190 if (params->codec_list_bss_supported.len)
1191 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1192
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001193 /* prepend header with final length */
1194 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1195
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001196 return msg;
1197}
1198
Philipp Maier225bdf42018-10-30 14:56:59 +01001199/*! Create BSSMAP HANDOVER PERFORMED message, 3GPP TS 48.008 3.2.1.25.
1200 * \param[in] params All information to be encoded.
1201 * \returns callee-allocated msgb with BSSMAP HANDOVER PERFORMED message */
1202struct msgb *gsm0808_create_handover_performed(const struct gsm0808_handover_performed *params)
1203{
1204 struct msgb *msg;
1205
1206 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-PERFORMED");
1207 if (!msg)
1208 return NULL;
1209
1210 /* Message Type, 3.2.2.1 */
1211 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_PERFORMED);
1212
1213 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001214 gsm0808_enc_cause(msg, params->cause);
Philipp Maier225bdf42018-10-30 14:56:59 +01001215
1216 /* Cell Identifier, 3.2.2.17 */
1217 gsm0808_enc_cell_id(msg, &params->cell_id);
1218
1219 /* Chosen Channel 3.2.2.33 */
1220 if (params->chosen_channel_present)
1221 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1222
1223 /* Chosen Encryption Algorithm 3.2.2.44 */
Vadim Yanitskiyecaf5fa2020-08-31 19:10:39 +07001224 if (params->chosen_encr_alg_present && params->chosen_encr_alg > 0)
Philipp Maier225bdf42018-10-30 14:56:59 +01001225 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1226
1227 /* Speech Version (chosen) 3.2.2.51 */
1228 if (params->speech_version_chosen_present)
1229 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_chosen);
1230
1231 /* AoIP: Speech Codec (chosen) 3.2.2.104 */
1232 if (params->speech_codec_chosen_present)
1233 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1234
1235 /* LCLS-BSS-Status 3.2.2.119 */
1236 if (params->lcls_bss_status_present)
1237 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1238
1239 /* prepend header with final length */
1240 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1241
1242 return msg;
1243}
1244
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001245/*! Create BSSMAP COMMON ID message, 3GPP TS 48.008 3.2.1.68.
1246 * \param[in] imsi IMSI digits (decimal string).
1247 * \param[in] selected_plmn_id Selected PLMN ID to encode, or NULL to not encode this IE.
1248 * \param[in] last_used_eutran_plnm_id Last used E-UTRAN PLMN ID to encode, or NULL to not encode this IE.
1249 * \returns callee-allocated msgb with BSSMAP COMMON ID message, or NULL if encoding failed. */
Harald Welte1bd726a2020-06-21 22:04:52 +02001250struct msgb *gsm0808_create_common_id(const char *imsi,
1251 const struct osmo_plmn_id *selected_plmn_id,
1252 const struct osmo_plmn_id *last_used_eutran_plnm_id)
1253{
1254 struct msgb *msg;
Harald Welte1bd726a2020-06-21 22:04:52 +02001255 uint8_t *out;
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001256 struct osmo_mobile_identity mi;
1257 int rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001258
1259 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "COMMON-ID");
1260 if (!msg)
1261 return NULL;
1262
1263 /* Message Type, 3.2.2.1 */
1264 msgb_v_put(msg, BSS_MAP_MSG_COMMON_ID);
1265
1266 /* mandatory IMSI 3.2.2.6 */
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001267 mi = (struct osmo_mobile_identity){ .type = GSM_MI_TYPE_IMSI };
1268 OSMO_STRLCPY_ARRAY(mi.imsi, imsi);
1269 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1270 rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
1271 if (rc < 0) {
1272 msgb_free(msg);
1273 return NULL;
1274 }
1275 /* write the MI value length */
1276 *out = rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001277
1278 /* not implemented: SNA Access Information */
1279
1280 /* Selected PLMN ID */
1281 if (selected_plmn_id) {
1282 msgb_v_put(msg, GSM0808_IE_SELECTED_PLMN_ID);
1283 out = msgb_put(msg, 3);
1284 osmo_plmn_to_bcd(out, selected_plmn_id);
1285 }
1286
1287 /* Last used E-UTRAN PLMN ID */
1288 if (last_used_eutran_plnm_id) {
1289 msgb_v_put(msg, GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID);
1290 out = msgb_put(msg, 3);
1291 osmo_plmn_to_bcd(out, last_used_eutran_plnm_id);
1292 }
1293
1294 /* prepend header with final length */
1295 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1296
1297 return msg;
1298}
1299
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001300/*! Prepend a DTAP header to given Message Buffer
Harald Welte96e2a002017-06-12 21:44:18 +02001301 * \param[in] msgb Message Buffer
1302 * \param[in] link_id Link Identifier */
Holger Hans Peter Freyther9a3dec02010-05-16 08:15:40 +08001303void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id)
1304{
1305 uint8_t *hh = msgb_push(msg, 3);
1306 hh[0] = BSSAP_MSG_DTAP;
1307 hh[1] = link_id;
1308 hh[2] = msg->len - 3;
1309}
1310
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001311/*! Create BSSMAP DTAP message
Harald Welte96e2a002017-06-12 21:44:18 +02001312 * \param[in] msg_l3 Messge Buffer containing Layer3 message
1313 * \param[in] link_id Link Identifier
1314 * \returns callee-allocated msgb with BSSMAP DTAP message */
Holger Hans Peter Freytherc25c6682010-11-04 12:26:06 +01001315struct msgb *gsm0808_create_dtap(struct msgb *msg_l3, uint8_t link_id)
1316{
1317 struct dtap_header *header;
1318 uint8_t *data;
1319 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
1320 "dtap");
1321 if (!msg)
1322 return NULL;
1323
1324 /* DTAP header */
1325 msg->l3h = msgb_put(msg, sizeof(*header));
1326 header = (struct dtap_header *) &msg->l3h[0];
1327 header->type = BSSAP_MSG_DTAP;
1328 header->link_id = link_id;
1329 header->length = msgb_l3len(msg_l3);
1330
1331 /* Payload */
1332 data = msgb_put(msg, header->length);
1333 memcpy(data, msg_l3->l3h, header->length);
1334
1335 return msg;
1336}
1337
Neels Hofmeyr5b214e22020-09-18 18:00:50 +02001338struct msgb *gsm0808_create_perform_location_request(const struct gsm0808_perform_location_request *params)
1339{
1340 struct msgb *msg;
1341 uint8_t *out;
1342 int rc;
1343
1344 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-REQUEST");
1345 if (!msg)
1346 return NULL;
1347
1348 /* Message Type, 3.2.2.1 */
1349 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_RQST);
1350
1351 /* Location Type 3.2.2.63 */
1352 osmo_bssmap_le_ie_enc_location_type(msg, &params->location_type);
1353
1354 if (params->imsi.type == GSM_MI_TYPE_IMSI) {
1355 /* IMSI 3.2.2.6 */
1356 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1357 rc = osmo_mobile_identity_encode_msgb(msg, &params->imsi, false);
1358 if (rc < 0) {
1359 msgb_free(msg);
1360 return NULL;
1361 }
1362 /* write the MI value length */
1363 *out = rc;
1364 }
1365
1366 /* prepend header with final length */
1367 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1368
1369 return msg;
1370}
1371
1372struct msgb *gsm0808_create_perform_location_response(const struct gsm0808_perform_location_response *params)
1373{
1374 struct msgb *msg;
1375
1376 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-RESPONSE");
1377 if (!msg)
1378 return NULL;
1379
1380 /* Message Type, 3.2.2.1 */
1381 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE);
1382
1383 if (params->location_estimate_present) {
1384 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LOCATION_ESTIMATE);
1385 int rc = osmo_gad_raw_write(msg, &params->location_estimate);
1386 if (rc < 0) {
1387 msgb_free(msg);
1388 return NULL;
1389 }
1390 *l = rc;
1391 }
1392
1393 if (params->lcs_cause.present) {
1394 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LCS_CAUSE);
1395 int rc = osmo_lcs_cause_enc(msg, &params->lcs_cause);
1396 if (rc < 0) {
1397 msgb_free(msg);
1398 return NULL;
1399 }
1400 *l = rc;
1401 }
1402
1403 /* prepend header with final length */
1404 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1405
1406 return msg;
1407}
1408
1409int gsm0808_enc_lcs_cause(struct msgb *msg, const struct lcs_cause_ie *lcs_cause)
1410{
1411 uint8_t *l = msgb_tl_put(msg, GSM0808_IE_LCS_CAUSE);
1412 int rc = osmo_lcs_cause_enc(msg, lcs_cause);
1413 if (rc <= 0)
1414 return rc;
1415 *l = rc;
1416 return rc + 2;
1417}
1418
1419struct msgb *gsm0808_create_perform_location_abort(const struct lcs_cause_ie *lcs_cause)
1420{
1421 struct msgb *msg;
1422
1423 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-PERFORM-LOCATION-ABORT");
1424 if (!msg)
1425 return NULL;
1426
1427 /* Message Type, 3.2.2.1 */
1428 msgb_v_put(msg, BSS_MAP_MSG_PERFORM_LOCATION_ABORT);
1429
1430 gsm0808_enc_lcs_cause(msg, lcs_cause);
1431
1432 /* prepend header with final length */
1433 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1434
1435 return msg;
1436}
1437
Harald Welte92107df2014-06-21 23:16:20 +02001438/* As per 3GPP TS 48.008 version 11.7.0 Release 11 */
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001439static const struct tlv_definition bss_att_tlvdef = {
1440 .def = {
Harald Welte92107df2014-06-21 23:16:20 +02001441 [GSM0808_IE_CIRCUIT_IDENTITY_CODE] = { TLV_TYPE_FIXED, 2 },
1442 [GSM0808_IE_CONNECTION_RELEASE_RQSTED] = { TLV_TYPE_TV },
1443 [GSM0808_IE_RESOURCE_AVAILABLE] = { TLV_TYPE_FIXED, 21 },
1444 [GSM0808_IE_CAUSE] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001445 [GSM0808_IE_IMSI] = { TLV_TYPE_TLV },
1446 [GSM0808_IE_TMSI] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001447 [GSM0808_IE_NUMBER_OF_MSS] = { TLV_TYPE_TV },
Dmitri Soloviev29099422013-07-11 09:25:37 +02001448 [GSM0808_IE_LAYER_3_HEADER_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001449 [GSM0808_IE_ENCRYPTION_INFORMATION] = { TLV_TYPE_TLV },
1450 [GSM0808_IE_CHANNEL_TYPE] = { TLV_TYPE_TLV },
1451 [GSM0808_IE_PERIODICITY] = { TLV_TYPE_TV },
1452 [GSM0808_IE_EXTENDED_RESOURCE_INDICATOR]= { TLV_TYPE_TV },
1453 [GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE] = { TLV_TYPE_FIXED, 4 },
1454 [GSM0808_IE_LSA_IDENTIFIER] = { TLV_TYPE_TLV },
1455 [GSM0808_IE_LSA_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther715e9452014-08-21 14:17:45 +02001456 [GSM0808_IE_LSA_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001457 [GSM0808_IE_CELL_IDENTIFIER] = { TLV_TYPE_TLV },
1458 [GSM0808_IE_PRIORITY] = { TLV_TYPE_TLV },
1459 [GSM0808_IE_CLASSMARK_INFORMATION_T2] = { TLV_TYPE_TLV },
1460 [GSM0808_IE_CLASSMARK_INFORMATION_T3] = { TLV_TYPE_TLV },
1461 [GSM0808_IE_INTERFERENCE_BAND_TO_USE] = { TLV_TYPE_TV },
1462 [GSM0808_IE_RR_CAUSE] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001463 [GSM0808_IE_LAYER_3_INFORMATION] = { TLV_TYPE_TLV },
1464 [GSM0808_IE_DLCI] = { TLV_TYPE_TV },
1465 [GSM0808_IE_DOWNLINK_DTX_FLAG] = { TLV_TYPE_TV },
1466 [GSM0808_IE_CELL_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
1467 [GSM0808_IE_CELL_ID_LIST_SEGMENT] = { TLV_TYPE_TLV },
1468 [GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS] = { TLV_TYPE_TLV },
1469 [GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE] = { TLV_TYPE_TLV },
1470 [GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS] = { TLV_TYPE_TLV },
1471 [GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS] = { TLV_TYPE_TLV },
1472 [GSM0808_IE_RESPONSE_RQST] = { TLV_TYPE_T },
1473 [GSM0808_IE_RESOURCE_INDICATION_METHOD] = { TLV_TYPE_TV },
1474 [GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1] = { TLV_TYPE_TV },
1475 [GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST] = { TLV_TYPE_TLV },
1476 [GSM0808_IE_DIAGNOSTIC] = { TLV_TYPE_TLV },
1477 [GSM0808_IE_CHOSEN_CHANNEL] = { TLV_TYPE_TV },
1478 [GSM0808_IE_CIPHER_RESPONSE_MODE] = { TLV_TYPE_TV },
1479 [GSM0808_IE_LAYER_3_MESSAGE_CONTENTS] = { TLV_TYPE_TLV },
1480 [GSM0808_IE_CHANNEL_NEEDED] = { TLV_TYPE_TV },
1481 [GSM0808_IE_TRACE_TYPE] = { TLV_TYPE_TV },
1482 [GSM0808_IE_TRIGGERID] = { TLV_TYPE_TLV },
1483 [GSM0808_IE_TRACE_REFERENCE] = { TLV_TYPE_TV },
1484 [GSM0808_IE_TRANSACTIONID] = { TLV_TYPE_TLV },
1485 [GSM0808_IE_MOBILE_IDENTITY] = { TLV_TYPE_TLV },
1486 [GSM0808_IE_OMCID] = { TLV_TYPE_TLV },
1487 [GSM0808_IE_FORWARD_INDICATOR] = { TLV_TYPE_TV },
Holger Hans Peter Freytherc2b7f922010-08-04 18:50:43 +08001488 [GSM0808_IE_CHOSEN_ENCR_ALG] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001489 [GSM0808_IE_CIRCUIT_POOL] = { TLV_TYPE_TV },
1490 [GSM0808_IE_CIRCUIT_POOL_LIST] = { TLV_TYPE_TLV },
1491 [GSM0808_IE_TIME_INDICATION] = { TLV_TYPE_TV },
1492 [GSM0808_IE_RESOURCE_SITUATION] = { TLV_TYPE_TLV },
1493 [GSM0808_IE_CURRENT_CHANNEL_TYPE_1] = { TLV_TYPE_TV },
1494 [GSM0808_IE_QUEUEING_INDICATOR] = { TLV_TYPE_TV },
1495 [GSM0808_IE_SPEECH_VERSION] = { TLV_TYPE_TV },
1496 [GSM0808_IE_ASSIGNMENT_REQUIREMENT] = { TLV_TYPE_TV },
1497 [GSM0808_IE_TALKER_FLAG] = { TLV_TYPE_T },
1498 [GSM0808_IE_GROUP_CALL_REFERENCE] = { TLV_TYPE_TLV },
1499 [GSM0808_IE_EMLPP_PRIORITY] = { TLV_TYPE_TV },
1500 [GSM0808_IE_CONFIG_EVO_INDI] = { TLV_TYPE_TV },
1501 [GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION] = { TLV_TYPE_TLV },
1502 [GSM0808_IE_LCS_QOS] = { TLV_TYPE_TLV },
1503 [GSM0808_IE_LSA_ACCESS_CTRL_SUPPR] = { TLV_TYPE_TV },
1504 [GSM0808_IE_LCS_PRIORITY] = { TLV_TYPE_TLV },
1505 [GSM0808_IE_LOCATION_TYPE] = { TLV_TYPE_TLV },
1506 [GSM0808_IE_LOCATION_ESTIMATE] = { TLV_TYPE_TLV },
1507 [GSM0808_IE_POSITIONING_DATA] = { TLV_TYPE_TLV },
1508 [GSM0808_IE_LCS_CAUSE] = { TLV_TYPE_TLV },
1509 [GSM0808_IE_APDU] = { TLV_TYPE_TLV },
1510 [GSM0808_IE_NETWORK_ELEMENT_IDENTITY] = { TLV_TYPE_TLV },
1511 [GSM0808_IE_GPS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1512 [GSM0808_IE_DECIPHERING_KEYS] = { TLV_TYPE_TLV },
1513 [GSM0808_IE_RETURN_ERROR_RQST] = { TLV_TYPE_TLV },
1514 [GSM0808_IE_RETURN_ERROR_CAUSE] = { TLV_TYPE_TLV },
1515 [GSM0808_IE_SEGMENTATION] = { TLV_TYPE_TLV },
1516 [GSM0808_IE_SERVICE_HANDOVER] = { TLV_TYPE_TLV },
1517 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS] = { TLV_TYPE_TLV },
1518 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000] = { TLV_TYPE_TLV },
1519 [GSM0808_IE_GERAN_CLASSMARK] = { TLV_TYPE_TLV },
1520 [GSM0808_IE_GERAN_BSC_CONTAINER] = { TLV_TYPE_TLV },
1521 [GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO] = { TLV_TYPE_TLV },
1522 [GSM0800_IE_INTER_SYSTEM_INFO] = { TLV_TYPE_TLV },
1523 [GSM0808_IE_SNA_ACCESS_INFO] = { TLV_TYPE_TLV },
1524 [GSM0808_IE_VSTK_RAND_INFO] = { TLV_TYPE_TLV },
1525 [GSM0808_IE_PAGING_INFO] = { TLV_TYPE_TV },
1526 [GSM0808_IE_IMEI] = { TLV_TYPE_TLV },
1527 [GSM0808_IE_VELOCITY_ESTIMATE] = { TLV_TYPE_TLV },
1528 [GSM0808_IE_VGCS_FEATURE_FLAGS] = { TLV_TYPE_TLV },
1529 [GSM0808_IE_TALKER_PRIORITY] = { TLV_TYPE_TV },
1530 [GSM0808_IE_EMERGENCY_SET_INDICATION] = { TLV_TYPE_T },
1531 [GSM0808_IE_TALKER_IDENTITY] = { TLV_TYPE_TLV },
1532 [GSM0808_IE_SMS_TO_VGCS] = { TLV_TYPE_TLV },
1533 [GSM0808_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
1534 [GSM0808_IE_VGCS_VBS_CELL_STATUS] = { TLV_TYPE_TLV },
1535 [GSM0808_IE_GANSS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1536 [GSM0808_IE_GANSS_POSITIONING_DATA] = { TLV_TYPE_TLV },
1537 [GSM0808_IE_GANSS_LOCATION_TYPE] = { TLV_TYPE_TLV },
1538 [GSM0808_IE_APP_DATA] = { TLV_TYPE_TLV },
1539 [GSM0808_IE_DATA_IDENTITY] = { TLV_TYPE_TLV },
1540 [GSM0808_IE_APP_DATA_INFO] = { TLV_TYPE_TLV },
1541 [GSM0808_IE_MSISDN] = { TLV_TYPE_TLV },
1542 [GSM0808_IE_AOIP_TRASP_ADDR] = { TLV_TYPE_TLV },
1543 [GSM0808_IE_SPEECH_CODEC_LIST] = { TLV_TYPE_TLV },
1544 [GSM0808_IE_SPEECH_CODEC] = { TLV_TYPE_TLV },
1545 [GSM0808_IE_CALL_ID] = { TLV_TYPE_FIXED, 4 },
1546 [GSM0808_IE_CALL_ID_LIST] = { TLV_TYPE_TLV },
1547 [GSM0808_IE_A_IF_SEL_FOR_RESET] = { TLV_TYPE_TV },
1548 [GSM0808_IE_KC_128] = { TLV_TYPE_FIXED, 16 },
1549 [GSM0808_IE_CSG_IDENTIFIER] = { TLV_TYPE_TLV },
1550 [GSM0808_IE_REDIR_ATTEMPT_FLAG] = { TLV_TYPE_T },
1551 [GSM0808_IE_REROUTE_REJ_CAUSE] = { TLV_TYPE_TV },
1552 [GSM0808_IE_SEND_SEQ_NUM] = { TLV_TYPE_TV },
1553 [GSM0808_IE_REROUTE_COMPL_OUTCOME] = { TLV_TYPE_TV },
1554 [GSM0808_IE_GLOBAL_CALL_REF] = { TLV_TYPE_TLV },
1555 [GSM0808_IE_LCLS_CONFIG] = { TLV_TYPE_TV },
1556 [GSM0808_IE_LCLS_CONN_STATUS_CTRL] = { TLV_TYPE_TV },
1557 [GSM0808_IE_LCLS_CORR_NOT_NEEDED] = { TLV_TYPE_TV },
1558 [GSM0808_IE_LCLS_BSS_STATUS] = { TLV_TYPE_TV },
1559 [GSM0808_IE_LCLS_BREAK_REQ] = { TLV_TYPE_TV },
1560 [GSM0808_IE_CSFB_INDICATION] = { TLV_TYPE_T },
1561 [GSM0808_IE_CS_TO_PS_SRVCC] = { TLV_TYPE_T },
1562 [GSM0808_IE_SRC_ENB_TO_TGT_ENB_TRANSP] = { TLV_TYPE_TLV },
1563 [GSM0808_IE_CS_TO_PS_SRVCC_IND] = { TLV_TYPE_T },
1564 [GSM0808_IE_CN_TO_MS_TRANSP_INFO] = { TLV_TYPE_TLV },
1565 [GSM0808_IE_SELECTED_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
1566 [GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol18506c82019-04-16 15:47:59 +02001567
1568 /* Osmocom extensions */
1569 [GSM0808_IE_OSMO_OSMUX_SUPPORT] = { TLV_TYPE_T },
1570 [GSM0808_IE_OSMO_OSMUX_CID] = { TLV_TYPE_TV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001571 },
1572};
1573
Harald Weltef4d45ab2011-07-16 12:13:00 +02001574const struct tlv_definition *gsm0808_att_tlvdef(void)
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001575{
1576 return &bss_att_tlvdef;
1577}
Harald Welte9b837e62011-07-11 17:43:19 +02001578
Pau Espin Pedrol392f6072019-11-27 12:07:04 +01001579const struct value_string gsm0406_dlci_sapi_names[] = {
1580 { DLCI_SAPI_RR_MM_CC, "RR/MM/CC" },
1581 { DLCI_SAPI_SMS, "SMS" },
1582 { 0, NULL }
1583};
1584
Harald Welte9b837e62011-07-11 17:43:19 +02001585static const struct value_string gsm0808_msgt_names[] = {
1586 { BSS_MAP_MSG_ASSIGMENT_RQST, "ASSIGNMENT REQ" },
1587 { BSS_MAP_MSG_ASSIGMENT_COMPLETE, "ASSIGNMENT COMPL" },
1588 { BSS_MAP_MSG_ASSIGMENT_FAILURE, "ASSIGNMENT FAIL" },
Harald Welte92107df2014-06-21 23:16:20 +02001589 { BSS_MAP_MSG_CHAN_MOD_RQST, "CHANNEL MODIFY REQUEST" },
Harald Welte9b837e62011-07-11 17:43:19 +02001590
1591 { BSS_MAP_MSG_HANDOVER_RQST, "HANDOVER REQ" },
1592 { BSS_MAP_MSG_HANDOVER_REQUIRED, "HANDOVER REQUIRED" },
1593 { BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE,"HANDOVER REQ ACK" },
1594 { BSS_MAP_MSG_HANDOVER_CMD, "HANDOVER CMD" },
1595 { BSS_MAP_MSG_HANDOVER_COMPLETE, "HANDOVER COMPLETE" },
1596 { BSS_MAP_MSG_HANDOVER_SUCCEEDED, "HANDOVER SUCCESS" },
1597 { BSS_MAP_MSG_HANDOVER_FAILURE, "HANDOVER FAILURE" },
1598 { BSS_MAP_MSG_HANDOVER_PERFORMED, "HANDOVER PERFORMED" },
1599 { BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE, "HANDOVER CAND ENQ" },
1600 { BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE, "HANDOVER CAND RESP" },
1601 { BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT, "HANDOVER REQ REJ" },
1602 { BSS_MAP_MSG_HANDOVER_DETECT, "HANDOVER DETECT" },
Harald Welte92107df2014-06-21 23:16:20 +02001603 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED, "INT HANDOVER REQ" },
1604 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED_REJ,"INT HANDOVER REQ REJ" },
1605 { BSS_MAP_MSG_INT_HANDOVER_CMD, "INT HANDOVER CMD" },
1606 { BSS_MAP_MSG_INT_HANDOVER_ENQUIRY, "INT HANDOVER ENQ" },
Harald Welte9b837e62011-07-11 17:43:19 +02001607
1608 { BSS_MAP_MSG_CLEAR_CMD, "CLEAR COMMAND" },
1609 { BSS_MAP_MSG_CLEAR_COMPLETE, "CLEAR COMPLETE" },
1610 { BSS_MAP_MSG_CLEAR_RQST, "CLEAR REQUEST" },
1611 { BSS_MAP_MSG_SAPI_N_REJECT, "SAPI N REJECT" },
1612 { BSS_MAP_MSG_CONFUSION, "CONFUSION" },
1613
1614 { BSS_MAP_MSG_SUSPEND, "SUSPEND" },
1615 { BSS_MAP_MSG_RESUME, "RESUME" },
1616 { BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION, "CONN ORIENT INFO" },
1617 { BSS_MAP_MSG_PERFORM_LOCATION_RQST, "PERFORM LOC REQ" },
1618 { BSS_MAP_MSG_LSA_INFORMATION, "LSA INFORMATION" },
1619 { BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE, "PERFORM LOC RESP" },
1620 { BSS_MAP_MSG_PERFORM_LOCATION_ABORT, "PERFORM LOC ABORT" },
1621 { BSS_MAP_MSG_COMMON_ID, "COMMON ID" },
Harald Welte92107df2014-06-21 23:16:20 +02001622 { BSS_MAP_MSG_REROUTE_CMD, "REROUTE COMMAND" },
1623 { BSS_MAP_MSG_REROUTE_COMPLETE, "REROUTE COMPLETE" },
Harald Welte9b837e62011-07-11 17:43:19 +02001624
1625 { BSS_MAP_MSG_RESET, "RESET" },
1626 { BSS_MAP_MSG_RESET_ACKNOWLEDGE, "RESET ACK" },
1627 { BSS_MAP_MSG_OVERLOAD, "OVERLOAD" },
1628 { BSS_MAP_MSG_RESET_CIRCUIT, "RESET CIRCUIT" },
1629 { BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE, "RESET CIRCUIT ACK" },
1630 { BSS_MAP_MSG_MSC_INVOKE_TRACE, "MSC INVOKE TRACE" },
1631 { BSS_MAP_MSG_BSS_INVOKE_TRACE, "BSS INVOKE TRACE" },
1632 { BSS_MAP_MSG_CONNECTIONLESS_INFORMATION, "CONNLESS INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02001633 { BSS_MAP_MSG_RESET_IP_RSRC, "RESET IP RESOURCE" },
1634 { BSS_MAP_MSG_RESET_IP_RSRC_ACK, "RESET IP RESOURCE ACK" },
Harald Welte9b837e62011-07-11 17:43:19 +02001635
1636 { BSS_MAP_MSG_BLOCK, "BLOCK" },
1637 { BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE, "BLOCK ACK" },
1638 { BSS_MAP_MSG_UNBLOCK, "UNBLOCK" },
1639 { BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE, "UNBLOCK ACK" },
1640 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK, "CIRC GROUP BLOCK" },
1641 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE, "CIRC GORUP BLOCK ACK" },
1642 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK, "CIRC GROUP UNBLOCK" },
1643 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE, "CIRC GROUP UNBLOCK ACK" },
1644 { BSS_MAP_MSG_UNEQUIPPED_CIRCUIT, "UNEQUIPPED CIRCUIT" },
1645 { BSS_MAP_MSG_CHANGE_CIRCUIT, "CHANGE CIRCUIT" },
1646 { BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE, "CHANGE CIRCUIT ACK" },
1647
1648 { BSS_MAP_MSG_RESOURCE_RQST, "RESOURCE REQ" },
1649 { BSS_MAP_MSG_RESOURCE_INDICATION, "RESOURCE IND" },
1650 { BSS_MAP_MSG_PAGING, "PAGING" },
1651 { BSS_MAP_MSG_CIPHER_MODE_CMD, "CIPHER MODE CMD" },
1652 { BSS_MAP_MSG_CLASSMARK_UPDATE, "CLASSMARK UPDATE" },
1653 { BSS_MAP_MSG_CIPHER_MODE_COMPLETE, "CIPHER MODE COMPLETE" },
1654 { BSS_MAP_MSG_QUEUING_INDICATION, "QUEUING INDICATION" },
1655 { BSS_MAP_MSG_COMPLETE_LAYER_3, "COMPLETE LAYER 3" },
1656 { BSS_MAP_MSG_CLASSMARK_RQST, "CLASSMARK REQ" },
1657 { BSS_MAP_MSG_CIPHER_MODE_REJECT, "CIPHER MODE REJECT" },
1658 { BSS_MAP_MSG_LOAD_INDICATION, "LOAD IND" },
1659
Harald Welte92107df2014-06-21 23:16:20 +02001660 { BSS_MAP_MSG_VGCS_VBS_SETUP, "VGCS/VBS SETUP" },
1661 { BSS_MAP_MSG_VGCS_VBS_SETUP_ACK, "VGCS/VBS SETUP ACK" },
1662 { BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE, "VGCS/VBS SETUP REFUSE" },
1663 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST, "VGCS/VBS ASSIGN REQ" },
1664 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT, "VGCS/VBS ASSIGN RES" },
1665 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE, "VGCS/VBS ASSIGN FAIL" },
1666 { BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION, "VGCS/VBS QUEUING IND" },
1667 { BSS_MAP_MSG_UPLINK_RQST, "UPLINK REQ" },
1668 { BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE, "UPLINK REQ ACK" },
1669 { BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION, "UPLINK REQ CONF" },
1670 { BSS_MAP_MSG_UPLINK_RELEASE_INDICATION,"UPLINK REL IND" },
1671 { BSS_MAP_MSG_UPLINK_REJECT_CMD, "UPLINK REJ CMD" },
1672 { BSS_MAP_MSG_UPLINK_RELEASE_CMD, "UPLINK REL CMD" },
1673 { BSS_MAP_MSG_UPLINK_SEIZED_CMD, "UPLINK SEIZED CMD" },
1674 { BSS_MAP_MSG_VGCS_ADDL_INFO, "VGCS ADDL INFO" },
1675 { BSS_MAP_MSG_NOTIFICATION_DATA, "NOTIF DATA" },
1676 { BSS_MAP_MSG_UPLINK_APP_DATA, "UPLINK APP DATA" },
1677
1678 { BSS_MAP_MSG_LCLS_CONNECT_CTRL, "LCLS-CONNECT-CONTROL" },
1679 { BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK, "CLS-CONNECT-CONTROL-ACK" },
1680 { BSS_MAP_MSG_LCLS_NOTIFICATION, "LCLS-NOTIFICATION" },
Harald Welte9b837e62011-07-11 17:43:19 +02001681
1682 { 0, NULL }
1683};
1684
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001685/*! Return string name of BSSMAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001686const char *gsm0808_bssmap_name(uint8_t msg_type)
1687{
1688 return get_value_string(gsm0808_msgt_names, msg_type);
1689}
1690
1691static const struct value_string gsm0808_bssap_names[] = {
1692 { BSSAP_MSG_BSS_MANAGEMENT, "MANAGEMENT" },
1693 { BSSAP_MSG_DTAP, "DTAP" },
Neels Hofmeyr90fdb082017-03-01 14:59:44 +01001694 { 0, NULL }
Harald Welte9b837e62011-07-11 17:43:19 +02001695};
1696
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001697/*! Return string name of BSSAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001698const char *gsm0808_bssap_name(uint8_t msg_type)
1699{
1700 return get_value_string(gsm0808_bssap_names, msg_type);
1701}
Harald Welte96e2a002017-06-12 21:44:18 +02001702
Neels Hofmeyrffad5742018-01-12 05:34:03 +01001703const struct value_string gsm0808_speech_codec_type_names[] = {
1704 { GSM0808_SCT_FR1, "FR1" },
1705 { GSM0808_SCT_FR2, "FR2" },
1706 { GSM0808_SCT_FR3, "FR3" },
1707 { GSM0808_SCT_FR4, "FR4" },
1708 { GSM0808_SCT_FR5, "FR5" },
1709 { GSM0808_SCT_HR1, "HR1" },
1710 { GSM0808_SCT_HR3, "HR3" },
1711 { GSM0808_SCT_HR4, "HR4" },
1712 { GSM0808_SCT_HR6, "HR6" },
1713 { GSM0808_SCT_CSD, "CSD" },
1714 { 0, NULL }
1715};
1716
Philipp Maiercdd05812018-07-12 18:21:07 +02001717const struct value_string gsm0808_permitted_speech_names[] = {
1718 { GSM0808_PERM_FR1, "FR1" },
1719 { GSM0808_PERM_FR2, "FR2" },
1720 { GSM0808_PERM_FR3, "FR3" },
1721 { GSM0808_PERM_FR4, "FR4" },
1722 { GSM0808_PERM_FR5, "FR5" },
1723 { GSM0808_PERM_HR1, "HR1" },
1724 { GSM0808_PERM_HR2, "HR2" },
1725 { GSM0808_PERM_HR3, "HR3" },
1726 { GSM0808_PERM_HR4, "HR4" },
1727 { GSM0808_PERM_HR6, "HR6" },
1728 { 0, NULL }
1729};
1730
Pau Espin Pedrolf2cda622018-07-06 17:16:41 +02001731const struct value_string gsm0808_chosen_enc_alg_names[] = {
1732 { GSM0808_ALG_ID_A5_0, "A5/0" },
1733 { GSM0808_ALG_ID_A5_1, "A5/1" },
1734 { GSM0808_ALG_ID_A5_2, "A5/2" },
1735 { GSM0808_ALG_ID_A5_3, "A5/3" },
1736 { GSM0808_ALG_ID_A5_4, "A5/4" },
1737 { GSM0808_ALG_ID_A5_5, "A5/5" },
1738 { GSM0808_ALG_ID_A5_6, "A5/6" },
1739 { GSM0808_ALG_ID_A5_7, "A5/7" },
1740 { 0, NULL }
1741};
1742
Philipp Maierdbb76592018-03-29 12:55:26 +02001743static const struct value_string gsm0808_cause_names[] = {
1744 { GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE, "RADIO INTERFACE MESSAGE FAILURE" },
1745 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, "RADIO INTERFACE FAILURE" },
1746 { GSM0808_CAUSE_UPLINK_QUALITY, "UPLINK QUALITY" },
1747 { GSM0808_CAUSE_UPLINK_STRENGTH, "UPLINK STRENGTH" },
1748 { GSM0808_CAUSE_DOWNLINK_QUALITY, "DOWNLINK QUALITY" },
1749 { GSM0808_CAUSE_DOWNLINK_STRENGTH, "DOWNLINK STRENGTH" },
1750 { GSM0808_CAUSE_DISTANCE, "DISTANCE" },
1751 { GSM0808_CAUSE_O_AND_M_INTERVENTION, "O AND M INTERVENTION" },
1752 { GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION, "RESPONSE TO MSC INVOCATION" },
1753 { GSM0808_CAUSE_CALL_CONTROL, "CALL CONTROL" },
1754 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION, "RADIO INTERFACE FAILURE REVERSION" },
1755 { GSM0808_CAUSE_HANDOVER_SUCCESSFUL, "HANDOVER SUCCESSFUL" },
1756 { GSM0808_CAUSE_BETTER_CELL, "BETTER CELL" },
1757 { GSM0808_CAUSE_DIRECTED_RETRY, "DIRECTED RETRY" },
1758 { GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL, "JOINED GROUP CALL CHANNEL" },
1759 { GSM0808_CAUSE_TRAFFIC, "TRAFFIC" },
1760 { GSM0808_CAUSE_REDUCE_LOAD_IN_SERVING_CELL, "REDUCE LOAD IN SERVING CELL" },
1761 { GSM0808_CAUSE_TRAFFIC_LOAD_IN_TGT_HIGHER_THAN_IN_SRC_CELL, "TRAFFIC LOAD IN TGT HIGHER THAN IN SRC CELL" },
1762 { GSM0808_CAUSE_RELOCATION_TRIGGERED, "RELOCATION TRIGGERED" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001763 { GSM0808_CAUSE_REQUESTED_OPT_NOT_AUTHORISED, "REQUESTED OPT NOT AUTHORISED" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001764 { GSM0808_CAUSE_ALT_CHAN_CONFIG_REQUESTED, "ALT CHAN CONFIG REQUESTED" },
1765 { GSM0808_CAUSE_RESP_TO_INT_HO_ENQ_MSG, "RESP TO INT HO ENQ MSG" },
1766 { GSM0808_CAUSE_INT_HO_ENQUIRY_REJECT, "INT HO ENQUIRY REJECT" },
1767 { GSM0808_CAUSE_REDUNDANCY_LEVEL_NOT_ADEQUATE, "REDUNDANCY LEVEL NOT ADEQUATE" },
1768 { GSM0808_CAUSE_EQUIPMENT_FAILURE, "EQUIPMENT FAILURE" },
1769 { GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE, "NO RADIO RESOURCE AVAILABLE" },
1770 { GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, "RQSTED TERRESTRIAL RESOURCE UNAVAILABLE" },
1771 { GSM0808_CAUSE_CCCH_OVERLOAD, "CCCH OVERLOAD" },
1772 { GSM0808_CAUSE_PROCESSOR_OVERLOAD, "PROCESSOR OVERLOAD" },
1773 { GSM0808_CAUSE_BSS_NOT_EQUIPPED, "BSS NOT EQUIPPED" },
1774 { GSM0808_CAUSE_MS_NOT_EQUIPPED, "MS NOT EQUIPPED" },
1775 { GSM0808_CAUSE_INVALID_CELL, "INVALID CELL" },
1776 { GSM0808_CAUSE_TRAFFIC_LOAD, "TRAFFIC LOAD" },
1777 { GSM0808_CAUSE_PREEMPTION, "PREEMPTION" },
1778 { GSM0808_CAUSE_DTM_HO_SGSN_FAILURE, "DTM HO SGSN FAILURE" },
1779 { GSM0808_CAUSE_DTM_HO_PS_ALLOC_FAILURE, "DTM HO PS ALLOC FAILURE" },
1780 { GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE, "RQSTED TRANSCODING RATE ADAPTION UNAVAILABLE" },
1781 { GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH, "CIRCUIT POOL MISMATCH" },
1782 { GSM0808_CAUSE_SWITCH_CIRCUIT_POOL, "SWITCH CIRCUIT POOL" },
1783 { GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, "RQSTED SPEECH VERSION UNAVAILABLE" },
1784 { GSM0808_CAUSE_LSA_NOT_ALLOWED, "LSA NOT ALLOWED" },
1785 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_UNAVAIL, "REQ CODEC TYPE OR CONFIG UNAVAIL" },
1786 { GSM0808_CAUSE_REQ_A_IF_TYPE_UNAVAIL, "REQ A IF TYPE UNAVAIL" },
1787 { GSM0808_CAUSE_INVALID_CSG_CELL, "INVALID CSG CELL" },
1788 { GSM0808_CAUSE_REQ_REDUND_LEVEL_NOT_AVAIL, "REQ REDUND LEVEL NOT AVAIL" },
1789 { GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED, "CIPHERING ALGORITHM NOT SUPPORTED" },
1790 { GSM0808_CAUSE_GERAN_IU_MODE_FAILURE, "GERAN IU MODE FAILURE" },
1791 { GSM0808_CAUSE_INC_RELOC_NOT_SUPP_DT_PUESBINE_FEATURE, "INC RELOC NOT SUPP DT PUESBINE FEATURE" },
1792 { GSM0808_CAUSE_ACCESS_RESTRICTED_DUE_TO_SHARED_NETWORKS, "ACCESS RESTRICTED DUE TO SHARED NETWORKS" },
1793 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, "REQ CODEC TYPE OR CONFIG NOT SUPP" },
1794 { GSM0808_CAUSE_REQ_A_IF_TYPE_NOT_SUPP, "REQ A IF TYPE NOT SUPP" },
1795 { GSM0808_CAUSE_REQ_REDUND_LVL_NOT_SUPP, "REQ REDUND LVL NOT SUPP" },
1796 { GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED, "TERRESTRIAL CIRCUIT ALREADY ALLOCATED" },
1797 { GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS, "INVALID MESSAGE CONTENTS" },
1798 { GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING, "INFORMATION ELEMENT OR FIELD MISSING" },
1799 { GSM0808_CAUSE_INCORRECT_VALUE, "INCORRECT VALUE" },
1800 { GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE, "UNKNOWN MESSAGE TYPE" },
1801 { GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT, "UNKNOWN INFORMATION ELEMENT" },
1802 { GSM0808_CAUSE_DTM_HO_INVALID_PS_IND, "DTM HO INVALID PS IND" },
1803 { GSM0808_CAUSE_CALL_ID_ALREADY_ALLOC, "CALL ID ALREADY ALLOC" },
1804 { GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC, "PROTOCOL ERROR BETWEEN BSS AND MSC" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001805 { GSM0808_CAUSE_VGCS_VBS_CALL_NON_EXISTENT, "VGCS VBS CALL NON EXISTENT" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001806 { GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY, "DTM HO TIMER EXPIRY" },
1807 { 0, NULL }
1808};
1809
Maxaa934632018-11-07 13:16:54 +01001810static const struct value_string gsm0808_cause_class_names[] = {
1811 { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },
1812 { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },
1813 { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },
1814 { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },
1815 { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },
1816 { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },
1817 { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },
1818 { GSM0808_CAUSE_CLASS_INTW, "Interworking" },
1819 { 0, NULL }
1820};
1821
1822/*! Return string name of BSSMAP Cause Class name */
1823const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)
1824{
1825 return get_value_string(gsm0808_cause_class_names, class);
1826}
1827
Philipp Maierdbb76592018-03-29 12:55:26 +02001828/*! Return string name of BSSMAP Cause name */
Maxaa934632018-11-07 13:16:54 +01001829const char *gsm0808_cause_name(enum gsm0808_cause cause)
Philipp Maierdbb76592018-03-29 12:55:26 +02001830{
1831 return get_value_string(gsm0808_cause_names, cause);
1832}
1833
Alexander Chemerisfdfe25b2020-05-12 23:21:56 +03001834enum gsm0808_cause gsm0808_get_cause(const struct tlv_parsed *tp)
1835{
1836 const uint8_t *buf = TLVP_VAL_MINLEN(tp, GSM0808_IE_CAUSE, 1);
1837
1838 if (!buf)
1839 return -EBADMSG;
1840
1841 if (TLVP_LEN(tp, GSM0808_IE_CAUSE) > 1) {
1842 if (!gsm0808_cause_ext(buf[0]))
1843 return -EINVAL;
1844 return buf[1];
1845 }
1846
1847 return buf[0];
1848}
1849
Alexander Chemeris22630e62020-05-13 00:44:04 +03001850const char *gsm0808_diagnostics_octet_location_str(uint8_t pointer)
1851{
1852 switch (pointer) {
1853 case 0:
1854 return "Error location not determined";
1855 case 1:
1856 return "The first octet of the message received (i.e. the message type) was found erroneous (unknown)";
1857 case 0xfd:
1858 return "The first octet of the BSSAP header (Discrimination) was found erroneous";
1859 case 0xfe:
1860 return "(DTAP only) The DLCI (second) octet of the BSSAP header was found erroneous";
1861 case 0xff:
1862 return "The last octet of the BSSAP header (length indicator) was found erroneous";
1863 default:
1864 snprintf(str_buff, sizeof(str_buff), "The %d octet of the message received was found erroneous", pointer);
1865 return str_buff;
1866 }
1867}
1868
1869const char *gsm0808_diagnostics_bit_location_str(uint8_t bit_pointer)
1870{
1871 if (bit_pointer == 0) {
1872 return "No particular part of the octet is indicated";
1873 } else if (bit_pointer > 8) {
1874 return "Reserved value";
1875 }
1876
1877 snprintf(str_buff, sizeof(str_buff),
1878 "An error was provoked by the field whose most significant bit is in bit position %d",
1879 bit_pointer);
1880 return str_buff;
1881}
1882
Harald Welteebd362d2018-06-02 14:11:19 +02001883const struct value_string gsm0808_lcls_config_names[] = {
1884 { GSM0808_LCLS_CFG_BOTH_WAY, "Connect both-way" },
1885 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL,
1886 "Connect both-way, bi-cast UL to CN" },
1887 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL,
1888 "Connect both-way, send access DL from CN" },
1889 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL_BLOCK_LOCAL_DL,
1890 "Connect both-way, send access DL from CN, block local DL" },
1891 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL,
1892 "Connect both-way, bi-cast UL to CN, send access DL from CN" },
1893 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL_BLOCK_LOCAL_DL,
1894 "Connect both-way, bi-cast UL to CN, send access DL from CN, block local DL" },
Max961db7c2018-11-08 11:40:23 +01001895 { GSM0808_LCLS_CFG_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001896 { 0, NULL }
1897};
1898
1899const struct value_string gsm0808_lcls_control_names[] = {
1900 { GSM0808_LCLS_CSC_CONNECT, "Connect" },
1901 { GSM0808_LCLS_CSC_DO_NOT_CONNECT, "Do not connect" },
1902 { GSM0808_LCLS_CSC_RELEASE_LCLS, "Release LCLS" },
1903 { GSM0808_LCLS_CSC_BICAST_UL_AT_HANDOVER, "Bi-cast UL at Handover" },
1904 { GSM0808_LCLS_CSC_BICAST_UL_AND_RECV_DL_AT_HANDOVER, "Bi-cast UL and receive DL at Handover" },
Max961db7c2018-11-08 11:40:23 +01001905 { GSM0808_LCLS_CSC_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001906 { 0, NULL }
1907};
1908
1909const struct value_string gsm0808_lcls_status_names[] = {
1910 { GSM0808_LCLS_STS_NOT_YET_LS, "Call not yet locally switched" },
1911 { GSM0808_LCLS_STS_NOT_POSSIBLE_LS, "Call not possible to be locally switched" },
1912 { GSM0808_LCLS_STS_NO_LONGER_LS, "Call is no longer locally switched" },
1913 { GSM0808_LCLS_STS_REQ_LCLS_NOT_SUPP, "Requested LCLS configuration is not supported" },
1914 { GSM0808_LCLS_STS_LOCALLY_SWITCHED, "Call is locally switched with requested LCLS config" },
Max961db7c2018-11-08 11:40:23 +01001915 { GSM0808_LCLS_STS_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001916 { 0, NULL }
1917};
1918
Harald Welte96e2a002017-06-12 21:44:18 +02001919/*! @} */