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 |
| 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> |
Harald Welte | dfe6c7d | 2010-02-20 16:24:02 +0100 | [diff] [blame] | 27 | #include <osmocore/tlv.h> |
Harald Welte | 13f5297 | 2010-02-20 18:56:00 +0100 | [diff] [blame] | 28 | #include <osmocore/protocol/gsm_12_21.h> |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 29 | |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 30 | struct cell_global_id { |
| 31 | u_int16_t mcc; |
| 32 | u_int16_t mnc; |
| 33 | u_int16_t lac; |
| 34 | u_int16_t ci; |
| 35 | }; |
| 36 | |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 37 | /* The BCCH info from an ip.access test, in host byte order |
| 38 | * and already parsed... */ |
| 39 | struct ipac_bcch_info { |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 40 | struct llist_head list; |
| 41 | |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 42 | u_int16_t info_type; |
| 43 | u_int8_t freq_qual; |
| 44 | u_int16_t arfcn; |
| 45 | u_int8_t rx_lev; |
| 46 | u_int8_t rx_qual; |
Harald Welte | aff237d | 2009-11-13 14:41:52 +0100 | [diff] [blame] | 47 | int16_t freq_err; |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 48 | u_int16_t frame_offset; |
| 49 | u_int32_t frame_nr_offset; |
| 50 | u_int8_t bsic; |
Harald Welte | b40a38f | 2009-11-13 11:56:05 +0100 | [diff] [blame] | 51 | struct cell_global_id cgi; |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 52 | u_int8_t ba_list_si2[16]; |
| 53 | u_int8_t ba_list_si2bis[16]; |
| 54 | u_int8_t ba_list_si2ter[16]; |
| 55 | u_int8_t ca_list_si1[16]; |
| 56 | }; |
| 57 | |
Harald Welte | 81c9b9c | 2010-05-31 16:40:40 +0200 | [diff] [blame] | 58 | extern const struct value_string abis_nm_adm_state_names[]; |
| 59 | extern const struct value_string abis_nm_obj_class_names[]; |
Harald Welte | 39315c4 | 2010-01-10 18:01:52 +0100 | [diff] [blame] | 60 | extern const struct tlv_definition nm_att_tlvdef; |
| 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 | |
Harald Welte | 39315c4 | 2010-01-10 18:01:52 +0100 | [diff] [blame] | 76 | int abis_nm_tlv_parse(struct tlv_parsed *tp, struct gsm_bts *bts, const u_int8_t *buf, int len); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 77 | int abis_nm_rx(struct msgb *msg); |
Harald Welte | 34a9968 | 2009-02-13 02:41:40 +0000 | [diff] [blame] | 78 | int abis_nm_opstart(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i0, u_int8_t i1, u_int8_t i2); |
| 79 | int abis_nm_chg_adm_state(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i0, |
Daniel Willmann | 65f68fa | 2009-08-10 11:49:36 +0200 | [diff] [blame] | 80 | u_int8_t i1, u_int8_t i2, enum abis_nm_adm_state adm_state); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 81 | int abis_nm_establish_tei(struct gsm_bts *bts, u_int8_t trx_nr, |
| 82 | u_int8_t e1_port, u_int8_t e1_timeslot, u_int8_t e1_subslot, |
| 83 | u_int8_t tei); |
| 84 | int abis_nm_conn_terr_sign(struct gsm_bts_trx *trx, |
| 85 | u_int8_t e1_port, u_int8_t e1_timeslot, u_int8_t e1_subslot); |
| 86 | int abis_nm_conn_terr_traf(struct gsm_bts_trx_ts *ts, |
| 87 | u_int8_t e1_port, u_int8_t e1_timeslot, |
| 88 | u_int8_t e1_subslot); |
Harald Welte | 22af0db | 2009-02-14 15:41:08 +0000 | [diff] [blame] | 89 | int abis_nm_set_bts_attr(struct gsm_bts *bts, u_int8_t *attr, int attr_len); |
| 90 | int abis_nm_set_radio_attr(struct gsm_bts_trx *trx, u_int8_t *attr, int attr_len); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 91 | int abis_nm_set_channel_attr(struct gsm_bts_trx_ts *ts, u_int8_t chan_comb); |
Harald Welte | 34a9968 | 2009-02-13 02:41:40 +0000 | [diff] [blame] | 92 | int abis_nm_sw_act_req_ack(struct gsm_bts *bts, u_int8_t obj_class, u_int8_t i1, |
Harald Welte | 5c1e458 | 2009-02-15 11:57:29 +0000 | [diff] [blame] | 93 | u_int8_t i2, u_int8_t i3, int nack, u_int8_t *attr, int att_len); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 94 | int abis_nm_raw_msg(struct gsm_bts *bts, int len, u_int8_t *msg); |
| 95 | int abis_nm_event_reports(struct gsm_bts *bts, int on); |
| 96 | int abis_nm_reset_resource(struct gsm_bts *bts); |
Holger Hans Peter Freyther | 64278ed | 2010-05-12 23:51:46 +0800 | [diff] [blame] | 97 | int abis_nm_software_load(struct gsm_bts *bts, int trx_nr, const char *fname, |
Harald Welte | 3ffd137 | 2009-02-01 22:15:49 +0000 | [diff] [blame] | 98 | u_int8_t win_size, int forced, |
| 99 | gsm_cbfn *cbfn, void *cb_data); |
| 100 | int abis_nm_software_load_status(struct gsm_bts *bts); |
Harald Welte | 5e4d1b3 | 2009-02-01 13:36:56 +0000 | [diff] [blame] | 101 | int abis_nm_software_activate(struct gsm_bts *bts, const char *fname, |
| 102 | gsm_cbfn *cbfn, void *cb_data); |
Harald Welte | 47d88ae | 2009-01-04 12:02:08 +0000 | [diff] [blame] | 103 | |
Harald Welte | 1989c08 | 2009-08-06 17:58:31 +0200 | [diff] [blame] | 104 | int abis_nm_conn_mdrop_link(struct gsm_bts *bts, u_int8_t e1_port0, u_int8_t ts0, |
| 105 | u_int8_t e1_port1, u_int8_t ts1); |
| 106 | |
Harald Welte | c731038 | 2009-08-08 00:02:36 +0200 | [diff] [blame] | 107 | int abis_nm_perform_test(struct gsm_bts *bts, u_int8_t obj_class, |
| 108 | u_int8_t bts_nr, u_int8_t trx_nr, u_int8_t ts_nr, |
| 109 | u_int8_t test_nr, u_int8_t auton_report, |
| 110 | u_int8_t *phys_config, u_int16_t phys_config_len); |
| 111 | |
Harald Welte | 21bd3a5 | 2009-08-10 12:21:22 +0200 | [diff] [blame] | 112 | int abis_nm_chcomb4pchan(enum gsm_phys_chan_config pchan); |
| 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, |
Harald Welte | 1bc0906 | 2009-01-18 14:17:52 +0000 | [diff] [blame] | 118 | u_int8_t idx, u_int8_t attr_len, const u_int8_t *attr); |
Harald Welte | 05188ee | 2009-01-18 11:39:08 +0000 | [diff] [blame] | 119 | int abis_nm_bs11_create_envaBTSE(struct gsm_bts *bts, u_int8_t idx); |
| 120 | int abis_nm_bs11_create_bport(struct gsm_bts *bts, u_int8_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, |
| 122 | enum abis_bs11_objtype type, u_int8_t idx); |
Daniel Willmann | 65f68fa | 2009-08-10 11:49:36 +0200 | [diff] [blame] | 123 | int abis_nm_bs11_delete_bport(struct gsm_bts *bts, u_int8_t idx); |
Harald Welte | b6c92ae | 2009-02-21 20:15:32 +0000 | [diff] [blame] | 124 | int abis_nm_bs11_conn_oml_tei(struct gsm_bts *bts, u_int8_t e1_port, |
| 125 | u_int8_t e1_timeslot, u_int8_t e1_subslot, u_int8_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); |
Harald Welte | 05188ee | 2009-01-18 11:39:08 +0000 | [diff] [blame] | 128 | int abis_nm_bs11_set_trx_power(struct gsm_bts_trx *trx, u_int8_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); |
Daniel Willmann | 493db4e | 2010-01-07 00:43:11 +0100 | [diff] [blame] | 130 | int abis_nm_bs11_logon(struct gsm_bts *bts, u_int8_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, |
Harald Welte | 3ffd137 | 2009-02-01 22:15:49 +0000 | [diff] [blame] | 140 | u_int8_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); |
Daniel Willmann | 65f68fa | 2009-08-10 11:49:36 +0200 | [diff] [blame] | 142 | int abis_nm_bs11_set_bport_line_cfg(struct gsm_bts *bts, u_int8_t bport, enum abis_bs11_line_cfg line_cfg); |
Harald Welte | 3ffd137 | 2009-02-01 22:15:49 +0000 | [diff] [blame] | 143 | int abis_nm_bs11_bsc_disconnect(struct gsm_bts *bts, int reconnect); |
Harald Welte | 1fa60c8 | 2009-02-09 18:13:26 +0000 | [diff] [blame] | 144 | int abis_nm_bs11_restart(struct gsm_bts *bts); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 145 | |
Harald Welte | 5c1e458 | 2009-02-15 11:57:29 +0000 | [diff] [blame] | 146 | /* ip.access nanoBTS specific commands */ |
| 147 | int abis_nm_ipaccess_msg(struct gsm_bts *bts, u_int8_t msg_type, |
| 148 | u_int8_t obj_class, u_int8_t bts_nr, |
| 149 | u_int8_t trx_nr, u_int8_t ts_nr, |
| 150 | u_int8_t *attr, int attr_len); |
Harald Welte | 2ef156d | 2010-01-07 20:39:42 +0100 | [diff] [blame] | 151 | int abis_nm_ipaccess_set_nvattr(struct gsm_bts_trx *trx, u_int8_t *attr, |
Harald Welte | 193fefc | 2009-04-30 15:16:27 +0000 | [diff] [blame] | 152 | int attr_len); |
Holger Hans Peter Freyther | 52fd4e4 | 2010-05-12 23:34:51 +0800 | [diff] [blame] | 153 | int abis_nm_ipaccess_restart(struct gsm_bts_trx *trx); |
Harald Welte | daef521 | 2009-10-24 10:20:41 +0200 | [diff] [blame] | 154 | int abis_nm_ipaccess_set_attr(struct gsm_bts *bts, u_int8_t obj_class, |
| 155 | u_int8_t bts_nr, u_int8_t trx_nr, u_int8_t ts_nr, |
| 156 | u_int8_t *attr, u_int8_t attr_len); |
Harald Welte | 746d609 | 2009-10-19 22:11:11 +0200 | [diff] [blame] | 157 | int abis_nm_ipaccess_rsl_connect(struct gsm_bts_trx *trx, |
| 158 | u_int32_t ip, u_int16_t port, u_int8_t stream); |
Harald Welte | 97a282b | 2010-03-14 15:37:43 +0800 | [diff] [blame] | 159 | void abis_nm_ipaccess_cgi(u_int8_t *buf, struct gsm_bts *bts); |
Harald Welte | 0f25585 | 2009-11-12 14:48:42 +0100 | [diff] [blame] | 160 | int ipac_parse_bcch_info(struct ipac_bcch_info *binf, u_int8_t *buf); |
| 161 | const char *ipacc_testres_name(u_int8_t res); |
Harald Welte | 5c1e458 | 2009-02-15 11:57:29 +0000 | [diff] [blame] | 162 | |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 163 | /* Functions calling into other code parts */ |
| 164 | enum nm_evt { |
| 165 | EVT_STATECHG_OPER, |
| 166 | EVT_STATECHG_ADM, |
| 167 | }; |
| 168 | int nm_state_event(enum nm_evt evt, u_int8_t obj_class, void *obj, |
Holger Hans Peter Freyther | aa0db80 | 2010-05-13 00:37:48 +0800 | [diff] [blame] | 169 | struct gsm_nm_state *old_state, struct gsm_nm_state *new_state, |
| 170 | struct abis_om_obj_inst *obj_inst); |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 171 | |
Harald Welte | 4d87f24 | 2009-03-10 19:43:44 +0000 | [diff] [blame] | 172 | const char *nm_opstate_name(u_int8_t os); |
| 173 | const char *nm_avail_name(u_int8_t avail); |
Sylvain Munaut | 1f6c11f | 2010-01-02 16:32:17 +0100 | [diff] [blame] | 174 | int nm_is_running(struct gsm_nm_state *s); |
Harald Welte | 81c9b9c | 2010-05-31 16:40:40 +0200 | [diff] [blame] | 175 | |
| 176 | int abis_nm_vty_init(void); |
| 177 | |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 178 | #endif /* _NM_H */ |