blob: b46f9f531776f2acf8d882b0657e89342a231147 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gsm_08_58.h
2 * GSM Radio Signalling Link messages on the A-bis interface.
Harald Welteec8b4502010-02-20 20:34:29 +01003 * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02004/*
5 * (C) 2008 by Harald Welte <laforge@gnumonks.org>
Harald Welteec8b4502010-02-20 20:34:29 +01006 * 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
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020024#pragma once
25
Harald Welteec8b4502010-02-20 20:34:29 +010026#include <stdint.h>
27
Pau Espin Pedrol42908032018-10-10 17:04:28 +020028#include <osmocom/core/endian.h>
29
Harald Welte8f2c7e52011-08-17 18:52:03 +020030/*! \addtogroup rsl
31 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020032 * \file gsm_08_58.h */
Harald Welte8f2c7e52011-08-17 18:52:03 +020033
Pau Espin Pedrolfb97e722018-10-10 20:41:40 +020034/* Channel Number 9.3.1 */
35union abis_rsl_chan_nr {
36#if OSMO_IS_BIG_ENDIAN
37 uint8_t cbits:5,
38 tn:3;
39#elif OSMO_IS_LITTLE_ENDIAN
40 uint8_t tn:3,
41 cbits:5;
42#endif
43 uint8_t chan_nr;
44} __attribute__ ((packed));
45#define ABIS_RSL_CHAN_NR_CBITS_Bm_ACCHs 0x01
46#define ABIS_RSL_CHAN_NR_CBITS_Lm_ACCHs(ss) (0x02 + (ss))
47#define ABIS_RSL_CHAN_NR_CBITS_SDCCH4_ACCH(ss) (0x04 + (ss))
48#define ABIS_RSL_CHAN_NR_CBITS_SDCCH8_ACCH(ss) (0x08 + (ss))
49#define ABIS_RSL_CHAN_NR_CBITS_BCCH 0x10
50#define ABIS_RSL_CHAN_NR_CBITS_RACH 0x11
51#define ABIS_RSL_CHAN_NR_CBITS_PCH_AGCH 0x12
52#define ABIS_RSL_CHAN_NR_CBITS_OSMO_PDCH 0x18 /*< non-standard, for dyn TS */
Harald Weltea8d7ebb2019-05-27 16:51:23 +020053#define ABIS_RSL_CHAN_NR_CBITS_OSMO_CBCH4 0x19 /*< non-standard, for CBCH/SDCCH4 */
54#define ABIS_RSL_CHAN_NR_CBITS_OSMO_CBCH8 0x1a /*< non-standard, for CBCH/SDCCH8 */
Pau Espin Pedrolfb97e722018-10-10 20:41:40 +020055
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +020056/* non-standard, Osmocom specific Bm/Lm equivalents for VAMOS */
57#define ABIS_RSL_CHAN_NR_CBITS_OSMO_VAMOS_Bm_ACCHs 0x1d /*< VAMOS TCH/F */
58#define ABIS_RSL_CHAN_NR_CBITS_OSMO_VAMOS_Lm_ACCHs(ss) (0x1e + (ss)) /*< VAMOS TCH/H */
59
Pau Espin Pedrol42908032018-10-10 17:04:28 +020060/* Link Identifier 9.3.2 */
61union abis_rsl_link_id {
62#if OSMO_IS_BIG_ENDIAN
63 uint8_t cbits:2,
64 na:1,
Martin Haukee63b8872018-11-15 14:53:13 +010065 reserved:2,
Pau Espin Pedrol42908032018-10-10 17:04:28 +020066 sapi:3;
67#elif OSMO_IS_LITTLE_ENDIAN
68 uint8_t sapi:3,
69 reserved:2,
70 na:1,
71 cbits:2;
72#endif
73 uint8_t link_id;
74} __attribute__ ((packed));
75#define ABIS_RSL_LINK_ID_CBITS_FACCH_SDCCH 0x00
76#define ABIS_RSL_LINK_ID_CBITS_SACCH 0x01
77
Neels Hofmeyr87e45502017-06-20 00:17:59 +020078/*! RSL common header */
Harald Welteec8b4502010-02-20 20:34:29 +010079struct abis_rsl_common_hdr {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020080 uint8_t msg_discr; /*!< message discriminator (ABIS_RSL_MDISC_*) */
81 uint8_t msg_type; /*!< message type (\ref abis_rsl_msgtype) */
82 uint8_t data[0]; /*!< actual payload data */
Harald Welteec8b4502010-02-20 20:34:29 +010083} __attribute__ ((packed));
84
Neels Hofmeyr87e45502017-06-20 00:17:59 +020085/* RSL RLL header (Chapter 8.3) */
Harald Welteec8b4502010-02-20 20:34:29 +010086struct abis_rsl_rll_hdr {
87 struct abis_rsl_common_hdr c;
Neels Hofmeyr87e45502017-06-20 00:17:59 +020088 uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
Pau Espin Pedrolfb97e722018-10-10 20:41:40 +020089 union {
90 uint8_t chan_nr; /* API backward compat */
91 union abis_rsl_chan_nr chan_nr_fields; /*!< RSL channel number (value) */
92 };
Neels Hofmeyr87e45502017-06-20 00:17:59 +020093 uint8_t ie_link_id; /*!< \ref RSL_IE_LINK_IDENT (tag) */
Pau Espin Pedrol42908032018-10-10 17:04:28 +020094 union {
95 uint8_t link_id; /* API backward compat */
96 union abis_rsl_link_id link_id_fields; /*!< RSL link identifier (value) */
97 };
Neels Hofmeyr87e45502017-06-20 00:17:59 +020098 uint8_t data[0]; /*!< message payload data */
Harald Welteec8b4502010-02-20 20:34:29 +010099} __attribute__ ((packed));
100
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200101/* RSL Dedicated Channel header (Chapter 8.3 and 8.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100102struct abis_rsl_dchan_hdr {
103 struct abis_rsl_common_hdr c;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200104 uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
Pau Espin Pedrolfb97e722018-10-10 20:41:40 +0200105 union {
106 uint8_t chan_nr; /* API backward compat */
107 union abis_rsl_chan_nr chan_nr_fields; /*!< RSL channel number (value) */
108 };
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200109 uint8_t data[0]; /*!< message payload data */
Harald Welteec8b4502010-02-20 20:34:29 +0100110} __attribute__ ((packed));
111
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200112/* RSL Common Channel header (Chapter 8.5) */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200113struct abis_rsl_cchan_hdr {
114 struct abis_rsl_common_hdr c;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200115 uint8_t ie_chan; /*!< \ref RSL_IE_CHAN_NR (tag) */
Pau Espin Pedrolfb97e722018-10-10 20:41:40 +0200116 union {
117 uint8_t chan_nr; /* API backward compat */
118 union abis_rsl_chan_nr chan_nr_fields; /*!< RSL channel number (value) */
119 };
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200120 uint8_t data[0]; /*!< message payload data */
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200121} __attribute__ ((packed));
122
Philipp Maier439ddbe2020-11-16 17:49:34 +0100123/* Osmocom specific IE to negotiate repeated ACCH capabilities */
124struct abis_rsl_osmo_rep_acch_cap {
125#if OSMO_IS_BIG_ENDIAN
Philipp Maier55ce87d2021-08-31 09:24:37 +0200126 uint8_t reserved:1,
127 rxqual:3,
128 ul_sacch:1,
129 dl_sacch:1,
130 dl_facch_all:1,
131 dl_facch_cmd:1;
Philipp Maier439ddbe2020-11-16 17:49:34 +0100132#elif OSMO_IS_LITTLE_ENDIAN
Philipp Maier55ce87d2021-08-31 09:24:37 +0200133 uint8_t dl_facch_cmd:1,
134 dl_facch_all:1,
135 dl_sacch:1,
136 ul_sacch:1,
137 rxqual:3,
138 reserved:1;
Philipp Maier439ddbe2020-11-16 17:49:34 +0100139#endif
140} __attribute__ ((packed));
Harald Welteec8b4502010-02-20 20:34:29 +0100141
Philipp Maier0e44a722021-08-30 10:51:52 +0200142/* Osmocom specific IE to negotiate temporary overpower of ACCH channels */
143struct abis_rsl_osmo_temp_ovp_acch_cap {
Vadim Yanitskiy8db64ee2021-10-20 14:36:18 +0300144#if OSMO_IS_BIG_ENDIAN
145 uint8_t sacch_enable:1,
146 facch_enable:1,
147 rxqual:3,
148 overpower_db:3;
149#elif OSMO_IS_LITTLE_ENDIAN
150 uint8_t overpower_db:3,
151 rxqual:3,
152 facch_enable:1,
153 sacch_enable:1;
154#endif
Philipp Maier0e44a722021-08-30 10:51:52 +0200155} __attribute__ ((packed));
156
Harald Welteec8b4502010-02-20 20:34:29 +0100157/* Chapter 9.1 */
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200158/* RSL Message Discriminator: RLL */
Harald Welteec8b4502010-02-20 20:34:29 +0100159#define ABIS_RSL_MDISC_RLL 0x02
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200160/* RSL Message Discriminator: Dedicated Channel */
Harald Welteec8b4502010-02-20 20:34:29 +0100161#define ABIS_RSL_MDISC_DED_CHAN 0x08
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200162/* RSL Message Discriminator: Common Channel */
Harald Welteec8b4502010-02-20 20:34:29 +0100163#define ABIS_RSL_MDISC_COM_CHAN 0x0c
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200164/* RSL Message Discriminator: TRX Management */
Harald Welteec8b4502010-02-20 20:34:29 +0100165#define ABIS_RSL_MDISC_TRX 0x10
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200166/* RSL Message Discriminator: Location Service */
Harald Welteec8b4502010-02-20 20:34:29 +0100167#define ABIS_RSL_MDISC_LOC 0x20
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200168/* RSL Message Discriminator: ip.access */
Harald Welteec8b4502010-02-20 20:34:29 +0100169#define ABIS_RSL_MDISC_IPACCESS 0x7e
170#define ABIS_RSL_MDISC_TRANSP 0x01
171
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200172/* Check if given RSL message discriminator is transparent */
Harald Welteec8b4502010-02-20 20:34:29 +0100173#define ABIS_RSL_MDISC_IS_TRANSP(x) (x & 0x01)
174
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200175/* RSL Message Type (Chapter 9.1) */
Harald Welteec8b4502010-02-20 20:34:29 +0100176enum abis_rsl_msgtype {
177 /* Radio Link Layer Management */
178 RSL_MT_DATA_REQ = 0x01,
179 RSL_MT_DATA_IND,
180 RSL_MT_ERROR_IND,
181 RSL_MT_EST_REQ,
182 RSL_MT_EST_CONF,
183 RSL_MT_EST_IND,
184 RSL_MT_REL_REQ,
185 RSL_MT_REL_CONF,
186 RSL_MT_REL_IND,
187 RSL_MT_UNIT_DATA_REQ,
188 RSL_MT_UNIT_DATA_IND, /* 0x0b */
Andreas Eversberg816e24c2010-06-25 02:50:56 +0200189 RSL_MT_SUSP_REQ, /* non-standard elements */
190 RSL_MT_SUSP_CONF,
191 RSL_MT_RES_REQ,
192 RSL_MT_RECON_REQ, /* 0x0f */
Harald Welteec8b4502010-02-20 20:34:29 +0100193
194 /* Common Channel Management / TRX Management */
195 RSL_MT_BCCH_INFO = 0x11,
196 RSL_MT_CCCH_LOAD_IND,
197 RSL_MT_CHAN_RQD,
198 RSL_MT_DELETE_IND,
199 RSL_MT_PAGING_CMD,
200 RSL_MT_IMMEDIATE_ASSIGN_CMD,
201 RSL_MT_SMS_BC_REQ,
Harald Welte6eb7d6c2010-07-13 13:48:13 +0200202 RSL_MT_CHAN_CONF, /* non-standard element */
Harald Welteec8b4502010-02-20 20:34:29 +0100203 /* empty */
204 RSL_MT_RF_RES_IND = 0x19,
205 RSL_MT_SACCH_FILL,
206 RSL_MT_OVERLOAD,
207 RSL_MT_ERROR_REPORT,
208 RSL_MT_SMS_BC_CMD,
209 RSL_MT_CBCH_LOAD_IND,
210 RSL_MT_NOT_CMD, /* 0x1f */
211
212 /* Dedicate Channel Management */
213 RSL_MT_CHAN_ACTIV = 0x21,
214 RSL_MT_CHAN_ACTIV_ACK,
215 RSL_MT_CHAN_ACTIV_NACK,
216 RSL_MT_CONN_FAIL,
217 RSL_MT_DEACTIVATE_SACCH,
218 RSL_MT_ENCR_CMD,
219 RSL_MT_HANDO_DET,
220 RSL_MT_MEAS_RES,
221 RSL_MT_MODE_MODIFY_REQ,
222 RSL_MT_MODE_MODIFY_ACK,
223 RSL_MT_MODE_MODIFY_NACK,
224 RSL_MT_PHY_CONTEXT_REQ,
225 RSL_MT_PHY_CONTEXT_CONF,
226 RSL_MT_RF_CHAN_REL,
227 RSL_MT_MS_POWER_CONTROL,
228 RSL_MT_BS_POWER_CONTROL, /* 0x30 */
229 RSL_MT_PREPROC_CONFIG,
230 RSL_MT_PREPROC_MEAS_RES,
231 RSL_MT_RF_CHAN_REL_ACK,
232 RSL_MT_SACCH_INFO_MODIFY,
233 RSL_MT_TALKER_DET,
234 RSL_MT_LISTENER_DET,
235 RSL_MT_REMOTE_CODEC_CONF_REP,
236 RSL_MT_RTD_REP,
237 RSL_MT_PRE_HANDO_NOTIF,
238 RSL_MT_MR_CODEC_MOD_REQ,
239 RSL_MT_MR_CODEC_MOD_ACK,
240 RSL_MT_MR_CODEC_MOD_NACK,
241 RSL_MT_MR_CODEC_MOD_PER,
242 RSL_MT_TFO_REP,
243 RSL_MT_TFO_MOD_REQ, /* 0x3f */
244 RSL_MT_LOCATION_INFO = 0x41,
245
246 /* ip.access specific RSL message types */
247 RSL_MT_IPAC_DIR_RETR_ENQ = 0x40,
248 RSL_MT_IPAC_PDCH_ACT = 0x48,
249 RSL_MT_IPAC_PDCH_ACT_ACK,
250 RSL_MT_IPAC_PDCH_ACT_NACK,
251 RSL_MT_IPAC_PDCH_DEACT = 0x4b,
252 RSL_MT_IPAC_PDCH_DEACT_ACK,
253 RSL_MT_IPAC_PDCH_DEACT_NACK,
254 RSL_MT_IPAC_CONNECT_MUX = 0x50,
255 RSL_MT_IPAC_CONNECT_MUX_ACK,
256 RSL_MT_IPAC_CONNECT_MUX_NACK,
257 RSL_MT_IPAC_BIND_MUX = 0x53,
258 RSL_MT_IPAC_BIND_MUX_ACK,
259 RSL_MT_IPAC_BIND_MUX_NACK,
260 RSL_MT_IPAC_DISC_MUX = 0x56,
261 RSL_MT_IPAC_DISC_MUX_ACK,
262 RSL_MT_IPAC_DISC_MUX_NACK,
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400263 RSL_MT_IPAC_MEAS_PREPROC_DFT = 0x60, /*Extented Common Channel Management */
264 RSL_MT_IPAC_HO_CAN_ENQ = 0x61,
265 RSL_MT_IPAC_HO_CAN_RES = 0x62,
Harald Welteec8b4502010-02-20 20:34:29 +0100266 RSL_MT_IPAC_CRCX = 0x70, /* Bind to local BTS RTP port */
267 RSL_MT_IPAC_CRCX_ACK,
268 RSL_MT_IPAC_CRCX_NACK,
269 RSL_MT_IPAC_MDCX = 0x73,
270 RSL_MT_IPAC_MDCX_ACK,
271 RSL_MT_IPAC_MDCX_NACK,
272 RSL_MT_IPAC_DLCX_IND = 0x76,
273 RSL_MT_IPAC_DLCX = 0x77,
274 RSL_MT_IPAC_DLCX_ACK,
275 RSL_MT_IPAC_DLCX_NACK,
Harald Weltef9456892019-09-03 13:56:00 +0200276
277 RSL_MT_OSMO_ETWS_CMD = 0x7f,
Harald Welteec8b4502010-02-20 20:34:29 +0100278};
279
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200280/*! Siemens vendor-specific RSL message types */
Harald Welteec8b4502010-02-20 20:34:29 +0100281enum abis_rsl_msgtype_siemens {
282 RSL_MT_SIEMENS_MRPCI = 0x41,
283 RSL_MT_SIEMENS_INTRAC_HO_COND_IND = 0x42,
284 RSL_MT_SIEMENS_INTERC_HO_COND_IND = 0x43,
285 RSL_MT_SIEMENS_FORCED_HO_REQ = 0x44,
286 RSL_MT_SIEMENS_PREF_AREA_REQ = 0x45,
287 RSL_MT_SIEMENS_PREF_AREA = 0x46,
288 RSL_MT_SIEMENS_START_TRACE = 0x47,
289 RSL_MT_SIEMENS_START_TRACE_ACK = 0x48,
290 RSL_MT_SIEMENS_STOP_TRACE = 0x49,
291 RSL_MT_SIEMENS_TRMR = 0x4a,
292 RSL_MT_SIEMENS_HO_FAIL_IND = 0x4b,
293 RSL_MT_SIEMENS_STOP_TRACE_ACK = 0x4c,
294 RSL_MT_SIEMENS_UPLF = 0x4d,
295 RSL_MT_SIEMENS_UPLB = 0x4e,
296 RSL_MT_SIEMENS_SET_SYS_INFO_10 = 0x4f,
297 RSL_MT_SIEMENS_MODIF_COND_IND = 0x50,
298};
299
Pau Espin Pedrol95959a82018-04-21 22:47:54 +0200300/*! Ericsson vendor-specific RSL message types */
301enum abis_rsl_msgtype_ericsson {
302 RSL_MT_ERICSSON_IMM_ASS_SENT = 0x10,
303};
304
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200305/*! RSL Information Element Identifiers (Chapter 9.3) */
Harald Welteec8b4502010-02-20 20:34:29 +0100306enum abis_rsl_ie {
307 RSL_IE_CHAN_NR = 0x01,
308 RSL_IE_LINK_IDENT,
309 RSL_IE_ACT_TYPE,
310 RSL_IE_BS_POWER,
311 RSL_IE_CHAN_IDENT,
312 RSL_IE_CHAN_MODE,
313 RSL_IE_ENCR_INFO,
314 RSL_IE_FRAME_NUMBER,
315 RSL_IE_HANDO_REF,
316 RSL_IE_L1_INFO,
317 RSL_IE_L3_INFO,
318 RSL_IE_MS_IDENTITY,
319 RSL_IE_MS_POWER,
320 RSL_IE_PAGING_GROUP,
321 RSL_IE_PAGING_LOAD,
322 RSL_IE_PYHS_CONTEXT = 0x10,
323 RSL_IE_ACCESS_DELAY,
324 RSL_IE_RACH_LOAD,
325 RSL_IE_REQ_REFERENCE,
326 RSL_IE_RELEASE_MODE,
327 RSL_IE_RESOURCE_INFO,
328 RSL_IE_RLM_CAUSE,
329 RSL_IE_STARTNG_TIME,
330 RSL_IE_TIMING_ADVANCE,
331 RSL_IE_UPLINK_MEAS,
332 RSL_IE_CAUSE,
333 RSL_IE_MEAS_RES_NR,
334 RSL_IE_MSG_ID,
335 /* reserved */
336 RSL_IE_SYSINFO_TYPE = 0x1e,
337 RSL_IE_MS_POWER_PARAM,
338 RSL_IE_BS_POWER_PARAM,
339 RSL_IE_PREPROC_PARAM,
340 RSL_IE_PREPROC_MEAS,
341 RSL_IE_IMM_ASS_INFO, /* Phase 1 (3.6.0), later Full below */
342 RSL_IE_SMSCB_INFO = 0x24,
343 RSL_IE_MS_TIMING_OFFSET,
344 RSL_IE_ERR_MSG,
345 RSL_IE_FULL_BCCH_INFO,
346 RSL_IE_CHAN_NEEDED,
347 RSL_IE_CB_CMD_TYPE,
348 RSL_IE_SMSCB_MSG,
349 RSL_IE_FULL_IMM_ASS_INFO,
350 RSL_IE_SACCH_INFO,
351 RSL_IE_CBCH_LOAD_INFO,
352 RSL_IE_SMSCB_CHAN_INDICATOR,
353 RSL_IE_GROUP_CALL_REF,
354 RSL_IE_CHAN_DESC = 0x30,
355 RSL_IE_NCH_DRX_INFO,
356 RSL_IE_CMD_INDICATOR,
357 RSL_IE_EMLPP_PRIO,
358 RSL_IE_UIC,
359 RSL_IE_MAIN_CHAN_REF,
360 RSL_IE_MR_CONFIG,
361 RSL_IE_MR_CONTROL,
362 RSL_IE_SUP_CODEC_TYPES,
363 RSL_IE_CODEC_CONFIG,
364 RSL_IE_RTD,
365 RSL_IE_TFO_STATUS,
366 RSL_IE_LLP_APDU,
367 /* Siemens vendor-specific */
368 RSL_IE_SIEMENS_MRPCI = 0x40,
369 RSL_IE_SIEMENS_PREF_AREA_TYPE = 0x43,
370 RSL_IE_SIEMENS_ININ_CELL_HO_PAR = 0x45,
371 RSL_IE_SIEMENS_TRACE_REF_NR = 0x46,
372 RSL_IE_SIEMENS_INT_TRACE_IDX = 0x47,
373 RSL_IE_SIEMENS_L2_HDR_INFO = 0x48,
374 RSL_IE_SIEMENS_HIGHEST_RATE = 0x4e,
375 RSL_IE_SIEMENS_SUGGESTED_RATE = 0x4f,
376
Philipp Maiera15967b2020-11-06 21:37:16 +0100377 /* Osmocom specific */
Philipp Maiere67edfd2021-08-31 09:46:35 +0200378 RSL_IE_OSMO_REP_ACCH_CAP = 0x60,
Neels Hofmeyrdd6f1362021-04-20 23:02:59 +0200379 RSL_IE_OSMO_TRAINING_SEQUENCE = 0x61,
Philipp Maier0e44a722021-08-30 10:51:52 +0200380 RSL_IE_OSMO_TEMP_OVP_ACCH_CAP = 0x62,
Philipp Maiera15967b2020-11-06 21:37:16 +0100381
Harald Welteec8b4502010-02-20 20:34:29 +0100382 /* ip.access */
383 RSL_IE_IPAC_SRTP_CONFIG = 0xe0,
384 RSL_IE_IPAC_PROXY_UDP = 0xe1,
385 RSL_IE_IPAC_BSCMPL_TOUT = 0xe2,
386 RSL_IE_IPAC_REMOTE_IP = 0xf0,
387 RSL_IE_IPAC_REMOTE_PORT = 0xf1,
388 RSL_IE_IPAC_RTP_PAYLOAD = 0xf2,
389 RSL_IE_IPAC_LOCAL_PORT = 0xf3,
390 RSL_IE_IPAC_SPEECH_MODE = 0xf4,
391 RSL_IE_IPAC_LOCAL_IP = 0xf5,
392 RSL_IE_IPAC_CONN_STAT = 0xf6,
393 RSL_IE_IPAC_HO_C_PARMS = 0xf7,
394 RSL_IE_IPAC_CONN_ID = 0xf8,
395 RSL_IE_IPAC_RTP_CSD_FMT = 0xf9,
396 RSL_IE_IPAC_RTP_JIT_BUF = 0xfa,
397 RSL_IE_IPAC_RTP_COMPR = 0xfb,
398 RSL_IE_IPAC_RTP_PAYLOAD2= 0xfc,
399 RSL_IE_IPAC_RTP_MPLEX = 0xfd,
400 RSL_IE_IPAC_RTP_MPLEX_ID= 0xfe,
401};
402
Harald Welte6e363e72016-11-16 16:58:52 +0100403/* Ericsson specific IEs, clash with above partially, so they're not
404 * part of the enum */
Alexander Couzens9f39d892018-04-21 21:20:25 +0200405#define RSL_IE_ERIC_PAGING_GROUP 0x0e
Harald Welte6e363e72016-11-16 16:58:52 +0100406#define RSL_IE_ERIC_INST_NR 0x48
407#define RSL_IE_ERIC_PGSL_TIMERS 0x49
408#define RSL_IE_ERIC_REPEAT_DL_FACCH 0x4a
409#define RSL_IE_ERIC_POWER_INFO 0xf0
410#define RSL_IE_ERIC_MOBILE_ID 0xf1
411#define RSL_IE_ERIC_BCCH_MAPPING 0xf2
412#define RSL_IE_ERIC_PACKET_PAG_IND 0xf3
413#define RSL_IE_ERIC_CNTR_CTRL 0xf4
414#define RSL_IE_ERIC_CNTR_CTRL_ACK 0xf5
415#define RSL_IE_ERIC_CNTR_REPORT 0xf6
416#define RSL_IE_ERIC_ICP_CONN 0xf7
417#define RSL_IE_ERIC_EMR_SUPPORT 0xf8
418#define RSL_IE_ERIC_EGPRS_REQ_REF 0xf9
419#define RSL_IE_ERIC_VGCS_REL 0xfa
420#define RSL_IE_ERIC_REP_PER_NCH 0xfb
421#define RSL_IE_ERIC_NY2 0xfc
422#define RSL_IE_ERIC_T3115 0xfd
423#define RSL_IE_ERIC_ACTIVATE_FLAG 0xfe
424#define RSL_IE_ERIC_FULL_NCH_INFO 0xff
425
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400426/* IPAC MEAS_PREPROC AVERAGING METHOD */
427enum {
428 IPAC_UNWEIGHTED_AVE = 0,
429 IPAC_WEIGHTED_AVE,
Vadim Yanitskiyc8158ec2020-12-15 08:04:30 +0100430 IPAC_MEDIAN_AVE,
431 /* EWMA is an Osmocom specific extension */
432 IPAC_OSMO_EWMA_AVE,
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400433};
434
Pau Espin Pedrol9da16b52021-08-26 15:25:16 +0200435/* IPAC MEAS_PREPROC AVERAGING PARAM ID */
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400436enum {
437 IPAC_RXLEV_AVE = 0,
438 IPAC_RXQUAL_AVE,
439 IPAC_MS_BTS_DIS_AVE
440};
441
442/* IPAC MEAS_PREPROC HO CAUSES */
443enum {
444 IPAC_HO_RQD_CAUSE_L_RXLEV_UL_H = 0x01,
445 IPAC_HO_RQD_CAUSE_L_RXLEV_DL_H,
446 IPAC_HO_RQD_CAUSE_L_RXQUAL_UL_H,
447 IPAC_HO_RQD_CAUSE_L_RXQUAL_DL_H,
448 IPAC_HO_RQD_CAUSE_RXLEV_UL_IH,
449 IPAC_HO_RQD_CAUSE_RXLEV_DL_IH,
450 IPAC_HO_RQD_CAUSE_MAX_MS_RANGE,
451 IPAC_HO_RQD_CAUSE_POWER_BUDGET,
452 IPAC_HO_RQD_CAUSE_ENQUIRY,
453 IPAC_HO_RQD_CAUSE_ENQUIRY_FAILED,
454 IPAC_HO_RQD_CAUSE_NORMAL3G,
455 IPAC_HO_RQD_CAUSE_EMERGENCY3G,
456 IPAC_HO_RQD_CAUSE_SERVICE_PREFERRED3G,
457 IPAC_HO_RQD_CAUSE_O_M_SHUTDOWN,
458 IPAC_HO_RQD_CAUSE_QUALITY_PROMOTION,
459 IPAC_HO_RQD_CAUSE_LOAD_PROMOTION,
460 IPAC_HO_RQD_CAUSE_LOAD_DEMOTION,
461 IPAC_HO_RQD_CAUSE_MAX,
462};
463
Harald Welteec8b4502010-02-20 20:34:29 +0100464/* Chapter 9.3.1 */
465#define RSL_CHAN_NR_MASK 0xf8
Neels Hofmeyr15b96ff2016-07-18 23:33:48 +0200466#define RSL_CHAN_NR_1 0x08 /*< bit to add for 2nd,... lchan */
Harald Welteec8b4502010-02-20 20:34:29 +0100467#define RSL_CHAN_Bm_ACCHs 0x08
468#define RSL_CHAN_Lm_ACCHs 0x10 /* .. 0x18 */
469#define RSL_CHAN_SDCCH4_ACCH 0x20 /* .. 0x38 */
470#define RSL_CHAN_SDCCH8_ACCH 0x40 /* ...0x78 */
471#define RSL_CHAN_BCCH 0x80
472#define RSL_CHAN_RACH 0x88
473#define RSL_CHAN_PCH_AGCH 0x90
Neels Hofmeyrfd80f5a2016-07-14 03:21:05 +0200474#define RSL_CHAN_OSMO_PDCH 0xc0 /*< non-standard, for dyn TS */
Harald Weltea8d7ebb2019-05-27 16:51:23 +0200475#define RSL_CHAN_OSMO_CBCH4 0xc8 /*< non-standard, for CBCH/SDCCH4 */
476#define RSL_CHAN_OSMO_CBCH8 0xd0 /*< non-standard, for CBCH/SDCCH8 */
Harald Welteec8b4502010-02-20 20:34:29 +0100477
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200478/* non-standard, Osmocom specific Bm/Lm equivalents for VAMOS */
479#define RSL_CHAN_OSMO_VAMOS_Bm_ACCHs 0xe8 /* VAMOS TCH/F */
480#define RSL_CHAN_OSMO_VAMOS_Lm_ACCHs 0xf0 /* VAMOS TCH/H */
Vadim Yanitskiy442ff642021-06-01 19:55:43 +0200481#define RSL_CHAN_OSMO_VAMOS_MASK 0xe0 /* VAMOS TCH/{F,H} */
Vadim Yanitskiyfc02ff42021-05-26 18:19:03 +0200482
Harald Welteec8b4502010-02-20 20:34:29 +0100483/* Chapter 9.3.3 */
484#define RSL_ACT_TYPE_INITIAL 0x00
485#define RSL_ACT_TYPE_REACT 0x80
486#define RSL_ACT_INTRA_IMM_ASS 0x00
487#define RSL_ACT_INTRA_NORM_ASS 0x01
488#define RSL_ACT_INTER_ASYNC 0x02
489#define RSL_ACT_INTER_SYNC 0x03
490#define RSL_ACT_SECOND_ADD 0x04
491#define RSL_ACT_SECOND_MULTI 0x05
Neels Hofmeyrfd80f5a2016-07-14 03:21:05 +0200492#define RSL_ACT_OSMO_PDCH 0x0f /*< non-standard, for dyn TS */
Harald Welteec8b4502010-02-20 20:34:29 +0100493
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200494/*! RSL Channel Mode IF (Chapter 9.3.6) */
Harald Welteec8b4502010-02-20 20:34:29 +0100495struct rsl_ie_chan_mode {
496 uint8_t dtx_dtu;
497 uint8_t spd_ind;
498 uint8_t chan_rt;
499 uint8_t chan_rate;
500} __attribute__ ((packed));
501#define RSL_CMOD_DTXu 0x01 /* uplink */
502#define RSL_CMOD_DTXd 0x02 /* downlink */
503enum rsl_cmod_spd {
504 RSL_CMOD_SPD_SPEECH = 0x01,
505 RSL_CMOD_SPD_DATA = 0x02,
506 RSL_CMOD_SPD_SIGN = 0x03,
507};
Vadim Yanitskiy307b2012021-04-19 04:42:34 +0200508#define RSL_CMOD_CRT_SDCCH 0x01
509#define RSL_CMOD_CRT_TCH_Bm 0x08 /* full-rate */
510#define RSL_CMOD_CRT_TCH_Lm 0x09 /* half-rate */
511#define RSL_CMOD_CRT_TCH_BI_Bm 0x0a /* full-rate: bi-directional (multislot) */
512#define RSL_CMOD_CRT_TCH_UNI_Bm 0x1a /* full-rate: uni-directional (multislot) */
513#define RSL_CMOD_CRT_TCH_GROUP_Bm 0x18 /* full-rate: group call channel */
514#define RSL_CMOD_CRT_TCH_GROUP_Lm 0x19 /* half-rate: group call channel */
515#define RSL_CMOD_CRT_TCH_BCAST_Bm 0x28 /* full-rate: broadcast call channel */
516#define RSL_CMOD_CRT_TCH_BCAST_Lm 0x29 /* half-rate: broadcast call channel */
Neels Hofmeyrfef61cd2021-04-22 21:54:31 +0200517#define RSL_CMOD_CRT_OSMO_TCH_VAMOS_Bm 0x88 /* full-rate in VAMOS mode */
518#define RSL_CMOD_CRT_OSMO_TCH_VAMOS_Lm 0x89 /* half-rate in VAMOS mode */
Harald Welteec8b4502010-02-20 20:34:29 +0100519/* Speech */
520#define RSL_CMOD_SP_GSM1 0x01
521#define RSL_CMOD_SP_GSM2 0x11
522#define RSL_CMOD_SP_GSM3 0x21
Vadim Yanitskiy99f6cd52021-04-19 04:26:10 +0200523#define RSL_CMOD_SP_GSM4 0x31
524#define RSL_CMOD_SP_GSM5 0x09
525#define RSL_CMOD_SP_GSM6 0x0d
Vadim Yanitskiye731a7d2021-04-19 04:59:51 +0200526/* non-transparent data (asymmetric) */
527#define RSL_CMOD_CSD_NTA_43k5_14k5 0x61 /* asymmetric 43.5 kbit/s (DL) + 14.5 kbit/s (UL) */
528#define RSL_CMOD_CSD_NTA_29k0_14k5 0x62 /* asymmetric 29.0 kbit/s (DL) + 14.5 kbit/s (UL) */
529#define RSL_CMOD_CSD_NTA_43k5_29k0 0x63 /* asymmetric 43.5 kbit/s (DL) + 29.0 kbit/s (UL) */
530#define RSL_CMOD_CSD_NTA_14k5_43k5 0x69 /* asymmetric 14.5 kbit/s (DL) + 43.5 kbit/s (UL) */
531#define RSL_CMOD_CSD_NTA_14k5_29k0 0x6a /* asymmetric 14.5 kbit/s (DL) + 29.0 kbit/s (UL) */
532#define RSL_CMOD_CSD_NTA_29k0_43k5 0x6b /* asymmetric 29.0 kbit/s (DL) + 43.5 kbit/s (UL) */
Harald Welteeed26112012-08-24 15:35:34 +0200533/* non-transparent data */
534#define RSL_CMOD_CSD_NT_43k5 0x74
535#define RSL_CMOD_CSD_NT_28k8 0x71
536#define RSL_CMOD_CSD_NT_14k5 0x58
537#define RSL_CMOD_CSD_NT_12k0 0x50
538#define RSL_CMOD_CSD_NT_6k0 0x51
539/* legacy #defines with wrong name */
540#define RSL_CMOD_SP_NT_14k5 RSL_CMOD_CSD_NT_14k5
541#define RSL_CMOD_SP_NT_12k0 RSL_CMOD_CSD_NT_12k0
542#define RSL_CMOD_SP_NT_6k0 RSL_CMOD_CSD_NT_6k0
543/* transparent data */
544#define RSL_CMOD_CSD_T_32000 0x38
545#define RSL_CMOD_CSD_T_29000 0x39
546#define RSL_CMOD_CSD_T_14400 0x18
547#define RSL_CMOD_CSD_T_9600 0x10
548#define RSL_CMOD_CSD_T_4800 0x11
549#define RSL_CMOD_CSD_T_2400 0x12
550#define RSL_CMOD_CSD_T_1200 0x13
551#define RSL_CMOD_CSD_T_600 0x14
552#define RSL_CMOD_CSD_T_1200_75 0x15
Harald Welteec8b4502010-02-20 20:34:29 +0100553
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200554/*! RSL Channel Identification IE (Chapter 9.3.5) */
Harald Welteec8b4502010-02-20 20:34:29 +0100555struct rsl_ie_chan_ident {
556 /* GSM 04.08 10.5.2.5 */
557 struct {
558 uint8_t iei;
559 uint8_t chan_nr; /* enc_chan_nr */
560 uint8_t oct3;
561 uint8_t oct4;
562 } chan_desc;
563#if 0 /* spec says we need this but Abissim doesn't use it */
564 struct {
565 uint8_t tag;
566 uint8_t len;
567 } mobile_alloc;
568#endif
569} __attribute__ ((packed));
570
571/* Chapter 9.3.22 */
572#define RLL_CAUSE_T200_EXPIRED 0x01
573#define RLL_CAUSE_REEST_REQ 0x02
574#define RLL_CAUSE_UNSOL_UA_RESP 0x03
575#define RLL_CAUSE_UNSOL_DM_RESP 0x04
576#define RLL_CAUSE_UNSOL_DM_RESP_MF 0x05
577#define RLL_CAUSE_UNSOL_SPRV_RESP 0x06
578#define RLL_CAUSE_SEQ_ERR 0x07
579#define RLL_CAUSE_UFRM_INC_PARAM 0x08
580#define RLL_CAUSE_SFRM_INC_PARAM 0x09
581#define RLL_CAUSE_IFRM_INC_MBITS 0x0a
582#define RLL_CAUSE_IFRM_INC_LEN 0x0b
583#define RLL_CAUSE_FRM_UNIMPL 0x0c
584#define RLL_CAUSE_SABM_MF 0x0d
585#define RLL_CAUSE_SABM_INFO_NOTALL 0x0e
586
587/* Chapter 9.3.26 */
588#define RSL_ERRCLS_NORMAL 0x00
589#define RSL_ERRCLS_RESOURCE_UNAVAIL 0x20
590#define RSL_ERRCLS_SERVICE_UNAVAIL 0x30
591#define RSL_ERRCLS_SERVICE_UNIMPL 0x40
592#define RSL_ERRCLS_INVAL_MSG 0x50
593#define RSL_ERRCLS_PROTO_ERROR 0x60
594#define RSL_ERRCLS_INTERWORKING 0x70
595
596/* normal event */
597#define RSL_ERR_RADIO_IF_FAIL 0x00
598#define RSL_ERR_RADIO_LINK_FAIL 0x01
599#define RSL_ERR_HANDOVER_ACC_FAIL 0x02
600#define RSL_ERR_TALKER_ACC_FAIL 0x03
601#define RSL_ERR_OM_INTERVENTION 0x07
602#define RSL_ERR_NORMAL_UNSPEC 0x0f
603#define RSL_ERR_T_MSRFPCI_EXP 0x18
604/* resource unavailable */
605#define RSL_ERR_EQUIPMENT_FAIL 0x20
606#define RSL_ERR_RR_UNAVAIL 0x21
607#define RSL_ERR_TERR_CH_FAIL 0x22
608#define RSL_ERR_CCCH_OVERLOAD 0x23
609#define RSL_ERR_ACCH_OVERLOAD 0x24
610#define RSL_ERR_PROCESSOR_OVERLOAD 0x25
Philipp Maier6d214482020-07-28 16:53:27 +0200611#define RSL_ERR_BTS_NOT_EQUIPPED 0x27
612#define RSL_ERR_REMOTE_TRANSC_FAIL 0x28
613#define RSL_ERR_NOTIFICATION_OVERFL 0x29
Harald Welteec8b4502010-02-20 20:34:29 +0100614#define RSL_ERR_RES_UNAVAIL 0x2f
615/* service or option not available */
616#define RSL_ERR_TRANSC_UNAVAIL 0x30
617#define RSL_ERR_SERV_OPT_UNAVAIL 0x3f
618/* service or option not implemented */
619#define RSL_ERR_ENCR_UNIMPL 0x40
620#define RSL_ERR_SERV_OPT_UNIMPL 0x4f
621/* invalid message */
622#define RSL_ERR_RCH_ALR_ACTV_ALLOC 0x50
623#define RSL_ERR_INVALID_MESSAGE 0x5f
624/* protocol error */
625#define RSL_ERR_MSG_DISCR 0x60
626#define RSL_ERR_MSG_TYPE 0x61
627#define RSL_ERR_MSG_SEQ 0x62
628#define RSL_ERR_IE_ERROR 0x63
629#define RSL_ERR_MAND_IE_ERROR 0x64
630#define RSL_ERR_OPT_IE_ERROR 0x65
631#define RSL_ERR_IE_NONEXIST 0x66
632#define RSL_ERR_IE_LENGTH 0x67
633#define RSL_ERR_IE_CONTENT 0x68
634#define RSL_ERR_PROTO 0x6f
635/* interworking */
636#define RSL_ERR_INTERWORKING 0x7f
637
638/* Chapter 9.3.30 */
639#define RSL_SYSTEM_INFO_8 0x00
640#define RSL_SYSTEM_INFO_1 0x01
641#define RSL_SYSTEM_INFO_2 0x02
642#define RSL_SYSTEM_INFO_3 0x03
643#define RSL_SYSTEM_INFO_4 0x04
644#define RSL_SYSTEM_INFO_5 0x05
645#define RSL_SYSTEM_INFO_6 0x06
646#define RSL_SYSTEM_INFO_7 0x07
647#define RSL_SYSTEM_INFO_16 0x08
648#define RSL_SYSTEM_INFO_17 0x09
649#define RSL_SYSTEM_INFO_2bis 0x0a
650#define RSL_SYSTEM_INFO_2ter 0x0b
651#define RSL_SYSTEM_INFO_5bis 0x0d
652#define RSL_SYSTEM_INFO_5ter 0x0e
653#define RSL_SYSTEM_INFO_10 0x0f
Harald Welte3d732272011-06-25 21:39:01 +0200654#define RSL_EXT_MEAS_ORDER 0x47
Harald Welteec8b4502010-02-20 20:34:29 +0100655#define RSL_MEAS_INFO 0x48
656#define RSL_SYSTEM_INFO_13 0x28
Philipp00b15392016-11-14 12:34:15 +0100657#define RSL_ERIC_SYSTEM_INFO_13 0x0C
Harald Welteec8b4502010-02-20 20:34:29 +0100658#define RSL_SYSTEM_INFO_2quater 0x29
659#define RSL_SYSTEM_INFO_9 0x2a
660#define RSL_SYSTEM_INFO_18 0x2b
661#define RSL_SYSTEM_INFO_19 0x2c
662#define RSL_SYSTEM_INFO_20 0x2d
663
664/* Chapter 9.3.40 */
665#define RSL_CHANNEED_ANY 0x00
666#define RSL_CHANNEED_SDCCH 0x01
667#define RSL_CHANNEED_TCH_F 0x02
668#define RSL_CHANNEED_TCH_ForH 0x03
669
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200670/*! RSL Cell Broadcast Command (Chapter 9.3.45) */
Alex Badea84930182010-11-27 23:34:46 +0200671struct rsl_ie_cb_cmd_type {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100672#if OSMO_IS_LITTLE_ENDIAN
Alex Badea84930182010-11-27 23:34:46 +0200673 uint8_t last_block:2;
674 uint8_t spare:1;
675 uint8_t def_bcast:1;
676 uint8_t command:4;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100677#elif OSMO_IS_BIG_ENDIAN
678/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
679 uint8_t command:4, def_bcast:1, spare:1, last_block:2;
680#endif
Alex Badea84930182010-11-27 23:34:46 +0200681} __attribute__ ((packed));
682/* ->command */
683#define RSL_CB_CMD_TYPE_NORMAL 0x00
684#define RSL_CB_CMD_TYPE_SCHEDULE 0x08
685#define RSL_CB_CMD_TYPE_DEFAULT 0x0e
686#define RSL_CB_CMD_TYPE_NULL 0x0f
687/* ->def_bcast */
688#define RSL_CB_CMD_DEFBCAST_NORMAL 0
689#define RSL_CB_CMD_DEFBCAST_NULL 1
690/* ->last_block */
691#define RSL_CB_CMD_LASTBLOCK_4 0
692#define RSL_CB_CMD_LASTBLOCK_1 1
693#define RSL_CB_CMD_LASTBLOCK_2 2
694#define RSL_CB_CMD_LASTBLOCK_3 3
695
Harald Welteec8b4502010-02-20 20:34:29 +0100696/* Chapter 3.3.2.3 Brocast control channel */
697/* CCCH-CONF, NC is not combined */
698#define RSL_BCCH_CCCH_CONF_1_NC 0x00
699#define RSL_BCCH_CCCH_CONF_1_C 0x01
700#define RSL_BCCH_CCCH_CONF_2_NC 0x02
701#define RSL_BCCH_CCCH_CONF_3_NC 0x04
702#define RSL_BCCH_CCCH_CONF_4_NC 0x06
703
704/* BS-PA-MFRMS */
705#define RSL_BS_PA_MFRMS_2 0x00
706#define RSL_BS_PA_MFRMS_3 0x01
707#define RSL_BS_PA_MFRMS_4 0x02
708#define RSL_BS_PA_MFRMS_5 0x03
709#define RSL_BS_PA_MFRMS_6 0x04
710#define RSL_BS_PA_MFRMS_7 0x05
711#define RSL_BS_PA_MFRMS_8 0x06
712#define RSL_BS_PA_MFRMS_9 0x07
713
714/* RSL_IE_IPAC_RTP_PAYLOAD[2] */
715enum rsl_ipac_rtp_payload {
716 RSL_IPAC_RTP_GSM = 1,
717 RSL_IPAC_RTP_EFR,
718 RSL_IPAC_RTP_AMR,
719 RSL_IPAC_RTP_CSD,
720 RSL_IPAC_RTP_MUX,
721};
722
723/* RSL_IE_IPAC_SPEECH_MODE, lower four bits */
724enum rsl_ipac_speech_mode_s {
725 RSL_IPAC_SPEECH_GSM_FR = 0, /* GSM FR (Type 1, FS) */
726 RSL_IPAC_SPEECH_GSM_EFR = 1, /* GSM EFR (Type 2, FS) */
727 RSL_IPAC_SPEECH_GSM_AMR_FR = 2, /* GSM AMR/FR (Type 3, FS) */
728 RSL_IPAC_SPEECH_GSM_HR = 3, /* GSM HR (Type 1, HS) */
729 RSL_IPAC_SPEECH_GSM_AMR_HR = 5, /* GSM AMR/hr (Type 3, HS) */
730 RSL_IPAC_SPEECH_AS_RTP = 0xf, /* As specified by RTP Payload IE */
731};
732/* RSL_IE_IPAC_SPEECH_MODE, upper four bits */
733enum rsl_ipac_speech_mode_m {
734 RSL_IPAC_SPEECH_M_RXTX = 0, /* Send and Receive */
735 RSL_IPAC_SPEECH_M_RX = 1, /* Receive only */
736 RSL_IPAC_SPEECH_M_TX = 2, /* Send only */
737};
738
739/* RSL_IE_IPAC_RTP_CSD_FMT, lower four bits */
740enum rsl_ipac_rtp_csd_format_d {
741 RSL_IPAC_RTP_CSD_EXT_TRAU = 0,
742 RSL_IPAC_RTP_CSD_NON_TRAU = 1,
743 RSL_IPAC_RTP_CSD_TRAU_BTS = 2,
744 RSL_IPAC_RTP_CSD_IWF_FREE = 3,
745};
746/* RSL_IE_IPAC_RTP_CSD_FMT, upper four bits */
747enum rsl_ipac_rtp_csd_format_ir {
748 RSL_IPAC_RTP_CSD_IR_8k = 0,
749 RSL_IPAC_RTP_CSD_IR_16k = 1,
750 RSL_IPAC_RTP_CSD_IR_32k = 2,
751 RSL_IPAC_RTP_CSD_IR_64k = 3,
752};
753
754/* Siemens vendor-specific RSL extensions */
755struct rsl_mrpci {
756 uint8_t power_class:3,
757 vgcs_capable:1,
758 vbs_capable:1,
759 gsm_phase:2;
760} __attribute__ ((packed));
761
762enum rsl_mrpci_pwrclass {
763 RSL_MRPCI_PWRC_1 = 0,
764 RSL_MRPCI_PWRC_2 = 1,
765 RSL_MRPCI_PWRC_3 = 2,
766 RSL_MRPCI_PWRC_4 = 3,
767 RSL_MRPCI_PWRC_5 = 4,
768};
769enum rsl_mrpci_phase {
770 RSL_MRPCI_PHASE_1 = 0,
771 /* reserved */
772 RSL_MRPCI_PHASE_2 = 2,
773 RSL_MRPCI_PHASE_2PLUS = 3,
774};
775
Holger Hans Peter Freyther0357e9b2012-12-06 11:57:31 +0100776/* 9.3.20 Release Mode */
777enum rsl_rel_mode {
778 RSL_REL_NORMAL = 0,
779 RSL_REL_LOCAL_END = 1,
780};
781
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200782/*! ip.access specific embedded information elements */
Harald Weltefad57522015-12-13 11:56:36 +0100783enum rsl_ipac_embedded_ie {
784 RSL_IPAC_EIE_RXLEV = 0x00,
785 RSL_IPAC_EIE_RXQUAL = 0x01,
786 RSL_IPAC_EIE_FREQ_ERR = 0x02,
787 RSL_IPAC_EIE_TIMING_ERR = 0x03,
788 RSL_IPAC_EIE_MEAS_AVG_CFG = 0x04,
789 RSL_IPAC_EIE_BS_PWR_CTL = 0x05,
790 RSL_IPAC_EIE_MS_PWR_CTL = 0x06,
791 RSL_IPAC_EIE_HANDO_THRESH = 0x07,
792 RSL_IPAC_EIE_NCELL_DEFAULTS = 0x08,
793 RSL_IPAC_EIE_NCELL_LIST = 0x09,
794 RSL_IPAC_EIE_PC_THRESH_COMP = 0x0a,
795 RSL_IPAC_EIE_HO_THRESH_COMP = 0x0b,
796 RSL_IPAC_EIE_HO_CAUSE = 0x0c,
797 RSL_IPAC_EIE_HO_CANDIDATES = 0x0d,
798 RSL_IPAC_EIE_NCELL_BA_CHG_LIST = 0x0e,
799 RSL_IPAC_EIE_NUM_OF_MS = 0x10,
800 RSL_IPAC_EIE_HO_CAND_EXT = 0x11,
801 RSL_IPAC_EIE_NCELL_DEF_EXT = 0x12,
802 RSL_IPAC_EIE_NCELL_LIST_EXT = 0x13,
803 RSL_IPAC_EIE_MASTER_KEY = 0x14,
804 RSL_IPAC_EIE_MASTER_SALT = 0x15,
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400805 /* additional IPAC measurement pre-processing related IEI */
806 RSL_IPAC_EIE_MEAS_TRANS_RES = 0x16,
807 RSL_IPAC_EIE_3G_HO_PARAM = 0x17,
808 RSL_IPAC_EIE_3G_NCELL_LIST = 0x18,
809 RSL_IPAC_EIE_SDCCH_CTL_PARAM = 0x1a,
810 RSL_IPAC_EIE_AMR_CONV_THRESH = 0x1b,
811
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200812 /* Osmocom specific extensions: */
813 RSL_IPAC_EIE_OSMO_MEAS_AVG_CFG = 0xf0,
814 RSL_IPAC_EIE_OSMO_MS_PWR_CTL = 0xf1,
815 RSL_IPAC_EIE_OSMO_PC_THRESH_COMP = 0xf2,
816
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400817};
818
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200819/* Value of TLV IE RSL_IPAC_EIE_MEAS_AVG_CFG */
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400820struct ipac_preproc_ave_cfg {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100821#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400822 uint8_t h_reqave:5,
823 param_id:2,
824 reserved:1;
825 uint8_t h_reqt:5,
826 ave_method:3;
Vadim Yanitskiy8f5844e2020-12-25 00:19:45 +0100827 uint8_t params[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100828#elif OSMO_IS_BIG_ENDIAN
829/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
830 uint8_t reserved:1, param_id:2, h_reqave:5;
831 uint8_t ave_method:3, h_reqt:5;
Vadim Yanitskiy8f5844e2020-12-25 00:19:45 +0100832 uint8_t params[0];
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100833#endif
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400834}__attribute__ ((packed));
835
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200836
837struct osmo_preproc_ave_cfg_field {
838#if OSMO_IS_LITTLE_ENDIAN
839 uint8_t h_reqave:5,
840 ave_enabled:1,
841 reserved:2;
842 uint8_t h_reqt:5,
843 ave_method:3;
844#elif OSMO_IS_BIG_ENDIAN
845/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
846 uint8_t reserved:2, ave_enabled:1, h_reqave:5;
847 uint8_t ave_method:3, h_reqt:5;
848#endif
849}__attribute__ ((packed));
850/* Value of TLV IE RSL_IPAC_EIE_OSMO_MEAS_AVG_CFG: */
851struct osmo_preproc_ave_cfg {
852 struct osmo_preproc_ave_cfg_field ci_fr;
853 struct osmo_preproc_ave_cfg_field ci_hr;
854 struct osmo_preproc_ave_cfg_field ci_amr_fr;
855 struct osmo_preproc_ave_cfg_field ci_amr_hr;
856 struct osmo_preproc_ave_cfg_field ci_sdcch;
857 struct osmo_preproc_ave_cfg_field ci_gprs;
858 uint8_t params[0]; /* Contains params for each above, appended one after the other */
859}__attribute__ ((packed));
860
861/*! MS/BS Power Control Thresholds (RSL_IPAC_EIE_MS_PWR_CTL) */
Vadim Yanitskiya346c452020-12-15 07:48:58 +0100862struct ipac_preproc_pc_thresh {
863#if OSMO_IS_LITTLE_ENDIAN
864 uint8_t l_rxlev:6, reserved_l_rxlev:2;
865 uint8_t u_rxlev:6, reserved_u_rxlev:2;
Vadim Yanitskiy2060bbb2020-12-19 17:33:41 +0100866 uint8_t u_rxqual:3, reserved_u_rxqual:1,
867 l_rxqual:3, reserved_l_rxqual:1;
Vadim Yanitskiya346c452020-12-15 07:48:58 +0100868#elif OSMO_IS_BIG_ENDIAN
869 uint8_t reserved_l_rxlev:2, l_rxlev:6;
870 uint8_t reserved_u_rxlev:2, u_rxlev:6;
871 uint8_t reserved_l_rxqual:1, l_rxqual:3,
872 reserved_u_rxqual:1, u_rxqual:3;
873#endif
874}__attribute__ ((packed));
875
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200876/*! Osmocom extension for: MS/BS Power Control Thresholds (RSL_IPAC_EIE_OSMO_MS_PWR_CTL) */
877struct osmo_preproc_pc_thresh {
878 /* Carrier-to-Interference (C/I), in dB: */
879 int8_t l_ci_fr; int8_t u_ci_fr; /* FR/EFR */
880 int8_t l_ci_hr; int8_t u_ci_hr; /* HR */
881 int8_t l_ci_amr_fr; int8_t u_ci_amr_fr; /* AMR FR */
882 int8_t l_ci_amr_hr; int8_t u_ci_amr_hr; /* AMR HR */
883 int8_t l_ci_sdcch; int8_t u_ci_sdcch; /* SDCCH */
884 int8_t l_ci_gprs; int8_t u_ci_gprs; /* GPRS */
885}__attribute__ ((packed));
886
Vadim Yanitskiya346c452020-12-15 07:48:58 +0100887/*! Handover Thresholds */
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400888struct ipac_preproc_ho_thresh {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100889#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400890 uint8_t l_rxlev_ul_h:6,
891 reserved_l_rxlev_ul:2;
892 uint8_t l_rxlev_dl_h:6,
893 reserved_l_rxlev_dl:2;
894 uint8_t rxlev_ul_ih:6,
895 reserved_rxlev_ul:2;
896 uint8_t rxlev_dl_ih:6,
897 reserved_rxlev_dl:2;
898 uint8_t l_rxqual_ul_h:3,
899 reserved_rxlqual_ul:1,
900 l_rxqual_dl_h:3,
901 reserved_rxqual_dl:1;
902 uint8_t ms_range_max:6,
903 reserved_ms_range:2;
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100904#elif OSMO_IS_BIG_ENDIAN
905/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
906 uint8_t reserved_l_rxlev_ul:2, l_rxlev_ul_h:6;
907 uint8_t reserved_l_rxlev_dl:2, l_rxlev_dl_h:6;
908 uint8_t reserved_rxlev_ul:2, rxlev_ul_ih:6;
909 uint8_t reserved_rxlev_dl:2, rxlev_dl_ih:6;
910 uint8_t reserved_rxqual_dl:1, l_rxqual_dl_h:3, reserved_rxlqual_ul:1, l_rxqual_ul_h:3;
911 uint8_t reserved_ms_range:2, ms_range_max:6;
912#endif
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400913}__attribute__ ((packed));
914
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200915/*! PC Threshold Comparators (RSL_IPAC_EIE_PC_THRESH_COMP) */
Vadim Yanitskiya346c452020-12-15 07:48:58 +0100916struct ipac_preproc_pc_comp {
917#if OSMO_IS_LITTLE_ENDIAN
918 uint8_t p1:5, reserved_p1:3;
919 uint8_t n1:5, reserved_n1:3;
920 uint8_t p2:5, reserved_p2:3;
921 uint8_t n2:5, reserved_n2:3;
922 uint8_t p3:5, reserved_p3:3;
923 uint8_t n3:5, reserved_n3:3;
924 uint8_t p4:5, reserved_p4:3;
925 uint8_t n4:5, reserved_n4:3;
926 uint8_t pc_interval:5, reserved_pc:3;
927 uint8_t red_step_size:4, inc_step_size:4;
928#elif OSMO_IS_BIG_ENDIAN
929 uint8_t reserved_p1:3, p1:5;
930 uint8_t reserved_n1:3, n1:5;
931 uint8_t reserved_p2:3, p2:5;
932 uint8_t reserved_n2:3, n2:5;
933 uint8_t reserved_p3:3, p3:5;
934 uint8_t reserved_n3:3, n3:5;
935 uint8_t reserved_p4:3, p4:5;
936 uint8_t reserved_n4:3, n4:5;
937 uint8_t reserved_pc:3, pc_interval:5;
938 uint8_t inc_step_size:4, red_step_size:4;
939#endif
940}__attribute__ ((packed));
941
Pau Espin Pedrol51933842021-08-30 13:50:56 +0200942/*! Osmocom extension for: PC Threshold Comparators (RSL_IPAC_EIE_OSMO_PC_THRESH_COMP) */
943struct ipac_preproc_pc_comp_field {
944#if OSMO_IS_LITTLE_ENDIAN
945 uint8_t lower_p:5, reserved_lower_p:3;
946 uint8_t lower_n:5, reserved_lower_n:3;
947 uint8_t upper_p:5, reserved_upper_p:3;
948 uint8_t upper_n:5, reserved_upper_n:3;
949#elif OSMO_IS_BIG_ENDIAN
950 uint8_t reserved_lower_p:3, lower_p:5;
951 uint8_t reserved_lower_n:3, lower_n:5;
952 uint8_t reserved_upper_p:3, upper_p:5;
953 uint8_t reserved_upper_n:3, upper_n:5;
954 #endif
955}__attribute__ ((packed));
956struct osmo_preproc_pc_comp {
957 /* Used for Carrier-to-Interference (C/I), in dB: */
958 struct ipac_preproc_pc_comp_field ci_fr;
959 struct ipac_preproc_pc_comp_field ci_hr;
960 struct ipac_preproc_pc_comp_field ci_amr_fr;
961 struct ipac_preproc_pc_comp_field ci_amr_hr;
962 struct ipac_preproc_pc_comp_field ci_sdcch;
963 struct ipac_preproc_pc_comp_field ci_gprs;
964}__attribute__ ((packed));
965
Vadim Yanitskiya346c452020-12-15 07:48:58 +0100966/*! HO Threshold Comparators */
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400967struct ipac_preproc_ho_comp {
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100968#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -0400969 uint8_t p5:5,
970 reserved_p5:3;
971 uint8_t n5:5,
972 reserved_n5:3;
973 uint8_t p6:5,
974 reserved_p6:3;
975 uint8_t n6:5,
976 reserved_n6:3;
977 uint8_t p7:5,
978 reserved_p7:3;
979 uint8_t n7:5,
980 reserved_n7:3;
981 uint8_t p8:5,
982 reserved_p8:3;
983 uint8_t n8:5,
984 reserved_n8:3;
985 uint8_t ho_interval:5,
986 reserved_ho:3;
987 uint8_t reserved;
988
Neels Hofmeyrb2600392018-11-16 00:20:39 +0100989#elif OSMO_IS_BIG_ENDIAN
990/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
991 uint8_t reserved_p5:3, p5:5;
992 uint8_t reserved_n5:3, n5:5;
993 uint8_t reserved_p6:3, p6:5;
994 uint8_t reserved_n6:3, n6:5;
995 uint8_t reserved_p7:3, p7:5;
996 uint8_t reserved_n7:3, n7:5;
997 uint8_t reserved_p8:3, p8:5;
998 uint8_t reserved_n8:3, n8:5;
999 uint8_t reserved_ho:3, ho_interval:5;
1000 uint8_t reserved;
1001#endif
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001002}__attribute__ ((packed));
1003
1004struct ipac_preproc_ho_candidates {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001005#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001006 uint8_t bsic:6,
1007 reserved0:2;
1008 uint8_t bcch_freq:5,
1009 ba_used:1,
1010 s:1,
1011 reserved1:1;
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001012#elif OSMO_IS_BIG_ENDIAN
1013/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1014 uint8_t reserved0:2, bsic:6;
1015 uint8_t reserved1:1, s:1, ba_used:1, bcch_freq:5;
1016#endif
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001017}__attribute__ ((packed));
1018
1019struct ipac_preproc_ncell_dflts {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001020#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001021 uint8_t rxlev_min_def:6,
1022 reserved_rxlev_min_def:2;
1023 uint8_t ho_margin_def:5,
1024 reserved_ho_margin_def:3;
1025 uint8_t ms_txpwr_max_def:5,
1026 reserved_ms_txpwr_max_def:3;
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001027#elif OSMO_IS_BIG_ENDIAN
1028/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1029 uint8_t reserved_rxlev_min_def:2, rxlev_min_def:6;
1030 uint8_t reserved_ho_margin_def:3, ho_margin_def:5;
1031 uint8_t reserved_ms_txpwr_max_def:3, ms_txpwr_max_def:5;
1032#endif
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001033}__attribute__ ((packed));
1034
Minh-Quang Nguyenadc28dc2017-02-06 11:13:31 -05001035struct ipac_preproc_ho_ctl_param {
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001036#if OSMO_IS_LITTLE_ENDIAN
Minh-Quang Nguyenadc28dc2017-02-06 11:13:31 -05001037 uint8_t sdcch_ho_gsm:1,
1038 sdcch_ho_umts:1,
1039 reserved:6;
Neels Hofmeyrb2600392018-11-16 00:20:39 +01001040#elif OSMO_IS_BIG_ENDIAN
1041/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
1042 uint8_t reserved:6, sdcch_ho_umts:1, sdcch_ho_gsm:1;
1043#endif
Minh-Quang Nguyenadc28dc2017-02-06 11:13:31 -05001044}__attribute__ ((packed));
1045
Minh-Quang Nguyen17a87482016-09-02 11:28:31 -04001046struct ipac_preproc_cfg {
1047 uint8_t meas_rep_mode;
1048 uint32_t meas_mode_flags;
1049 struct ipac_preproc_ave_cfg ms_ave_cfg[3];
1050 struct ipac_preproc_ave_cfg ave_cfg;
1051 struct ipac_preproc_ho_thresh ho_thresh;
1052 struct ipac_preproc_ho_comp ho_comp;
1053 struct ipac_preproc_ncell_dflts ncell_dflts;
Minh-Quang Nguyenadc28dc2017-02-06 11:13:31 -05001054 struct ipac_preproc_ho_ctl_param ho_ctl_param;
Harald Weltefad57522015-12-13 11:56:36 +01001055};
1056
Philipp Maierca770ae2021-02-16 17:31:22 +01001057struct rsl_l1_info {
1058#if OSMO_IS_BIG_ENDIAN
1059 uint8_t ms_pwr:5,
1060 fpc_epc:1,
1061 srr_sro:1,
1062 reserved:1;
1063 uint8_t ta;
1064#elif OSMO_IS_LITTLE_ENDIAN
1065 uint8_t reserved:1,
1066 srr_sro:1,
1067 fpc_epc:1,
1068 ms_pwr:5;
1069 uint8_t ta;
1070#endif
1071} __attribute__ ((packed));
1072
Sylvain Munautdca7d2c2012-04-18 21:53:23 +02001073/*! @} */