blob: 7207fb97190aab42375235a3b2d087c58210298d [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*
2 * (C) 2008-2011 by Harald Welte <laforge@gnumonks.org>
Harald Weltef7a1bcc2011-05-22 22:45:16 +02003 *
4 * 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 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 *
19 */
20
Harald Welte4e777c32011-08-17 19:15:24 +020021/*! \addtogroup oml
22 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020023 * GSM Network Management (OML) messages on the A-bis interface.
Harald Welte96e2a002017-06-12 21:44:18 +020024 * 3GPP TS 12.21 version 8.0.0 Release 1999 / ETSI TS 100 623 V8.0.0
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020025 *
26 * \file abis_nm.c */
Harald Welte4e777c32011-08-17 19:15:24 +020027
Harald Weltef7a1bcc2011-05-22 22:45:16 +020028#include <stdint.h>
Harald Welte11c71932011-05-24 17:15:12 +020029#include <errno.h>
30
Harald Weltef7a1bcc2011-05-22 22:45:16 +020031#include <osmocom/core/utils.h>
32#include <osmocom/core/logging.h>
33#include <osmocom/gsm/tlv.h>
Harald Welte11c71932011-05-24 17:15:12 +020034#include <osmocom/gsm/gsm_utils.h>
Harald Weltef7a1bcc2011-05-22 22:45:16 +020035#include <osmocom/gsm/protocol/gsm_12_21.h>
36#include <osmocom/gsm/abis_nm.h>
37
Harald Welte604d5522014-08-17 18:42:58 +020038const char abis_nm_ipa_magic[13] = "com.ipaccess";
39const char abis_nm_osmo_magic[12] = "org.osmocom";
40
Neels Hofmeyr87e45502017-06-20 00:17:59 +020041/*! unidirectional messages from BTS to BSC */
Harald Weltef7a1bcc2011-05-22 22:45:16 +020042const enum abis_nm_msgtype abis_nm_reports[4] = {
43 NM_MT_SW_ACTIVATED_REP,
44 NM_MT_TEST_REP,
45 NM_MT_STATECHG_EVENT_REP,
46 NM_MT_FAILURE_EVENT_REP,
47};
48
Neels Hofmeyr87e45502017-06-20 00:17:59 +020049/*! messages without ACK/NACK */
Harald Weltef7a1bcc2011-05-22 22:45:16 +020050const enum abis_nm_msgtype abis_nm_no_ack_nack[3] = {
51 NM_MT_MEAS_RES_REQ,
52 NM_MT_STOP_MEAS,
53 NM_MT_START_MEAS,
54};
55
Neels Hofmeyr87e45502017-06-20 00:17:59 +020056/*! messages related to software load */
Harald Weltef7a1bcc2011-05-22 22:45:16 +020057const enum abis_nm_msgtype abis_nm_sw_load_msgs[9] = {
58 NM_MT_LOAD_INIT_ACK,
59 NM_MT_LOAD_INIT_NACK,
60 NM_MT_LOAD_SEG_ACK,
61 NM_MT_LOAD_ABORT,
62 NM_MT_LOAD_END_ACK,
63 NM_MT_LOAD_END_NACK,
64 //NM_MT_SW_ACT_REQ,
65 NM_MT_ACTIVATE_SW_ACK,
66 NM_MT_ACTIVATE_SW_NACK,
67 NM_MT_SW_ACTIVATED_REP,
68};
69
Neels Hofmeyr87e45502017-06-20 00:17:59 +020070/*! All NACKs (negative acknowledgements */
Harald Weltef7a1bcc2011-05-22 22:45:16 +020071const enum abis_nm_msgtype abis_nm_nacks[33] = {
72 NM_MT_LOAD_INIT_NACK,
73 NM_MT_LOAD_END_NACK,
74 NM_MT_SW_ACT_REQ_NACK,
75 NM_MT_ACTIVATE_SW_NACK,
76 NM_MT_ESTABLISH_TEI_NACK,
77 NM_MT_CONN_TERR_SIGN_NACK,
78 NM_MT_DISC_TERR_SIGN_NACK,
79 NM_MT_CONN_TERR_TRAF_NACK,
80 NM_MT_DISC_TERR_TRAF_NACK,
81 NM_MT_CONN_MDROP_LINK_NACK,
82 NM_MT_DISC_MDROP_LINK_NACK,
83 NM_MT_SET_BTS_ATTR_NACK,
84 NM_MT_SET_RADIO_ATTR_NACK,
85 NM_MT_SET_CHAN_ATTR_NACK,
86 NM_MT_PERF_TEST_NACK,
87 NM_MT_SEND_TEST_REP_NACK,
88 NM_MT_STOP_TEST_NACK,
89 NM_MT_STOP_EVENT_REP_NACK,
90 NM_MT_REST_EVENT_REP_NACK,
91 NM_MT_CHG_ADM_STATE_NACK,
92 NM_MT_CHG_ADM_STATE_REQ_NACK,
93 NM_MT_REP_OUTST_ALARMS_NACK,
94 NM_MT_CHANGEOVER_NACK,
95 NM_MT_OPSTART_NACK,
96 NM_MT_REINIT_NACK,
97 NM_MT_SET_SITE_OUT_NACK,
98 NM_MT_CHG_HW_CONF_NACK,
99 NM_MT_GET_ATTR_NACK,
100 NM_MT_SET_ALARM_THRES_NACK,
Pau Espin Pedrolb3be9642017-06-23 12:38:55 +0200101 (enum abis_nm_msgtype) NM_MT_BS11_BEGIN_DB_TX_NACK,
102 (enum abis_nm_msgtype) NM_MT_BS11_END_DB_TX_NACK,
103 (enum abis_nm_msgtype) NM_MT_BS11_CREATE_OBJ_NACK,
104 (enum abis_nm_msgtype) NM_MT_BS11_DELETE_OBJ_NACK,
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200105};
106
107static const struct value_string nack_names[] = {
108 { NM_MT_LOAD_INIT_NACK, "SOFTWARE LOAD INIT" },
109 { NM_MT_LOAD_END_NACK, "SOFTWARE LOAD END" },
110 { NM_MT_SW_ACT_REQ_NACK, "SOFTWARE ACTIVATE REQUEST" },
111 { NM_MT_ACTIVATE_SW_NACK, "ACTIVATE SOFTWARE" },
112 { NM_MT_ESTABLISH_TEI_NACK, "ESTABLISH TEI" },
113 { NM_MT_CONN_TERR_SIGN_NACK, "CONNECT TERRESTRIAL SIGNALLING" },
114 { NM_MT_DISC_TERR_SIGN_NACK, "DISCONNECT TERRESTRIAL SIGNALLING" },
115 { NM_MT_CONN_TERR_TRAF_NACK, "CONNECT TERRESTRIAL TRAFFIC" },
116 { NM_MT_DISC_TERR_TRAF_NACK, "DISCONNECT TERRESTRIAL TRAFFIC" },
117 { NM_MT_CONN_MDROP_LINK_NACK, "CONNECT MULTI-DROP LINK" },
118 { NM_MT_DISC_MDROP_LINK_NACK, "DISCONNECT MULTI-DROP LINK" },
119 { NM_MT_SET_BTS_ATTR_NACK, "SET BTS ATTRIBUTE" },
120 { NM_MT_SET_RADIO_ATTR_NACK, "SET RADIO ATTRIBUTE" },
121 { NM_MT_SET_CHAN_ATTR_NACK, "SET CHANNEL ATTRIBUTE" },
122 { NM_MT_PERF_TEST_NACK, "PERFORM TEST" },
123 { NM_MT_SEND_TEST_REP_NACK, "SEND TEST REPORT" },
124 { NM_MT_STOP_TEST_NACK, "STOP TEST" },
125 { NM_MT_STOP_EVENT_REP_NACK, "STOP EVENT REPORT" },
126 { NM_MT_REST_EVENT_REP_NACK, "RESET EVENT REPORT" },
127 { NM_MT_CHG_ADM_STATE_NACK, "CHANGE ADMINISTRATIVE STATE" },
128 { NM_MT_CHG_ADM_STATE_REQ_NACK,
129 "CHANGE ADMINISTRATIVE STATE REQUEST" },
130 { NM_MT_REP_OUTST_ALARMS_NACK, "REPORT OUTSTANDING ALARMS" },
131 { NM_MT_CHANGEOVER_NACK, "CHANGEOVER" },
132 { NM_MT_OPSTART_NACK, "OPSTART" },
133 { NM_MT_REINIT_NACK, "REINIT" },
134 { NM_MT_SET_SITE_OUT_NACK, "SET SITE OUTPUT" },
135 { NM_MT_CHG_HW_CONF_NACK, "CHANGE HARDWARE CONFIGURATION" },
136 { NM_MT_GET_ATTR_NACK, "GET ATTRIBUTE" },
137 { NM_MT_SET_ALARM_THRES_NACK, "SET ALARM THRESHOLD" },
138 { NM_MT_BS11_BEGIN_DB_TX_NACK, "BS11 BEGIN DATABASE TRANSMISSION" },
139 { NM_MT_BS11_END_DB_TX_NACK, "BS11 END DATABASE TRANSMISSION" },
140 { NM_MT_BS11_CREATE_OBJ_NACK, "BS11 CREATE OBJECT" },
141 { NM_MT_BS11_DELETE_OBJ_NACK, "BS11 DELETE OBJECT" },
142 { 0, NULL }
143};
144
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200145/*! Get human-readable string for OML NACK message type */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200146const char *abis_nm_nack_name(uint8_t nack)
147{
148 return get_value_string(nack_names, nack);
149}
150
Max07352fe2017-01-02 19:05:25 +0100151/* Section 9.4.43: Manufacturer specific values */
152const struct value_string abis_mm_event_cause_names[] = {
153 { OSMO_EVT_CRIT_SW_FATAL, "Fatal software error" },
154 { OSMO_EVT_CRIT_PROC_STOP, "Process stopped" },
155 { OSMO_EVT_CRIT_RTP_TOUT, "RTP error" },
156 { OSMO_EVT_CRIT_BOOT_FAIL, "Boot failure" },
157 { OSMO_EVT_MAJ_UKWN_MSG, "Unknown message" },
158 { OSMO_EVT_MAJ_RSL_FAIL, "RSL failure" },
159 { OSMO_EVT_MAJ_UNSUP_ATTR, "Unsupported attribute" },
160 { OSMO_EVT_MAJ_NET_CONGEST, "Network congestion" },
161 { OSMO_EVT_MIN_PAG_TAB_FULL, "Paging table full" },
162 { OSMO_EVT_WARN_SW_WARN, "Software warning" },
Max319f3212017-01-11 14:10:58 +0100163 { OSMO_EVT_EXT_ALARM, "External alarm" },
Max7f9c7e72017-03-15 12:02:22 +0100164 { OSMO_EVT_PCU_VERS, "PCU version report" },
Max07352fe2017-01-02 19:05:25 +0100165 { 0, NULL }
166};
167
Max85908a92017-01-10 17:49:23 +0100168const struct value_string abis_nm_pcause_type_names[] = {
169 { NM_PCAUSE_T_X721, "ISO/CCITT values (X.721)"},
170 { NM_PCAUSE_T_GSM, "GSM specific values"},
171 { NM_PCAUSE_T_MANUF, "Manufacturer specific values"},
172 { 0, NULL }
173};
174
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200175/* Chapter 9.4.36 */
176static const struct value_string nack_cause_names[] = {
177 /* General Nack Causes */
178 { NM_NACK_INCORR_STRUCT, "Incorrect message structure" },
179 { NM_NACK_MSGTYPE_INVAL, "Invalid message type value" },
180 { NM_NACK_OBJCLASS_INVAL, "Invalid Object class value" },
181 { NM_NACK_OBJCLASS_NOTSUPP, "Object class not supported" },
182 { NM_NACK_BTSNR_UNKN, "BTS no. unknown" },
183 { NM_NACK_TRXNR_UNKN, "Baseband Transceiver no. unknown" },
184 { NM_NACK_OBJINST_UNKN, "Object Instance unknown" },
185 { NM_NACK_ATTRID_INVAL, "Invalid attribute identifier value" },
186 { NM_NACK_ATTRID_NOTSUPP, "Attribute identifier not supported" },
187 { NM_NACK_PARAM_RANGE, "Parameter value outside permitted range" },
188 { NM_NACK_ATTRLIST_INCONSISTENT,"Inconsistency in attribute list" },
189 { NM_NACK_SPEC_IMPL_NOTSUPP, "Specified implementation not supported" },
190 { NM_NACK_CANT_PERFORM, "Message cannot be performed" },
191 /* Specific Nack Causes */
192 { NM_NACK_RES_NOTIMPL, "Resource not implemented" },
193 { NM_NACK_RES_NOTAVAIL, "Resource not available" },
194 { NM_NACK_FREQ_NOTAVAIL, "Frequency not available" },
195 { NM_NACK_TEST_NOTSUPP, "Test not supported" },
196 { NM_NACK_CAPACITY_RESTR, "Capacity restrictions" },
197 { NM_NACK_PHYSCFG_NOTPERFORM, "Physical configuration cannot be performed" },
198 { NM_NACK_TEST_NOTINIT, "Test not initiated" },
199 { NM_NACK_PHYSCFG_NOTRESTORE, "Physical configuration cannot be restored" },
200 { NM_NACK_TEST_NOSUCH, "No such test" },
201 { NM_NACK_TEST_NOSTOP, "Test cannot be stopped" },
202 { NM_NACK_MSGINCONSIST_PHYSCFG, "Message inconsistent with physical configuration" },
203 { NM_NACK_FILE_INCOMPLETE, "Complete file notreceived" },
204 { NM_NACK_FILE_NOTAVAIL, "File not available at destination" },
205 { NM_NACK_FILE_NOTACTIVATE, "File cannot be activate" },
206 { NM_NACK_REQ_NOT_GRANT, "Request not granted" },
207 { NM_NACK_WAIT, "Wait" },
208 { NM_NACK_NOTH_REPORT_EXIST, "Nothing reportable existing" },
209 { NM_NACK_MEAS_NOTSUPP, "Measurement not supported" },
210 { NM_NACK_MEAS_NOTSTART, "Measurement not started" },
211 { 0, NULL }
212};
213
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200214/*! Get human-readable string for NACK cause */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200215const char *abis_nm_nack_cause_name(uint8_t cause)
216{
217 return get_value_string(nack_cause_names, cause);
218}
219
220/* Chapter 9.4.16: Event Type */
221static const struct value_string event_type_names[] = {
222 { NM_EVT_COMM_FAIL, "communication failure" },
223 { NM_EVT_QOS_FAIL, "quality of service failure" },
224 { NM_EVT_PROC_FAIL, "processing failure" },
225 { NM_EVT_EQUIP_FAIL, "equipment failure" },
226 { NM_EVT_ENV_FAIL, "environment failure" },
227 { 0, NULL }
228};
229
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200230/*! Get human-readable string for OML event type */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200231const char *abis_nm_event_type_name(uint8_t cause)
232{
233 return get_value_string(event_type_names, cause);
234}
235
236/* Chapter 9.4.63: Perceived Severity */
237static const struct value_string severity_names[] = {
238 { NM_SEVER_CEASED, "failure ceased" },
239 { NM_SEVER_CRITICAL, "critical failure" },
240 { NM_SEVER_MAJOR, "major failure" },
241 { NM_SEVER_MINOR, "minor failure" },
242 { NM_SEVER_WARNING, "warning level failure" },
243 { NM_SEVER_INDETERMINATE, "indeterminate failure" },
244 { 0, NULL }
245};
246
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200247/*! Get human-readable string for perceived OML severity */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200248const char *abis_nm_severity_name(uint8_t cause)
249{
250 return get_value_string(severity_names, cause);
251}
252
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200253/*! 3GPP TS 12.21 9.4.53 T200 values (in msec) */
Max0bee65c2017-01-02 13:42:24 +0100254const uint8_t abis_nm_t200_ms[] = {
255 [T200_SDCCH] = 5,
256 [T200_FACCH_F] = 5,
257 [T200_FACCH_H] = 5,
258 [T200_SACCH_TCH_SAPI0] = 10,
259 [T200_SACCH_SDCCH] = 10,
260 [T200_SDCCH_SAPI3] = 5,
261 [T200_SACCH_TCH_SAPI3] = 10
262};
263
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200264/*! 3GPP TS 52.021 §9.1 Message Types */
Max5d994e42017-03-22 15:20:39 +0100265const struct value_string abis_nm_msgtype_names[] = {
266 { NM_MT_LOAD_INIT, "Load Data Initiate" }, /* §8.3.1 */
267 { NM_MT_LOAD_INIT_ACK, "Load Data Initiate Ack" },
268 { NM_MT_LOAD_INIT_NACK, "Load Data Initiate Nack" },
269 { NM_MT_LOAD_SEG, "Load Data Segment" }, /* §8.3.2 */
270 { NM_MT_LOAD_SEG_ACK, "Load Data Segment Ack" },
271 { NM_MT_LOAD_ABORT, "Load Data Abort" }, /* §8.3.3 */
272 { NM_MT_LOAD_END, "Load Data End" }, /* §8.3.4 */
273 { NM_MT_LOAD_END_ACK, "Load Data End Ack" },
274 { NM_MT_LOAD_END_NACK, "Load Data End Nack" },
275 { NM_MT_SW_ACT_REQ, "SW Activate Request" }, /* §8.3.5 */
276 { NM_MT_SW_ACT_REQ_ACK, "SW Activate Request Ack" },
277 { NM_MT_SW_ACT_REQ_NACK, "SW Activate Request Nack" },
278 { NM_MT_ACTIVATE_SW, "Activate SW" }, /* §8.3.6 */
279 { NM_MT_ACTIVATE_SW_ACK, "Activate SW Ack" },
280 { NM_MT_ACTIVATE_SW_NACK, "Activate SW Nack" },
281 { NM_MT_SW_ACTIVATED_REP, "SW Activated Report" }, /* §8.3.7 */
282 { NM_MT_ESTABLISH_TEI, "Establish TEI" }, /* §8.4.1 */
283 { NM_MT_ESTABLISH_TEI_ACK, "Establish TEI Ack" },
284 { NM_MT_ESTABLISH_TEI_NACK, "Establish TEI Nack" },
285 { NM_MT_CONN_TERR_SIGN, "Connect Terrestrial Signalling" }, /* §8.4.2 */
286 { NM_MT_CONN_TERR_SIGN_ACK, "Connect Terrestrial Signalling Ack" },
287 { NM_MT_CONN_TERR_SIGN_NACK, "Connect Terrestrial Signalling Nack" },
288 { NM_MT_DISC_TERR_SIGN, "Disconnect Terrestrial Signalling" }, /* §8.4.3 */
289 { NM_MT_DISC_TERR_SIGN_ACK, "Disconnect Terrestrial Signalling Ack" },
290 { NM_MT_DISC_TERR_SIGN_NACK, "Disconnect Terrestrial Signalling Nack" },
291 { NM_MT_CONN_TERR_TRAF, "Connect Terrestrial Traffic" }, /* §8.4.4 */
292 { NM_MT_CONN_TERR_TRAF_ACK, "Connect Terrestrial Traffic Ack" },
293 { NM_MT_CONN_TERR_TRAF_NACK, "Connect Terrestrial Traffic Nack" },
294 { NM_MT_DISC_TERR_TRAF, "Disconnect Terrestrial Traffic" }, /* §8.4.5 */
295 { NM_MT_DISC_TERR_TRAF_ACK, "Disconnect Terrestrial Traffic Ack" },
296 { NM_MT_DISC_TERR_TRAF_NACK, "Disconnect Terrestrial Traffic Nack" },
297 { NM_MT_CONN_MDROP_LINK, "Connect Multi-Drop Link" }, /* §8.5.1 */
298 { NM_MT_CONN_MDROP_LINK_ACK, "Connect Multi-Drop Link Ack" },
299 { NM_MT_CONN_MDROP_LINK_NACK, "Connect Multi-Drop Link Nack" },
300 { NM_MT_DISC_MDROP_LINK, "Disconnect Multi-Drop Link" }, /* §8.5.2 */
301 { NM_MT_DISC_MDROP_LINK_ACK, "Disconnect Multi-Drop Link Ack" },
302 { NM_MT_DISC_MDROP_LINK_NACK, "Disconnect Multi-Drop Link Nack" },
303 { NM_MT_SET_BTS_ATTR, "Set BTS Attributes" }, /* §8.6.1 */
304 { NM_MT_SET_BTS_ATTR_ACK, "Set BTS Attributes Ack" },
305 { NM_MT_SET_BTS_ATTR_NACK, "Set BTS Attributes Nack" },
306 { NM_MT_SET_RADIO_ATTR, "Set Radio Carrier Attributes" }, /* §8.6.2 */
307 { NM_MT_SET_RADIO_ATTR_ACK, "Set Radio Carrier Attributes Ack" },
308 { NM_MT_SET_RADIO_ATTR_NACK, "Set Radio Carrier Attributes Nack" },
309 { NM_MT_SET_CHAN_ATTR, "Set Channel Attributes" }, /* §8.6.3 */
310 { NM_MT_SET_CHAN_ATTR_ACK, "Set Channel Attributes Ack" },
311 { NM_MT_SET_CHAN_ATTR_NACK, "Set Channel Attributes Nack" },
312 { NM_MT_PERF_TEST, "Perform Test" }, /* §8.7.1 */
313 { NM_MT_PERF_TEST_ACK, "Perform Test Ack" },
314 { NM_MT_PERF_TEST_NACK, "Perform Test Nack" },
315 { NM_MT_TEST_REP, "Test Report" }, /* §8.7.2 */
316 { NM_MT_SEND_TEST_REP, "Send Test Report" }, /* §8.7.3 */
317 { NM_MT_SEND_TEST_REP_ACK, "Send Test Report Ack" },
318 { NM_MT_SEND_TEST_REP_NACK, "Send Test Report Nack" },
319 { NM_MT_STOP_TEST, "Stop Test" }, /* §8.7.4 */
320 { NM_MT_STOP_TEST_ACK, "Stop Test Ack" },
321 { NM_MT_STOP_TEST_NACK, "Stop Test Nack" },
322 { NM_MT_STATECHG_EVENT_REP, "State Changed Event Report" }, /* §8.8.1 */
323 { NM_MT_FAILURE_EVENT_REP, "Failure Event Report" }, /* §8.8.2 */
324 { NM_MT_STOP_EVENT_REP, "Stop Sending Event Reports" }, /* §8.8.3 */
325 { NM_MT_STOP_EVENT_REP_ACK, "Stop Sending Event Reports Ack" },
326 { NM_MT_STOP_EVENT_REP_NACK, "Stop Sending Event Reports Nack" },
327 { NM_MT_REST_EVENT_REP, "Restart Sending Event Reports" }, /* §8.8.4 */
328 { NM_MT_REST_EVENT_REP_ACK, "Restart Sending Event Reports Ack" },
329 { NM_MT_REST_EVENT_REP_NACK, "Restart Sending Event Reports Nack" },
330 { NM_MT_CHG_ADM_STATE, "Change Administrative State" }, /* §8.8.5 */
331 { NM_MT_CHG_ADM_STATE_ACK, "Change Administrative State Ack" },
332 { NM_MT_CHG_ADM_STATE_NACK, "Change Administrative State Nack" },
333 { NM_MT_CHG_ADM_STATE_REQ, "Change Administrative State Request" }, /* §8.8.6 */
334 { NM_MT_CHG_ADM_STATE_REQ_ACK, "Change Administrative State Request Ack" },
335 { NM_MT_CHG_ADM_STATE_REQ_NACK, "Change Administrative State Request Nack" },
336 { NM_MT_REP_OUTST_ALARMS, "Report Outstanding Alarms" }, /* §8.8.7 */
337 { NM_MT_REP_OUTST_ALARMS_ACK, "Report Outstanding Alarms Ack" },
338 { NM_MT_REP_OUTST_ALARMS_NACK, "Report Outstanding Alarms Nack" },
339 { NM_MT_CHANGEOVER, "Changeover" }, /* §8.9.1 */
340 { NM_MT_CHANGEOVER_ACK, "Changeover Ack" },
341 { NM_MT_CHANGEOVER_NACK, "Changeover Nack" },
342 { NM_MT_OPSTART, "Opstart" }, /* §8.9.2 */
343 { NM_MT_OPSTART_ACK, "Opstart Ack" },
344 { NM_MT_OPSTART_NACK, "Opstart Nack" },
345 { NM_MT_REINIT, "Reinitialize" }, /* §8.9.3 */
346 { NM_MT_REINIT_ACK, "Reinitialize Ack" },
347 { NM_MT_REINIT_NACK, "Reinitialize Nack" },
348 { NM_MT_SET_SITE_OUT, "Set Site Outputs" }, /* §8.9.4 */
349 { NM_MT_SET_SITE_OUT_ACK, "Set Site Outputs Ack" },
350 { NM_MT_SET_SITE_OUT_NACK, "Set Site Outputs Nack" },
351 { NM_MT_CHG_HW_CONF, "Change HW Configuration" }, /* §8.9.5 */
352 { NM_MT_CHG_HW_CONF_ACK, "Change HW Configuration Ack" },
353 { NM_MT_CHG_HW_CONF_NACK, "Change HW Configuration Nack" },
354 { NM_MT_MEAS_RES_REQ, "Measurement Result Request" }, /* §8.10.1 */
355 { NM_MT_MEAS_RES_RESP, "Measurement Result Response" }, /* §8.10.2 */
356 { NM_MT_STOP_MEAS, "Stop Measurement" }, /* §8.10.4 */
357 { NM_MT_START_MEAS, "Start Measurement" }, /* §8.10.3 */
358 { NM_MT_GET_ATTR, "Get Attributes" }, /* §8.11.1 */
359 { NM_MT_GET_ATTR_RESP, "Get Attributes Response" }, /* §8.11.3 */
360 { NM_MT_GET_ATTR_NACK, "Get Attributes Nack" },
361 { NM_MT_SET_ALARM_THRES, "Set Alarm Threshold" }, /* §8.11.2 */
362 { NM_MT_SET_ALARM_THRES_ACK, "Set Alarm Threshold Ack" },
363 { NM_MT_SET_ALARM_THRES_NACK, "Set Alarm Threshold Nack" },
364 { 0, NULL }
365};
366
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200367/*! 3GPP TS 52.021 §9.4 Attributes and Parameters */
Max62d6f252017-03-21 16:55:45 +0100368const struct value_string abis_nm_att_names[] = {
369 { NM_ATT_ABIS_CHANNEL, "Abis Channel" }, /* §9.4.1 */
370 { NM_ATT_ADD_INFO, "Additional Info" }, /* §9.4.2 */
371 { NM_ATT_ADD_TEXT, "Additional Text" }, /* §9.4.3 */
372 { NM_ATT_ADM_STATE, "Administrative State" }, /* §9.4.4 */
373 { NM_ATT_ARFCN_LIST, "ARFCN List" }, /* §9.4.5 */
374 { NM_ATT_AUTON_REPORT, "Autonomously Report" }, /* §9.4.6 */
375 { NM_ATT_AVAIL_STATUS, "Availability Status" }, /* §9.4.7 */
376 { NM_ATT_BCCH_ARFCN, "BCCH ARFCN" }, /* §9.4.8 */
377 { NM_ATT_BSIC, "BSIC" }, /* §9.4.9 */
378 { NM_ATT_BTS_AIR_TIMER, "BTS Air Timer" }, /* §9.4.10 */
379 { NM_ATT_CCCH_L_I_P, "CCCH Load Indication Period" }, /* §9.4.11 */
380 { NM_ATT_CCCH_L_T, "CCCH Load Threshold" }, /* §9.4.12 */
381 { NM_ATT_CHAN_COMB, "Channel Combination" }, /* §9.4.13 */
382 { NM_ATT_CONN_FAIL_CRIT, "Connection Failure Criterion" }, /* §9.4.14 */
383 { NM_ATT_DEST, "Destination" }, /* §9.4.15 */
384 { NM_ATT_EVENT_TYPE, "Event Type" }, /* §9.4.16 */
385 { NM_ATT_FILE_DATA, "File Data" }, /* §9.4.17 */
386 { NM_ATT_FILE_ID, "File Id" }, /* §9.4.18 */
387 { NM_ATT_FILE_VERSION, "File Version" }, /* §9.4.19 */
388 { NM_ATT_GSM_TIME, "GSM Time" }, /* §9.4.20 */
389 { NM_ATT_HSN, "HSN" }, /* §9.4.21 */
390 { NM_ATT_HW_CONFIG, "HW Configuration" }, /* §9.4.22 */
391 { NM_ATT_HW_DESC, "HW Description" }, /* §9.4.23 */
392 { NM_ATT_INTAVE_PARAM, "Intave Parameter" }, /* §9.4.24 */
393 { NM_ATT_INTERF_BOUND, "Interference level Boundaries" }, /* §9.4.25 */
394 { NM_ATT_LIST_REQ_ATTR, "List of Required Attributes" }, /* §9.4.26 */
395 { NM_ATT_MAIO, "MAIO" }, /* §9.4.27 */
396 { NM_ATT_MANUF_STATE, "Manufacturer Dependent State" }, /* §9.4.28 */
397 { NM_ATT_MANUF_THRESH, "Manufacturer Dependent Thresholds" }, /* §9.4.29 */
398 { NM_ATT_MANUF_ID, "Manufacturer Id" }, /* §9.4.30 */
399 { NM_ATT_MAX_TA, "Max Timing Advance" }, /* §9.4.31 */
400 { NM_ATT_MEAS_RES, "Measurement Result" }, /* §9.4.32 */
401 { NM_ATT_MEAS_TYPE, "Measurement Type" }, /* §9.4.33 */
402 { NM_ATT_MDROP_LINK, "Multi-drop BSC Link" }, /* §9.4.34 */
403 { NM_ATT_MDROP_NEXT, "Multi-drop next BTS Link" }, /* §9.4.35 */
404 { NM_ATT_NACK_CAUSES, "Nack Causes" }, /* §9.4.36 */
405 { NM_ATT_NY1, "Ny1" }, /* §9.4.37 */
406 { NM_ATT_OPER_STATE, "Operational State" }, /* §9.4.38 */
407 { NM_ATT_OVERL_PERIOD, "Overload Period" }, /* §9.4.39 */
408 { NM_ATT_PHYS_CONF, "Physical Config" }, /* §9.4.40 */
409 { NM_ATT_POWER_CLASS, "Power Class" }, /* §9.4.41 */
410 { NM_ATT_POWER_THRESH, "Power Output Thresholds" }, /* §9.4.42 */
411 { NM_ATT_PROB_CAUSE, "Probable Cause" }, /* §9.4.43 */
412 { NM_ATT_RACH_B_THRESH, "RACH Busy Threshold" }, /* §9.4.44 */
413 { NM_ATT_LDAVG_SLOTS, "RACH Load Averaging Slots" }, /* §9.4.45 */
414 { NM_ATT_RAD_SUBC, "Radio Sub Channel" }, /* §9.4.46 */
415 { NM_ATT_RF_MAXPOWR_R, "RF Max Power Reduction" }, /* §9.4.47 */
416 { NM_ATT_SITE_INPUTS, "Site Inputs" }, /* §9.4.48 */
417 { NM_ATT_SITE_OUTPUTS, "Site Outputs" }, /* §9.4.49 */
418 { NM_ATT_SOURCE, "Source" }, /* §9.4.50 */
419 { NM_ATT_SPEC_PROB, "Specific Problems" }, /* §9.4.51 */
420 { NM_ATT_START_TIME, "Starting Time" }, /* §9.4.52 */
421 { NM_ATT_T200, "T200" }, /* §9.4.53 */
422 { NM_ATT_TEI, "TEI" }, /* §9.4.54 */
423 { NM_ATT_TEST_DUR, "Test Duration" }, /* §9.4.55 */
424 { NM_ATT_TEST_NO, "Test No" }, /* §9.4.56 */
425 { NM_ATT_TEST_REPORT, "Test Report Info" }, /* §9.4.57 */
426 { NM_ATT_VSWR_THRESH, "VSWR Thresholds" }, /* §9.4.58 */
427 { NM_ATT_WINDOW_SIZE, "Window Size" }, /* §9.4.59 */
428 { NM_ATT_TSC, "TSC" }, /* §9.4.60 */
429 { NM_ATT_SW_CONFIG, "SW Configuration" }, /* §9.4.61 */
430 { NM_ATT_SW_DESCR, "SW Description" }, /* §9.4.62 */
431 { NM_ATT_SEVERITY, "Perceived Severity" }, /* §9.4.63 */
432 { NM_ATT_GET_ARI, "Get Attribute Response Info" }, /* §9.4.64 */
433 { NM_ATT_OUTST_ALARM, "Outstanding Alarm Sequence" }, /* §9.4.65 */
434 { NM_ATT_HW_CONF_CHG, "HW Conf Change Info" }, /* §9.4.66 */
435 { 0, NULL }
436};
437
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200438/*! Attributes that the BSC can set, not only get, according to Section 9.4 */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200439const enum abis_nm_attr abis_nm_att_settable[] = {
440 NM_ATT_ADD_INFO,
441 NM_ATT_ADD_TEXT,
442 NM_ATT_DEST,
443 NM_ATT_EVENT_TYPE,
444 NM_ATT_FILE_DATA,
445 NM_ATT_GET_ARI,
446 NM_ATT_HW_CONF_CHG,
447 NM_ATT_LIST_REQ_ATTR,
448 NM_ATT_MDROP_LINK,
449 NM_ATT_MDROP_NEXT,
450 NM_ATT_NACK_CAUSES,
451 NM_ATT_OUTST_ALARM,
452 NM_ATT_PHYS_CONF,
453 NM_ATT_PROB_CAUSE,
454 NM_ATT_RAD_SUBC,
455 NM_ATT_SOURCE,
456 NM_ATT_SPEC_PROB,
457 NM_ATT_START_TIME,
458 NM_ATT_TEST_DUR,
459 NM_ATT_TEST_NO,
460 NM_ATT_TEST_REPORT,
461 NM_ATT_WINDOW_SIZE,
462 NM_ATT_SEVERITY,
463 NM_ATT_MEAS_RES,
464 NM_ATT_MEAS_TYPE,
465};
466
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200467/*! GSM A-bis OML IPA TLV parser definition */
Max0bee65c2017-01-02 13:42:24 +0100468const struct tlv_definition abis_nm_att_tlvdef_ipa = {
469 .def = {
470 /* ip.access specifics */
471 [NM_ATT_IPACC_DST_IP] = { TLV_TYPE_FIXED, 4 },
472 [NM_ATT_IPACC_DST_IP_PORT] = { TLV_TYPE_FIXED, 2 },
473 [NM_ATT_IPACC_STREAM_ID] = { TLV_TYPE_TV, },
474 [NM_ATT_IPACC_SEC_OML_CFG] = { TLV_TYPE_FIXED, 6 },
475 [NM_ATT_IPACC_IP_IF_CFG] = { TLV_TYPE_FIXED, 8 },
476 [NM_ATT_IPACC_IP_GW_CFG] = { TLV_TYPE_FIXED, 12 },
477 [NM_ATT_IPACC_IN_SERV_TIME] = { TLV_TYPE_FIXED, 4 },
478 [NM_ATT_IPACC_LOCATION] = { TLV_TYPE_TL16V },
479 [NM_ATT_IPACC_PAGING_CFG] = { TLV_TYPE_FIXED, 2 },
480 [NM_ATT_IPACC_UNIT_ID] = { TLV_TYPE_TL16V },
481 [NM_ATT_IPACC_UNIT_NAME] = { TLV_TYPE_TL16V },
482 [NM_ATT_IPACC_SNMP_CFG] = { TLV_TYPE_TL16V },
483 [NM_ATT_IPACC_PRIM_OML_CFG_LIST] = { TLV_TYPE_TL16V },
484 [NM_ATT_IPACC_NV_FLAGS] = { TLV_TYPE_TL16V },
485 [NM_ATT_IPACC_FREQ_CTRL] = { TLV_TYPE_FIXED, 2 },
486 [NM_ATT_IPACC_PRIM_OML_FB_TOUT] = { TLV_TYPE_TL16V },
487 [NM_ATT_IPACC_CUR_SW_CFG] = { TLV_TYPE_TL16V },
488 [NM_ATT_IPACC_TIMING_BUS] = { TLV_TYPE_TL16V },
489 [NM_ATT_IPACC_CGI] = { TLV_TYPE_TL16V },
490 [NM_ATT_IPACC_RAC] = { TLV_TYPE_TL16V },
491 [NM_ATT_IPACC_OBJ_VERSION] = { TLV_TYPE_TL16V },
492 [NM_ATT_IPACC_GPRS_PAGING_CFG]= { TLV_TYPE_TL16V },
493 [NM_ATT_IPACC_NSEI] = { TLV_TYPE_TL16V },
494 [NM_ATT_IPACC_BVCI] = { TLV_TYPE_TL16V },
495 [NM_ATT_IPACC_NSVCI] = { TLV_TYPE_TL16V },
496 [NM_ATT_IPACC_NS_CFG] = { TLV_TYPE_TL16V },
497 [NM_ATT_IPACC_BSSGP_CFG] = { TLV_TYPE_TL16V },
498 [NM_ATT_IPACC_NS_LINK_CFG] = { TLV_TYPE_TL16V },
499 [NM_ATT_IPACC_RLC_CFG] = { TLV_TYPE_TL16V },
500 [NM_ATT_IPACC_ALM_THRESH_LIST]= { TLV_TYPE_TL16V },
501 [NM_ATT_IPACC_MONIT_VAL_LIST] = { TLV_TYPE_TL16V },
502 [NM_ATT_IPACC_TIB_CONTROL] = { TLV_TYPE_TL16V },
503 [NM_ATT_IPACC_SUPP_FEATURES] = { TLV_TYPE_TL16V },
504 [NM_ATT_IPACC_CODING_SCHEMES] = { TLV_TYPE_TL16V },
505 [NM_ATT_IPACC_RLC_CFG_2] = { TLV_TYPE_TL16V },
506 [NM_ATT_IPACC_HEARTB_TOUT] = { TLV_TYPE_TL16V },
507 [NM_ATT_IPACC_UPTIME] = { TLV_TYPE_TL16V },
508 [NM_ATT_IPACC_RLC_CFG_3] = { TLV_TYPE_TL16V },
509 [NM_ATT_IPACC_SSL_CFG] = { TLV_TYPE_TL16V },
510 [NM_ATT_IPACC_SEC_POSSIBLE] = { TLV_TYPE_TL16V },
511 [NM_ATT_IPACC_IML_SSL_STATE] = { TLV_TYPE_TL16V },
512 [NM_ATT_IPACC_REVOC_DATE] = { TLV_TYPE_TL16V },
513 },
514};
515
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200516/*! GSM A-bis OML TLV parser definition */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200517const struct tlv_definition abis_nm_att_tlvdef = {
518 .def = {
519 [NM_ATT_ABIS_CHANNEL] = { TLV_TYPE_FIXED, 3 },
520 [NM_ATT_ADD_INFO] = { TLV_TYPE_TL16V },
521 [NM_ATT_ADD_TEXT] = { TLV_TYPE_TL16V },
522 [NM_ATT_ADM_STATE] = { TLV_TYPE_TV },
523 [NM_ATT_ARFCN_LIST]= { TLV_TYPE_TL16V },
524 [NM_ATT_AUTON_REPORT] = { TLV_TYPE_TV },
525 [NM_ATT_AVAIL_STATUS] = { TLV_TYPE_TL16V },
526 [NM_ATT_BCCH_ARFCN] = { TLV_TYPE_FIXED, 2 },
527 [NM_ATT_BSIC] = { TLV_TYPE_TV },
528 [NM_ATT_BTS_AIR_TIMER] = { TLV_TYPE_TV },
529 [NM_ATT_CCCH_L_I_P] = { TLV_TYPE_TV },
530 [NM_ATT_CCCH_L_T] = { TLV_TYPE_TV },
531 [NM_ATT_CHAN_COMB] = { TLV_TYPE_TV },
532 [NM_ATT_CONN_FAIL_CRIT] = { TLV_TYPE_TL16V },
533 [NM_ATT_DEST] = { TLV_TYPE_TL16V },
534 [NM_ATT_EVENT_TYPE] = { TLV_TYPE_TV },
535 [NM_ATT_FILE_DATA] = { TLV_TYPE_TL16V },
536 [NM_ATT_FILE_ID] = { TLV_TYPE_TL16V },
537 [NM_ATT_FILE_VERSION] = { TLV_TYPE_TL16V },
538 [NM_ATT_GSM_TIME] = { TLV_TYPE_FIXED, 2 },
539 [NM_ATT_HSN] = { TLV_TYPE_TV },
540 [NM_ATT_HW_CONFIG] = { TLV_TYPE_TL16V },
541 [NM_ATT_HW_DESC] = { TLV_TYPE_TL16V },
542 [NM_ATT_INTAVE_PARAM] = { TLV_TYPE_TV },
543 [NM_ATT_INTERF_BOUND] = { TLV_TYPE_FIXED, 6 },
544 [NM_ATT_LIST_REQ_ATTR] = { TLV_TYPE_TL16V },
545 [NM_ATT_MAIO] = { TLV_TYPE_TV },
546 [NM_ATT_MANUF_STATE] = { TLV_TYPE_TV },
547 [NM_ATT_MANUF_THRESH] = { TLV_TYPE_TL16V },
548 [NM_ATT_MANUF_ID] = { TLV_TYPE_TL16V },
549 [NM_ATT_MAX_TA] = { TLV_TYPE_TV },
550 [NM_ATT_MDROP_LINK] = { TLV_TYPE_FIXED, 2 },
551 [NM_ATT_MDROP_NEXT] = { TLV_TYPE_FIXED, 2 },
552 [NM_ATT_NACK_CAUSES] = { TLV_TYPE_TV },
553 [NM_ATT_NY1] = { TLV_TYPE_TV },
554 [NM_ATT_OPER_STATE] = { TLV_TYPE_TV },
555 [NM_ATT_OVERL_PERIOD] = { TLV_TYPE_TL16V },
556 [NM_ATT_PHYS_CONF] = { TLV_TYPE_TL16V },
557 [NM_ATT_POWER_CLASS] = { TLV_TYPE_TV },
558 [NM_ATT_POWER_THRESH] = { TLV_TYPE_FIXED, 3 },
559 [NM_ATT_PROB_CAUSE] = { TLV_TYPE_FIXED, 3 },
560 [NM_ATT_RACH_B_THRESH] = { TLV_TYPE_TV },
561 [NM_ATT_LDAVG_SLOTS] = { TLV_TYPE_FIXED, 2 },
562 [NM_ATT_RAD_SUBC] = { TLV_TYPE_TV },
563 [NM_ATT_RF_MAXPOWR_R] = { TLV_TYPE_TV },
564 [NM_ATT_SITE_INPUTS] = { TLV_TYPE_TL16V },
565 [NM_ATT_SITE_OUTPUTS] = { TLV_TYPE_TL16V },
566 [NM_ATT_SOURCE] = { TLV_TYPE_TL16V },
567 [NM_ATT_SPEC_PROB] = { TLV_TYPE_TV },
568 [NM_ATT_START_TIME] = { TLV_TYPE_FIXED, 2 },
569 [NM_ATT_T200] = { TLV_TYPE_FIXED, 7 },
570 [NM_ATT_TEI] = { TLV_TYPE_TV },
571 [NM_ATT_TEST_DUR] = { TLV_TYPE_FIXED, 2 },
572 [NM_ATT_TEST_NO] = { TLV_TYPE_TV },
573 [NM_ATT_TEST_REPORT] = { TLV_TYPE_TL16V },
574 [NM_ATT_VSWR_THRESH] = { TLV_TYPE_FIXED, 2 },
575 [NM_ATT_WINDOW_SIZE] = { TLV_TYPE_TV },
576 [NM_ATT_TSC] = { TLV_TYPE_TV },
577 [NM_ATT_SW_CONFIG] = { TLV_TYPE_TL16V },
578 [NM_ATT_SEVERITY] = { TLV_TYPE_TV },
579 [NM_ATT_GET_ARI] = { TLV_TYPE_TL16V },
580 [NM_ATT_HW_CONF_CHG] = { TLV_TYPE_TL16V },
581 [NM_ATT_OUTST_ALARM] = { TLV_TYPE_TV },
582 [NM_ATT_MEAS_RES] = { TLV_TYPE_TL16V },
Minh-Quang Nguyenaab6b262017-03-30 12:57:26 -0400583 [NM_ATT_MEAS_TYPE] = { TLV_TYPE_TV },
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200584 },
585};
586
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200587/*! org.osmocom GSM A-bis OML TLV parser definition */
Harald Welte5b5650f2014-05-19 11:25:46 +0200588const struct tlv_definition abis_nm_osmo_att_tlvdef = {
589 .def = {
590 [NM_ATT_OSMO_REDUCEPOWER] = { TLV_TYPE_TV },
591 },
592};
593
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200594/*! Human-readable strings for A-bis OML Object Class */
Harald Welte8d5180e2014-08-17 19:36:26 +0200595const struct value_string abis_nm_msg_disc_names[] = {
596 { ABIS_OM_MDISC_FOM, "FOM" },
597 { ABIS_OM_MDISC_MMI, "MMI" },
598 { ABIS_OM_MDISC_TRAU, "TRAU" },
599 { ABIS_OM_MDISC_MANUF, "MANUF" },
600 { 0, NULL }
601};
602
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200603/*! Human-readable strings for A-bis OML Object Class */
Harald Welteea4b12a2011-05-23 20:41:31 +0200604const struct value_string abis_nm_obj_class_names[] = {
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200605 { NM_OC_SITE_MANAGER, "SITE-MANAGER" },
606 { NM_OC_BTS, "BTS" },
607 { NM_OC_RADIO_CARRIER, "RADIO-CARRIER" },
608 { NM_OC_BASEB_TRANSC, "BASEBAND-TRANSCEIVER" },
609 { NM_OC_CHANNEL, "CHANNEL" },
610 { NM_OC_BS11_ADJC, "ADJC" },
611 { NM_OC_BS11_HANDOVER, "HANDOVER" },
612 { NM_OC_BS11_PWR_CTRL, "POWER-CONTROL" },
613 { NM_OC_BS11_BTSE, "BTSE" },
614 { NM_OC_BS11_RACK, "RACK" },
615 { NM_OC_BS11_TEST, "TEST" },
616 { NM_OC_BS11_ENVABTSE, "ENVABTSE" },
617 { NM_OC_BS11_BPORT, "BPORT" },
618 { NM_OC_GPRS_NSE, "GPRS-NSE" },
619 { NM_OC_GPRS_CELL, "GPRS-CELL" },
620 { NM_OC_GPRS_NSVC, "GPRS-NSVC" },
621 { NM_OC_BS11, "SIEMENSHW" },
622 { 0, NULL }
623};
624
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200625/*! Get human-readable string for OML Operational State */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200626const char *abis_nm_opstate_name(uint8_t os)
627{
628 switch (os) {
629 case NM_OPSTATE_DISABLED:
630 return "Disabled";
631 case NM_OPSTATE_ENABLED:
632 return "Enabled";
633 case NM_OPSTATE_NULL:
634 return "NULL";
635 default:
636 return "RFU";
637 }
638}
639
640/* Chapter 9.4.7 */
641static const struct value_string avail_names[] = {
642 { 0, "In test" },
643 { 1, "Failed" },
644 { 2, "Power off" },
645 { 3, "Off line" },
646 /* Not used */
647 { 5, "Dependency" },
648 { 6, "Degraded" },
649 { 7, "Not installed" },
650 { 0xff, "OK" },
651 { 0, NULL }
652};
653
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200654/*! Get human-readable string for OML Availability State */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200655const char *abis_nm_avail_name(uint8_t avail)
656{
657 return get_value_string(avail_names, avail);
658}
659
Holger Hans Peter Freyther579fb092012-11-22 10:54:23 +0100660static const struct value_string test_names[] = {
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200661 /* FIXME: standard test names */
662 { NM_IPACC_TESTNO_CHAN_USAGE, "Channel Usage" },
663 { NM_IPACC_TESTNO_BCCH_CHAN_USAGE, "BCCH Channel Usage" },
664 { NM_IPACC_TESTNO_FREQ_SYNC, "Frequency Synchronization" },
665 { NM_IPACC_TESTNO_BCCH_INFO, "BCCH Info" },
666 { NM_IPACC_TESTNO_TX_BEACON, "Transmit Beacon" },
667 { NM_IPACC_TESTNO_SYSINFO_MONITOR, "System Info Monitor" },
668 { NM_IPACC_TESTNO_BCCCH_MONITOR, "BCCH Monitor" },
669 { 0, NULL }
670};
671
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200672/*! Get human-readable string for OML test */
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200673const char *abis_nm_test_name(uint8_t test)
674{
675 return get_value_string(test_names, test);
676}
677
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200678/*! Human-readable names for OML administrative state */
Harald Welteea4b12a2011-05-23 20:41:31 +0200679const struct value_string abis_nm_adm_state_names[] = {
Harald Weltef7a1bcc2011-05-22 22:45:16 +0200680 { NM_STATE_LOCKED, "Locked" },
681 { NM_STATE_UNLOCKED, "Unlocked" },
682 { NM_STATE_SHUTDOWN, "Shutdown" },
683 { NM_STATE_NULL, "NULL" },
684 { 0, NULL }
685};
686
Harald Welte11c71932011-05-24 17:15:12 +0200687static const enum abis_nm_chan_comb chcomb4pchan[] = {
Harald Welte7721a772011-06-29 18:44:06 +0200688 [GSM_PCHAN_NONE] = 0xff,
Harald Welte11c71932011-05-24 17:15:12 +0200689 [GSM_PCHAN_CCCH] = NM_CHANC_mainBCCH,
690 [GSM_PCHAN_CCCH_SDCCH4] = NM_CHANC_BCCHComb,
691 [GSM_PCHAN_TCH_F] = NM_CHANC_TCHFull,
692 [GSM_PCHAN_TCH_H] = NM_CHANC_TCHHalf,
693 [GSM_PCHAN_SDCCH8_SACCH8C] = NM_CHANC_SDCCH,
694 [GSM_PCHAN_PDCH] = NM_CHANC_IPAC_PDCH,
695 [GSM_PCHAN_TCH_F_PDCH] = NM_CHANC_IPAC_TCHFull_PDCH,
Harald Welte7721a772011-06-29 18:44:06 +0200696 [GSM_PCHAN_UNKNOWN] = 0xff,
Harald Welte1b12d162014-12-28 13:37:01 +0100697 [GSM_PCHAN_CCCH_SDCCH4_CBCH] = NM_CHANC_BCCH_CBCH,
698 [GSM_PCHAN_SDCCH8_SACCH8C_CBCH] = NM_CHANC_SDCCH_CBCH,
Neels Hofmeyrfd80f5a2016-07-14 03:21:05 +0200699 [GSM_PCHAN_TCH_F_TCH_H_PDCH] = NM_CHANC_OSMO_TCHFull_TCHHalf_PDCH,
Harald Welte11c71932011-05-24 17:15:12 +0200700 /* FIXME: bounds check */
701};
702
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200703/*! Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
Maxecbcdf52017-01-02 14:43:35 +0100704struct msgb *abis_nm_fail_evt_rep(enum abis_nm_event_type t,
705 enum abis_nm_severity s,
706 enum abis_nm_pcause_type ct,
707 uint16_t cause_value, const char *fmt, ...)
708{
Max1251afe2017-01-11 18:12:32 +0100709 va_list ap;
710 struct msgb *nmsg;
711
712 va_start(ap, fmt);
713 nmsg = abis_nm_fail_evt_vrep(t, s, ct, cause_value, fmt, ap);
714 va_end(ap);
715
716 return nmsg;
717}
718
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200719/*! Pack 3GPP TS 12.21 § 8.8.2 Failure Event Report into msgb */
Max1251afe2017-01-11 18:12:32 +0100720struct msgb *abis_nm_fail_evt_vrep(enum abis_nm_event_type t,
721 enum abis_nm_severity s,
722 enum abis_nm_pcause_type ct,
723 uint16_t cause_value, const char *fmt,
724 va_list ap)
725{
Maxecbcdf52017-01-02 14:43:35 +0100726 uint8_t cause[3];
727 int len;
Maxecbcdf52017-01-02 14:43:35 +0100728 char add_text[ABIS_NM_MSG_HEADROOM];
729 struct msgb *nmsg = msgb_alloc_headroom(ABIS_NM_MSG_SIZE,
730 ABIS_NM_MSG_HEADROOM,
731 "OML FAIL EV. REP.");
732 if (!nmsg)
733 return NULL;
734
735 msgb_tv_put(nmsg, NM_ATT_EVENT_TYPE, t);
736 msgb_tv_put(nmsg, NM_ATT_SEVERITY, s);
737
738 cause[0] = ct;
739 osmo_store16be(cause_value, cause + 1);
740
741 msgb_tv_fixed_put(nmsg, NM_ATT_PROB_CAUSE, 3, cause);
742
Maxecbcdf52017-01-02 14:43:35 +0100743 len = vsnprintf(add_text, ABIS_NM_MSG_HEADROOM, fmt, ap);
Maxecbcdf52017-01-02 14:43:35 +0100744 if (len < 0) {
745 msgb_free(nmsg);
746 return NULL;
747 }
748 if (len)
Harald Weltef12d40f2017-02-08 15:46:53 +0000749 msgb_tl16v_put(nmsg, NM_ATT_ADD_TEXT, len, (const uint8_t *) add_text);
Maxecbcdf52017-01-02 14:43:35 +0100750
751 return nmsg;
752}
753
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200754/*! Compute length of given 3GPP TS 52.021 §9.4.62 SW Description.
Maxf74cfd32017-03-24 20:16:33 +0100755 * \param[in] sw SW Description struct
756 * \param[in] put_sw_descr boolean, whether to put NM_ATT_SW_DESCR IE or not
757 * \returns length of buffer space necessary to store sw
758 */
759uint16_t abis_nm_sw_desc_len(const struct abis_nm_sw_desc *sw, bool put_sw_desc)
760{
761 /* +3: type is 1-byte, length is 2-byte */
762 return (put_sw_desc ? 1 : 0) + (sw->file_id_len + 3) + (sw->file_version_len + 3);
763}
764
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200765/*! Put given 3GPP TS 52.021 §9.4.62 SW Description into msgb.
Maxf74cfd32017-03-24 20:16:33 +0100766 * \param[out] msg message buffer
767 * \param[in] sw SW Description struct
768 * \param[in] put_sw_descr boolean, whether to put NM_ATT_SW_DESCR IE or not
769 * \returns length of buffer space necessary to store sw
770 */
771uint16_t abis_nm_put_sw_desc(struct msgb *msg, const struct abis_nm_sw_desc *sw, bool put_sw_desc)
772{
773 if (put_sw_desc)
774 msgb_v_put(msg, NM_ATT_SW_DESCR);
775
776 msgb_tl16v_put(msg, NM_ATT_FILE_ID, sw->file_id_len, sw->file_id);
777 msgb_tl16v_put(msg, NM_ATT_FILE_VERSION, sw->file_version_len, sw->file_version);
778
779 return abis_nm_sw_desc_len(sw, put_sw_desc);
780}
781
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200782/*! Put given file ID/Version pair as 3GPP TS 52.021 §9.4.62 SW Description into msgb.
Maxf74cfd32017-03-24 20:16:33 +0100783 * \param[out] msg message buffer
784 * \param[in] id File ID part of SW Description
785 * \param[in] id File Version part of SW Description
786 * \param[in] put_sw_descr boolean, whether to put NM_ATT_SW_DESCR IE or not
787 * \returns length of buffer space necessary to store sw
788 */
789uint16_t abis_nm_put_sw_file(struct msgb *msg, const char *id, const char *ver, bool put_sw_desc)
790{
791 struct abis_nm_sw_desc sw = {
792 .file_id_len = strlen(id),
793 .file_version_len = strlen(ver),
794 };
795
796 memcpy(sw.file_id, id, sw.file_id_len);
797 memcpy(sw.file_version, ver, sw.file_version_len);
798
799 return abis_nm_put_sw_desc(msg, &sw, put_sw_desc);
800}
801
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200802/*! Get length of first 3GPP TS 52.021 §9.4.62 SW Description from buffer.
Maxf74cfd32017-03-24 20:16:33 +0100803 * \param[in] buf buffer, may contain several SW Descriptions
804 * \param[in] len buffer length
805 * \returns length if parsing succeeded, 0 otherwise
806 */
807uint32_t abis_nm_get_sw_desc_len(const uint8_t *buf, size_t len)
808{
809 uint16_t sw = 2; /* 1-byte SW tag + 1-byte FILE_* tag */
810
811 if (buf[0] != NM_ATT_SW_DESCR)
812 sw = 1; /* 1-byte FILE_* tag */
813
814 if (buf[sw - 1] != NM_ATT_FILE_ID && buf[sw - 1] != NM_ATT_FILE_VERSION)
815 return 0;
816
817 /* + length of 1st FILE_* element + 1-byte tag + 2-byte length field of
818 1st FILE_* element */
819 sw += (osmo_load16be(buf + sw) + 3);
820
821 /* + length of 2nd FILE_* element */
822 sw += osmo_load16be(buf + sw);
823
824 return sw + 2; /* + 2-byte length field of 2nd FILE_* element */
825}
826
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200827/*! Parse single 3GPP TS 52.021 §9.4.62 SW Description from buffer.
Maxf74cfd32017-03-24 20:16:33 +0100828 * \param[out] sw SW Description struct
829 * \param[in] buf buffer
830 * \param[in] len buffer length
831 * \returns 0 if parsing succeeded, negative error code otherwise
832 */
833static inline int abis_nm_get_sw_desc(struct abis_nm_sw_desc *sw, const uint8_t *buf, size_t length)
834{
835 int rc;
836 uint32_t len = abis_nm_get_sw_desc_len(buf, length);
837 static struct tlv_parsed tp;
838 const struct tlv_definition sw_tlvdef = {
839 .def = {
840 [NM_ATT_SW_DESCR] = { TLV_TYPE_TV },
841 [NM_ATT_FILE_ID] = { TLV_TYPE_TL16V },
842 [NM_ATT_FILE_VERSION] = { TLV_TYPE_TL16V },
843 },
844 };
845
846 /* Basic sanity check */
847 if (len > length)
848 return -EFBIG;
849
850 /* Note: current implementation of TLV parser fails on multilpe SW Descr:
851 we will only parse the first one */
852 if (!len)
853 return -EINVAL;
854
855 /* Note: the return value is ignored here because SW Description tag
856 itself is considered optional. */
857 tlv_parse(&tp, &sw_tlvdef, buf, len, 0, 0);
858
859 /* Parsing SW Description is tricky for current implementation of TLV
860 parser which fails to properly handle TV when V has following
861 structure: | TL16V | TL16V |. Hence, the need for 2nd call: */
862 rc = tlv_parse(&tp, &sw_tlvdef, buf + TLVP_LEN(&tp, NM_ATT_SW_DESCR), len - TLVP_LEN(&tp, NM_ATT_SW_DESCR),
863 0, 0);
864
865 if (rc < 0)
866 return rc;
867
868 if (!TLVP_PRESENT(&tp, NM_ATT_FILE_ID))
869 return -EBADF;
870
871 if (!TLVP_PRESENT(&tp, NM_ATT_FILE_VERSION))
872 return -EBADMSG;
873
874 sw->file_id_len = TLVP_LEN(&tp, NM_ATT_FILE_ID);
875 sw->file_version_len = TLVP_LEN(&tp, NM_ATT_FILE_VERSION);
876
877 memcpy(sw->file_id, TLVP_VAL(&tp, NM_ATT_FILE_ID), sw->file_id_len);
878 memcpy(sw->file_version, TLVP_VAL(&tp, NM_ATT_FILE_VERSION), sw->file_version_len);
879
880 return 0;
881}
882
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200883/*! Parse 3GPP TS 52.021 §9.4.61 SW Configuration from buffer.
Maxf74cfd32017-03-24 20:16:33 +0100884 * \param[in] buf buffer
885 * \param[in] buf_len buffer length
886 * \param[out] sw SW Description struct array
887 * \param[in] sw_len Expected number of SW Description entries
Maxb9040912017-05-10 13:32:49 +0200888 * \returns Number fo parsed SW-Description entries, negative error code otherwise
Maxf74cfd32017-03-24 20:16:33 +0100889 */
890int abis_nm_get_sw_conf(const uint8_t * buf, size_t buf_len, struct abis_nm_sw_desc *sw, uint16_t sw_len)
891{
892 int rc;
893 uint16_t len = 0, i;
894 for (i = 0; i < sw_len; i++) {
895 memset(&sw[i], 0, sizeof(sw[i]));
896 rc = abis_nm_get_sw_desc(&sw[i], buf + len, buf_len - len);
897 if (rc < 0)
898 return rc;
899
900 len += abis_nm_get_sw_desc_len(buf + len, buf_len - len);
901
902 if (len >= buf_len)
903 return i + 1;
904 }
905
906 return i;
907}
908
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200909/*! Obtain OML Channel Combination for phnsical channel config */
Harald Welte11c71932011-05-24 17:15:12 +0200910int abis_nm_chcomb4pchan(enum gsm_phys_chan_config pchan)
911{
912 if (pchan < ARRAY_SIZE(chcomb4pchan))
913 return chcomb4pchan[pchan];
914
915 return -EINVAL;
916}
917
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200918/*! Obtain physical channel config for OML Channel Combination */
Holger Hans Peter Freytherd4d87c52014-01-02 14:10:25 +0100919enum gsm_phys_chan_config abis_nm_pchan4chcomb(uint8_t chcomb)
Harald Welte11c71932011-05-24 17:15:12 +0200920{
921 int i;
922 for (i = 0; i < ARRAY_SIZE(chcomb4pchan); i++) {
923 if (chcomb4pchan[i] == chcomb)
924 return i;
925 }
926 return GSM_PCHAN_NONE;
927}
Harald Welte4e777c32011-08-17 19:15:24 +0200928
Harald Welte868a5c42013-02-10 09:29:27 +0100929/* this is just for compatibility reasons, it is now a macro */
930#undef abis_nm_debugp_foh
Maxace80bb2017-01-13 13:45:06 +0100931OSMO_DEPRECATED("Use abis_nm_debugp_foh macro instead")
Harald Welte868a5c42013-02-10 09:29:27 +0100932void abis_nm_debugp_foh(int ss, struct abis_om_fom_hdr *foh)
933{
934 DEBUGP(ss, "OC=%s(%02x) INST=(%02x,%02x,%02x) ",
935 get_value_string(abis_nm_obj_class_names, foh->obj_class),
936 foh->obj_class, foh->obj_inst.bts_nr, foh->obj_inst.trx_nr,
937 foh->obj_inst.ts_nr);
938}
939
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200940/*! @} */