blob: 85f5cfc9d7a90a03dddba9a16abe15b194a726d9 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*
2 * (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02003 * (C) 2009,2010 by On-Waves
4 * All Rights Reserved
5 *
Harald Weltee08da972017-11-13 01:00:26 +09006 * SPDX-License-Identifier: GPL-2.0+
7 *
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +02008 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
23
Alexander Chemeris22630e62020-05-13 00:44:04 +030024#include <string.h>
25
Harald Welte95871da2017-05-15 12:11:36 +020026#include <osmocom/core/byteswap.h>
Philipp Maier2908dbf2020-06-05 14:16:11 +020027#include <osmocom/core/endian.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010028#include <osmocom/gsm/gsm0808.h>
Philipp Maierfa896ab2017-03-27 16:55:32 +020029#include <osmocom/gsm/gsm0808_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010030#include <osmocom/gsm/protocol/gsm_08_08.h>
31#include <osmocom/gsm/gsm48.h>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020032
Harald Welte96e2a002017-06-12 21:44:18 +020033/*! \addtogroup gsm0808
34 * @{
Harald Welte37b61652017-10-16 18:46:03 +020035 * \file gsm0808.c
36 * Helper functions regarding the TS 08.08 / 48.008 A interface, primarily
37 * message generation/encoding.
Harald Welte96e2a002017-06-12 21:44:18 +020038 */
39
Alexander Chemeris22630e62020-05-13 00:44:04 +030040/*! Char buffer to return strings from functions */
41static __thread char str_buff[512];
42
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010043/*! Create "Complete L3 Info" for AoIP, legacy implementation.
44 * Instead use gsm0808_create_layer3_aoip2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +020045 * \param[in] msg_l3 msgb containing Layer 3 Message
46 * \param[in] nc Mobile Network Code
47 * \param[in] cc Mobile Country Code
48 * \param[in] lac Location Area Code
49 * \param[in] _ci Cell Identity
50 * \param[in] scl Speech Codec List
51 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +020052struct msgb *gsm0808_create_layer3_aoip(const struct msgb *msg_l3, uint16_t nc,
53 uint16_t cc, int lac, uint16_t _ci,
54 const struct gsm0808_speech_codec_list
55 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020056{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010057 struct osmo_cell_global_id cgi = {
58 .lai = {
59 .plmn = {
60 .mcc = cc,
61 .mnc = nc,
62 },
63 .lac = lac,
64 },
65 .cell_identity = _ci,
66 };
67 return gsm0808_create_layer3_2(msg_l3, &cgi, scl);
68}
69
70/*! Create "Complete L3 Info" for AoIP.
71 * \param[in] msg_l3 msgb containing Layer 3 Message -- not modified by this call.
72 * \param[in] cell MCC, MNC, LAC, CI to identify the cell.
73 * \param[in] scl Speech Codec List, optional.
74 * \returns newly allocated msgb with Complete L3 Info message */
75struct msgb *gsm0808_create_layer3_2(const struct msgb *msg_l3, const struct osmo_cell_global_id *cell,
76 const struct gsm0808_speech_codec_list *scl)
77{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020078 struct msgb* msg;
Harald Welte65c2d362012-01-21 14:26:01 +010079 struct {
80 uint8_t ident;
81 struct gsm48_loc_area_id lai;
82 uint16_t ci;
83 } __attribute__ ((packed)) lai_ci;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020084
85 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
86 "bssmap cmpl l3");
87 if (!msg)
88 return NULL;
89
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020090 /* create layer 3 header */
Harald Welte65c2d362012-01-21 14:26:01 +010091 msgb_v_put(msg, BSS_MAP_MSG_COMPLETE_LAYER_3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020092
93 /* create the cell header */
Harald Welte65c2d362012-01-21 14:26:01 +010094 lai_ci.ident = CELL_IDENT_WHOLE_GLOBAL;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010095 gsm48_generate_lai2(&lai_ci.lai, &cell->lai);
96 lai_ci.ci = osmo_htons(cell->cell_identity);
Harald Welte65c2d362012-01-21 14:26:01 +010097 msgb_tlv_put(msg, GSM0808_IE_CELL_IDENTIFIER, sizeof(lai_ci),
98 (uint8_t *) &lai_ci);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020099
100 /* copy the layer3 data */
Harald Welte65c2d362012-01-21 14:26:01 +0100101 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION,
102 msgb_l3len(msg_l3), msg_l3->l3h);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200103
Philipp Maierfa896ab2017-03-27 16:55:32 +0200104 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
105 if (scl)
106 gsm0808_enc_speech_codec_list(msg, scl);
107
Harald Welte65c2d362012-01-21 14:26:01 +0100108 /* push the bssmap header */
109 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200110
111 return msg;
112}
113
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100114/*! Create "Complete L3 Info" for A, legacy implementation.
115 * Instead use gsm0808_create_layer3_2() with the scl parameter passed as NULL,
116 * which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200117 * \param[in] msg_l3 msgb containing Layer 3 Message
118 * \param[in] nc Mobile Network Code
119 * \param[in] cc Mobile Country Code
120 * \param[in] lac Location Area Code
121 * \param[in] _ci Cell Identity
122 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200123struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
124 uint16_t cc, int lac, uint16_t _ci)
125{
Neels Hofmeyr4eeb8082018-03-23 01:47:14 +0100126 struct osmo_cell_global_id cgi = {
127 .lai = {
128 .plmn = {
129 .mcc = cc,
130 .mnc = nc,
131 },
132 .lac = lac,
133 },
134 .cell_identity = _ci,
135 };
136 return gsm0808_create_layer3_2(msg_l3, &cgi, NULL);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200137}
138
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200139/*! Create BSSMAP RESET message
Harald Welte96e2a002017-06-12 21:44:18 +0200140 * \returns callee-allocated msgb with BSSMAP Reset message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200141struct msgb *gsm0808_create_reset(void)
142{
Harald Welte65c2d362012-01-21 14:26:01 +0100143 uint8_t cause = GSM0808_CAUSE_EQUIPMENT_FAILURE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200144 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
145 "bssmap: reset");
146 if (!msg)
147 return NULL;
148
Harald Welte65c2d362012-01-21 14:26:01 +0100149 msgb_v_put(msg, BSS_MAP_MSG_RESET);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100150 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100151 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
152
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200153 return msg;
154}
155
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200156/*! Create BSSMAP RESET ACK message
Harald Welte96e2a002017-06-12 21:44:18 +0200157 * \returns callee-allocated msgb with BSSMAP Reset ACK message */
Harald Weltea62fe312013-06-19 15:14:37 +0200158struct msgb *gsm0808_create_reset_ack(void)
159{
160 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
161 "bssmap: reset ack");
162 if (!msg)
163 return NULL;
164
165 msgb_v_put(msg, BSS_MAP_MSG_RESET_ACKNOWLEDGE);
166 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
167
168 return msg;
169}
170
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200171/*! Create BSSMAP Clear Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200172 * \returns callee-allocated msgb with BSSMAP Clear Complete message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200173struct msgb *gsm0808_create_clear_complete(void)
174{
175 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
176 "bssmap: clear complete");
Harald Welte65c2d362012-01-21 14:26:01 +0100177 uint8_t val = BSS_MAP_MSG_CLEAR_COMPLETE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200178 if (!msg)
179 return NULL;
180
Harald Welte65c2d362012-01-21 14:26:01 +0100181 msg->l3h = msg->data;
182 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200183
184 return msg;
185}
186
Harald Welted1365e12019-02-18 13:44:30 +0100187/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
188 * This is quite different from most (all?) other gsm0808_create_* which have l3h
189 * point to the BSSAP header. However, we have to keep this for backwards compatibility.
190 * Use gsm0808_create_clear_command2() for a 'modern' implementation.
Philipp Maier1a146c82018-10-30 09:36:49 +0100191 * \param[in] cause TS 08.08 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200192 * \returns callee-allocated msgb with BSSMAP Clear Command message */
Philipp Maier1a146c82018-10-30 09:36:49 +0100193struct msgb *gsm0808_create_clear_command(uint8_t cause)
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200194{
195 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
196 "bssmap: clear command");
197 if (!msg)
198 return NULL;
199
Holger Hans Peter Freytheraeebe392010-10-27 12:36:05 +0200200 msg->l3h = msgb_tv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 4);
201 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100202 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100203
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200204 return msg;
205}
206
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100207/*! Create BSSMAP Clear Command message.
208 * \param[in] cause TS 08.08 cause value.
209 * \param[in] csfb_ind indicate that the call was established in an CSFB context.
210 * \returns callee-allocated msgb with BSSMAP Clear Command message. */
211struct msgb *gsm0808_create_clear_command2(uint8_t cause, bool csfb_ind)
212{
Harald Welte10ba47d2019-02-18 12:36:54 +0100213 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
214 "bssmap: clear command");
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100215 if (!msg)
216 return NULL;
217
Harald Welte10ba47d2019-02-18 12:36:54 +0100218 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
219 gsm0808_enc_cause(msg, cause);
220
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100221 if (csfb_ind)
222 msgb_v_put(msg, GSM0808_IE_CSFB_INDICATION);
223
Harald Welte10ba47d2019-02-18 12:36:54 +0100224 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
225
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100226 return msg;
227}
228
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200229/*! Create BSSMAP Cipher Mode Command message
Harald Welte96e2a002017-06-12 21:44:18 +0200230 * \param[in] ei Mandatory Encryption Information
231 * \param[in] cipher_response_mode optional 1-byte Cipher Response Mode
232 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
Philipp Maierb478dd32017-03-29 15:50:05 +0200233struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,
234 const uint8_t *cipher_response_mode)
235{
236 /* See also: 3GPP TS 48.008 3.2.1.30 CIPHER MODE COMMAND */
237 struct msgb *msg;
238
239 /* Mandatory emelent! */
240 OSMO_ASSERT(ei);
241
242 msg =
243 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
244 "cipher-mode-command");
245 if (!msg)
246 return NULL;
247
248 /* Message Type 3.2.2.1 */
249 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_CMD);
250
251 /* Encryption Information 3.2.2.10 */
252 gsm0808_enc_encrypt_info(msg, ei);
253
254 /* Cipher Response Mode 3.2.2.34 */
255 if (cipher_response_mode)
256 msgb_tv_put(msg, GSM0808_IE_CIPHER_RESPONSE_MODE,
257 *cipher_response_mode);
258
259 /* pre-pend the header */
260 msg->l3h =
261 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
262
263 return msg;
264}
265
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200266/*! Create BSSMAP Cipher Mode Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200267 * \param[in] layer3 L3 Message to be included
268 * \param[in] alg_id Chosen Encrpytion Algorithm
269 * \returns callee-allocated msgb with BSSMAP Cipher Mode Complete message */
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200270struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id)
271{
272 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
273 "cipher-complete");
274 if (!msg)
275 return NULL;
276
277 /* send response with BSS override for A5/1... cheating */
Harald Welte65c2d362012-01-21 14:26:01 +0100278 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_COMPLETE);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200279
280 /* include layer3 in case we have at least two octets */
281 if (layer3 && msgb_l3len(layer3) > 2) {
Harald Welte65c2d362012-01-21 14:26:01 +0100282 msg->l4h = msgb_tlv_put(msg, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS,
283 msgb_l3len(layer3), layer3->l3h);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200284 }
285
286 /* and the optional BSS message */
Harald Welte65c2d362012-01-21 14:26:01 +0100287 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, alg_id);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200288
Harald Welte65c2d362012-01-21 14:26:01 +0100289 /* pre-pend the header */
290 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
291
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200292 return msg;
293}
294
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200295/*! Create BSSMAP Cipher Mode Reject message
Maxaa934632018-11-07 13:16:54 +0100296 * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200297 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
Maxaa934632018-11-07 13:16:54 +0100298struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200299{
300 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
Maxaa934632018-11-07 13:16:54 +0100301 "bssmap: cipher mode reject");
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200302 if (!msg)
303 return NULL;
304
Harald Welte62e40852017-12-17 20:50:34 +0100305 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
Maxaa934632018-11-07 13:16:54 +0100306
Philipp Maier4f4905f2018-11-30 13:36:12 +0100307 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100308
309 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200310
311 return msg;
312}
313
Maxed651d22018-11-07 15:25:05 +0100314/*! Create BSSMAP Cipher Mode Reject message
315 * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class
316 * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)
317 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
318struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)
319{
Philipp Maier4f4905f2018-11-30 13:36:12 +0100320 uint16_t cause;
Maxed651d22018-11-07 15:25:05 +0100321 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
322 "bssmap: cipher mode reject");
323 if (!msg)
324 return NULL;
325
Philipp Maier4f4905f2018-11-30 13:36:12 +0100326 /* Set cause code class in the upper byte */
327 cause = 0x80 | (class << 4);
328 cause = cause << 8;
329
330 /* Set cause code extension in the lower byte */
331 cause |= ext;
Maxed651d22018-11-07 15:25:05 +0100332
333 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
334
Philipp Maier4f4905f2018-11-30 13:36:12 +0100335 gsm0808_enc_cause(msg, cause);
Maxed651d22018-11-07 15:25:05 +0100336
337 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
338
339 return msg;
340}
341
Harald Welte64e807c2018-05-29 21:00:56 +0200342/*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).
343 * \param[in] config LCLS Configuration
344 * \param[in] control LCLS Connection Status Control
345 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
Max45f89c92018-12-19 19:35:26 +0100346struct msgb *gsm0808_create_lcls_conn_ctrl(enum gsm0808_lcls_config config,
347 enum gsm0808_lcls_control control)
Harald Welte64e807c2018-05-29 21:00:56 +0200348{
Max45f89c92018-12-19 19:35:26 +0100349 struct msgb *msg;
350
351 /* According to NOTE 1 in §3.2.1.91 at least one of the parameters is required */
352 if (config == GSM0808_LCLS_CFG_NA && control == GSM0808_LCLS_CSC_NA)
353 return NULL;
354
355 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "bssmap: LCLS CONN CTRL");
Harald Welte64e807c2018-05-29 21:00:56 +0200356 if (!msg)
357 return NULL;
358
359 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL);
Max45f89c92018-12-19 19:35:26 +0100360 if (config != GSM0808_LCLS_CFG_NA)
361 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, config);
362 if (control != GSM0808_LCLS_CSC_NA)
363 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, control);
Harald Welte64e807c2018-05-29 21:00:56 +0200364 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
365
366 return msg;
367}
368
369/*! Create BSSMAP LCLS CONNECT CONTROL ACK message (TS 48.008 3.2.1.92).
370 * \param[in] status LCLS BSS Status
371 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
372struct msgb *gsm0808_create_lcls_conn_ctrl_ack(enum gsm0808_lcls_status status)
373{
374 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
375 "bssmap: LCLS CONN CTRL ACK");
376 if (!msg)
377 return NULL;
378
379 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK);
380 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
381 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
382
383 return msg;
384}
385
386/*! Create BSSMAP LCLS NOTIFICATION message (TS 48.008 3.2.1.93).
387 * \param[in] status LCLS BSS Status
388 * \param[in] break_req Include the LCLS BREAK REQ IE (true) or not (false)
389 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
390struct msgb *gsm0808_create_lcls_notification(enum gsm0808_lcls_status status, bool break_req)
391{
392 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
393 "bssmap: LCLS NOTIFICATION");
394 if (!msg)
395 return NULL;
396
397 msgb_v_put(msg, BSS_MAP_MSG_LCLS_NOTIFICATION);
398 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
399 if (break_req)
400 msgb_v_put(msg, GSM0808_IE_LCLS_BREAK_REQ);
401 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
402
403 return msg;
404}
405
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200406/*! Create BSSMAP Classmark Request message
407 * \returns callee-allocated msgb with BSSMAP Classmark Request message */
408struct msgb *gsm0808_create_classmark_request()
409{
410 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
411 "classmark-request");
412 if (!msg)
413 return NULL;
414
415 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_RQST);
416 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
417 return msg;
418}
Harald Welte64e807c2018-05-29 21:00:56 +0200419
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200420/*! Create BSSMAP Classmark Update message
Harald Welte96e2a002017-06-12 21:44:18 +0200421 * \param[in] cm2 Classmark 2
422 * \param[in] cm2_len length (in octets) of \a cm2
423 * \param[in] cm3 Classmark 3
424 * \param[in] cm3_len length (in octets) of \a cm3
425 * \returns callee-allocated msgb with BSSMAP Classmark Update message */
Harald Welte07b625d2012-01-23 10:02:58 +0100426struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,
427 const uint8_t *cm3, uint8_t cm3_len)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200428{
429 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
430 "classmark-update");
431 if (!msg)
432 return NULL;
433
Harald Welte65c2d362012-01-21 14:26:01 +0100434 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_UPDATE);
Harald Welte07b625d2012-01-23 10:02:58 +0100435 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2, cm2_len, cm2);
436 if (cm3)
437 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
438 cm3_len, cm3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200439
Harald Welte65c2d362012-01-21 14:26:01 +0100440 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
441
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200442 return msg;
443}
444
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200445/*! Create BSSMAP SAPI N Reject message
Harald Welte96e2a002017-06-12 21:44:18 +0200446 * \param[in] link_id Link Identifier
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700447 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
Harald Welte96e2a002017-06-12 21:44:18 +0200448 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700449struct msgb *gsm0808_create_sapi_reject_cause(uint8_t link_id, uint16_t cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200450{
451 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
452 "bssmap: sapi 'n' reject");
453 if (!msg)
454 return NULL;
455
Harald Welte65c2d362012-01-21 14:26:01 +0100456 msgb_v_put(msg, BSS_MAP_MSG_SAPI_N_REJECT);
Alexander Chemerisa5b1b862020-05-12 01:03:08 +0300457 msgb_tv_put(msg, GSM0808_IE_DLCI, link_id);
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700458 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100459
460 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200461
462 return msg;
463}
464
Vadim Yanitskiyfa6cd882020-08-26 18:03:59 +0700465/*! Create BSSMAP SAPI N Reject message (with hard-coded cause "BSS not equipped").
466 * DEPRECATED: use gsm0808_create_sapi_reject_cause() instead.
467 * \param[in] link_id Link Identifier
468 * \param[in] cause BSSAP Cause value (see 3GPP TS 48.008, section 3.2.2.5)
469 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
470struct msgb *gsm0808_create_sapi_reject(uint8_t link_id)
471{
472 return gsm0808_create_sapi_reject_cause(link_id, GSM0808_CAUSE_BSS_NOT_EQUIPPED);
473}
474
Max52074322018-11-30 10:44:07 +0100475/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
476 * This is identical to gsm0808_create_ass(), but adds KC and LCLS IEs.
Harald Welte96e2a002017-06-12 21:44:18 +0200477 * \param[in] ct Channel Type
478 * \param[in] cic Circuit Identity Code (Classic A only)
479 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
480 * \param[in] scl Speech Codec List (AoIP only)
Max49c06682018-11-21 22:10:26 +0100481 * \param[in] ci Call Identifier (Optional), §3.2.2.105
Max52074322018-11-30 10:44:07 +0100482 * \param[in] kc Kc128 ciphering key (Optional, A5/4), §3.2.2.109
483 * \param[in] lcls Optional LCLS parameters
Harald Welte96e2a002017-06-12 21:44:18 +0200484 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
Max52074322018-11-30 10:44:07 +0100485struct msgb *gsm0808_create_ass2(const struct gsm0808_channel_type *ct,
486 const uint16_t *cic,
487 const struct sockaddr_storage *ss,
488 const struct gsm0808_speech_codec_list *scl,
489 const uint32_t *ci,
490 const uint8_t *kc, const struct osmo_lcls *lcls)
Philipp Maierc6144a22017-03-29 17:53:43 +0200491{
492 /* See also: 3GPP TS 48.008 3.2.1.1 ASSIGNMENT REQUEST */
493 struct msgb *msg;
494 uint16_t cic_sw;
495 uint32_t ci_sw;
496
497 /* Mandatory emelent! */
498 OSMO_ASSERT(ct);
499
500 msg =
501 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
502 "bssmap: ass req");
503 if (!msg)
504 return NULL;
505
506 /* Message Type 3.2.2.1 */
507 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_RQST);
508
509 /* Channel Type 3.2.2.11 */
510 gsm0808_enc_channel_type(msg, ct);
511
512 /* Circuit Identity Code 3.2.2.2 */
513 if (cic) {
Harald Welte95871da2017-05-15 12:11:36 +0200514 cic_sw = osmo_htons(*cic);
Philipp Maierc6144a22017-03-29 17:53:43 +0200515 msgb_tv_fixed_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE,
516 sizeof(cic_sw), (uint8_t *) & cic_sw);
517 }
518
519 /* AoIP: AoIP Transport Layer Address (MGW) 3.2.2.102 */
520 if (ss) {
521 gsm0808_enc_aoip_trasp_addr(msg, ss);
522 }
523
524 /* AoIP: Codec List (MSC Preferred) 3.2.2.103 */
525 if (scl)
526 gsm0808_enc_speech_codec_list(msg, scl);
527
528 /* AoIP: Call Identifier 3.2.2.105 */
529 if (ci) {
Philipp Maier2908dbf2020-06-05 14:16:11 +0200530 /* NOTE: 3GPP TS 48.008, section 3.2.2.105 specifies that
531 the least significant byte should be transmitted first.
532 On x86, this would mean that the endieness is already
533 correct, however a platform independed implementation
534 is required: */
535#ifndef OSMO_IS_LITTLE_ENDIAN
536 ci_sw = osmo_swab32(*ci);
537#else
538 ci_sw = *ci;
539#endif
Philipp Maierc6144a22017-03-29 17:53:43 +0200540 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, sizeof(ci_sw),
541 (uint8_t *) & ci_sw);
542 }
543
Max52074322018-11-30 10:44:07 +0100544 if (kc)
545 msgb_tv_fixed_put(msg, GSM0808_IE_KC_128, 16, kc);
546
Max47022152018-12-19 18:51:00 +0100547 if (lcls)
548 gsm0808_enc_lcls(msg, lcls);
Max52074322018-11-30 10:44:07 +0100549
Philipp Maierc6144a22017-03-29 17:53:43 +0200550 /* push the bssmap header */
551 msg->l3h =
552 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
553
554 return msg;
555}
556
Max52074322018-11-30 10:44:07 +0100557/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
558 * \param[in] ct Channel Type
559 * \param[in] cic Circuit Identity Code (Classic A only)
560 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
561 * \param[in] scl Speech Codec List (AoIP only)
562 * \param[in] ci Call Identifier (Optional), §3.2.2.105
563 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
564struct msgb *gsm0808_create_ass(const struct gsm0808_channel_type *ct,
565 const uint16_t *cic,
566 const struct sockaddr_storage *ss,
567 const struct gsm0808_speech_codec_list *scl,
568 const uint32_t *ci)
569{
570 return gsm0808_create_ass2(ct, cic, ss, scl, ci, NULL, NULL);
571}
572
Max414c8f52019-01-08 14:44:24 +0100573/*! Create BSSMAP Assignment Completed message as per 3GPP TS 48.008 §3.2.1.2
Harald Welte96e2a002017-06-12 21:44:18 +0200574 * \param[in] rr_cause GSM 04.08 RR Cause value
575 * \param[in] chosen_channel Chosen Channel
576 * \param[in] encr_alg_id Encryption Algorithm ID
577 * \param[in] speech_mode Speech Mode
578 * \param[in] ss Socket Address of BSS-side RTP socket
579 * \param[in] sc Speech Codec (current)
580 * \param[in] scl Speech Codec List (permitted)
Max414c8f52019-01-08 14:44:24 +0100581 * \param[in] lcls_bss_status §3.2.2.119 LCLS-BSS-Status, optional
Harald Welte96e2a002017-06-12 21:44:18 +0200582 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Max414c8f52019-01-08 14:44:24 +0100583struct msgb *gsm0808_create_ass_compl2(uint8_t rr_cause, uint8_t chosen_channel,
Philipp Maierfa896ab2017-03-27 16:55:32 +0200584 uint8_t encr_alg_id, uint8_t speech_mode,
585 const struct sockaddr_storage *ss,
586 const struct gsm0808_speech_codec *sc,
Max414c8f52019-01-08 14:44:24 +0100587 const struct gsm0808_speech_codec_list *scl,
588 enum gsm0808_lcls_status lcls_bss_status)
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200589{
Harald Welte65c2d362012-01-21 14:26:01 +0100590 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
591 "bssmap: ass compl");
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200592 if (!msg)
593 return NULL;
594
Harald Welte65c2d362012-01-21 14:26:01 +0100595 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_COMPLETE);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200596
597 /* write 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100598 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, rr_cause);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200599
600 /* write cirtcuit identity code 3.2.2.2 */
601 /* write cell identifier 3.2.2.17 */
602 /* write chosen channel 3.2.2.33 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100603 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, chosen_channel);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200604
605 /* write chosen encryption algorithm 3.2.2.44 */
Harald Welte65c2d362012-01-21 14:26:01 +0100606 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, encr_alg_id);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200607
608 /* write circuit pool 3.2.2.45 */
609 /* write speech version chosen: 3.2.2.51 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100610 if (speech_mode != 0)
611 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, speech_mode);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200612
Philipp Maierfa896ab2017-03-27 16:55:32 +0200613 /* AoIP: AoIP Transport Layer Address (BSS) 3.2.2.102 */
614 if (ss)
615 gsm0808_enc_aoip_trasp_addr(msg, ss);
616
617 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
618 if (sc)
619 gsm0808_enc_speech_codec(msg, sc);
620
621 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
622 if (scl)
623 gsm0808_enc_speech_codec_list(msg, scl);
624
Max414c8f52019-01-08 14:44:24 +0100625 /* FIXME: write LSA identifier 3.2.2.15 - see 3GPP TS 43.073 */
626
627 /* LCLS-BSS-Status 3.2.2.119 */
628 if (lcls_bss_status != GSM0808_LCLS_STS_NA)
629 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, lcls_bss_status);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200630
Harald Welte65c2d362012-01-21 14:26:01 +0100631 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200632
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200633 return msg;
634}
635
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200636/*! Create BSSMAP Assignment Completed message
Harald Welte96e2a002017-06-12 21:44:18 +0200637 * \param[in] rr_cause GSM 04.08 RR Cause value
638 * \param[in] chosen_channel Chosen Channel
639 * \param[in] encr_alg_id Encryption Algorithm ID
640 * \param[in] speech_mode Speech Mode
Max414c8f52019-01-08 14:44:24 +0100641 * \param[in] ss Socket Address of BSS-side RTP socket
642 * \param[in] sc Speech Codec (current)
643 * \param[in] scl Speech Codec List (permitted)
644 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
645struct msgb *gsm0808_create_ass_compl(uint8_t rr_cause, uint8_t chosen_channel,
646 uint8_t encr_alg_id, uint8_t speech_mode,
647 const struct sockaddr_storage *ss,
648 const struct gsm0808_speech_codec *sc,
649 const struct gsm0808_speech_codec_list *scl)
650{
651 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id, speech_mode,
652 ss, sc, scl, GSM0808_LCLS_STS_NA);
653}
654
655/*! Create BSSMAP Assignment Completed message
656 * \param[in] rr_cause GSM 04.08 RR Cause value
657 * \param[in] chosen_channel Chosen Channel
658 * \param[in] encr_alg_id Encryption Algorithm ID
659 * \param[in] speech_mode Speech Mode
Harald Welte96e2a002017-06-12 21:44:18 +0200660 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200661struct msgb *gsm0808_create_assignment_completed(uint8_t rr_cause,
662 uint8_t chosen_channel,
663 uint8_t encr_alg_id,
664 uint8_t speech_mode)
665{
Max414c8f52019-01-08 14:44:24 +0100666 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id,
667 speech_mode, NULL, NULL, NULL, GSM0808_LCLS_STS_NA);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200668}
669
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200670/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200671 * \param[in] cause BSSMAP Cause value
672 * \param[in] rr_cause GSM 04.08 RR Cause value
673 * \param[in] scl Optional Speech Cdec List (AoIP)
674 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200675struct msgb *gsm0808_create_ass_fail(uint8_t cause, const uint8_t *rr_cause,
676 const struct gsm0808_speech_codec_list
677 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200678{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200679 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
680 "bssmap: ass fail");
681 if (!msg)
682 return NULL;
683
Harald Welte65c2d362012-01-21 14:26:01 +0100684 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_FAILURE);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100685 gsm0808_enc_cause(msg, cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200686
687 /* RR cause 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100688 if (rr_cause)
689 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, *rr_cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200690
691 /* Circuit pool 3.22.45 */
692 /* Circuit pool list 3.2.2.46 */
693
Philipp Maierfa896ab2017-03-27 16:55:32 +0200694 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
695 if (scl)
696 gsm0808_enc_speech_codec_list(msg, scl);
697
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200698 /* update the size */
Harald Welte65c2d362012-01-21 14:26:01 +0100699 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
700
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200701 return msg;
702}
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +0200703
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200704/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200705 * \param[in] cause BSSMAP Cause value
706 * \param[in] rr_cause GSM 04.08 RR Cause value
707 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200708struct msgb *gsm0808_create_assignment_failure(uint8_t cause,
709 uint8_t *rr_cause)
710{
711 return gsm0808_create_ass_fail(cause, rr_cause, NULL);
712}
713
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200714/*! Create BSSMAP Clear Request message
Harald Welte96e2a002017-06-12 21:44:18 +0200715 * \param[in] cause BSSMAP Cause value
716 * \returns callee-allocated msgb with BSSMAP Clear Request message */
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100717struct msgb *gsm0808_create_clear_rqst(uint8_t cause)
718{
719 struct msgb *msg;
720
721 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
722 "bssmap: clear rqst");
723 if (!msg)
724 return NULL;
725
Harald Welte65c2d362012-01-21 14:26:01 +0100726 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_RQST);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100727 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100728 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100729
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100730 return msg;
731}
732
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200733/*! Create BSSMAP PAGING message
Harald Welte96e2a002017-06-12 21:44:18 +0200734 * \param[in] imsi Mandatory paged IMSI in string representation
735 * \param[in] tmsi Optional paged TMSI
Stefan Sperling3953f412018-08-28 15:06:30 +0200736 * \param[in] cil Mandatory Cell Identity List (where to page)
Harald Welte96e2a002017-06-12 21:44:18 +0200737 * \param[in] chan_needed Channel Type needed
738 * \returns callee-allocated msgb with BSSMAP PAGING message */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100739struct msgb *gsm0808_create_paging2(const char *imsi, const uint32_t *tmsi,
740 const struct gsm0808_cell_id_list2 *cil,
741 const uint8_t *chan_needed)
Philipp Maier3d48ec02017-03-29 17:37:55 +0200742{
743 struct msgb *msg;
Harald Weltea13fb752020-06-16 08:44:42 +0200744 uint8_t mid_buf[GSM48_MI_SIZE + 2];
745 int mid_len;
Philipp Maier3d48ec02017-03-29 17:37:55 +0200746 uint32_t tmsi_sw;
747
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100748 /* Mandatory elements! */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200749 OSMO_ASSERT(imsi);
750 OSMO_ASSERT(cil);
751
752 /* Malformed IMSI */
753 OSMO_ASSERT(strlen(imsi) <= GSM48_MI_SIZE);
754
755 msg =
756 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "paging");
757 if (!msg)
758 return NULL;
759
760 /* Message Type 3.2.2.1 */
761 msgb_v_put(msg, BSS_MAP_MSG_PAGING);
762
Stefan Sperling3953f412018-08-28 15:06:30 +0200763 /* mandatory IMSI 3.2.2.6 */
Harald Weltea13fb752020-06-16 08:44:42 +0200764 mid_len = gsm48_generate_mid_from_imsi(mid_buf, imsi);
765 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200766
767 /* TMSI 3.2.2.7 */
768 if (tmsi) {
Harald Welte95871da2017-05-15 12:11:36 +0200769 tmsi_sw = osmo_htonl(*tmsi);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200770 msgb_tlv_put(msg, GSM0808_IE_TMSI, sizeof(*tmsi),
771 (uint8_t *) & tmsi_sw);
772 }
773
Stefan Sperling3953f412018-08-28 15:06:30 +0200774 /* mandatory Cell Identifier List 3.2.2.27 */
775 gsm0808_enc_cell_id_list2(msg, cil);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200776
777 /* Channel Needed 3.2.2.36 */
778 if (chan_needed) {
779 msgb_tv_put(msg, GSM0808_IE_CHANNEL_NEEDED,
780 (*chan_needed) & 0x03);
781 }
782
783 /* pre-pend the header */
784 msg->l3h =
785 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
786
787 return msg;
788}
789
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100790/*! DEPRECATED: Use gsm0808_create_paging2 instead.
791 * Create BSSMAP PAGING message.
792 * \param[in] imsi Mandatory paged IMSI in string representation
793 * \param[in] tmsi Optional paged TMSI
794 * \param[in] cil Cell Identity List (where to page)
795 * \param[in] chan_needed Channel Type needed
796 * \returns callee-allocated msgb with BSSMAP PAGING message */
797struct msgb *gsm0808_create_paging(const char *imsi, const uint32_t *tmsi,
798 const struct gsm0808_cell_id_list *cil,
799 const uint8_t *chan_needed)
800{
801 struct gsm0808_cell_id_list2 cil2 = {};
802
803 /* Mandatory emelents! */
804 OSMO_ASSERT(cil);
805
806 if (cil->id_list_len > GSM0808_CELL_ID_LIST2_MAXLEN)
807 return NULL;
808
809 cil2.id_discr = cil->id_discr;
810 memcpy(cil2.id_list, cil->id_list_lac, cil->id_list_len * sizeof(cil2.id_list[0].lac));
811 cil2.id_list_len = cil->id_list_len;
812
813 return gsm0808_create_paging2(imsi, tmsi, &cil2, chan_needed);
814}
815
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100816static uint8_t put_old_bss_to_new_bss_information(struct msgb *msg,
817 const struct gsm0808_old_bss_to_new_bss_info *i)
818{
819 uint8_t *old_tail;
820 uint8_t *tlv_len;
821
822 msgb_put_u8(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION);
823 tlv_len = msgb_put(msg, 1);
824 old_tail = msg->tail;
825
826 if (i->extra_information_present) {
827 uint8_t val = 0;
828 if (i->extra_information.prec)
829 val |= 1 << 0;
830 if (i->extra_information.lcs)
831 val |= 1 << 1;
832 if (i->extra_information.ue_prob)
833 val |= 1 << 2;
834 msgb_tlv_put(msg, GSM0808_FE_IE_EXTRA_INFORMATION, 1, &val);
835 }
836
837 if (i->current_channel_type_2_present) {
838 uint8_t val[2] = {
839 i->current_channel_type_2.mode,
840 i->current_channel_type_2.field,
841 };
842 msgb_tlv_put(msg, GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2, 2, val);
843 }
844
845 *tlv_len = (uint8_t) (msg->tail - old_tail);
846 return *tlv_len + 2;
847}
848
849/*! Create BSSMAP HANDOVER REQUIRED message.
850 * \param[in] params All information to be encoded.
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200851 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED message. */
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100852struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params)
853{
854 struct msgb *msg;
855
856 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED");
857 if (!msg)
858 return NULL;
859
860 /* Message Type, 3.2.2.1 */
861 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED);
862
863 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +0100864 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100865
866 /* Cell Identifier List, 3.2.2.27 */
867 gsm0808_enc_cell_id_list2(msg, &params->cil);
868
869 /* Current Channel Type 1, 3.2.2.49 */
870 if (params->current_channel_type_1_present)
871 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
872
873 /* Speech Version (Used), 3.2.2.51 */
874 if (params->speech_version_used_present)
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200875 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100876
877 if (params->old_bss_to_new_bss_info_present)
878 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
879
880 /* pre-pend the header */
881 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
882
883 return msg;
884}
885
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100886/*! Create BSSMAP HANDOVER REQUIRED REJECT message.
887 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED REJECT message. */
888struct msgb *gsm0808_create_handover_required_reject(const struct gsm0808_handover_required_reject *params)
889{
890 struct msgb *msg;
891
892 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED-REJECT");
893 if (!msg)
894 return NULL;
895
896 /* Message Type, 3.2.2.1 */
897 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT);
898
899 /* Cause, 3.2.2.5 */
900 gsm0808_enc_cause(msg, params->cause);
901
902 /* prepend the header */
903 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
904
905 return msg;
906}
907
908/*! Create BSSMAP HANDOVER REQUEST message, 3GPP TS 48.008 3.2.1.8.
909 * Sent from the MSC to the potential new target cell during inter-BSC handover, or to the target MSC during inter-MSC
910 * handover.
911 */
912struct msgb *gsm0808_create_handover_request(const struct gsm0808_handover_request *params)
913{
914 struct msgb *msg;
915
916 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST");
917 if (!msg)
918 return NULL;
919
920 /* Message Type, 3.2.2.1 */
921 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST);
922
923 /* Channel Type 3.2.2.11 */
924 gsm0808_enc_channel_type(msg, &params->channel_type);
925
926 /* Encryption Information 3.2.2.10 */
927 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
928
929 /* Classmark Information 1 3.2.2.30 or Classmark Information 2 3.2.2.19 (Classmark 2 wins) */
930 if (params->classmark_information.classmark2_len) {
931 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2,
932 params->classmark_information.classmark2_len,
933 (const uint8_t*)&params->classmark_information.classmark2);
934 } else if (params->classmark_information.classmark1_set) {
935 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1,
936 sizeof(params->classmark_information.classmark1),
937 (const uint8_t*)&params->classmark_information.classmark1);
938 }
939 /* (Classmark 3 possibly follows below) */
940
941 /* Cell Identifier (Serving) , 3.2.2.17 */
942 gsm0808_enc_cell_id(msg, &params->cell_identifier_serving);
943
944 /* Cell Identifier (Target) , 3.2.2.17 */
945 gsm0808_enc_cell_id(msg, &params->cell_identifier_target);
946
947 /* Cause, 3.2.2.5 */
948 gsm0808_enc_cause(msg, params->cause);
949
950 /* Classmark Information 3 3.2.2.20 */
951 if (params->classmark_information.classmark3_len) {
952 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
953 params->classmark_information.classmark3_len,
954 (const uint8_t*)&params->classmark_information.classmark3);
955 }
956
957 /* Current Channel type 1 3.2.2.49 */
958 if (params->current_channel_type_1_present)
959 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
960
961 /* Speech Version (Used), 3.2.2.51 */
962 if (params->speech_version_used) {
963 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
964 }
965
966 /* Chosen Encryption Algorithm (Serving) 3.2.2.44 */
967 if (params->chosen_encryption_algorithm_serving)
968 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encryption_algorithm_serving);
969
970 /* Old BSS to New BSS Information 3.2.2.58 */
971 if (params->old_bss_to_new_bss_info_raw && params->old_bss_to_new_bss_info_raw_len) {
972 msgb_tlv_put(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION,
973 params->old_bss_to_new_bss_info_raw_len,
974 params->old_bss_to_new_bss_info_raw);
975 } else if (params->old_bss_to_new_bss_info_present) {
976 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
977 }
978
979 /* IMSI 3.2.2.6 */
980 if (params->imsi) {
Harald Weltea13fb752020-06-16 08:44:42 +0200981 uint8_t mid_buf[GSM48_MI_SIZE + 2];
982 int mid_len = gsm48_generate_mid_from_imsi(mid_buf, params->imsi);
983 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100984 }
985
986 if (params->aoip_transport_layer)
987 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
988
989 if (params->codec_list_msc_preferred)
990 gsm0808_enc_speech_codec_list(msg, params->codec_list_msc_preferred);
991
992 if (params->call_id_present) {
993 uint8_t val[4];
994 osmo_store32le(params->call_id, val);
995 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, 4, val);
996 }
997
998 if (params->global_call_reference && params->global_call_reference_len) {
999 msgb_tlv_put(msg, GSM0808_IE_GLOBAL_CALL_REF,
1000 params->global_call_reference_len, params->global_call_reference);
1001 }
1002
1003 /* prepend header with final length */
1004 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1005
1006 return msg;
1007}
1008
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001009/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.
1010 * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.
1011 * 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 +01001012struct msgb *gsm0808_create_handover_request_ack2(const struct gsm0808_handover_request_ack *params)
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001013{
1014 struct msgb *msg;
1015
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001016 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001017 if (!msg)
1018 return NULL;
1019
1020 /* Message Type, 3.2.2.1 */
1021 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE);
1022
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001023 /* Layer 3 Information, 3.2.2.24 -- it is actually mandatory, but rather compose a nonstandard message than
1024 * segfault or return NULL without a log message. */
1025 if (params->l3_info && params->l3_info_len)
1026 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001027
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001028 if (params->chosen_channel_present)
1029 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1030 if (params->chosen_encr_alg)
1031 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1032
1033 if (params->chosen_speech_version != 0)
1034 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->chosen_speech_version);
1035
1036 if (params->aoip_transport_layer)
1037 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1038
1039 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1040 if (params->speech_codec_chosen_present)
1041 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001042
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001043 /* prepend header with final length */
1044 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1045
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001046 return msg;
1047}
1048
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001049/*! Same as gsm0808_create_handover_request_ack2() but with less parameters.
1050 * In particular, this lacks the AoIP Transport Layer address. */
1051struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,
1052 uint8_t chosen_channel, uint8_t chosen_encr_alg,
1053 uint8_t chosen_speech_version)
1054{
1055 struct gsm0808_handover_request_ack params = {
1056 .l3_info = l3_info,
1057 .l3_info_len = l3_info_len,
1058 .chosen_channel = chosen_channel,
1059 .chosen_encr_alg = chosen_encr_alg,
1060 .chosen_speech_version = chosen_speech_version,
1061 };
1062
1063 return gsm0808_create_handover_request_ack2(&params);
1064}
1065
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001066/*! Create BSSMAP HANDOVER COMMAND message, 3GPP TS 48.008 3.2.1.11.
1067 * Sent from the MSC to the old BSS to transmit the RR Handover Command received from the new BSS. */
1068struct msgb *gsm0808_create_handover_command(const struct gsm0808_handover_command *params)
1069{
1070 struct msgb *msg;
1071
1072 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMMAND");
1073 if (!msg)
1074 return NULL;
1075
1076 /* Message Type, 3.2.2.1 */
1077 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_CMD);
1078
1079 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
1080
1081 if (params->cell_identifier.id_discr != CELL_IDENT_NO_CELL)
1082 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1083
1084 if (params->new_bss_to_old_bss_info_raw
1085 && params->new_bss_to_old_bss_info_raw_len)
1086 msgb_tlv_put(msg, GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO, params->new_bss_to_old_bss_info_raw_len,
1087 params->new_bss_to_old_bss_info_raw);
1088
1089 /* prepend header with final length */
1090 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1091
1092 return msg;
1093}
1094
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001095/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.
1096 * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has
1097 * received the Handover Detect message. */
1098struct msgb *gsm0808_create_handover_detect()
1099{
1100 struct msgb *msg;
1101
1102 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1103 if (!msg)
1104 return NULL;
1105
1106 /* Message Type, 3.2.2.1 */
1107 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);
1108
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001109 /* prepend header with final length */
1110 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1111
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001112 return msg;
1113}
1114
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001115/*! Create BSSMAP HANDOVER SUCCEEDED message, 3GPP TS 48.008 3.2.1.13.
1116 * Sent from the MSC back to the old BSS to notify that the MS has successfully accessed the new BSS. */
1117struct msgb *gsm0808_create_handover_succeeded()
1118{
1119 struct msgb *msg;
1120
1121 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1122 if (!msg)
1123 return NULL;
1124
1125 /* Message Type, 3.2.2.1 */
1126 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_SUCCEEDED);
1127
1128 /* prepend header with final length */
1129 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1130
1131 return msg;
1132}
1133
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001134/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.
1135 * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */
1136struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)
1137{
1138 struct msgb *msg;
1139
1140 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");
1141 if (!msg)
1142 return NULL;
1143
1144 /* Message Type, 3.2.2.1 */
1145 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);
1146
1147 /* RR Cause, 3.2.2.22 */
1148 if (params->rr_cause_present)
1149 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1150
1151 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1152 if (params->speech_codec_chosen_present)
1153 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1154
1155 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1156 if (params->codec_list_bss_supported.len)
1157 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1158
1159 /* Chosen Encryption Algorithm 3.2.2.44 */
1160 if (params->chosen_encr_alg_present)
1161 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1162
1163 /* LCLS-BSS-Status 3.2.2.119 */
1164 if (params->lcls_bss_status_present)
1165 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1166
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001167 /* prepend header with final length */
1168 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1169
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001170 return msg;
1171}
1172
1173/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.
1174 * Sent from the MT BSC back to the MSC when the handover has failed. */
1175struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)
1176{
1177 struct msgb *msg;
1178
1179 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");
1180 if (!msg)
1181 return NULL;
1182
1183 /* Message Type, 3.2.2.1 */
1184 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);
1185
1186 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001187 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001188
1189 /* RR Cause, 3.2.2.22 */
1190 if (params->rr_cause_present)
1191 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1192
1193 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1194 if (params->codec_list_bss_supported.len)
1195 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1196
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001197 /* prepend header with final length */
1198 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1199
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001200 return msg;
1201}
1202
Philipp Maier225bdf42018-10-30 14:56:59 +01001203/*! Create BSSMAP HANDOVER PERFORMED message, 3GPP TS 48.008 3.2.1.25.
1204 * \param[in] params All information to be encoded.
1205 * \returns callee-allocated msgb with BSSMAP HANDOVER PERFORMED message */
1206struct msgb *gsm0808_create_handover_performed(const struct gsm0808_handover_performed *params)
1207{
1208 struct msgb *msg;
1209
1210 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-PERFORMED");
1211 if (!msg)
1212 return NULL;
1213
1214 /* Message Type, 3.2.2.1 */
1215 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_PERFORMED);
1216
1217 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001218 gsm0808_enc_cause(msg, params->cause);
Philipp Maier225bdf42018-10-30 14:56:59 +01001219
1220 /* Cell Identifier, 3.2.2.17 */
1221 gsm0808_enc_cell_id(msg, &params->cell_id);
1222
1223 /* Chosen Channel 3.2.2.33 */
1224 if (params->chosen_channel_present)
1225 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1226
1227 /* Chosen Encryption Algorithm 3.2.2.44 */
1228 if (params->chosen_encr_alg_present)
1229 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1230
1231 /* Speech Version (chosen) 3.2.2.51 */
1232 if (params->speech_version_chosen_present)
1233 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_chosen);
1234
1235 /* AoIP: Speech Codec (chosen) 3.2.2.104 */
1236 if (params->speech_codec_chosen_present)
1237 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1238
1239 /* LCLS-BSS-Status 3.2.2.119 */
1240 if (params->lcls_bss_status_present)
1241 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1242
1243 /* prepend header with final length */
1244 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1245
1246 return msg;
1247}
1248
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001249/*! Create BSSMAP COMMON ID message, 3GPP TS 48.008 3.2.1.68.
1250 * \param[in] imsi IMSI digits (decimal string).
1251 * \param[in] selected_plmn_id Selected PLMN ID to encode, or NULL to not encode this IE.
1252 * \param[in] last_used_eutran_plnm_id Last used E-UTRAN PLMN ID to encode, or NULL to not encode this IE.
1253 * \returns callee-allocated msgb with BSSMAP COMMON ID message, or NULL if encoding failed. */
Harald Welte1bd726a2020-06-21 22:04:52 +02001254struct msgb *gsm0808_create_common_id(const char *imsi,
1255 const struct osmo_plmn_id *selected_plmn_id,
1256 const struct osmo_plmn_id *last_used_eutran_plnm_id)
1257{
1258 struct msgb *msg;
Harald Welte1bd726a2020-06-21 22:04:52 +02001259 uint8_t *out;
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001260 struct osmo_mobile_identity mi;
1261 int rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001262
1263 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "COMMON-ID");
1264 if (!msg)
1265 return NULL;
1266
1267 /* Message Type, 3.2.2.1 */
1268 msgb_v_put(msg, BSS_MAP_MSG_COMMON_ID);
1269
1270 /* mandatory IMSI 3.2.2.6 */
Neels Hofmeyr9b35e562020-06-22 17:59:18 +02001271 mi = (struct osmo_mobile_identity){ .type = GSM_MI_TYPE_IMSI };
1272 OSMO_STRLCPY_ARRAY(mi.imsi, imsi);
1273 out = msgb_tl_put(msg, GSM0808_IE_IMSI);
1274 rc = osmo_mobile_identity_encode_msgb(msg, &mi, false);
1275 if (rc < 0) {
1276 msgb_free(msg);
1277 return NULL;
1278 }
1279 /* write the MI value length */
1280 *out = rc;
Harald Welte1bd726a2020-06-21 22:04:52 +02001281
1282 /* not implemented: SNA Access Information */
1283
1284 /* Selected PLMN ID */
1285 if (selected_plmn_id) {
1286 msgb_v_put(msg, GSM0808_IE_SELECTED_PLMN_ID);
1287 out = msgb_put(msg, 3);
1288 osmo_plmn_to_bcd(out, selected_plmn_id);
1289 }
1290
1291 /* Last used E-UTRAN PLMN ID */
1292 if (last_used_eutran_plnm_id) {
1293 msgb_v_put(msg, GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID);
1294 out = msgb_put(msg, 3);
1295 osmo_plmn_to_bcd(out, last_used_eutran_plnm_id);
1296 }
1297
1298 /* prepend header with final length */
1299 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1300
1301 return msg;
1302}
1303
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001304/*! Prepend a DTAP header to given Message Buffer
Harald Welte96e2a002017-06-12 21:44:18 +02001305 * \param[in] msgb Message Buffer
1306 * \param[in] link_id Link Identifier */
Holger Hans Peter Freyther9a3dec02010-05-16 08:15:40 +08001307void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id)
1308{
1309 uint8_t *hh = msgb_push(msg, 3);
1310 hh[0] = BSSAP_MSG_DTAP;
1311 hh[1] = link_id;
1312 hh[2] = msg->len - 3;
1313}
1314
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001315/*! Create BSSMAP DTAP message
Harald Welte96e2a002017-06-12 21:44:18 +02001316 * \param[in] msg_l3 Messge Buffer containing Layer3 message
1317 * \param[in] link_id Link Identifier
1318 * \returns callee-allocated msgb with BSSMAP DTAP message */
Holger Hans Peter Freytherc25c6682010-11-04 12:26:06 +01001319struct msgb *gsm0808_create_dtap(struct msgb *msg_l3, uint8_t link_id)
1320{
1321 struct dtap_header *header;
1322 uint8_t *data;
1323 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
1324 "dtap");
1325 if (!msg)
1326 return NULL;
1327
1328 /* DTAP header */
1329 msg->l3h = msgb_put(msg, sizeof(*header));
1330 header = (struct dtap_header *) &msg->l3h[0];
1331 header->type = BSSAP_MSG_DTAP;
1332 header->link_id = link_id;
1333 header->length = msgb_l3len(msg_l3);
1334
1335 /* Payload */
1336 data = msgb_put(msg, header->length);
1337 memcpy(data, msg_l3->l3h, header->length);
1338
1339 return msg;
1340}
1341
Harald Welte92107df2014-06-21 23:16:20 +02001342/* As per 3GPP TS 48.008 version 11.7.0 Release 11 */
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001343static const struct tlv_definition bss_att_tlvdef = {
1344 .def = {
Harald Welte92107df2014-06-21 23:16:20 +02001345 [GSM0808_IE_CIRCUIT_IDENTITY_CODE] = { TLV_TYPE_FIXED, 2 },
1346 [GSM0808_IE_CONNECTION_RELEASE_RQSTED] = { TLV_TYPE_TV },
1347 [GSM0808_IE_RESOURCE_AVAILABLE] = { TLV_TYPE_FIXED, 21 },
1348 [GSM0808_IE_CAUSE] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001349 [GSM0808_IE_IMSI] = { TLV_TYPE_TLV },
1350 [GSM0808_IE_TMSI] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001351 [GSM0808_IE_NUMBER_OF_MSS] = { TLV_TYPE_TV },
Dmitri Soloviev29099422013-07-11 09:25:37 +02001352 [GSM0808_IE_LAYER_3_HEADER_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001353 [GSM0808_IE_ENCRYPTION_INFORMATION] = { TLV_TYPE_TLV },
1354 [GSM0808_IE_CHANNEL_TYPE] = { TLV_TYPE_TLV },
1355 [GSM0808_IE_PERIODICITY] = { TLV_TYPE_TV },
1356 [GSM0808_IE_EXTENDED_RESOURCE_INDICATOR]= { TLV_TYPE_TV },
1357 [GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE] = { TLV_TYPE_FIXED, 4 },
1358 [GSM0808_IE_LSA_IDENTIFIER] = { TLV_TYPE_TLV },
1359 [GSM0808_IE_LSA_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther715e9452014-08-21 14:17:45 +02001360 [GSM0808_IE_LSA_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001361 [GSM0808_IE_CELL_IDENTIFIER] = { TLV_TYPE_TLV },
1362 [GSM0808_IE_PRIORITY] = { TLV_TYPE_TLV },
1363 [GSM0808_IE_CLASSMARK_INFORMATION_T2] = { TLV_TYPE_TLV },
1364 [GSM0808_IE_CLASSMARK_INFORMATION_T3] = { TLV_TYPE_TLV },
1365 [GSM0808_IE_INTERFERENCE_BAND_TO_USE] = { TLV_TYPE_TV },
1366 [GSM0808_IE_RR_CAUSE] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001367 [GSM0808_IE_LAYER_3_INFORMATION] = { TLV_TYPE_TLV },
1368 [GSM0808_IE_DLCI] = { TLV_TYPE_TV },
1369 [GSM0808_IE_DOWNLINK_DTX_FLAG] = { TLV_TYPE_TV },
1370 [GSM0808_IE_CELL_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
1371 [GSM0808_IE_CELL_ID_LIST_SEGMENT] = { TLV_TYPE_TLV },
1372 [GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS] = { TLV_TYPE_TLV },
1373 [GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE] = { TLV_TYPE_TLV },
1374 [GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS] = { TLV_TYPE_TLV },
1375 [GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS] = { TLV_TYPE_TLV },
1376 [GSM0808_IE_RESPONSE_RQST] = { TLV_TYPE_T },
1377 [GSM0808_IE_RESOURCE_INDICATION_METHOD] = { TLV_TYPE_TV },
1378 [GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1] = { TLV_TYPE_TV },
1379 [GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST] = { TLV_TYPE_TLV },
1380 [GSM0808_IE_DIAGNOSTIC] = { TLV_TYPE_TLV },
1381 [GSM0808_IE_CHOSEN_CHANNEL] = { TLV_TYPE_TV },
1382 [GSM0808_IE_CIPHER_RESPONSE_MODE] = { TLV_TYPE_TV },
1383 [GSM0808_IE_LAYER_3_MESSAGE_CONTENTS] = { TLV_TYPE_TLV },
1384 [GSM0808_IE_CHANNEL_NEEDED] = { TLV_TYPE_TV },
1385 [GSM0808_IE_TRACE_TYPE] = { TLV_TYPE_TV },
1386 [GSM0808_IE_TRIGGERID] = { TLV_TYPE_TLV },
1387 [GSM0808_IE_TRACE_REFERENCE] = { TLV_TYPE_TV },
1388 [GSM0808_IE_TRANSACTIONID] = { TLV_TYPE_TLV },
1389 [GSM0808_IE_MOBILE_IDENTITY] = { TLV_TYPE_TLV },
1390 [GSM0808_IE_OMCID] = { TLV_TYPE_TLV },
1391 [GSM0808_IE_FORWARD_INDICATOR] = { TLV_TYPE_TV },
Holger Hans Peter Freytherc2b7f922010-08-04 18:50:43 +08001392 [GSM0808_IE_CHOSEN_ENCR_ALG] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001393 [GSM0808_IE_CIRCUIT_POOL] = { TLV_TYPE_TV },
1394 [GSM0808_IE_CIRCUIT_POOL_LIST] = { TLV_TYPE_TLV },
1395 [GSM0808_IE_TIME_INDICATION] = { TLV_TYPE_TV },
1396 [GSM0808_IE_RESOURCE_SITUATION] = { TLV_TYPE_TLV },
1397 [GSM0808_IE_CURRENT_CHANNEL_TYPE_1] = { TLV_TYPE_TV },
1398 [GSM0808_IE_QUEUEING_INDICATOR] = { TLV_TYPE_TV },
1399 [GSM0808_IE_SPEECH_VERSION] = { TLV_TYPE_TV },
1400 [GSM0808_IE_ASSIGNMENT_REQUIREMENT] = { TLV_TYPE_TV },
1401 [GSM0808_IE_TALKER_FLAG] = { TLV_TYPE_T },
1402 [GSM0808_IE_GROUP_CALL_REFERENCE] = { TLV_TYPE_TLV },
1403 [GSM0808_IE_EMLPP_PRIORITY] = { TLV_TYPE_TV },
1404 [GSM0808_IE_CONFIG_EVO_INDI] = { TLV_TYPE_TV },
1405 [GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION] = { TLV_TYPE_TLV },
1406 [GSM0808_IE_LCS_QOS] = { TLV_TYPE_TLV },
1407 [GSM0808_IE_LSA_ACCESS_CTRL_SUPPR] = { TLV_TYPE_TV },
1408 [GSM0808_IE_LCS_PRIORITY] = { TLV_TYPE_TLV },
1409 [GSM0808_IE_LOCATION_TYPE] = { TLV_TYPE_TLV },
1410 [GSM0808_IE_LOCATION_ESTIMATE] = { TLV_TYPE_TLV },
1411 [GSM0808_IE_POSITIONING_DATA] = { TLV_TYPE_TLV },
1412 [GSM0808_IE_LCS_CAUSE] = { TLV_TYPE_TLV },
1413 [GSM0808_IE_APDU] = { TLV_TYPE_TLV },
1414 [GSM0808_IE_NETWORK_ELEMENT_IDENTITY] = { TLV_TYPE_TLV },
1415 [GSM0808_IE_GPS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1416 [GSM0808_IE_DECIPHERING_KEYS] = { TLV_TYPE_TLV },
1417 [GSM0808_IE_RETURN_ERROR_RQST] = { TLV_TYPE_TLV },
1418 [GSM0808_IE_RETURN_ERROR_CAUSE] = { TLV_TYPE_TLV },
1419 [GSM0808_IE_SEGMENTATION] = { TLV_TYPE_TLV },
1420 [GSM0808_IE_SERVICE_HANDOVER] = { TLV_TYPE_TLV },
1421 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS] = { TLV_TYPE_TLV },
1422 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000] = { TLV_TYPE_TLV },
1423 [GSM0808_IE_GERAN_CLASSMARK] = { TLV_TYPE_TLV },
1424 [GSM0808_IE_GERAN_BSC_CONTAINER] = { TLV_TYPE_TLV },
1425 [GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO] = { TLV_TYPE_TLV },
1426 [GSM0800_IE_INTER_SYSTEM_INFO] = { TLV_TYPE_TLV },
1427 [GSM0808_IE_SNA_ACCESS_INFO] = { TLV_TYPE_TLV },
1428 [GSM0808_IE_VSTK_RAND_INFO] = { TLV_TYPE_TLV },
1429 [GSM0808_IE_PAGING_INFO] = { TLV_TYPE_TV },
1430 [GSM0808_IE_IMEI] = { TLV_TYPE_TLV },
1431 [GSM0808_IE_VELOCITY_ESTIMATE] = { TLV_TYPE_TLV },
1432 [GSM0808_IE_VGCS_FEATURE_FLAGS] = { TLV_TYPE_TLV },
1433 [GSM0808_IE_TALKER_PRIORITY] = { TLV_TYPE_TV },
1434 [GSM0808_IE_EMERGENCY_SET_INDICATION] = { TLV_TYPE_T },
1435 [GSM0808_IE_TALKER_IDENTITY] = { TLV_TYPE_TLV },
1436 [GSM0808_IE_SMS_TO_VGCS] = { TLV_TYPE_TLV },
1437 [GSM0808_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
1438 [GSM0808_IE_VGCS_VBS_CELL_STATUS] = { TLV_TYPE_TLV },
1439 [GSM0808_IE_GANSS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1440 [GSM0808_IE_GANSS_POSITIONING_DATA] = { TLV_TYPE_TLV },
1441 [GSM0808_IE_GANSS_LOCATION_TYPE] = { TLV_TYPE_TLV },
1442 [GSM0808_IE_APP_DATA] = { TLV_TYPE_TLV },
1443 [GSM0808_IE_DATA_IDENTITY] = { TLV_TYPE_TLV },
1444 [GSM0808_IE_APP_DATA_INFO] = { TLV_TYPE_TLV },
1445 [GSM0808_IE_MSISDN] = { TLV_TYPE_TLV },
1446 [GSM0808_IE_AOIP_TRASP_ADDR] = { TLV_TYPE_TLV },
1447 [GSM0808_IE_SPEECH_CODEC_LIST] = { TLV_TYPE_TLV },
1448 [GSM0808_IE_SPEECH_CODEC] = { TLV_TYPE_TLV },
1449 [GSM0808_IE_CALL_ID] = { TLV_TYPE_FIXED, 4 },
1450 [GSM0808_IE_CALL_ID_LIST] = { TLV_TYPE_TLV },
1451 [GSM0808_IE_A_IF_SEL_FOR_RESET] = { TLV_TYPE_TV },
1452 [GSM0808_IE_KC_128] = { TLV_TYPE_FIXED, 16 },
1453 [GSM0808_IE_CSG_IDENTIFIER] = { TLV_TYPE_TLV },
1454 [GSM0808_IE_REDIR_ATTEMPT_FLAG] = { TLV_TYPE_T },
1455 [GSM0808_IE_REROUTE_REJ_CAUSE] = { TLV_TYPE_TV },
1456 [GSM0808_IE_SEND_SEQ_NUM] = { TLV_TYPE_TV },
1457 [GSM0808_IE_REROUTE_COMPL_OUTCOME] = { TLV_TYPE_TV },
1458 [GSM0808_IE_GLOBAL_CALL_REF] = { TLV_TYPE_TLV },
1459 [GSM0808_IE_LCLS_CONFIG] = { TLV_TYPE_TV },
1460 [GSM0808_IE_LCLS_CONN_STATUS_CTRL] = { TLV_TYPE_TV },
1461 [GSM0808_IE_LCLS_CORR_NOT_NEEDED] = { TLV_TYPE_TV },
1462 [GSM0808_IE_LCLS_BSS_STATUS] = { TLV_TYPE_TV },
1463 [GSM0808_IE_LCLS_BREAK_REQ] = { TLV_TYPE_TV },
1464 [GSM0808_IE_CSFB_INDICATION] = { TLV_TYPE_T },
1465 [GSM0808_IE_CS_TO_PS_SRVCC] = { TLV_TYPE_T },
1466 [GSM0808_IE_SRC_ENB_TO_TGT_ENB_TRANSP] = { TLV_TYPE_TLV },
1467 [GSM0808_IE_CS_TO_PS_SRVCC_IND] = { TLV_TYPE_T },
1468 [GSM0808_IE_CN_TO_MS_TRANSP_INFO] = { TLV_TYPE_TLV },
1469 [GSM0808_IE_SELECTED_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
1470 [GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol18506c82019-04-16 15:47:59 +02001471
1472 /* Osmocom extensions */
1473 [GSM0808_IE_OSMO_OSMUX_SUPPORT] = { TLV_TYPE_T },
1474 [GSM0808_IE_OSMO_OSMUX_CID] = { TLV_TYPE_TV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001475 },
1476};
1477
Harald Weltef4d45ab2011-07-16 12:13:00 +02001478const struct tlv_definition *gsm0808_att_tlvdef(void)
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001479{
1480 return &bss_att_tlvdef;
1481}
Harald Welte9b837e62011-07-11 17:43:19 +02001482
Pau Espin Pedrol392f6072019-11-27 12:07:04 +01001483const struct value_string gsm0406_dlci_sapi_names[] = {
1484 { DLCI_SAPI_RR_MM_CC, "RR/MM/CC" },
1485 { DLCI_SAPI_SMS, "SMS" },
1486 { 0, NULL }
1487};
1488
Harald Welte9b837e62011-07-11 17:43:19 +02001489static const struct value_string gsm0808_msgt_names[] = {
1490 { BSS_MAP_MSG_ASSIGMENT_RQST, "ASSIGNMENT REQ" },
1491 { BSS_MAP_MSG_ASSIGMENT_COMPLETE, "ASSIGNMENT COMPL" },
1492 { BSS_MAP_MSG_ASSIGMENT_FAILURE, "ASSIGNMENT FAIL" },
Harald Welte92107df2014-06-21 23:16:20 +02001493 { BSS_MAP_MSG_CHAN_MOD_RQST, "CHANNEL MODIFY REQUEST" },
Harald Welte9b837e62011-07-11 17:43:19 +02001494
1495 { BSS_MAP_MSG_HANDOVER_RQST, "HANDOVER REQ" },
1496 { BSS_MAP_MSG_HANDOVER_REQUIRED, "HANDOVER REQUIRED" },
1497 { BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE,"HANDOVER REQ ACK" },
1498 { BSS_MAP_MSG_HANDOVER_CMD, "HANDOVER CMD" },
1499 { BSS_MAP_MSG_HANDOVER_COMPLETE, "HANDOVER COMPLETE" },
1500 { BSS_MAP_MSG_HANDOVER_SUCCEEDED, "HANDOVER SUCCESS" },
1501 { BSS_MAP_MSG_HANDOVER_FAILURE, "HANDOVER FAILURE" },
1502 { BSS_MAP_MSG_HANDOVER_PERFORMED, "HANDOVER PERFORMED" },
1503 { BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE, "HANDOVER CAND ENQ" },
1504 { BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE, "HANDOVER CAND RESP" },
1505 { BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT, "HANDOVER REQ REJ" },
1506 { BSS_MAP_MSG_HANDOVER_DETECT, "HANDOVER DETECT" },
Harald Welte92107df2014-06-21 23:16:20 +02001507 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED, "INT HANDOVER REQ" },
1508 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED_REJ,"INT HANDOVER REQ REJ" },
1509 { BSS_MAP_MSG_INT_HANDOVER_CMD, "INT HANDOVER CMD" },
1510 { BSS_MAP_MSG_INT_HANDOVER_ENQUIRY, "INT HANDOVER ENQ" },
Harald Welte9b837e62011-07-11 17:43:19 +02001511
1512 { BSS_MAP_MSG_CLEAR_CMD, "CLEAR COMMAND" },
1513 { BSS_MAP_MSG_CLEAR_COMPLETE, "CLEAR COMPLETE" },
1514 { BSS_MAP_MSG_CLEAR_RQST, "CLEAR REQUEST" },
1515 { BSS_MAP_MSG_SAPI_N_REJECT, "SAPI N REJECT" },
1516 { BSS_MAP_MSG_CONFUSION, "CONFUSION" },
1517
1518 { BSS_MAP_MSG_SUSPEND, "SUSPEND" },
1519 { BSS_MAP_MSG_RESUME, "RESUME" },
1520 { BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION, "CONN ORIENT INFO" },
1521 { BSS_MAP_MSG_PERFORM_LOCATION_RQST, "PERFORM LOC REQ" },
1522 { BSS_MAP_MSG_LSA_INFORMATION, "LSA INFORMATION" },
1523 { BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE, "PERFORM LOC RESP" },
1524 { BSS_MAP_MSG_PERFORM_LOCATION_ABORT, "PERFORM LOC ABORT" },
1525 { BSS_MAP_MSG_COMMON_ID, "COMMON ID" },
Harald Welte92107df2014-06-21 23:16:20 +02001526 { BSS_MAP_MSG_REROUTE_CMD, "REROUTE COMMAND" },
1527 { BSS_MAP_MSG_REROUTE_COMPLETE, "REROUTE COMPLETE" },
Harald Welte9b837e62011-07-11 17:43:19 +02001528
1529 { BSS_MAP_MSG_RESET, "RESET" },
1530 { BSS_MAP_MSG_RESET_ACKNOWLEDGE, "RESET ACK" },
1531 { BSS_MAP_MSG_OVERLOAD, "OVERLOAD" },
1532 { BSS_MAP_MSG_RESET_CIRCUIT, "RESET CIRCUIT" },
1533 { BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE, "RESET CIRCUIT ACK" },
1534 { BSS_MAP_MSG_MSC_INVOKE_TRACE, "MSC INVOKE TRACE" },
1535 { BSS_MAP_MSG_BSS_INVOKE_TRACE, "BSS INVOKE TRACE" },
1536 { BSS_MAP_MSG_CONNECTIONLESS_INFORMATION, "CONNLESS INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02001537 { BSS_MAP_MSG_RESET_IP_RSRC, "RESET IP RESOURCE" },
1538 { BSS_MAP_MSG_RESET_IP_RSRC_ACK, "RESET IP RESOURCE ACK" },
Harald Welte9b837e62011-07-11 17:43:19 +02001539
1540 { BSS_MAP_MSG_BLOCK, "BLOCK" },
1541 { BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE, "BLOCK ACK" },
1542 { BSS_MAP_MSG_UNBLOCK, "UNBLOCK" },
1543 { BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE, "UNBLOCK ACK" },
1544 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK, "CIRC GROUP BLOCK" },
1545 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE, "CIRC GORUP BLOCK ACK" },
1546 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK, "CIRC GROUP UNBLOCK" },
1547 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE, "CIRC GROUP UNBLOCK ACK" },
1548 { BSS_MAP_MSG_UNEQUIPPED_CIRCUIT, "UNEQUIPPED CIRCUIT" },
1549 { BSS_MAP_MSG_CHANGE_CIRCUIT, "CHANGE CIRCUIT" },
1550 { BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE, "CHANGE CIRCUIT ACK" },
1551
1552 { BSS_MAP_MSG_RESOURCE_RQST, "RESOURCE REQ" },
1553 { BSS_MAP_MSG_RESOURCE_INDICATION, "RESOURCE IND" },
1554 { BSS_MAP_MSG_PAGING, "PAGING" },
1555 { BSS_MAP_MSG_CIPHER_MODE_CMD, "CIPHER MODE CMD" },
1556 { BSS_MAP_MSG_CLASSMARK_UPDATE, "CLASSMARK UPDATE" },
1557 { BSS_MAP_MSG_CIPHER_MODE_COMPLETE, "CIPHER MODE COMPLETE" },
1558 { BSS_MAP_MSG_QUEUING_INDICATION, "QUEUING INDICATION" },
1559 { BSS_MAP_MSG_COMPLETE_LAYER_3, "COMPLETE LAYER 3" },
1560 { BSS_MAP_MSG_CLASSMARK_RQST, "CLASSMARK REQ" },
1561 { BSS_MAP_MSG_CIPHER_MODE_REJECT, "CIPHER MODE REJECT" },
1562 { BSS_MAP_MSG_LOAD_INDICATION, "LOAD IND" },
1563
Harald Welte92107df2014-06-21 23:16:20 +02001564 { BSS_MAP_MSG_VGCS_VBS_SETUP, "VGCS/VBS SETUP" },
1565 { BSS_MAP_MSG_VGCS_VBS_SETUP_ACK, "VGCS/VBS SETUP ACK" },
1566 { BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE, "VGCS/VBS SETUP REFUSE" },
1567 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST, "VGCS/VBS ASSIGN REQ" },
1568 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT, "VGCS/VBS ASSIGN RES" },
1569 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE, "VGCS/VBS ASSIGN FAIL" },
1570 { BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION, "VGCS/VBS QUEUING IND" },
1571 { BSS_MAP_MSG_UPLINK_RQST, "UPLINK REQ" },
1572 { BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE, "UPLINK REQ ACK" },
1573 { BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION, "UPLINK REQ CONF" },
1574 { BSS_MAP_MSG_UPLINK_RELEASE_INDICATION,"UPLINK REL IND" },
1575 { BSS_MAP_MSG_UPLINK_REJECT_CMD, "UPLINK REJ CMD" },
1576 { BSS_MAP_MSG_UPLINK_RELEASE_CMD, "UPLINK REL CMD" },
1577 { BSS_MAP_MSG_UPLINK_SEIZED_CMD, "UPLINK SEIZED CMD" },
1578 { BSS_MAP_MSG_VGCS_ADDL_INFO, "VGCS ADDL INFO" },
1579 { BSS_MAP_MSG_NOTIFICATION_DATA, "NOTIF DATA" },
1580 { BSS_MAP_MSG_UPLINK_APP_DATA, "UPLINK APP DATA" },
1581
1582 { BSS_MAP_MSG_LCLS_CONNECT_CTRL, "LCLS-CONNECT-CONTROL" },
1583 { BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK, "CLS-CONNECT-CONTROL-ACK" },
1584 { BSS_MAP_MSG_LCLS_NOTIFICATION, "LCLS-NOTIFICATION" },
Harald Welte9b837e62011-07-11 17:43:19 +02001585
1586 { 0, NULL }
1587};
1588
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001589/*! Return string name of BSSMAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001590const char *gsm0808_bssmap_name(uint8_t msg_type)
1591{
1592 return get_value_string(gsm0808_msgt_names, msg_type);
1593}
1594
1595static const struct value_string gsm0808_bssap_names[] = {
1596 { BSSAP_MSG_BSS_MANAGEMENT, "MANAGEMENT" },
1597 { BSSAP_MSG_DTAP, "DTAP" },
Neels Hofmeyr90fdb082017-03-01 14:59:44 +01001598 { 0, NULL }
Harald Welte9b837e62011-07-11 17:43:19 +02001599};
1600
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001601/*! Return string name of BSSAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001602const char *gsm0808_bssap_name(uint8_t msg_type)
1603{
1604 return get_value_string(gsm0808_bssap_names, msg_type);
1605}
Harald Welte96e2a002017-06-12 21:44:18 +02001606
Neels Hofmeyrffad5742018-01-12 05:34:03 +01001607const struct value_string gsm0808_speech_codec_type_names[] = {
1608 { GSM0808_SCT_FR1, "FR1" },
1609 { GSM0808_SCT_FR2, "FR2" },
1610 { GSM0808_SCT_FR3, "FR3" },
1611 { GSM0808_SCT_FR4, "FR4" },
1612 { GSM0808_SCT_FR5, "FR5" },
1613 { GSM0808_SCT_HR1, "HR1" },
1614 { GSM0808_SCT_HR3, "HR3" },
1615 { GSM0808_SCT_HR4, "HR4" },
1616 { GSM0808_SCT_HR6, "HR6" },
1617 { GSM0808_SCT_CSD, "CSD" },
1618 { 0, NULL }
1619};
1620
Philipp Maiercdd05812018-07-12 18:21:07 +02001621const struct value_string gsm0808_permitted_speech_names[] = {
1622 { GSM0808_PERM_FR1, "FR1" },
1623 { GSM0808_PERM_FR2, "FR2" },
1624 { GSM0808_PERM_FR3, "FR3" },
1625 { GSM0808_PERM_FR4, "FR4" },
1626 { GSM0808_PERM_FR5, "FR5" },
1627 { GSM0808_PERM_HR1, "HR1" },
1628 { GSM0808_PERM_HR2, "HR2" },
1629 { GSM0808_PERM_HR3, "HR3" },
1630 { GSM0808_PERM_HR4, "HR4" },
1631 { GSM0808_PERM_HR6, "HR6" },
1632 { 0, NULL }
1633};
1634
Pau Espin Pedrolf2cda622018-07-06 17:16:41 +02001635const struct value_string gsm0808_chosen_enc_alg_names[] = {
1636 { GSM0808_ALG_ID_A5_0, "A5/0" },
1637 { GSM0808_ALG_ID_A5_1, "A5/1" },
1638 { GSM0808_ALG_ID_A5_2, "A5/2" },
1639 { GSM0808_ALG_ID_A5_3, "A5/3" },
1640 { GSM0808_ALG_ID_A5_4, "A5/4" },
1641 { GSM0808_ALG_ID_A5_5, "A5/5" },
1642 { GSM0808_ALG_ID_A5_6, "A5/6" },
1643 { GSM0808_ALG_ID_A5_7, "A5/7" },
1644 { 0, NULL }
1645};
1646
Philipp Maierdbb76592018-03-29 12:55:26 +02001647static const struct value_string gsm0808_cause_names[] = {
1648 { GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE, "RADIO INTERFACE MESSAGE FAILURE" },
1649 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, "RADIO INTERFACE FAILURE" },
1650 { GSM0808_CAUSE_UPLINK_QUALITY, "UPLINK QUALITY" },
1651 { GSM0808_CAUSE_UPLINK_STRENGTH, "UPLINK STRENGTH" },
1652 { GSM0808_CAUSE_DOWNLINK_QUALITY, "DOWNLINK QUALITY" },
1653 { GSM0808_CAUSE_DOWNLINK_STRENGTH, "DOWNLINK STRENGTH" },
1654 { GSM0808_CAUSE_DISTANCE, "DISTANCE" },
1655 { GSM0808_CAUSE_O_AND_M_INTERVENTION, "O AND M INTERVENTION" },
1656 { GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION, "RESPONSE TO MSC INVOCATION" },
1657 { GSM0808_CAUSE_CALL_CONTROL, "CALL CONTROL" },
1658 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION, "RADIO INTERFACE FAILURE REVERSION" },
1659 { GSM0808_CAUSE_HANDOVER_SUCCESSFUL, "HANDOVER SUCCESSFUL" },
1660 { GSM0808_CAUSE_BETTER_CELL, "BETTER CELL" },
1661 { GSM0808_CAUSE_DIRECTED_RETRY, "DIRECTED RETRY" },
1662 { GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL, "JOINED GROUP CALL CHANNEL" },
1663 { GSM0808_CAUSE_TRAFFIC, "TRAFFIC" },
1664 { GSM0808_CAUSE_REDUCE_LOAD_IN_SERVING_CELL, "REDUCE LOAD IN SERVING CELL" },
1665 { GSM0808_CAUSE_TRAFFIC_LOAD_IN_TGT_HIGHER_THAN_IN_SRC_CELL, "TRAFFIC LOAD IN TGT HIGHER THAN IN SRC CELL" },
1666 { GSM0808_CAUSE_RELOCATION_TRIGGERED, "RELOCATION TRIGGERED" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001667 { GSM0808_CAUSE_REQUESTED_OPT_NOT_AUTHORISED, "REQUESTED OPT NOT AUTHORISED" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001668 { GSM0808_CAUSE_ALT_CHAN_CONFIG_REQUESTED, "ALT CHAN CONFIG REQUESTED" },
1669 { GSM0808_CAUSE_RESP_TO_INT_HO_ENQ_MSG, "RESP TO INT HO ENQ MSG" },
1670 { GSM0808_CAUSE_INT_HO_ENQUIRY_REJECT, "INT HO ENQUIRY REJECT" },
1671 { GSM0808_CAUSE_REDUNDANCY_LEVEL_NOT_ADEQUATE, "REDUNDANCY LEVEL NOT ADEQUATE" },
1672 { GSM0808_CAUSE_EQUIPMENT_FAILURE, "EQUIPMENT FAILURE" },
1673 { GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE, "NO RADIO RESOURCE AVAILABLE" },
1674 { GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, "RQSTED TERRESTRIAL RESOURCE UNAVAILABLE" },
1675 { GSM0808_CAUSE_CCCH_OVERLOAD, "CCCH OVERLOAD" },
1676 { GSM0808_CAUSE_PROCESSOR_OVERLOAD, "PROCESSOR OVERLOAD" },
1677 { GSM0808_CAUSE_BSS_NOT_EQUIPPED, "BSS NOT EQUIPPED" },
1678 { GSM0808_CAUSE_MS_NOT_EQUIPPED, "MS NOT EQUIPPED" },
1679 { GSM0808_CAUSE_INVALID_CELL, "INVALID CELL" },
1680 { GSM0808_CAUSE_TRAFFIC_LOAD, "TRAFFIC LOAD" },
1681 { GSM0808_CAUSE_PREEMPTION, "PREEMPTION" },
1682 { GSM0808_CAUSE_DTM_HO_SGSN_FAILURE, "DTM HO SGSN FAILURE" },
1683 { GSM0808_CAUSE_DTM_HO_PS_ALLOC_FAILURE, "DTM HO PS ALLOC FAILURE" },
1684 { GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE, "RQSTED TRANSCODING RATE ADAPTION UNAVAILABLE" },
1685 { GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH, "CIRCUIT POOL MISMATCH" },
1686 { GSM0808_CAUSE_SWITCH_CIRCUIT_POOL, "SWITCH CIRCUIT POOL" },
1687 { GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, "RQSTED SPEECH VERSION UNAVAILABLE" },
1688 { GSM0808_CAUSE_LSA_NOT_ALLOWED, "LSA NOT ALLOWED" },
1689 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_UNAVAIL, "REQ CODEC TYPE OR CONFIG UNAVAIL" },
1690 { GSM0808_CAUSE_REQ_A_IF_TYPE_UNAVAIL, "REQ A IF TYPE UNAVAIL" },
1691 { GSM0808_CAUSE_INVALID_CSG_CELL, "INVALID CSG CELL" },
1692 { GSM0808_CAUSE_REQ_REDUND_LEVEL_NOT_AVAIL, "REQ REDUND LEVEL NOT AVAIL" },
1693 { GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED, "CIPHERING ALGORITHM NOT SUPPORTED" },
1694 { GSM0808_CAUSE_GERAN_IU_MODE_FAILURE, "GERAN IU MODE FAILURE" },
1695 { GSM0808_CAUSE_INC_RELOC_NOT_SUPP_DT_PUESBINE_FEATURE, "INC RELOC NOT SUPP DT PUESBINE FEATURE" },
1696 { GSM0808_CAUSE_ACCESS_RESTRICTED_DUE_TO_SHARED_NETWORKS, "ACCESS RESTRICTED DUE TO SHARED NETWORKS" },
1697 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, "REQ CODEC TYPE OR CONFIG NOT SUPP" },
1698 { GSM0808_CAUSE_REQ_A_IF_TYPE_NOT_SUPP, "REQ A IF TYPE NOT SUPP" },
1699 { GSM0808_CAUSE_REQ_REDUND_LVL_NOT_SUPP, "REQ REDUND LVL NOT SUPP" },
1700 { GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED, "TERRESTRIAL CIRCUIT ALREADY ALLOCATED" },
1701 { GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS, "INVALID MESSAGE CONTENTS" },
1702 { GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING, "INFORMATION ELEMENT OR FIELD MISSING" },
1703 { GSM0808_CAUSE_INCORRECT_VALUE, "INCORRECT VALUE" },
1704 { GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE, "UNKNOWN MESSAGE TYPE" },
1705 { GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT, "UNKNOWN INFORMATION ELEMENT" },
1706 { GSM0808_CAUSE_DTM_HO_INVALID_PS_IND, "DTM HO INVALID PS IND" },
1707 { GSM0808_CAUSE_CALL_ID_ALREADY_ALLOC, "CALL ID ALREADY ALLOC" },
1708 { GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC, "PROTOCOL ERROR BETWEEN BSS AND MSC" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001709 { GSM0808_CAUSE_VGCS_VBS_CALL_NON_EXISTENT, "VGCS VBS CALL NON EXISTENT" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001710 { GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY, "DTM HO TIMER EXPIRY" },
1711 { 0, NULL }
1712};
1713
Maxaa934632018-11-07 13:16:54 +01001714static const struct value_string gsm0808_cause_class_names[] = {
1715 { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },
1716 { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },
1717 { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },
1718 { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },
1719 { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },
1720 { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },
1721 { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },
1722 { GSM0808_CAUSE_CLASS_INTW, "Interworking" },
1723 { 0, NULL }
1724};
1725
1726/*! Return string name of BSSMAP Cause Class name */
1727const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)
1728{
1729 return get_value_string(gsm0808_cause_class_names, class);
1730}
1731
Philipp Maierdbb76592018-03-29 12:55:26 +02001732/*! Return string name of BSSMAP Cause name */
Maxaa934632018-11-07 13:16:54 +01001733const char *gsm0808_cause_name(enum gsm0808_cause cause)
Philipp Maierdbb76592018-03-29 12:55:26 +02001734{
1735 return get_value_string(gsm0808_cause_names, cause);
1736}
1737
Alexander Chemerisfdfe25b2020-05-12 23:21:56 +03001738enum gsm0808_cause gsm0808_get_cause(const struct tlv_parsed *tp)
1739{
1740 const uint8_t *buf = TLVP_VAL_MINLEN(tp, GSM0808_IE_CAUSE, 1);
1741
1742 if (!buf)
1743 return -EBADMSG;
1744
1745 if (TLVP_LEN(tp, GSM0808_IE_CAUSE) > 1) {
1746 if (!gsm0808_cause_ext(buf[0]))
1747 return -EINVAL;
1748 return buf[1];
1749 }
1750
1751 return buf[0];
1752}
1753
Alexander Chemeris22630e62020-05-13 00:44:04 +03001754const char *gsm0808_diagnostics_octet_location_str(uint8_t pointer)
1755{
1756 switch (pointer) {
1757 case 0:
1758 return "Error location not determined";
1759 case 1:
1760 return "The first octet of the message received (i.e. the message type) was found erroneous (unknown)";
1761 case 0xfd:
1762 return "The first octet of the BSSAP header (Discrimination) was found erroneous";
1763 case 0xfe:
1764 return "(DTAP only) The DLCI (second) octet of the BSSAP header was found erroneous";
1765 case 0xff:
1766 return "The last octet of the BSSAP header (length indicator) was found erroneous";
1767 default:
1768 snprintf(str_buff, sizeof(str_buff), "The %d octet of the message received was found erroneous", pointer);
1769 return str_buff;
1770 }
1771}
1772
1773const char *gsm0808_diagnostics_bit_location_str(uint8_t bit_pointer)
1774{
1775 if (bit_pointer == 0) {
1776 return "No particular part of the octet is indicated";
1777 } else if (bit_pointer > 8) {
1778 return "Reserved value";
1779 }
1780
1781 snprintf(str_buff, sizeof(str_buff),
1782 "An error was provoked by the field whose most significant bit is in bit position %d",
1783 bit_pointer);
1784 return str_buff;
1785}
1786
Harald Welteebd362d2018-06-02 14:11:19 +02001787const struct value_string gsm0808_lcls_config_names[] = {
1788 { GSM0808_LCLS_CFG_BOTH_WAY, "Connect both-way" },
1789 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL,
1790 "Connect both-way, bi-cast UL to CN" },
1791 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL,
1792 "Connect both-way, send access DL from CN" },
1793 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL_BLOCK_LOCAL_DL,
1794 "Connect both-way, send access DL from CN, block local DL" },
1795 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL,
1796 "Connect both-way, bi-cast UL to CN, send access DL from CN" },
1797 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL_BLOCK_LOCAL_DL,
1798 "Connect both-way, bi-cast UL to CN, send access DL from CN, block local DL" },
Max961db7c2018-11-08 11:40:23 +01001799 { GSM0808_LCLS_CFG_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001800 { 0, NULL }
1801};
1802
1803const struct value_string gsm0808_lcls_control_names[] = {
1804 { GSM0808_LCLS_CSC_CONNECT, "Connect" },
1805 { GSM0808_LCLS_CSC_DO_NOT_CONNECT, "Do not connect" },
1806 { GSM0808_LCLS_CSC_RELEASE_LCLS, "Release LCLS" },
1807 { GSM0808_LCLS_CSC_BICAST_UL_AT_HANDOVER, "Bi-cast UL at Handover" },
1808 { GSM0808_LCLS_CSC_BICAST_UL_AND_RECV_DL_AT_HANDOVER, "Bi-cast UL and receive DL at Handover" },
Max961db7c2018-11-08 11:40:23 +01001809 { GSM0808_LCLS_CSC_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001810 { 0, NULL }
1811};
1812
1813const struct value_string gsm0808_lcls_status_names[] = {
1814 { GSM0808_LCLS_STS_NOT_YET_LS, "Call not yet locally switched" },
1815 { GSM0808_LCLS_STS_NOT_POSSIBLE_LS, "Call not possible to be locally switched" },
1816 { GSM0808_LCLS_STS_NO_LONGER_LS, "Call is no longer locally switched" },
1817 { GSM0808_LCLS_STS_REQ_LCLS_NOT_SUPP, "Requested LCLS configuration is not supported" },
1818 { GSM0808_LCLS_STS_LOCALLY_SWITCHED, "Call is locally switched with requested LCLS config" },
Max961db7c2018-11-08 11:40:23 +01001819 { GSM0808_LCLS_STS_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001820 { 0, NULL }
1821};
1822
Harald Welte96e2a002017-06-12 21:44:18 +02001823/*! @} */