blob: 9ddbd69f6922f1dba6cd37159262c1b7e6e851f2 [file] [log] [blame]
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +02001/* 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 Pedroldc2aaac2021-05-14 12:50:46 +020015 */
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
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +020028#include <bts_pch_timer.h>
29
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +020030#define X(s) (1 << (s))
31
32const struct osmo_tdef_state_timeout tbf_fsm_timeouts[32] = {
Pau Espin Pedrol00430052021-10-12 12:04:03 +020033 [TBF_ST_NEW] = {},
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +020034 [TBF_ST_ASSIGN] = { },
35 [TBF_ST_FLOW] = { },
36 [TBF_ST_FINISHED] = {},
37 [TBF_ST_WAIT_RELEASE] = {},
38 [TBF_ST_RELEASING] = {},
39};
40
41const struct value_string tbf_fsm_event_names[] = {
Pau Espin Pedrol33e80072021-07-22 19:20:50 +020042 { TBF_EV_ASSIGN_ADD_CCCH, "ASSIGN_ADD_CCCH" },
43 { TBF_EV_ASSIGN_ADD_PACCH, "ASSIGN_ADD_PACCH" },
Pau Espin Pedrol720e19e2021-07-22 19:56:37 +020044 { TBF_EV_ASSIGN_ACK_PACCH, "ASSIGN_ACK_PACCH" },
45 { TBF_EV_ASSIGN_READY_CCCH, "ASSIGN_READY_CCCH" },
Pau Espin Pedrol32252902021-07-29 16:44:11 +020046 { TBF_EV_ASSIGN_PCUIF_CNF, "ASSIGN_PCUIF_CNF" },
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +020047 { TBF_EV_FIRST_UL_DATA_RECVD, "FIRST_UL_DATA_RECVD" },
Pau Espin Pedrol32252902021-07-29 16:44:11 +020048 { TBF_EV_DL_ACKNACK_MISS, "DL_ACKNACK_MISS" },
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +020049 { TBF_EV_LAST_DL_DATA_SENT, "LAST_DL_DATA_SENT" },
50 { TBF_EV_LAST_UL_DATA_RECVD, "LAST_UL_DATA_RECVD" },
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +020051 { TBF_EV_FINAL_ACK_RECVD, "FINAL_ACK_RECVD" },
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +020052 { TBF_EV_FINAL_UL_ACK_CONFIRMED, "FINAL_UL_ACK_CONFIRMED" },
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +020053 { TBF_EV_MAX_N3101 , "MAX_N3101" },
54 { TBF_EV_MAX_N3103 , "MAX_N3103" },
55 { TBF_EV_MAX_N3105 , "MAX_N3105" },
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +020056 { 0, NULL }
57};
58
Pau Espin Pedrol33e80072021-07-22 19:20:50 +020059static void mod_ass_type(struct tbf_fsm_ctx *ctx, uint8_t t, bool set)
60{
61 const char *ch = "UNKNOWN";
62 bool prev_set = ctx->state_flags & (1 << t);
63
64 switch (t) {
65 case GPRS_RLCMAC_FLAG_CCCH:
66 ch = "CCCH";
67 break;
68 case GPRS_RLCMAC_FLAG_PACCH:
69 ch = "PACCH";
70 break;
71 default:
72 LOGPTBF(ctx->tbf, LOGL_ERROR,
73 "attempted to %sset unexpected ass. type %d - FIXME!\n",
74 set ? "" : "un", t);
75 return;
76 }
77
78 if (set && prev_set) {
79 LOGPTBF(ctx->tbf, LOGL_ERROR,
80 "attempted to set ass. type %s which is already set.\n", ch);
81 } else if (!set && !prev_set) {
82 return;
83 }
84
85 LOGPTBF(ctx->tbf, LOGL_INFO, "%sset ass. type %s [prev CCCH:%u, PACCH:%u]\n",
86 set ? "" : "un", ch,
87 !!(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)),
88 !!(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_PACCH)));
89
90 if (set) {
91 ctx->state_flags |= (1 << t);
92 } else {
93 ctx->state_flags &= GPRS_RLCMAC_FLAG_TO_MASK; /* keep to flags */
94 ctx->state_flags &= ~(1 << t);
95 }
96}
97
98
Pau Espin Pedrol00430052021-10-12 12:04:03 +020099static void st_new(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200100{
101 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
102 switch (event) {
103 case TBF_EV_ASSIGN_ADD_CCCH:
104 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, true);
Pau Espin Pedrol94386132022-10-28 19:50:09 +0200105 if (tbf_direction(ctx->tbf) == GPRS_RLCMAC_UL_TBF) {
106 struct gprs_rlcmac_ul_tbf *ul_tbf = tbf_as_ul_tbf(ctx->tbf);
107 tbf_fsm_state_chg(fi, TBF_ST_FLOW);
108 ul_tbf_contention_resolution_start(ul_tbf);
109 } else {
110 tbf_fsm_state_chg(fi, TBF_ST_ASSIGN);
111 }
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200112 break;
113 case TBF_EV_ASSIGN_ADD_PACCH:
114 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true);
115 tbf_fsm_state_chg(fi, TBF_ST_ASSIGN);
116 break;
117 default:
118 OSMO_ASSERT(0);
119 }
120}
121
Pau Espin Pedrol9d67e722021-07-28 19:25:38 +0200122static void st_assign_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
123{
124 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
125 unsigned long val;
126 unsigned int sec, micro;
127
128 /* If assignment for this TBF is happening on PACCH, that means the
129 * actual Assignment procedure (tx/rx) is happening on another TBF (eg
130 * Ul TBF vs DL TBF). Hence we add a security timer here to free it in
131 * case the other TBF doesn't succeed in informing (assigning) the MS
132 * about this TBF, or simply because the scheduler takes too long to
133 * schedule it. This timer can probably be dropped once we make the
134 * other TBF always signal us assignment failure (we already get
135 * assignment success through TBF_EV_ASSIGN_ACK_PACCH) */
136 if (ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_PACCH)) {
137 fi->T = -2001;
138 val = osmo_tdef_get(the_pcu->T_defs, fi->T, OSMO_TDEF_MS, -1);
139 sec = val / 1000;
140 micro = (val % 1000) * 1000;
141 LOGPTBF(ctx->tbf, LOGL_DEBUG,
142 "Starting timer X2001 [assignment (PACCH)] with %u sec. %u microsec\n",
143 sec, micro);
144 osmo_timer_schedule(&fi->timer, sec, micro);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200145 } else if (tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF) {
146 /* GPRS_RLCMAC_FLAG_CCCH is set, so here we submitted an DL Ass through PCUIF on CCCH */
Pau Espin Pedrol9d67e722021-07-28 19:25:38 +0200147 }
148}
149
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200150static void st_assign(struct osmo_fsm_inst *fi, uint32_t event, void *data)
151{
152 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200153 unsigned long val;
154 unsigned int sec, micro;
155
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200156 switch (event) {
157 case TBF_EV_ASSIGN_ADD_CCCH:
158 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, true);
159 break;
160 case TBF_EV_ASSIGN_ADD_PACCH:
161 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true);
162 break;
Pau Espin Pedrol720e19e2021-07-22 19:56:37 +0200163 case TBF_EV_ASSIGN_ACK_PACCH:
Pau Espin Pedrolffe998c2021-10-12 19:32:28 +0200164 tbf_assign_control_ts(ctx->tbf);
Pau Espin Pedrol720e19e2021-07-22 19:56:37 +0200165 if (ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)) {
166 /* We now know that the PACCH really existed */
167 LOGPTBF(ctx->tbf, LOGL_INFO,
168 "The TBF has been confirmed on the PACCH, "
169 "changed type from CCCH to PACCH\n");
170 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, false);
171 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_PACCH, true);
172 }
173 tbf_fsm_state_chg(fi, TBF_ST_FLOW);
174 break;
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200175 case TBF_EV_ASSIGN_PCUIF_CNF:
176 /* BTS informs us it sent Imm Ass for DL TBF over CCCH. We now
177 * have to wait for X2002 to trigger (meaning MS is already
178 * listening on PDCH) in order to move to FLOW state and start
179 * transmitting data to it. When X2002 triggers (see cb timer
180 * end of the file) it will send TBF_EV_ASSIGN_READY_CCCH back
181 * to us here. */
182 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
183 fi->T = -2002;
184 val = osmo_tdef_get(the_pcu->T_defs, fi->T, OSMO_TDEF_MS, -1);
185 sec = val / 1000;
186 micro = (val % 1000) * 1000;
187 LOGPTBF(ctx->tbf, LOGL_DEBUG,
188 "Starting timer X2002 [assignment (AGCH)] with %u sec. %u microsec\n",
189 sec, micro);
190 osmo_timer_schedule(&fi->timer, sec, micro);
191 break;
Pau Espin Pedrol720e19e2021-07-22 19:56:37 +0200192 case TBF_EV_ASSIGN_READY_CCCH:
193 /* change state to FLOW, so scheduler will start transmission */
194 tbf_fsm_state_chg(fi, TBF_ST_FLOW);
195 break;
Pau Espin Pedrol85aa87b2021-10-12 14:02:52 +0200196 case TBF_EV_MAX_N3105:
Pau Espin Pedrolb3291bc2021-10-14 19:21:38 +0200197 /* We are going to release, so abort any Pkt Ul Ass pending to be scheduled: */
198 osmo_fsm_inst_dispatch(tbf_ul_ass_fi(ctx->tbf), TBF_UL_ASS_EV_ABORT, NULL);
Pau Espin Pedrol85aa87b2021-10-12 14:02:52 +0200199 ctx->T_release = 3195;
200 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
201 break;
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200202 default:
203 OSMO_ASSERT(0);
204 }
205}
206
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200207static void st_flow(struct osmo_fsm_inst *fi, uint32_t event, void *data)
208{
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200209 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +0200210 struct GprsMs *ms = tbf_ms(ctx->tbf);
Pau Espin Pedrol677bebb2022-10-31 13:56:33 +0100211 struct gprs_rlcmac_dl_tbf *dl_tbf = NULL;
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200212
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200213 switch (event) {
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +0200214 case TBF_EV_FIRST_UL_DATA_RECVD:
215 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_UL_TBF);
216 /* TS 44.060 7a.2.1.1: "The contention resolution is completed on
217 * the network side when the network receives an RLC data block that
218 * comprises the TLLI value that identifies the mobile station and the
219 * TFI value associated with the TBF." */
220 bts_pch_timer_stop(ms->bts, ms);
Pau Espin Pedrol677bebb2022-10-31 13:56:33 +0100221 /* We may still have some DL-TBF waiting for assignment in PCH,
222 * which clearly won't happen since the MS is on PDCH now. Get rid
223 * of it, it will be re-assigned on PACCH when contention
224 * resolution at the MS side is done (1st UL ACK/NACK sent) */
225 if ((dl_tbf = ms_dl_tbf(ms))) {
226 /* Get rid of previous finished UL TBF before providing a new one */
227 LOGPTBFDL(dl_tbf, LOGL_NOTICE,
228 "Got first UL data while DL-TBF pending, killing it\n");
229 tbf_free(dl_tbf_as_tbf(dl_tbf));
230 dl_tbf = NULL;
231 }
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +0200232 break;
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200233 case TBF_EV_DL_ACKNACK_MISS:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200234 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200235 /* DL TBF: we missed a DL ACK/NACK. If we started assignment
236 * over CCCH and never received any DL ACK/NACK yet, it means we
237 * don't even know if the MS successfuly received the Imm Ass on
238 * CCCH and hence is listening on PDCH. Let's better refrain
239 * from continuing and start assignment on CCCH again */
240 if ((ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH))
241 && !(ctx->state_flags & (1 << GPRS_RLCMAC_FLAG_DL_ACK))) {
242 struct GprsMs *ms = tbf_ms(ctx->tbf);
Pau Espin Pedrold06ec272021-07-30 15:03:21 +0200243 LOGPTBF(ctx->tbf, LOGL_DEBUG, "Re-send downlink assignment on PCH (IMSI=%s)\n",
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100244 ms_imsi_is_valid(ms) ? ms_imsi(ms) : "");
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200245 tbf_fsm_state_chg(fi, TBF_ST_ASSIGN);
246 /* send immediate assignment */
Pau Espin Pedrol5deac142021-11-12 18:01:50 +0100247 bts_snd_dl_ass(ms->bts, ctx->tbf);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200248 }
249 break;
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200250 case TBF_EV_LAST_DL_DATA_SENT:
251 case TBF_EV_LAST_UL_DATA_RECVD:
252 /* All data has been sent or received, change state to FINISHED */
253 tbf_fsm_state_chg(fi, TBF_ST_FINISHED);
254 break;
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200255 case TBF_EV_FINAL_ACK_RECVD:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200256 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200257 /* We received Final Ack (DL ACK/NACK) from MS. move to
258 WAIT_RELEASE, we wait there for release or re-use the TBF in
259 case we receive more DL data to tx */
260 tbf_fsm_state_chg(fi, TBF_ST_WAIT_RELEASE);
261 break;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200262 case TBF_EV_MAX_N3101:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200263 ctx->T_release = 3169;
264 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
265 break;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200266 case TBF_EV_MAX_N3105:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200267 ctx->T_release = 3195;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200268 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
269 break;
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200270 default:
271 OSMO_ASSERT(0);
272 }
273}
274
275static void st_finished(struct osmo_fsm_inst *fi, uint32_t event, void *data)
276{
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200277 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +0200278 struct GprsMs *ms;
279 bool new_ul_tbf_requested;
280
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200281 switch (event) {
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200282 case TBF_EV_DL_ACKNACK_MISS:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200283 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200284 break;
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200285 case TBF_EV_FINAL_ACK_RECVD:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200286 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200287 /* We received Final Ack (DL ACK/NACK) from MS. move to
288 WAIT_RELEASE, we wait there for release or re-use the TBF in
289 case we receive more DL data to tx */
290 tbf_fsm_state_chg(fi, TBF_ST_WAIT_RELEASE);
291 break;
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +0200292 case TBF_EV_FINAL_UL_ACK_CONFIRMED:
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +0200293 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_UL_TBF);
294 new_ul_tbf_requested = (bool)data;
295 /* Ref the MS, otherwise it may be freed after ul_tbf is
296 * detached when sending event below. */
297 ms = tbf_ms(ctx->tbf);
298 ms_ref(ms);
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +0200299 /* UL TBF ACKed our transmitted UL ACK/NACK with final Ack
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +0200300 * Indicator set to '1'. We can free the TBF right away, the MS
301 * also just released its TBF on its side. */
302 LOGPTBFUL(tbf_as_ul_tbf(ctx->tbf), LOGL_DEBUG, "[UPLINK] END\n");
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +0200303 tbf_free(ctx->tbf);
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +0200304 /* Here fi, ctx and ctx->tbf are already freed! */
305 /* TS 44.060 9.3.3.3.2: There might be LLC packets waiting in
306 * the queue but the DL TBF assignment might have been delayed
307 * because there was no way to reach the MS (because ul_tbf was
308 * in packet-active mode with FINISHED state). If MS is going
309 * back to packet-idle mode then we can assign the DL TBF on PCH
310 * now. */
311 if (!new_ul_tbf_requested && ms_need_dl_tbf(ms))
Pau Espin Pedrol091642a2022-10-28 18:01:31 +0200312 ms_new_dl_tbf_assigned_on_pch(ms);
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +0200313 ms_unref(ms);
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +0200314 break;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200315 case TBF_EV_MAX_N3103:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200316 ctx->T_release = 3169;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200317 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
318 break;
319 case TBF_EV_MAX_N3105:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200320 ctx->T_release = 3195;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200321 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
322 break;
323 default:
324 OSMO_ASSERT(0);
325 }
326}
327
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200328static void st_wait_release_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
329{
330 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
331 unsigned long val_s, val_ms, val_us;
332 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
333
334 fi->T = 3193;
335 val_ms = osmo_tdef_get(tbf_ms(ctx->tbf)->bts->T_defs_bts, fi->T, OSMO_TDEF_MS, -1);
336 val_s = val_ms / 1000;
337 val_us = (val_ms % 1000) * 1000;
338 LOGPTBF(ctx->tbf, LOGL_DEBUG, "starting timer T%u with %lu sec. %lu microsec\n",
339 fi->T, val_s, val_us);
340 osmo_timer_schedule(&fi->timer, val_s, val_us);
341
342 mod_ass_type(ctx, GPRS_RLCMAC_FLAG_CCCH, false);
343}
344
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200345static void st_wait_release(struct osmo_fsm_inst *fi, uint32_t event, void *data)
346{
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200347 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200348 switch (event) {
349 case TBF_EV_FINAL_ACK_RECVD:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200350 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200351 /* ignore, duplicate ACK, we already know about since we are in WAIT_RELEASE */
352 break;
353 case TBF_EV_MAX_N3101:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200354 ctx->T_release = 3169;
355 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
356 break;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200357 case TBF_EV_MAX_N3105:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200358 ctx->T_release = 3195;
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200359 tbf_fsm_state_chg(fi, TBF_ST_RELEASING);
360 break;
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200361 default:
362 OSMO_ASSERT(0);
363 }
364}
365
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200366static void st_releasing_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
367{
368 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
369 unsigned long val;
370
371 if (!ctx->T_release)
372 return;
373
374 /* In general we should end up here with an assigned timer in ctx->T_release. Possible values are:
375 * T3195: Wait for reuse of TFI(s) when there is no response from the MS
376 * (radio failure or cell change) for this TBF/MBMS radio bearer.
377 * T3169: Wait for reuse of USF and TFI(s) after the MS uplink assignment for this TBF is invalid.
378 */
379 val = osmo_tdef_get(tbf_ms(ctx->tbf)->bts->T_defs_bts, ctx->T_release, OSMO_TDEF_S, -1);
380 fi->T = ctx->T_release;
381 LOGPTBF(ctx->tbf, LOGL_DEBUG, "starting timer T%u with %lu sec. %u microsec\n",
382 ctx->T_release, val, 0);
383 osmo_timer_schedule(&fi->timer, val, 0);
384}
385
Pau Espin Pedrolcee6b122021-09-28 16:49:33 +0200386static void st_releasing(struct osmo_fsm_inst *fi, uint32_t event, void *data)
387{
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200388 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedrolcee6b122021-09-28 16:49:33 +0200389 switch (event) {
390 case TBF_EV_DL_ACKNACK_MISS:
Pau Espin Pedrol3f339292022-10-28 18:29:18 +0200391 OSMO_ASSERT(tbf_direction(ctx->tbf) == GPRS_RLCMAC_DL_TBF);
Pau Espin Pedrolcee6b122021-09-28 16:49:33 +0200392 /* Ignore, we don't care about missed DL ACK/NACK poll timeouts
393 * anymore, we are already releasing the TBF */
394 break;
395 default:
396 OSMO_ASSERT(0);
397 }
398}
399
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200400static void handle_timeout_X2002(struct tbf_fsm_ctx *ctx)
401{
Pau Espin Pedrolcc30b052022-10-27 15:25:55 +0200402 struct gprs_rlcmac_dl_tbf *dl_tbf = tbf_as_dl_tbf(ctx->tbf);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200403
Pau Espin Pedrol89a995a2021-10-18 14:25:17 +0200404 /* X2002 is used only for DL TBF */
405 OSMO_ASSERT(dl_tbf);
406
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200407 if (ctx->fi->state == TBF_ST_ASSIGN) {
408 tbf_assign_control_ts(ctx->tbf);
409
410 if (!tbf_can_upgrade_to_multislot(ctx->tbf)) {
411 /* change state to FLOW, so scheduler
412 * will start transmission */
413 osmo_fsm_inst_dispatch(ctx->fi, TBF_EV_ASSIGN_READY_CCCH, NULL);
414 return;
415 }
416
417 /* This tbf can be upgraded to use multiple DL
418 * timeslots and now that there is already one
419 * slot assigned send another DL assignment via
420 * PDCH. */
421
422 /* keep to flags */
423 ctx->state_flags &= GPRS_RLCMAC_FLAG_TO_MASK;
424
425 tbf_update(ctx->tbf);
Pau Espin Pedrolee350082022-10-28 17:35:03 +0200426 dl_tbf_trigger_ass_on_pacch(dl_tbf, ctx->tbf);
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200427 } else
428 LOGPTBF(ctx->tbf, LOGL_NOTICE, "Continue flow after IMM.ASS confirm\n");
429}
430
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200431static int tbf_fsm_timer_cb(struct osmo_fsm_inst *fi)
432{
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200433 struct tbf_fsm_ctx *ctx = (struct tbf_fsm_ctx *)fi->priv;
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200434 switch (fi->T) {
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200435 case -2002:
436 handle_timeout_X2002(ctx);
437 break;
Pau Espin Pedrol9d67e722021-07-28 19:25:38 +0200438 case -2001:
439 LOGPTBF(ctx->tbf, LOGL_NOTICE, "releasing due to PACCH assignment timeout.\n");
440 /* fall-through */
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200441 case 3169:
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200442 case 3193:
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200443 case 3195:
444 tbf_free(ctx->tbf);
445 break;
446 default:
447 OSMO_ASSERT(0);
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200448 }
449 return 0;
450}
451
452static struct osmo_fsm_state tbf_fsm_states[] = {
Pau Espin Pedrol00430052021-10-12 12:04:03 +0200453 [TBF_ST_NEW] = {
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200454 .in_event_mask =
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200455 X(TBF_EV_ASSIGN_ADD_CCCH) |
456 X(TBF_EV_ASSIGN_ADD_PACCH),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200457 .out_state_mask =
458 X(TBF_ST_ASSIGN) |
459 X(TBF_ST_FLOW) |
460 X(TBF_ST_RELEASING),
Pau Espin Pedrol00430052021-10-12 12:04:03 +0200461 .name = "NEW",
462 .action = st_new,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200463 },
464 [TBF_ST_ASSIGN] = {
465 .in_event_mask =
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200466 X(TBF_EV_ASSIGN_ADD_CCCH) |
Pau Espin Pedrol720e19e2021-07-22 19:56:37 +0200467 X(TBF_EV_ASSIGN_ADD_PACCH) |
468 X(TBF_EV_ASSIGN_ACK_PACCH) |
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200469 X(TBF_EV_ASSIGN_PCUIF_CNF) |
Pau Espin Pedrol85aa87b2021-10-12 14:02:52 +0200470 X(TBF_EV_ASSIGN_READY_CCCH) |
471 X(TBF_EV_MAX_N3105),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200472 .out_state_mask =
473 X(TBF_ST_FLOW) |
474 X(TBF_ST_FINISHED) |
475 X(TBF_ST_RELEASING),
476 .name = "ASSIGN",
Pau Espin Pedrol33e80072021-07-22 19:20:50 +0200477 .action = st_assign,
Pau Espin Pedrol9d67e722021-07-28 19:25:38 +0200478 .onenter = st_assign_on_enter,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200479 },
480 [TBF_ST_FLOW] = {
481 .in_event_mask =
Pau Espin Pedrol338a5ae2022-10-28 18:47:44 +0200482 X(TBF_EV_FIRST_UL_DATA_RECVD) |
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200483 X(TBF_EV_DL_ACKNACK_MISS) |
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200484 X(TBF_EV_LAST_DL_DATA_SENT) |
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200485 X(TBF_EV_LAST_UL_DATA_RECVD) |
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200486 X(TBF_EV_FINAL_ACK_RECVD) |
487 X(TBF_EV_MAX_N3101) |
488 X(TBF_EV_MAX_N3105),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200489 .out_state_mask =
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200490 X(TBF_ST_ASSIGN) |
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200491 X(TBF_ST_FINISHED) |
492 X(TBF_ST_WAIT_RELEASE) |
493 X(TBF_ST_RELEASING),
494 .name = "FLOW",
Pau Espin Pedrolc32c4a32021-07-23 18:27:57 +0200495 .action = st_flow,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200496 },
497 [TBF_ST_FINISHED] = {
498 .in_event_mask =
Pau Espin Pedrol32252902021-07-29 16:44:11 +0200499 X(TBF_EV_DL_ACKNACK_MISS) |
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200500 X(TBF_EV_FINAL_ACK_RECVD) |
Pau Espin Pedrol7a2b65e2021-10-11 19:18:13 +0200501 X(TBF_EV_FINAL_UL_ACK_CONFIRMED) |
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200502 X(TBF_EV_MAX_N3103) |
503 X(TBF_EV_MAX_N3105),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200504 .out_state_mask =
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200505 X(TBF_ST_WAIT_RELEASE) |
506 X(TBF_ST_RELEASING),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200507 .name = "FINISHED",
Pau Espin Pedrolefcb0462021-07-26 12:33:39 +0200508 .action = st_finished,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200509 },
510 [TBF_ST_WAIT_RELEASE] = {
511 .in_event_mask =
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200512 X(TBF_EV_FINAL_ACK_RECVD) |
513 X(TBF_EV_MAX_N3101) |
514 X(TBF_EV_MAX_N3105),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200515 .out_state_mask =
516 X(TBF_ST_RELEASING),
517 .name = "WAIT_RELEASE",
Pau Espin Pedrol55f600b2021-07-26 15:54:39 +0200518 .action = st_wait_release,
Pau Espin Pedrolf48de622021-07-30 14:48:06 +0200519 .onenter = st_wait_release_on_enter,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200520 },
521 [TBF_ST_RELEASING] = {
522 .in_event_mask =
Pau Espin Pedrolcee6b122021-09-28 16:49:33 +0200523 X(TBF_EV_DL_ACKNACK_MISS),
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200524 .out_state_mask =
525 0,
526 .name = "RELEASING",
Pau Espin Pedrolcee6b122021-09-28 16:49:33 +0200527 .action = st_releasing,
Pau Espin Pedrolcfb61d92021-07-26 17:17:02 +0200528 .onenter = st_releasing_on_enter,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200529 },
530};
531
532struct osmo_fsm tbf_fsm = {
533 .name = "TBF",
534 .states = tbf_fsm_states,
535 .num_states = ARRAY_SIZE(tbf_fsm_states),
536 .timer_cb = tbf_fsm_timer_cb,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200537 .log_subsys = DTBF,
538 .event_names = tbf_fsm_event_names,
Pau Espin Pedroldc2aaac2021-05-14 12:50:46 +0200539};
540
541static __attribute__((constructor)) void tbf_fsm_init(void)
542{
543 OSMO_ASSERT(osmo_fsm_register(&tbf_fsm) == 0);
544}