blob: 5bdb0063cc6a360a7c3fd089f5440fe7dc746929 [file] [log] [blame]
Harald Welted284cd92010-03-01 21:58:31 +01001/* GSM Radio Signalling Link messages on the A-bis interface
2 * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */
3
Harald Welteeb8bf392010-03-04 10:32:09 +01004/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welted284cd92010-03-01 21:58:31 +01005 *
6 * All Rights Reserved
7 *
8 * 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 Welteecf9dd02010-03-04 14:27:48 +010024#include <stdint.h>
Harald Welte40481e82010-07-30 11:40:32 +020025#include <stdio.h>
Harald Welteecf9dd02010-03-04 14:27:48 +010026#include <errno.h>
27
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010028#include <osmocom/gsm/tlv.h>
29#include <osmocom/gsm/rsl.h>
Harald Welted284cd92010-03-01 21:58:31 +010030
Harald Welte8f2c7e52011-08-17 18:52:03 +020031/*! \addtogroup rsl
32 * @{
Harald Welte96e2a002017-06-12 21:44:18 +020033 * \brief GSM Radio Signalling Link (TS 08.58)
Harald Welte8f2c7e52011-08-17 18:52:03 +020034 */
35
36/*! \file rsl.c */
37
38/*! \brief Size for RSL \ref msgb_alloc */
Harald Welteeb8bf392010-03-04 10:32:09 +010039#define RSL_ALLOC_SIZE 200
Harald Welte8f2c7e52011-08-17 18:52:03 +020040/*! \brief Headroom size for RSL \ref msgb_alloc */
Harald Welteeb8bf392010-03-04 10:32:09 +010041#define RSL_ALLOC_HEADROOM 56
42
Harald Welte96e2a002017-06-12 21:44:18 +020043/*! \brief Initialize a RSL RLL header
44 * \param[out] dh Caller-allocated RSL RLL header
45 * \param[in] msg_type Message Type */
Harald Welted284cd92010-03-01 21:58:31 +010046void rsl_init_rll_hdr(struct abis_rsl_rll_hdr *dh, uint8_t msg_type)
47{
48 dh->c.msg_discr = ABIS_RSL_MDISC_RLL;
49 dh->c.msg_type = msg_type;
50 dh->ie_chan = RSL_IE_CHAN_NR;
51 dh->ie_link_id = RSL_IE_LINK_IDENT;
52}
53
Harald Welte96e2a002017-06-12 21:44:18 +020054/*! \brief Initialize a RSL Common Channel header
55 * \param[out] ch Caller-allocated RSL Common Channel Header
56 * \param[in] msg_type Message Type */
Harald Welte6eb7d6c2010-07-13 13:48:13 +020057void rsl_init_cchan_hdr(struct abis_rsl_cchan_hdr *ch, uint8_t msg_type)
58{
59 ch->c.msg_discr = ABIS_RSL_MDISC_COM_CHAN;
60 ch->c.msg_type = msg_type;
61 ch->ie_chan = RSL_IE_CHAN_NR;
62}
63
Harald Welte8f2c7e52011-08-17 18:52:03 +020064/* \brief TLV parser definition for RSL */
Harald Welted284cd92010-03-01 21:58:31 +010065const struct tlv_definition rsl_att_tlvdef = {
66 .def = {
67 [RSL_IE_CHAN_NR] = { TLV_TYPE_TV },
68 [RSL_IE_LINK_IDENT] = { TLV_TYPE_TV },
69 [RSL_IE_ACT_TYPE] = { TLV_TYPE_TV },
70 [RSL_IE_BS_POWER] = { TLV_TYPE_TV },
71 [RSL_IE_CHAN_IDENT] = { TLV_TYPE_TLV },
72 [RSL_IE_CHAN_MODE] = { TLV_TYPE_TLV },
73 [RSL_IE_ENCR_INFO] = { TLV_TYPE_TLV },
74 [RSL_IE_FRAME_NUMBER] = { TLV_TYPE_FIXED, 2 },
75 [RSL_IE_HANDO_REF] = { TLV_TYPE_TV },
76 [RSL_IE_L1_INFO] = { TLV_TYPE_FIXED, 2 },
77 [RSL_IE_L3_INFO] = { TLV_TYPE_TL16V },
78 [RSL_IE_MS_IDENTITY] = { TLV_TYPE_TLV },
79 [RSL_IE_MS_POWER] = { TLV_TYPE_TV },
80 [RSL_IE_PAGING_GROUP] = { TLV_TYPE_TV },
81 [RSL_IE_PAGING_LOAD] = { TLV_TYPE_FIXED, 2 },
82 [RSL_IE_PYHS_CONTEXT] = { TLV_TYPE_TLV },
83 [RSL_IE_ACCESS_DELAY] = { TLV_TYPE_TV },
84 [RSL_IE_RACH_LOAD] = { TLV_TYPE_TLV },
85 [RSL_IE_REQ_REFERENCE] = { TLV_TYPE_FIXED, 3 },
86 [RSL_IE_RELEASE_MODE] = { TLV_TYPE_TV },
87 [RSL_IE_RESOURCE_INFO] = { TLV_TYPE_TLV },
88 [RSL_IE_RLM_CAUSE] = { TLV_TYPE_TLV },
89 [RSL_IE_STARTNG_TIME] = { TLV_TYPE_FIXED, 2 },
90 [RSL_IE_TIMING_ADVANCE] = { TLV_TYPE_TV },
91 [RSL_IE_UPLINK_MEAS] = { TLV_TYPE_TLV },
92 [RSL_IE_CAUSE] = { TLV_TYPE_TLV },
93 [RSL_IE_MEAS_RES_NR] = { TLV_TYPE_TV },
94 [RSL_IE_MSG_ID] = { TLV_TYPE_TV },
95 [RSL_IE_SYSINFO_TYPE] = { TLV_TYPE_TV },
96 [RSL_IE_MS_POWER_PARAM] = { TLV_TYPE_TLV },
97 [RSL_IE_BS_POWER_PARAM] = { TLV_TYPE_TLV },
98 [RSL_IE_PREPROC_PARAM] = { TLV_TYPE_TLV },
99 [RSL_IE_PREPROC_MEAS] = { TLV_TYPE_TLV },
100 [RSL_IE_IMM_ASS_INFO] = { TLV_TYPE_TLV },
101 [RSL_IE_SMSCB_INFO] = { TLV_TYPE_FIXED, 23 },
102 [RSL_IE_MS_TIMING_OFFSET] = { TLV_TYPE_TV },
103 [RSL_IE_ERR_MSG] = { TLV_TYPE_TLV },
104 [RSL_IE_FULL_BCCH_INFO] = { TLV_TYPE_TLV },
105 [RSL_IE_CHAN_NEEDED] = { TLV_TYPE_TV },
106 [RSL_IE_CB_CMD_TYPE] = { TLV_TYPE_TV },
107 [RSL_IE_SMSCB_MSG] = { TLV_TYPE_TLV },
108 [RSL_IE_FULL_IMM_ASS_INFO] = { TLV_TYPE_TLV },
109 [RSL_IE_SACCH_INFO] = { TLV_TYPE_TLV },
110 [RSL_IE_CBCH_LOAD_INFO] = { TLV_TYPE_TV },
111 [RSL_IE_SMSCB_CHAN_INDICATOR] = { TLV_TYPE_TV },
112 [RSL_IE_GROUP_CALL_REF] = { TLV_TYPE_TLV },
113 [RSL_IE_CHAN_DESC] = { TLV_TYPE_TLV },
114 [RSL_IE_NCH_DRX_INFO] = { TLV_TYPE_TLV },
115 [RSL_IE_CMD_INDICATOR] = { TLV_TYPE_TLV },
116 [RSL_IE_EMLPP_PRIO] = { TLV_TYPE_TV },
117 [RSL_IE_UIC] = { TLV_TYPE_TLV },
118 [RSL_IE_MAIN_CHAN_REF] = { TLV_TYPE_TV },
119 [RSL_IE_MR_CONFIG] = { TLV_TYPE_TLV },
120 [RSL_IE_MR_CONTROL] = { TLV_TYPE_TV },
121 [RSL_IE_SUP_CODEC_TYPES] = { TLV_TYPE_TLV },
122 [RSL_IE_CODEC_CONFIG] = { TLV_TYPE_TLV },
123 [RSL_IE_RTD] = { TLV_TYPE_TV },
124 [RSL_IE_TFO_STATUS] = { TLV_TYPE_TV },
125 [RSL_IE_LLP_APDU] = { TLV_TYPE_TLV },
126 [RSL_IE_SIEMENS_MRPCI] = { TLV_TYPE_TV },
127 [RSL_IE_IPAC_PROXY_UDP] = { TLV_TYPE_FIXED, 2 },
128 [RSL_IE_IPAC_BSCMPL_TOUT] = { TLV_TYPE_TV },
129 [RSL_IE_IPAC_REMOTE_IP] = { TLV_TYPE_FIXED, 4 },
130 [RSL_IE_IPAC_REMOTE_PORT] = { TLV_TYPE_FIXED, 2 },
131 [RSL_IE_IPAC_RTP_PAYLOAD] = { TLV_TYPE_TV },
132 [RSL_IE_IPAC_LOCAL_PORT] = { TLV_TYPE_FIXED, 2 },
133 [RSL_IE_IPAC_SPEECH_MODE] = { TLV_TYPE_TV },
134 [RSL_IE_IPAC_LOCAL_IP] = { TLV_TYPE_FIXED, 4 },
135 [RSL_IE_IPAC_CONN_ID] = { TLV_TYPE_FIXED, 2 },
136 [RSL_IE_IPAC_RTP_CSD_FMT] = { TLV_TYPE_TV },
137 [RSL_IE_IPAC_RTP_JIT_BUF] = { TLV_TYPE_FIXED, 2 },
138 [RSL_IE_IPAC_RTP_COMPR] = { TLV_TYPE_TV },
139 [RSL_IE_IPAC_RTP_PAYLOAD2] = { TLV_TYPE_TV },
140 [RSL_IE_IPAC_RTP_MPLEX] = { TLV_TYPE_FIXED, 8 },
141 [RSL_IE_IPAC_RTP_MPLEX_ID] = { TLV_TYPE_TV },
142 },
143};
144
Harald Welte96e2a002017-06-12 21:44:18 +0200145/*! \brief Encode channel number as per Section 9.3.1
146 * \param[in] Channel Type (RSL_CHAN_...)
147 * \param[in] subch Sub-Channel within Channel
148 * \param[in] timeslot Air interface timeslot
149 * \returns RSL Channel Number (TS 08.58 9.3.1) */
Harald Welted284cd92010-03-01 21:58:31 +0100150uint8_t rsl_enc_chan_nr(uint8_t type, uint8_t subch, uint8_t timeslot)
151{
152 uint8_t ret;
153
154 ret = (timeslot & 0x07) | type;
155
156 switch (type) {
157 case RSL_CHAN_Lm_ACCHs:
158 subch &= 0x01;
159 break;
160 case RSL_CHAN_SDCCH4_ACCH:
Harald Welte098cd4b2010-03-04 10:12:50 +0100161 subch &= 0x03;
Harald Welted284cd92010-03-01 21:58:31 +0100162 break;
163 case RSL_CHAN_SDCCH8_ACCH:
164 subch &= 0x07;
165 break;
166 default:
167 /* no subchannels allowed */
168 subch = 0x00;
169 break;
170 }
171 ret |= (subch << 3);
172
173 return ret;
174}
175
Harald Welte8f2c7e52011-08-17 18:52:03 +0200176/*! \brief Decode RSL channel number
177 * \param[in] chan_nr Channel Number
178 * \param[out] type Channel Type
179 * \param[out] subch Sub-channel Number
180 * \param[out] timeslot Timeslot
181 */
Harald Welteecf9dd02010-03-04 14:27:48 +0100182int rsl_dec_chan_nr(uint8_t chan_nr, uint8_t *type, uint8_t *subch, uint8_t *timeslot)
183{
184 *timeslot = chan_nr & 0x7;
185
186 if ((chan_nr & 0xf8) == RSL_CHAN_Bm_ACCHs) {
187 *type = RSL_CHAN_Bm_ACCHs;
188 *subch = 0;
189 } else if ((chan_nr & 0xf0) == RSL_CHAN_Lm_ACCHs) {
190 *type = RSL_CHAN_Lm_ACCHs;
191 *subch = (chan_nr >> 3) & 0x1;
192 } else if ((chan_nr & 0xe0) == RSL_CHAN_SDCCH4_ACCH) {
193 *type = RSL_CHAN_SDCCH4_ACCH;
194 *subch = (chan_nr >> 3) & 0x3;
195 } else if ((chan_nr & 0xc0) == RSL_CHAN_SDCCH8_ACCH) {
196 *type = RSL_CHAN_SDCCH8_ACCH;
197 *subch = (chan_nr >> 3) & 0x7;
Harald Welte6fec5142010-03-04 14:30:15 +0100198 } else if ((chan_nr & 0xf8) == RSL_CHAN_BCCH) {
Harald Welteecf9dd02010-03-04 14:27:48 +0100199 *type = RSL_CHAN_BCCH;
200 *subch = 0;
Harald Welte6fec5142010-03-04 14:30:15 +0100201 } else if ((chan_nr & 0xf8) == RSL_CHAN_RACH) {
Harald Welteecf9dd02010-03-04 14:27:48 +0100202 *type = RSL_CHAN_RACH;
203 *subch = 0;
Harald Welte6fec5142010-03-04 14:30:15 +0100204 } else if ((chan_nr & 0xf8) == RSL_CHAN_PCH_AGCH) {
Harald Welteecf9dd02010-03-04 14:27:48 +0100205 *type = RSL_CHAN_PCH_AGCH;
206 *subch = 0;
207 } else
208 return -EINVAL;
209
210 return 0;
211}
212
Harald Welte8f2c7e52011-08-17 18:52:03 +0200213/*! \brief Get human-readable string for RSL channel number */
Sylvain Munaut27af0752010-07-25 12:25:17 +0200214const char *rsl_chan_nr_str(uint8_t chan_nr)
215{
216 static char str[20];
217 int ts = chan_nr & 7;
218 uint8_t cbits = chan_nr >> 3;
219
220 if (cbits == 0x01)
221 sprintf(str, "TCH/F on TS%d", ts);
222 else if ((cbits & 0x1e) == 0x02)
223 sprintf(str, "TCH/H(%u) on TS%d", cbits & 0x01, ts);
224 else if ((cbits & 0x1c) == 0x04)
225 sprintf(str, "SDCCH/4(%u) on TS%d", cbits & 0x03, ts);
226 else if ((cbits & 0x18) == 0x08)
227 sprintf(str, "SDCCH/8(%u) on TS%d", cbits & 0x07, ts);
228 else if (cbits == 0x10)
229 sprintf(str, "BCCH on TS%d", ts);
230 else if (cbits == 0x11)
231 sprintf(str, "RACH on TS%d", ts);
232 else if (cbits == 0x12)
233 sprintf(str, "PCH/AGCH on TS%d", ts);
234 else
235 sprintf(str, "UNKNOWN on TS%d", ts);
236
237 return str;
238}
239
Harald Weltee9e190a2010-03-25 11:44:57 +0800240static const struct value_string rsl_err_vals[] = {
241 { RSL_ERR_RADIO_IF_FAIL, "Radio Interface Failure" },
242 { RSL_ERR_RADIO_LINK_FAIL, "Radio Link Failure" },
243 { RSL_ERR_HANDOVER_ACC_FAIL, "Handover Access Failure" },
244 { RSL_ERR_TALKER_ACC_FAIL, "Talker Access Failure" },
245 { RSL_ERR_OM_INTERVENTION, "O&M Intervention" },
246 { RSL_ERR_NORMAL_UNSPEC, "Normal event, unspecified" },
247 { RSL_ERR_T_MSRFPCI_EXP, "Siemens: T_MSRFPCI Expired" },
248 { RSL_ERR_EQUIPMENT_FAIL, "Equipment Failure" },
249 { RSL_ERR_RR_UNAVAIL, "Radio Resource not available" },
250 { RSL_ERR_TERR_CH_FAIL, "Terrestrial Channel Failure" },
251 { RSL_ERR_CCCH_OVERLOAD, "CCCH Overload" },
252 { RSL_ERR_ACCH_OVERLOAD, "ACCH Overload" },
253 { RSL_ERR_PROCESSOR_OVERLOAD, "Processor Overload" },
254 { RSL_ERR_RES_UNAVAIL, "Resource not available, unspecified" },
255 { RSL_ERR_TRANSC_UNAVAIL, "Transcoding not available" },
256 { RSL_ERR_SERV_OPT_UNAVAIL, "Service or Option not available" },
257 { RSL_ERR_ENCR_UNIMPL, "Encryption algorithm not implemented" },
258 { RSL_ERR_SERV_OPT_UNIMPL, "Service or Option not implemented" },
259 { RSL_ERR_RCH_ALR_ACTV_ALLOC, "Radio channel already activated" },
260 { RSL_ERR_INVALID_MESSAGE, "Invalid Message, unspecified" },
261 { RSL_ERR_MSG_DISCR, "Message Discriminator Error" },
262 { RSL_ERR_MSG_TYPE, "Message Type Error" },
263 { RSL_ERR_MSG_SEQ, "Message Sequence Error" },
264 { RSL_ERR_IE_ERROR, "General IE error" },
265 { RSL_ERR_MAND_IE_ERROR, "Mandatory IE error" },
266 { RSL_ERR_OPT_IE_ERROR, "Optional IE error" },
267 { RSL_ERR_IE_NONEXIST, "IE non-existent" },
268 { RSL_ERR_IE_LENGTH, "IE length error" },
269 { RSL_ERR_IE_CONTENT, "IE content error" },
270 { RSL_ERR_PROTO, "Protocol error, unspecified" },
271 { RSL_ERR_INTERWORKING, "Interworking error, unspecified" },
272 { 0, NULL }
Harald Welted284cd92010-03-01 21:58:31 +0100273};
274
Harald Welte8f2c7e52011-08-17 18:52:03 +0200275/*! \brief Get human-readable name for RSL Error */
Harald Welte52b4abd2010-03-25 12:11:38 +0800276const char *rsl_err_name(uint8_t err)
277{
278 return get_value_string(rsl_err_vals, err);
279}
280
Harald Weltecf7e5da2011-06-23 20:43:13 +0200281/* Names for Radio Link Layer Management */
282static const struct value_string rsl_msgt_names[] = {
283 { RSL_MT_DATA_REQ, "DATA_REQ" },
284 { RSL_MT_DATA_IND, "DATA_IND" },
285 { RSL_MT_ERROR_IND, "ERROR_IND" },
286 { RSL_MT_EST_REQ, "EST_REQ" },
287 { RSL_MT_EST_CONF, "EST_CONF" },
288 { RSL_MT_EST_IND, "EST_IND" },
289 { RSL_MT_REL_REQ, "REL_REQ" },
290 { RSL_MT_REL_CONF, "REL_CONF" },
291 { RSL_MT_REL_IND, "REL_IND" },
292 { RSL_MT_UNIT_DATA_REQ, "UNIT_DATA_REQ" },
293 { RSL_MT_UNIT_DATA_IND, "UNIT_DATA_IND" },
294 { RSL_MT_SUSP_REQ, "SUSP_REQ" },
295 { RSL_MT_SUSP_CONF, "SUSP_CONF" },
296 { RSL_MT_RES_REQ, "RES_REQ" },
297 { RSL_MT_RECON_REQ, "RECON_REQ" },
298
299 { RSL_MT_BCCH_INFO, "BCCH_INFO" },
300 { RSL_MT_CCCH_LOAD_IND, "CCCH_LOAD_IND" },
301 { RSL_MT_CHAN_RQD, "CHAN_RQD" },
302 { RSL_MT_DELETE_IND, "DELETE_IND" },
303 { RSL_MT_PAGING_CMD, "PAGING_CMD" },
304 { RSL_MT_IMMEDIATE_ASSIGN_CMD, "IMM_ASS_CMD" },
305 { RSL_MT_SMS_BC_REQ, "SMS_BC_REQ" },
306 { RSL_MT_CHAN_CONF, "CHAN_CONF" },
307
308 { RSL_MT_RF_RES_IND, "RF_RES_IND" },
309 { RSL_MT_SACCH_FILL, "SACCH_FILL" },
310 { RSL_MT_OVERLOAD, "OVERLOAD" },
311 { RSL_MT_ERROR_REPORT, "ERROR_REPORT" },
312 { RSL_MT_SMS_BC_CMD, "SMS_BC_CMD" },
313 { RSL_MT_CBCH_LOAD_IND, "CBCH_LOAD_IND" },
314 { RSL_MT_NOT_CMD, "NOTIFY_CMD" },
315
316 { RSL_MT_CHAN_ACTIV, "CHAN_ACTIV" },
317 { RSL_MT_CHAN_ACTIV_ACK, "CHAN_ACTIV_ACK" },
318 { RSL_MT_CHAN_ACTIV_NACK, "CHAN_ACTIV_NACK" },
319 { RSL_MT_CONN_FAIL, "CONN_FAIL" },
320 { RSL_MT_DEACTIVATE_SACCH, "DEACTIVATE_SACCH" },
321 { RSL_MT_ENCR_CMD, "ENCR_CMD" },
322 { RSL_MT_HANDO_DET, "HANDOVER_DETECT" },
323 { RSL_MT_MEAS_RES, "MEAS_RES" },
324 { RSL_MT_MODE_MODIFY_REQ, "MODE_MODIFY_REQ" },
325 { RSL_MT_MODE_MODIFY_ACK, "MODE_MODIFY_ACK" },
326 { RSL_MT_MODE_MODIFY_NACK, "MODE_MODIFY_NACK" },
327 { RSL_MT_PHY_CONTEXT_REQ, "PHY_CONTEXT_REQ" },
328 { RSL_MT_PHY_CONTEXT_CONF, "PHY_CONTEXT_CONF" },
329 { RSL_MT_RF_CHAN_REL, "RF_CHAN_REL" },
330 { RSL_MT_MS_POWER_CONTROL, "MS_POWER_CONTROL" },
331 { RSL_MT_BS_POWER_CONTROL, "BS_POWER_CONTROL" },
332 { RSL_MT_PREPROC_CONFIG, "PREPROC_CONFIG" },
333 { RSL_MT_PREPROC_MEAS_RES, "PREPROC_MEAS_RES" },
334 { RSL_MT_RF_CHAN_REL_ACK, "RF_CHAN_REL_ACK" },
335 { RSL_MT_SACCH_INFO_MODIFY, "SACCH_INFO_MODIFY" },
336 { RSL_MT_TALKER_DET, "TALKER_DETECT" },
337 { RSL_MT_LISTENER_DET, "LISTENER_DETECT" },
338 { RSL_MT_REMOTE_CODEC_CONF_REP, "REM_CODEC_CONF_REP" },
339 { RSL_MT_RTD_REP, "RTD_REQ" },
340 { RSL_MT_PRE_HANDO_NOTIF, "HANDO_NOTIF" },
341 { RSL_MT_MR_CODEC_MOD_REQ, "CODEC_MOD_REQ" },
342 { RSL_MT_MR_CODEC_MOD_ACK, "CODEC_MOD_ACK" },
343 { RSL_MT_MR_CODEC_MOD_NACK, "CODEC_MOD_NACK" },
344 { RSL_MT_MR_CODEC_MOD_PER, "CODEC_MODE_PER" },
345 { RSL_MT_TFO_REP, "TFO_REP" },
346 { RSL_MT_TFO_MOD_REQ, "TFO_MOD_REQ" },
347 { RSL_MT_LOCATION_INFO, "LOCATION_INFO" },
348 { 0, NULL }
349};
350
351
Harald Welte8f2c7e52011-08-17 18:52:03 +0200352/*! \brief Get human-readable string for RSL Message Type */
Harald Weltecf7e5da2011-06-23 20:43:13 +0200353const char *rsl_msg_name(uint8_t msg_type)
354{
355 return get_value_string(rsl_msgt_names, msg_type);
356}
357
Harald Weltea24026a2011-09-02 12:26:50 +0200358/*! \brief ip.access specific */
359static const struct value_string rsl_ipac_msgt_names[] = {
360 { RSL_MT_IPAC_PDCH_ACT, "IPAC_PDCH_ACT" },
361 { RSL_MT_IPAC_PDCH_ACT_ACK, "IPAC_PDCH_ACT_ACK" },
362 { RSL_MT_IPAC_PDCH_ACT_NACK, "IPAC_PDCH_ACT_NACK" },
363 { RSL_MT_IPAC_PDCH_DEACT, "IPAC_PDCH_DEACT" },
364 { RSL_MT_IPAC_PDCH_DEACT_ACK, "IPAC_PDCH_DEACT_ACK" },
365 { RSL_MT_IPAC_PDCH_DEACT_NACK, "IPAC_PDCH_DEACT_NACK" },
366 { RSL_MT_IPAC_CONNECT_MUX, "IPAC_CONNECT_MUX" },
367 { RSL_MT_IPAC_CONNECT_MUX_ACK, "IPAC_CONNECT_MUX_ACK" },
368 { RSL_MT_IPAC_CONNECT_MUX_NACK, "IPAC_CONNECT_MUX_NACK" },
369 { RSL_MT_IPAC_BIND_MUX, "IPAC_BIND_MUX" },
370 { RSL_MT_IPAC_BIND_MUX_ACK, "IPAC_BIND_MUX_ACK" },
371 { RSL_MT_IPAC_BIND_MUX_NACK, "IPAC_BIND_MUX_NACK" },
372 { RSL_MT_IPAC_DISC_MUX, "IPAC_DISC_MUX" },
373 { RSL_MT_IPAC_DISC_MUX_ACK, "IPAC_DISC_MUX_ACK" },
374 { RSL_MT_IPAC_DISC_MUX_NACK, "IPAC_DISC_MUX_NACK" },
375 { RSL_MT_IPAC_CRCX, "IPAC_CRCX" },
376 { RSL_MT_IPAC_CRCX_ACK, "IPAC_CRCX_ACK" },
377 { RSL_MT_IPAC_CRCX_NACK, "IPAC_CRCX_NACK" },
378 { RSL_MT_IPAC_MDCX, "IPAC_MDCX" },
379 { RSL_MT_IPAC_MDCX_ACK, "IPAC_MDCX_ACK" },
380 { RSL_MT_IPAC_MDCX_NACK, "IPAC_MDCX_NACK" },
381 { RSL_MT_IPAC_DLCX_IND, "IPAC_DLCX_IND" },
382 { RSL_MT_IPAC_DLCX, "IPAC_DLCX" },
383 { RSL_MT_IPAC_DLCX_ACK, "IPAC_DLCX_ACK" },
384 { RSL_MT_IPAC_DLCX_NACK, "IPAC_DLCX_NACK" },
385 { 0, NULL }
386};
387
388/*! \brief Get human-readable name of ip.access RSL msg type */
389const char *rsl_ipac_msg_name(uint8_t msg_type)
390{
391 return get_value_string(rsl_ipac_msgt_names, msg_type);
392}
393
Neels Hofmeyr0167e3f2016-06-06 18:10:38 +0200394/*! \brief Get human-readable name of standard or ip.access RSL msg type.
395 * If msg_type is a standard RSL message type, return its human-readable name.
396 * Otherwise return rsl_ipac_msg_name(msg_type). */
397const char *rsl_or_ipac_msg_name(uint8_t msg_type)
398{
399 const char *str = get_value_string_or_null(rsl_msgt_names, msg_type);
400 if (str)
401 return str;
402 return rsl_ipac_msg_name(msg_type);
403}
404
Harald Welte52b4abd2010-03-25 12:11:38 +0800405static const struct value_string rsl_rlm_cause_strs[] = {
Harald Welted284cd92010-03-01 21:58:31 +0100406 { RLL_CAUSE_T200_EXPIRED, "Timer T200 expired (N200+1) times" },
407 { RLL_CAUSE_REEST_REQ, "Re-establishment request" },
408 { RLL_CAUSE_UNSOL_UA_RESP, "Unsolicited UA response" },
409 { RLL_CAUSE_UNSOL_DM_RESP, "Unsolicited DM response" },
410 { RLL_CAUSE_UNSOL_DM_RESP_MF, "Unsolicited DM response, multiple frame" },
411 { RLL_CAUSE_UNSOL_SPRV_RESP, "Unsolicited supervisory response" },
412 { RLL_CAUSE_SEQ_ERR, "Sequence Error" },
413 { RLL_CAUSE_UFRM_INC_PARAM, "U-Frame with incorrect parameters" },
414 { RLL_CAUSE_SFRM_INC_PARAM, "S-Frame with incorrect parameters" },
415 { RLL_CAUSE_IFRM_INC_MBITS, "I-Frame with incorrect use of M bit" },
416 { RLL_CAUSE_IFRM_INC_LEN, "I-Frame with incorrect length" },
Holger Hans Peter Freyther9ac45372013-06-11 17:54:56 +0200417 { RLL_CAUSE_FRM_UNIMPL, "Frame not implemented" },
Harald Welted284cd92010-03-01 21:58:31 +0100418 { RLL_CAUSE_SABM_MF, "SABM command, multiple frame established state" },
419 { RLL_CAUSE_SABM_INFO_NOTALL, "SABM frame with information not allowed in this state" },
420 { 0, NULL },
421};
422
Harald Welte8f2c7e52011-08-17 18:52:03 +0200423/*! \brief Get human-readable string for RLM cause */
Harald Welte52b4abd2010-03-25 12:11:38 +0800424const char *rsl_rlm_cause_name(uint8_t err)
Harald Welted284cd92010-03-01 21:58:31 +0100425{
Harald Welte52b4abd2010-03-25 12:11:38 +0800426 return get_value_string(rsl_rlm_cause_strs, err);
Harald Welted284cd92010-03-01 21:58:31 +0100427}
428
429/* Section 3.3.2.3 TS 05.02. I think this looks like a table */
430int rsl_ccch_conf_to_bs_cc_chans(int ccch_conf)
431{
432 switch (ccch_conf) {
433 case RSL_BCCH_CCCH_CONF_1_NC:
434 return 1;
435 case RSL_BCCH_CCCH_CONF_1_C:
436 return 1;
437 case RSL_BCCH_CCCH_CONF_2_NC:
438 return 2;
439 case RSL_BCCH_CCCH_CONF_3_NC:
440 return 3;
441 case RSL_BCCH_CCCH_CONF_4_NC:
442 return 4;
443 default:
444 return -1;
445 }
446}
447
448/* Section 3.3.2.3 TS 05.02 */
449int rsl_ccch_conf_to_bs_ccch_sdcch_comb(int ccch_conf)
450{
451 switch (ccch_conf) {
452 case RSL_BCCH_CCCH_CONF_1_NC:
453 return 0;
454 case RSL_BCCH_CCCH_CONF_1_C:
455 return 1;
456 case RSL_BCCH_CCCH_CONF_2_NC:
457 return 0;
458 case RSL_BCCH_CCCH_CONF_3_NC:
459 return 0;
460 case RSL_BCCH_CCCH_CONF_4_NC:
461 return 0;
462 default:
463 return -1;
464 }
465}
Harald Weltef08eabf2010-03-02 21:59:20 +0100466
Harald Welte96e2a002017-06-12 21:44:18 +0200467/*! \brief Push a RSL RLL header onto an existing msgb
468 * \param msg Message Buffer to which RLL header shall be pushed
469 * \param[in] msg_type RSL Message Type
470 * \param[in] chan_nr RSL Channel Number
471 * \param[in] link_id RSL Link Identifier
472 * \param[in] transparent Transparent to BTS (1) or not (0) */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200473void rsl_rll_push_hdr(struct msgb *msg, uint8_t msg_type, uint8_t chan_nr,
474 uint8_t link_id, int transparent)
Harald Weltef08eabf2010-03-02 21:59:20 +0100475{
Harald Weltef08eabf2010-03-02 21:59:20 +0100476 struct abis_rsl_rll_hdr *rh;
477
Harald Weltef08eabf2010-03-02 21:59:20 +0100478 rh = (struct abis_rsl_rll_hdr *) msgb_push(msg, sizeof(*rh));
479 rsl_init_rll_hdr(rh, msg_type);
Harald Welteeb8bf392010-03-04 10:32:09 +0100480 if (transparent)
481 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
Harald Weltef08eabf2010-03-02 21:59:20 +0100482 rh->chan_nr = chan_nr;
483 rh->link_id = link_id;
484
485 /* set the l2 header pointer */
486 msg->l2h = (uint8_t *)rh;
Harald Weltef08eabf2010-03-02 21:59:20 +0100487}
488
Harald Welte96e2a002017-06-12 21:44:18 +0200489/*! \brief Wrap msgb in L3 Info IE and push a RSL RLL header
490 * \param[in] msg Message Buffer to which L3 Header shall be appended
491 * \param[in] msg_type RSL Message Type
492 * \param[in] chan_hr RSL Channel Number
493 * \param[in] link_id Link Identififer
494 * \param[in] transparent Transparent to BTS (1) or not (0) */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200495void rsl_rll_push_l3(struct msgb *msg, uint8_t msg_type, uint8_t chan_nr,
496 uint8_t link_id, int transparent)
497{
498 uint8_t l3_len = msg->tail - (uint8_t *)msgb_l3(msg);
499
500 /* construct a RSLms RLL message (DATA INDICATION, UNIT DATA
501 * INDICATION) and send it off via RSLms */
502
503 /* Push the L3 IE tag and lengh */
504 msgb_tv16_push(msg, RSL_IE_L3_INFO, l3_len);
505
506 /* Then push the RSL header */
507 rsl_rll_push_hdr(msg, msg_type, chan_nr, link_id, transparent);
508}
509
Harald Welte96e2a002017-06-12 21:44:18 +0200510/*! \brief Create msgb with RSL RLL header
511 * \param[in] msg_type RSL Message Type
512 * \param[in] chan_nr RSL Channel Number
513 * \param[in] link_id RSL Link Identifier
514 * \param[in] transparent Transparent to BTS (1) or not (0)
515 * \returns callee-allocated msgb; NULL on error */
Harald Weltef08eabf2010-03-02 21:59:20 +0100516struct msgb *rsl_rll_simple(uint8_t msg_type, uint8_t chan_nr,
Harald Welteeb8bf392010-03-04 10:32:09 +0100517 uint8_t link_id, int transparent)
Harald Weltef08eabf2010-03-02 21:59:20 +0100518{
519 struct abis_rsl_rll_hdr *rh;
Harald Welteeb8bf392010-03-04 10:32:09 +0100520 struct msgb *msg;
521
522 msg = msgb_alloc_headroom(RSL_ALLOC_SIZE+RSL_ALLOC_HEADROOM,
523 RSL_ALLOC_HEADROOM, "rsl_rll_simple");
Harald Weltef08eabf2010-03-02 21:59:20 +0100524
525 if (!msg)
526 return NULL;
527
528 /* put the RSL header */
529 rh = (struct abis_rsl_rll_hdr *) msgb_put(msg, sizeof(*rh));
530 rsl_init_rll_hdr(rh, msg_type);
Harald Welteeb8bf392010-03-04 10:32:09 +0100531 if (transparent)
532 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
Harald Weltef08eabf2010-03-02 21:59:20 +0100533 rh->chan_nr = chan_nr;
534 rh->link_id = link_id;
535
536 /* set the l2 header pointer */
537 msg->l2h = (uint8_t *)rh;
538
539 return msg;
540}
Harald Welte8f2c7e52011-08-17 18:52:03 +0200541
Harald Welte96e2a002017-06-12 21:44:18 +0200542/*! \brief TLV parser definitions for IPA embedded IEs */
Harald Weltefad57522015-12-13 11:56:36 +0100543const struct tlv_definition rsl_ipac_eie_tlvdef = {
544 .def = {
545 [RSL_IPAC_EIE_RXLEV] = { TLV_TYPE_TV },
546 [RSL_IPAC_EIE_RXQUAL] = { TLV_TYPE_TV },
547 [RSL_IPAC_EIE_FREQ_ERR] = { TLV_TYPE_FIXED, 2 },
548 [RSL_IPAC_EIE_TIMING_ERR] = { TLV_TYPE_TV },
549 [RSL_IPAC_EIE_MEAS_AVG_CFG] = { TLV_TYPE_TLV },
550 [RSL_IPAC_EIE_BS_PWR_CTL] = { TLV_TYPE_FIXED, 3 },
551 [RSL_IPAC_EIE_MS_PWR_CTL] = { TLV_TYPE_FIXED, 3 },
552 [RSL_IPAC_EIE_HANDO_THRESH] = { TLV_TYPE_FIXED, 6 },
553 [RSL_IPAC_EIE_NCELL_DEFAULTS] = { TLV_TYPE_FIXED, 3 },
554 [RSL_IPAC_EIE_NCELL_LIST] = { TLV_TYPE_TLV },
555 [RSL_IPAC_EIE_PC_THRESH_COMP] = { TLV_TYPE_FIXED, 10 },
556 [RSL_IPAC_EIE_HO_THRESH_COMP] = { TLV_TYPE_FIXED, 10 },
557 [RSL_IPAC_EIE_HO_CAUSE] = { TLV_TYPE_TLV },
558 [RSL_IPAC_EIE_HO_CANDIDATES] = { TLV_TYPE_TLV },
559 [RSL_IPAC_EIE_NCELL_BA_CHG_LIST]= { TLV_TYPE_TLV },
560 [RSL_IPAC_EIE_NUM_OF_MS] = { TLV_TYPE_TV },
561 [RSL_IPAC_EIE_HO_CAND_EXT] = { TLV_TYPE_TLV },
562 [RSL_IPAC_EIE_NCELL_DEF_EXT] = { TLV_TYPE_TLV },
563 [RSL_IPAC_EIE_NCELL_LIST_EXT] = { TLV_TYPE_TLV },
564 [RSL_IPAC_EIE_MASTER_KEY] = { TLV_TYPE_TLV },
565 [RSL_IPAC_EIE_MASTER_SALT] = { TLV_TYPE_TLV },
566 },
567};
568
Harald Welte96e2a002017-06-12 21:44:18 +0200569/*! \brief String names of RSL Channel Activation Types */
Neels Hofmeyr47390762016-07-18 23:54:01 +0200570const struct value_string rsl_act_type_names[] = {
571 { RSL_ACT_TYPE_INITIAL, "INITIAL" },
572 { RSL_ACT_TYPE_REACT, "REACT" },
573 { RSL_ACT_INTRA_IMM_ASS, "INTRA_IMM_ASS" },
574 { RSL_ACT_INTRA_NORM_ASS, "INTRA_NORM_ASS" },
575 { RSL_ACT_INTER_ASYNC, "INTER_ASYNC" },
576 { RSL_ACT_INTER_SYNC, "INTER_SYNC" },
577 { RSL_ACT_SECOND_ADD, "SECOND_ADD" },
578 { RSL_ACT_SECOND_MULTI, "SECOND_MULTI" },
579 { RSL_ACT_OSMO_PDCH, "OSMO_PDCH" },
580 { 0, NULL }
581};
582
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200583/*! @} */