blob: c280c89150adefd13fc1a25fba8aef266c3be1bd [file] [log] [blame]
Harald Welte52b1f982008-12-23 20:25:15 +00001/* GSM Network Management messages on the A-bis interface
2 * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0 */
3
Harald Welte4724f992009-01-18 18:01:49 +00004/* (C) 2008-2009 by Harald Welte <laforge@gnumonks.org>
Harald Welte52b1f982008-12-23 20:25:15 +00005 * All Rights Reserved
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 */
22
23#ifndef _NM_H
24#define _NM_H
25
26#include <sys/types.h>
27
Harald Welte03133942009-02-18 19:51:53 +000028#include <openbsc/tlv.h>
29
Harald Welte52b1f982008-12-23 20:25:15 +000030/* PRIVATE */
31
Harald Welte47d88ae2009-01-04 12:02:08 +000032/* generic header in front of every OML message according to TS 08.59 */
Harald Welte52b1f982008-12-23 20:25:15 +000033struct abis_om_hdr {
34 u_int8_t mdisc;
35 u_int8_t placement;
36 u_int8_t sequence;
37 u_int8_t length;
38 u_int8_t data[0];
39} __attribute__ ((packed));
40
41#define ABIS_OM_MDISC_FOM 0x80
42#define ABIS_OM_MDISC_MMI 0x40
43#define ABIS_OM_MDISC_TRAU 0x20
44#define ABIS_OM_MDISC_MANUF 0x10
45#define ABIS_OM_PLACEMENT_ONLY 0x80
46#define ABIS_OM_PLACEMENT_FIRST 0x40
47#define ABIS_OM_PLACEMENT_MIDDLE 0x20
48#define ABIS_OM_PLACEMENT_LAST 0x10
49
50struct abis_om_obj_inst {
51 u_int8_t bts_nr;
52 u_int8_t trx_nr;
53 u_int8_t ts_nr;
54} __attribute__ ((packed));
55
56struct abis_om_fom_hdr {
57 u_int8_t msg_type;
58 u_int8_t obj_class;
59 struct abis_om_obj_inst obj_inst;
Harald Weltef3066bb2009-01-18 19:02:46 +000060 u_int8_t data[0];
Harald Welte52b1f982008-12-23 20:25:15 +000061} __attribute__ ((packed));
62
63#define ABIS_OM_FOM_HDR_SIZE (sizeof(struct abis_om_hdr) + sizeof(struct abis_om_fom_hdr))
64
65/* Section 9.1: Message Types */
66enum abis_nm_msgtype {
67 /* SW Download Management Messages */
68 NM_MT_LOAD_INIT = 0x01,
69 NM_MT_LOAD_INIT_ACK,
70 NM_MT_LOAD_INIT_NACK,
71 NM_MT_LOAD_SEG,
72 NM_MT_LOAD_SEG_ACK,
73 NM_MT_LOAD_ABORT,
74 NM_MT_LOAD_END,
75 NM_MT_LOAD_END_ACK,
76 NM_MT_LOAD_END_NACK,
77 NM_MT_SW_ACT_REQ, /* BTS->BSC */
78 NM_MT_SW_ACT_REQ_ACK,
79 NM_MT_SW_ACT_REQ_NACK,
80 NM_MT_ACTIVATE_SW, /* BSC->BTS */
81 NM_MT_ACTIVATE_SW_ACK,
82 NM_MT_ACTIVATE_SW_NACK,
83 NM_MT_SW_ACTIVATED_REP, /* 0x10 */
84 /* A-bis Interface Management Messages */
85 NM_MT_ESTABLISH_TEI = 0x21,
86 NM_MT_ESTABLISH_TEI_ACK,
87 NM_MT_ESTABLISH_TEI_NACK,
88 NM_MT_CONN_TERR_SIGN,
89 NM_MT_CONN_TERR_SIGN_ACK,
90 NM_MT_CONN_TERR_SIGN_NACK,
91 NM_MT_DISC_TERR_SIGN,
92 NM_MT_DISC_TERR_SIGN_ACK,
93 NM_MT_DISC_TERR_SIGN_NACK,
94 NM_MT_CONN_TERR_TRAF,
95 NM_MT_CONN_TERR_TRAF_ACK,
96 NM_MT_CONN_TERR_TRAF_NACK,
97 NM_MT_DISC_TERR_TRAF,
98 NM_MT_DISC_TERR_TRAF_ACK,
99 NM_MT_DISC_TERR_TRAF_NACK,
100 /* Transmission Management Messages */
101 NM_MT_CONN_MDROP_LINK = 0x31,
102 NM_MT_CONN_MDROP_LINK_ACK,
103 NM_MT_CONN_MDROP_LINK_NACK,
104 NM_MT_DISC_MDROP_LINK,
105 NM_MT_DISC_MDROP_LINK_ACK,
106 NM_MT_DISC_MDROP_LINK_NACK,
107 /* Air Interface Management Messages */
108 NM_MT_SET_BTS_ATTR = 0x41,
109 NM_MT_SET_BTS_ATTR_ACK,
110 NM_MT_SET_BTS_ATTR_NACK,
111 NM_MT_SET_RADIO_ATTR,
112 NM_MT_SET_RADIO_ATTR_ACK,
113 NM_MT_SET_RADIO_ATTR_NACK,
114 NM_MT_SET_CHAN_ATTR,
115 NM_MT_SET_CHAN_ATTR_ACK,
116 NM_MT_SET_CHAN_ATTR_NACK,
117 /* Test Management Messages */
118 NM_MT_PERF_TEST = 0x51,
119 NM_MT_PERF_TESET_ACK,
120 NM_MT_PERF_TEST_NACK,
121 NM_MT_TEST_REP,
122 NM_MT_SEND_TEST_REP,
123 NM_MT_SEND_TEST_REP_ACK,
124 NM_MT_SEND_TEST_REP_NACK,
125 NM_MT_STOP_TEST,
126 NM_MT_STOP_TEST_ACK,
127 NM_MT_STOP_TEST_NACK,
128 /* State Management and Event Report Messages */
129 NM_MT_STATECHG_EVENT_REP = 0x61,
130 NM_MT_FAILURE_EVENT_REP,
131 NM_MT_STOP_EVENT_REP,
132 NM_MT_STOP_EVENT_REP_ACK,
133 NM_MT_STOP_EVENT_REP_NACK,
134 NM_MT_REST_EVENT_REP,
135 NM_MT_REST_EVENT_REP_ACK,
136 NM_MT_REST_EVENT_REP_NACK,
137 NM_MT_CHG_ADM_STATE,
138 NM_MT_CHG_ADM_STATE_ACK,
139 NM_MT_CHG_ADM_STATE_NACK,
140 NM_MT_CHG_ADM_STATE_REQ,
141 NM_MT_CHG_ADM_STATE_REQ_ACK,
142 NM_MT_CHG_ADM_STATE_REQ_NACK,
143 NM_MT_REP_OUTST_ALARMS = 0x93,
144 NM_MT_REP_OUTST_ALARMS_ACK,
145 NM_MT_REP_OUTST_ALARMS_NACK,
146 /* Equipment Management Messages */
147 NM_MT_CHANGEOVER = 0x71,
148 NM_MT_CHANGEOVER_ACK,
149 NM_MT_CHANGEOVER_NACK,
150 NM_MT_OPSTART,
151 NM_MT_OPSTART_ACK,
152 NM_MT_OPSTART_NACK,
153 NM_MT_REINIT,
154 NM_MT_REINIT_ACK,
155 NM_MT_REINIT_NACK,
Harald Welte47d88ae2009-01-04 12:02:08 +0000156 NM_MT_SET_SITE_OUT, /* BS11: get alarm ?!? */
Harald Welte52b1f982008-12-23 20:25:15 +0000157 NM_MT_SET_SITE_OUT_ACK,
158 NM_MT_SET_SITE_OUT_NACK,
159 NM_MT_CHG_HW_CONF = 0x90,
160 NM_MT_CHG_HW_CONF_ACK,
161 NM_MT_CHG_HW_CONF_NACK,
162 /* Measurement Management Messages */
163 NM_MT_MEAS_RES_REQ = 0x8a,
164 NM_MT_MEAS_RES_RESP,
165 NM_MT_STOP_MEAS,
166 NM_MT_START_MEAS,
167 /* Other Messages */
168 NM_MT_GET_ATTR = 0x81,
169 NM_MT_GET_ATTR_RESP,
170 NM_MT_GET_ATTR_NACK,
171 NM_MT_SET_ALARM_THRES,
172 NM_MT_SET_ALARM_THRES_ACK,
173 NM_MT_SET_ALARM_THRES_NACK,
Harald Welte677c21f2009-02-17 13:22:23 +0000174};
175
176enum abis_nm_msgtype_bs11 {
Harald Welte4668fda2009-01-03 08:19:29 +0000177 NM_MT_BS11_RESET_RESOURCE = 0x74,
178
179 NM_MT_BS11_BEGIN_DB_TX = 0xa3,
180 NM_MT_BS11_BEGIN_DB_TX_ACK,
181 NM_MT_BS11_BEGIN_DB_TX_NACK,
182 NM_MT_BS11_END_DB_TX = 0xa6,
183 NM_MT_BS11_END_DB_TX_ACK,
184 NM_MT_BS11_END_DB_TX_NACK,
185 NM_MT_BS11_CREATE_OBJ = 0xa9,
186 NM_MT_BS11_CREATE_OBJ_ACK,
187 NM_MT_BS11_CREATE_OBJ_NACK,
188 NM_MT_BS11_DELETE_OBJ = 0xac,
189 NM_MT_BS11_DELETE_OBJ_ACK,
190 NM_MT_BS11_DELETE_OBJ_NACK,
191
Harald Welteadaf08b2009-01-18 11:08:10 +0000192 NM_MT_BS11_SET_ATTR = 0xd0,
193 NM_MT_BS11_SET_ATTR_ACK,
Harald Welte5659d662009-02-21 20:45:39 +0000194 NM_MT_BS11_SET_ATTR_NACK,
Harald Weltea7dbe492009-02-06 16:44:37 +0000195 NM_MT_BS11_LMT_SESSION = 0xdc,
Harald Welte4668fda2009-01-03 08:19:29 +0000196
Harald Welte1bc09062009-01-18 14:17:52 +0000197 NM_MT_BS11_GET_STATE = 0xe3,
198 NM_MT_BS11_GET_STATE_ACK,
Harald Welte043d04a2009-01-29 23:15:30 +0000199 NM_MT_BS11_LMT_LOGON = 0xe5,
200 NM_MT_BS11_LMT_LOGON_ACK,
Harald Welte4668fda2009-01-03 08:19:29 +0000201 NM_MT_BS11_RESTART = 0xe7,
Harald Welteadaf08b2009-01-18 11:08:10 +0000202 NM_MT_BS11_RESTART_ACK,
Harald Welte4668fda2009-01-03 08:19:29 +0000203 NM_MT_BS11_DISCONNECT = 0xe9,
Harald Welteadaf08b2009-01-18 11:08:10 +0000204 NM_MT_BS11_DISCONNECT_ACK,
Harald Welte5e4d1b32009-02-01 13:36:56 +0000205 NM_MT_BS11_LMT_LOGOFF = 0xec,
206 NM_MT_BS11_LMT_LOGOFF_ACK,
Harald Welte4668fda2009-01-03 08:19:29 +0000207 NM_MT_BS11_RECONNECT = 0xf1,
Harald Welteadaf08b2009-01-18 11:08:10 +0000208 NM_MT_BS11_RECONNECT_ACK,
Harald Welte52b1f982008-12-23 20:25:15 +0000209};
210
Harald Welte677c21f2009-02-17 13:22:23 +0000211enum abis_nm_msgtype_ipacc {
212 NM_MT_IPACC_RSL_CONNECT = 0xe0,
213 NM_MT_IPACC_RSL_CONNECT_ACK,
214 NM_MT_IPACC_RSL_CONNECT_NACK,
215};
216
Harald Welte52b1f982008-12-23 20:25:15 +0000217/* Section 9.2: Object Class */
218enum abis_nm_obj_class {
219 NM_OC_SITE_MANAGER = 0x00,
220 NM_OC_BTS,
221 NM_OC_RADIO_CARRIER,
Harald Welte52b1f982008-12-23 20:25:15 +0000222 NM_OC_CHANNEL,
Harald Welte34a99682009-02-13 02:41:40 +0000223 NM_OC_BASEB_TRANSC,
Harald Welte52b1f982008-12-23 20:25:15 +0000224 /* RFU: 05-FE */
Harald Welteadaf08b2009-01-18 11:08:10 +0000225 NM_OC_BS11_A0 = 0xa0,
226 NM_OC_BS11_A3 = 0xa3,
227 NM_OC_BS11_A4 = 0xa4,
Harald Welte47d88ae2009-01-04 12:02:08 +0000228 NM_OC_BS11 = 0xa5,
Harald Welteadaf08b2009-01-18 11:08:10 +0000229 NM_OC_BS11_A6 = 0xa6,
Harald Welte47d88ae2009-01-04 12:02:08 +0000230 NM_OC_BS11_ENVABTSE = 0xa8,
231 NM_OC_BS11_BPORT = 0xa9,
Harald Welte4668fda2009-01-03 08:19:29 +0000232
Harald Welte5c1e4582009-02-15 11:57:29 +0000233 NM_OC_GPRS_NSE = 0xf0,
234 NM_OC_GPRS_CELL = 0xf1,
235 NM_OC_GPRS_NSVC0 = 0xf2,
236 NM_OC_GPRS_NSVC1 = 0xf3,
237
Harald Welte52b1f982008-12-23 20:25:15 +0000238 NM_OC_NULL = 0xff,
239};
240
241/* Section 9.4: Attributes */
242enum abis_nm_attr {
Harald Welteadaf08b2009-01-18 11:08:10 +0000243 NM_ATT_ABIS_CHANNEL = 0x01,
Harald Welte52b1f982008-12-23 20:25:15 +0000244 NM_ATT_ADD_INFO,
245 NM_ATT_ADD_TEXT,
246 NM_ATT_ADM_STATE,
247 NM_ATT_ARFCN_LIST,
248 NM_ATT_AUTON_REPORT,
249 NM_ATT_AVAIL_STATUS,
250 NM_ATT_BCCH_ARFCN,
251 NM_ATT_BSIC,
252 NM_ATT_BTS_AIR_TIMER,
253 NM_ATT_CCCH_L_I_P,
254 NM_ATT_CCCH_L_T,
255 NM_ATT_CHAN_COMB,
256 NM_ATT_CONN_FAIL_CRIT,
257 NM_ATT_DEST,
258 /* res */
Harald Welte47d88ae2009-01-04 12:02:08 +0000259 NM_ATT_EVENT_TYPE = 0x11, /* BS11: file data ?!? */
Harald Welte52b1f982008-12-23 20:25:15 +0000260 NM_ATT_FILE_ID,
261 NM_ATT_FILE_VERSION,
262 NM_ATT_GSM_TIME,
263 NM_ATT_HSN,
264 NM_ATT_HW_CONFIG,
265 NM_ATT_HW_DESC,
266 NM_ATT_INTAVE_PARAM,
267 NM_ATT_INTERF_BOUND,
268 NM_ATT_LIST_REQ_ATTR,
269 NM_ATT_MAIO,
270 NM_ATT_MANUF_STATE,
271 NM_ATT_MANUF_THRESH,
272 NM_ATT_MANUF_ID,
273 NM_ATT_MAX_TA,
274 NM_ATT_MDROP_LINK, /* 0x20 */
275 NM_ATT_MDROP_NEXT,
276 NM_ATT_NACK_CAUSES,
277 NM_ATT_NY1,
278 NM_ATT_OPER_STATE,
279 NM_ATT_OVERL_PERIOD,
280 NM_ATT_PHYS_CONF,
281 NM_ATT_POWER_CLASS,
282 NM_ATT_POWER_THRESH,
283 NM_ATT_PROB_CAUSE,
284 NM_ATT_RACH_B_THRESH,
285 NM_ATT_LDAVG_SLOTS,
286 NM_ATT_RAD_SUBC,
287 NM_ATT_RF_MAXPOWR_R,
288 NM_ATT_SITE_INPUTS,
289 NM_ATT_SITE_OUTPUTS,
290 NM_ATT_SOURCE, /* 0x30 */
291 NM_ATT_SPEC_PROB,
292 NM_ATT_START_TIME,
293 NM_ATT_T200,
294 NM_ATT_TEI,
295 NM_ATT_TEST_DUR,
296 NM_ATT_TEST_NO,
297 NM_ATT_TEST_REPORT,
298 NM_ATT_VSWR_THRESH,
299 NM_ATT_WINDOW_SIZE,
300 /* Res */
Harald Welte934e68b2009-01-29 23:08:12 +0000301 NM_ATT_BS11_RSSI_OFFS = 0x3d,
Harald Welteadaf08b2009-01-18 11:08:10 +0000302 NM_ATT_BS11_TXPWR = 0x3e,
Harald Welte934e68b2009-01-29 23:08:12 +0000303 NM_ATT_BS11_DIVERSITY = 0x3f,
Harald Welteadaf08b2009-01-18 11:08:10 +0000304 /* Res */
Harald Welte52b1f982008-12-23 20:25:15 +0000305 NM_ATT_TSC = 0x40,
306 NM_ATT_SW_CONFIG,
307 NM_ATT_SW_DESCR,
308 NM_ATT_SEVERITY,
309 NM_ATT_GET_ARI,
310 NM_ATT_HW_CONF_CHG,
311 NM_ATT_OUTST_ALARM,
312 NM_ATT_FILE_DATA,
313 NM_ATT_MEAS_RES,
314 NM_ATT_MEAS_TYPE,
Harald Welte1bc09062009-01-18 14:17:52 +0000315
Harald Welte5e4d1b32009-02-01 13:36:56 +0000316 NM_ATT_BS11_ESN_FW_CODE_NO = 0x4c,
317 NM_ATT_BS11_ESN_HW_CODE_NO = 0x4f,
318
319 NM_ATT_BS11_ESN_PCB_SERIAL = 0x55,
Harald Weltecd993872009-02-15 16:16:28 +0000320 NM_ATT_BS11_EXCESSIVE_DISTANCE = 0x58,
Harald Welte5e4d1b32009-02-01 13:36:56 +0000321
Harald Welte934e68b2009-01-29 23:08:12 +0000322 NM_ATT_BS11_ALL_TEST_CATG = 0x60,
323 NM_ATT_BS11_BTSLS_HOPPING,
324 NM_ATT_BS11_CELL_ALLOC_NR,
325 NM_ATT_BS11_CALL_GLOBAL_ID,
326 NM_ATT_BS11_ENA_INTERF_CLASS = 0x66,
327 NM_ATT_BS11_ENA_INT_INTEC_HANDO = 0x67,
328 NM_ATT_BS11_ENA_INT_INTRC_HANDO = 0x68,
329 NM_ATT_BS11_ENA_MS_PWR_CTRL = 0x69,
330 NM_ATT_BS11_ENA_PWR_BDGT_HO = 0x6a,
331 NM_ATT_BS11_ENA_PWR_CTRL_RLFW = 0x6b,
332 NM_ATT_BS11_ENA_RXLEV_HO = 0x6c,
333 NM_ATT_BS11_ENA_RXQUAL_HO = 0x6d,
Harald Weltecd993872009-02-15 16:16:28 +0000334 NM_ATT_BS11_FACCH_QUAL = 0x6e,
335
Harald Welte677c21f2009-02-17 13:22:23 +0000336 NM_ATT_IPACC_RSL_BSC_IP = 0x80,
337 NM_ATT_IPACC_RSL_BSC_PORT = 0x81,
338
Harald Weltecd993872009-02-15 16:16:28 +0000339 NM_ATT_BS11_RF_RES_IND_PER = 0x8f,
Harald Welte934e68b2009-01-29 23:08:12 +0000340
341 NM_ATT_BS11_RX_LEV_MIN_CELL = 0x90,
342 NM_ATT_BS11_ABIS_EXT_TIME = 0x91,
343 NM_ATT_BS11_TIMER_HO_REQUEST = 0x92,
344 NM_ATT_BS11_TIMER_NCELL = 0x93,
345 NM_ATT_BS11_TSYNC = 0x94,
346 NM_ATT_BS11_TTRAU = 0x95,
Harald Weltecd993872009-02-15 16:16:28 +0000347 NM_ATT_BS11_EMRG_CFG_MEMBER = 0x9b,
348 NM_ATT_BS11_TRX_AREA = 0x9f,
Harald Welte934e68b2009-01-29 23:08:12 +0000349
350 NM_ATT_BS11_BCCH_RECONF = 0xd7,
351 NM_ATT_BS11_BIT_ERR_THESH = 0xa0,
352 NM_ATT_BS11_BOOT_SW_VERS = 0xa1,
353 NM_ATT_BS11_CCLK_ACCURACY = 0xa3,
354 NM_ATT_BS11_CCLK_TYPE = 0xa4,
355 NM_ATT_BS11_INP_IMPEDANCE = 0xaa,
356 NM_ATT_BS11_L1_PROT_TYPE = 0xab,
357 NM_ATT_BS11_LINE_CFG = 0xac,
358 NM_ATT_BS11_LI_PORT_1 = 0xad,
359 NM_ATT_BS11_LI_PORT_2 = 0xae,
360
361 NM_ATT_BS11_L1_REM_ALM_TYPE = 0xb0,
362 NM_ATT_BS11_SW_LOAD_INTENDED = 0xbb,
363 NM_ATT_BS11_SW_LOAD_SAFETY = 0xbc,
Harald Welte5e4d1b32009-02-01 13:36:56 +0000364 NM_ATT_BS11_SW_LOAD_STORED = 0xbd,
Harald Welte934e68b2009-01-29 23:08:12 +0000365
366 NM_ATT_BS11_VENDOR_NAME = 0xc1,
Harald Weltecd993872009-02-15 16:16:28 +0000367 NM_ATT_BS11_HOPPING_MODE = 0xc5,
Harald Welte934e68b2009-01-29 23:08:12 +0000368 NM_ATT_BS11_LMT_LOGON_SESSION = 0xc6,
369 NM_ATT_BS11_LMT_LOGIN_TIME = 0xc7,
370 NM_ATT_BS11_LMT_USER_ACC_LEV = 0xc8,
371 NM_ATT_BS11_LMT_USER_NAME = 0xc9,
372
373 NM_ATT_BS11_L1_CONTROL_TS = 0xd8,
Harald Weltecd993872009-02-15 16:16:28 +0000374 NM_ATT_BS11_RADIO_MEAS_GRAN = 0xdc, /* in SACCH multiframes */
375 NM_ATT_BS11_RADIO_MEAS_REP = 0xdd,
Harald Welte934e68b2009-01-29 23:08:12 +0000376
Harald Welte03133942009-02-18 19:51:53 +0000377 NM_ATT_BS11_BTS_STATE = 0xf0,
378 NM_ATT_BS11_E1_STATE = 0xf1,
Harald Welte934e68b2009-01-29 23:08:12 +0000379 NM_ATT_BS11_PLL = 0xf2,
380 NM_ATT_BS11_RX_OFFSET = 0xf3,
381 NM_ATT_BS11_ANT_TYPE = 0xf4,
382 NM_ATT_BS11_PASSWORD = 0xfd,
Harald Welte52b1f982008-12-23 20:25:15 +0000383};
Harald Welte3b8ba212009-01-29 12:27:58 +0000384#define NM_ATT_BS11_FILE_DATA NM_ATT_EVENT_TYPE
Harald Welte52b1f982008-12-23 20:25:15 +0000385
386/* Section 9.4.4: Administrative State */
387enum abis_nm_adm_state {
388 NM_STATE_LOCKED = 0x01,
389 NM_STATE_UNLOCKED = 0x02,
390 NM_STATE_SHUTDOWN = 0x03,
391 NM_STATE_NULL = 0xff,
392};
393
394/* Section 9.4.13: Channel Combination */
395enum abis_nm_chan_comb {
396 NM_CHANC_TCHFull = 0x00,
397 NM_CHANC_TCHHalf = 0x01,
398 NM_CHANC_TCHHalf2 = 0x02,
399 NM_CHANC_SDCCH = 0x03,
400 NM_CHANC_mainBCCH = 0x04,
401 NM_CHANC_BCCCHComb = 0x05,
402 NM_CHANC_BCCH = 0x06,
403 NM_CHANC_BCCH_CBCH = 0x07,
404 NM_CHANC_SDCCH_CBCH = 0x08,
405};
406
Harald Weltee0590df2009-02-15 03:34:15 +0000407/* Section 9.4.36: NACK Causes */
408enum abis_nm_nack_cause {
409 /* General Nack Causes */
410 NM_NACK_INCORR_STRUCT = 0x01,
411 NM_NACK_MSGTYPE_INVAL = 0x02,
412 NM_NACK_OBJCLASS_INVAL = 0x05,
413 NM_NACK_OBJCLASS_NOTSUPP = 0x06,
414 NM_NACK_BTSNR_UNKN = 0x07,
415 NM_NACK_TRXNR_UNKN = 0x08,
416 NM_NACK_OBJINST_UNKN = 0x09,
417 NM_NACK_ATTRID_INVAL = 0x0c,
418 NM_NACK_ATTRID_NOTSUPP = 0x0d,
419 NM_NACK_PARAM_RANGE = 0x0e,
420 NM_NACK_ATTRLIST_INCONSISTENT = 0x0f,
421 NM_NACK_SPEC_IMPL_NOTSUPP = 0x10,
422 NM_NACK_CANT_PERFORM = 0x11,
423 /* Specific Nack Causes */
424 NM_NACK_RES_NOTIMPL = 0x19,
425 NM_NACK_RES_NOTAVAIL = 0x1a,
426 NM_NACK_FREQ_NOTAVAIL = 0x1b,
427 NM_NACK_TEST_NOTSUPP = 0x1c,
428 NM_NACK_CAPACITY_RESTR = 0x1d,
429 NM_NACK_PHYSCFG_NOTPERFORM = 0x1e,
430 NM_NACK_TEST_NOTINIT = 0x1f,
431 NM_NACK_PHYSCFG_NOTRESTORE = 0x20,
432 NM_NACK_TEST_NOSUCH = 0x21,
433 NM_NACK_TEST_NOSTOP = 0x22,
434 NM_NACK_MSGINCONSIST_PHYSCFG = 0x23,
435 NM_NACK_FILE_INCOMPLETE = 0x25,
436 NM_NACK_FILE_NOTAVAIL = 0x26,
437 MN_NACK_FILE_NOTACTIVATE = 0x27,
438 NM_NACK_REQ_NOT_GRANT = 0x28,
439 NM_NACK_WAIT = 0x29,
440 NM_NACK_NOTH_REPORT_EXIST = 0x2a,
441 NM_NACK_MEAS_NOTSUPP = 0x2b,
442 NM_NACK_MEAS_NOTSTART = 0x2c,
443};
444
Harald Welte52b1f982008-12-23 20:25:15 +0000445/* Section 9.4.1 */
Harald Welte8470bf22008-12-25 23:28:35 +0000446struct abis_nm_channel {
Harald Welte52b1f982008-12-23 20:25:15 +0000447 u_int8_t attrib;
448 u_int8_t bts_port;
449 u_int8_t timeslot;
450 u_int8_t subslot;
451} __attribute__ ((packed));
452
Harald Welte47d88ae2009-01-04 12:02:08 +0000453/* Siemens BS-11 specific */
454enum abis_bs11_objtype {
455 BS11_OBJ_ALCO = 0x01,
456 BS11_OBJ_BBSIG = 0x02, /* obj_class: 0,1 */
457 BS11_OBJ_TRX1 = 0x03, /* only DEACTIVATE TRX1 */
458 BS11_OBJ_CCLK = 0x04,
459 BS11_OBJ_GPSU = 0x06,
460 BS11_OBJ_LI = 0x07,
461 BS11_OBJ_PA = 0x09, /* obj_class: 0, 1*/
462};
463
Harald Welte1bc09062009-01-18 14:17:52 +0000464enum abis_bs11_trx_power {
Harald Welte5e4d1b32009-02-01 13:36:56 +0000465 BS11_TRX_POWER_GSM_2W = 0x06,
466 BS11_TRX_POWER_GSM_250mW= 0x07,
467 BS11_TRX_POWER_GSM_80mW = 0x08,
468 BS11_TRX_POWER_GSM_30mW = 0x09,
469 BS11_TRX_POWER_DCS_3W = 0x0a,
470 BS11_TRX_POWER_DCS_1W6 = 0x0b,
471 BS11_TRX_POWER_DCS_500mW= 0x0c,
472 BS11_TRX_POWER_DCS_160mW= 0x0d,
Harald Welte1bc09062009-01-18 14:17:52 +0000473};
474
Harald Welte268bb402009-02-01 19:11:56 +0000475enum abis_bs11_phase {
Harald Welte1bc09062009-01-18 14:17:52 +0000476 BS11_STATE_SOFTWARE_RQD = 0x01,
Harald Welte268bb402009-02-01 19:11:56 +0000477 BS11_STATE_LOAD_SMU_INTENDED = 0x11,
Harald Welte1bc09062009-01-18 14:17:52 +0000478 BS11_STATE_LOAD_SMU_SAFETY = 0x21,
Harald Weltec12d52b2009-02-01 21:39:06 +0000479 BS11_STATE_LOAD_FAILED = 0x31,
480 BS11_STATE_LOAD_DIAGNOSTIC = 0x41,
Harald Welte1bc09062009-01-18 14:17:52 +0000481 BS11_STATE_WARM_UP = 0x51,
Harald Weltec12d52b2009-02-01 21:39:06 +0000482 BS11_STATE_WARM_UP_2 = 0x52,
Harald Welte1bc09062009-01-18 14:17:52 +0000483 BS11_STATE_WAIT_MIN_CFG = 0x62,
484 BS11_STATE_MAINTENANCE = 0x72,
Harald Welte268bb402009-02-01 19:11:56 +0000485 BS11_STATE_LOAD_MBCCU = 0x92,
Harald Welte1bc09062009-01-18 14:17:52 +0000486 BS11_STATE_WAIT_MIN_CFG_2 = 0xA2,
Harald Welte5e4d1b32009-02-01 13:36:56 +0000487 BS11_STATE_NORMAL = 0x03,
Harald Welte34a99682009-02-13 02:41:40 +0000488 BS11_STATE_ABIS_LOAD = 0x13,
Harald Welte1bc09062009-01-18 14:17:52 +0000489};
490
Harald Welte268bb402009-02-01 19:11:56 +0000491
Harald Welte52b1f982008-12-23 20:25:15 +0000492/* PUBLIC */
493
494struct msgb;
495
496struct abis_nm_cfg {
497 /* callback for unidirectional reports */
498 int (*report_cb)(struct msgb *,
499 struct abis_om_fom_hdr *);
500 /* callback for software activate requests from BTS */
501 int (*sw_act_req)(struct msgb *);
502};
503
Harald Welte8470bf22008-12-25 23:28:35 +0000504extern int abis_nm_rcvmsg(struct msgb *msg);
Harald Welte52b1f982008-12-23 20:25:15 +0000505
Harald Welte03133942009-02-18 19:51:53 +0000506int abis_nm_tlv_parse(struct tlv_parsed *tp, const u_int8_t *buf, int len);
Harald Welte52b1f982008-12-23 20:25:15 +0000507int abis_nm_rx(struct msgb *msg);
Harald Welte34a99682009-02-13 02:41:40 +0000508int abis_nm_opstart(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i0, u_int8_t i1, u_int8_t i2);
509int abis_nm_chg_adm_state(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i0,
510 u_int8_t i1, u_int8_t i2, u_int8_t adm_state);
Harald Welte52b1f982008-12-23 20:25:15 +0000511int abis_nm_establish_tei(struct gsm_bts *bts, u_int8_t trx_nr,
512 u_int8_t e1_port, u_int8_t e1_timeslot, u_int8_t e1_subslot,
513 u_int8_t tei);
514int abis_nm_conn_terr_sign(struct gsm_bts_trx *trx,
515 u_int8_t e1_port, u_int8_t e1_timeslot, u_int8_t e1_subslot);
516int abis_nm_conn_terr_traf(struct gsm_bts_trx_ts *ts,
517 u_int8_t e1_port, u_int8_t e1_timeslot,
518 u_int8_t e1_subslot);
Harald Welte22af0db2009-02-14 15:41:08 +0000519int abis_nm_set_bts_attr(struct gsm_bts *bts, u_int8_t *attr, int attr_len);
520int abis_nm_set_radio_attr(struct gsm_bts_trx *trx, u_int8_t *attr, int attr_len);
Harald Welte52b1f982008-12-23 20:25:15 +0000521int abis_nm_set_channel_attr(struct gsm_bts_trx_ts *ts, u_int8_t chan_comb);
Harald Welte34a99682009-02-13 02:41:40 +0000522int abis_nm_sw_act_req_ack(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i1,
Harald Welte5c1e4582009-02-15 11:57:29 +0000523 u_int8_t i2, u_int8_t i3, int nack, u_int8_t *attr, int att_len);
Harald Welte52b1f982008-12-23 20:25:15 +0000524int abis_nm_raw_msg(struct gsm_bts *bts, int len, u_int8_t *msg);
525int abis_nm_event_reports(struct gsm_bts *bts, int on);
526int abis_nm_reset_resource(struct gsm_bts *bts);
Harald Welte5e4d1b32009-02-01 13:36:56 +0000527int abis_nm_software_load(struct gsm_bts *bts, const char *fname,
Harald Welte3ffd1372009-02-01 22:15:49 +0000528 u_int8_t win_size, int forced,
529 gsm_cbfn *cbfn, void *cb_data);
530int abis_nm_software_load_status(struct gsm_bts *bts);
Harald Welte5e4d1b32009-02-01 13:36:56 +0000531int abis_nm_software_activate(struct gsm_bts *bts, const char *fname,
532 gsm_cbfn *cbfn, void *cb_data);
Harald Welte47d88ae2009-01-04 12:02:08 +0000533
534/* Siemens / BS-11 specific */
Holger Freyther245c5342009-01-27 19:00:44 +0000535int abis_nm_bs11_reset_resource(struct gsm_bts *bts);
Harald Welte05188ee2009-01-18 11:39:08 +0000536int abis_nm_bs11_db_transmission(struct gsm_bts *bts, int begin);
537int abis_nm_bs11_create_object(struct gsm_bts *bts, enum abis_bs11_objtype type,
Harald Welte1bc09062009-01-18 14:17:52 +0000538 u_int8_t idx, u_int8_t attr_len, const u_int8_t *attr);
Harald Welte05188ee2009-01-18 11:39:08 +0000539int abis_nm_bs11_create_envaBTSE(struct gsm_bts *bts, u_int8_t idx);
540int abis_nm_bs11_create_bport(struct gsm_bts *bts, u_int8_t idx);
Harald Welte78fc0d42009-02-19 02:50:57 +0000541int abis_nm_bs11_delete_object(struct gsm_bts *bts,
542 enum abis_bs11_objtype type, u_int8_t idx);
Harald Welteb6c92ae2009-02-21 20:15:32 +0000543int abis_nm_bs11_conn_oml_tei(struct gsm_bts *bts, u_int8_t e1_port,
544 u_int8_t e1_timeslot, u_int8_t e1_subslot, u_int8_t tei);
Harald Welte78fc0d42009-02-19 02:50:57 +0000545int abis_nm_bs11_get_oml_tei_ts(struct gsm_bts *bts);
546int abis_nm_bs11_get_serno(struct gsm_bts *bts);
Harald Welte05188ee2009-01-18 11:39:08 +0000547int abis_nm_bs11_set_trx_power(struct gsm_bts_trx *trx, u_int8_t level);
Harald Welte78fc0d42009-02-19 02:50:57 +0000548int abis_nm_bs11_get_trx_power(struct gsm_bts_trx *trx);
Harald Welte1bc09062009-01-18 14:17:52 +0000549int abis_nm_bs11_factory_logon(struct gsm_bts *bts, int on);
550int abis_nm_bs11_set_trx1_pw(struct gsm_bts *bts, const char *password);
551int abis_nm_bs11_get_state(struct gsm_bts *bts);
Harald Welte5e4d1b32009-02-01 13:36:56 +0000552int abis_nm_bs11_load_swl(struct gsm_bts *bts, const char *fname,
Harald Welte3ffd1372009-02-01 22:15:49 +0000553 u_int8_t win_size, int forced, gsm_cbfn *cbfn);
Harald Welte268bb402009-02-01 19:11:56 +0000554int abis_nm_bs11_set_ext_time(struct gsm_bts *bts);
Harald Welte3ffd1372009-02-01 22:15:49 +0000555int abis_nm_bs11_bsc_disconnect(struct gsm_bts *bts, int reconnect);
Harald Welte1fa60c82009-02-09 18:13:26 +0000556int abis_nm_bs11_restart(struct gsm_bts *bts);
Harald Welte52b1f982008-12-23 20:25:15 +0000557
Harald Welte5c1e4582009-02-15 11:57:29 +0000558/* ip.access nanoBTS specific commands */
559int abis_nm_ipaccess_msg(struct gsm_bts *bts, u_int8_t msg_type,
560 u_int8_t obj_class, u_int8_t bts_nr,
561 u_int8_t trx_nr, u_int8_t ts_nr,
562 u_int8_t *attr, int attr_len);
563
Harald Weltee0590df2009-02-15 03:34:15 +0000564/* Functions calling into other code parts */
565enum nm_evt {
566 EVT_STATECHG_OPER,
567 EVT_STATECHG_ADM,
568};
569int nm_state_event(enum nm_evt evt, u_int8_t obj_class, void *obj,
570 struct gsm_nm_state *old_state, struct gsm_nm_state *new_state);
571
Harald Welte52b1f982008-12-23 20:25:15 +0000572#endif /* _NM_H */