blob: ed53dc64a6fec0a08ff68fcdbe354f541eddf5fc [file] [log] [blame]
Sylvain Munaut12ba7782014-06-16 10:13:40 +02001#pragma once
Harald Welteec8b4502010-02-20 20:34:29 +01002
3/* GSM Network Management messages on the A-bis interface
4 * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0 */
5
6/* (C) 2008-2009 by Harald Welte <laforge@gnumonks.org>
7 * All Rights Reserved
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 *
23 */
24
Harald Welte4e777c32011-08-17 19:15:24 +020025/*! \addtogroup oml
26 * @{
27 */
28
29/*! \file gsm_12_21.h */
30
Harald Welteec8b4502010-02-20 20:34:29 +010031#include <stdint.h>
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010032#include <osmocom/gsm/tlv.h>
Harald Welteec8b4502010-02-20 20:34:29 +010033
Harald Welte4e777c32011-08-17 19:15:24 +020034/*! \brief generic header in front of every OML message according to TS 08.59 */
Harald Welteec8b4502010-02-20 20:34:29 +010035struct abis_om_hdr {
Harald Welte4e777c32011-08-17 19:15:24 +020036 /*! \brief Message Discriminator \ref abis_oml_mdisc */
Harald Welteec8b4502010-02-20 20:34:29 +010037 uint8_t mdisc;
Harald Welte4e777c32011-08-17 19:15:24 +020038 /*! \brief Placement (like \ref ABIS_OM_PLACEMENT_ONLY) */
Harald Welteec8b4502010-02-20 20:34:29 +010039 uint8_t placement;
Harald Welte4e777c32011-08-17 19:15:24 +020040 /*! \brief Sequence Number (if \ref ABIS_OM_PLACEMENT_MIDDLE) */
Harald Welteec8b4502010-02-20 20:34:29 +010041 uint8_t sequence;
Harald Welte4e777c32011-08-17 19:15:24 +020042 /*! \brief Length in octets */
Harald Welteec8b4502010-02-20 20:34:29 +010043 uint8_t length;
Harald Welte4e777c32011-08-17 19:15:24 +020044 /*! \brief actual payload data */
Harald Welteec8b4502010-02-20 20:34:29 +010045 uint8_t data[0];
46} __attribute__ ((packed));
47
Harald Welte4e777c32011-08-17 19:15:24 +020048/*! \brief Message Discriminator for Formatted Object Messages */
Harald Welteec8b4502010-02-20 20:34:29 +010049#define ABIS_OM_MDISC_FOM 0x80
Harald Welte4e777c32011-08-17 19:15:24 +020050/*! \brief Message Discriminator for Man Machine Interface */
Harald Welteec8b4502010-02-20 20:34:29 +010051#define ABIS_OM_MDISC_MMI 0x40
Harald Welte4e777c32011-08-17 19:15:24 +020052/*! \brief Message Discriminator for TRAU management */
Harald Welteec8b4502010-02-20 20:34:29 +010053#define ABIS_OM_MDISC_TRAU 0x20
Harald Welte4e777c32011-08-17 19:15:24 +020054/*! \brief Message Discriminator for Manufacturer Specific Messages */
Harald Welteec8b4502010-02-20 20:34:29 +010055#define ABIS_OM_MDISC_MANUF 0x10
Harald Welte4e777c32011-08-17 19:15:24 +020056
57/*! \brief Entire OML message is in the L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010058#define ABIS_OM_PLACEMENT_ONLY 0x80
Harald Welte4e777c32011-08-17 19:15:24 +020059/*! \brief First fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010060#define ABIS_OM_PLACEMENT_FIRST 0x40
Harald Welte4e777c32011-08-17 19:15:24 +020061/*! \brief Middle fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010062#define ABIS_OM_PLACEMENT_MIDDLE 0x20
Harald Welte4e777c32011-08-17 19:15:24 +020063/*! \brief Last fragment of OML message is in this L2 frame */
Harald Welteec8b4502010-02-20 20:34:29 +010064#define ABIS_OM_PLACEMENT_LAST 0x10
65
Harald Welte4e777c32011-08-17 19:15:24 +020066/*! \brief OML Object Instance */
Harald Welteec8b4502010-02-20 20:34:29 +010067struct abis_om_obj_inst {
Harald Welte4e777c32011-08-17 19:15:24 +020068 uint8_t bts_nr; /*!< \brief BTS Number */
69 uint8_t trx_nr; /*!< \brief TRX Number */
70 uint8_t ts_nr; /*!< \brief Timeslot Number */
Harald Welteec8b4502010-02-20 20:34:29 +010071} __attribute__ ((packed));
72
Harald Welte4e777c32011-08-17 19:15:24 +020073/*! \brief OML Object Instance */
Harald Welteec8b4502010-02-20 20:34:29 +010074struct abis_om_fom_hdr {
Harald Welte4e777c32011-08-17 19:15:24 +020075 uint8_t msg_type; /*!< \brief Message Type (\ref abis_nm_msgtype) */
76 uint8_t obj_class; /*!< \brief Object Class (\ref abis_nm_obj_class) */
77 struct abis_om_obj_inst obj_inst; /*!< \brief Object Instance */
78 uint8_t data[0]; /*!< \brief Data */
Harald Welteec8b4502010-02-20 20:34:29 +010079} __attribute__ ((packed));
80
Harald Welte4e777c32011-08-17 19:15:24 +020081/*! \brief Size of the OML FOM header in octets */
Harald Welteec8b4502010-02-20 20:34:29 +010082#define ABIS_OM_FOM_HDR_SIZE (sizeof(struct abis_om_hdr) + sizeof(struct abis_om_fom_hdr))
83
Harald Welte4e777c32011-08-17 19:15:24 +020084/*! \brief OML Message Type (Section 9.1) */
Harald Welteec8b4502010-02-20 20:34:29 +010085enum abis_nm_msgtype {
86 /* SW Download Management Messages */
87 NM_MT_LOAD_INIT = 0x01,
88 NM_MT_LOAD_INIT_ACK,
89 NM_MT_LOAD_INIT_NACK,
90 NM_MT_LOAD_SEG,
91 NM_MT_LOAD_SEG_ACK,
92 NM_MT_LOAD_ABORT,
93 NM_MT_LOAD_END,
94 NM_MT_LOAD_END_ACK,
95 NM_MT_LOAD_END_NACK,
96 NM_MT_SW_ACT_REQ, /* BTS->BSC */
97 NM_MT_SW_ACT_REQ_ACK,
98 NM_MT_SW_ACT_REQ_NACK,
99 NM_MT_ACTIVATE_SW, /* BSC->BTS */
100 NM_MT_ACTIVATE_SW_ACK,
101 NM_MT_ACTIVATE_SW_NACK,
102 NM_MT_SW_ACTIVATED_REP, /* 0x10 */
103 /* A-bis Interface Management Messages */
104 NM_MT_ESTABLISH_TEI = 0x21,
105 NM_MT_ESTABLISH_TEI_ACK,
106 NM_MT_ESTABLISH_TEI_NACK,
107 NM_MT_CONN_TERR_SIGN,
108 NM_MT_CONN_TERR_SIGN_ACK,
109 NM_MT_CONN_TERR_SIGN_NACK,
110 NM_MT_DISC_TERR_SIGN,
111 NM_MT_DISC_TERR_SIGN_ACK,
112 NM_MT_DISC_TERR_SIGN_NACK,
113 NM_MT_CONN_TERR_TRAF,
114 NM_MT_CONN_TERR_TRAF_ACK,
115 NM_MT_CONN_TERR_TRAF_NACK,
116 NM_MT_DISC_TERR_TRAF,
117 NM_MT_DISC_TERR_TRAF_ACK,
118 NM_MT_DISC_TERR_TRAF_NACK,
119 /* Transmission Management Messages */
120 NM_MT_CONN_MDROP_LINK = 0x31,
121 NM_MT_CONN_MDROP_LINK_ACK,
122 NM_MT_CONN_MDROP_LINK_NACK,
123 NM_MT_DISC_MDROP_LINK,
124 NM_MT_DISC_MDROP_LINK_ACK,
125 NM_MT_DISC_MDROP_LINK_NACK,
126 /* Air Interface Management Messages */
127 NM_MT_SET_BTS_ATTR = 0x41,
128 NM_MT_SET_BTS_ATTR_ACK,
129 NM_MT_SET_BTS_ATTR_NACK,
130 NM_MT_SET_RADIO_ATTR,
131 NM_MT_SET_RADIO_ATTR_ACK,
132 NM_MT_SET_RADIO_ATTR_NACK,
133 NM_MT_SET_CHAN_ATTR,
134 NM_MT_SET_CHAN_ATTR_ACK,
135 NM_MT_SET_CHAN_ATTR_NACK,
136 /* Test Management Messages */
137 NM_MT_PERF_TEST = 0x51,
138 NM_MT_PERF_TEST_ACK,
139 NM_MT_PERF_TEST_NACK,
140 NM_MT_TEST_REP,
141 NM_MT_SEND_TEST_REP,
142 NM_MT_SEND_TEST_REP_ACK,
143 NM_MT_SEND_TEST_REP_NACK,
144 NM_MT_STOP_TEST,
145 NM_MT_STOP_TEST_ACK,
146 NM_MT_STOP_TEST_NACK,
147 /* State Management and Event Report Messages */
148 NM_MT_STATECHG_EVENT_REP = 0x61,
149 NM_MT_FAILURE_EVENT_REP,
150 NM_MT_STOP_EVENT_REP,
151 NM_MT_STOP_EVENT_REP_ACK,
152 NM_MT_STOP_EVENT_REP_NACK,
153 NM_MT_REST_EVENT_REP,
154 NM_MT_REST_EVENT_REP_ACK,
155 NM_MT_REST_EVENT_REP_NACK,
156 NM_MT_CHG_ADM_STATE,
157 NM_MT_CHG_ADM_STATE_ACK,
158 NM_MT_CHG_ADM_STATE_NACK,
159 NM_MT_CHG_ADM_STATE_REQ,
160 NM_MT_CHG_ADM_STATE_REQ_ACK,
161 NM_MT_CHG_ADM_STATE_REQ_NACK,
162 NM_MT_REP_OUTST_ALARMS = 0x93,
163 NM_MT_REP_OUTST_ALARMS_ACK,
164 NM_MT_REP_OUTST_ALARMS_NACK,
165 /* Equipment Management Messages */
166 NM_MT_CHANGEOVER = 0x71,
167 NM_MT_CHANGEOVER_ACK,
168 NM_MT_CHANGEOVER_NACK,
169 NM_MT_OPSTART,
170 NM_MT_OPSTART_ACK,
171 NM_MT_OPSTART_NACK,
172 NM_MT_REINIT,
173 NM_MT_REINIT_ACK,
174 NM_MT_REINIT_NACK,
175 NM_MT_SET_SITE_OUT, /* BS11: get alarm ?!? */
176 NM_MT_SET_SITE_OUT_ACK,
177 NM_MT_SET_SITE_OUT_NACK,
178 NM_MT_CHG_HW_CONF = 0x90,
179 NM_MT_CHG_HW_CONF_ACK,
180 NM_MT_CHG_HW_CONF_NACK,
181 /* Measurement Management Messages */
182 NM_MT_MEAS_RES_REQ = 0x8a,
183 NM_MT_MEAS_RES_RESP,
184 NM_MT_STOP_MEAS,
185 NM_MT_START_MEAS,
186 /* Other Messages */
187 NM_MT_GET_ATTR = 0x81,
188 NM_MT_GET_ATTR_RESP,
189 NM_MT_GET_ATTR_NACK,
190 NM_MT_SET_ALARM_THRES,
191 NM_MT_SET_ALARM_THRES_ACK,
192 NM_MT_SET_ALARM_THRES_NACK,
193};
194
Harald Welte4e777c32011-08-17 19:15:24 +0200195/*! \brief Siemens specific OML Message Types */
Harald Welteec8b4502010-02-20 20:34:29 +0100196enum abis_nm_msgtype_bs11 {
197 NM_MT_BS11_RESET_RESOURCE = 0x74,
198
199 NM_MT_BS11_BEGIN_DB_TX = 0xa3,
200 NM_MT_BS11_BEGIN_DB_TX_ACK,
201 NM_MT_BS11_BEGIN_DB_TX_NACK,
202 NM_MT_BS11_END_DB_TX = 0xa6,
203 NM_MT_BS11_END_DB_TX_ACK,
204 NM_MT_BS11_END_DB_TX_NACK,
205 NM_MT_BS11_CREATE_OBJ = 0xa9,
206 NM_MT_BS11_CREATE_OBJ_ACK,
207 NM_MT_BS11_CREATE_OBJ_NACK,
208 NM_MT_BS11_DELETE_OBJ = 0xac,
209 NM_MT_BS11_DELETE_OBJ_ACK,
210 NM_MT_BS11_DELETE_OBJ_NACK,
211
212 NM_MT_BS11_SET_ATTR = 0xd0,
213 NM_MT_BS11_SET_ATTR_ACK,
214 NM_MT_BS11_SET_ATTR_NACK,
215 NM_MT_BS11_LMT_SESSION = 0xdc,
216
217 NM_MT_BS11_GET_STATE = 0xe3,
218 NM_MT_BS11_GET_STATE_ACK,
219 NM_MT_BS11_LMT_LOGON = 0xe5,
220 NM_MT_BS11_LMT_LOGON_ACK,
221 NM_MT_BS11_RESTART = 0xe7,
222 NM_MT_BS11_RESTART_ACK,
223 NM_MT_BS11_DISCONNECT = 0xe9,
224 NM_MT_BS11_DISCONNECT_ACK,
225 NM_MT_BS11_LMT_LOGOFF = 0xec,
226 NM_MT_BS11_LMT_LOGOFF_ACK,
227 NM_MT_BS11_RECONNECT = 0xf1,
228 NM_MT_BS11_RECONNECT_ACK,
229};
230
Harald Welte4e777c32011-08-17 19:15:24 +0200231/*! \brief ip.access specific OML Message Types */
Harald Welteec8b4502010-02-20 20:34:29 +0100232enum abis_nm_msgtype_ipacc {
233 NM_MT_IPACC_RESTART = 0x87,
234 NM_MT_IPACC_RESTART_ACK,
235 NM_MT_IPACC_RESTART_NACK,
236 NM_MT_IPACC_RSL_CONNECT = 0xe0,
237 NM_MT_IPACC_RSL_CONNECT_ACK,
238 NM_MT_IPACC_RSL_CONNECT_NACK,
239 NM_MT_IPACC_RSL_DISCONNECT = 0xe3,
240 NM_MT_IPACC_RSL_DISCONNECT_ACK,
241 NM_MT_IPACC_RSL_DISCONNECT_NACK,
242 NM_MT_IPACC_CONN_TRAF = 0xe6,
243 NM_MT_IPACC_CONN_TRAF_ACK,
244 NM_MT_IPACC_CONN_TRAF_NACK,
245 NM_MT_IPACC_DEF_BOOT_SW = 0xec,
246 NM_MT_IPACC_DEF_BOOT_SW_ACK,
247 MN_MT_IPACC_DEF_BOOT_SW_NACK,
248 NM_MT_IPACC_SET_NVATTR = 0xef,
249 NM_MT_IPACC_SET_NVATTR_ACK,
250 NM_MT_IPACC_SET_NVATTR_NACK,
251 NM_MT_IPACC_GET_NVATTR = 0xf2,
252 NM_MT_IPACC_GET_NVATTR_ACK,
253 NM_MT_IPACC_GET_NVATTR_NACK,
254 NM_MT_IPACC_SET_ATTR = 0xf5,
255 NM_MT_IPACC_SET_ATTR_ACK,
256 NM_MT_IPACC_SET_ATTR_NACK,
257};
258
259enum abis_nm_bs11_cell_alloc {
260 NM_BS11_CANR_GSM = 0x00,
261 NM_BS11_CANR_DCS1800 = 0x01,
262};
263
Harald Welte4e777c32011-08-17 19:15:24 +0200264/*! \brief OML Object Class (Section 9.2) */
Harald Welteec8b4502010-02-20 20:34:29 +0100265enum abis_nm_obj_class {
266 NM_OC_SITE_MANAGER = 0x00,
267 NM_OC_BTS,
268 NM_OC_RADIO_CARRIER,
269 NM_OC_CHANNEL,
270 NM_OC_BASEB_TRANSC,
271 /* RFU: 05-FE */
272
273 NM_OC_IPAC_E1_TRUNK = 0x0e,
274 NM_OC_IPAC_E1_PORT = 0x0f,
275 NM_OC_IPAC_E1_CHAN = 0x10,
276 NM_OC_IPAC_CLK_MODULE = 0x22,
277
278 NM_OC_BS11_ADJC = 0xa0,
279 NM_OC_BS11_HANDOVER = 0xa1,
280 NM_OC_BS11_PWR_CTRL = 0xa2,
281 NM_OC_BS11_BTSE = 0xa3, /* LMT? */
282 NM_OC_BS11_RACK = 0xa4,
283 NM_OC_BS11 = 0xa5, /* 01: ALCO */
284 NM_OC_BS11_TEST = 0xa6,
285 NM_OC_BS11_ENVABTSE = 0xa8,
286 NM_OC_BS11_BPORT = 0xa9,
287
288 NM_OC_GPRS_NSE = 0xf0,
289 NM_OC_GPRS_CELL = 0xf1,
290 NM_OC_GPRS_NSVC = 0xf2,
291
292 NM_OC_NULL = 0xff,
293};
294
Harald Welte4e777c32011-08-17 19:15:24 +0200295/*! \brief OML Attributes / IEs (Section 9.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100296enum abis_nm_attr {
297 NM_ATT_ABIS_CHANNEL = 0x01,
298 NM_ATT_ADD_INFO,
299 NM_ATT_ADD_TEXT,
300 NM_ATT_ADM_STATE,
301 NM_ATT_ARFCN_LIST,
302 NM_ATT_AUTON_REPORT,
303 NM_ATT_AVAIL_STATUS,
304 NM_ATT_BCCH_ARFCN,
305 NM_ATT_BSIC,
306 NM_ATT_BTS_AIR_TIMER,
307 NM_ATT_CCCH_L_I_P,
308 NM_ATT_CCCH_L_T,
309 NM_ATT_CHAN_COMB,
310 NM_ATT_CONN_FAIL_CRIT,
311 NM_ATT_DEST,
312 /* res */
313 NM_ATT_EVENT_TYPE = 0x11, /* BS11: file data ?!? */
314 NM_ATT_FILE_ID,
315 NM_ATT_FILE_VERSION,
316 NM_ATT_GSM_TIME,
317 NM_ATT_HSN,
318 NM_ATT_HW_CONFIG,
319 NM_ATT_HW_DESC,
320 NM_ATT_INTAVE_PARAM,
321 NM_ATT_INTERF_BOUND,
322 NM_ATT_LIST_REQ_ATTR,
323 NM_ATT_MAIO,
324 NM_ATT_MANUF_STATE,
325 NM_ATT_MANUF_THRESH,
326 NM_ATT_MANUF_ID,
327 NM_ATT_MAX_TA,
328 NM_ATT_MDROP_LINK, /* 0x20 */
329 NM_ATT_MDROP_NEXT,
330 NM_ATT_NACK_CAUSES,
331 NM_ATT_NY1,
332 NM_ATT_OPER_STATE,
333 NM_ATT_OVERL_PERIOD,
334 NM_ATT_PHYS_CONF,
335 NM_ATT_POWER_CLASS,
336 NM_ATT_POWER_THRESH,
337 NM_ATT_PROB_CAUSE,
338 NM_ATT_RACH_B_THRESH,
339 NM_ATT_LDAVG_SLOTS,
340 NM_ATT_RAD_SUBC,
341 NM_ATT_RF_MAXPOWR_R,
342 NM_ATT_SITE_INPUTS,
343 NM_ATT_SITE_OUTPUTS,
344 NM_ATT_SOURCE, /* 0x30 */
345 NM_ATT_SPEC_PROB,
346 NM_ATT_START_TIME,
347 NM_ATT_T200,
348 NM_ATT_TEI,
349 NM_ATT_TEST_DUR,
350 NM_ATT_TEST_NO,
351 NM_ATT_TEST_REPORT,
352 NM_ATT_VSWR_THRESH,
353 NM_ATT_WINDOW_SIZE,
354 /* Res */
355 NM_ATT_BS11_RSSI_OFFS = 0x3d,
356 NM_ATT_BS11_TXPWR = 0x3e,
357 NM_ATT_BS11_DIVERSITY = 0x3f,
358 /* Res */
359 NM_ATT_TSC = 0x40,
360 NM_ATT_SW_CONFIG,
361 NM_ATT_SW_DESCR,
362 NM_ATT_SEVERITY,
363 NM_ATT_GET_ARI,
364 NM_ATT_HW_CONF_CHG,
365 NM_ATT_OUTST_ALARM,
366 NM_ATT_FILE_DATA,
367 NM_ATT_MEAS_RES,
368 NM_ATT_MEAS_TYPE,
369
370 NM_ATT_BS11_ESN_FW_CODE_NO = 0x4c,
371 NM_ATT_BS11_ESN_HW_CODE_NO = 0x4f,
372
373 NM_ATT_BS11_ESN_PCB_SERIAL = 0x55,
374 NM_ATT_BS11_EXCESSIVE_DISTANCE = 0x58,
375
376 NM_ATT_BS11_ALL_TEST_CATG = 0x60,
377 NM_ATT_BS11_BTSLS_HOPPING,
378 NM_ATT_BS11_CELL_ALLOC_NR,
379 NM_ATT_BS11_CELL_GLOBAL_ID,
380 NM_ATT_BS11_ENA_INTERF_CLASS = 0x66,
381 NM_ATT_BS11_ENA_INT_INTEC_HANDO = 0x67,
382 NM_ATT_BS11_ENA_INT_INTRC_HANDO = 0x68,
383 NM_ATT_BS11_ENA_MS_PWR_CTRL = 0x69,
384 NM_ATT_BS11_ENA_PWR_BDGT_HO = 0x6a,
385 NM_ATT_BS11_ENA_PWR_CTRL_RLFW = 0x6b,
386 NM_ATT_BS11_ENA_RXLEV_HO = 0x6c,
387 NM_ATT_BS11_ENA_RXQUAL_HO = 0x6d,
388 NM_ATT_BS11_FACCH_QUAL = 0x6e,
389
390 NM_ATT_IPACC_DST_IP = 0x80,
391 NM_ATT_IPACC_DST_IP_PORT = 0x81,
392 NM_ATT_IPACC_SSRC = 0x82,
393 NM_ATT_IPACC_RTP_PAYLD_TYPE = 0x83,
394 NM_ATT_IPACC_BASEB_ID = 0x84,
395 NM_ATT_IPACC_STREAM_ID = 0x85,
396 NM_ATT_IPACC_NV_FLAGS = 0x86,
397 NM_ATT_IPACC_FREQ_CTRL = 0x87,
398 NM_ATT_IPACC_PRIM_OML_CFG = 0x88,
399 NM_ATT_IPACC_SEC_OML_CFG = 0x89,
400 NM_ATT_IPACC_IP_IF_CFG = 0x8a, /* IP interface */
401 NM_ATT_IPACC_IP_GW_CFG = 0x8b, /* IP gateway */
402 NM_ATT_IPACC_IN_SERV_TIME = 0x8c,
403 NM_ATT_IPACC_TRX_BTS_ASS = 0x8d,
404 NM_ATT_IPACC_LOCATION = 0x8e, /* string describing location */
405 NM_ATT_IPACC_PAGING_CFG = 0x8f,
406 NM_ATT_IPACC_FILE_DATA = 0x90,
407 NM_ATT_IPACC_UNIT_ID = 0x91, /* Site/BTS/TRX */
408 NM_ATT_IPACC_PARENT_UNIT_ID = 0x92,
409 NM_ATT_IPACC_UNIT_NAME = 0x93, /* default: nbts-<mac-as-string> */
410 NM_ATT_IPACC_SNMP_CFG = 0x94,
411 NM_ATT_IPACC_PRIM_OML_CFG_LIST = 0x95,
412 NM_ATT_IPACC_PRIM_OML_FB_TOUT = 0x96,
413 NM_ATT_IPACC_CUR_SW_CFG = 0x97,
414 NM_ATT_IPACC_TIMING_BUS = 0x98,
415 NM_ATT_IPACC_CGI = 0x99,
416 NM_ATT_IPACC_RAC = 0x9a,
417 NM_ATT_IPACC_OBJ_VERSION = 0x9b,
418 NM_ATT_IPACC_GPRS_PAGING_CFG = 0x9c,
419 NM_ATT_IPACC_NSEI = 0x9d,
420 NM_ATT_IPACC_BVCI = 0x9e,
421 NM_ATT_IPACC_NSVCI = 0x9f,
422 NM_ATT_IPACC_NS_CFG = 0xa0,
423 NM_ATT_IPACC_BSSGP_CFG = 0xa1,
424 NM_ATT_IPACC_NS_LINK_CFG = 0xa2,
425 NM_ATT_IPACC_RLC_CFG = 0xa3,
426 NM_ATT_IPACC_ALM_THRESH_LIST = 0xa4,
427 NM_ATT_IPACC_MONIT_VAL_LIST = 0xa5,
428 NM_ATT_IPACC_TIB_CONTROL = 0xa6,
429 NM_ATT_IPACC_SUPP_FEATURES = 0xa7,
430 NM_ATT_IPACC_CODING_SCHEMES = 0xa8,
431 NM_ATT_IPACC_RLC_CFG_2 = 0xa9,
432 NM_ATT_IPACC_HEARTB_TOUT = 0xaa,
433 NM_ATT_IPACC_UPTIME = 0xab,
434 NM_ATT_IPACC_RLC_CFG_3 = 0xac,
435 NM_ATT_IPACC_SSL_CFG = 0xad,
436 NM_ATT_IPACC_SEC_POSSIBLE = 0xae,
437 NM_ATT_IPACC_IML_SSL_STATE = 0xaf,
438 NM_ATT_IPACC_REVOC_DATE = 0xb0,
439
440
441 NM_ATT_BS11_RF_RES_IND_PER = 0x8f,
442
443 NM_ATT_BS11_RX_LEV_MIN_CELL = 0x90,
444 NM_ATT_BS11_ABIS_EXT_TIME = 0x91,
445 NM_ATT_BS11_TIMER_HO_REQUEST = 0x92,
446 NM_ATT_BS11_TIMER_NCELL = 0x93,
447 NM_ATT_BS11_TSYNC = 0x94,
448 NM_ATT_BS11_TTRAU = 0x95,
449 NM_ATT_BS11_EMRG_CFG_MEMBER = 0x9b,
450 NM_ATT_BS11_TRX_AREA = 0x9f,
451
452 NM_ATT_BS11_BCCH_RECONF = 0xd7,
453 NM_ATT_BS11_BIT_ERR_THESH = 0xa0,
454 NM_ATT_BS11_BOOT_SW_VERS = 0xa1,
455 NM_ATT_BS11_CCLK_ACCURACY = 0xa3,
456 NM_ATT_BS11_CCLK_TYPE = 0xa4,
457 NM_ATT_BS11_INP_IMPEDANCE = 0xaa,
458 NM_ATT_BS11_L1_PROT_TYPE = 0xab,
459 NM_ATT_BS11_LINE_CFG = 0xac,
460 NM_ATT_BS11_LI_PORT_1 = 0xad,
461 NM_ATT_BS11_LI_PORT_2 = 0xae,
462
463 NM_ATT_BS11_L1_REM_ALM_TYPE = 0xb0,
464 NM_ATT_BS11_SW_LOAD_INTENDED = 0xbb,
465 NM_ATT_BS11_SW_LOAD_SAFETY = 0xbc,
466 NM_ATT_BS11_SW_LOAD_STORED = 0xbd,
467
468 NM_ATT_BS11_VENDOR_NAME = 0xc1,
469 NM_ATT_BS11_HOPPING_MODE = 0xc5,
470 NM_ATT_BS11_LMT_LOGON_SESSION = 0xc6,
471 NM_ATT_BS11_LMT_LOGIN_TIME = 0xc7,
472 NM_ATT_BS11_LMT_USER_ACC_LEV = 0xc8,
473 NM_ATT_BS11_LMT_USER_NAME = 0xc9,
474
475 NM_ATT_BS11_L1_CONTROL_TS = 0xd8,
476 NM_ATT_BS11_RADIO_MEAS_GRAN = 0xdc, /* in SACCH multiframes */
477 NM_ATT_BS11_RADIO_MEAS_REP = 0xdd,
478
479 NM_ATT_BS11_SH_LAPD_INT_TIMER = 0xe8,
480
481 NM_ATT_BS11_BTS_STATE = 0xf0,
482 NM_ATT_BS11_E1_STATE = 0xf1,
483 NM_ATT_BS11_PLL = 0xf2,
484 NM_ATT_BS11_RX_OFFSET = 0xf3,
485 NM_ATT_BS11_ANT_TYPE = 0xf4,
486 NM_ATT_BS11_PLL_MODE = 0xfc,
487 NM_ATT_BS11_PASSWORD = 0xfd,
Álvaro Neira Ayusoc22d72c2014-05-05 16:04:02 +0200488
Harald Welte5b5650f2014-05-19 11:25:46 +0200489 /* osmocom (osmo-bts) specific attributes, used in combination
490 * with the "org.osmocom" manufacturer identification */
491 NM_ATT_OSMO_REDUCEPOWER = 0xfe, /* TLV_TYPE_TV */
Harald Welteec8b4502010-02-20 20:34:29 +0100492};
493#define NM_ATT_BS11_FILE_DATA NM_ATT_EVENT_TYPE
494
Harald Welte4e777c32011-08-17 19:15:24 +0200495/*! \brief OML Administrative State (Section 9.4.4) */
Harald Welteec8b4502010-02-20 20:34:29 +0100496enum abis_nm_adm_state {
497 NM_STATE_LOCKED = 0x01,
498 NM_STATE_UNLOCKED = 0x02,
499 NM_STATE_SHUTDOWN = 0x03,
500 NM_STATE_NULL = 0xff,
501};
502
Harald Welte4e777c32011-08-17 19:15:24 +0200503/*! \brief OML Availability State (Section 9.4.7) */
Harald Welteec8b4502010-02-20 20:34:29 +0100504enum abis_nm_avail_state {
505 NM_AVSTATE_IN_TEST = 1,
506 NM_AVSTATE_POWER_OFF = 2,
507 NM_AVSTATE_OFF_LINE = 3,
508 NM_AVSTATE_DEPENDENCY = 5,
509 NM_AVSTATE_DEGRADED = 6,
510 NM_AVSTATE_NOT_INSTALLED= 7,
511 NM_AVSTATE_OK = 0xff,
512};
513
Harald Welte4e777c32011-08-17 19:15:24 +0200514/*! \brief OML Operational State */
Harald Welteec8b4502010-02-20 20:34:29 +0100515enum abis_nm_op_state {
516 NM_OPSTATE_DISABLED = 1,
517 NM_OPSTATE_ENABLED = 2,
518 NM_OPSTATE_NULL = 0xff,
519};
520
Harald Welte4e777c32011-08-17 19:15:24 +0200521/* \brief Channel Combination (Section 9.4.13) */
Harald Welteec8b4502010-02-20 20:34:29 +0100522enum abis_nm_chan_comb {
523 NM_CHANC_TCHFull = 0x00, /* TCH/F + TCH/H + SACCH/TF */
524 NM_CHANC_TCHHalf = 0x01, /* TCH/H(0,1) + FACCH/H(0,1) +
525 SACCH/TH(0,1) */
526 NM_CHANC_TCHHalf2 = 0x02, /* TCH/H(0) + FACCH/H(0) + SACCH/TH(0) +
527 TCH/H(1) */
528 NM_CHANC_SDCCH = 0x03, /* SDCCH/8 + SACCH/8 */
529 NM_CHANC_mainBCCH = 0x04, /* FCCH + SCH + BCCH + CCCH */
530 NM_CHANC_BCCHComb = 0x05, /* FCCH + SCH + BCCH + CCCH + SDCCH/4 +
531 SACCH/C4 */
532 NM_CHANC_BCCH = 0x06, /* BCCH + CCCH */
533 NM_CHANC_BCCH_CBCH = 0x07, /* CHANC_BCCHComb + CBCH */
534 NM_CHANC_SDCCH_CBCH = 0x08, /* CHANC_SDCCH8 + CBCH */
535 /* ip.access */
536 NM_CHANC_IPAC_bPDCH = 0x0b, /* PBCCH + PCCCH + PDTCH/F + PACCH/F +
537 PTCCH/F */
538 NM_CHANC_IPAC_cPDCH = 0x0c, /* PBCCH + PDTCH/F + PACCH/F + PTCCH/F */
539 NM_CHANC_IPAC_PDCH = 0x0d, /* PDTCH/F + PACCH/F + PTCCH/F */
540 NM_CHANC_IPAC_TCHFull_PDCH = 0x80,
541 NM_CHANC_IPAC_TCHFull_TCHHalf = 0x81,
Neels Hofmeyrfd80f5a2016-07-14 03:21:05 +0200542 /* osmocom */
543 NM_CHANC_OSMO_TCHFull_TCHHalf_PDCH = 0x90,
Harald Welteec8b4502010-02-20 20:34:29 +0100544};
545
Harald Welte4e777c32011-08-17 19:15:24 +0200546/*! \brief Event Type (Section 9.4.16) */
Harald Welteec8b4502010-02-20 20:34:29 +0100547enum abis_nm_event_type {
548 NM_EVT_COMM_FAIL = 0x00,
549 NM_EVT_QOS_FAIL = 0x01,
550 NM_EVT_PROC_FAIL = 0x02,
551 NM_EVT_EQUIP_FAIL = 0x03,
552 NM_EVT_ENV_FAIL = 0x04,
553};
554
Harald Welte4e777c32011-08-17 19:15:24 +0200555/*! \brief Perceived Severity (Section: 9.4.63) */
Harald Welteec8b4502010-02-20 20:34:29 +0100556enum abis_nm_severity {
557 NM_SEVER_CEASED = 0x00,
558 NM_SEVER_CRITICAL = 0x01,
559 NM_SEVER_MAJOR = 0x02,
560 NM_SEVER_MINOR = 0x03,
561 NM_SEVER_WARNING = 0x04,
562 NM_SEVER_INDETERMINATE = 0x05,
563};
564
Harald Welte4e777c32011-08-17 19:15:24 +0200565/*! \brief Probable Cause Type (Section 9.4.43) */
Harald Welteec8b4502010-02-20 20:34:29 +0100566enum abis_nm_pcause_type {
567 NM_PCAUSE_T_X721 = 0x01,
568 NM_PCAUSE_T_GSM = 0x02,
569 NM_PCAUSE_T_MANUF = 0x03,
570};
571
Harald Welte4e777c32011-08-17 19:15:24 +0200572/*! \brief NACK causes (Section 9.4.36) */
Harald Welteec8b4502010-02-20 20:34:29 +0100573enum abis_nm_nack_cause {
574 /* General Nack Causes */
575 NM_NACK_INCORR_STRUCT = 0x01,
576 NM_NACK_MSGTYPE_INVAL = 0x02,
577 NM_NACK_OBJCLASS_INVAL = 0x05,
578 NM_NACK_OBJCLASS_NOTSUPP = 0x06,
579 NM_NACK_BTSNR_UNKN = 0x07,
580 NM_NACK_TRXNR_UNKN = 0x08,
581 NM_NACK_OBJINST_UNKN = 0x09,
582 NM_NACK_ATTRID_INVAL = 0x0c,
583 NM_NACK_ATTRID_NOTSUPP = 0x0d,
584 NM_NACK_PARAM_RANGE = 0x0e,
585 NM_NACK_ATTRLIST_INCONSISTENT = 0x0f,
586 NM_NACK_SPEC_IMPL_NOTSUPP = 0x10,
587 NM_NACK_CANT_PERFORM = 0x11,
588 /* Specific Nack Causes */
589 NM_NACK_RES_NOTIMPL = 0x19,
590 NM_NACK_RES_NOTAVAIL = 0x1a,
591 NM_NACK_FREQ_NOTAVAIL = 0x1b,
592 NM_NACK_TEST_NOTSUPP = 0x1c,
593 NM_NACK_CAPACITY_RESTR = 0x1d,
594 NM_NACK_PHYSCFG_NOTPERFORM = 0x1e,
595 NM_NACK_TEST_NOTINIT = 0x1f,
596 NM_NACK_PHYSCFG_NOTRESTORE = 0x20,
597 NM_NACK_TEST_NOSUCH = 0x21,
598 NM_NACK_TEST_NOSTOP = 0x22,
599 NM_NACK_MSGINCONSIST_PHYSCFG = 0x23,
600 NM_NACK_FILE_INCOMPLETE = 0x25,
601 NM_NACK_FILE_NOTAVAIL = 0x26,
602 NM_NACK_FILE_NOTACTIVATE = 0x27,
603 NM_NACK_REQ_NOT_GRANT = 0x28,
604 NM_NACK_WAIT = 0x29,
605 NM_NACK_NOTH_REPORT_EXIST = 0x2a,
606 NM_NACK_MEAS_NOTSUPP = 0x2b,
607 NM_NACK_MEAS_NOTSTART = 0x2c,
608};
609
Harald Welte4e777c32011-08-17 19:15:24 +0200610/*! \brief Abis OML Channel (Section 9.4.1) */
Harald Welteec8b4502010-02-20 20:34:29 +0100611struct abis_nm_channel {
612 uint8_t attrib;
Harald Welte4e777c32011-08-17 19:15:24 +0200613 uint8_t bts_port; /*!< \brief BTS port number */
614 uint8_t timeslot; /*!< \brief E1 timeslot */
615 uint8_t subslot; /*!< \brief E1 sub-slot */
Harald Welteec8b4502010-02-20 20:34:29 +0100616} __attribute__ ((packed));
617
Max0bee65c2017-01-02 13:42:24 +0100618/*! \brief 3GPP TS 12.21 9.4.53 T200 index */
619enum abis_nm_t200_idx {
620 T200_SDCCH = 0,
621 T200_FACCH_F = 1,
622 T200_FACCH_H = 2,
623 T200_SACCH_TCH_SAPI0 = 3,
624 T200_SACCH_SDCCH = 4,
625 T200_SDCCH_SAPI3 = 5,
626 T200_SACCH_TCH_SAPI3 = 6
627};
628
629extern const uint8_t abis_nm_t200_ms[];
630
Harald Welte4e777c32011-08-17 19:15:24 +0200631/*! \brief Siemens BS-11 specific objects in the SienemsHW (0xA5) object class */
Harald Welteec8b4502010-02-20 20:34:29 +0100632enum abis_bs11_objtype {
633 BS11_OBJ_ALCO = 0x01,
634 BS11_OBJ_BBSIG = 0x02, /* obj_class: 0,1 */
635 BS11_OBJ_TRX1 = 0x03, /* only DEACTIVATE TRX1 */
636 BS11_OBJ_CCLK = 0x04,
637 BS11_OBJ_GPSU = 0x06,
638 BS11_OBJ_LI = 0x07,
639 BS11_OBJ_PA = 0x09, /* obj_class: 0, 1*/
640};
641
Harald Welte4e777c32011-08-17 19:15:24 +0200642/*! \brief Siemens BS11 TRX power */
Harald Welteec8b4502010-02-20 20:34:29 +0100643enum abis_bs11_trx_power {
644 BS11_TRX_POWER_GSM_2W = 0x06,
645 BS11_TRX_POWER_GSM_250mW= 0x07,
646 BS11_TRX_POWER_GSM_80mW = 0x08,
647 BS11_TRX_POWER_GSM_30mW = 0x09,
648 BS11_TRX_POWER_DCS_3W = 0x0a,
649 BS11_TRX_POWER_DCS_1W6 = 0x0b,
650 BS11_TRX_POWER_DCS_500mW= 0x0c,
651 BS11_TRX_POWER_DCS_160mW= 0x0d,
652};
653
Harald Welte4e777c32011-08-17 19:15:24 +0200654/*! \brief Siemens BS11 PLL mode */
Harald Welteec8b4502010-02-20 20:34:29 +0100655enum abis_bs11_li_pll_mode {
656 BS11_LI_PLL_LOCKED = 2,
657 BS11_LI_PLL_STANDALONE = 3,
658};
659
Harald Welte4e777c32011-08-17 19:15:24 +0200660/*! \brief Siemens BS11 E1 line configuration */
Harald Welteec8b4502010-02-20 20:34:29 +0100661enum abis_bs11_line_cfg {
662 BS11_LINE_CFG_STAR = 0x00,
663 BS11_LINE_CFG_MULTIDROP = 0x01,
664 BS11_LINE_CFG_LOOP = 0x02,
665};
666
Harald Welte4e777c32011-08-17 19:15:24 +0200667/*! \brief Siemens BS11 boot phase */
Harald Welteec8b4502010-02-20 20:34:29 +0100668enum abis_bs11_phase {
669 BS11_STATE_SOFTWARE_RQD = 0x01,
670 BS11_STATE_LOAD_SMU_INTENDED = 0x11,
671 BS11_STATE_LOAD_SMU_SAFETY = 0x21,
672 BS11_STATE_LOAD_FAILED = 0x31,
673 BS11_STATE_LOAD_DIAGNOSTIC = 0x41,
674 BS11_STATE_WARM_UP = 0x51,
675 BS11_STATE_WARM_UP_2 = 0x52,
676 BS11_STATE_WAIT_MIN_CFG = 0x62,
677 BS11_STATE_MAINTENANCE = 0x72,
678 BS11_STATE_LOAD_MBCCU = 0x92,
679 BS11_STATE_WAIT_MIN_CFG_2 = 0xA2,
680 BS11_STATE_NORMAL = 0x03,
681 BS11_STATE_ABIS_LOAD = 0x13,
682};
683
Harald Welte4e777c32011-08-17 19:15:24 +0200684/*! \brief ip.access test number */
Harald Welteec8b4502010-02-20 20:34:29 +0100685enum abis_nm_ipacc_test_no {
686 NM_IPACC_TESTNO_RLOOP_ANT = 0x01,
687 NM_IPACC_TESTNO_RLOOP_XCVR = 0x02,
688 NM_IPACC_TESTNO_FUNC_OBJ = 0x03,
689 NM_IPACC_TESTNO_CHAN_USAGE = 0x40,
690 NM_IPACC_TESTNO_BCCH_CHAN_USAGE = 0x41,
691 NM_IPACC_TESTNO_FREQ_SYNC = 0x42,
692 NM_IPACC_TESTNO_BCCH_INFO = 0x43,
693 NM_IPACC_TESTNO_TX_BEACON = 0x44,
694 NM_IPACC_TESTNO_SYSINFO_MONITOR = 0x45,
695 NM_IPACC_TESTNO_BCCCH_MONITOR = 0x46,
696};
697
Harald Welte4e777c32011-08-17 19:15:24 +0200698/*! \brief first byte after length inside NM_ATT_TEST_REPORT */
Harald Welteec8b4502010-02-20 20:34:29 +0100699enum abis_nm_ipacc_test_res {
700 NM_IPACC_TESTRES_SUCCESS = 0,
701 NM_IPACC_TESTRES_TIMEOUT = 1,
702 NM_IPACC_TESTRES_NO_CHANS = 2,
703 NM_IPACC_TESTRES_PARTIAL = 3,
704 NM_IPACC_TESTRES_STOPPED = 4,
705};
706
Harald Welte4e777c32011-08-17 19:15:24 +0200707/*! \brief internal IE inside NM_ATT_TEST_REPORT */
Harald Welteec8b4502010-02-20 20:34:29 +0100708enum abis_nm_ipacc_testres_ie {
709 NM_IPACC_TR_IE_FREQ_ERR_LIST = 3,
710 NM_IPACC_TR_IE_CHAN_USAGE = 4,
711 NM_IPACC_TR_IE_BCCH_INFO = 6,
712 NM_IPACC_TR_IE_RESULT_DETAILS = 8,
713 NM_IPACC_TR_IE_FREQ_ERR = 18,
714};
715
Harald Welte4e777c32011-08-17 19:15:24 +0200716/*! \brief ip.access IEI */
Harald Welteec8b4502010-02-20 20:34:29 +0100717enum ipac_eie {
718 NM_IPAC_EIE_ARFCN_WHITE = 0x01,
719 NM_IPAC_EIE_ARFCH_BLACK = 0x02,
720 NM_IPAC_EIE_FREQ_ERR_LIST = 0x03,
721 NM_IPAC_EIE_CHAN_USE_LIST = 0x04,
722 NM_IPAC_EIE_BCCH_INFO_TYPE = 0x05,
723 NM_IPAC_EIE_BCCH_INFO = 0x06,
Harald Welte380ae252010-03-06 11:29:07 +0100724 NM_IPAC_EIE_CONFIG = 0x07,
725 NM_IPAC_EIE_RES_DETAILS = 0x08,
726 NM_IPAC_EIE_RXLEV_THRESH = 0x09,
727 NM_IPAC_EIE_FREQ_SYNC_OPTS = 0x0a,
728 NM_IPAC_EIE_MAC_ADDR = 0x0b,
729 NM_IPAC_EIE_HW_SW_COMPAT_NR = 0x0c,
730 NM_IPAC_EIE_MANUF_SER_NR = 0x0d,
731 NM_IPAC_EIE_OEM_ID = 0x0e,
732 NM_IPAC_EIE_DATE_TIME_MANUF = 0x0f,
733 NM_IPAC_EIE_DATE_TIME_CALIB = 0x10,
734 NM_IPAC_EIE_BEACON_INFO = 0x11,
735 NM_IPAC_EIE_FREQ_ERR = 0x12,
Harald Welteec8b4502010-02-20 20:34:29 +0100736 /* FIXME */
Harald Welte380ae252010-03-06 11:29:07 +0100737 NM_IPAC_EIE_FREQ_BANDS = 0x1c,
738 NM_IPAC_EIE_MAX_TA = 0x1d,
739 NM_IPAC_EIE_CIPH_ALGOS = 0x1e,
740 NM_IPAC_EIE_CHAN_TYPES = 0x1f,
741 NM_IPAC_EIE_CHAN_MODES = 0x20,
742 NM_IPAC_EIE_GPRS_CODING = 0x21,
743 NM_IPAC_EIE_RTP_FEATURES = 0x22,
744 NM_IPAC_EIE_RSL_FEATURES = 0x23,
745 NM_IPAC_EIE_BTS_HW_CLASS = 0x24,
746 NM_IPAC_EIE_BTS_ID = 0x25,
Harald Welteec8b4502010-02-20 20:34:29 +0100747};
748
Harald Welte4e777c32011-08-17 19:15:24 +0200749/*! \brief ip.access NWL BCCH information type */
Harald Welteec8b4502010-02-20 20:34:29 +0100750enum ipac_bcch_info_type {
751 IPAC_BINF_RXLEV = (1 << 8),
752 IPAC_BINF_RXQUAL = (1 << 9),
753 IPAC_BINF_FREQ_ERR_QUAL = (1 << 10),
754 IPAC_BINF_FRAME_OFFSET = (1 << 11),
755 IPAC_BINF_FRAME_NR_OFFSET = (1 << 12),
756 IPAC_BINF_BSIC = (1 << 13),
757 IPAC_BINF_CGI = (1 << 14),
758 IPAC_BINF_NEIGH_BA_SI2 = (1 << 15),
759 IPAC_BINF_NEIGH_BA_SI2bis = (1 << 0),
760 IPAC_BINF_NEIGH_BA_SI2ter = (1 << 1),
761 IPAC_BINF_CELL_ALLOC = (1 << 2),
762};
763
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200764/*! @} */