Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 1 | /* osmo-bsc API to manage lchans, logical channels in GSM cells. */ |
| 2 | #pragma once |
| 3 | |
| 4 | #include <osmocom/bsc/gsm_data.h> |
| 5 | #include <osmocom/bsc/debug.h> |
| 6 | |
| 7 | /* This macro automatically includes a final \n, if omitted. */ |
| 8 | #define LOG_LCHAN(lchan, level, fmt, args...) do { \ |
| 9 | if (lchan->fi) \ |
| 10 | LOGPFSML(lchan->fi, level, "(type=%s) " fmt, gsm_lchant_name(lchan->type), ## args); \ |
| 11 | else \ |
| 12 | LOGP(DRSL, level, "%s (not initialized) " fmt, gsm_lchan_name(lchan), ## args); \ |
| 13 | } while(0) |
| 14 | |
| 15 | enum lchan_fsm_state { |
| 16 | LCHAN_ST_UNUSED, |
Neels Hofmeyr | 526b4a5 | 2018-09-11 00:47:29 +0200 | [diff] [blame] | 17 | LCHAN_ST_CBCH, /*< Blocked by CBCH channel combination, not usable as SDCCH. */ |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 18 | LCHAN_ST_WAIT_TS_READY, |
| 19 | LCHAN_ST_WAIT_ACTIV_ACK, /*< After RSL Chan Act Ack, lchan is active but RTP not configured. */ |
Neels Hofmeyr | ac85b34 | 2018-07-12 21:23:26 +0200 | [diff] [blame] | 20 | LCHAN_ST_WAIT_RLL_RTP_ESTABLISH, |
Philipp Maier | 92eed41 | 2020-08-21 20:47:49 +0200 | [diff] [blame] | 21 | LCHAN_ST_WAIT_RR_CHAN_MODE_MODIFY_ACK, |
| 22 | LCHAN_ST_WAIT_RSL_CHAN_MODE_MODIFY_ACK, |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 23 | LCHAN_ST_ESTABLISHED, /*< Active and RTP is fully configured. */ |
Neels Hofmeyr | ac85b34 | 2018-07-12 21:23:26 +0200 | [diff] [blame] | 24 | LCHAN_ST_WAIT_RLL_RTP_RELEASED, |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 25 | LCHAN_ST_WAIT_BEFORE_RF_RELEASE, |
| 26 | LCHAN_ST_WAIT_RF_RELEASE_ACK, |
| 27 | LCHAN_ST_WAIT_AFTER_ERROR, |
| 28 | LCHAN_ST_BORKEN, |
| 29 | }; |
| 30 | |
| 31 | enum lchan_fsm_event { |
| 32 | LCHAN_EV_ACTIVATE, |
| 33 | LCHAN_EV_TS_READY, |
| 34 | LCHAN_EV_TS_ERROR, |
| 35 | LCHAN_EV_RSL_CHAN_ACTIV_ACK, |
| 36 | LCHAN_EV_RSL_CHAN_ACTIV_NACK, |
| 37 | LCHAN_EV_RLL_ESTABLISH_IND, |
Neels Hofmeyr | ac85b34 | 2018-07-12 21:23:26 +0200 | [diff] [blame] | 38 | LCHAN_EV_RTP_READY, |
| 39 | LCHAN_EV_RTP_ERROR, |
| 40 | LCHAN_EV_RTP_RELEASED, |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 41 | LCHAN_EV_RLL_REL_IND, |
| 42 | LCHAN_EV_RLL_REL_CONF, |
| 43 | LCHAN_EV_RSL_RF_CHAN_REL_ACK, |
| 44 | LCHAN_EV_RLL_ERR_IND, |
Philipp Maier | 92eed41 | 2020-08-21 20:47:49 +0200 | [diff] [blame] | 45 | LCHAN_EV_RR_CHAN_MODE_MODIFY_ACK, |
| 46 | LCHAN_EV_RR_CHAN_MODE_MODIFY_ERROR, |
| 47 | LCHAN_EV_RSL_CHAN_MODE_MODIFY_ACK, |
| 48 | LCHAN_EV_RSL_CHAN_MODE_MODIFY_NACK, |
| 49 | LCHAN_EV_REQUEST_MODE_MODIFY, |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 50 | }; |
| 51 | |
| 52 | void lchan_fsm_init(); |
| 53 | |
| 54 | void lchan_fsm_alloc(struct gsm_lchan *lchan); |
Neels Hofmeyr | 5b1a7d1 | 2018-11-06 22:24:07 +0100 | [diff] [blame] | 55 | void lchan_release(struct gsm_lchan *lchan, bool do_rr_release, |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 56 | bool err, enum gsm48_rr_cause cause_rr); |
| 57 | |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 58 | void lchan_activate(struct gsm_lchan *lchan, struct lchan_activate_info *info); |
Neels Hofmeyr | ac85b34 | 2018-07-12 21:23:26 +0200 | [diff] [blame] | 59 | void lchan_ready_to_switch_rtp(struct gsm_lchan *lchan); |
Neels Hofmeyr | 31f525e | 2018-05-14 18:14:15 +0200 | [diff] [blame] | 60 | |
| 61 | static inline const char *lchan_state_name(struct gsm_lchan *lchan) |
| 62 | { |
| 63 | return lchan->fi ? osmo_fsm_inst_state_name(lchan->fi) : "NULL"; |
| 64 | } |
| 65 | |
| 66 | static inline bool lchan_state_is(struct gsm_lchan *lchan, uint32_t state) |
| 67 | { |
| 68 | return (!lchan->fi && state == LCHAN_ST_UNUSED) |
| 69 | || (lchan->fi && lchan->fi->state == state); |
| 70 | } |
| 71 | |
| 72 | bool lchan_may_receive_data(struct gsm_lchan *lchan); |
| 73 | |
| 74 | void lchan_forget_conn(struct gsm_lchan *lchan); |
Neels Hofmeyr | ac85b34 | 2018-07-12 21:23:26 +0200 | [diff] [blame] | 75 | |
| 76 | void lchan_set_last_error(struct gsm_lchan *lchan, const char *fmt, ...); |
Philipp Maier | cc6d35d | 2020-08-21 22:40:23 +0200 | [diff] [blame] | 77 | |
| 78 | void lchan_fsm_skip_error(struct gsm_lchan *lchan); |