blob: f9f7b5822825021da1c8107bb9e3cb5f274f1caa [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
Harald Welte95871da2017-05-15 12:11:36 +020024#include <osmocom/core/byteswap.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010025#include <osmocom/gsm/gsm0808.h>
Philipp Maierfa896ab2017-03-27 16:55:32 +020026#include <osmocom/gsm/gsm0808_utils.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010027#include <osmocom/gsm/protocol/gsm_08_08.h>
28#include <osmocom/gsm/gsm48.h>
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020029
Harald Welte96e2a002017-06-12 21:44:18 +020030/*! \addtogroup gsm0808
31 * @{
Harald Welte37b61652017-10-16 18:46:03 +020032 * \file gsm0808.c
33 * Helper functions regarding the TS 08.08 / 48.008 A interface, primarily
34 * message generation/encoding.
Harald Welte96e2a002017-06-12 21:44:18 +020035 */
36
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010037/*! Create "Complete L3 Info" for AoIP, legacy implementation.
38 * Instead use gsm0808_create_layer3_aoip2(), which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +020039 * \param[in] msg_l3 msgb containing Layer 3 Message
40 * \param[in] nc Mobile Network Code
41 * \param[in] cc Mobile Country Code
42 * \param[in] lac Location Area Code
43 * \param[in] _ci Cell Identity
44 * \param[in] scl Speech Codec List
45 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +020046struct msgb *gsm0808_create_layer3_aoip(const struct msgb *msg_l3, uint16_t nc,
47 uint16_t cc, int lac, uint16_t _ci,
48 const struct gsm0808_speech_codec_list
49 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020050{
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010051 struct osmo_cell_global_id cgi = {
52 .lai = {
53 .plmn = {
54 .mcc = cc,
55 .mnc = nc,
56 },
57 .lac = lac,
58 },
59 .cell_identity = _ci,
60 };
61 return gsm0808_create_layer3_2(msg_l3, &cgi, scl);
62}
63
64/*! Create "Complete L3 Info" for AoIP.
65 * \param[in] msg_l3 msgb containing Layer 3 Message -- not modified by this call.
66 * \param[in] cell MCC, MNC, LAC, CI to identify the cell.
67 * \param[in] scl Speech Codec List, optional.
68 * \returns newly allocated msgb with Complete L3 Info message */
69struct msgb *gsm0808_create_layer3_2(const struct msgb *msg_l3, const struct osmo_cell_global_id *cell,
70 const struct gsm0808_speech_codec_list *scl)
71{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020072 struct msgb* msg;
Harald Welte65c2d362012-01-21 14:26:01 +010073 struct {
74 uint8_t ident;
75 struct gsm48_loc_area_id lai;
76 uint16_t ci;
77 } __attribute__ ((packed)) lai_ci;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020078
79 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
80 "bssmap cmpl l3");
81 if (!msg)
82 return NULL;
83
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020084 /* create layer 3 header */
Harald Welte65c2d362012-01-21 14:26:01 +010085 msgb_v_put(msg, BSS_MAP_MSG_COMPLETE_LAYER_3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020086
87 /* create the cell header */
Harald Welte65c2d362012-01-21 14:26:01 +010088 lai_ci.ident = CELL_IDENT_WHOLE_GLOBAL;
Neels Hofmeyrc4fce142018-02-20 13:47:08 +010089 gsm48_generate_lai2(&lai_ci.lai, &cell->lai);
90 lai_ci.ci = osmo_htons(cell->cell_identity);
Harald Welte65c2d362012-01-21 14:26:01 +010091 msgb_tlv_put(msg, GSM0808_IE_CELL_IDENTIFIER, sizeof(lai_ci),
92 (uint8_t *) &lai_ci);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020093
94 /* copy the layer3 data */
Harald Welte65c2d362012-01-21 14:26:01 +010095 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION,
96 msgb_l3len(msg_l3), msg_l3->l3h);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +020097
Philipp Maierfa896ab2017-03-27 16:55:32 +020098 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
99 if (scl)
100 gsm0808_enc_speech_codec_list(msg, scl);
101
Harald Welte65c2d362012-01-21 14:26:01 +0100102 /* push the bssmap header */
103 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200104
105 return msg;
106}
107
Neels Hofmeyrc4fce142018-02-20 13:47:08 +0100108/*! Create "Complete L3 Info" for A, legacy implementation.
109 * Instead use gsm0808_create_layer3_2() with the scl parameter passed as NULL,
110 * which is capable of three-digit MNC with leading zeros.
Harald Welte96e2a002017-06-12 21:44:18 +0200111 * \param[in] msg_l3 msgb containing Layer 3 Message
112 * \param[in] nc Mobile Network Code
113 * \param[in] cc Mobile Country Code
114 * \param[in] lac Location Area Code
115 * \param[in] _ci Cell Identity
116 * \returns callee-allocated msgb with Complete L3 Info message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200117struct msgb *gsm0808_create_layer3(struct msgb *msg_l3, uint16_t nc,
118 uint16_t cc, int lac, uint16_t _ci)
119{
Neels Hofmeyr4eeb8082018-03-23 01:47:14 +0100120 struct osmo_cell_global_id cgi = {
121 .lai = {
122 .plmn = {
123 .mcc = cc,
124 .mnc = nc,
125 },
126 .lac = lac,
127 },
128 .cell_identity = _ci,
129 };
130 return gsm0808_create_layer3_2(msg_l3, &cgi, NULL);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200131}
132
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200133/*! Create BSSMAP RESET message
Harald Welte96e2a002017-06-12 21:44:18 +0200134 * \returns callee-allocated msgb with BSSMAP Reset message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200135struct msgb *gsm0808_create_reset(void)
136{
Harald Welte65c2d362012-01-21 14:26:01 +0100137 uint8_t cause = GSM0808_CAUSE_EQUIPMENT_FAILURE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200138 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
139 "bssmap: reset");
140 if (!msg)
141 return NULL;
142
Harald Welte65c2d362012-01-21 14:26:01 +0100143 msgb_v_put(msg, BSS_MAP_MSG_RESET);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100144 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100145 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
146
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200147 return msg;
148}
149
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200150/*! Create BSSMAP RESET ACK message
Harald Welte96e2a002017-06-12 21:44:18 +0200151 * \returns callee-allocated msgb with BSSMAP Reset ACK message */
Harald Weltea62fe312013-06-19 15:14:37 +0200152struct msgb *gsm0808_create_reset_ack(void)
153{
154 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
155 "bssmap: reset ack");
156 if (!msg)
157 return NULL;
158
159 msgb_v_put(msg, BSS_MAP_MSG_RESET_ACKNOWLEDGE);
160 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
161
162 return msg;
163}
164
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200165/*! Create BSSMAP Clear Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200166 * \returns callee-allocated msgb with BSSMAP Clear Complete message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200167struct msgb *gsm0808_create_clear_complete(void)
168{
169 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
170 "bssmap: clear complete");
Harald Welte65c2d362012-01-21 14:26:01 +0100171 uint8_t val = BSS_MAP_MSG_CLEAR_COMPLETE;
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200172 if (!msg)
173 return NULL;
174
Harald Welte65c2d362012-01-21 14:26:01 +0100175 msg->l3h = msg->data;
176 msgb_tlv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 1, &val);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200177
178 return msg;
179}
180
Harald Welted1365e12019-02-18 13:44:30 +0100181/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
182 * This is quite different from most (all?) other gsm0808_create_* which have l3h
183 * point to the BSSAP header. However, we have to keep this for backwards compatibility.
184 * Use gsm0808_create_clear_command2() for a 'modern' implementation.
Philipp Maier1a146c82018-10-30 09:36:49 +0100185 * \param[in] cause TS 08.08 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200186 * \returns callee-allocated msgb with BSSMAP Clear Command message */
Philipp Maier1a146c82018-10-30 09:36:49 +0100187struct msgb *gsm0808_create_clear_command(uint8_t cause)
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200188{
189 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
190 "bssmap: clear command");
191 if (!msg)
192 return NULL;
193
Holger Hans Peter Freytheraeebe392010-10-27 12:36:05 +0200194 msg->l3h = msgb_tv_put(msg, BSSAP_MSG_BSS_MANAGEMENT, 4);
195 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100196 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100197
Holger Hans Peter Freythera3f05d82010-10-27 11:49:24 +0200198 return msg;
199}
200
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100201/*! Create BSSMAP Clear Command message.
202 * \param[in] cause TS 08.08 cause value.
203 * \param[in] csfb_ind indicate that the call was established in an CSFB context.
204 * \returns callee-allocated msgb with BSSMAP Clear Command message. */
205struct msgb *gsm0808_create_clear_command2(uint8_t cause, bool csfb_ind)
206{
Harald Welte10ba47d2019-02-18 12:36:54 +0100207 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
208 "bssmap: clear command");
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100209 if (!msg)
210 return NULL;
211
Harald Welte10ba47d2019-02-18 12:36:54 +0100212 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_CMD);
213 gsm0808_enc_cause(msg, cause);
214
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100215 if (csfb_ind)
216 msgb_v_put(msg, GSM0808_IE_CSFB_INDICATION);
217
Harald Welte10ba47d2019-02-18 12:36:54 +0100218 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
219
Philipp Maier74c4c4e2019-02-04 16:42:28 +0100220 return msg;
221}
222
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200223/*! Create BSSMAP Cipher Mode Command message
Harald Welte96e2a002017-06-12 21:44:18 +0200224 * \param[in] ei Mandatory Encryption Information
225 * \param[in] cipher_response_mode optional 1-byte Cipher Response Mode
226 * \returns callee-allocated msgb with BSSMAP Cipher Mode Command message */
Philipp Maierb478dd32017-03-29 15:50:05 +0200227struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,
228 const uint8_t *cipher_response_mode)
229{
230 /* See also: 3GPP TS 48.008 3.2.1.30 CIPHER MODE COMMAND */
231 struct msgb *msg;
232
233 /* Mandatory emelent! */
234 OSMO_ASSERT(ei);
235
236 msg =
237 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
238 "cipher-mode-command");
239 if (!msg)
240 return NULL;
241
242 /* Message Type 3.2.2.1 */
243 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_CMD);
244
245 /* Encryption Information 3.2.2.10 */
246 gsm0808_enc_encrypt_info(msg, ei);
247
248 /* Cipher Response Mode 3.2.2.34 */
249 if (cipher_response_mode)
250 msgb_tv_put(msg, GSM0808_IE_CIPHER_RESPONSE_MODE,
251 *cipher_response_mode);
252
253 /* pre-pend the header */
254 msg->l3h =
255 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
256
257 return msg;
258}
259
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200260/*! Create BSSMAP Cipher Mode Complete message
Harald Welte96e2a002017-06-12 21:44:18 +0200261 * \param[in] layer3 L3 Message to be included
262 * \param[in] alg_id Chosen Encrpytion Algorithm
263 * \returns callee-allocated msgb with BSSMAP Cipher Mode Complete message */
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200264struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id)
265{
266 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
267 "cipher-complete");
268 if (!msg)
269 return NULL;
270
271 /* send response with BSS override for A5/1... cheating */
Harald Welte65c2d362012-01-21 14:26:01 +0100272 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_COMPLETE);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200273
274 /* include layer3 in case we have at least two octets */
275 if (layer3 && msgb_l3len(layer3) > 2) {
Harald Welte65c2d362012-01-21 14:26:01 +0100276 msg->l4h = msgb_tlv_put(msg, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS,
277 msgb_l3len(layer3), layer3->l3h);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200278 }
279
280 /* and the optional BSS message */
Harald Welte65c2d362012-01-21 14:26:01 +0100281 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, alg_id);
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200282
Harald Welte65c2d362012-01-21 14:26:01 +0100283 /* pre-pend the header */
284 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
285
Holger Hans Peter Freyther81716d52010-04-17 06:16:35 +0200286 return msg;
287}
288
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200289/*! Create BSSMAP Cipher Mode Reject message
Maxaa934632018-11-07 13:16:54 +0100290 * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value
Harald Welte96e2a002017-06-12 21:44:18 +0200291 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
Maxaa934632018-11-07 13:16:54 +0100292struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200293{
294 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
Maxaa934632018-11-07 13:16:54 +0100295 "bssmap: cipher mode reject");
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200296 if (!msg)
297 return NULL;
298
Harald Welte62e40852017-12-17 20:50:34 +0100299 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
Maxaa934632018-11-07 13:16:54 +0100300
Philipp Maier4f4905f2018-11-30 13:36:12 +0100301 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100302
303 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200304
305 return msg;
306}
307
Maxed651d22018-11-07 15:25:05 +0100308/*! Create BSSMAP Cipher Mode Reject message
309 * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class
310 * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)
311 * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */
312struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)
313{
Philipp Maier4f4905f2018-11-30 13:36:12 +0100314 uint16_t cause;
Maxed651d22018-11-07 15:25:05 +0100315 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
316 "bssmap: cipher mode reject");
317 if (!msg)
318 return NULL;
319
Philipp Maier4f4905f2018-11-30 13:36:12 +0100320 /* Set cause code class in the upper byte */
321 cause = 0x80 | (class << 4);
322 cause = cause << 8;
323
324 /* Set cause code extension in the lower byte */
325 cause |= ext;
Maxed651d22018-11-07 15:25:05 +0100326
327 msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);
328
Philipp Maier4f4905f2018-11-30 13:36:12 +0100329 gsm0808_enc_cause(msg, cause);
Maxed651d22018-11-07 15:25:05 +0100330
331 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
332
333 return msg;
334}
335
Harald Welte64e807c2018-05-29 21:00:56 +0200336/*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).
337 * \param[in] config LCLS Configuration
338 * \param[in] control LCLS Connection Status Control
339 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
Max45f89c92018-12-19 19:35:26 +0100340struct msgb *gsm0808_create_lcls_conn_ctrl(enum gsm0808_lcls_config config,
341 enum gsm0808_lcls_control control)
Harald Welte64e807c2018-05-29 21:00:56 +0200342{
Max45f89c92018-12-19 19:35:26 +0100343 struct msgb *msg;
344
345 /* According to NOTE 1 in §3.2.1.91 at least one of the parameters is required */
346 if (config == GSM0808_LCLS_CFG_NA && control == GSM0808_LCLS_CSC_NA)
347 return NULL;
348
349 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "bssmap: LCLS CONN CTRL");
Harald Welte64e807c2018-05-29 21:00:56 +0200350 if (!msg)
351 return NULL;
352
353 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL);
Max45f89c92018-12-19 19:35:26 +0100354 if (config != GSM0808_LCLS_CFG_NA)
355 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, config);
356 if (control != GSM0808_LCLS_CSC_NA)
357 msgb_tv_put(msg, GSM0808_IE_LCLS_CONFIG, control);
Harald Welte64e807c2018-05-29 21:00:56 +0200358 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
359
360 return msg;
361}
362
363/*! Create BSSMAP LCLS CONNECT CONTROL ACK message (TS 48.008 3.2.1.92).
364 * \param[in] status LCLS BSS Status
365 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
366struct msgb *gsm0808_create_lcls_conn_ctrl_ack(enum gsm0808_lcls_status status)
367{
368 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
369 "bssmap: LCLS CONN CTRL ACK");
370 if (!msg)
371 return NULL;
372
373 msgb_v_put(msg, BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK);
374 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
375 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
376
377 return msg;
378}
379
380/*! Create BSSMAP LCLS NOTIFICATION message (TS 48.008 3.2.1.93).
381 * \param[in] status LCLS BSS Status
382 * \param[in] break_req Include the LCLS BREAK REQ IE (true) or not (false)
383 * \returns callee-allocated msgb with BSSMAP LCLS NOTIFICATION */
384struct msgb *gsm0808_create_lcls_notification(enum gsm0808_lcls_status status, bool break_req)
385{
386 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
387 "bssmap: LCLS NOTIFICATION");
388 if (!msg)
389 return NULL;
390
391 msgb_v_put(msg, BSS_MAP_MSG_LCLS_NOTIFICATION);
392 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, status);
393 if (break_req)
394 msgb_v_put(msg, GSM0808_IE_LCLS_BREAK_REQ);
395 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
396
397 return msg;
398}
399
Neels Hofmeyr2c79d552018-09-13 05:36:32 +0200400/*! Create BSSMAP Classmark Request message
401 * \returns callee-allocated msgb with BSSMAP Classmark Request message */
402struct msgb *gsm0808_create_classmark_request()
403{
404 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
405 "classmark-request");
406 if (!msg)
407 return NULL;
408
409 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_RQST);
410 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
411 return msg;
412}
Harald Welte64e807c2018-05-29 21:00:56 +0200413
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200414/*! Create BSSMAP Classmark Update message
Harald Welte96e2a002017-06-12 21:44:18 +0200415 * \param[in] cm2 Classmark 2
416 * \param[in] cm2_len length (in octets) of \a cm2
417 * \param[in] cm3 Classmark 3
418 * \param[in] cm3_len length (in octets) of \a cm3
419 * \returns callee-allocated msgb with BSSMAP Classmark Update message */
Harald Welte07b625d2012-01-23 10:02:58 +0100420struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,
421 const uint8_t *cm3, uint8_t cm3_len)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200422{
423 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
424 "classmark-update");
425 if (!msg)
426 return NULL;
427
Harald Welte65c2d362012-01-21 14:26:01 +0100428 msgb_v_put(msg, BSS_MAP_MSG_CLASSMARK_UPDATE);
Harald Welte07b625d2012-01-23 10:02:58 +0100429 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2, cm2_len, cm2);
430 if (cm3)
431 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
432 cm3_len, cm3);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200433
Harald Welte65c2d362012-01-21 14:26:01 +0100434 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
435
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200436 return msg;
437}
438
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200439/*! Create BSSMAP SAPI N Reject message
Harald Welte96e2a002017-06-12 21:44:18 +0200440 * \param[in] link_id Link Identifier
441 * \returns callee-allocated msgb with BSSMAP SAPI N Reject message */
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200442struct msgb *gsm0808_create_sapi_reject(uint8_t link_id)
443{
444 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
445 "bssmap: sapi 'n' reject");
446 if (!msg)
447 return NULL;
448
Harald Welte65c2d362012-01-21 14:26:01 +0100449 msgb_v_put(msg, BSS_MAP_MSG_SAPI_N_REJECT);
450 msgb_v_put(msg, link_id);
451 msgb_v_put(msg, GSM0808_CAUSE_BSS_NOT_EQUIPPED);
452
453 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200454
455 return msg;
456}
457
Max52074322018-11-30 10:44:07 +0100458/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
459 * This is identical to gsm0808_create_ass(), but adds KC and LCLS IEs.
Harald Welte96e2a002017-06-12 21:44:18 +0200460 * \param[in] ct Channel Type
461 * \param[in] cic Circuit Identity Code (Classic A only)
462 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
463 * \param[in] scl Speech Codec List (AoIP only)
Max49c06682018-11-21 22:10:26 +0100464 * \param[in] ci Call Identifier (Optional), §3.2.2.105
Max52074322018-11-30 10:44:07 +0100465 * \param[in] kc Kc128 ciphering key (Optional, A5/4), §3.2.2.109
466 * \param[in] lcls Optional LCLS parameters
Harald Welte96e2a002017-06-12 21:44:18 +0200467 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
Max52074322018-11-30 10:44:07 +0100468struct msgb *gsm0808_create_ass2(const struct gsm0808_channel_type *ct,
469 const uint16_t *cic,
470 const struct sockaddr_storage *ss,
471 const struct gsm0808_speech_codec_list *scl,
472 const uint32_t *ci,
473 const uint8_t *kc, const struct osmo_lcls *lcls)
Philipp Maierc6144a22017-03-29 17:53:43 +0200474{
475 /* See also: 3GPP TS 48.008 3.2.1.1 ASSIGNMENT REQUEST */
476 struct msgb *msg;
477 uint16_t cic_sw;
478 uint32_t ci_sw;
479
480 /* Mandatory emelent! */
481 OSMO_ASSERT(ct);
482
483 msg =
484 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
485 "bssmap: ass req");
486 if (!msg)
487 return NULL;
488
489 /* Message Type 3.2.2.1 */
490 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_RQST);
491
492 /* Channel Type 3.2.2.11 */
493 gsm0808_enc_channel_type(msg, ct);
494
495 /* Circuit Identity Code 3.2.2.2 */
496 if (cic) {
Harald Welte95871da2017-05-15 12:11:36 +0200497 cic_sw = osmo_htons(*cic);
Philipp Maierc6144a22017-03-29 17:53:43 +0200498 msgb_tv_fixed_put(msg, GSM0808_IE_CIRCUIT_IDENTITY_CODE,
499 sizeof(cic_sw), (uint8_t *) & cic_sw);
500 }
501
502 /* AoIP: AoIP Transport Layer Address (MGW) 3.2.2.102 */
503 if (ss) {
504 gsm0808_enc_aoip_trasp_addr(msg, ss);
505 }
506
507 /* AoIP: Codec List (MSC Preferred) 3.2.2.103 */
508 if (scl)
509 gsm0808_enc_speech_codec_list(msg, scl);
510
511 /* AoIP: Call Identifier 3.2.2.105 */
512 if (ci) {
Harald Welte95871da2017-05-15 12:11:36 +0200513 ci_sw = osmo_htonl(*ci);
Philipp Maierc6144a22017-03-29 17:53:43 +0200514 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, sizeof(ci_sw),
515 (uint8_t *) & ci_sw);
516 }
517
Max52074322018-11-30 10:44:07 +0100518 if (kc)
519 msgb_tv_fixed_put(msg, GSM0808_IE_KC_128, 16, kc);
520
Max47022152018-12-19 18:51:00 +0100521 if (lcls)
522 gsm0808_enc_lcls(msg, lcls);
Max52074322018-11-30 10:44:07 +0100523
Philipp Maierc6144a22017-03-29 17:53:43 +0200524 /* push the bssmap header */
525 msg->l3h =
526 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
527
528 return msg;
529}
530
Max52074322018-11-30 10:44:07 +0100531/*! Create BSSMAP Assignment Request message, 3GPP TS 48.008 §3.2.1.1.
532 * \param[in] ct Channel Type
533 * \param[in] cic Circuit Identity Code (Classic A only)
534 * \param[in] ss Socket Address of MSC-side RTP socket (AoIP only)
535 * \param[in] scl Speech Codec List (AoIP only)
536 * \param[in] ci Call Identifier (Optional), §3.2.2.105
537 * \returns callee-allocated msgb with BSSMAP Assignment Request message */
538struct msgb *gsm0808_create_ass(const struct gsm0808_channel_type *ct,
539 const uint16_t *cic,
540 const struct sockaddr_storage *ss,
541 const struct gsm0808_speech_codec_list *scl,
542 const uint32_t *ci)
543{
544 return gsm0808_create_ass2(ct, cic, ss, scl, ci, NULL, NULL);
545}
546
Max414c8f52019-01-08 14:44:24 +0100547/*! Create BSSMAP Assignment Completed message as per 3GPP TS 48.008 §3.2.1.2
Harald Welte96e2a002017-06-12 21:44:18 +0200548 * \param[in] rr_cause GSM 04.08 RR Cause value
549 * \param[in] chosen_channel Chosen Channel
550 * \param[in] encr_alg_id Encryption Algorithm ID
551 * \param[in] speech_mode Speech Mode
552 * \param[in] ss Socket Address of BSS-side RTP socket
553 * \param[in] sc Speech Codec (current)
554 * \param[in] scl Speech Codec List (permitted)
Max414c8f52019-01-08 14:44:24 +0100555 * \param[in] lcls_bss_status §3.2.2.119 LCLS-BSS-Status, optional
Harald Welte96e2a002017-06-12 21:44:18 +0200556 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Max414c8f52019-01-08 14:44:24 +0100557struct msgb *gsm0808_create_ass_compl2(uint8_t rr_cause, uint8_t chosen_channel,
Philipp Maierfa896ab2017-03-27 16:55:32 +0200558 uint8_t encr_alg_id, uint8_t speech_mode,
559 const struct sockaddr_storage *ss,
560 const struct gsm0808_speech_codec *sc,
Max414c8f52019-01-08 14:44:24 +0100561 const struct gsm0808_speech_codec_list *scl,
562 enum gsm0808_lcls_status lcls_bss_status)
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200563{
Harald Welte65c2d362012-01-21 14:26:01 +0100564 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
565 "bssmap: ass compl");
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200566 if (!msg)
567 return NULL;
568
Harald Welte65c2d362012-01-21 14:26:01 +0100569 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_COMPLETE);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200570
571 /* write 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100572 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, rr_cause);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200573
574 /* write cirtcuit identity code 3.2.2.2 */
575 /* write cell identifier 3.2.2.17 */
576 /* write chosen channel 3.2.2.33 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100577 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, chosen_channel);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200578
579 /* write chosen encryption algorithm 3.2.2.44 */
Harald Welte65c2d362012-01-21 14:26:01 +0100580 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, encr_alg_id);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200581
582 /* write circuit pool 3.2.2.45 */
583 /* write speech version chosen: 3.2.2.51 when BTS picked it */
Harald Welte65c2d362012-01-21 14:26:01 +0100584 if (speech_mode != 0)
585 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, speech_mode);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200586
Philipp Maierfa896ab2017-03-27 16:55:32 +0200587 /* AoIP: AoIP Transport Layer Address (BSS) 3.2.2.102 */
588 if (ss)
589 gsm0808_enc_aoip_trasp_addr(msg, ss);
590
591 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
592 if (sc)
593 gsm0808_enc_speech_codec(msg, sc);
594
595 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
596 if (scl)
597 gsm0808_enc_speech_codec_list(msg, scl);
598
Max414c8f52019-01-08 14:44:24 +0100599 /* FIXME: write LSA identifier 3.2.2.15 - see 3GPP TS 43.073 */
600
601 /* LCLS-BSS-Status 3.2.2.119 */
602 if (lcls_bss_status != GSM0808_LCLS_STS_NA)
603 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, lcls_bss_status);
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200604
Harald Welte65c2d362012-01-21 14:26:01 +0100605 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200606
Holger Hans Peter Freytherba6172a2010-04-17 06:21:49 +0200607 return msg;
608}
609
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200610/*! Create BSSMAP Assignment Completed message
Harald Welte96e2a002017-06-12 21:44:18 +0200611 * \param[in] rr_cause GSM 04.08 RR Cause value
612 * \param[in] chosen_channel Chosen Channel
613 * \param[in] encr_alg_id Encryption Algorithm ID
614 * \param[in] speech_mode Speech Mode
Max414c8f52019-01-08 14:44:24 +0100615 * \param[in] ss Socket Address of BSS-side RTP socket
616 * \param[in] sc Speech Codec (current)
617 * \param[in] scl Speech Codec List (permitted)
618 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
619struct msgb *gsm0808_create_ass_compl(uint8_t rr_cause, uint8_t chosen_channel,
620 uint8_t encr_alg_id, uint8_t speech_mode,
621 const struct sockaddr_storage *ss,
622 const struct gsm0808_speech_codec *sc,
623 const struct gsm0808_speech_codec_list *scl)
624{
625 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id, speech_mode,
626 ss, sc, scl, GSM0808_LCLS_STS_NA);
627}
628
629/*! Create BSSMAP Assignment Completed message
630 * \param[in] rr_cause GSM 04.08 RR Cause value
631 * \param[in] chosen_channel Chosen Channel
632 * \param[in] encr_alg_id Encryption Algorithm ID
633 * \param[in] speech_mode Speech Mode
Harald Welte96e2a002017-06-12 21:44:18 +0200634 * \returns callee-allocated msgb with BSSMAP Assignment Complete message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200635struct msgb *gsm0808_create_assignment_completed(uint8_t rr_cause,
636 uint8_t chosen_channel,
637 uint8_t encr_alg_id,
638 uint8_t speech_mode)
639{
Max414c8f52019-01-08 14:44:24 +0100640 return gsm0808_create_ass_compl2(rr_cause, chosen_channel, encr_alg_id,
641 speech_mode, NULL, NULL, NULL, GSM0808_LCLS_STS_NA);
Philipp Maierfa896ab2017-03-27 16:55:32 +0200642}
643
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200644/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200645 * \param[in] cause BSSMAP Cause value
646 * \param[in] rr_cause GSM 04.08 RR Cause value
647 * \param[in] scl Optional Speech Cdec List (AoIP)
648 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200649struct msgb *gsm0808_create_ass_fail(uint8_t cause, const uint8_t *rr_cause,
650 const struct gsm0808_speech_codec_list
651 *scl)
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200652{
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200653 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
654 "bssmap: ass fail");
655 if (!msg)
656 return NULL;
657
Harald Welte65c2d362012-01-21 14:26:01 +0100658 msgb_v_put(msg, BSS_MAP_MSG_ASSIGMENT_FAILURE);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100659 gsm0808_enc_cause(msg, cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200660
661 /* RR cause 3.2.2.22 */
Harald Welte65c2d362012-01-21 14:26:01 +0100662 if (rr_cause)
663 msgb_tv_put(msg, GSM0808_IE_RR_CAUSE, *rr_cause);
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200664
665 /* Circuit pool 3.22.45 */
666 /* Circuit pool list 3.2.2.46 */
667
Philipp Maierfa896ab2017-03-27 16:55:32 +0200668 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
669 if (scl)
670 gsm0808_enc_speech_codec_list(msg, scl);
671
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200672 /* update the size */
Harald Welte65c2d362012-01-21 14:26:01 +0100673 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
674
Holger Hans Peter Freyther280cd512010-04-15 10:10:39 +0200675 return msg;
676}
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +0200677
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200678/*! Create BSSMAP Assignment Failure message
Harald Welte96e2a002017-06-12 21:44:18 +0200679 * \param[in] cause BSSMAP Cause value
680 * \param[in] rr_cause GSM 04.08 RR Cause value
681 * \returns callee-allocated msgb with BSSMAP Assignment Failure message */
Philipp Maierfa896ab2017-03-27 16:55:32 +0200682struct msgb *gsm0808_create_assignment_failure(uint8_t cause,
683 uint8_t *rr_cause)
684{
685 return gsm0808_create_ass_fail(cause, rr_cause, NULL);
686}
687
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200688/*! Create BSSMAP Clear Request message
Harald Welte96e2a002017-06-12 21:44:18 +0200689 * \param[in] cause BSSMAP Cause value
690 * \returns callee-allocated msgb with BSSMAP Clear Request message */
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100691struct msgb *gsm0808_create_clear_rqst(uint8_t cause)
692{
693 struct msgb *msg;
694
695 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
696 "bssmap: clear rqst");
697 if (!msg)
698 return NULL;
699
Harald Welte65c2d362012-01-21 14:26:01 +0100700 msgb_v_put(msg, BSS_MAP_MSG_CLEAR_RQST);
Philipp Maier4f4905f2018-11-30 13:36:12 +0100701 gsm0808_enc_cause(msg, cause);
Harald Welte65c2d362012-01-21 14:26:01 +0100702 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100703
Holger Hans Peter Freytheraf270a42010-11-04 12:42:50 +0100704 return msg;
705}
706
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200707/*! Create BSSMAP PAGING message
Harald Welte96e2a002017-06-12 21:44:18 +0200708 * \param[in] imsi Mandatory paged IMSI in string representation
709 * \param[in] tmsi Optional paged TMSI
Stefan Sperling3953f412018-08-28 15:06:30 +0200710 * \param[in] cil Mandatory Cell Identity List (where to page)
Harald Welte96e2a002017-06-12 21:44:18 +0200711 * \param[in] chan_needed Channel Type needed
712 * \returns callee-allocated msgb with BSSMAP PAGING message */
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100713struct msgb *gsm0808_create_paging2(const char *imsi, const uint32_t *tmsi,
714 const struct gsm0808_cell_id_list2 *cil,
715 const uint8_t *chan_needed)
Philipp Maier3d48ec02017-03-29 17:37:55 +0200716{
717 struct msgb *msg;
718 uint8_t mid_buf[GSM48_MI_SIZE + 2];
719 int mid_len;
720 uint32_t tmsi_sw;
721
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100722 /* Mandatory elements! */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200723 OSMO_ASSERT(imsi);
724 OSMO_ASSERT(cil);
725
726 /* Malformed IMSI */
727 OSMO_ASSERT(strlen(imsi) <= GSM48_MI_SIZE);
728
729 msg =
730 msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "paging");
731 if (!msg)
732 return NULL;
733
734 /* Message Type 3.2.2.1 */
735 msgb_v_put(msg, BSS_MAP_MSG_PAGING);
736
Stefan Sperling3953f412018-08-28 15:06:30 +0200737 /* mandatory IMSI 3.2.2.6 */
Philipp Maier3d48ec02017-03-29 17:37:55 +0200738 mid_len = gsm48_generate_mid_from_imsi(mid_buf, imsi);
739 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
740
741 /* TMSI 3.2.2.7 */
742 if (tmsi) {
Harald Welte95871da2017-05-15 12:11:36 +0200743 tmsi_sw = osmo_htonl(*tmsi);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200744 msgb_tlv_put(msg, GSM0808_IE_TMSI, sizeof(*tmsi),
745 (uint8_t *) & tmsi_sw);
746 }
747
Stefan Sperling3953f412018-08-28 15:06:30 +0200748 /* mandatory Cell Identifier List 3.2.2.27 */
749 gsm0808_enc_cell_id_list2(msg, cil);
Philipp Maier3d48ec02017-03-29 17:37:55 +0200750
751 /* Channel Needed 3.2.2.36 */
752 if (chan_needed) {
753 msgb_tv_put(msg, GSM0808_IE_CHANNEL_NEEDED,
754 (*chan_needed) & 0x03);
755 }
756
757 /* pre-pend the header */
758 msg->l3h =
759 msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
760
761 return msg;
762}
763
Stefan Sperling11a4d9d2018-02-15 18:28:04 +0100764/*! DEPRECATED: Use gsm0808_create_paging2 instead.
765 * Create BSSMAP PAGING message.
766 * \param[in] imsi Mandatory paged IMSI in string representation
767 * \param[in] tmsi Optional paged TMSI
768 * \param[in] cil Cell Identity List (where to page)
769 * \param[in] chan_needed Channel Type needed
770 * \returns callee-allocated msgb with BSSMAP PAGING message */
771struct msgb *gsm0808_create_paging(const char *imsi, const uint32_t *tmsi,
772 const struct gsm0808_cell_id_list *cil,
773 const uint8_t *chan_needed)
774{
775 struct gsm0808_cell_id_list2 cil2 = {};
776
777 /* Mandatory emelents! */
778 OSMO_ASSERT(cil);
779
780 if (cil->id_list_len > GSM0808_CELL_ID_LIST2_MAXLEN)
781 return NULL;
782
783 cil2.id_discr = cil->id_discr;
784 memcpy(cil2.id_list, cil->id_list_lac, cil->id_list_len * sizeof(cil2.id_list[0].lac));
785 cil2.id_list_len = cil->id_list_len;
786
787 return gsm0808_create_paging2(imsi, tmsi, &cil2, chan_needed);
788}
789
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100790static uint8_t put_old_bss_to_new_bss_information(struct msgb *msg,
791 const struct gsm0808_old_bss_to_new_bss_info *i)
792{
793 uint8_t *old_tail;
794 uint8_t *tlv_len;
795
796 msgb_put_u8(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION);
797 tlv_len = msgb_put(msg, 1);
798 old_tail = msg->tail;
799
800 if (i->extra_information_present) {
801 uint8_t val = 0;
802 if (i->extra_information.prec)
803 val |= 1 << 0;
804 if (i->extra_information.lcs)
805 val |= 1 << 1;
806 if (i->extra_information.ue_prob)
807 val |= 1 << 2;
808 msgb_tlv_put(msg, GSM0808_FE_IE_EXTRA_INFORMATION, 1, &val);
809 }
810
811 if (i->current_channel_type_2_present) {
812 uint8_t val[2] = {
813 i->current_channel_type_2.mode,
814 i->current_channel_type_2.field,
815 };
816 msgb_tlv_put(msg, GSM0808_FE_IE_CURRENT_CHANNEL_TYPE_2, 2, val);
817 }
818
819 *tlv_len = (uint8_t) (msg->tail - old_tail);
820 return *tlv_len + 2;
821}
822
823/*! Create BSSMAP HANDOVER REQUIRED message.
824 * \param[in] params All information to be encoded.
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200825 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED message. */
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100826struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params)
827{
828 struct msgb *msg;
829
830 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED");
831 if (!msg)
832 return NULL;
833
834 /* Message Type, 3.2.2.1 */
835 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED);
836
837 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +0100838 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100839
840 /* Cell Identifier List, 3.2.2.27 */
841 gsm0808_enc_cell_id_list2(msg, &params->cil);
842
843 /* Current Channel Type 1, 3.2.2.49 */
844 if (params->current_channel_type_1_present)
845 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
846
847 /* Speech Version (Used), 3.2.2.51 */
848 if (params->speech_version_used_present)
Neels Hofmeyr302aafc2019-04-10 19:23:45 +0200849 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
Neels Hofmeyr70aba3f2018-03-13 03:40:53 +0100850
851 if (params->old_bss_to_new_bss_info_present)
852 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
853
854 /* pre-pend the header */
855 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
856
857 return msg;
858}
859
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +0100860/*! Create BSSMAP HANDOVER REQUIRED REJECT message.
861 * \returns newly allocated msgb with BSSMAP HANDOVER REQUIRED REJECT message. */
862struct msgb *gsm0808_create_handover_required_reject(const struct gsm0808_handover_required_reject *params)
863{
864 struct msgb *msg;
865
866 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUIRED-REJECT");
867 if (!msg)
868 return NULL;
869
870 /* Message Type, 3.2.2.1 */
871 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT);
872
873 /* Cause, 3.2.2.5 */
874 gsm0808_enc_cause(msg, params->cause);
875
876 /* prepend the header */
877 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
878
879 return msg;
880}
881
882/*! Create BSSMAP HANDOVER REQUEST message, 3GPP TS 48.008 3.2.1.8.
883 * Sent from the MSC to the potential new target cell during inter-BSC handover, or to the target MSC during inter-MSC
884 * handover.
885 */
886struct msgb *gsm0808_create_handover_request(const struct gsm0808_handover_request *params)
887{
888 struct msgb *msg;
889
890 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST");
891 if (!msg)
892 return NULL;
893
894 /* Message Type, 3.2.2.1 */
895 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST);
896
897 /* Channel Type 3.2.2.11 */
898 gsm0808_enc_channel_type(msg, &params->channel_type);
899
900 /* Encryption Information 3.2.2.10 */
901 gsm0808_enc_encrypt_info(msg, &params->encryption_information);
902
903 /* Classmark Information 1 3.2.2.30 or Classmark Information 2 3.2.2.19 (Classmark 2 wins) */
904 if (params->classmark_information.classmark2_len) {
905 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T2,
906 params->classmark_information.classmark2_len,
907 (const uint8_t*)&params->classmark_information.classmark2);
908 } else if (params->classmark_information.classmark1_set) {
909 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1,
910 sizeof(params->classmark_information.classmark1),
911 (const uint8_t*)&params->classmark_information.classmark1);
912 }
913 /* (Classmark 3 possibly follows below) */
914
915 /* Cell Identifier (Serving) , 3.2.2.17 */
916 gsm0808_enc_cell_id(msg, &params->cell_identifier_serving);
917
918 /* Cell Identifier (Target) , 3.2.2.17 */
919 gsm0808_enc_cell_id(msg, &params->cell_identifier_target);
920
921 /* Cause, 3.2.2.5 */
922 gsm0808_enc_cause(msg, params->cause);
923
924 /* Classmark Information 3 3.2.2.20 */
925 if (params->classmark_information.classmark3_len) {
926 msgb_tlv_put(msg, GSM0808_IE_CLASSMARK_INFORMATION_T3,
927 params->classmark_information.classmark3_len,
928 (const uint8_t*)&params->classmark_information.classmark3);
929 }
930
931 /* Current Channel type 1 3.2.2.49 */
932 if (params->current_channel_type_1_present)
933 msgb_tv_fixed_put(msg, GSM0808_IE_CURRENT_CHANNEL_TYPE_1, 1, &params->current_channel_type_1);
934
935 /* Speech Version (Used), 3.2.2.51 */
936 if (params->speech_version_used) {
937 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_used);
938 }
939
940 /* Chosen Encryption Algorithm (Serving) 3.2.2.44 */
941 if (params->chosen_encryption_algorithm_serving)
942 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encryption_algorithm_serving);
943
944 /* Old BSS to New BSS Information 3.2.2.58 */
945 if (params->old_bss_to_new_bss_info_raw && params->old_bss_to_new_bss_info_raw_len) {
946 msgb_tlv_put(msg, GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION,
947 params->old_bss_to_new_bss_info_raw_len,
948 params->old_bss_to_new_bss_info_raw);
949 } else if (params->old_bss_to_new_bss_info_present) {
950 put_old_bss_to_new_bss_information(msg, &params->old_bss_to_new_bss_info);
951 }
952
953 /* IMSI 3.2.2.6 */
954 if (params->imsi) {
955 uint8_t mid_buf[GSM48_MI_SIZE + 2];
956 int mid_len = gsm48_generate_mid_from_imsi(mid_buf, params->imsi);
957 msgb_tlv_put(msg, GSM0808_IE_IMSI, mid_len - 2, mid_buf + 2);
958 }
959
960 if (params->aoip_transport_layer)
961 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
962
963 if (params->codec_list_msc_preferred)
964 gsm0808_enc_speech_codec_list(msg, params->codec_list_msc_preferred);
965
966 if (params->call_id_present) {
967 uint8_t val[4];
968 osmo_store32le(params->call_id, val);
969 msgb_tv_fixed_put(msg, GSM0808_IE_CALL_ID, 4, val);
970 }
971
972 if (params->global_call_reference && params->global_call_reference_len) {
973 msgb_tlv_put(msg, GSM0808_IE_GLOBAL_CALL_REF,
974 params->global_call_reference_len, params->global_call_reference);
975 }
976
977 /* prepend header with final length */
978 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
979
980 return msg;
981}
982
Neels Hofmeyr60f31532018-04-16 22:42:09 +0200983/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.
984 * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.
985 * 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 +0100986struct msgb *gsm0808_create_handover_request_ack2(const struct gsm0808_handover_request_ack *params)
Neels Hofmeyrb662b362018-04-16 22:31:15 +0200987{
988 struct msgb *msg;
989
Neels Hofmeyr60f31532018-04-16 22:42:09 +0200990 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");
Neels Hofmeyrb662b362018-04-16 22:31:15 +0200991 if (!msg)
992 return NULL;
993
994 /* Message Type, 3.2.2.1 */
995 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE);
996
Neels Hofmeyr73b943e2019-03-14 04:10:25 +0100997 /* Layer 3 Information, 3.2.2.24 -- it is actually mandatory, but rather compose a nonstandard message than
998 * segfault or return NULL without a log message. */
999 if (params->l3_info && params->l3_info_len)
1000 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001001
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001002 if (params->chosen_channel_present)
1003 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1004 if (params->chosen_encr_alg)
1005 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1006
1007 if (params->chosen_speech_version != 0)
1008 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->chosen_speech_version);
1009
1010 if (params->aoip_transport_layer)
1011 gsm0808_enc_aoip_trasp_addr(msg, params->aoip_transport_layer);
1012
1013 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1014 if (params->speech_codec_chosen_present)
1015 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001016
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001017 /* prepend header with final length */
1018 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1019
Neels Hofmeyrb662b362018-04-16 22:31:15 +02001020 return msg;
1021}
1022
Neels Hofmeyr73b943e2019-03-14 04:10:25 +01001023/*! Same as gsm0808_create_handover_request_ack2() but with less parameters.
1024 * In particular, this lacks the AoIP Transport Layer address. */
1025struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,
1026 uint8_t chosen_channel, uint8_t chosen_encr_alg,
1027 uint8_t chosen_speech_version)
1028{
1029 struct gsm0808_handover_request_ack params = {
1030 .l3_info = l3_info,
1031 .l3_info_len = l3_info_len,
1032 .chosen_channel = chosen_channel,
1033 .chosen_encr_alg = chosen_encr_alg,
1034 .chosen_speech_version = chosen_speech_version,
1035 };
1036
1037 return gsm0808_create_handover_request_ack2(&params);
1038}
1039
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001040/*! Create BSSMAP HANDOVER COMMAND message, 3GPP TS 48.008 3.2.1.11.
1041 * Sent from the MSC to the old BSS to transmit the RR Handover Command received from the new BSS. */
1042struct msgb *gsm0808_create_handover_command(const struct gsm0808_handover_command *params)
1043{
1044 struct msgb *msg;
1045
1046 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMMAND");
1047 if (!msg)
1048 return NULL;
1049
1050 /* Message Type, 3.2.2.1 */
1051 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_CMD);
1052
1053 msgb_tlv_put(msg, GSM0808_IE_LAYER_3_INFORMATION, params->l3_info_len, params->l3_info);
1054
1055 if (params->cell_identifier.id_discr != CELL_IDENT_NO_CELL)
1056 gsm0808_enc_cell_id(msg, &params->cell_identifier);
1057
1058 if (params->new_bss_to_old_bss_info_raw
1059 && params->new_bss_to_old_bss_info_raw_len)
1060 msgb_tlv_put(msg, GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO, params->new_bss_to_old_bss_info_raw_len,
1061 params->new_bss_to_old_bss_info_raw);
1062
1063 /* prepend header with final length */
1064 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1065
1066 return msg;
1067}
1068
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001069/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.
1070 * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has
1071 * received the Handover Detect message. */
1072struct msgb *gsm0808_create_handover_detect()
1073{
1074 struct msgb *msg;
1075
1076 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1077 if (!msg)
1078 return NULL;
1079
1080 /* Message Type, 3.2.2.1 */
1081 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);
1082
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001083 /* prepend header with final length */
1084 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1085
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001086 return msg;
1087}
1088
Neels Hofmeyrf7e9c512019-03-06 04:25:38 +01001089/*! Create BSSMAP HANDOVER SUCCEEDED message, 3GPP TS 48.008 3.2.1.13.
1090 * Sent from the MSC back to the old BSS to notify that the MS has successfully accessed the new BSS. */
1091struct msgb *gsm0808_create_handover_succeeded()
1092{
1093 struct msgb *msg;
1094
1095 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");
1096 if (!msg)
1097 return NULL;
1098
1099 /* Message Type, 3.2.2.1 */
1100 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_SUCCEEDED);
1101
1102 /* prepend header with final length */
1103 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1104
1105 return msg;
1106}
1107
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001108/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.
1109 * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */
1110struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)
1111{
1112 struct msgb *msg;
1113
1114 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");
1115 if (!msg)
1116 return NULL;
1117
1118 /* Message Type, 3.2.2.1 */
1119 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);
1120
1121 /* RR Cause, 3.2.2.22 */
1122 if (params->rr_cause_present)
1123 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1124
1125 /* AoIP: Speech Codec (Chosen) 3.2.2.104 */
1126 if (params->speech_codec_chosen_present)
1127 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1128
1129 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1130 if (params->codec_list_bss_supported.len)
1131 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1132
1133 /* Chosen Encryption Algorithm 3.2.2.44 */
1134 if (params->chosen_encr_alg_present)
1135 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1136
1137 /* LCLS-BSS-Status 3.2.2.119 */
1138 if (params->lcls_bss_status_present)
1139 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1140
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001141 /* prepend header with final length */
1142 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1143
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001144 return msg;
1145}
1146
1147/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.
1148 * Sent from the MT BSC back to the MSC when the handover has failed. */
1149struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)
1150{
1151 struct msgb *msg;
1152
1153 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");
1154 if (!msg)
1155 return NULL;
1156
1157 /* Message Type, 3.2.2.1 */
1158 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);
1159
1160 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001161 gsm0808_enc_cause(msg, params->cause);
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001162
1163 /* RR Cause, 3.2.2.22 */
1164 if (params->rr_cause_present)
1165 msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, &params->rr_cause);
1166
1167 /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */
1168 if (params->codec_list_bss_supported.len)
1169 gsm0808_enc_speech_codec_list(msg, &params->codec_list_bss_supported);
1170
Neels Hofmeyr43c266f2018-08-28 01:08:38 +02001171 /* prepend header with final length */
1172 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1173
Neels Hofmeyr60f31532018-04-16 22:42:09 +02001174 return msg;
1175}
1176
Philipp Maier225bdf42018-10-30 14:56:59 +01001177/*! Create BSSMAP HANDOVER PERFORMED message, 3GPP TS 48.008 3.2.1.25.
1178 * \param[in] params All information to be encoded.
1179 * \returns callee-allocated msgb with BSSMAP HANDOVER PERFORMED message */
1180struct msgb *gsm0808_create_handover_performed(const struct gsm0808_handover_performed *params)
1181{
1182 struct msgb *msg;
1183
1184 msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-PERFORMED");
1185 if (!msg)
1186 return NULL;
1187
1188 /* Message Type, 3.2.2.1 */
1189 msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_PERFORMED);
1190
1191 /* Cause, 3.2.2.5 */
Philipp Maier4f4905f2018-11-30 13:36:12 +01001192 gsm0808_enc_cause(msg, params->cause);
Philipp Maier225bdf42018-10-30 14:56:59 +01001193
1194 /* Cell Identifier, 3.2.2.17 */
1195 gsm0808_enc_cell_id(msg, &params->cell_id);
1196
1197 /* Chosen Channel 3.2.2.33 */
1198 if (params->chosen_channel_present)
1199 msgb_tv_put(msg, GSM0808_IE_CHOSEN_CHANNEL, params->chosen_channel);
1200
1201 /* Chosen Encryption Algorithm 3.2.2.44 */
1202 if (params->chosen_encr_alg_present)
1203 msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);
1204
1205 /* Speech Version (chosen) 3.2.2.51 */
1206 if (params->speech_version_chosen_present)
1207 msgb_tv_put(msg, GSM0808_IE_SPEECH_VERSION, params->speech_version_chosen);
1208
1209 /* AoIP: Speech Codec (chosen) 3.2.2.104 */
1210 if (params->speech_codec_chosen_present)
1211 gsm0808_enc_speech_codec(msg, &params->speech_codec_chosen);
1212
1213 /* LCLS-BSS-Status 3.2.2.119 */
1214 if (params->lcls_bss_status_present)
1215 msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);
1216
1217 /* prepend header with final length */
1218 msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));
1219
1220 return msg;
1221}
1222
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001223/*! Prepend a DTAP header to given Message Buffer
Harald Welte96e2a002017-06-12 21:44:18 +02001224 * \param[in] msgb Message Buffer
1225 * \param[in] link_id Link Identifier */
Holger Hans Peter Freyther9a3dec02010-05-16 08:15:40 +08001226void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id)
1227{
1228 uint8_t *hh = msgb_push(msg, 3);
1229 hh[0] = BSSAP_MSG_DTAP;
1230 hh[1] = link_id;
1231 hh[2] = msg->len - 3;
1232}
1233
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001234/*! Create BSSMAP DTAP message
Harald Welte96e2a002017-06-12 21:44:18 +02001235 * \param[in] msg_l3 Messge Buffer containing Layer3 message
1236 * \param[in] link_id Link Identifier
1237 * \returns callee-allocated msgb with BSSMAP DTAP message */
Holger Hans Peter Freytherc25c6682010-11-04 12:26:06 +01001238struct msgb *gsm0808_create_dtap(struct msgb *msg_l3, uint8_t link_id)
1239{
1240 struct dtap_header *header;
1241 uint8_t *data;
1242 struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,
1243 "dtap");
1244 if (!msg)
1245 return NULL;
1246
1247 /* DTAP header */
1248 msg->l3h = msgb_put(msg, sizeof(*header));
1249 header = (struct dtap_header *) &msg->l3h[0];
1250 header->type = BSSAP_MSG_DTAP;
1251 header->link_id = link_id;
1252 header->length = msgb_l3len(msg_l3);
1253
1254 /* Payload */
1255 data = msgb_put(msg, header->length);
1256 memcpy(data, msg_l3->l3h, header->length);
1257
1258 return msg;
1259}
1260
Harald Welte92107df2014-06-21 23:16:20 +02001261/* As per 3GPP TS 48.008 version 11.7.0 Release 11 */
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001262static const struct tlv_definition bss_att_tlvdef = {
1263 .def = {
Harald Welte92107df2014-06-21 23:16:20 +02001264 [GSM0808_IE_CIRCUIT_IDENTITY_CODE] = { TLV_TYPE_FIXED, 2 },
1265 [GSM0808_IE_CONNECTION_RELEASE_RQSTED] = { TLV_TYPE_TV },
1266 [GSM0808_IE_RESOURCE_AVAILABLE] = { TLV_TYPE_FIXED, 21 },
1267 [GSM0808_IE_CAUSE] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001268 [GSM0808_IE_IMSI] = { TLV_TYPE_TLV },
1269 [GSM0808_IE_TMSI] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001270 [GSM0808_IE_NUMBER_OF_MSS] = { TLV_TYPE_TV },
Dmitri Soloviev29099422013-07-11 09:25:37 +02001271 [GSM0808_IE_LAYER_3_HEADER_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001272 [GSM0808_IE_ENCRYPTION_INFORMATION] = { TLV_TYPE_TLV },
1273 [GSM0808_IE_CHANNEL_TYPE] = { TLV_TYPE_TLV },
1274 [GSM0808_IE_PERIODICITY] = { TLV_TYPE_TV },
1275 [GSM0808_IE_EXTENDED_RESOURCE_INDICATOR]= { TLV_TYPE_TV },
1276 [GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE] = { TLV_TYPE_FIXED, 4 },
1277 [GSM0808_IE_LSA_IDENTIFIER] = { TLV_TYPE_TLV },
1278 [GSM0808_IE_LSA_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
Holger Hans Peter Freyther715e9452014-08-21 14:17:45 +02001279 [GSM0808_IE_LSA_INFORMATION] = { TLV_TYPE_TLV },
Harald Welte92107df2014-06-21 23:16:20 +02001280 [GSM0808_IE_CELL_IDENTIFIER] = { TLV_TYPE_TLV },
1281 [GSM0808_IE_PRIORITY] = { TLV_TYPE_TLV },
1282 [GSM0808_IE_CLASSMARK_INFORMATION_T2] = { TLV_TYPE_TLV },
1283 [GSM0808_IE_CLASSMARK_INFORMATION_T3] = { TLV_TYPE_TLV },
1284 [GSM0808_IE_INTERFERENCE_BAND_TO_USE] = { TLV_TYPE_TV },
1285 [GSM0808_IE_RR_CAUSE] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001286 [GSM0808_IE_LAYER_3_INFORMATION] = { TLV_TYPE_TLV },
1287 [GSM0808_IE_DLCI] = { TLV_TYPE_TV },
1288 [GSM0808_IE_DOWNLINK_DTX_FLAG] = { TLV_TYPE_TV },
1289 [GSM0808_IE_CELL_IDENTIFIER_LIST] = { TLV_TYPE_TLV },
1290 [GSM0808_IE_CELL_ID_LIST_SEGMENT] = { TLV_TYPE_TLV },
1291 [GSM0808_IE_CELL_ID_LIST_SEG_EST_CELLS] = { TLV_TYPE_TLV },
1292 [GSM0808_IE_CELL_ID_LIST_SEG_CELLS_TBE] = { TLV_TYPE_TLV },
1293 [GSM0808_IE_CELL_ID_LIST_SEG_REL_CELLS] = { TLV_TYPE_TLV },
1294 [GSM0808_IE_CELL_ID_LIST_SEG_NE_CELLS] = { TLV_TYPE_TLV },
1295 [GSM0808_IE_RESPONSE_RQST] = { TLV_TYPE_T },
1296 [GSM0808_IE_RESOURCE_INDICATION_METHOD] = { TLV_TYPE_TV },
1297 [GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1] = { TLV_TYPE_TV },
1298 [GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST] = { TLV_TYPE_TLV },
1299 [GSM0808_IE_DIAGNOSTIC] = { TLV_TYPE_TLV },
1300 [GSM0808_IE_CHOSEN_CHANNEL] = { TLV_TYPE_TV },
1301 [GSM0808_IE_CIPHER_RESPONSE_MODE] = { TLV_TYPE_TV },
1302 [GSM0808_IE_LAYER_3_MESSAGE_CONTENTS] = { TLV_TYPE_TLV },
1303 [GSM0808_IE_CHANNEL_NEEDED] = { TLV_TYPE_TV },
1304 [GSM0808_IE_TRACE_TYPE] = { TLV_TYPE_TV },
1305 [GSM0808_IE_TRIGGERID] = { TLV_TYPE_TLV },
1306 [GSM0808_IE_TRACE_REFERENCE] = { TLV_TYPE_TV },
1307 [GSM0808_IE_TRANSACTIONID] = { TLV_TYPE_TLV },
1308 [GSM0808_IE_MOBILE_IDENTITY] = { TLV_TYPE_TLV },
1309 [GSM0808_IE_OMCID] = { TLV_TYPE_TLV },
1310 [GSM0808_IE_FORWARD_INDICATOR] = { TLV_TYPE_TV },
Holger Hans Peter Freytherc2b7f922010-08-04 18:50:43 +08001311 [GSM0808_IE_CHOSEN_ENCR_ALG] = { TLV_TYPE_TV },
Harald Welte92107df2014-06-21 23:16:20 +02001312 [GSM0808_IE_CIRCUIT_POOL] = { TLV_TYPE_TV },
1313 [GSM0808_IE_CIRCUIT_POOL_LIST] = { TLV_TYPE_TLV },
1314 [GSM0808_IE_TIME_INDICATION] = { TLV_TYPE_TV },
1315 [GSM0808_IE_RESOURCE_SITUATION] = { TLV_TYPE_TLV },
1316 [GSM0808_IE_CURRENT_CHANNEL_TYPE_1] = { TLV_TYPE_TV },
1317 [GSM0808_IE_QUEUEING_INDICATOR] = { TLV_TYPE_TV },
1318 [GSM0808_IE_SPEECH_VERSION] = { TLV_TYPE_TV },
1319 [GSM0808_IE_ASSIGNMENT_REQUIREMENT] = { TLV_TYPE_TV },
1320 [GSM0808_IE_TALKER_FLAG] = { TLV_TYPE_T },
1321 [GSM0808_IE_GROUP_CALL_REFERENCE] = { TLV_TYPE_TLV },
1322 [GSM0808_IE_EMLPP_PRIORITY] = { TLV_TYPE_TV },
1323 [GSM0808_IE_CONFIG_EVO_INDI] = { TLV_TYPE_TV },
1324 [GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION] = { TLV_TYPE_TLV },
1325 [GSM0808_IE_LCS_QOS] = { TLV_TYPE_TLV },
1326 [GSM0808_IE_LSA_ACCESS_CTRL_SUPPR] = { TLV_TYPE_TV },
1327 [GSM0808_IE_LCS_PRIORITY] = { TLV_TYPE_TLV },
1328 [GSM0808_IE_LOCATION_TYPE] = { TLV_TYPE_TLV },
1329 [GSM0808_IE_LOCATION_ESTIMATE] = { TLV_TYPE_TLV },
1330 [GSM0808_IE_POSITIONING_DATA] = { TLV_TYPE_TLV },
1331 [GSM0808_IE_LCS_CAUSE] = { TLV_TYPE_TLV },
1332 [GSM0808_IE_APDU] = { TLV_TYPE_TLV },
1333 [GSM0808_IE_NETWORK_ELEMENT_IDENTITY] = { TLV_TYPE_TLV },
1334 [GSM0808_IE_GPS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1335 [GSM0808_IE_DECIPHERING_KEYS] = { TLV_TYPE_TLV },
1336 [GSM0808_IE_RETURN_ERROR_RQST] = { TLV_TYPE_TLV },
1337 [GSM0808_IE_RETURN_ERROR_CAUSE] = { TLV_TYPE_TLV },
1338 [GSM0808_IE_SEGMENTATION] = { TLV_TYPE_TLV },
1339 [GSM0808_IE_SERVICE_HANDOVER] = { TLV_TYPE_TLV },
1340 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS] = { TLV_TYPE_TLV },
1341 [GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000] = { TLV_TYPE_TLV },
1342 [GSM0808_IE_GERAN_CLASSMARK] = { TLV_TYPE_TLV },
1343 [GSM0808_IE_GERAN_BSC_CONTAINER] = { TLV_TYPE_TLV },
1344 [GSM0808_IE_NEW_BSS_TO_OLD_BSS_INFO] = { TLV_TYPE_TLV },
1345 [GSM0800_IE_INTER_SYSTEM_INFO] = { TLV_TYPE_TLV },
1346 [GSM0808_IE_SNA_ACCESS_INFO] = { TLV_TYPE_TLV },
1347 [GSM0808_IE_VSTK_RAND_INFO] = { TLV_TYPE_TLV },
1348 [GSM0808_IE_PAGING_INFO] = { TLV_TYPE_TV },
1349 [GSM0808_IE_IMEI] = { TLV_TYPE_TLV },
1350 [GSM0808_IE_VELOCITY_ESTIMATE] = { TLV_TYPE_TLV },
1351 [GSM0808_IE_VGCS_FEATURE_FLAGS] = { TLV_TYPE_TLV },
1352 [GSM0808_IE_TALKER_PRIORITY] = { TLV_TYPE_TV },
1353 [GSM0808_IE_EMERGENCY_SET_INDICATION] = { TLV_TYPE_T },
1354 [GSM0808_IE_TALKER_IDENTITY] = { TLV_TYPE_TLV },
1355 [GSM0808_IE_SMS_TO_VGCS] = { TLV_TYPE_TLV },
1356 [GSM0808_IE_VGCS_TALKER_MODE] = { TLV_TYPE_TLV },
1357 [GSM0808_IE_VGCS_VBS_CELL_STATUS] = { TLV_TYPE_TLV },
1358 [GSM0808_IE_GANSS_ASSISTANCE_DATA] = { TLV_TYPE_TLV },
1359 [GSM0808_IE_GANSS_POSITIONING_DATA] = { TLV_TYPE_TLV },
1360 [GSM0808_IE_GANSS_LOCATION_TYPE] = { TLV_TYPE_TLV },
1361 [GSM0808_IE_APP_DATA] = { TLV_TYPE_TLV },
1362 [GSM0808_IE_DATA_IDENTITY] = { TLV_TYPE_TLV },
1363 [GSM0808_IE_APP_DATA_INFO] = { TLV_TYPE_TLV },
1364 [GSM0808_IE_MSISDN] = { TLV_TYPE_TLV },
1365 [GSM0808_IE_AOIP_TRASP_ADDR] = { TLV_TYPE_TLV },
1366 [GSM0808_IE_SPEECH_CODEC_LIST] = { TLV_TYPE_TLV },
1367 [GSM0808_IE_SPEECH_CODEC] = { TLV_TYPE_TLV },
1368 [GSM0808_IE_CALL_ID] = { TLV_TYPE_FIXED, 4 },
1369 [GSM0808_IE_CALL_ID_LIST] = { TLV_TYPE_TLV },
1370 [GSM0808_IE_A_IF_SEL_FOR_RESET] = { TLV_TYPE_TV },
1371 [GSM0808_IE_KC_128] = { TLV_TYPE_FIXED, 16 },
1372 [GSM0808_IE_CSG_IDENTIFIER] = { TLV_TYPE_TLV },
1373 [GSM0808_IE_REDIR_ATTEMPT_FLAG] = { TLV_TYPE_T },
1374 [GSM0808_IE_REROUTE_REJ_CAUSE] = { TLV_TYPE_TV },
1375 [GSM0808_IE_SEND_SEQ_NUM] = { TLV_TYPE_TV },
1376 [GSM0808_IE_REROUTE_COMPL_OUTCOME] = { TLV_TYPE_TV },
1377 [GSM0808_IE_GLOBAL_CALL_REF] = { TLV_TYPE_TLV },
1378 [GSM0808_IE_LCLS_CONFIG] = { TLV_TYPE_TV },
1379 [GSM0808_IE_LCLS_CONN_STATUS_CTRL] = { TLV_TYPE_TV },
1380 [GSM0808_IE_LCLS_CORR_NOT_NEEDED] = { TLV_TYPE_TV },
1381 [GSM0808_IE_LCLS_BSS_STATUS] = { TLV_TYPE_TV },
1382 [GSM0808_IE_LCLS_BREAK_REQ] = { TLV_TYPE_TV },
1383 [GSM0808_IE_CSFB_INDICATION] = { TLV_TYPE_T },
1384 [GSM0808_IE_CS_TO_PS_SRVCC] = { TLV_TYPE_T },
1385 [GSM0808_IE_SRC_ENB_TO_TGT_ENB_TRANSP] = { TLV_TYPE_TLV },
1386 [GSM0808_IE_CS_TO_PS_SRVCC_IND] = { TLV_TYPE_T },
1387 [GSM0808_IE_CN_TO_MS_TRANSP_INFO] = { TLV_TYPE_TLV },
1388 [GSM0808_IE_SELECTED_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
1389 [GSM0808_IE_LAST_USED_EUTRAN_PLMN_ID] = { TLV_TYPE_FIXED, 3 },
Pau Espin Pedrol18506c82019-04-16 15:47:59 +02001390
1391 /* Osmocom extensions */
1392 [GSM0808_IE_OSMO_OSMUX_SUPPORT] = { TLV_TYPE_T },
1393 [GSM0808_IE_OSMO_OSMUX_CID] = { TLV_TYPE_TV },
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001394 },
1395};
1396
Harald Weltef4d45ab2011-07-16 12:13:00 +02001397const struct tlv_definition *gsm0808_att_tlvdef(void)
Holger Hans Peter Freyther7daa01c2010-04-17 05:14:36 +02001398{
1399 return &bss_att_tlvdef;
1400}
Harald Welte9b837e62011-07-11 17:43:19 +02001401
Pau Espin Pedrol392f6072019-11-27 12:07:04 +01001402const struct value_string gsm0406_dlci_sapi_names[] = {
1403 { DLCI_SAPI_RR_MM_CC, "RR/MM/CC" },
1404 { DLCI_SAPI_SMS, "SMS" },
1405 { 0, NULL }
1406};
1407
Harald Welte9b837e62011-07-11 17:43:19 +02001408static const struct value_string gsm0808_msgt_names[] = {
1409 { BSS_MAP_MSG_ASSIGMENT_RQST, "ASSIGNMENT REQ" },
1410 { BSS_MAP_MSG_ASSIGMENT_COMPLETE, "ASSIGNMENT COMPL" },
1411 { BSS_MAP_MSG_ASSIGMENT_FAILURE, "ASSIGNMENT FAIL" },
Harald Welte92107df2014-06-21 23:16:20 +02001412 { BSS_MAP_MSG_CHAN_MOD_RQST, "CHANNEL MODIFY REQUEST" },
Harald Welte9b837e62011-07-11 17:43:19 +02001413
1414 { BSS_MAP_MSG_HANDOVER_RQST, "HANDOVER REQ" },
1415 { BSS_MAP_MSG_HANDOVER_REQUIRED, "HANDOVER REQUIRED" },
1416 { BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE,"HANDOVER REQ ACK" },
1417 { BSS_MAP_MSG_HANDOVER_CMD, "HANDOVER CMD" },
1418 { BSS_MAP_MSG_HANDOVER_COMPLETE, "HANDOVER COMPLETE" },
1419 { BSS_MAP_MSG_HANDOVER_SUCCEEDED, "HANDOVER SUCCESS" },
1420 { BSS_MAP_MSG_HANDOVER_FAILURE, "HANDOVER FAILURE" },
1421 { BSS_MAP_MSG_HANDOVER_PERFORMED, "HANDOVER PERFORMED" },
1422 { BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE, "HANDOVER CAND ENQ" },
1423 { BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE, "HANDOVER CAND RESP" },
1424 { BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT, "HANDOVER REQ REJ" },
1425 { BSS_MAP_MSG_HANDOVER_DETECT, "HANDOVER DETECT" },
Harald Welte92107df2014-06-21 23:16:20 +02001426 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED, "INT HANDOVER REQ" },
1427 { BSS_MAP_MSG_INT_HANDOVER_REQUIRED_REJ,"INT HANDOVER REQ REJ" },
1428 { BSS_MAP_MSG_INT_HANDOVER_CMD, "INT HANDOVER CMD" },
1429 { BSS_MAP_MSG_INT_HANDOVER_ENQUIRY, "INT HANDOVER ENQ" },
Harald Welte9b837e62011-07-11 17:43:19 +02001430
1431 { BSS_MAP_MSG_CLEAR_CMD, "CLEAR COMMAND" },
1432 { BSS_MAP_MSG_CLEAR_COMPLETE, "CLEAR COMPLETE" },
1433 { BSS_MAP_MSG_CLEAR_RQST, "CLEAR REQUEST" },
1434 { BSS_MAP_MSG_SAPI_N_REJECT, "SAPI N REJECT" },
1435 { BSS_MAP_MSG_CONFUSION, "CONFUSION" },
1436
1437 { BSS_MAP_MSG_SUSPEND, "SUSPEND" },
1438 { BSS_MAP_MSG_RESUME, "RESUME" },
1439 { BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION, "CONN ORIENT INFO" },
1440 { BSS_MAP_MSG_PERFORM_LOCATION_RQST, "PERFORM LOC REQ" },
1441 { BSS_MAP_MSG_LSA_INFORMATION, "LSA INFORMATION" },
1442 { BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE, "PERFORM LOC RESP" },
1443 { BSS_MAP_MSG_PERFORM_LOCATION_ABORT, "PERFORM LOC ABORT" },
1444 { BSS_MAP_MSG_COMMON_ID, "COMMON ID" },
Harald Welte92107df2014-06-21 23:16:20 +02001445 { BSS_MAP_MSG_REROUTE_CMD, "REROUTE COMMAND" },
1446 { BSS_MAP_MSG_REROUTE_COMPLETE, "REROUTE COMPLETE" },
Harald Welte9b837e62011-07-11 17:43:19 +02001447
1448 { BSS_MAP_MSG_RESET, "RESET" },
1449 { BSS_MAP_MSG_RESET_ACKNOWLEDGE, "RESET ACK" },
1450 { BSS_MAP_MSG_OVERLOAD, "OVERLOAD" },
1451 { BSS_MAP_MSG_RESET_CIRCUIT, "RESET CIRCUIT" },
1452 { BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE, "RESET CIRCUIT ACK" },
1453 { BSS_MAP_MSG_MSC_INVOKE_TRACE, "MSC INVOKE TRACE" },
1454 { BSS_MAP_MSG_BSS_INVOKE_TRACE, "BSS INVOKE TRACE" },
1455 { BSS_MAP_MSG_CONNECTIONLESS_INFORMATION, "CONNLESS INFO" },
Harald Welte92107df2014-06-21 23:16:20 +02001456 { BSS_MAP_MSG_RESET_IP_RSRC, "RESET IP RESOURCE" },
1457 { BSS_MAP_MSG_RESET_IP_RSRC_ACK, "RESET IP RESOURCE ACK" },
Harald Welte9b837e62011-07-11 17:43:19 +02001458
1459 { BSS_MAP_MSG_BLOCK, "BLOCK" },
1460 { BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE, "BLOCK ACK" },
1461 { BSS_MAP_MSG_UNBLOCK, "UNBLOCK" },
1462 { BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE, "UNBLOCK ACK" },
1463 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK, "CIRC GROUP BLOCK" },
1464 { BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE, "CIRC GORUP BLOCK ACK" },
1465 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK, "CIRC GROUP UNBLOCK" },
1466 { BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE, "CIRC GROUP UNBLOCK ACK" },
1467 { BSS_MAP_MSG_UNEQUIPPED_CIRCUIT, "UNEQUIPPED CIRCUIT" },
1468 { BSS_MAP_MSG_CHANGE_CIRCUIT, "CHANGE CIRCUIT" },
1469 { BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE, "CHANGE CIRCUIT ACK" },
1470
1471 { BSS_MAP_MSG_RESOURCE_RQST, "RESOURCE REQ" },
1472 { BSS_MAP_MSG_RESOURCE_INDICATION, "RESOURCE IND" },
1473 { BSS_MAP_MSG_PAGING, "PAGING" },
1474 { BSS_MAP_MSG_CIPHER_MODE_CMD, "CIPHER MODE CMD" },
1475 { BSS_MAP_MSG_CLASSMARK_UPDATE, "CLASSMARK UPDATE" },
1476 { BSS_MAP_MSG_CIPHER_MODE_COMPLETE, "CIPHER MODE COMPLETE" },
1477 { BSS_MAP_MSG_QUEUING_INDICATION, "QUEUING INDICATION" },
1478 { BSS_MAP_MSG_COMPLETE_LAYER_3, "COMPLETE LAYER 3" },
1479 { BSS_MAP_MSG_CLASSMARK_RQST, "CLASSMARK REQ" },
1480 { BSS_MAP_MSG_CIPHER_MODE_REJECT, "CIPHER MODE REJECT" },
1481 { BSS_MAP_MSG_LOAD_INDICATION, "LOAD IND" },
1482
Harald Welte92107df2014-06-21 23:16:20 +02001483 { BSS_MAP_MSG_VGCS_VBS_SETUP, "VGCS/VBS SETUP" },
1484 { BSS_MAP_MSG_VGCS_VBS_SETUP_ACK, "VGCS/VBS SETUP ACK" },
1485 { BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE, "VGCS/VBS SETUP REFUSE" },
1486 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST, "VGCS/VBS ASSIGN REQ" },
1487 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT, "VGCS/VBS ASSIGN RES" },
1488 { BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE, "VGCS/VBS ASSIGN FAIL" },
1489 { BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION, "VGCS/VBS QUEUING IND" },
1490 { BSS_MAP_MSG_UPLINK_RQST, "UPLINK REQ" },
1491 { BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE, "UPLINK REQ ACK" },
1492 { BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION, "UPLINK REQ CONF" },
1493 { BSS_MAP_MSG_UPLINK_RELEASE_INDICATION,"UPLINK REL IND" },
1494 { BSS_MAP_MSG_UPLINK_REJECT_CMD, "UPLINK REJ CMD" },
1495 { BSS_MAP_MSG_UPLINK_RELEASE_CMD, "UPLINK REL CMD" },
1496 { BSS_MAP_MSG_UPLINK_SEIZED_CMD, "UPLINK SEIZED CMD" },
1497 { BSS_MAP_MSG_VGCS_ADDL_INFO, "VGCS ADDL INFO" },
1498 { BSS_MAP_MSG_NOTIFICATION_DATA, "NOTIF DATA" },
1499 { BSS_MAP_MSG_UPLINK_APP_DATA, "UPLINK APP DATA" },
1500
1501 { BSS_MAP_MSG_LCLS_CONNECT_CTRL, "LCLS-CONNECT-CONTROL" },
1502 { BSS_MAP_MSG_LCLS_CONNECT_CTRL_ACK, "CLS-CONNECT-CONTROL-ACK" },
1503 { BSS_MAP_MSG_LCLS_NOTIFICATION, "LCLS-NOTIFICATION" },
Harald Welte9b837e62011-07-11 17:43:19 +02001504
1505 { 0, NULL }
1506};
1507
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001508/*! Return string name of BSSMAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001509const char *gsm0808_bssmap_name(uint8_t msg_type)
1510{
1511 return get_value_string(gsm0808_msgt_names, msg_type);
1512}
1513
1514static const struct value_string gsm0808_bssap_names[] = {
1515 { BSSAP_MSG_BSS_MANAGEMENT, "MANAGEMENT" },
1516 { BSSAP_MSG_DTAP, "DTAP" },
Neels Hofmeyr90fdb082017-03-01 14:59:44 +01001517 { 0, NULL }
Harald Welte9b837e62011-07-11 17:43:19 +02001518};
1519
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001520/*! Return string name of BSSAP Message Type */
Harald Welte9b837e62011-07-11 17:43:19 +02001521const char *gsm0808_bssap_name(uint8_t msg_type)
1522{
1523 return get_value_string(gsm0808_bssap_names, msg_type);
1524}
Harald Welte96e2a002017-06-12 21:44:18 +02001525
Neels Hofmeyrffad5742018-01-12 05:34:03 +01001526const struct value_string gsm0808_speech_codec_type_names[] = {
1527 { GSM0808_SCT_FR1, "FR1" },
1528 { GSM0808_SCT_FR2, "FR2" },
1529 { GSM0808_SCT_FR3, "FR3" },
1530 { GSM0808_SCT_FR4, "FR4" },
1531 { GSM0808_SCT_FR5, "FR5" },
1532 { GSM0808_SCT_HR1, "HR1" },
1533 { GSM0808_SCT_HR3, "HR3" },
1534 { GSM0808_SCT_HR4, "HR4" },
1535 { GSM0808_SCT_HR6, "HR6" },
1536 { GSM0808_SCT_CSD, "CSD" },
1537 { 0, NULL }
1538};
1539
Philipp Maiercdd05812018-07-12 18:21:07 +02001540const struct value_string gsm0808_permitted_speech_names[] = {
1541 { GSM0808_PERM_FR1, "FR1" },
1542 { GSM0808_PERM_FR2, "FR2" },
1543 { GSM0808_PERM_FR3, "FR3" },
1544 { GSM0808_PERM_FR4, "FR4" },
1545 { GSM0808_PERM_FR5, "FR5" },
1546 { GSM0808_PERM_HR1, "HR1" },
1547 { GSM0808_PERM_HR2, "HR2" },
1548 { GSM0808_PERM_HR3, "HR3" },
1549 { GSM0808_PERM_HR4, "HR4" },
1550 { GSM0808_PERM_HR6, "HR6" },
1551 { 0, NULL }
1552};
1553
Pau Espin Pedrolf2cda622018-07-06 17:16:41 +02001554const struct value_string gsm0808_chosen_enc_alg_names[] = {
1555 { GSM0808_ALG_ID_A5_0, "A5/0" },
1556 { GSM0808_ALG_ID_A5_1, "A5/1" },
1557 { GSM0808_ALG_ID_A5_2, "A5/2" },
1558 { GSM0808_ALG_ID_A5_3, "A5/3" },
1559 { GSM0808_ALG_ID_A5_4, "A5/4" },
1560 { GSM0808_ALG_ID_A5_5, "A5/5" },
1561 { GSM0808_ALG_ID_A5_6, "A5/6" },
1562 { GSM0808_ALG_ID_A5_7, "A5/7" },
1563 { 0, NULL }
1564};
1565
Philipp Maierdbb76592018-03-29 12:55:26 +02001566static const struct value_string gsm0808_cause_names[] = {
1567 { GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE, "RADIO INTERFACE MESSAGE FAILURE" },
1568 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, "RADIO INTERFACE FAILURE" },
1569 { GSM0808_CAUSE_UPLINK_QUALITY, "UPLINK QUALITY" },
1570 { GSM0808_CAUSE_UPLINK_STRENGTH, "UPLINK STRENGTH" },
1571 { GSM0808_CAUSE_DOWNLINK_QUALITY, "DOWNLINK QUALITY" },
1572 { GSM0808_CAUSE_DOWNLINK_STRENGTH, "DOWNLINK STRENGTH" },
1573 { GSM0808_CAUSE_DISTANCE, "DISTANCE" },
1574 { GSM0808_CAUSE_O_AND_M_INTERVENTION, "O AND M INTERVENTION" },
1575 { GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION, "RESPONSE TO MSC INVOCATION" },
1576 { GSM0808_CAUSE_CALL_CONTROL, "CALL CONTROL" },
1577 { GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION, "RADIO INTERFACE FAILURE REVERSION" },
1578 { GSM0808_CAUSE_HANDOVER_SUCCESSFUL, "HANDOVER SUCCESSFUL" },
1579 { GSM0808_CAUSE_BETTER_CELL, "BETTER CELL" },
1580 { GSM0808_CAUSE_DIRECTED_RETRY, "DIRECTED RETRY" },
1581 { GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL, "JOINED GROUP CALL CHANNEL" },
1582 { GSM0808_CAUSE_TRAFFIC, "TRAFFIC" },
1583 { GSM0808_CAUSE_REDUCE_LOAD_IN_SERVING_CELL, "REDUCE LOAD IN SERVING CELL" },
1584 { GSM0808_CAUSE_TRAFFIC_LOAD_IN_TGT_HIGHER_THAN_IN_SRC_CELL, "TRAFFIC LOAD IN TGT HIGHER THAN IN SRC CELL" },
1585 { GSM0808_CAUSE_RELOCATION_TRIGGERED, "RELOCATION TRIGGERED" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001586 { GSM0808_CAUSE_REQUESTED_OPT_NOT_AUTHORISED, "REQUESTED OPT NOT AUTHORISED" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001587 { GSM0808_CAUSE_ALT_CHAN_CONFIG_REQUESTED, "ALT CHAN CONFIG REQUESTED" },
1588 { GSM0808_CAUSE_RESP_TO_INT_HO_ENQ_MSG, "RESP TO INT HO ENQ MSG" },
1589 { GSM0808_CAUSE_INT_HO_ENQUIRY_REJECT, "INT HO ENQUIRY REJECT" },
1590 { GSM0808_CAUSE_REDUNDANCY_LEVEL_NOT_ADEQUATE, "REDUNDANCY LEVEL NOT ADEQUATE" },
1591 { GSM0808_CAUSE_EQUIPMENT_FAILURE, "EQUIPMENT FAILURE" },
1592 { GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE, "NO RADIO RESOURCE AVAILABLE" },
1593 { GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, "RQSTED TERRESTRIAL RESOURCE UNAVAILABLE" },
1594 { GSM0808_CAUSE_CCCH_OVERLOAD, "CCCH OVERLOAD" },
1595 { GSM0808_CAUSE_PROCESSOR_OVERLOAD, "PROCESSOR OVERLOAD" },
1596 { GSM0808_CAUSE_BSS_NOT_EQUIPPED, "BSS NOT EQUIPPED" },
1597 { GSM0808_CAUSE_MS_NOT_EQUIPPED, "MS NOT EQUIPPED" },
1598 { GSM0808_CAUSE_INVALID_CELL, "INVALID CELL" },
1599 { GSM0808_CAUSE_TRAFFIC_LOAD, "TRAFFIC LOAD" },
1600 { GSM0808_CAUSE_PREEMPTION, "PREEMPTION" },
1601 { GSM0808_CAUSE_DTM_HO_SGSN_FAILURE, "DTM HO SGSN FAILURE" },
1602 { GSM0808_CAUSE_DTM_HO_PS_ALLOC_FAILURE, "DTM HO PS ALLOC FAILURE" },
1603 { GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE, "RQSTED TRANSCODING RATE ADAPTION UNAVAILABLE" },
1604 { GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH, "CIRCUIT POOL MISMATCH" },
1605 { GSM0808_CAUSE_SWITCH_CIRCUIT_POOL, "SWITCH CIRCUIT POOL" },
1606 { GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, "RQSTED SPEECH VERSION UNAVAILABLE" },
1607 { GSM0808_CAUSE_LSA_NOT_ALLOWED, "LSA NOT ALLOWED" },
1608 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_UNAVAIL, "REQ CODEC TYPE OR CONFIG UNAVAIL" },
1609 { GSM0808_CAUSE_REQ_A_IF_TYPE_UNAVAIL, "REQ A IF TYPE UNAVAIL" },
1610 { GSM0808_CAUSE_INVALID_CSG_CELL, "INVALID CSG CELL" },
1611 { GSM0808_CAUSE_REQ_REDUND_LEVEL_NOT_AVAIL, "REQ REDUND LEVEL NOT AVAIL" },
1612 { GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED, "CIPHERING ALGORITHM NOT SUPPORTED" },
1613 { GSM0808_CAUSE_GERAN_IU_MODE_FAILURE, "GERAN IU MODE FAILURE" },
1614 { GSM0808_CAUSE_INC_RELOC_NOT_SUPP_DT_PUESBINE_FEATURE, "INC RELOC NOT SUPP DT PUESBINE FEATURE" },
1615 { GSM0808_CAUSE_ACCESS_RESTRICTED_DUE_TO_SHARED_NETWORKS, "ACCESS RESTRICTED DUE TO SHARED NETWORKS" },
1616 { GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, "REQ CODEC TYPE OR CONFIG NOT SUPP" },
1617 { GSM0808_CAUSE_REQ_A_IF_TYPE_NOT_SUPP, "REQ A IF TYPE NOT SUPP" },
1618 { GSM0808_CAUSE_REQ_REDUND_LVL_NOT_SUPP, "REQ REDUND LVL NOT SUPP" },
1619 { GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED, "TERRESTRIAL CIRCUIT ALREADY ALLOCATED" },
1620 { GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS, "INVALID MESSAGE CONTENTS" },
1621 { GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING, "INFORMATION ELEMENT OR FIELD MISSING" },
1622 { GSM0808_CAUSE_INCORRECT_VALUE, "INCORRECT VALUE" },
1623 { GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE, "UNKNOWN MESSAGE TYPE" },
1624 { GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT, "UNKNOWN INFORMATION ELEMENT" },
1625 { GSM0808_CAUSE_DTM_HO_INVALID_PS_IND, "DTM HO INVALID PS IND" },
1626 { GSM0808_CAUSE_CALL_ID_ALREADY_ALLOC, "CALL ID ALREADY ALLOC" },
1627 { GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC, "PROTOCOL ERROR BETWEEN BSS AND MSC" },
Thorsten Alteholz0062a5f2018-05-15 15:28:55 +02001628 { GSM0808_CAUSE_VGCS_VBS_CALL_NON_EXISTENT, "VGCS VBS CALL NON EXISTENT" },
Philipp Maierdbb76592018-03-29 12:55:26 +02001629 { GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY, "DTM HO TIMER EXPIRY" },
1630 { 0, NULL }
1631};
1632
Maxaa934632018-11-07 13:16:54 +01001633static const struct value_string gsm0808_cause_class_names[] = {
1634 { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },
1635 { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },
1636 { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },
1637 { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },
1638 { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },
1639 { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },
1640 { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },
1641 { GSM0808_CAUSE_CLASS_INTW, "Interworking" },
1642 { 0, NULL }
1643};
1644
1645/*! Return string name of BSSMAP Cause Class name */
1646const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)
1647{
1648 return get_value_string(gsm0808_cause_class_names, class);
1649}
1650
Philipp Maierdbb76592018-03-29 12:55:26 +02001651/*! Return string name of BSSMAP Cause name */
Maxaa934632018-11-07 13:16:54 +01001652const char *gsm0808_cause_name(enum gsm0808_cause cause)
Philipp Maierdbb76592018-03-29 12:55:26 +02001653{
1654 return get_value_string(gsm0808_cause_names, cause);
1655}
1656
Harald Welteebd362d2018-06-02 14:11:19 +02001657const struct value_string gsm0808_lcls_config_names[] = {
1658 { GSM0808_LCLS_CFG_BOTH_WAY, "Connect both-way" },
1659 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL,
1660 "Connect both-way, bi-cast UL to CN" },
1661 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL,
1662 "Connect both-way, send access DL from CN" },
1663 { GSM0808_LCLS_CFG_BOTH_WAY_AND_SEND_DL_BLOCK_LOCAL_DL,
1664 "Connect both-way, send access DL from CN, block local DL" },
1665 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL,
1666 "Connect both-way, bi-cast UL to CN, send access DL from CN" },
1667 { GSM0808_LCLS_CFG_BOTH_WAY_AND_BICAST_UL_SEND_DL_BLOCK_LOCAL_DL,
1668 "Connect both-way, bi-cast UL to CN, send access DL from CN, block local DL" },
Max961db7c2018-11-08 11:40:23 +01001669 { GSM0808_LCLS_CFG_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001670 { 0, NULL }
1671};
1672
1673const struct value_string gsm0808_lcls_control_names[] = {
1674 { GSM0808_LCLS_CSC_CONNECT, "Connect" },
1675 { GSM0808_LCLS_CSC_DO_NOT_CONNECT, "Do not connect" },
1676 { GSM0808_LCLS_CSC_RELEASE_LCLS, "Release LCLS" },
1677 { GSM0808_LCLS_CSC_BICAST_UL_AT_HANDOVER, "Bi-cast UL at Handover" },
1678 { GSM0808_LCLS_CSC_BICAST_UL_AND_RECV_DL_AT_HANDOVER, "Bi-cast UL and receive DL at Handover" },
Max961db7c2018-11-08 11:40:23 +01001679 { GSM0808_LCLS_CSC_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001680 { 0, NULL }
1681};
1682
1683const struct value_string gsm0808_lcls_status_names[] = {
1684 { GSM0808_LCLS_STS_NOT_YET_LS, "Call not yet locally switched" },
1685 { GSM0808_LCLS_STS_NOT_POSSIBLE_LS, "Call not possible to be locally switched" },
1686 { GSM0808_LCLS_STS_NO_LONGER_LS, "Call is no longer locally switched" },
1687 { GSM0808_LCLS_STS_REQ_LCLS_NOT_SUPP, "Requested LCLS configuration is not supported" },
1688 { GSM0808_LCLS_STS_LOCALLY_SWITCHED, "Call is locally switched with requested LCLS config" },
Max961db7c2018-11-08 11:40:23 +01001689 { GSM0808_LCLS_STS_NA, "Not available" },
Harald Welteebd362d2018-06-02 14:11:19 +02001690 { 0, NULL }
1691};
1692
Harald Welte96e2a002017-06-12 21:44:18 +02001693/*! @} */