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