blob: 39b1d45c3b7f0d805f7a373155fce59cae47fcf4 [file] [log] [blame]
Pau Espin Pedrol7ac04512022-05-04 17:06:05 +02001/* 3GPP TS 12.21, nowadays 3GPP TS 52.021 */
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02002/*
3 * (C) 2008-2009 by Harald Welte <laforge@gnumonks.org>
Harald Welteec8b4502010-02-20 20:34:29 +01004 * All Rights Reserved
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
Harald Welteec8b4502010-02-20 20:34:29 +010016 */
17
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020018#pragma once
19
Harald Welte4e777c32011-08-17 19:15:24 +020020/*! \addtogroup oml
21 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020022 * \file gsm_12_21.h */
Harald Welte4e777c32011-08-17 19:15:24 +020023
Harald Welteec8b4502010-02-20 20:34:29 +010024#include <stdint.h>
Maxf74cfd32017-03-24 20:16:33 +010025#include <stdbool.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010026#include <osmocom/gsm/tlv.h>
Harald Welteec8b4502010-02-20 20:34:29 +010027
Neels Hofmeyr87e45502017-06-20 00:17:59 +020028/*! generic header in front of every OML message according to TS 08.59 */
Harald Welteec8b4502010-02-20 20:34:29 +010029struct abis_om_hdr {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020030 /*! Message Discriminator \ref abis_oml_mdisc */
Harald Welteec8b4502010-02-20 20:34:29 +010031 uint8_t mdisc;
Neels Hofmeyr87e45502017-06-20 00:17:59 +020032 /*! Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */
Harald Welteec8b4502010-02-20 20:34:29 +010033 uint8_t placement;
Neels Hofmeyr87e45502017-06-20 00:17:59 +020034 /*! Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */
Harald Welteec8b4502010-02-20 20:34:29 +010035 uint8_t sequence;
Neels Hofmeyr87e45502017-06-20 00:17:59 +020036 /*! Length in octets */
Harald Welteec8b4502010-02-20 20:34:29 +010037 uint8_t length;
Neels Hofmeyr87e45502017-06-20 00:17:59 +020038 /*! actual payload data */
Harald Welteec8b4502010-02-20 20:34:29 +010039 uint8_t data[0];
40} __attribute__ ((packed));
41
Maxecbcdf52017-01-02 14:43:35 +010042#define ABIS_NM_MSG_SIZE 1024
43#define ABIS_NM_MSG_HEADROOM 128
44
Neels Hofmeyr87e45502017-06-20 00:17:59 +020045/*! Message Discriminator for Formatted Object Messages */
Harald Welteec8b4502010-02-20 20:34:29 +010046#define ABIS_OM_MDISC_FOM 0x80
Neels Hofmeyr87e45502017-06-20 00:17:59 +020047/*! Message Discriminator for Man Machine Interface */
Harald Welteec8b4502010-02-20 20:34:29 +010048#define ABIS_OM_MDISC_MMI 0x40
Neels Hofmeyr87e45502017-06-20 00:17:59 +020049/*! Message Discriminator for TRAU management */
Harald Welteec8b4502010-02-20 20:34:29 +010050#define ABIS_OM_MDISC_TRAU 0x20
Neels Hofmeyr87e45502017-06-20 00:17:59 +020051/*! Message Discriminator for Manufacturer Specific Messages */
Harald Welteec8b4502010-02-20 20:34:29 +010052#define ABIS_OM_MDISC_MANUF 0x10
Harald Welte4e777c32011-08-17 19:15:24 +020053
Neels Hofmeyr87e45502017-06-20 00:17:59 +020054/*! Entire OML message is in the L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010055#define ABIS_OM_PLACEMENT_ONLY 0x80
Neels Hofmeyr87e45502017-06-20 00:17:59 +020056/*! First fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010057#define ABIS_OM_PLACEMENT_FIRST 0x40
Neels Hofmeyr87e45502017-06-20 00:17:59 +020058/*! Middle fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010059#define ABIS_OM_PLACEMENT_MIDDLE 0x20
Neels Hofmeyr87e45502017-06-20 00:17:59 +020060/*! Last fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010061#define ABIS_OM_PLACEMENT_LAST 0x10
62
Neels Hofmeyr87e45502017-06-20 00:17:59 +020063/*! OML Object Instance */
Harald Welteec8b4502010-02-20 20:34:29 +010064struct abis_om_obj_inst {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020065 uint8_t bts_nr; /*!< BTS Number */
66 uint8_t trx_nr; /*!< TRX Number */
67 uint8_t ts_nr; /*!< Timeslot Number */
Harald Welteec8b4502010-02-20 20:34:29 +010068} __attribute__ ((packed));
69
Vadim Yanitskiy1d32b7f2019-05-24 18:35:22 +070070/*! OML FOM header */
Harald Welteec8b4502010-02-20 20:34:29 +010071struct abis_om_fom_hdr {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020072 uint8_t msg_type; /*!< Message Type (\ref abis_nm_msgtype) */
73 uint8_t obj_class; /*!< Object Class (\ref abis_nm_obj_class) */
74 struct abis_om_obj_inst obj_inst; /*!< Object Instance */
75 uint8_t data[0]; /*!< Data */
Harald Welteec8b4502010-02-20 20:34:29 +010076} __attribute__ ((packed));
77
Neels Hofmeyr87e45502017-06-20 00:17:59 +020078/*! Size of the OML FOM header in octets */
Harald Welteec8b4502010-02-20 20:34:29 +010079#define ABIS_OM_FOM_HDR_SIZE (sizeof(struct abis_om_hdr) + sizeof(struct abis_om_fom_hdr))
80
Neels Hofmeyr87e45502017-06-20 00:17:59 +020081/*! OML Message Type (Section 9.1) */
Harald Welteec8b4502010-02-20 20:34:29 +010082enum abis_nm_msgtype {
83 /* SW Download Management Messages */
84 NM_MT_LOAD_INIT = 0x01,
85 NM_MT_LOAD_INIT_ACK,
86 NM_MT_LOAD_INIT_NACK,
87 NM_MT_LOAD_SEG,
88 NM_MT_LOAD_SEG_ACK,
89 NM_MT_LOAD_ABORT,
90 NM_MT_LOAD_END,
91 NM_MT_LOAD_END_ACK,
92 NM_MT_LOAD_END_NACK,
93 NM_MT_SW_ACT_REQ, /* BTS->BSC */
94 NM_MT_SW_ACT_REQ_ACK,
95 NM_MT_SW_ACT_REQ_NACK,
96 NM_MT_ACTIVATE_SW, /* BSC->BTS */
97 NM_MT_ACTIVATE_SW_ACK,
98 NM_MT_ACTIVATE_SW_NACK,
99 NM_MT_SW_ACTIVATED_REP, /* 0x10 */
100 /* A-bis Interface Management Messages */
101 NM_MT_ESTABLISH_TEI = 0x21,
102 NM_MT_ESTABLISH_TEI_ACK,
103 NM_MT_ESTABLISH_TEI_NACK,
104 NM_MT_CONN_TERR_SIGN,
105 NM_MT_CONN_TERR_SIGN_ACK,
106 NM_MT_CONN_TERR_SIGN_NACK,
107 NM_MT_DISC_TERR_SIGN,
108 NM_MT_DISC_TERR_SIGN_ACK,
109 NM_MT_DISC_TERR_SIGN_NACK,
110 NM_MT_CONN_TERR_TRAF,
111 NM_MT_CONN_TERR_TRAF_ACK,
112 NM_MT_CONN_TERR_TRAF_NACK,
113 NM_MT_DISC_TERR_TRAF,
114 NM_MT_DISC_TERR_TRAF_ACK,
115 NM_MT_DISC_TERR_TRAF_NACK,
116 /* Transmission Management Messages */
117 NM_MT_CONN_MDROP_LINK = 0x31,
118 NM_MT_CONN_MDROP_LINK_ACK,
119 NM_MT_CONN_MDROP_LINK_NACK,
120 NM_MT_DISC_MDROP_LINK,
121 NM_MT_DISC_MDROP_LINK_ACK,
122 NM_MT_DISC_MDROP_LINK_NACK,
123 /* Air Interface Management Messages */
124 NM_MT_SET_BTS_ATTR = 0x41,
125 NM_MT_SET_BTS_ATTR_ACK,
126 NM_MT_SET_BTS_ATTR_NACK,
127 NM_MT_SET_RADIO_ATTR,
128 NM_MT_SET_RADIO_ATTR_ACK,
129 NM_MT_SET_RADIO_ATTR_NACK,
130 NM_MT_SET_CHAN_ATTR,
131 NM_MT_SET_CHAN_ATTR_ACK,
132 NM_MT_SET_CHAN_ATTR_NACK,
133 /* Test Management Messages */
134 NM_MT_PERF_TEST = 0x51,
135 NM_MT_PERF_TEST_ACK,
136 NM_MT_PERF_TEST_NACK,
137 NM_MT_TEST_REP,
138 NM_MT_SEND_TEST_REP,
139 NM_MT_SEND_TEST_REP_ACK,
140 NM_MT_SEND_TEST_REP_NACK,
141 NM_MT_STOP_TEST,
142 NM_MT_STOP_TEST_ACK,
143 NM_MT_STOP_TEST_NACK,
144 /* State Management and Event Report Messages */
145 NM_MT_STATECHG_EVENT_REP = 0x61,
146 NM_MT_FAILURE_EVENT_REP,
147 NM_MT_STOP_EVENT_REP,
148 NM_MT_STOP_EVENT_REP_ACK,
149 NM_MT_STOP_EVENT_REP_NACK,
150 NM_MT_REST_EVENT_REP,
151 NM_MT_REST_EVENT_REP_ACK,
152 NM_MT_REST_EVENT_REP_NACK,
153 NM_MT_CHG_ADM_STATE,
154 NM_MT_CHG_ADM_STATE_ACK,
155 NM_MT_CHG_ADM_STATE_NACK,
156 NM_MT_CHG_ADM_STATE_REQ,
157 NM_MT_CHG_ADM_STATE_REQ_ACK,
158 NM_MT_CHG_ADM_STATE_REQ_NACK,
159 NM_MT_REP_OUTST_ALARMS = 0x93,
160 NM_MT_REP_OUTST_ALARMS_ACK,
161 NM_MT_REP_OUTST_ALARMS_NACK,
162 /* Equipment Management Messages */
163 NM_MT_CHANGEOVER = 0x71,
164 NM_MT_CHANGEOVER_ACK,
165 NM_MT_CHANGEOVER_NACK,
166 NM_MT_OPSTART,
167 NM_MT_OPSTART_ACK,
168 NM_MT_OPSTART_NACK,
169 NM_MT_REINIT,
170 NM_MT_REINIT_ACK,
171 NM_MT_REINIT_NACK,
172 NM_MT_SET_SITE_OUT, /* BS11: get alarm ?!? */
173 NM_MT_SET_SITE_OUT_ACK,
174 NM_MT_SET_SITE_OUT_NACK,
175 NM_MT_CHG_HW_CONF = 0x90,
176 NM_MT_CHG_HW_CONF_ACK,
177 NM_MT_CHG_HW_CONF_NACK,
178 /* Measurement Management Messages */
179 NM_MT_MEAS_RES_REQ = 0x8a,
180 NM_MT_MEAS_RES_RESP,
181 NM_MT_STOP_MEAS,
182 NM_MT_START_MEAS,
183 /* Other Messages */
184 NM_MT_GET_ATTR = 0x81,
185 NM_MT_GET_ATTR_RESP,
186 NM_MT_GET_ATTR_NACK,
187 NM_MT_SET_ALARM_THRES,
188 NM_MT_SET_ALARM_THRES_ACK,
189 NM_MT_SET_ALARM_THRES_NACK,
190};
191
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200192/*! Siemens specific OML Message Types */
Harald Welteec8b4502010-02-20 20:34:29 +0100193enum abis_nm_msgtype_bs11 {
194 NM_MT_BS11_RESET_RESOURCE = 0x74,
195
196 NM_MT_BS11_BEGIN_DB_TX = 0xa3,
197 NM_MT_BS11_BEGIN_DB_TX_ACK,
198 NM_MT_BS11_BEGIN_DB_TX_NACK,
199 NM_MT_BS11_END_DB_TX = 0xa6,
200 NM_MT_BS11_END_DB_TX_ACK,
201 NM_MT_BS11_END_DB_TX_NACK,
202 NM_MT_BS11_CREATE_OBJ = 0xa9,
203 NM_MT_BS11_CREATE_OBJ_ACK,
204 NM_MT_BS11_CREATE_OBJ_NACK,
205 NM_MT_BS11_DELETE_OBJ = 0xac,
206 NM_MT_BS11_DELETE_OBJ_ACK,
207 NM_MT_BS11_DELETE_OBJ_NACK,
208
209 NM_MT_BS11_SET_ATTR = 0xd0,
210 NM_MT_BS11_SET_ATTR_ACK,
211 NM_MT_BS11_SET_ATTR_NACK,
212 NM_MT_BS11_LMT_SESSION = 0xdc,
213
214 NM_MT_BS11_GET_STATE = 0xe3,
215 NM_MT_BS11_GET_STATE_ACK,
216 NM_MT_BS11_LMT_LOGON = 0xe5,
217 NM_MT_BS11_LMT_LOGON_ACK,
218 NM_MT_BS11_RESTART = 0xe7,
219 NM_MT_BS11_RESTART_ACK,
220 NM_MT_BS11_DISCONNECT = 0xe9,
221 NM_MT_BS11_DISCONNECT_ACK,
222 NM_MT_BS11_LMT_LOGOFF = 0xec,
223 NM_MT_BS11_LMT_LOGOFF_ACK,
224 NM_MT_BS11_RECONNECT = 0xf1,
225 NM_MT_BS11_RECONNECT_ACK,
226};
227
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200228/*! ip.access specific OML Message Types */
Harald Welteec8b4502010-02-20 20:34:29 +0100229enum abis_nm_msgtype_ipacc {
230 NM_MT_IPACC_RESTART = 0x87,
231 NM_MT_IPACC_RESTART_ACK,
232 NM_MT_IPACC_RESTART_NACK,
233 NM_MT_IPACC_RSL_CONNECT = 0xe0,
234 NM_MT_IPACC_RSL_CONNECT_ACK,
235 NM_MT_IPACC_RSL_CONNECT_NACK,
236 NM_MT_IPACC_RSL_DISCONNECT = 0xe3,
237 NM_MT_IPACC_RSL_DISCONNECT_ACK,
238 NM_MT_IPACC_RSL_DISCONNECT_NACK,
239 NM_MT_IPACC_CONN_TRAF = 0xe6,
240 NM_MT_IPACC_CONN_TRAF_ACK,
241 NM_MT_IPACC_CONN_TRAF_NACK,
242 NM_MT_IPACC_DEF_BOOT_SW = 0xec,
243 NM_MT_IPACC_DEF_BOOT_SW_ACK,
244 MN_MT_IPACC_DEF_BOOT_SW_NACK,
245 NM_MT_IPACC_SET_NVATTR = 0xef,
246 NM_MT_IPACC_SET_NVATTR_ACK,
247 NM_MT_IPACC_SET_NVATTR_NACK,
248 NM_MT_IPACC_GET_NVATTR = 0xf2,
249 NM_MT_IPACC_GET_NVATTR_ACK,
250 NM_MT_IPACC_GET_NVATTR_NACK,
251 NM_MT_IPACC_SET_ATTR = 0xf5,
252 NM_MT_IPACC_SET_ATTR_ACK,
253 NM_MT_IPACC_SET_ATTR_NACK,
254};
255
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200256/*! OML Probable Cause (Section 9.4.43) Manufacturer specific values */
Minh-Quang Nguyen592fcc92017-01-02 14:52:16 +0100257enum abis_mm_event_causes {
258 /* Critical causes */
259 OSMO_EVT_CRIT_SW_FATAL = 0x0000,
260 OSMO_EVT_CRIT_PROC_STOP = 0x0002,
261 OSMO_EVT_CRIT_RTP_TOUT = 0x032c,
262 OSMO_EVT_CRIT_BOOT_FAIL = 0x0401,
263 /* Major causes */
264 OSMO_EVT_MAJ_UKWN_MSG = 0x0002,
265 OSMO_EVT_MAJ_RSL_FAIL = 0x0309,
266 OSMO_EVT_MAJ_UNSUP_ATTR = 0x0318,
267 OSMO_EVT_MAJ_NET_CONGEST = 0x032b,
268 /* Minor causes */
269 OSMO_EVT_MIN_PAG_TAB_FULL = 0x0401,
270 /* Warning causes */
271 OSMO_EVT_WARN_SW_WARN = 0x0001,
Max319f3212017-01-11 14:10:58 +0100272 /* External causes */
273 OSMO_EVT_EXT_ALARM = 0xfeed,
Max7f9c7e72017-03-15 12:02:22 +0100274 OSMO_EVT_PCU_VERS = 0xface,
Minh-Quang Nguyen592fcc92017-01-02 14:52:16 +0100275};
276
Max07352fe2017-01-02 19:05:25 +0100277extern const struct value_string abis_mm_event_cause_names[];
278
Harald Welteec8b4502010-02-20 20:34:29 +0100279enum abis_nm_bs11_cell_alloc {
280 NM_BS11_CANR_GSM = 0x00,
281 NM_BS11_CANR_DCS1800 = 0x01,
282};
283
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200284/*! OML Object Class (Section 9.2) */
Harald Welteec8b4502010-02-20 20:34:29 +0100285enum abis_nm_obj_class {
286 NM_OC_SITE_MANAGER = 0x00,
287 NM_OC_BTS,
288 NM_OC_RADIO_CARRIER,
289 NM_OC_CHANNEL,
290 NM_OC_BASEB_TRANSC,
291 /* RFU: 05-FE */
292
293 NM_OC_IPAC_E1_TRUNK = 0x0e,
294 NM_OC_IPAC_E1_PORT = 0x0f,
295 NM_OC_IPAC_E1_CHAN = 0x10,
296 NM_OC_IPAC_CLK_MODULE = 0x22,
297
298 NM_OC_BS11_ADJC = 0xa0,
299 NM_OC_BS11_HANDOVER = 0xa1,
300 NM_OC_BS11_PWR_CTRL = 0xa2,
301 NM_OC_BS11_BTSE = 0xa3, /* LMT? */
302 NM_OC_BS11_RACK = 0xa4,
303 NM_OC_BS11 = 0xa5, /* 01: ALCO */
304 NM_OC_BS11_TEST = 0xa6,
305 NM_OC_BS11_ENVABTSE = 0xa8,
306 NM_OC_BS11_BPORT = 0xa9,
307
308 NM_OC_GPRS_NSE = 0xf0,
309 NM_OC_GPRS_CELL = 0xf1,
310 NM_OC_GPRS_NSVC = 0xf2,
311
312 NM_OC_NULL = 0xff,
313};
314
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200315/*! OML Attributes / IEs (Section 9.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100316enum abis_nm_attr {
317 NM_ATT_ABIS_CHANNEL = 0x01,
318 NM_ATT_ADD_INFO,
319 NM_ATT_ADD_TEXT,
320 NM_ATT_ADM_STATE,
321 NM_ATT_ARFCN_LIST,
322 NM_ATT_AUTON_REPORT,
323 NM_ATT_AVAIL_STATUS,
324 NM_ATT_BCCH_ARFCN,
325 NM_ATT_BSIC,
326 NM_ATT_BTS_AIR_TIMER,
327 NM_ATT_CCCH_L_I_P,
328 NM_ATT_CCCH_L_T,
329 NM_ATT_CHAN_COMB,
330 NM_ATT_CONN_FAIL_CRIT,
331 NM_ATT_DEST,
332 /* res */
333 NM_ATT_EVENT_TYPE = 0x11, /* BS11: file data ?!? */
334 NM_ATT_FILE_ID,
335 NM_ATT_FILE_VERSION,
336 NM_ATT_GSM_TIME,
337 NM_ATT_HSN,
338 NM_ATT_HW_CONFIG,
339 NM_ATT_HW_DESC,
340 NM_ATT_INTAVE_PARAM,
341 NM_ATT_INTERF_BOUND,
342 NM_ATT_LIST_REQ_ATTR,
343 NM_ATT_MAIO,
344 NM_ATT_MANUF_STATE,
345 NM_ATT_MANUF_THRESH,
346 NM_ATT_MANUF_ID,
347 NM_ATT_MAX_TA,
348 NM_ATT_MDROP_LINK, /* 0x20 */
349 NM_ATT_MDROP_NEXT,
350 NM_ATT_NACK_CAUSES,
351 NM_ATT_NY1,
352 NM_ATT_OPER_STATE,
353 NM_ATT_OVERL_PERIOD,
354 NM_ATT_PHYS_CONF,
355 NM_ATT_POWER_CLASS,
356 NM_ATT_POWER_THRESH,
357 NM_ATT_PROB_CAUSE,
358 NM_ATT_RACH_B_THRESH,
359 NM_ATT_LDAVG_SLOTS,
360 NM_ATT_RAD_SUBC,
361 NM_ATT_RF_MAXPOWR_R,
362 NM_ATT_SITE_INPUTS,
363 NM_ATT_SITE_OUTPUTS,
364 NM_ATT_SOURCE, /* 0x30 */
365 NM_ATT_SPEC_PROB,
366 NM_ATT_START_TIME,
367 NM_ATT_T200,
368 NM_ATT_TEI,
369 NM_ATT_TEST_DUR,
370 NM_ATT_TEST_NO,
371 NM_ATT_TEST_REPORT,
372 NM_ATT_VSWR_THRESH,
373 NM_ATT_WINDOW_SIZE,
374 /* Res */
375 NM_ATT_BS11_RSSI_OFFS = 0x3d,
376 NM_ATT_BS11_TXPWR = 0x3e,
377 NM_ATT_BS11_DIVERSITY = 0x3f,
378 /* Res */
379 NM_ATT_TSC = 0x40,
380 NM_ATT_SW_CONFIG,
381 NM_ATT_SW_DESCR,
382 NM_ATT_SEVERITY,
383 NM_ATT_GET_ARI,
384 NM_ATT_HW_CONF_CHG,
385 NM_ATT_OUTST_ALARM,
386 NM_ATT_FILE_DATA,
387 NM_ATT_MEAS_RES,
388 NM_ATT_MEAS_TYPE,
389
390 NM_ATT_BS11_ESN_FW_CODE_NO = 0x4c,
391 NM_ATT_BS11_ESN_HW_CODE_NO = 0x4f,
392
393 NM_ATT_BS11_ESN_PCB_SERIAL = 0x55,
394 NM_ATT_BS11_EXCESSIVE_DISTANCE = 0x58,
395
396 NM_ATT_BS11_ALL_TEST_CATG = 0x60,
397 NM_ATT_BS11_BTSLS_HOPPING,
398 NM_ATT_BS11_CELL_ALLOC_NR,
399 NM_ATT_BS11_CELL_GLOBAL_ID,
400 NM_ATT_BS11_ENA_INTERF_CLASS = 0x66,
401 NM_ATT_BS11_ENA_INT_INTEC_HANDO = 0x67,
402 NM_ATT_BS11_ENA_INT_INTRC_HANDO = 0x68,
403 NM_ATT_BS11_ENA_MS_PWR_CTRL = 0x69,
404 NM_ATT_BS11_ENA_PWR_BDGT_HO = 0x6a,
405 NM_ATT_BS11_ENA_PWR_CTRL_RLFW = 0x6b,
406 NM_ATT_BS11_ENA_RXLEV_HO = 0x6c,
407 NM_ATT_BS11_ENA_RXQUAL_HO = 0x6d,
408 NM_ATT_BS11_FACCH_QUAL = 0x6e,
409
410 NM_ATT_IPACC_DST_IP = 0x80,
411 NM_ATT_IPACC_DST_IP_PORT = 0x81,
412 NM_ATT_IPACC_SSRC = 0x82,
413 NM_ATT_IPACC_RTP_PAYLD_TYPE = 0x83,
414 NM_ATT_IPACC_BASEB_ID = 0x84,
415 NM_ATT_IPACC_STREAM_ID = 0x85,
416 NM_ATT_IPACC_NV_FLAGS = 0x86,
417 NM_ATT_IPACC_FREQ_CTRL = 0x87,
418 NM_ATT_IPACC_PRIM_OML_CFG = 0x88,
419 NM_ATT_IPACC_SEC_OML_CFG = 0x89,
420 NM_ATT_IPACC_IP_IF_CFG = 0x8a, /* IP interface */
421 NM_ATT_IPACC_IP_GW_CFG = 0x8b, /* IP gateway */
422 NM_ATT_IPACC_IN_SERV_TIME = 0x8c,
423 NM_ATT_IPACC_TRX_BTS_ASS = 0x8d,
424 NM_ATT_IPACC_LOCATION = 0x8e, /* string describing location */
425 NM_ATT_IPACC_PAGING_CFG = 0x8f,
426 NM_ATT_IPACC_FILE_DATA = 0x90,
427 NM_ATT_IPACC_UNIT_ID = 0x91, /* Site/BTS/TRX */
428 NM_ATT_IPACC_PARENT_UNIT_ID = 0x92,
429 NM_ATT_IPACC_UNIT_NAME = 0x93, /* default: nbts-<mac-as-string> */
430 NM_ATT_IPACC_SNMP_CFG = 0x94,
431 NM_ATT_IPACC_PRIM_OML_CFG_LIST = 0x95,
432 NM_ATT_IPACC_PRIM_OML_FB_TOUT = 0x96,
433 NM_ATT_IPACC_CUR_SW_CFG = 0x97,
434 NM_ATT_IPACC_TIMING_BUS = 0x98,
435 NM_ATT_IPACC_CGI = 0x99,
436 NM_ATT_IPACC_RAC = 0x9a,
437 NM_ATT_IPACC_OBJ_VERSION = 0x9b,
438 NM_ATT_IPACC_GPRS_PAGING_CFG = 0x9c,
439 NM_ATT_IPACC_NSEI = 0x9d,
440 NM_ATT_IPACC_BVCI = 0x9e,
441 NM_ATT_IPACC_NSVCI = 0x9f,
442 NM_ATT_IPACC_NS_CFG = 0xa0,
443 NM_ATT_IPACC_BSSGP_CFG = 0xa1,
444 NM_ATT_IPACC_NS_LINK_CFG = 0xa2,
Pau Espin Pedrol3265ded2021-06-28 12:09:29 +0200445 NM_ATT_IPACC_RLC_CFG = 0xa3,
Harald Welteec8b4502010-02-20 20:34:29 +0100446 NM_ATT_IPACC_ALM_THRESH_LIST = 0xa4,
447 NM_ATT_IPACC_MONIT_VAL_LIST = 0xa5,
448 NM_ATT_IPACC_TIB_CONTROL = 0xa6,
449 NM_ATT_IPACC_SUPP_FEATURES = 0xa7,
450 NM_ATT_IPACC_CODING_SCHEMES = 0xa8,
451 NM_ATT_IPACC_RLC_CFG_2 = 0xa9,
452 NM_ATT_IPACC_HEARTB_TOUT = 0xaa,
453 NM_ATT_IPACC_UPTIME = 0xab,
454 NM_ATT_IPACC_RLC_CFG_3 = 0xac,
455 NM_ATT_IPACC_SSL_CFG = 0xad,
456 NM_ATT_IPACC_SEC_POSSIBLE = 0xae,
457 NM_ATT_IPACC_IML_SSL_STATE = 0xaf,
458 NM_ATT_IPACC_REVOC_DATE = 0xb0,
459
460
461 NM_ATT_BS11_RF_RES_IND_PER = 0x8f,
Pau Espin Pedrol3265ded2021-06-28 12:09:29 +0200462
Harald Welteec8b4502010-02-20 20:34:29 +0100463 NM_ATT_BS11_RX_LEV_MIN_CELL = 0x90,
464 NM_ATT_BS11_ABIS_EXT_TIME = 0x91,
465 NM_ATT_BS11_TIMER_HO_REQUEST = 0x92,
466 NM_ATT_BS11_TIMER_NCELL = 0x93,
467 NM_ATT_BS11_TSYNC = 0x94,
468 NM_ATT_BS11_TTRAU = 0x95,
469 NM_ATT_BS11_EMRG_CFG_MEMBER = 0x9b,
470 NM_ATT_BS11_TRX_AREA = 0x9f,
471
472 NM_ATT_BS11_BCCH_RECONF = 0xd7,
473 NM_ATT_BS11_BIT_ERR_THESH = 0xa0,
474 NM_ATT_BS11_BOOT_SW_VERS = 0xa1,
475 NM_ATT_BS11_CCLK_ACCURACY = 0xa3,
476 NM_ATT_BS11_CCLK_TYPE = 0xa4,
477 NM_ATT_BS11_INP_IMPEDANCE = 0xaa,
478 NM_ATT_BS11_L1_PROT_TYPE = 0xab,
479 NM_ATT_BS11_LINE_CFG = 0xac,
480 NM_ATT_BS11_LI_PORT_1 = 0xad,
481 NM_ATT_BS11_LI_PORT_2 = 0xae,
482
483 NM_ATT_BS11_L1_REM_ALM_TYPE = 0xb0,
484 NM_ATT_BS11_SW_LOAD_INTENDED = 0xbb,
485 NM_ATT_BS11_SW_LOAD_SAFETY = 0xbc,
486 NM_ATT_BS11_SW_LOAD_STORED = 0xbd,
487
488 NM_ATT_BS11_VENDOR_NAME = 0xc1,
489 NM_ATT_BS11_HOPPING_MODE = 0xc5,
490 NM_ATT_BS11_LMT_LOGON_SESSION = 0xc6,
491 NM_ATT_BS11_LMT_LOGIN_TIME = 0xc7,
492 NM_ATT_BS11_LMT_USER_ACC_LEV = 0xc8,
493 NM_ATT_BS11_LMT_USER_NAME = 0xc9,
494
495 NM_ATT_BS11_L1_CONTROL_TS = 0xd8,
496 NM_ATT_BS11_RADIO_MEAS_GRAN = 0xdc, /* in SACCH multiframes */
497 NM_ATT_BS11_RADIO_MEAS_REP = 0xdd,
498
499 NM_ATT_BS11_SH_LAPD_INT_TIMER = 0xe8,
500
501 NM_ATT_BS11_BTS_STATE = 0xf0,
502 NM_ATT_BS11_E1_STATE = 0xf1,
503 NM_ATT_BS11_PLL = 0xf2,
504 NM_ATT_BS11_RX_OFFSET = 0xf3,
505 NM_ATT_BS11_ANT_TYPE = 0xf4,
506 NM_ATT_BS11_PLL_MODE = 0xfc,
507 NM_ATT_BS11_PASSWORD = 0xfd,
รlvaro Neira Ayusoc22d72c2014-05-05 16:04:02 +0200508
Harald Welte5b5650f2014-05-19 11:25:46 +0200509 /* osmocom (osmo-bts) specific attributes, used in combination
510 * with the "org.osmocom" manufacturer identification */
Alexander Couzens6300aff2020-06-07 22:56:02 +0200511 NM_ATT_OSMO_NS_LINK_CFG = 0xfd, /* osmocom version supports IPv4 & IPv6 in difference to IPACC */
Harald Welte5b5650f2014-05-19 11:25:46 +0200512 NM_ATT_OSMO_REDUCEPOWER = 0xfe, /* TLV_TYPE_TV */
Harald Welteec8b4502010-02-20 20:34:29 +0100513};
514#define NM_ATT_BS11_FILE_DATA NM_ATT_EVENT_TYPE
515
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200516/*! OML Administrative State (Section 9.4.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100517enum abis_nm_adm_state {
518 NM_STATE_LOCKED = 0x01,
519 NM_STATE_UNLOCKED = 0x02,
520 NM_STATE_SHUTDOWN = 0x03,
521 NM_STATE_NULL = 0xff,
522};
523
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200524/*! OML Availability State (Section 9.4.7) */
Harald Welteec8b4502010-02-20 20:34:29 +0100525enum abis_nm_avail_state {
Pau Espin Pedrol7813cc92022-05-04 17:04:02 +0200526 NM_AVSTATE_IN_TEST = 0,
527 NM_AVSTATE_FAILED = 1,
Harald Welteec8b4502010-02-20 20:34:29 +0100528 NM_AVSTATE_POWER_OFF = 2,
529 NM_AVSTATE_OFF_LINE = 3,
Pau Espin Pedrol7813cc92022-05-04 17:04:02 +0200530 /* <not used> = 4, */
Harald Welteec8b4502010-02-20 20:34:29 +0100531 NM_AVSTATE_DEPENDENCY = 5,
532 NM_AVSTATE_DEGRADED = 6,
533 NM_AVSTATE_NOT_INSTALLED= 7,
534 NM_AVSTATE_OK = 0xff,
535};
536
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200537/*! OML Operational State */
Harald Welteec8b4502010-02-20 20:34:29 +0100538enum abis_nm_op_state {
539 NM_OPSTATE_DISABLED = 1,
540 NM_OPSTATE_ENABLED = 2,
541 NM_OPSTATE_NULL = 0xff,
542};
543
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200544/* Channel Combination (Section 9.4.13) */
Harald Welteec8b4502010-02-20 20:34:29 +0100545enum abis_nm_chan_comb {
546 NM_CHANC_TCHFull = 0x00, /* TCH/F + TCH/H + SACCH/TF */
547 NM_CHANC_TCHHalf = 0x01, /* TCH/H(0,1) + FACCH/H(0,1) +
548 SACCH/TH(0,1) */
549 NM_CHANC_TCHHalf2 = 0x02, /* TCH/H(0) + FACCH/H(0) + SACCH/TH(0) +
550 TCH/H(1) */
551 NM_CHANC_SDCCH = 0x03, /* SDCCH/8 + SACCH/8 */
552 NM_CHANC_mainBCCH = 0x04, /* FCCH + SCH + BCCH + CCCH */
553 NM_CHANC_BCCHComb = 0x05, /* FCCH + SCH + BCCH + CCCH + SDCCH/4 +
554 SACCH/C4 */
555 NM_CHANC_BCCH = 0x06, /* BCCH + CCCH */
556 NM_CHANC_BCCH_CBCH = 0x07, /* CHANC_BCCHComb + CBCH */
557 NM_CHANC_SDCCH_CBCH = 0x08, /* CHANC_SDCCH8 + CBCH */
558 /* ip.access */
559 NM_CHANC_IPAC_bPDCH = 0x0b, /* PBCCH + PCCCH + PDTCH/F + PACCH/F +
560 PTCCH/F */
561 NM_CHANC_IPAC_cPDCH = 0x0c, /* PBCCH + PDTCH/F + PACCH/F + PTCCH/F */
562 NM_CHANC_IPAC_PDCH = 0x0d, /* PDTCH/F + PACCH/F + PTCCH/F */
563 NM_CHANC_IPAC_TCHFull_PDCH = 0x80,
564 NM_CHANC_IPAC_TCHFull_TCHHalf = 0x81,
Neels Hofmeyrfd80f5a2016-07-14 03:21:05 +0200565 /* osmocom */
Pau Espin Pedrol45dc9d02021-06-28 12:12:53 +0200566 NM_CHANC_OSMO_DYN = 0x90,
Harald Welteec8b4502010-02-20 20:34:29 +0100567};
Pau Espin Pedrol45dc9d02021-06-28 12:12:53 +0200568/* Backward compatibility with older naming: */
569#define NM_CHANC_OSMO_TCHFull_TCHHalf_PDCH NM_CHANC_OSMO_DYN
Harald Welteec8b4502010-02-20 20:34:29 +0100570
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200571/*! Event Type (Section 9.4.16) */
Harald Welteec8b4502010-02-20 20:34:29 +0100572enum abis_nm_event_type {
573 NM_EVT_COMM_FAIL = 0x00,
574 NM_EVT_QOS_FAIL = 0x01,
575 NM_EVT_PROC_FAIL = 0x02,
576 NM_EVT_EQUIP_FAIL = 0x03,
577 NM_EVT_ENV_FAIL = 0x04,
578};
579
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200580/*! Perceived Severity (Section: 9.4.63) */
Harald Welteec8b4502010-02-20 20:34:29 +0100581enum abis_nm_severity {
582 NM_SEVER_CEASED = 0x00,
583 NM_SEVER_CRITICAL = 0x01,
584 NM_SEVER_MAJOR = 0x02,
585 NM_SEVER_MINOR = 0x03,
586 NM_SEVER_WARNING = 0x04,
587 NM_SEVER_INDETERMINATE = 0x05,
588};
589
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200590/*! Probable Cause Type (Section 9.4.43) */
Harald Welteec8b4502010-02-20 20:34:29 +0100591enum abis_nm_pcause_type {
592 NM_PCAUSE_T_X721 = 0x01,
593 NM_PCAUSE_T_GSM = 0x02,
594 NM_PCAUSE_T_MANUF = 0x03,
595};
596
Max85908a92017-01-10 17:49:23 +0100597extern const struct value_string abis_nm_pcause_type_names[];
Max5d994e42017-03-22 15:20:39 +0100598extern const struct value_string abis_nm_msgtype_names[];
Max62d6f252017-03-21 16:55:45 +0100599extern const struct value_string abis_nm_att_names[];
Max85908a92017-01-10 17:49:23 +0100600
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200601/*! NACK causes (Section 9.4.36) */
Harald Welteec8b4502010-02-20 20:34:29 +0100602enum abis_nm_nack_cause {
603 /* General Nack Causes */
604 NM_NACK_INCORR_STRUCT = 0x01,
605 NM_NACK_MSGTYPE_INVAL = 0x02,
606 NM_NACK_OBJCLASS_INVAL = 0x05,
607 NM_NACK_OBJCLASS_NOTSUPP = 0x06,
608 NM_NACK_BTSNR_UNKN = 0x07,
609 NM_NACK_TRXNR_UNKN = 0x08,
610 NM_NACK_OBJINST_UNKN = 0x09,
611 NM_NACK_ATTRID_INVAL = 0x0c,
612 NM_NACK_ATTRID_NOTSUPP = 0x0d,
613 NM_NACK_PARAM_RANGE = 0x0e,
614 NM_NACK_ATTRLIST_INCONSISTENT = 0x0f,
615 NM_NACK_SPEC_IMPL_NOTSUPP = 0x10,
616 NM_NACK_CANT_PERFORM = 0x11,
617 /* Specific Nack Causes */
618 NM_NACK_RES_NOTIMPL = 0x19,
619 NM_NACK_RES_NOTAVAIL = 0x1a,
620 NM_NACK_FREQ_NOTAVAIL = 0x1b,
621 NM_NACK_TEST_NOTSUPP = 0x1c,
622 NM_NACK_CAPACITY_RESTR = 0x1d,
623 NM_NACK_PHYSCFG_NOTPERFORM = 0x1e,
624 NM_NACK_TEST_NOTINIT = 0x1f,
625 NM_NACK_PHYSCFG_NOTRESTORE = 0x20,
626 NM_NACK_TEST_NOSUCH = 0x21,
627 NM_NACK_TEST_NOSTOP = 0x22,
628 NM_NACK_MSGINCONSIST_PHYSCFG = 0x23,
629 NM_NACK_FILE_INCOMPLETE = 0x25,
630 NM_NACK_FILE_NOTAVAIL = 0x26,
631 NM_NACK_FILE_NOTACTIVATE = 0x27,
632 NM_NACK_REQ_NOT_GRANT = 0x28,
633 NM_NACK_WAIT = 0x29,
634 NM_NACK_NOTH_REPORT_EXIST = 0x2a,
635 NM_NACK_MEAS_NOTSUPP = 0x2b,
636 NM_NACK_MEAS_NOTSTART = 0x2c,
637};
638
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200639/*! Abis OML Channel (Section 9.4.1) */
Harald Welteec8b4502010-02-20 20:34:29 +0100640struct abis_nm_channel {
641 uint8_t attrib;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200642 uint8_t bts_port; /*!< BTS port number */
643 uint8_t timeslot; /*!< E1 timeslot */
644 uint8_t subslot; /*!< E1 sub-slot */
Harald Welteec8b4502010-02-20 20:34:29 +0100645} __attribute__ ((packed));
646
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200647/*! 3GPP TS 12.21 9.4.53 T200 index */
Max0bee65c2017-01-02 13:42:24 +0100648enum abis_nm_t200_idx {
649 T200_SDCCH = 0,
650 T200_FACCH_F = 1,
651 T200_FACCH_H = 2,
652 T200_SACCH_TCH_SAPI0 = 3,
653 T200_SACCH_SDCCH = 4,
654 T200_SDCCH_SAPI3 = 5,
655 T200_SACCH_TCH_SAPI3 = 6
656};
657
658extern const uint8_t abis_nm_t200_ms[];
659
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200660/*! Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */
Harald Welteec8b4502010-02-20 20:34:29 +0100661enum abis_bs11_objtype {
662 BS11_OBJ_ALCO = 0x01,
663 BS11_OBJ_BBSIG = 0x02, /* obj_class: 0,1 */
664 BS11_OBJ_TRX1 = 0x03, /* only DEACTIVATE TRX1 */
665 BS11_OBJ_CCLK = 0x04,
666 BS11_OBJ_GPSU = 0x06,
667 BS11_OBJ_LI = 0x07,
668 BS11_OBJ_PA = 0x09, /* obj_class: 0, 1*/
669};
670
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200671/*! Siemens BS11 TRX power */
Harald Welteec8b4502010-02-20 20:34:29 +0100672enum abis_bs11_trx_power {
673 BS11_TRX_POWER_GSM_2W = 0x06,
674 BS11_TRX_POWER_GSM_250mW= 0x07,
675 BS11_TRX_POWER_GSM_80mW = 0x08,
676 BS11_TRX_POWER_GSM_30mW = 0x09,
677 BS11_TRX_POWER_DCS_3W = 0x0a,
678 BS11_TRX_POWER_DCS_1W6 = 0x0b,
679 BS11_TRX_POWER_DCS_500mW= 0x0c,
680 BS11_TRX_POWER_DCS_160mW= 0x0d,
681};
682
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200683/*! Siemens BS11 PLL mode */
Harald Welteec8b4502010-02-20 20:34:29 +0100684enum abis_bs11_li_pll_mode {
685 BS11_LI_PLL_LOCKED = 2,
686 BS11_LI_PLL_STANDALONE = 3,
687};
688
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200689/*! Siemens BS11 E1 line configuration */
Harald Welteec8b4502010-02-20 20:34:29 +0100690enum abis_bs11_line_cfg {
691 BS11_LINE_CFG_STAR = 0x00,
692 BS11_LINE_CFG_MULTIDROP = 0x01,
693 BS11_LINE_CFG_LOOP = 0x02,
694};
695
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200696/*! Siemens BS11 boot phase */
Harald Welteec8b4502010-02-20 20:34:29 +0100697enum abis_bs11_phase {
698 BS11_STATE_SOFTWARE_RQD = 0x01,
699 BS11_STATE_LOAD_SMU_INTENDED = 0x11,
700 BS11_STATE_LOAD_SMU_SAFETY = 0x21,
701 BS11_STATE_LOAD_FAILED = 0x31,
702 BS11_STATE_LOAD_DIAGNOSTIC = 0x41,
703 BS11_STATE_WARM_UP = 0x51,
704 BS11_STATE_WARM_UP_2 = 0x52,
705 BS11_STATE_WAIT_MIN_CFG = 0x62,
706 BS11_STATE_MAINTENANCE = 0x72,
707 BS11_STATE_LOAD_MBCCU = 0x92,
708 BS11_STATE_WAIT_MIN_CFG_2 = 0xA2,
709 BS11_STATE_NORMAL = 0x03,
710 BS11_STATE_ABIS_LOAD = 0x13,
711};
712
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200713/*! ip.access test number */
Harald Welteec8b4502010-02-20 20:34:29 +0100714enum abis_nm_ipacc_test_no {
715 NM_IPACC_TESTNO_RLOOP_ANT = 0x01,
716 NM_IPACC_TESTNO_RLOOP_XCVR = 0x02,
717 NM_IPACC_TESTNO_FUNC_OBJ = 0x03,
718 NM_IPACC_TESTNO_CHAN_USAGE = 0x40,
719 NM_IPACC_TESTNO_BCCH_CHAN_USAGE = 0x41,
720 NM_IPACC_TESTNO_FREQ_SYNC = 0x42,
721 NM_IPACC_TESTNO_BCCH_INFO = 0x43,
722 NM_IPACC_TESTNO_TX_BEACON = 0x44,
723 NM_IPACC_TESTNO_SYSINFO_MONITOR = 0x45,
724 NM_IPACC_TESTNO_BCCCH_MONITOR = 0x46,
725};
726
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200727/*! first byte after length inside NM_ATT_TEST_REPORT */
Harald Welteec8b4502010-02-20 20:34:29 +0100728enum abis_nm_ipacc_test_res {
729 NM_IPACC_TESTRES_SUCCESS = 0,
730 NM_IPACC_TESTRES_TIMEOUT = 1,
731 NM_IPACC_TESTRES_NO_CHANS = 2,
732 NM_IPACC_TESTRES_PARTIAL = 3,
733 NM_IPACC_TESTRES_STOPPED = 4,
734};
735
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200736/*! internal IE inside NM_ATT_TEST_REPORT */
Harald Welteec8b4502010-02-20 20:34:29 +0100737enum abis_nm_ipacc_testres_ie {
738 NM_IPACC_TR_IE_FREQ_ERR_LIST = 3,
739 NM_IPACC_TR_IE_CHAN_USAGE = 4,
740 NM_IPACC_TR_IE_BCCH_INFO = 6,
741 NM_IPACC_TR_IE_RESULT_DETAILS = 8,
742 NM_IPACC_TR_IE_FREQ_ERR = 18,
743};
744
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200745/*! ip.access IEI */
Harald Welteec8b4502010-02-20 20:34:29 +0100746enum ipac_eie {
747 NM_IPAC_EIE_ARFCN_WHITE = 0x01,
748 NM_IPAC_EIE_ARFCH_BLACK = 0x02,
749 NM_IPAC_EIE_FREQ_ERR_LIST = 0x03,
750 NM_IPAC_EIE_CHAN_USE_LIST = 0x04,
751 NM_IPAC_EIE_BCCH_INFO_TYPE = 0x05,
752 NM_IPAC_EIE_BCCH_INFO = 0x06,
Harald Welte380ae252010-03-06 11:29:07 +0100753 NM_IPAC_EIE_CONFIG = 0x07,
754 NM_IPAC_EIE_RES_DETAILS = 0x08,
755 NM_IPAC_EIE_RXLEV_THRESH = 0x09,
756 NM_IPAC_EIE_FREQ_SYNC_OPTS = 0x0a,
757 NM_IPAC_EIE_MAC_ADDR = 0x0b,
758 NM_IPAC_EIE_HW_SW_COMPAT_NR = 0x0c,
759 NM_IPAC_EIE_MANUF_SER_NR = 0x0d,
760 NM_IPAC_EIE_OEM_ID = 0x0e,
761 NM_IPAC_EIE_DATE_TIME_MANUF = 0x0f,
762 NM_IPAC_EIE_DATE_TIME_CALIB = 0x10,
763 NM_IPAC_EIE_BEACON_INFO = 0x11,
764 NM_IPAC_EIE_FREQ_ERR = 0x12,
Harald Welteec8b4502010-02-20 20:34:29 +0100765 /* FIXME */
Harald Welte380ae252010-03-06 11:29:07 +0100766 NM_IPAC_EIE_FREQ_BANDS = 0x1c,
767 NM_IPAC_EIE_MAX_TA = 0x1d,
768 NM_IPAC_EIE_CIPH_ALGOS = 0x1e,
769 NM_IPAC_EIE_CHAN_TYPES = 0x1f,
770 NM_IPAC_EIE_CHAN_MODES = 0x20,
771 NM_IPAC_EIE_GPRS_CODING = 0x21,
772 NM_IPAC_EIE_RTP_FEATURES = 0x22,
773 NM_IPAC_EIE_RSL_FEATURES = 0x23,
774 NM_IPAC_EIE_BTS_HW_CLASS = 0x24,
775 NM_IPAC_EIE_BTS_ID = 0x25,
Harald Welteec8b4502010-02-20 20:34:29 +0100776};
777
Vadim Yanitskiya7d7cf22023-09-05 02:32:26 +0700778/*! ip.access support flags for NM_IPAC_EIE_FREQ_BANDS */
779#define NM_IPAC_F_FREQ_BAND_PGSM (1 << 0)
780#define NM_IPAC_F_FREQ_BAND_EGSM (1 << 1)
781#define NM_IPAC_F_FREQ_BAND_RGSM (1 << 2)
782#define NM_IPAC_F_FREQ_BAND_DCS (1 << 3)
783#define NM_IPAC_F_FREQ_BAND_PCS (1 << 4)
784#define NM_IPAC_F_FREQ_BAND_850 (1 << 5)
785#define NM_IPAC_F_FREQ_BAND_480 (1 << 6)
786#define NM_IPAC_F_FREQ_BAND_450 (1 << 7)
787
788/*! ip.access support flags for NM_IPAC_EIE_CIPH_ALGOS */
789#define NM_IPAC_F_CIPH_ALGO_A51 (1 << 0)
790#define NM_IPAC_F_CIPH_ALGO_A52 (1 << 1)
791#define NM_IPAC_F_CIPH_ALGO_A53 (1 << 2)
792#define NM_IPAC_F_CIPH_ALGO_A54 (1 << 3)
793#define NM_IPAC_F_CIPH_ALGO_A55 (1 << 4)
794#define NM_IPAC_F_CIPH_ALGO_A56 (1 << 5)
795#define NM_IPAC_F_CIPH_ALGO_A57 (1 << 6)
796#define NM_IPAC_F_CIPH_ALGO_A58 (1 << 7)
797
798/*! ip.access support flags for NM_IPAC_EIE_CHAN_TYPES (1st octet) */
799#define NM_IPAC_F_CHANT_TCHF (1 << 0)
800#define NM_IPAC_F_CHANT_TCHH (1 << 1)
801#define NM_IPAC_F_CHANT_SDCCH8 (1 << 2)
802#define NM_IPAC_F_CHANT_BCCH (1 << 3)
803#define NM_IPAC_F_CHANT_BCCH_SDCCH4 (1 << 4)
804#define NM_IPAC_F_CHANT_BCH (1 << 5)
805#define NM_IPAC_F_CHANT_BCCH_SDCCH4_CBCH (1 << 6)
806#define NM_IPAC_F_CHANT_SDCCH8_CBCH (1 << 7)
807/*! ip.access support flags for NM_IPAC_EIE_CHAN_TYPES (2nd octet) */
Vadim Yanitskiy13c29c72023-09-12 05:16:22 +0700808#define NM_IPAC_F_CHANT_PDCHF (1 << 8)
Vadim Yanitskiya7d7cf22023-09-05 02:32:26 +0700809#define NM_IPAC_F_CHANT_TCHF_PDCHF (1 << 9)
810#define NM_IPAC_F_CHANT_TCHH_PDCHH (1 << 10)
811#define NM_IPAC_F_CHANT_TCHF_TCHH (1 << 11)
812
813/*! ip.access support flags for NM_IPAC_EIE_CHAN_MODES (speech codecs) */
814#define NM_IPAC_F_CHANM_SPEECH_FS (1 << 0)
815#define NM_IPAC_F_CHANM_SPEECH_EFS (1 << 1)
816#define NM_IPAC_F_CHANM_SPEECH_AFS (1 << 2)
817#define NM_IPAC_F_CHANM_SPEECH_HS (1 << 3)
818#define NM_IPAC_F_CHANM_SPEECH_AHS (1 << 4)
819/*! ip.access support flags for NM_IPAC_EIE_CHAN_MODES (CSD non-transparent) */
820#define NM_IPAC_F_CHANM_CSD_NT_4k8 (1 << 8)
821#define NM_IPAC_F_CHANM_CSD_NT_9k6 (1 << 9)
822#define NM_IPAC_F_CHANM_CSD_NT_14k4 (1 << 10)
823/*! ip.access support flags for NM_IPAC_EIE_CHAN_MODES (CSD transparent) */
824#define NM_IPAC_F_CHANM_CSD_T_1200_75 (1 << 16)
825#define NM_IPAC_F_CHANM_CSD_T_600 (1 << 17)
826#define NM_IPAC_F_CHANM_CSD_T_1k2 (1 << 18)
827#define NM_IPAC_F_CHANM_CSD_T_2k4 (1 << 19)
828#define NM_IPAC_F_CHANM_CSD_T_4k8 (1 << 20)
829#define NM_IPAC_F_CHANM_CSD_T_9k6 (1 << 21)
830#define NM_IPAC_F_CHANM_CSD_T_14k4 (1 << 22)
831
832/*! ip.access support flags for NM_IPAC_EIE_GPRS_CODING (GPRS) */
833#define NM_IPAC_F_GPRS_CODING_CS1 (1 << 0)
834#define NM_IPAC_F_GPRS_CODING_CS2 (1 << 1)
835#define NM_IPAC_F_GPRS_CODING_CS3 (1 << 2)
836#define NM_IPAC_F_GPRS_CODING_CS4 (1 << 3)
837/*! ip.access support flags for NM_IPAC_EIE_GPRS_CODING (EGPRS) */
838#define NM_IPAC_F_GPRS_CODING_MCS1 (1 << 7)
839#define NM_IPAC_F_GPRS_CODING_MCS2 (1 << 8)
840#define NM_IPAC_F_GPRS_CODING_MCS3 (1 << 9)
841#define NM_IPAC_F_GPRS_CODING_MCS4 (1 << 10)
842#define NM_IPAC_F_GPRS_CODING_MCS5 (1 << 11)
843#define NM_IPAC_F_GPRS_CODING_MCS6 (1 << 12)
844#define NM_IPAC_F_GPRS_CODING_MCS7 (1 << 13)
845#define NM_IPAC_F_GPRS_CODING_MCS8 (1 << 14)
846#define NM_IPAC_F_GPRS_CODING_MCS9 (1 << 15)
847
848/*! ip.access support flags for NM_IPAC_EIE_RTP_FEATURES */
849#define NM_IPAC_F_RTP_FEAT_COMPR_CONTROL (1 << 0) /* RTP Compression Control */
850#define NM_IPAC_F_RTP_FEAT_IR_8k (1 << 1) /* IR 8 kbit/s */
851#define NM_IPAC_F_RTP_FEAT_IR_16k (1 << 2) /* IR 16 kbit/s */
852#define NM_IPAC_F_RTP_FEAT_IR_32k (1 << 3) /* IR 32 kbit/s */
853#define NM_IPAC_F_RTP_FEAT_IR_64k (1 << 4) /* IR 64 kbit/s */
854#define NM_IPAC_F_RTP_FEAT_MULTIPLEX_RTP (1 << 6) /* RTP Multiplexing */
855#define NM_IPAC_F_RTP_FEAT_MULTIPLEX_SRTP (1 << 7) /* SRTP Multiplexing */
856
857/*! ip.access support flags for NM_IPAC_EIE_RSL_FEATURES */
858#define NM_IPAC_F_RSL_FEAT_PHYSICAL_CONTEXT (1 << 0)
859#define NM_IPAC_F_RSL_FEAT_DYN_PDCH_ACT (1 << 1)
860#define NM_IPAC_F_RSL_FEAT_RTP_PT2 (1 << 2)
861
862extern const struct value_string abis_nm_ipacc_freq_band_desc[];
863extern const struct value_string abis_nm_ipacc_ciph_algo_desc[];
864extern const struct value_string abis_nm_ipacc_chant_desc[];
865extern const struct value_string abis_nm_ipacc_chanm_desc[];
866extern const struct value_string abis_nm_ipacc_gprs_coding_desc[];
867extern const struct value_string abis_nm_ipacc_rtp_feat_desc[];
868extern const struct value_string abis_nm_ipacc_rsl_feat_desc[];
869
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200870/*! ip.access NWL BCCH information type */
Harald Welteec8b4502010-02-20 20:34:29 +0100871enum ipac_bcch_info_type {
872 IPAC_BINF_RXLEV = (1 << 8),
873 IPAC_BINF_RXQUAL = (1 << 9),
874 IPAC_BINF_FREQ_ERR_QUAL = (1 << 10),
875 IPAC_BINF_FRAME_OFFSET = (1 << 11),
876 IPAC_BINF_FRAME_NR_OFFSET = (1 << 12),
877 IPAC_BINF_BSIC = (1 << 13),
878 IPAC_BINF_CGI = (1 << 14),
879 IPAC_BINF_NEIGH_BA_SI2 = (1 << 15),
880 IPAC_BINF_NEIGH_BA_SI2bis = (1 << 0),
881 IPAC_BINF_NEIGH_BA_SI2ter = (1 << 1),
882 IPAC_BINF_CELL_ALLOC = (1 << 2),
883};
884
Pau Espin Pedrolc49691f2023-09-01 19:49:34 +0200885/*! ip.access NM_ATT_IPACC_NS_CFG value */
886struct abis_nm_ipacc_att_ns_cfg {
887 uint8_t un_blocking_timer; /* (un)blocking Timer (Tns-block) timeout */
888 uint8_t un_blocking_retries; /* (un)blocking Timer (Tns-block) number of retries */
889 uint8_t reset_timer; /* Reset Timer (Tns-reset) timeout */
890 uint8_t reset_retries; /* Reset Timer (Tns-reset) number of retries */
891 uint8_t test_timer; /* Test Timer (Tns-test) timeout */
892 uint8_t alive_timer; /* Alive Timer (Tns-alive) timeout */
893 uint8_t alive_retries; /* Alive Timer (Tns-alive) number of retries */
894} __attribute__((packed));
895
Pau Espin Pedrolbbb69d32023-09-01 19:37:06 +0200896/*! ip.access NM_ATT_IPACC_BSSGP_CFG value */
897struct abis_nm_ipacc_att_bssgp_cfg {
898 uint8_t t1_s; /* blocking timer (T1) */
899 uint8_t t1_blocking_retries; /* blocking retries */
900 uint8_t t1_unblocking_retries; /* unblocking retries */
901 uint8_t t2_s; /* reset timer (T2) */
902 uint8_t t2_retries; /* reset retries */
903 uint8_t t3_100ms; /* suspend timer (T3) in 100ms */
904 uint8_t t3_retries; /* suspend retries */
905 uint8_t t4_100ms; /* resume timer (T4) in 100ms */
906 uint8_t t4_retries; /* resume retries */
907 uint8_t t5_s; /* capability update timer (T5) */
908 uint8_t t5_retries; /* capability update retries */
909} __attribute__((packed));
910
Pau Espin Pedrol34e67c22023-09-01 19:28:21 +0200911/*! ip.access NM_ATT_IPACC_RLC_CFG value */
912struct abis_nm_ipacc_att_rlc_cfg {
913 uint8_t t3142;
914 uint8_t t3169;
915 uint8_t t3191;
916 uint8_t t3193_10ms;
917 uint8_t t3195;
918 uint8_t n3101;
919 uint8_t n3103;
920 uint8_t n3105;
921 uint8_t rlc_cv_countdown;
922} __attribute__((packed));
923
924/*! ip.access NM_ATT_IPACC_RLC_CFG_2 value */
925struct abis_nm_ipacc_att_rlc_cfg_2 {
926 /* T downlink TBF extension (0..500, network order) */
927 uint16_t t_dl_tbf_ext_10ms;
928 /* T uplink TBF extension (0..500, network order) */
929 uint16_t t_ul_tbf_ext_10ms;
930 /* Initial CS to use: CS1 -> 1, CS2 -> 2, CS3 -> 3, CS4 -> 4 */
931 uint8_t initial_cs;
932} __attribute__((packed));
933
934/*! ip.access NM_ATT_IPACC_RLC_CFG_3 value */
935struct abis_nm_ipacc_att_rlc_cfg_3 {
936 /* Initial MCS to use when EGPRS is used:
937 * MCS1 -> 1, MCS2 -> 2, ..., MCS9 -> 9 */
938 uint8_t initial_mcs;
939} __attribute__((packed));
940
Alexander Couzense9069eb2020-09-26 19:03:45 +0200941/*! Osmocom NSVC address type for NM_ATT_OSMO_NS_LINK_CFG */
942enum osmo_oml_nsvc_address_type {
943 OSMO_NSVC_ADDR_UNSPEC = 0x00,
944 OSMO_NSVC_ADDR_IPV4 = 0x04,
945 OSMO_NSVC_ADDR_IPV6 = 0x29,
946};
947
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200948/*! 3GPP TS 52.021 ยง9.4.62 SW Description */
Maxf74cfd32017-03-24 20:16:33 +0100949struct abis_nm_sw_desc {
950 uint8_t file_id[UINT8_MAX];
951 uint8_t file_id_len;
952
953 uint8_t file_version[UINT8_MAX];
954 uint8_t file_version_len;
955};
956
957uint16_t abis_nm_sw_desc_len(const struct abis_nm_sw_desc *sw, bool put_sw_descr);
958uint16_t abis_nm_put_sw_desc(struct msgb *msg, const struct abis_nm_sw_desc *sw, bool put_sw_descr);
959uint16_t abis_nm_put_sw_file(struct msgb *msg, const char *id, const char *ver, bool put_sw_desc);
960uint32_t abis_nm_get_sw_desc_len(const uint8_t * buf, size_t len);
961int abis_nm_get_sw_conf(const uint8_t * buf, size_t buf_len, struct abis_nm_sw_desc *sw, uint16_t sw_len);
962
Maxecbcdf52017-01-02 14:43:35 +0100963struct msgb *abis_nm_fail_evt_rep(enum abis_nm_event_type t,
964 enum abis_nm_severity s,
965 enum abis_nm_pcause_type ct,
966 uint16_t cause_value, const char *fmt, ...);
Max1251afe2017-01-11 18:12:32 +0100967struct msgb *abis_nm_fail_evt_vrep(enum abis_nm_event_type t,
968 enum abis_nm_severity s,
969 enum abis_nm_pcause_type ct,
970 uint16_t cause_value, const char *fmt,
971 va_list ap);
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200972/*! @} */