blob: a7fa81d69f60cc4494dc262d8318539f240b5ddf [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*
Harald Weltee08da972017-11-13 01:00:26 +09002 * (C) 2008-2017 by Harald Welte <laforge@gnumonks.org>
3 * (C) 2013 by Holger Freyther <holger@freyther.de>
4 * (C) 2014-2016 by sysmocom - s.f.m.c. GmbH
Harald Welted284cd92010-03-01 21:58:31 +01005 *
6 * All Rights Reserved
7 *
Harald Weltee08da972017-11-13 01:00:26 +09008 * SPDX-License-Identifier: GPL-2.0+
9 *
Harald Welted284cd92010-03-01 21:58:31 +010010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 *
24 */
25
Harald Welteecf9dd02010-03-04 14:27:48 +010026#include <stdint.h>
Harald Welte40481e82010-07-30 11:40:32 +020027#include <stdio.h>
Harald Welteecf9dd02010-03-04 14:27:48 +010028#include <errno.h>
29
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010030#include <osmocom/gsm/tlv.h>
31#include <osmocom/gsm/rsl.h>
Harald Welted284cd92010-03-01 21:58:31 +010032
Harald Welte8f2c7e52011-08-17 18:52:03 +020033/*! \addtogroup rsl
34 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020035 * GSM Radio Signalling Link messages on the A-bis interface.
36 * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0.
37 *
38 * \file rsl.c */
Harald Welte8f2c7e52011-08-17 18:52:03 +020039
Neels Hofmeyr87e45502017-06-20 00:17:59 +020040/*! Size for RSL \ref msgb_alloc */
Harald Welteeb8bf392010-03-04 10:32:09 +010041#define RSL_ALLOC_SIZE 200
Neels Hofmeyr87e45502017-06-20 00:17:59 +020042/*! Headroom size for RSL \ref msgb_alloc */
Harald Welteeb8bf392010-03-04 10:32:09 +010043#define RSL_ALLOC_HEADROOM 56
44
Neels Hofmeyr87e45502017-06-20 00:17:59 +020045/*! Initialize a RSL RLL header
Harald Welte96e2a002017-06-12 21:44:18 +020046 * \param[out] dh Caller-allocated RSL RLL header
47 * \param[in] msg_type Message Type */
Harald Welted284cd92010-03-01 21:58:31 +010048void rsl_init_rll_hdr(struct abis_rsl_rll_hdr *dh, uint8_t msg_type)
49{
50 dh->c.msg_discr = ABIS_RSL_MDISC_RLL;
51 dh->c.msg_type = msg_type;
52 dh->ie_chan = RSL_IE_CHAN_NR;
53 dh->ie_link_id = RSL_IE_LINK_IDENT;
54}
55
Neels Hofmeyr87e45502017-06-20 00:17:59 +020056/*! Initialize a RSL Common Channel header
Harald Welte96e2a002017-06-12 21:44:18 +020057 * \param[out] ch Caller-allocated RSL Common Channel Header
58 * \param[in] msg_type Message Type */
Harald Welte6eb7d6c2010-07-13 13:48:13 +020059void rsl_init_cchan_hdr(struct abis_rsl_cchan_hdr *ch, uint8_t msg_type)
60{
61 ch->c.msg_discr = ABIS_RSL_MDISC_COM_CHAN;
62 ch->c.msg_type = msg_type;
63 ch->ie_chan = RSL_IE_CHAN_NR;
64}
65
Neels Hofmeyr87e45502017-06-20 00:17:59 +020066/* TLV parser definition for RSL */
Harald Welted284cd92010-03-01 21:58:31 +010067const struct tlv_definition rsl_att_tlvdef = {
68 .def = {
69 [RSL_IE_CHAN_NR] = { TLV_TYPE_TV },
70 [RSL_IE_LINK_IDENT] = { TLV_TYPE_TV },
71 [RSL_IE_ACT_TYPE] = { TLV_TYPE_TV },
72 [RSL_IE_BS_POWER] = { TLV_TYPE_TV },
73 [RSL_IE_CHAN_IDENT] = { TLV_TYPE_TLV },
74 [RSL_IE_CHAN_MODE] = { TLV_TYPE_TLV },
75 [RSL_IE_ENCR_INFO] = { TLV_TYPE_TLV },
76 [RSL_IE_FRAME_NUMBER] = { TLV_TYPE_FIXED, 2 },
77 [RSL_IE_HANDO_REF] = { TLV_TYPE_TV },
78 [RSL_IE_L1_INFO] = { TLV_TYPE_FIXED, 2 },
79 [RSL_IE_L3_INFO] = { TLV_TYPE_TL16V },
80 [RSL_IE_MS_IDENTITY] = { TLV_TYPE_TLV },
81 [RSL_IE_MS_POWER] = { TLV_TYPE_TV },
82 [RSL_IE_PAGING_GROUP] = { TLV_TYPE_TV },
83 [RSL_IE_PAGING_LOAD] = { TLV_TYPE_FIXED, 2 },
84 [RSL_IE_PYHS_CONTEXT] = { TLV_TYPE_TLV },
85 [RSL_IE_ACCESS_DELAY] = { TLV_TYPE_TV },
86 [RSL_IE_RACH_LOAD] = { TLV_TYPE_TLV },
87 [RSL_IE_REQ_REFERENCE] = { TLV_TYPE_FIXED, 3 },
88 [RSL_IE_RELEASE_MODE] = { TLV_TYPE_TV },
89 [RSL_IE_RESOURCE_INFO] = { TLV_TYPE_TLV },
90 [RSL_IE_RLM_CAUSE] = { TLV_TYPE_TLV },
91 [RSL_IE_STARTNG_TIME] = { TLV_TYPE_FIXED, 2 },
92 [RSL_IE_TIMING_ADVANCE] = { TLV_TYPE_TV },
93 [RSL_IE_UPLINK_MEAS] = { TLV_TYPE_TLV },
94 [RSL_IE_CAUSE] = { TLV_TYPE_TLV },
95 [RSL_IE_MEAS_RES_NR] = { TLV_TYPE_TV },
96 [RSL_IE_MSG_ID] = { TLV_TYPE_TV },
97 [RSL_IE_SYSINFO_TYPE] = { TLV_TYPE_TV },
98 [RSL_IE_MS_POWER_PARAM] = { TLV_TYPE_TLV },
99 [RSL_IE_BS_POWER_PARAM] = { TLV_TYPE_TLV },
100 [RSL_IE_PREPROC_PARAM] = { TLV_TYPE_TLV },
101 [RSL_IE_PREPROC_MEAS] = { TLV_TYPE_TLV },
102 [RSL_IE_IMM_ASS_INFO] = { TLV_TYPE_TLV },
103 [RSL_IE_SMSCB_INFO] = { TLV_TYPE_FIXED, 23 },
104 [RSL_IE_MS_TIMING_OFFSET] = { TLV_TYPE_TV },
105 [RSL_IE_ERR_MSG] = { TLV_TYPE_TLV },
106 [RSL_IE_FULL_BCCH_INFO] = { TLV_TYPE_TLV },
107 [RSL_IE_CHAN_NEEDED] = { TLV_TYPE_TV },
108 [RSL_IE_CB_CMD_TYPE] = { TLV_TYPE_TV },
109 [RSL_IE_SMSCB_MSG] = { TLV_TYPE_TLV },
110 [RSL_IE_FULL_IMM_ASS_INFO] = { TLV_TYPE_TLV },
111 [RSL_IE_SACCH_INFO] = { TLV_TYPE_TLV },
112 [RSL_IE_CBCH_LOAD_INFO] = { TLV_TYPE_TV },
113 [RSL_IE_SMSCB_CHAN_INDICATOR] = { TLV_TYPE_TV },
114 [RSL_IE_GROUP_CALL_REF] = { TLV_TYPE_TLV },
115 [RSL_IE_CHAN_DESC] = { TLV_TYPE_TLV },
116 [RSL_IE_NCH_DRX_INFO] = { TLV_TYPE_TLV },
117 [RSL_IE_CMD_INDICATOR] = { TLV_TYPE_TLV },
118 [RSL_IE_EMLPP_PRIO] = { TLV_TYPE_TV },
119 [RSL_IE_UIC] = { TLV_TYPE_TLV },
120 [RSL_IE_MAIN_CHAN_REF] = { TLV_TYPE_TV },
121 [RSL_IE_MR_CONFIG] = { TLV_TYPE_TLV },
122 [RSL_IE_MR_CONTROL] = { TLV_TYPE_TV },
123 [RSL_IE_SUP_CODEC_TYPES] = { TLV_TYPE_TLV },
124 [RSL_IE_CODEC_CONFIG] = { TLV_TYPE_TLV },
125 [RSL_IE_RTD] = { TLV_TYPE_TV },
126 [RSL_IE_TFO_STATUS] = { TLV_TYPE_TV },
127 [RSL_IE_LLP_APDU] = { TLV_TYPE_TLV },
128 [RSL_IE_SIEMENS_MRPCI] = { TLV_TYPE_TV },
Philipp Maiera15967b2020-11-06 21:37:16 +0100129 [RSL_IE_OSMO_REP_ACCH_CAP] = { TLV_TYPE_TLV },
Neels Hofmeyrdd6f1362021-04-20 23:02:59 +0200130 [RSL_IE_OSMO_TRAINING_SEQUENCE] = { TLV_TYPE_TLV },
Harald Welted284cd92010-03-01 21:58:31 +0100131 [RSL_IE_IPAC_PROXY_UDP] = { TLV_TYPE_FIXED, 2 },
132 [RSL_IE_IPAC_BSCMPL_TOUT] = { TLV_TYPE_TV },
133 [RSL_IE_IPAC_REMOTE_IP] = { TLV_TYPE_FIXED, 4 },
134 [RSL_IE_IPAC_REMOTE_PORT] = { TLV_TYPE_FIXED, 2 },
135 [RSL_IE_IPAC_RTP_PAYLOAD] = { TLV_TYPE_TV },
136 [RSL_IE_IPAC_LOCAL_PORT] = { TLV_TYPE_FIXED, 2 },
137 [RSL_IE_IPAC_SPEECH_MODE] = { TLV_TYPE_TV },
138 [RSL_IE_IPAC_LOCAL_IP] = { TLV_TYPE_FIXED, 4 },
139 [RSL_IE_IPAC_CONN_ID] = { TLV_TYPE_FIXED, 2 },
140 [RSL_IE_IPAC_RTP_CSD_FMT] = { TLV_TYPE_TV },
141 [RSL_IE_IPAC_RTP_JIT_BUF] = { TLV_TYPE_FIXED, 2 },
142 [RSL_IE_IPAC_RTP_COMPR] = { TLV_TYPE_TV },
143 [RSL_IE_IPAC_RTP_PAYLOAD2] = { TLV_TYPE_TV },
144 [RSL_IE_IPAC_RTP_MPLEX] = { TLV_TYPE_FIXED, 8 },
145 [RSL_IE_IPAC_RTP_MPLEX_ID] = { TLV_TYPE_TV },
146 },
147};
148
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200149/*! Encode channel number as per Section 9.3.1
Harald Welte96e2a002017-06-12 21:44:18 +0200150 * \param[in] Channel Type (RSL_CHAN_...)
151 * \param[in] subch Sub-Channel within Channel
152 * \param[in] timeslot Air interface timeslot
153 * \returns RSL Channel Number (TS 08.58 9.3.1) */
Harald Welted284cd92010-03-01 21:58:31 +0100154uint8_t rsl_enc_chan_nr(uint8_t type, uint8_t subch, uint8_t timeslot)
155{
156 uint8_t ret;
157
158 ret = (timeslot & 0x07) | type;
159
160 switch (type) {
161 case RSL_CHAN_Lm_ACCHs:
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200162 case RSL_CHAN_OSMO_VAMOS_Lm_ACCHs:
Harald Welted284cd92010-03-01 21:58:31 +0100163 subch &= 0x01;
164 break;
165 case RSL_CHAN_SDCCH4_ACCH:
Harald Welte098cd4b2010-03-04 10:12:50 +0100166 subch &= 0x03;
Harald Welted284cd92010-03-01 21:58:31 +0100167 break;
168 case RSL_CHAN_SDCCH8_ACCH:
169 subch &= 0x07;
170 break;
171 default:
172 /* no subchannels allowed */
173 subch = 0x00;
174 break;
175 }
176 ret |= (subch << 3);
177
178 return ret;
179}
180
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200181/*! Decode RSL channel number
Harald Welte8f2c7e52011-08-17 18:52:03 +0200182 * \param[in] chan_nr Channel Number
183 * \param[out] type Channel Type
184 * \param[out] subch Sub-channel Number
185 * \param[out] timeslot Timeslot
186 */
Harald Welteecf9dd02010-03-04 14:27:48 +0100187int rsl_dec_chan_nr(uint8_t chan_nr, uint8_t *type, uint8_t *subch, uint8_t *timeslot)
188{
189 *timeslot = chan_nr & 0x7;
190
Vadim Yanitskiy57850ae2021-05-26 20:23:46 +0200191 switch (chan_nr & RSL_CHAN_NR_MASK) {
192 case RSL_CHAN_Bm_ACCHs:
193 case RSL_CHAN_BCCH:
194 case RSL_CHAN_RACH:
195 case RSL_CHAN_PCH_AGCH:
196 case RSL_CHAN_OSMO_PDCH:
197 case RSL_CHAN_OSMO_CBCH4:
198 case RSL_CHAN_OSMO_CBCH8:
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200199 case RSL_CHAN_OSMO_VAMOS_Bm_ACCHs:
Vadim Yanitskiy57850ae2021-05-26 20:23:46 +0200200 *type = chan_nr & RSL_CHAN_NR_MASK;
Harald Welteecf9dd02010-03-04 14:27:48 +0100201 *subch = 0;
Vadim Yanitskiy57850ae2021-05-26 20:23:46 +0200202 break;
203 default:
204 if ((chan_nr & 0xf0) == RSL_CHAN_Lm_ACCHs) {
205 *type = RSL_CHAN_Lm_ACCHs;
206 *subch = (chan_nr >> 3) & 0x1;
207 } else if ((chan_nr & 0xe0) == RSL_CHAN_SDCCH4_ACCH) {
208 *type = RSL_CHAN_SDCCH4_ACCH;
209 *subch = (chan_nr >> 3) & 0x3;
210 } else if ((chan_nr & 0xc0) == RSL_CHAN_SDCCH8_ACCH) {
211 *type = RSL_CHAN_SDCCH8_ACCH;
212 *subch = (chan_nr >> 3) & 0x7;
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200213 } else if ((chan_nr & 0xf0) == RSL_CHAN_OSMO_VAMOS_Lm_ACCHs) {
214 *type = RSL_CHAN_OSMO_VAMOS_Lm_ACCHs;
215 *subch = (chan_nr >> 3) & 0x1;
Vadim Yanitskiy57850ae2021-05-26 20:23:46 +0200216 } else
217 return -EINVAL;
218 }
Harald Welteecf9dd02010-03-04 14:27:48 +0100219
220 return 0;
221}
222
Harald Welte4a62eda2019-03-18 18:27:00 +0100223/*! Get human-readable string for RSL channel number, in caller-provided buffer.
224 * \param[out] buf caller-provided output buffer
225 * \param[in] buf_len size of buf in bytes
226 * \param[in] chan_nr channel number to be stringified
227 * \returns buf with string
228 */
229char *rsl_chan_nr_str_buf(char *buf, size_t buf_len, uint8_t chan_nr)
Sylvain Munaut27af0752010-07-25 12:25:17 +0200230{
Sylvain Munaut27af0752010-07-25 12:25:17 +0200231 int ts = chan_nr & 7;
232 uint8_t cbits = chan_nr >> 3;
233
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700234 if (cbits == ABIS_RSL_CHAN_NR_CBITS_Bm_ACCHs)
Harald Welte4a62eda2019-03-18 18:27:00 +0100235 snprintf(buf, buf_len, "TCH/F on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700236 else if ((cbits & 0x1e) == ABIS_RSL_CHAN_NR_CBITS_Lm_ACCHs(0))
Harald Welte4a62eda2019-03-18 18:27:00 +0100237 snprintf(buf, buf_len, "TCH/H(%u) on TS%d", cbits & 0x01, ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700238 else if ((cbits & 0x1c) == ABIS_RSL_CHAN_NR_CBITS_SDCCH4_ACCH(0))
Harald Welte4a62eda2019-03-18 18:27:00 +0100239 snprintf(buf, buf_len, "SDCCH/4(%u) on TS%d", cbits & 0x03, ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700240 else if ((cbits & 0x18) == ABIS_RSL_CHAN_NR_CBITS_SDCCH8_ACCH(0))
Harald Welte4a62eda2019-03-18 18:27:00 +0100241 snprintf(buf, buf_len, "SDCCH/8(%u) on TS%d", cbits & 0x07, ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700242 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_BCCH)
Harald Welte4a62eda2019-03-18 18:27:00 +0100243 snprintf(buf, buf_len, "BCCH on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700244 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_RACH)
Harald Welte4a62eda2019-03-18 18:27:00 +0100245 snprintf(buf, buf_len, "RACH on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700246 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_PCH_AGCH)
Harald Welte4a62eda2019-03-18 18:27:00 +0100247 snprintf(buf, buf_len, "PCH/AGCH on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700248 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_OSMO_PDCH)
Harald Welte4a62eda2019-03-18 18:27:00 +0100249 snprintf(buf, buf_len, "PDCH on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700250 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_OSMO_CBCH4)
Harald Weltea8d7ebb2019-05-27 16:51:23 +0200251 snprintf(buf, buf_len, "CBCH(SDCCH/4) on TS%d", ts);
Vadim Yanitskiyfdaec8e2020-10-17 00:27:12 +0700252 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_OSMO_CBCH8)
Harald Weltea8d7ebb2019-05-27 16:51:23 +0200253 snprintf(buf, buf_len, "CBCH(SDCCH/8) on TS%d", ts);
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200254 else if (cbits == ABIS_RSL_CHAN_NR_CBITS_OSMO_VAMOS_Bm_ACCHs)
255 snprintf(buf, buf_len, "VAMOS TCH/F on TS%d", ts);
256 else if ((cbits & 0x1e) == ABIS_RSL_CHAN_NR_CBITS_OSMO_VAMOS_Lm_ACCHs(0))
257 snprintf(buf, buf_len, "VAMOS TCH/H(%u) on TS%d", cbits & 0x01, ts);
Sylvain Munaut27af0752010-07-25 12:25:17 +0200258 else
Harald Welte4a62eda2019-03-18 18:27:00 +0100259 snprintf(buf, buf_len, "UNKNOWN on TS%d", ts);
Sylvain Munaut27af0752010-07-25 12:25:17 +0200260
Harald Welte4a62eda2019-03-18 18:27:00 +0100261 return buf;
262}
263
264/*! Get human-readable string for RSL channel number, in static buffer.
265 * \param[in] chan_nr channel number to be stringified
266 * \returns buf with string
267 */
268const char *rsl_chan_nr_str(uint8_t chan_nr)
269{
Harald Welte171ef822019-03-28 10:49:05 +0100270 static __thread char str[20];
Harald Welte4a62eda2019-03-18 18:27:00 +0100271 return rsl_chan_nr_str_buf(str, sizeof(str), chan_nr);
Sylvain Munaut27af0752010-07-25 12:25:17 +0200272}
273
Harald Welte179f3572019-03-18 18:38:47 +0100274/*! Get human-readable string for RSL channel number, in dynamically-allocated buffer.
275 * \param[in] ctx talloc context from which to allocate output buffer
276 * \param[in] chan_nr channel number to be stringified
277 * \returns dynamically-allocated buffer with string representation
278 */
279char *rsl_chan_nr_str_c(const void *ctx, uint8_t chan_nr)
280{
281 char *str = talloc_size(ctx, 20);
282 if (!str)
283 return NULL;
284 return rsl_chan_nr_str_buf(str, 20, chan_nr);
285}
286
Harald Weltee9e190a2010-03-25 11:44:57 +0800287static const struct value_string rsl_err_vals[] = {
288 { RSL_ERR_RADIO_IF_FAIL, "Radio Interface Failure" },
289 { RSL_ERR_RADIO_LINK_FAIL, "Radio Link Failure" },
290 { RSL_ERR_HANDOVER_ACC_FAIL, "Handover Access Failure" },
291 { RSL_ERR_TALKER_ACC_FAIL, "Talker Access Failure" },
292 { RSL_ERR_OM_INTERVENTION, "O&M Intervention" },
293 { RSL_ERR_NORMAL_UNSPEC, "Normal event, unspecified" },
294 { RSL_ERR_T_MSRFPCI_EXP, "Siemens: T_MSRFPCI Expired" },
295 { RSL_ERR_EQUIPMENT_FAIL, "Equipment Failure" },
296 { RSL_ERR_RR_UNAVAIL, "Radio Resource not available" },
297 { RSL_ERR_TERR_CH_FAIL, "Terrestrial Channel Failure" },
298 { RSL_ERR_CCCH_OVERLOAD, "CCCH Overload" },
299 { RSL_ERR_ACCH_OVERLOAD, "ACCH Overload" },
300 { RSL_ERR_PROCESSOR_OVERLOAD, "Processor Overload" },
Philipp Maier6d214482020-07-28 16:53:27 +0200301 { RSL_ERR_BTS_NOT_EQUIPPED, "BTS not equipped" },
302 { RSL_ERR_REMOTE_TRANSC_FAIL, "Remote Transcoder Failure" },
303 { RSL_ERR_NOTIFICATION_OVERFL, "Notification Overflow" },
Harald Weltee9e190a2010-03-25 11:44:57 +0800304 { RSL_ERR_RES_UNAVAIL, "Resource not available, unspecified" },
305 { RSL_ERR_TRANSC_UNAVAIL, "Transcoding not available" },
306 { RSL_ERR_SERV_OPT_UNAVAIL, "Service or Option not available" },
307 { RSL_ERR_ENCR_UNIMPL, "Encryption algorithm not implemented" },
308 { RSL_ERR_SERV_OPT_UNIMPL, "Service or Option not implemented" },
309 { RSL_ERR_RCH_ALR_ACTV_ALLOC, "Radio channel already activated" },
310 { RSL_ERR_INVALID_MESSAGE, "Invalid Message, unspecified" },
311 { RSL_ERR_MSG_DISCR, "Message Discriminator Error" },
312 { RSL_ERR_MSG_TYPE, "Message Type Error" },
313 { RSL_ERR_MSG_SEQ, "Message Sequence Error" },
314 { RSL_ERR_IE_ERROR, "General IE error" },
315 { RSL_ERR_MAND_IE_ERROR, "Mandatory IE error" },
316 { RSL_ERR_OPT_IE_ERROR, "Optional IE error" },
317 { RSL_ERR_IE_NONEXIST, "IE non-existent" },
318 { RSL_ERR_IE_LENGTH, "IE length error" },
319 { RSL_ERR_IE_CONTENT, "IE content error" },
320 { RSL_ERR_PROTO, "Protocol error, unspecified" },
321 { RSL_ERR_INTERWORKING, "Interworking error, unspecified" },
322 { 0, NULL }
Harald Welted284cd92010-03-01 21:58:31 +0100323};
324
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200325/*! Get human-readable name for RSL Error */
Harald Welte52b4abd2010-03-25 12:11:38 +0800326const char *rsl_err_name(uint8_t err)
327{
328 return get_value_string(rsl_err_vals, err);
329}
330
Harald Weltecf7e5da2011-06-23 20:43:13 +0200331/* Names for Radio Link Layer Management */
332static const struct value_string rsl_msgt_names[] = {
333 { RSL_MT_DATA_REQ, "DATA_REQ" },
334 { RSL_MT_DATA_IND, "DATA_IND" },
335 { RSL_MT_ERROR_IND, "ERROR_IND" },
336 { RSL_MT_EST_REQ, "EST_REQ" },
337 { RSL_MT_EST_CONF, "EST_CONF" },
338 { RSL_MT_EST_IND, "EST_IND" },
339 { RSL_MT_REL_REQ, "REL_REQ" },
340 { RSL_MT_REL_CONF, "REL_CONF" },
341 { RSL_MT_REL_IND, "REL_IND" },
342 { RSL_MT_UNIT_DATA_REQ, "UNIT_DATA_REQ" },
343 { RSL_MT_UNIT_DATA_IND, "UNIT_DATA_IND" },
344 { RSL_MT_SUSP_REQ, "SUSP_REQ" },
345 { RSL_MT_SUSP_CONF, "SUSP_CONF" },
346 { RSL_MT_RES_REQ, "RES_REQ" },
347 { RSL_MT_RECON_REQ, "RECON_REQ" },
348
349 { RSL_MT_BCCH_INFO, "BCCH_INFO" },
350 { RSL_MT_CCCH_LOAD_IND, "CCCH_LOAD_IND" },
351 { RSL_MT_CHAN_RQD, "CHAN_RQD" },
352 { RSL_MT_DELETE_IND, "DELETE_IND" },
353 { RSL_MT_PAGING_CMD, "PAGING_CMD" },
354 { RSL_MT_IMMEDIATE_ASSIGN_CMD, "IMM_ASS_CMD" },
355 { RSL_MT_SMS_BC_REQ, "SMS_BC_REQ" },
356 { RSL_MT_CHAN_CONF, "CHAN_CONF" },
357
358 { RSL_MT_RF_RES_IND, "RF_RES_IND" },
359 { RSL_MT_SACCH_FILL, "SACCH_FILL" },
360 { RSL_MT_OVERLOAD, "OVERLOAD" },
361 { RSL_MT_ERROR_REPORT, "ERROR_REPORT" },
362 { RSL_MT_SMS_BC_CMD, "SMS_BC_CMD" },
363 { RSL_MT_CBCH_LOAD_IND, "CBCH_LOAD_IND" },
364 { RSL_MT_NOT_CMD, "NOTIFY_CMD" },
365
366 { RSL_MT_CHAN_ACTIV, "CHAN_ACTIV" },
367 { RSL_MT_CHAN_ACTIV_ACK, "CHAN_ACTIV_ACK" },
368 { RSL_MT_CHAN_ACTIV_NACK, "CHAN_ACTIV_NACK" },
369 { RSL_MT_CONN_FAIL, "CONN_FAIL" },
370 { RSL_MT_DEACTIVATE_SACCH, "DEACTIVATE_SACCH" },
371 { RSL_MT_ENCR_CMD, "ENCR_CMD" },
372 { RSL_MT_HANDO_DET, "HANDOVER_DETECT" },
373 { RSL_MT_MEAS_RES, "MEAS_RES" },
374 { RSL_MT_MODE_MODIFY_REQ, "MODE_MODIFY_REQ" },
375 { RSL_MT_MODE_MODIFY_ACK, "MODE_MODIFY_ACK" },
376 { RSL_MT_MODE_MODIFY_NACK, "MODE_MODIFY_NACK" },
377 { RSL_MT_PHY_CONTEXT_REQ, "PHY_CONTEXT_REQ" },
378 { RSL_MT_PHY_CONTEXT_CONF, "PHY_CONTEXT_CONF" },
379 { RSL_MT_RF_CHAN_REL, "RF_CHAN_REL" },
380 { RSL_MT_MS_POWER_CONTROL, "MS_POWER_CONTROL" },
381 { RSL_MT_BS_POWER_CONTROL, "BS_POWER_CONTROL" },
382 { RSL_MT_PREPROC_CONFIG, "PREPROC_CONFIG" },
383 { RSL_MT_PREPROC_MEAS_RES, "PREPROC_MEAS_RES" },
384 { RSL_MT_RF_CHAN_REL_ACK, "RF_CHAN_REL_ACK" },
385 { RSL_MT_SACCH_INFO_MODIFY, "SACCH_INFO_MODIFY" },
386 { RSL_MT_TALKER_DET, "TALKER_DETECT" },
387 { RSL_MT_LISTENER_DET, "LISTENER_DETECT" },
388 { RSL_MT_REMOTE_CODEC_CONF_REP, "REM_CODEC_CONF_REP" },
389 { RSL_MT_RTD_REP, "RTD_REQ" },
390 { RSL_MT_PRE_HANDO_NOTIF, "HANDO_NOTIF" },
391 { RSL_MT_MR_CODEC_MOD_REQ, "CODEC_MOD_REQ" },
392 { RSL_MT_MR_CODEC_MOD_ACK, "CODEC_MOD_ACK" },
393 { RSL_MT_MR_CODEC_MOD_NACK, "CODEC_MOD_NACK" },
394 { RSL_MT_MR_CODEC_MOD_PER, "CODEC_MODE_PER" },
395 { RSL_MT_TFO_REP, "TFO_REP" },
396 { RSL_MT_TFO_MOD_REQ, "TFO_MOD_REQ" },
397 { RSL_MT_LOCATION_INFO, "LOCATION_INFO" },
Harald Weltef9456892019-09-03 13:56:00 +0200398 { RSL_MT_OSMO_ETWS_CMD, "OSMO_ETWS_CMD" },
Harald Weltecf7e5da2011-06-23 20:43:13 +0200399 { 0, NULL }
400};
401
402
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200403/*! Get human-readable string for RSL Message Type */
Harald Weltecf7e5da2011-06-23 20:43:13 +0200404const char *rsl_msg_name(uint8_t msg_type)
405{
406 return get_value_string(rsl_msgt_names, msg_type);
407}
408
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200409/*! ip.access specific */
Harald Weltea24026a2011-09-02 12:26:50 +0200410static const struct value_string rsl_ipac_msgt_names[] = {
411 { RSL_MT_IPAC_PDCH_ACT, "IPAC_PDCH_ACT" },
412 { RSL_MT_IPAC_PDCH_ACT_ACK, "IPAC_PDCH_ACT_ACK" },
413 { RSL_MT_IPAC_PDCH_ACT_NACK, "IPAC_PDCH_ACT_NACK" },
414 { RSL_MT_IPAC_PDCH_DEACT, "IPAC_PDCH_DEACT" },
415 { RSL_MT_IPAC_PDCH_DEACT_ACK, "IPAC_PDCH_DEACT_ACK" },
416 { RSL_MT_IPAC_PDCH_DEACT_NACK, "IPAC_PDCH_DEACT_NACK" },
417 { RSL_MT_IPAC_CONNECT_MUX, "IPAC_CONNECT_MUX" },
418 { RSL_MT_IPAC_CONNECT_MUX_ACK, "IPAC_CONNECT_MUX_ACK" },
419 { RSL_MT_IPAC_CONNECT_MUX_NACK, "IPAC_CONNECT_MUX_NACK" },
420 { RSL_MT_IPAC_BIND_MUX, "IPAC_BIND_MUX" },
421 { RSL_MT_IPAC_BIND_MUX_ACK, "IPAC_BIND_MUX_ACK" },
422 { RSL_MT_IPAC_BIND_MUX_NACK, "IPAC_BIND_MUX_NACK" },
423 { RSL_MT_IPAC_DISC_MUX, "IPAC_DISC_MUX" },
424 { RSL_MT_IPAC_DISC_MUX_ACK, "IPAC_DISC_MUX_ACK" },
425 { RSL_MT_IPAC_DISC_MUX_NACK, "IPAC_DISC_MUX_NACK" },
426 { RSL_MT_IPAC_CRCX, "IPAC_CRCX" },
427 { RSL_MT_IPAC_CRCX_ACK, "IPAC_CRCX_ACK" },
428 { RSL_MT_IPAC_CRCX_NACK, "IPAC_CRCX_NACK" },
429 { RSL_MT_IPAC_MDCX, "IPAC_MDCX" },
430 { RSL_MT_IPAC_MDCX_ACK, "IPAC_MDCX_ACK" },
431 { RSL_MT_IPAC_MDCX_NACK, "IPAC_MDCX_NACK" },
432 { RSL_MT_IPAC_DLCX_IND, "IPAC_DLCX_IND" },
433 { RSL_MT_IPAC_DLCX, "IPAC_DLCX" },
434 { RSL_MT_IPAC_DLCX_ACK, "IPAC_DLCX_ACK" },
435 { RSL_MT_IPAC_DLCX_NACK, "IPAC_DLCX_NACK" },
Minh-Quang Nguyen2ff597e2017-02-02 13:44:25 -0500436 { RSL_MT_IPAC_DIR_RETR_ENQ, "IPAC_DIR_RETR_ENQ" },
Harald Weltea24026a2011-09-02 12:26:50 +0200437 { 0, NULL }
438};
439
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200440/*! Get human-readable name of ip.access RSL msg type */
Harald Weltea24026a2011-09-02 12:26:50 +0200441const char *rsl_ipac_msg_name(uint8_t msg_type)
442{
443 return get_value_string(rsl_ipac_msgt_names, msg_type);
444}
445
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200446/*! Get human-readable name of standard or ip.access RSL msg type.
Neels Hofmeyr0167e3f2016-06-06 18:10:38 +0200447 * If msg_type is a standard RSL message type, return its human-readable name.
448 * Otherwise return rsl_ipac_msg_name(msg_type). */
449const char *rsl_or_ipac_msg_name(uint8_t msg_type)
450{
451 const char *str = get_value_string_or_null(rsl_msgt_names, msg_type);
452 if (str)
453 return str;
454 return rsl_ipac_msg_name(msg_type);
455}
456
Harald Welte52b4abd2010-03-25 12:11:38 +0800457static const struct value_string rsl_rlm_cause_strs[] = {
Harald Welted284cd92010-03-01 21:58:31 +0100458 { RLL_CAUSE_T200_EXPIRED, "Timer T200 expired (N200+1) times" },
459 { RLL_CAUSE_REEST_REQ, "Re-establishment request" },
460 { RLL_CAUSE_UNSOL_UA_RESP, "Unsolicited UA response" },
461 { RLL_CAUSE_UNSOL_DM_RESP, "Unsolicited DM response" },
462 { RLL_CAUSE_UNSOL_DM_RESP_MF, "Unsolicited DM response, multiple frame" },
463 { RLL_CAUSE_UNSOL_SPRV_RESP, "Unsolicited supervisory response" },
464 { RLL_CAUSE_SEQ_ERR, "Sequence Error" },
465 { RLL_CAUSE_UFRM_INC_PARAM, "U-Frame with incorrect parameters" },
466 { RLL_CAUSE_SFRM_INC_PARAM, "S-Frame with incorrect parameters" },
467 { RLL_CAUSE_IFRM_INC_MBITS, "I-Frame with incorrect use of M bit" },
468 { RLL_CAUSE_IFRM_INC_LEN, "I-Frame with incorrect length" },
Holger Hans Peter Freyther9ac45372013-06-11 17:54:56 +0200469 { RLL_CAUSE_FRM_UNIMPL, "Frame not implemented" },
Harald Welted284cd92010-03-01 21:58:31 +0100470 { RLL_CAUSE_SABM_MF, "SABM command, multiple frame established state" },
471 { RLL_CAUSE_SABM_INFO_NOTALL, "SABM frame with information not allowed in this state" },
472 { 0, NULL },
473};
474
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200475/*! Get human-readable string for RLM cause */
Harald Welte52b4abd2010-03-25 12:11:38 +0800476const char *rsl_rlm_cause_name(uint8_t err)
Harald Welted284cd92010-03-01 21:58:31 +0100477{
Harald Welte52b4abd2010-03-25 12:11:38 +0800478 return get_value_string(rsl_rlm_cause_strs, err);
Harald Welted284cd92010-03-01 21:58:31 +0100479}
480
481/* Section 3.3.2.3 TS 05.02. I think this looks like a table */
482int rsl_ccch_conf_to_bs_cc_chans(int ccch_conf)
483{
484 switch (ccch_conf) {
485 case RSL_BCCH_CCCH_CONF_1_NC:
486 return 1;
487 case RSL_BCCH_CCCH_CONF_1_C:
488 return 1;
489 case RSL_BCCH_CCCH_CONF_2_NC:
490 return 2;
491 case RSL_BCCH_CCCH_CONF_3_NC:
492 return 3;
493 case RSL_BCCH_CCCH_CONF_4_NC:
494 return 4;
495 default:
496 return -1;
497 }
498}
499
500/* Section 3.3.2.3 TS 05.02 */
501int rsl_ccch_conf_to_bs_ccch_sdcch_comb(int ccch_conf)
502{
503 switch (ccch_conf) {
504 case RSL_BCCH_CCCH_CONF_1_NC:
505 return 0;
506 case RSL_BCCH_CCCH_CONF_1_C:
507 return 1;
508 case RSL_BCCH_CCCH_CONF_2_NC:
509 return 0;
510 case RSL_BCCH_CCCH_CONF_3_NC:
511 return 0;
512 case RSL_BCCH_CCCH_CONF_4_NC:
513 return 0;
514 default:
515 return -1;
516 }
517}
Harald Weltef08eabf2010-03-02 21:59:20 +0100518
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200519/*! Push a RSL RLL header onto an existing msgb
Harald Welte96e2a002017-06-12 21:44:18 +0200520 * \param msg Message Buffer to which RLL header shall be pushed
521 * \param[in] msg_type RSL Message Type
522 * \param[in] chan_nr RSL Channel Number
523 * \param[in] link_id RSL Link Identifier
524 * \param[in] transparent Transparent to BTS (1) or not (0) */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200525void rsl_rll_push_hdr(struct msgb *msg, uint8_t msg_type, uint8_t chan_nr,
526 uint8_t link_id, int transparent)
Harald Weltef08eabf2010-03-02 21:59:20 +0100527{
Harald Weltef08eabf2010-03-02 21:59:20 +0100528 struct abis_rsl_rll_hdr *rh;
529
Harald Weltef08eabf2010-03-02 21:59:20 +0100530 rh = (struct abis_rsl_rll_hdr *) msgb_push(msg, sizeof(*rh));
531 rsl_init_rll_hdr(rh, msg_type);
Harald Welteeb8bf392010-03-04 10:32:09 +0100532 if (transparent)
533 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
Harald Weltef08eabf2010-03-02 21:59:20 +0100534 rh->chan_nr = chan_nr;
535 rh->link_id = link_id;
536
537 /* set the l2 header pointer */
538 msg->l2h = (uint8_t *)rh;
Harald Weltef08eabf2010-03-02 21:59:20 +0100539}
540
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200541/*! Wrap msgb in L3 Info IE and push a RSL RLL header
Harald Welte96e2a002017-06-12 21:44:18 +0200542 * \param[in] msg Message Buffer to which L3 Header shall be appended
543 * \param[in] msg_type RSL Message Type
544 * \param[in] chan_hr RSL Channel Number
545 * \param[in] link_id Link Identififer
546 * \param[in] transparent Transparent to BTS (1) or not (0) */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200547void rsl_rll_push_l3(struct msgb *msg, uint8_t msg_type, uint8_t chan_nr,
548 uint8_t link_id, int transparent)
549{
550 uint8_t l3_len = msg->tail - (uint8_t *)msgb_l3(msg);
551
552 /* construct a RSLms RLL message (DATA INDICATION, UNIT DATA
553 * INDICATION) and send it off via RSLms */
554
555 /* Push the L3 IE tag and lengh */
556 msgb_tv16_push(msg, RSL_IE_L3_INFO, l3_len);
557
558 /* Then push the RSL header */
559 rsl_rll_push_hdr(msg, msg_type, chan_nr, link_id, transparent);
560}
561
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200562/*! Create msgb with RSL RLL header
Harald Welte96e2a002017-06-12 21:44:18 +0200563 * \param[in] msg_type RSL Message Type
564 * \param[in] chan_nr RSL Channel Number
565 * \param[in] link_id RSL Link Identifier
566 * \param[in] transparent Transparent to BTS (1) or not (0)
567 * \returns callee-allocated msgb; NULL on error */
Harald Weltef08eabf2010-03-02 21:59:20 +0100568struct msgb *rsl_rll_simple(uint8_t msg_type, uint8_t chan_nr,
Harald Welteeb8bf392010-03-04 10:32:09 +0100569 uint8_t link_id, int transparent)
Harald Weltef08eabf2010-03-02 21:59:20 +0100570{
571 struct abis_rsl_rll_hdr *rh;
Harald Welteeb8bf392010-03-04 10:32:09 +0100572 struct msgb *msg;
573
574 msg = msgb_alloc_headroom(RSL_ALLOC_SIZE+RSL_ALLOC_HEADROOM,
575 RSL_ALLOC_HEADROOM, "rsl_rll_simple");
Harald Weltef08eabf2010-03-02 21:59:20 +0100576
577 if (!msg)
578 return NULL;
579
580 /* put the RSL header */
581 rh = (struct abis_rsl_rll_hdr *) msgb_put(msg, sizeof(*rh));
582 rsl_init_rll_hdr(rh, msg_type);
Harald Welteeb8bf392010-03-04 10:32:09 +0100583 if (transparent)
584 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
Harald Weltef08eabf2010-03-02 21:59:20 +0100585 rh->chan_nr = chan_nr;
586 rh->link_id = link_id;
587
588 /* set the l2 header pointer */
589 msg->l2h = (uint8_t *)rh;
590
591 return msg;
592}
Harald Welte8f2c7e52011-08-17 18:52:03 +0200593
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200594/*! TLV parser definitions for IPA embedded IEs */
Harald Weltefad57522015-12-13 11:56:36 +0100595const struct tlv_definition rsl_ipac_eie_tlvdef = {
596 .def = {
597 [RSL_IPAC_EIE_RXLEV] = { TLV_TYPE_TV },
598 [RSL_IPAC_EIE_RXQUAL] = { TLV_TYPE_TV },
599 [RSL_IPAC_EIE_FREQ_ERR] = { TLV_TYPE_FIXED, 2 },
600 [RSL_IPAC_EIE_TIMING_ERR] = { TLV_TYPE_TV },
601 [RSL_IPAC_EIE_MEAS_AVG_CFG] = { TLV_TYPE_TLV },
602 [RSL_IPAC_EIE_BS_PWR_CTL] = { TLV_TYPE_FIXED, 3 },
603 [RSL_IPAC_EIE_MS_PWR_CTL] = { TLV_TYPE_FIXED, 3 },
604 [RSL_IPAC_EIE_HANDO_THRESH] = { TLV_TYPE_FIXED, 6 },
605 [RSL_IPAC_EIE_NCELL_DEFAULTS] = { TLV_TYPE_FIXED, 3 },
606 [RSL_IPAC_EIE_NCELL_LIST] = { TLV_TYPE_TLV },
607 [RSL_IPAC_EIE_PC_THRESH_COMP] = { TLV_TYPE_FIXED, 10 },
608 [RSL_IPAC_EIE_HO_THRESH_COMP] = { TLV_TYPE_FIXED, 10 },
609 [RSL_IPAC_EIE_HO_CAUSE] = { TLV_TYPE_TLV },
610 [RSL_IPAC_EIE_HO_CANDIDATES] = { TLV_TYPE_TLV },
611 [RSL_IPAC_EIE_NCELL_BA_CHG_LIST]= { TLV_TYPE_TLV },
612 [RSL_IPAC_EIE_NUM_OF_MS] = { TLV_TYPE_TV },
613 [RSL_IPAC_EIE_HO_CAND_EXT] = { TLV_TYPE_TLV },
614 [RSL_IPAC_EIE_NCELL_DEF_EXT] = { TLV_TYPE_TLV },
615 [RSL_IPAC_EIE_NCELL_LIST_EXT] = { TLV_TYPE_TLV },
616 [RSL_IPAC_EIE_MASTER_KEY] = { TLV_TYPE_TLV },
617 [RSL_IPAC_EIE_MASTER_SALT] = { TLV_TYPE_TLV },
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400618 [RSL_IPAC_EIE_MEAS_TRANS_RES] = {TLV_TYPE_TV},
619 [RSL_IPAC_EIE_3G_HO_PARAM] = { TLV_TYPE_TLV },
620 [RSL_IPAC_EIE_3G_NCELL_LIST] = { TLV_TYPE_TLV },
621 [RSL_IPAC_EIE_SDCCH_CTL_PARAM] = { TLV_TYPE_TV },
622 [RSL_IPAC_EIE_AMR_CONV_THRESH] = { TLV_TYPE_FIXED, 9 },
Harald Weltefad57522015-12-13 11:56:36 +0100623 },
624};
625
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200626/*! String names of RSL Channel Activation Types */
Neels Hofmeyr47390762016-07-18 23:54:01 +0200627const struct value_string rsl_act_type_names[] = {
628 { RSL_ACT_TYPE_INITIAL, "INITIAL" },
629 { RSL_ACT_TYPE_REACT, "REACT" },
630 { RSL_ACT_INTRA_IMM_ASS, "INTRA_IMM_ASS" },
631 { RSL_ACT_INTRA_NORM_ASS, "INTRA_NORM_ASS" },
632 { RSL_ACT_INTER_ASYNC, "INTER_ASYNC" },
633 { RSL_ACT_INTER_SYNC, "INTER_SYNC" },
634 { RSL_ACT_SECOND_ADD, "SECOND_ADD" },
635 { RSL_ACT_SECOND_MULTI, "SECOND_MULTI" },
636 { RSL_ACT_OSMO_PDCH, "OSMO_PDCH" },
637 { 0, NULL }
638};
639
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200640/*! @} */