Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 1 | /* 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 Welte | 4724f99 | 2009-01-18 18:01:49 +0000 | [diff] [blame] | 4 | /* (C) 2008-2009 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 5 | * All Rights Reserved |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 8 | * it under the terms of the GNU Affero General Public License as published by |
| 9 | * the Free Software Foundation; either version 3 of the License, or |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 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 |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 15 | * GNU Affero General Public License for more details. |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 16 | * |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 17 | * You should have received a copy of the GNU Affero General Public License |
| 18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 19 | * |
| 20 | */ |
| 21 | |
| 22 | #ifndef _NM_H |
| 23 | #define _NM_H |
| 24 | |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 25 | #include <osmocom/gsm/tlv.h> |
Harald Welte | 472e7e9 | 2011-06-05 11:24:08 +0200 | [diff] [blame] | 26 | #include <osmocom/gsm/abis_nm.h> |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 27 | #include <osmocom/gsm/protocol/gsm_12_21.h> |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 28 | |
Neels Hofmeyr | 2d521a0 | 2016-05-14 00:57:04 +0200 | [diff] [blame] | 29 | #include <openbsc/gsm_data.h> |
| 30 | |
Max | 1ebf23b | 2017-05-10 12:21:17 +0200 | [diff] [blame] | 31 | /* max number of attributes represented as 3GPP TS 52.021 ยง9.4.62 SW Description array */ |
| 32 | #define MAX_BTS_ATTR 5 |
| 33 | |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 34 | struct cell_global_id { |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 35 | uint16_t mcc; |
| 36 | uint16_t mnc; |
| 37 | uint16_t lac; |
| 38 | uint16_t ci; |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 39 | }; |
| 40 | |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 41 | /* The BCCH info from an ip.access test, in host byte order |
| 42 | * and already parsed... */ |
| 43 | struct ipac_bcch_info { |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 44 | struct llist_head list; |
| 45 | |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 46 | uint16_t info_type; |
| 47 | uint8_t freq_qual; |
| 48 | uint16_t arfcn; |
| 49 | uint8_t rx_lev; |
| 50 | uint8_t rx_qual; |
Harald Welte | aff237d | 2009-11-13 14:41:52 +0100 | [diff] [blame] | 51 | int16_t freq_err; |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 52 | uint16_t frame_offset; |
| 53 | uint32_t frame_nr_offset; |
| 54 | uint8_t bsic; |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 55 | struct cell_global_id cgi; |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 56 | uint8_t ba_list_si2[16]; |
| 57 | uint8_t ba_list_si2bis[16]; |
| 58 | uint8_t ba_list_si2ter[16]; |
| 59 | uint8_t ca_list_si1[16]; |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 60 | }; |
| 61 | |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 62 | /* PUBLIC */ |
| 63 | |
| 64 | struct msgb; |
| 65 | |
| 66 | struct abis_nm_cfg { |
| 67 | /* callback for unidirectional reports */ |
| 68 | int (*report_cb)(struct msgb *, |
| 69 | struct abis_om_fom_hdr *); |
| 70 | /* callback for software activate requests from BTS */ |
| 71 | int (*sw_act_req)(struct msgb *); |
| 72 | }; |
| 73 | |
Harald Welte | 8470bf2 | 2008-12-25 23:28:35 +0000 | [diff] [blame] | 74 | extern int abis_nm_rcvmsg(struct msgb *msg); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 75 | |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 76 | int abis_nm_tlv_parse(struct tlv_parsed *tp, struct gsm_bts *bts, const uint8_t *buf, int len); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 77 | int abis_nm_rx(struct msgb *msg); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 78 | int abis_nm_opstart(struct gsm_bts *bts, uint8_t obj_class, uint8_t i0, uint8_t i1, uint8_t i2); |
| 79 | int abis_nm_chg_adm_state(struct gsm_bts *bts, uint8_t obj_class, uint8_t i0, |
| 80 | uint8_t i1, uint8_t i2, enum abis_nm_adm_state adm_state); |
| 81 | int abis_nm_establish_tei(struct gsm_bts *bts, uint8_t trx_nr, |
| 82 | uint8_t e1_port, uint8_t e1_timeslot, uint8_t e1_subslot, |
| 83 | uint8_t tei); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 84 | int abis_nm_conn_terr_sign(struct gsm_bts_trx *trx, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 85 | uint8_t e1_port, uint8_t e1_timeslot, uint8_t e1_subslot); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 86 | int abis_nm_conn_terr_traf(struct gsm_bts_trx_ts *ts, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 87 | uint8_t e1_port, uint8_t e1_timeslot, |
| 88 | uint8_t e1_subslot); |
Harald Welte | fe568f2 | 2012-08-14 19:15:57 +0200 | [diff] [blame] | 89 | int abis_nm_get_attr(struct gsm_bts *bts, uint8_t obj_class, |
| 90 | uint8_t bts_nr, uint8_t trx_nr, uint8_t ts_nr, |
Max | 1ebf23b | 2017-05-10 12:21:17 +0200 | [diff] [blame] | 91 | const uint8_t *attr, uint8_t attr_len); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 92 | int abis_nm_set_bts_attr(struct gsm_bts *bts, uint8_t *attr, int attr_len); |
| 93 | int abis_nm_set_radio_attr(struct gsm_bts_trx *trx, uint8_t *attr, int attr_len); |
| 94 | int abis_nm_set_channel_attr(struct gsm_bts_trx_ts *ts, uint8_t chan_comb); |
| 95 | int abis_nm_sw_act_req_ack(struct gsm_bts *bts, uint8_t obj_class, uint8_t i1, |
| 96 | uint8_t i2, uint8_t i3, int nack, uint8_t *attr, int att_len); |
| 97 | int abis_nm_raw_msg(struct gsm_bts *bts, int len, uint8_t *msg); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 98 | int abis_nm_event_reports(struct gsm_bts *bts, int on); |
| 99 | int abis_nm_reset_resource(struct gsm_bts *bts); |
Holger Hans Peter Freyther | 64278ed | 2010-05-12 23:51:46 +0800 | [diff] [blame] | 100 | int abis_nm_software_load(struct gsm_bts *bts, int trx_nr, const char *fname, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 101 | uint8_t win_size, int forced, |
Harald Welte | 3ffd137 | 2009-02-01 22:15:49 +0000 | [diff] [blame] | 102 | gsm_cbfn *cbfn, void *cb_data); |
| 103 | int abis_nm_software_load_status(struct gsm_bts *bts); |
Harald Welte | 5e4d1b3 | 2009-02-01 13:36:56 +0000 | [diff] [blame] | 104 | int abis_nm_software_activate(struct gsm_bts *bts, const char *fname, |
| 105 | gsm_cbfn *cbfn, void *cb_data); |
Harald Welte | 47d88ae | 2009-01-04 12:02:08 +0000 | [diff] [blame] | 106 | |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 107 | int abis_nm_conn_mdrop_link(struct gsm_bts *bts, uint8_t e1_port0, uint8_t ts0, |
| 108 | uint8_t e1_port1, uint8_t ts1); |
Harald Welte | 1989c08 | 2009-08-06 17:58:31 +0200 | [diff] [blame] | 109 | |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 110 | int abis_nm_perform_test(struct gsm_bts *bts, uint8_t obj_class, |
| 111 | uint8_t bts_nr, uint8_t trx_nr, uint8_t ts_nr, |
| 112 | uint8_t test_nr, uint8_t auton_report, struct msgb *msg); |
Harald Welte | c731038 | 2009-08-08 00:02:36 +0200 | [diff] [blame] | 113 | |
Harald Welte | 47d88ae | 2009-01-04 12:02:08 +0000 | [diff] [blame] | 114 | /* Siemens / BS-11 specific */ |
Holger Freyther | 245c534 | 2009-01-27 19:00:44 +0000 | [diff] [blame] | 115 | int abis_nm_bs11_reset_resource(struct gsm_bts *bts); |
Harald Welte | 05188ee | 2009-01-18 11:39:08 +0000 | [diff] [blame] | 116 | int abis_nm_bs11_db_transmission(struct gsm_bts *bts, int begin); |
| 117 | int abis_nm_bs11_create_object(struct gsm_bts *bts, enum abis_bs11_objtype type, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 118 | uint8_t idx, uint8_t attr_len, const uint8_t *attr); |
| 119 | int abis_nm_bs11_create_envaBTSE(struct gsm_bts *bts, uint8_t idx); |
| 120 | int abis_nm_bs11_create_bport(struct gsm_bts *bts, uint8_t idx); |
Harald Welte | 78fc0d4 | 2009-02-19 02:50:57 +0000 | [diff] [blame] | 121 | int abis_nm_bs11_delete_object(struct gsm_bts *bts, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 122 | enum abis_bs11_objtype type, uint8_t idx); |
| 123 | int abis_nm_bs11_delete_bport(struct gsm_bts *bts, uint8_t idx); |
| 124 | int abis_nm_bs11_conn_oml_tei(struct gsm_bts *bts, uint8_t e1_port, |
| 125 | uint8_t e1_timeslot, uint8_t e1_subslot, uint8_t tei); |
Harald Welte | 78fc0d4 | 2009-02-19 02:50:57 +0000 | [diff] [blame] | 126 | int abis_nm_bs11_get_oml_tei_ts(struct gsm_bts *bts); |
| 127 | int abis_nm_bs11_get_serno(struct gsm_bts *bts); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 128 | int abis_nm_bs11_set_trx_power(struct gsm_bts_trx *trx, uint8_t level); |
Harald Welte | 78fc0d4 | 2009-02-19 02:50:57 +0000 | [diff] [blame] | 129 | int abis_nm_bs11_get_trx_power(struct gsm_bts_trx *trx); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 130 | int abis_nm_bs11_logon(struct gsm_bts *bts, uint8_t level, const char *name, int on); |
Harald Welte | 1bc0906 | 2009-01-18 14:17:52 +0000 | [diff] [blame] | 131 | int abis_nm_bs11_factory_logon(struct gsm_bts *bts, int on); |
Daniel Willmann | 4b054c8 | 2010-01-07 00:46:26 +0100 | [diff] [blame] | 132 | int abis_nm_bs11_infield_logon(struct gsm_bts *bts, int on); |
Harald Welte | 1bc0906 | 2009-01-18 14:17:52 +0000 | [diff] [blame] | 133 | int abis_nm_bs11_set_trx1_pw(struct gsm_bts *bts, const char *password); |
Harald Welte | e69f5fb | 2009-04-28 16:31:38 +0000 | [diff] [blame] | 134 | int abis_nm_bs11_set_pll_locked(struct gsm_bts *bts, int locked); |
Harald Welte | ef06195 | 2009-05-17 12:43:42 +0000 | [diff] [blame] | 135 | int abis_nm_bs11_get_pll_mode(struct gsm_bts *bts); |
Daniel Willmann | 7b1dd74 | 2010-01-07 00:54:01 +0100 | [diff] [blame] | 136 | int abis_nm_bs11_set_pll(struct gsm_bts *bts, int value); |
Harald Welte | ef06195 | 2009-05-17 12:43:42 +0000 | [diff] [blame] | 137 | int abis_nm_bs11_get_cclk(struct gsm_bts *bts); |
Harald Welte | 1bc0906 | 2009-01-18 14:17:52 +0000 | [diff] [blame] | 138 | int abis_nm_bs11_get_state(struct gsm_bts *bts); |
Harald Welte | 5e4d1b3 | 2009-02-01 13:36:56 +0000 | [diff] [blame] | 139 | int abis_nm_bs11_load_swl(struct gsm_bts *bts, const char *fname, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 140 | uint8_t win_size, int forced, gsm_cbfn *cbfn); |
Harald Welte | 268bb40 | 2009-02-01 19:11:56 +0000 | [diff] [blame] | 141 | int abis_nm_bs11_set_ext_time(struct gsm_bts *bts); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 142 | int abis_nm_bs11_get_bport_line_cfg(struct gsm_bts *bts, uint8_t bport); |
| 143 | int abis_nm_bs11_set_bport_line_cfg(struct gsm_bts *bts, uint8_t bport, enum abis_bs11_line_cfg line_cfg); |
Harald Welte | 3ffd137 | 2009-02-01 22:15:49 +0000 | [diff] [blame] | 144 | int abis_nm_bs11_bsc_disconnect(struct gsm_bts *bts, int reconnect); |
Harald Welte | 1fa60c8 | 2009-02-09 18:13:26 +0000 | [diff] [blame] | 145 | int abis_nm_bs11_restart(struct gsm_bts *bts); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 146 | |
Harald Welte | 5c1e458 | 2009-02-15 11:57:29 +0000 | [diff] [blame] | 147 | /* ip.access nanoBTS specific commands */ |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 148 | int abis_nm_ipaccess_msg(struct gsm_bts *bts, uint8_t msg_type, |
| 149 | uint8_t obj_class, uint8_t bts_nr, |
| 150 | uint8_t trx_nr, uint8_t ts_nr, |
| 151 | uint8_t *attr, int attr_len); |
| 152 | int abis_nm_ipaccess_set_nvattr(struct gsm_bts_trx *trx, uint8_t *attr, |
Harald Welte | 193fefc | 2009-04-30 15:16:27 +0000 | [diff] [blame] | 153 | int attr_len); |
Holger Hans Peter Freyther | 52fd4e4 | 2010-05-12 23:34:51 +0800 | [diff] [blame] | 154 | int abis_nm_ipaccess_restart(struct gsm_bts_trx *trx); |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 155 | int abis_nm_ipaccess_set_attr(struct gsm_bts *bts, uint8_t obj_class, |
| 156 | uint8_t bts_nr, uint8_t trx_nr, uint8_t ts_nr, |
| 157 | uint8_t *attr, uint8_t attr_len); |
Harald Welte | 746d609 | 2009-10-19 22:11:11 +0200 | [diff] [blame] | 158 | int abis_nm_ipaccess_rsl_connect(struct gsm_bts_trx *trx, |
Holger Hans Peter Freyther | c42ad8b | 2011-04-18 17:04:00 +0200 | [diff] [blame] | 159 | uint32_t ip, uint16_t port, uint8_t stream); |
| 160 | void abis_nm_ipaccess_cgi(uint8_t *buf, struct gsm_bts *bts); |
| 161 | int ipac_parse_bcch_info(struct ipac_bcch_info *binf, uint8_t *buf); |
| 162 | const char *ipacc_testres_name(uint8_t res); |
Harald Welte | 5c1e458 | 2009-02-15 11:57:29 +0000 | [diff] [blame] | 163 | |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 164 | /* Functions calling into other code parts */ |
Sylvain Munaut | 1f6c11f | 2010-01-02 16:32:17 +0100 | [diff] [blame] | 165 | int nm_is_running(struct gsm_nm_state *s); |
Harald Welte | 81c9b9c | 2010-05-31 16:40:40 +0200 | [diff] [blame] | 166 | |
| 167 | int abis_nm_vty_init(void); |
| 168 | |
Holger Hans Peter Freyther | 6f61555 | 2010-11-15 20:50:42 +0100 | [diff] [blame] | 169 | void abis_nm_clear_queue(struct gsm_bts *bts); |
| 170 | |
Harald Welte | 15eae8d | 2011-09-26 23:43:23 +0200 | [diff] [blame] | 171 | int _abis_nm_sendmsg(struct msgb *msg); |
Pablo Neira Ayuso | ed5cacb | 2011-08-17 22:44:07 +0200 | [diff] [blame] | 172 | |
| 173 | void abis_nm_queue_send_next(struct gsm_bts *bts); /* for bs11_config. */ |
Holger Hans Peter Freyther | 6f61555 | 2010-11-15 20:50:42 +0100 | [diff] [blame] | 174 | |
Max | fd2c1f9 | 2017-03-24 21:04:57 +0100 | [diff] [blame] | 175 | int abis_nm_select_newest_sw(const struct abis_nm_sw_desc *sw, const size_t len); |
Holger Hans Peter Freyther | bce5675 | 2012-11-22 14:59:46 +0100 | [diff] [blame] | 176 | |
Holger Hans Peter Freyther | 8a158bb | 2014-03-26 14:24:42 +0100 | [diff] [blame] | 177 | /* Helper functions for updating attributes */ |
| 178 | int abis_nm_update_max_power_red(struct gsm_bts_trx *trx); |
| 179 | |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 180 | #endif /* _NM_H */ |