Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 1 | /* tbf_fsm.c |
| 2 | * |
| 3 | * Copyright (C) 2021 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 4 | * Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version 2 |
| 9 | * of the License, or (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, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 19 | */ |
| 20 | |
| 21 | #include <unistd.h> |
| 22 | |
| 23 | #include <talloc.h> |
| 24 | |
| 25 | #include <tbf_fsm.h> |
| 26 | #include <gprs_rlcmac.h> |
| 27 | #include <gprs_debug.h> |
| 28 | #include <gprs_ms.h> |
| 29 | #include <encoding.h> |
| 30 | #include <bts.h> |
| 31 | |
| 32 | #define X(s) (1 << (s)) |
| 33 | |
| 34 | const struct osmo_tdef_state_timeout tbf_fsm_timeouts[32] = { |
Pau Espin Pedrol | 0043005 | 2021-10-12 12:04:03 +0200 | [diff] [blame] | 35 | [TBF_ST_NEW] = {}, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 36 | [TBF_ST_ASSIGN] = { }, |
| 37 | [TBF_ST_FLOW] = { }, |
| 38 | [TBF_ST_FINISHED] = {}, |
| 39 | [TBF_ST_WAIT_RELEASE] = {}, |
| 40 | [TBF_ST_RELEASING] = {}, |
| 41 | }; |
| 42 | |
| 43 | const struct value_string tbf_fsm_event_names[] = { |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 44 | { TBF_EV_ASSIGN_ADD_CCCH, "ASSIGN_ADD_CCCH" }, |
| 45 | { TBF_EV_ASSIGN_ADD_PACCH, "ASSIGN_ADD_PACCH" }, |
Pau Espin Pedrol | 720e19e | 2021-07-22 19:56:37 +0200 | [diff] [blame] | 46 | { TBF_EV_ASSIGN_ACK_PACCH, "ASSIGN_ACK_PACCH" }, |
| 47 | { TBF_EV_ASSIGN_READY_CCCH, "ASSIGN_READY_CCCH" }, |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 48 | { TBF_EV_ASSIGN_PCUIF_CNF, "ASSIGN_PCUIF_CNF" }, |
| 49 | { TBF_EV_DL_ACKNACK_MISS, "DL_ACKNACK_MISS" }, |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 50 | { TBF_EV_LAST_DL_DATA_SENT, "LAST_DL_DATA_SENT" }, |
| 51 | { TBF_EV_LAST_UL_DATA_RECVD, "LAST_UL_DATA_RECVD" }, |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 52 | { TBF_EV_FINAL_ACK_RECVD, "FINAL_ACK_RECVD" }, |
Pau Espin Pedrol | 7a2b65e | 2021-10-11 19:18:13 +0200 | [diff] [blame] | 53 | { TBF_EV_FINAL_UL_ACK_CONFIRMED, "FINAL_UL_ACK_CONFIRMED" }, |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 54 | { TBF_EV_MAX_N3101 , "MAX_N3101" }, |
| 55 | { TBF_EV_MAX_N3103 , "MAX_N3103" }, |
| 56 | { TBF_EV_MAX_N3105 , "MAX_N3105" }, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 57 | { 0, NULL } |
| 58 | }; |
| 59 | |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 60 | static void mod_ass_type(struct tbf_fsm_ctx *ctx, uint8_t t, bool set) |
| 61 | { |
| 62 | const char *ch = "UNKNOWN"; |
| 63 | bool prev_set = ctx->state_flags & (1 << t); |
| 64 | |
| 65 | switch (t) { |
| 66 | case GPRS_RLCMAC_FLAG_CCCH: |
| 67 | ch = "CCCH"; |
| 68 | break; |
| 69 | case GPRS_RLCMAC_FLAG_PACCH: |
| 70 | ch = "PACCH"; |
| 71 | break; |
| 72 | default: |
| 73 | LOGPTBF(ctx->tbf, LOGL_ERROR, |
| 74 | "attempted to %sset unexpected ass. type %d - FIXME!\n", |
| 75 | set ? "" : "un", t); |
| 76 | return; |
| 77 | } |
| 78 | |
| 79 | if (set && prev_set) { |
| 80 | LOGPTBF(ctx->tbf, LOGL_ERROR, |
| 81 | "attempted to set ass. type %s which is already set.\n", ch); |
| 82 | } else if (!set && !prev_set) { |
| 83 | return; |
| 84 | } |
| 85 | |
| 86 | LOGPTBF(ctx->tbf, LOGL_INFO, "%sset ass. type %s [prev CCCH:%u, PACCH:%u]\n", |
| 87 | set ? "" : "un", ch, |
| 88 | !!(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)), |
| 89 | !!(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_PACCH))); |
| 90 | |
| 91 | if (set) { |
| 92 | ctx->state_flags |= (1 << t); |
| 93 | } else { |
| 94 | ctx->state_flags &= GPRS_RLCMAC_FLAG_TO_MASK; /* keep to flags */ |
| 95 | ctx->state_flags &= ~(1 << t); |
| 96 | } |
| 97 | } |
| 98 | |
| 99 | |
Pau Espin Pedrol | 0043005 | 2021-10-12 12:04:03 +0200 | [diff] [blame] | 100 | static void st_new(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 101 | { |
| 102 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
| 103 | switch (event) { |
| 104 | case TBF_EV_ASSIGN_ADD_CCCH: |
| 105 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, true); |
| 106 | tbf_fsm_state_chg(fi, tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF ? |
| 107 | TBF_ST_ASSIGN : TBF_ST_FLOW); |
| 108 | break; |
| 109 | case TBF_EV_ASSIGN_ADD_PACCH: |
| 110 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true); |
| 111 | tbf_fsm_state_chg(fi, TBF_ST_ASSIGN); |
| 112 | break; |
| 113 | default: |
| 114 | OSMO_ASSERT(0); |
| 115 | } |
| 116 | } |
| 117 | |
Pau Espin Pedrol | 9d67e72 | 2021-07-28 19:25:38 +0200 | [diff] [blame] | 118 | static void st_assign_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 119 | { |
| 120 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
| 121 | unsigned long val; |
| 122 | unsigned int sec, micro; |
| 123 | |
| 124 | /* If assignment for this TBF is happening on PACCH, that means the |
| 125 | * actual Assignment procedure (tx/rx) is happening on another TBF (eg |
| 126 | * Ul TBF vs DL TBF). Hence we add a security timer here to free it in |
| 127 | * case the other TBF doesn't succeed in informing (assigning) the MS |
| 128 | * about this TBF, or simply because the scheduler takes too long to |
| 129 | * schedule it. This timer can probably be dropped once we make the |
| 130 | * other TBF always signal us assignment failure (we already get |
| 131 | * assignment success through TBF_EV_ASSIGN_ACK_PACCH) */ |
| 132 | if (ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_PACCH)) { |
| 133 | fi->T = -2001; |
| 134 | val = osmo_tdef_get(the_pcu->T_defs, fi->T, OSMO_TDEF_MS, -1); |
| 135 | sec = val / 1000; |
| 136 | micro = (val % 1000) * 1000; |
| 137 | LOGPTBF(ctx->tbf, LOGL_DEBUG, |
| 138 | "Starting timer X2001 [assignment (PACCH)] with %u sec. %u microsec\n", |
| 139 | sec, micro); |
| 140 | osmo_timer_schedule(&fi->timer, sec, micro); |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 141 | } else if (tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF) { |
| 142 | /* GPRS_RLCMAC_FLAG_CCCH is set, so here we submitted an DL Ass through PCUIF on CCCH */ |
Pau Espin Pedrol | 9d67e72 | 2021-07-28 19:25:38 +0200 | [diff] [blame] | 143 | } |
| 144 | } |
| 145 | |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 146 | static void st_assign(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 147 | { |
| 148 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 149 | unsigned long val; |
| 150 | unsigned int sec, micro; |
| 151 | |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 152 | switch (event) { |
| 153 | case TBF_EV_ASSIGN_ADD_CCCH: |
| 154 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, true); |
| 155 | break; |
| 156 | case TBF_EV_ASSIGN_ADD_PACCH: |
| 157 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true); |
| 158 | break; |
Pau Espin Pedrol | 720e19e | 2021-07-22 19:56:37 +0200 | [diff] [blame] | 159 | case TBF_EV_ASSIGN_ACK_PACCH: |
Pau Espin Pedrol | ffe998c | 2021-10-12 19:32:28 +0200 | [diff] [blame] | 160 | tbf_assign_control_ts(ctx->tbf); |
Pau Espin Pedrol | 720e19e | 2021-07-22 19:56:37 +0200 | [diff] [blame] | 161 | if (ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)) { |
| 162 | /* We now know that the PACCH really existed */ |
| 163 | LOGPTBF(ctx->tbf, LOGL_INFO, |
| 164 | "The TBF has been confirmed on the PACCH, " |
| 165 | "changed type from CCCH to PACCH\n"); |
| 166 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, false); |
| 167 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true); |
| 168 | } |
| 169 | tbf_fsm_state_chg(fi, TBF_ST_FLOW); |
| 170 | break; |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 171 | case TBF_EV_ASSIGN_PCUIF_CNF: |
| 172 | /* BTS informs us it sent Imm Ass for DL TBF over CCCH. We now |
| 173 | * have to wait for X2002 to trigger (meaning MS is already |
| 174 | * listening on PDCH) in order to move to FLOW state and start |
| 175 | * transmitting data to it. When X2002 triggers (see cb timer |
| 176 | * end of the file) it will send TBF_EV_ASSIGN_READY_CCCH back |
| 177 | * to us here. */ |
| 178 | OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF); |
| 179 | fi->T = -2002; |
| 180 | val = osmo_tdef_get(the_pcu->T_defs, fi->T, OSMO_TDEF_MS, -1); |
| 181 | sec = val / 1000; |
| 182 | micro = (val % 1000) * 1000; |
| 183 | LOGPTBF(ctx->tbf, LOGL_DEBUG, |
| 184 | "Starting timer X2002 [assignment (AGCH)] with %u sec. %u microsec\n", |
| 185 | sec, micro); |
| 186 | osmo_timer_schedule(&fi->timer, sec, micro); |
| 187 | break; |
Pau Espin Pedrol | 720e19e | 2021-07-22 19:56:37 +0200 | [diff] [blame] | 188 | case TBF_EV_ASSIGN_READY_CCCH: |
| 189 | /* change state to FLOW, so scheduler will start transmission */ |
| 190 | tbf_fsm_state_chg(fi, TBF_ST_FLOW); |
| 191 | break; |
Pau Espin Pedrol | 85aa87b | 2021-10-12 14:02:52 +0200 | [diff] [blame] | 192 | case TBF_EV_MAX_N3105: |
Pau Espin Pedrol | b3291bc | 2021-10-14 19:21:38 +0200 | [diff] [blame] | 193 | /* We are going to release, so abort any Pkt Ul Ass pending to be scheduled: */ |
| 194 | osmo_fsm_inst_dispatch(tbf_ul_ass_fi(ctx->tbf), TBF_UL_ASS_EV_ABORT, NULL); |
Pau Espin Pedrol | 85aa87b | 2021-10-12 14:02:52 +0200 | [diff] [blame] | 195 | ctx->T_release = 3195; |
| 196 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 197 | break; |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 198 | default: |
| 199 | OSMO_ASSERT(0); |
| 200 | } |
| 201 | } |
| 202 | |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 203 | static void st_flow(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 204 | { |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 205 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 206 | |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 207 | switch (event) { |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 208 | case TBF_EV_DL_ACKNACK_MISS: |
| 209 | /* DL TBF: we missed a DL ACK/NACK. If we started assignment |
| 210 | * over CCCH and never received any DL ACK/NACK yet, it means we |
| 211 | * don't even know if the MS successfuly received the Imm Ass on |
| 212 | * CCCH and hence is listening on PDCH. Let's better refrain |
| 213 | * from continuing and start assignment on CCCH again */ |
| 214 | if ((ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)) |
| 215 | && !(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_DL_ACK))) { |
| 216 | struct GprsMs *ms = tbf_ms(ctx->tbf); |
| 217 | const char *imsi = ms_imsi(ms); |
| 218 | uint16_t pgroup; |
Pau Espin Pedrol | d06ec27 | 2021-07-30 15:03:21 +0200 | [diff] [blame] | 219 | LOGPTBF(ctx->tbf, LOGL_DEBUG, "Re-send downlink assignment on PCH (IMSI=%s)\n", |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 220 | imsi); |
| 221 | tbf_fsm_state_chg(fi, TBF_ST_ASSIGN); |
| 222 | /* send immediate assignment */ |
| 223 | if ((pgroup = imsi2paging_group(imsi)) > 999) |
| 224 | LOGPTBF(ctx->tbf, LOGL_ERROR, "IMSI to paging group failed! (%s)\n", imsi); |
| 225 | bts_snd_dl_ass(ms->bts, ctx->tbf, pgroup); |
| 226 | } |
| 227 | break; |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 228 | case TBF_EV_LAST_DL_DATA_SENT: |
| 229 | case TBF_EV_LAST_UL_DATA_RECVD: |
| 230 | /* All data has been sent or received, change state to FINISHED */ |
| 231 | tbf_fsm_state_chg(fi, TBF_ST_FINISHED); |
| 232 | break; |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 233 | case TBF_EV_FINAL_ACK_RECVD: |
| 234 | /* We received Final Ack (DL ACK/NACK) from MS. move to |
| 235 | WAIT_RELEASE, we wait there for release or re-use the TBF in |
| 236 | case we receive more DL data to tx */ |
| 237 | tbf_fsm_state_chg(fi, TBF_ST_WAIT_RELEASE); |
| 238 | break; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 239 | case TBF_EV_MAX_N3101: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 240 | ctx->T_release = 3169; |
| 241 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 242 | break; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 243 | case TBF_EV_MAX_N3105: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 244 | ctx->T_release = 3195; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 245 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 246 | break; |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 247 | default: |
| 248 | OSMO_ASSERT(0); |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | static void st_finished(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 253 | { |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 254 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 255 | switch (event) { |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 256 | case TBF_EV_DL_ACKNACK_MISS: |
| 257 | break; |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 258 | case TBF_EV_FINAL_ACK_RECVD: |
| 259 | /* We received Final Ack (DL ACK/NACK) from MS. move to |
| 260 | WAIT_RELEASE, we wait there for release or re-use the TBF in |
| 261 | case we receive more DL data to tx */ |
| 262 | tbf_fsm_state_chg(fi, TBF_ST_WAIT_RELEASE); |
| 263 | break; |
Pau Espin Pedrol | 7a2b65e | 2021-10-11 19:18:13 +0200 | [diff] [blame] | 264 | case TBF_EV_FINAL_UL_ACK_CONFIRMED: |
| 265 | /* UL TBF ACKed our transmitted UL ACK/NACK with final Ack |
| 266 | * Indicator set to '1' t. We can free the TBF right away. */ |
| 267 | tbf_free(ctx->tbf); |
| 268 | break; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 269 | case TBF_EV_MAX_N3103: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 270 | ctx->T_release = 3169; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 271 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 272 | break; |
| 273 | case TBF_EV_MAX_N3105: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 274 | ctx->T_release = 3195; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 275 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 276 | break; |
| 277 | default: |
| 278 | OSMO_ASSERT(0); |
| 279 | } |
| 280 | } |
| 281 | |
Pau Espin Pedrol | f48de62 | 2021-07-30 14:48:06 +0200 | [diff] [blame] | 282 | static void st_wait_release_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 283 | { |
| 284 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
| 285 | unsigned long val_s, val_ms, val_us; |
| 286 | OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF); |
| 287 | |
| 288 | fi->T = 3193; |
| 289 | val_ms = osmo_tdef_get(tbf_ms(ctx->tbf)->bts->T_defs_bts, fi->T, OSMO_TDEF_MS, -1); |
| 290 | val_s = val_ms / 1000; |
| 291 | val_us = (val_ms % 1000) * 1000; |
| 292 | LOGPTBF(ctx->tbf, LOGL_DEBUG, "starting timer T%u with %lu sec. %lu microsec\n", |
| 293 | fi->T, val_s, val_us); |
| 294 | osmo_timer_schedule(&fi->timer, val_s, val_us); |
| 295 | |
| 296 | mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, false); |
| 297 | } |
| 298 | |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 299 | static void st_wait_release(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 300 | { |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 301 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 302 | switch (event) { |
| 303 | case TBF_EV_FINAL_ACK_RECVD: |
| 304 | /* ignore, duplicate ACK, we already know about since we are in WAIT_RELEASE */ |
| 305 | break; |
| 306 | case TBF_EV_MAX_N3101: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 307 | ctx->T_release = 3169; |
| 308 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 309 | break; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 310 | case TBF_EV_MAX_N3105: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 311 | ctx->T_release = 3195; |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 312 | tbf_fsm_state_chg(fi, TBF_ST_RELEASING); |
| 313 | break; |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 314 | default: |
| 315 | OSMO_ASSERT(0); |
| 316 | } |
| 317 | } |
| 318 | |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 319 | static void st_releasing_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 320 | { |
| 321 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
| 322 | unsigned long val; |
| 323 | |
| 324 | if (!ctx->T_release) |
| 325 | return; |
| 326 | |
| 327 | /* In general we should end up here with an assigned timer in ctx->T_release. Possible values are: |
| 328 | * T3195: Wait for reuse of TFI(s) when there is no response from the MS |
| 329 | * (radio failure or cell change) for this TBF/MBMS radio bearer. |
| 330 | * T3169: Wait for reuse of USF and TFI(s) after the MS uplink assignment for this TBF is invalid. |
| 331 | */ |
| 332 | val = osmo_tdef_get(tbf_ms(ctx->tbf)->bts->T_defs_bts, ctx->T_release, OSMO_TDEF_S, -1); |
| 333 | fi->T = ctx->T_release; |
| 334 | LOGPTBF(ctx->tbf, LOGL_DEBUG, "starting timer T%u with %lu sec. %u microsec\n", |
| 335 | ctx->T_release, val, 0); |
| 336 | osmo_timer_schedule(&fi->timer, val, 0); |
| 337 | } |
| 338 | |
Pau Espin Pedrol | cee6b12 | 2021-09-28 16:49:33 +0200 | [diff] [blame] | 339 | static void st_releasing(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 340 | { |
| 341 | switch (event) { |
| 342 | case TBF_EV_DL_ACKNACK_MISS: |
| 343 | /* Ignore, we don't care about missed DL ACK/NACK poll timeouts |
| 344 | * anymore, we are already releasing the TBF */ |
| 345 | break; |
| 346 | default: |
| 347 | OSMO_ASSERT(0); |
| 348 | } |
| 349 | } |
| 350 | |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 351 | static void handle_timeout_X2002(struct tbf_fsm_ctx *ctx) |
| 352 | { |
| 353 | struct gprs_rlcmac_dl_tbf *dl_tbf = as_dl_tbf(ctx->tbf); |
| 354 | |
Pau Espin Pedrol | 89a995a | 2021-10-18 14:25:17 +0200 | [diff] [blame] | 355 | /* X2002 is used only for DL TBF */ |
| 356 | OSMO_ASSERT(dl_tbf); |
| 357 | |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 358 | if (ctx->fi->state == TBF_ST_ASSIGN) { |
| 359 | tbf_assign_control_ts(ctx->tbf); |
| 360 | |
| 361 | if (!tbf_can_upgrade_to_multislot(ctx->tbf)) { |
| 362 | /* change state to FLOW, so scheduler |
| 363 | * will start transmission */ |
| 364 | osmo_fsm_inst_dispatch(ctx->fi, TBF_EV_ASSIGN_READY_CCCH, NULL); |
| 365 | return; |
| 366 | } |
| 367 | |
| 368 | /* This tbf can be upgraded to use multiple DL |
| 369 | * timeslots and now that there is already one |
| 370 | * slot assigned send another DL assignment via |
| 371 | * PDCH. */ |
| 372 | |
| 373 | /* keep to flags */ |
| 374 | ctx->state_flags &= GPRS_RLCMAC_FLAG_TO_MASK; |
| 375 | |
| 376 | tbf_update(ctx->tbf); |
| 377 | |
| 378 | tbf_dl_trigger_ass(dl_tbf, ctx->tbf); |
| 379 | } else |
| 380 | LOGPTBF(ctx->tbf, LOGL_NOTICE, "Continue flow after IMM.ASS confirm\n"); |
| 381 | } |
| 382 | |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 383 | static int tbf_fsm_timer_cb(struct osmo_fsm_inst *fi) |
| 384 | { |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 385 | struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv; |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 386 | switch (fi->T) { |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 387 | case -2002: |
| 388 | handle_timeout_X2002(ctx); |
| 389 | break; |
Pau Espin Pedrol | 9d67e72 | 2021-07-28 19:25:38 +0200 | [diff] [blame] | 390 | case -2001: |
| 391 | LOGPTBF(ctx->tbf, LOGL_NOTICE, "releasing due to PACCH assignment timeout.\n"); |
| 392 | /* fall-through */ |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 393 | case 3169: |
Pau Espin Pedrol | f48de62 | 2021-07-30 14:48:06 +0200 | [diff] [blame] | 394 | case 3193: |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 395 | case 3195: |
| 396 | tbf_free(ctx->tbf); |
| 397 | break; |
| 398 | default: |
| 399 | OSMO_ASSERT(0); |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 400 | } |
| 401 | return 0; |
| 402 | } |
| 403 | |
| 404 | static struct osmo_fsm_state tbf_fsm_states[] = { |
Pau Espin Pedrol | 0043005 | 2021-10-12 12:04:03 +0200 | [diff] [blame] | 405 | [TBF_ST_NEW] = { |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 406 | .in_event_mask = |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 407 | X(TBF_EV_ASSIGN_ADD_CCCH) | |
| 408 | X(TBF_EV_ASSIGN_ADD_PACCH), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 409 | .out_state_mask = |
| 410 | X(TBF_ST_ASSIGN) | |
| 411 | X(TBF_ST_FLOW) | |
| 412 | X(TBF_ST_RELEASING), |
Pau Espin Pedrol | 0043005 | 2021-10-12 12:04:03 +0200 | [diff] [blame] | 413 | .name = "NEW", |
| 414 | .action = st_new, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 415 | }, |
| 416 | [TBF_ST_ASSIGN] = { |
| 417 | .in_event_mask = |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 418 | X(TBF_EV_ASSIGN_ADD_CCCH) | |
Pau Espin Pedrol | 720e19e | 2021-07-22 19:56:37 +0200 | [diff] [blame] | 419 | X(TBF_EV_ASSIGN_ADD_PACCH) | |
| 420 | X(TBF_EV_ASSIGN_ACK_PACCH) | |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 421 | X(TBF_EV_ASSIGN_PCUIF_CNF) | |
Pau Espin Pedrol | 85aa87b | 2021-10-12 14:02:52 +0200 | [diff] [blame] | 422 | X(TBF_EV_ASSIGN_READY_CCCH) | |
| 423 | X(TBF_EV_MAX_N3105), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 424 | .out_state_mask = |
| 425 | X(TBF_ST_FLOW) | |
| 426 | X(TBF_ST_FINISHED) | |
| 427 | X(TBF_ST_RELEASING), |
| 428 | .name = "ASSIGN", |
Pau Espin Pedrol | 33e8007 | 2021-07-22 19:20:50 +0200 | [diff] [blame] | 429 | .action = st_assign, |
Pau Espin Pedrol | 9d67e72 | 2021-07-28 19:25:38 +0200 | [diff] [blame] | 430 | .onenter = st_assign_on_enter, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 431 | }, |
| 432 | [TBF_ST_FLOW] = { |
| 433 | .in_event_mask = |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 434 | X(TBF_EV_DL_ACKNACK_MISS) | |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 435 | X(TBF_EV_LAST_DL_DATA_SENT) | |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 436 | X(TBF_EV_LAST_UL_DATA_RECVD) | |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 437 | X(TBF_EV_FINAL_ACK_RECVD) | |
| 438 | X(TBF_EV_MAX_N3101) | |
| 439 | X(TBF_EV_MAX_N3105), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 440 | .out_state_mask = |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 441 | X(TBF_ST_ASSIGN) | |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 442 | X(TBF_ST_FINISHED) | |
| 443 | X(TBF_ST_WAIT_RELEASE) | |
| 444 | X(TBF_ST_RELEASING), |
| 445 | .name = "FLOW", |
Pau Espin Pedrol | c32c4a3 | 2021-07-23 18:27:57 +0200 | [diff] [blame] | 446 | .action = st_flow, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 447 | }, |
| 448 | [TBF_ST_FINISHED] = { |
| 449 | .in_event_mask = |
Pau Espin Pedrol | 3225290 | 2021-07-29 16:44:11 +0200 | [diff] [blame] | 450 | X(TBF_EV_DL_ACKNACK_MISS) | |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 451 | X(TBF_EV_FINAL_ACK_RECVD) | |
Pau Espin Pedrol | 7a2b65e | 2021-10-11 19:18:13 +0200 | [diff] [blame] | 452 | X(TBF_EV_FINAL_UL_ACK_CONFIRMED) | |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 453 | X(TBF_EV_MAX_N3103) | |
| 454 | X(TBF_EV_MAX_N3105), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 455 | .out_state_mask = |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 456 | X(TBF_ST_WAIT_RELEASE) | |
| 457 | X(TBF_ST_RELEASING), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 458 | .name = "FINISHED", |
Pau Espin Pedrol | efcb046 | 2021-07-26 12:33:39 +0200 | [diff] [blame] | 459 | .action = st_finished, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 460 | }, |
| 461 | [TBF_ST_WAIT_RELEASE] = { |
| 462 | .in_event_mask = |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 463 | X(TBF_EV_FINAL_ACK_RECVD) | |
| 464 | X(TBF_EV_MAX_N3101) | |
| 465 | X(TBF_EV_MAX_N3105), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 466 | .out_state_mask = |
| 467 | X(TBF_ST_RELEASING), |
| 468 | .name = "WAIT_RELEASE", |
Pau Espin Pedrol | 55f600b | 2021-07-26 15:54:39 +0200 | [diff] [blame] | 469 | .action = st_wait_release, |
Pau Espin Pedrol | f48de62 | 2021-07-30 14:48:06 +0200 | [diff] [blame] | 470 | .onenter = st_wait_release_on_enter, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 471 | }, |
| 472 | [TBF_ST_RELEASING] = { |
| 473 | .in_event_mask = |
Pau Espin Pedrol | cee6b12 | 2021-09-28 16:49:33 +0200 | [diff] [blame] | 474 | X(TBF_EV_DL_ACKNACK_MISS), |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 475 | .out_state_mask = |
| 476 | 0, |
| 477 | .name = "RELEASING", |
Pau Espin Pedrol | cee6b12 | 2021-09-28 16:49:33 +0200 | [diff] [blame] | 478 | .action = st_releasing, |
Pau Espin Pedrol | cfb61d9 | 2021-07-26 17:17:02 +0200 | [diff] [blame] | 479 | .onenter = st_releasing_on_enter, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 480 | }, |
| 481 | }; |
| 482 | |
| 483 | struct osmo_fsm tbf_fsm = { |
| 484 | .name = "TBF", |
| 485 | .states = tbf_fsm_states, |
| 486 | .num_states = ARRAY_SIZE(tbf_fsm_states), |
| 487 | .timer_cb = tbf_fsm_timer_cb, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 488 | .log_subsys = DTBF, |
| 489 | .event_names = tbf_fsm_event_names, |
Pau Espin Pedrol | dc2aaac | 2021-05-14 12:50:46 +0200 | [diff] [blame] | 490 | }; |
| 491 | |
| 492 | static __attribute__((constructor)) void tbf_fsm_init(void) |
| 493 | { |
| 494 | OSMO_ASSERT(osmo_fsm_register(&tbf_fsm) == 0); |
| 495 | } |