Holger Hans Peter Freyther | 43b0909 | 2010-06-15 11:52:51 +0800 | [diff] [blame] | 1 | /* Routines for the MSC handling */ |
| 2 | |
| 3 | #ifndef OSMO_MSC_H |
| 4 | #define OSMO_MSC_H |
| 5 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 6 | #include <osmocom/core/fsm.h> |
| 7 | #include <osmocom/gsm/gsup.h> |
| 8 | |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 9 | #include <osmocom/msc/gsm_data.h> |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 10 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 11 | #define MSC_HLR_REMOTE_IP_DEFAULT "127.0.0.1" |
| 12 | #define MSC_HLR_REMOTE_PORT_DEFAULT OSMO_GSUP_PORT |
| 13 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 14 | enum ran_conn_fsm_event { |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 15 | /* Accepted the initial Complete Layer 3 (starting to evaluate Authentication and Ciphering) */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 16 | RAN_CONN_E_COMPLETE_LAYER_3, |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 17 | /* Received Classmark Update, typically neede for Ciphering Mode Command */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 18 | RAN_CONN_E_CLASSMARK_UPDATE, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 19 | /* LU or Process Access FSM has determined that this conn is good */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 20 | RAN_CONN_E_ACCEPTED, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 21 | /* received first reply from MS in "real" CC, SMS, USSD communication */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 22 | RAN_CONN_E_COMMUNICATING, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 23 | /* Some async action has completed, check again whether all is done */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 24 | RAN_CONN_E_RELEASE_WHEN_UNUSED, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 25 | /* MS/BTS/BSC originated close request */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 26 | RAN_CONN_E_MO_CLOSE, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 27 | /* MSC originated close request, e.g. failed authentication */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 28 | RAN_CONN_E_CN_CLOSE, |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 29 | /* The usage count for the conn has reached zero */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 30 | RAN_CONN_E_UNUSED, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 31 | }; |
| 32 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 33 | enum ran_conn_fsm_state { |
| 34 | RAN_CONN_S_NEW, |
| 35 | RAN_CONN_S_AUTH_CIPH, |
| 36 | RAN_CONN_S_WAIT_CLASSMARK_UPDATE, |
| 37 | RAN_CONN_S_ACCEPTED, |
| 38 | RAN_CONN_S_COMMUNICATING, |
| 39 | RAN_CONN_S_RELEASING, |
| 40 | RAN_CONN_S_RELEASED, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 41 | }; |
| 42 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 43 | struct ran_conn *ran_conn_alloc(struct gsm_network *network, enum ran_type via_ran, uint16_t lac); |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 44 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 45 | void ran_conn_update_id(struct ran_conn *conn, enum complete_layer3_type from, const char *id); |
| 46 | char *ran_conn_get_conn_id(struct ran_conn *conn); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 47 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 48 | void ran_conn_complete_layer_3(struct ran_conn *conn); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 49 | |
| 50 | int msc_vlr_alloc(struct gsm_network *net); |
| 51 | int msc_vlr_start(struct gsm_network *net); |
| 52 | |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 53 | void ran_conn_sapi_n_reject(struct ran_conn *conn, int dlci); |
| 54 | int ran_conn_clear_request(struct ran_conn *conn, uint32_t cause); |
| 55 | void ran_conn_compl_l3(struct ran_conn *conn, |
| 56 | struct msgb *msg, uint16_t chosen_channel); |
| 57 | void ran_conn_dtap(struct ran_conn *conn, struct msgb *msg); |
| 58 | int ran_conn_classmark_request_then_cipher_mode_cmd(struct ran_conn *conn, bool umts_aka, |
| 59 | bool retrieve_imeisv); |
| 60 | int ran_conn_geran_set_cipher_mode(struct ran_conn *conn, bool umts_aka, bool retrieve_imeisv); |
| 61 | void ran_conn_cipher_mode_compl(struct ran_conn *conn, struct msgb *msg, uint8_t alg_id); |
| 62 | void ran_conn_rx_sec_mode_compl(struct ran_conn *conn); |
| 63 | void ran_conn_classmark_chg(struct ran_conn *conn, |
| 64 | const uint8_t *cm2, uint8_t cm2_len, |
| 65 | const uint8_t *cm3, uint8_t cm3_len); |
| 66 | void ran_conn_assign_fail(struct ran_conn *conn, uint8_t cause, uint8_t *rr_cause); |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 67 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 68 | void ran_conn_init(void); |
| 69 | bool ran_conn_is_accepted(const struct ran_conn *conn); |
| 70 | bool ran_conn_is_establishing_auth_ciph(const struct ran_conn *conn); |
| 71 | void ran_conn_communicating(struct ran_conn *conn); |
| 72 | void ran_conn_close(struct ran_conn *conn, uint32_t cause); |
| 73 | void ran_conn_mo_close(struct ran_conn *conn, uint32_t cause); |
| 74 | bool ran_conn_in_release(struct ran_conn *conn); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 75 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 76 | void ran_conn_rx_bssmap_clear_complete(struct ran_conn *conn); |
| 77 | void ran_conn_rx_iu_release_complete(struct ran_conn *conn); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 78 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 79 | enum ran_conn_use { |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 80 | RAN_CONN_USE_UNTRACKED = -1, |
| 81 | RAN_CONN_USE_COMPL_L3, |
| 82 | RAN_CONN_USE_DTAP, |
| 83 | RAN_CONN_USE_AUTH_CIPH, |
| 84 | RAN_CONN_USE_CM_SERVICE, |
| 85 | RAN_CONN_USE_TRANS_CC, |
| 86 | RAN_CONN_USE_TRANS_SMS, |
| 87 | RAN_CONN_USE_TRANS_NC_SS, |
| 88 | RAN_CONN_USE_SILENT_CALL, |
| 89 | RAN_CONN_USE_RELEASE, |
Neels Hofmeyr | 6166f29 | 2017-11-22 14:33:12 +0100 | [diff] [blame] | 90 | }; |
| 91 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 92 | extern const struct value_string ran_conn_use_names[]; |
| 93 | static inline const char *ran_conn_use_name(enum ran_conn_use val) |
| 94 | { return get_value_string(ran_conn_use_names, val); } |
Neels Hofmeyr | 6166f29 | 2017-11-22 14:33:12 +0100 | [diff] [blame] | 95 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 96 | #define ran_conn_get(conn, balance_token) \ |
| 97 | _ran_conn_get(conn, balance_token, __FILE__, __LINE__) |
| 98 | #define ran_conn_put(conn, balance_token) \ |
| 99 | _ran_conn_put(conn, balance_token, __FILE__, __LINE__) |
| 100 | struct ran_conn * _ran_conn_get(struct ran_conn *conn, enum ran_conn_use balance_token, |
| 101 | const char *file, int line); |
| 102 | void _ran_conn_put(struct ran_conn *conn, enum ran_conn_use balance_token, |
| 103 | const char *file, int line); |
| 104 | bool ran_conn_used_by(struct ran_conn *conn, enum ran_conn_use token); |
Holger Hans Peter Freyther | 43b0909 | 2010-06-15 11:52:51 +0800 | [diff] [blame] | 105 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 106 | void msc_stop_paging(struct vlr_subscr *vsub); |
| 107 | |
Holger Hans Peter Freyther | 43b0909 | 2010-06-15 11:52:51 +0800 | [diff] [blame] | 108 | #endif |