blob: 6c9946e5d62e47844201caa2a7866887f2e52158 [file] [log] [blame]
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +02001/*
2 * Copyright (C) 2013 by Holger Hans Peter Freyther
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18
19#pragma once
20
Daniel Willmannafa72f52014-01-15 17:06:19 +010021#ifdef __cplusplus
22
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +020023#include "gprs_rlcmac.h"
Holger Hans Peter Freytherbe570812013-11-07 08:01:49 +010024#include "llc.h"
Holger Hans Peter Freyther6b5660c2013-11-23 16:10:48 +010025#include "rlc.h"
Jacob Erlbeck6835cea2015-08-21 15:24:02 +020026#include "cxx_linuxlist.h"
Daniel Willmanneb100242014-08-08 11:43:53 +020027#include <gprs_debug.h>
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +020028
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +020029#include <stdint.h>
Maxe66de5b2017-01-05 18:26:58 +010030extern "C" {
31#include <osmocom/core/utils.h>
32}
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +020033
Holger Hans Peter Freyther1702f102013-10-20 08:44:02 +020034struct bssgp_bvc_ctx;
Jacob Erlbeck20f6fd12015-06-08 11:05:45 +020035struct pcu_l1_meas;
Jacob Erlbeckfecece02015-05-08 12:13:08 +020036class GprsMs;
Holger Hans Peter Freyther1702f102013-10-20 08:44:02 +020037
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020038/*
39 * TBF instance
40 */
41
Maxb2de1f72017-12-20 18:05:29 +010042#define T_ASS_AGCH_USEC 200000 /* waiting after IMM.ASS confirm */
43#define T_ASS_PACCH_SEC 2 /* timeout for pacch assigment */
44#define T_REJ_PACCH_USEC 2000 /* timeout for tbf reject for PRR*/
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020045
46enum gprs_rlcmac_tbf_state {
47 GPRS_RLCMAC_NULL = 0, /* new created TBF */
Neels Hofmeyr4ea45262016-06-08 15:27:40 +020048 GPRS_RLCMAC_ASSIGN, /* wait for downlink assignment */
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020049 GPRS_RLCMAC_FLOW, /* RLC/MAC flow, resource needed */
50 GPRS_RLCMAC_FINISHED, /* flow finished, wait for release */
51 GPRS_RLCMAC_WAIT_RELEASE,/* wait for release or restart of DL TBF */
52 GPRS_RLCMAC_RELEASING, /* releasing, wait to free TBI/USF */
53};
54
Maxf60cf622017-07-10 14:40:09 +020055enum gprs_rlcmac_tbf_poll_type {
56 GPRS_RLCMAC_POLL_UL_ASS,
57 GPRS_RLCMAC_POLL_DL_ASS,
58 GPRS_RLCMAC_POLL_UL_ACK,
59 GPRS_RLCMAC_POLL_DL_ACK,
60};
61
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020062enum gprs_rlcmac_tbf_poll_state {
63 GPRS_RLCMAC_POLL_NONE = 0,
64 GPRS_RLCMAC_POLL_SCHED, /* a polling was scheduled */
65};
66
67enum gprs_rlcmac_tbf_dl_ass_state {
68 GPRS_RLCMAC_DL_ASS_NONE = 0,
69 GPRS_RLCMAC_DL_ASS_SEND_ASS, /* send downlink assignment on next RTS */
70 GPRS_RLCMAC_DL_ASS_WAIT_ACK, /* wait for PACKET CONTROL ACK */
71};
72
Maxe66de5b2017-01-05 18:26:58 +010073extern const struct value_string gprs_rlcmac_tbf_dl_ass_state_names[];
74
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020075enum gprs_rlcmac_tbf_ul_ass_state {
76 GPRS_RLCMAC_UL_ASS_NONE = 0,
77 GPRS_RLCMAC_UL_ASS_SEND_ASS, /* send uplink assignment on next RTS */
aravind sirsikared3413e2016-11-11 17:15:10 +053078 GPRS_RLCMAC_UL_ASS_SEND_ASS_REJ, /* send assignment reject next RTS */
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020079 GPRS_RLCMAC_UL_ASS_WAIT_ACK, /* wait for PACKET CONTROL ACK */
80};
81
Maxe66de5b2017-01-05 18:26:58 +010082extern const struct value_string gprs_rlcmac_tbf_ul_ass_state_names[];
83
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +020084enum gprs_rlcmac_tbf_ul_ack_state {
85 GPRS_RLCMAC_UL_ACK_NONE = 0,
86 GPRS_RLCMAC_UL_ACK_SEND_ACK, /* send acknowledge on next RTS */
87 GPRS_RLCMAC_UL_ACK_WAIT_ACK, /* wait for PACKET CONTROL ACK */
88};
89
90enum gprs_rlcmac_tbf_direction {
91 GPRS_RLCMAC_DL_TBF,
92 GPRS_RLCMAC_UL_TBF
93};
94
Maxd0532b52017-12-13 18:27:32 +010095enum tbf_dl_prio {
96 DL_PRIO_NONE,
97 DL_PRIO_SENT_DATA, /* the data has been sent and not (yet) nacked */
98 DL_PRIO_LOW_AGE, /* the age has reached the first threshold */
99 DL_PRIO_NEW_DATA, /* the data has not been sent yet or nacked */
100 DL_PRIO_HIGH_AGE, /* the age has reached the second threshold */
101 DL_PRIO_CONTROL, /* a control block needs to be sent */
102};
103
sivasankari53950732016-12-08 17:15:17 +0530104enum tbf_counters {
105 TBF_CTR_RLC_NACKED,
106};
107
108enum tbf_gprs_counters {
109 TBF_CTR_GPRS_DL_CS1,
110 TBF_CTR_GPRS_DL_CS2,
111 TBF_CTR_GPRS_DL_CS3,
112 TBF_CTR_GPRS_DL_CS4,
113};
114
115enum tbf_egprs_counters {
116 TBF_CTR_EGPRS_DL_MCS1,
117 TBF_CTR_EGPRS_DL_MCS2,
118 TBF_CTR_EGPRS_DL_MCS3,
119 TBF_CTR_EGPRS_DL_MCS4,
120 TBF_CTR_EGPRS_DL_MCS5,
121 TBF_CTR_EGPRS_DL_MCS6,
122 TBF_CTR_EGPRS_DL_MCS7,
123 TBF_CTR_EGPRS_DL_MCS8,
124 TBF_CTR_EGPRS_DL_MCS9,
125};
126
sivasankarida7250a2016-12-16 12:57:18 +0530127enum tbf_gprs_ul_counters {
128 TBF_CTR_GPRS_UL_CS1,
129 TBF_CTR_GPRS_UL_CS2,
130 TBF_CTR_GPRS_UL_CS3,
131 TBF_CTR_GPRS_UL_CS4,
132};
133
134enum tbf_egprs_ul_counters {
135 TBF_CTR_EGPRS_UL_MCS1,
136 TBF_CTR_EGPRS_UL_MCS2,
137 TBF_CTR_EGPRS_UL_MCS3,
138 TBF_CTR_EGPRS_UL_MCS4,
139 TBF_CTR_EGPRS_UL_MCS5,
140 TBF_CTR_EGPRS_UL_MCS6,
141 TBF_CTR_EGPRS_UL_MCS7,
142 TBF_CTR_EGPRS_UL_MCS8,
143 TBF_CTR_EGPRS_UL_MCS9,
144};
145
Maxc21f0072017-12-15 17:36:45 +0100146#define LOGPTBF(tbf, level, fmt, args...) LOGP(DRLCMAC, level, "%s " fmt, tbf_name(tbf), ## args)
147#define LOGPTBFUL(tbf, level, fmt, args...) LOGP(DRLCMACUL, level, "%s " fmt, tbf_name(tbf), ## args)
148#define LOGPTBFDL(tbf, level, fmt, args...) LOGP(DRLCMACDL, level, "%s " fmt, tbf_name(tbf), ## args)
149
Maxee5be3a2017-12-20 17:31:13 +0100150enum tbf_timers {
Maxb2de1f72017-12-20 18:05:29 +0100151 /* internal assign/reject timer */
152 T0,
153
Maxee5be3a2017-12-20 17:31:13 +0100154 /* Wait for reuse of USF and TFI(s) after the MS uplink assignment for this TBF is invalid. */
155 T3169,
156
157 /* Wait for reuse of TFI(s) after sending of the last RLC Data Block on this TBF.
158 Wait for reuse of TFI(s) after sending the PACKET TBF RELEASE for an MBMS radio bearer. */
159 T3191,
160
161 /* Wait for reuse of TFI(s) after reception of the final PACKET DOWNLINK ACK/NACK from the
162 MS for this TBF. */
163 T3193,
164
165 /* Wait for reuse of TFI(s) when there is no response from the MS
166 (radio failure or cell change) for this TBF/MBMS radio bearer. */
167 T3195,
168 T_MAX
169};
170
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200171#define GPRS_RLCMAC_FLAG_CCCH 0 /* assignment on CCCH */
172#define GPRS_RLCMAC_FLAG_PACCH 1 /* assignment on PACCH */
173#define GPRS_RLCMAC_FLAG_UL_DATA 2 /* uplink data received */
174#define GPRS_RLCMAC_FLAG_DL_ACK 3 /* downlink acknowledge received */
175#define GPRS_RLCMAC_FLAG_TO_UL_ACK 4
176#define GPRS_RLCMAC_FLAG_TO_DL_ACK 5
177#define GPRS_RLCMAC_FLAG_TO_UL_ASS 6
178#define GPRS_RLCMAC_FLAG_TO_DL_ASS 7
179#define GPRS_RLCMAC_FLAG_TO_MASK 0xf0 /* timeout bits */
180
Max467f6332017-12-20 18:13:29 +0100181#define T_START(tbf, t, sec, usec, r, f) tbf->t_start(t, sec, usec, r, f, __FILE__, __LINE__)
182
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200183struct gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200184 gprs_rlcmac_tbf(BTS *bts_, gprs_rlcmac_tbf_direction dir);
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200185
186 static void free_all(struct gprs_rlcmac_trx *trx);
Holger Hans Peter Freyther4f6a4e5d2013-10-16 17:58:46 +0200187 static void free_all(struct gprs_rlcmac_pdch *pdch);
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200188
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200189 bool state_is(enum gprs_rlcmac_tbf_state rhs) const;
190 bool state_is_not(enum gprs_rlcmac_tbf_state rhs) const;
191 void set_state(enum gprs_rlcmac_tbf_state new_state);
Max8dce1de2018-01-02 14:17:04 +0100192 bool check_n_clear(uint8_t state_flag);
193 void set_assigned_on(uint8_t state_flag, bool check_ccch);
Daniel Willmann08e57c82014-08-15 18:11:57 +0200194 const char *state_name() const;
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200195
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100196 const char *name() const;
197
Jacob Erlbeck5a3c84d2016-01-22 17:25:38 +0100198 struct msgb *create_dl_ass(uint32_t fn, uint8_t ts);
199 struct msgb *create_ul_ass(uint32_t fn, uint8_t ts);
aravind sirsikared3413e2016-11-11 17:15:10 +0530200 struct msgb *create_packet_access_reject();
Holger Hans Peter Freyther2db7e7e2013-10-26 20:45:35 +0200201
Jacob Erlbeck10ed7952015-06-02 11:37:22 +0200202 GprsMs *ms() const;
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200203 void set_ms(GprsMs *ms);
204
Holger Hans Peter Freyther8f399de2013-12-25 20:22:35 +0100205 uint8_t tsc() const;
Holger Hans Peter Freythera1da2512013-11-07 07:32:51 +0100206
Holger Hans Peter Freyther7380bab2013-10-16 18:09:19 +0200207 int rlcmac_diag();
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200208
Jacob Erlbecke0c734d2015-07-03 14:03:33 +0200209 int update();
Holger Hans Peter Freytheraf8094d2013-10-26 17:56:15 +0200210 void handle_timeout();
Maxee5be3a2017-12-20 17:31:13 +0100211 void stop_timers(const char *reason);
212 bool timers_pending(enum tbf_timers t);
213 void t_stop(enum tbf_timers t, const char *reason);
Max467f6332017-12-20 18:13:29 +0100214 void t_start(enum tbf_timers t, uint32_t sec, uint32_t microsec, const char *reason, bool force,
215 const char *file, unsigned line);
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200216 int establish_dl_tbf_on_pacch();
Holger Hans Peter Freytheraa9c3262013-10-26 17:49:36 +0200217
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100218 int check_polling(uint32_t fn, uint8_t ts,
219 uint32_t *poll_fn, unsigned int *rrbp);
Maxf60cf622017-07-10 14:40:09 +0200220 void set_polling(uint32_t poll_fn, uint8_t ts, enum gprs_rlcmac_tbf_poll_type t);
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200221 void poll_timeout();
222
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100223 /** tlli handling */
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100224 uint32_t tlli() const;
225 bool is_tlli_valid() const;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100226
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200227 /** MS updating */
Jacob Erlbeckbe0cbc12015-05-18 14:35:11 +0200228 void update_ms(uint32_t tlli, enum gprs_rlcmac_tbf_direction);
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200229
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100230 uint8_t tfi() const;
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100231 bool is_tfi_assigned() const;
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100232
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100233 const char *imsi() const;
234 void assign_imsi(const char *imsi);
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200235 uint8_t ta() const;
236 void set_ta(uint8_t);
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200237 uint8_t ms_class() const;
238 void set_ms_class(uint8_t);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100239 GprsCodingScheme current_cs() const;
Max869c0c22018-01-03 12:00:36 +0100240 size_t llc_queue_size() const;
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100241
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100242 time_t created_ts() const;
Jacob Erlbeck617c7122015-06-30 09:18:30 +0200243 uint8_t dl_slots() const;
244 uint8_t ul_slots() const;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100245
Jacob Erlbeck646da1b2016-01-22 17:41:33 +0100246 bool is_control_ts(uint8_t ts) const;
247
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100248 /* EGPRS */
249 bool is_egprs_enabled() const;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100250 void disable_egprs();
251
Holger Hans Peter Freyther7a5f3c22013-11-26 13:08:12 +0100252 /* attempt to make things a bit more fair */
253 void rotate_in_list();
254
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200255 LListHead<gprs_rlcmac_tbf>& ms_list() {return this->m_ms_list;}
256 const LListHead<gprs_rlcmac_tbf>& ms_list() const {return this->m_ms_list;}
257
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100258 LListHead<gprs_rlcmac_tbf>& list();
259 const LListHead<gprs_rlcmac_tbf>& list() const;
260
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200261 uint32_t state_flags;
262 enum gprs_rlcmac_tbf_direction direction;
Holger Hans Peter Freyther743bafa2013-09-29 07:50:50 +0200263 struct gprs_rlcmac_trx *trx;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200264 uint8_t first_ts; /* first TS used by TBF */
265 uint8_t first_common_ts; /* first TS that the phone can send and
266 reveive simultaniously */
267 uint8_t control_ts; /* timeslot control messages and polling */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200268 struct gprs_rlcmac_pdch *pdch[8]; /* list of PDCHs allocated to TBF */
Holger Hans Peter Freyther28e53782013-11-06 20:23:56 +0100269
270 gprs_llc m_llc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200271
272 enum gprs_rlcmac_tbf_dl_ass_state dl_ass_state;
273 enum gprs_rlcmac_tbf_ul_ass_state ul_ass_state;
274 enum gprs_rlcmac_tbf_ul_ack_state ul_ack_state;
275
276 enum gprs_rlcmac_tbf_poll_state poll_state;
277 uint32_t poll_fn; /* frame number to poll */
Jacob Erlbeck8eb17142016-01-22 17:58:17 +0100278 uint8_t poll_ts; /* TS to poll */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200279
Holger Hans Peter Freyther9241fd02013-11-13 19:51:55 +0100280 gprs_rlc m_rlc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200281
282 uint8_t n3105; /* N3105 counter */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200283
284 struct osmo_gsm_timer_list gsm_timer;
285 unsigned int fT; /* fTxxxx number */
286 unsigned int num_fT_exp; /* number of consecutive fT expirations */
287
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200288 struct Meas {
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200289 struct timeval rssi_tv; /* timestamp for rssi calculation */
290 int32_t rssi_sum; /* sum of rssi values */
291 int rssi_num; /* number of rssi values added since rssi_tv */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200292
293 Meas();
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200294 } meas;
295
Daniel Willmann73191a42014-05-30 17:58:00 +0200296 /* Remember if the tbf was in wait_release state when we want to
297 * schedule a new dl assignment */
298 uint8_t was_releasing;
299
Daniel Willmanncf1fae72014-05-30 17:58:01 +0200300 /* Can/should we upgrade this tbf to use multiple slots? */
301 uint8_t upgrade_to_multislot;
302
Holger Hans Peter Freyther9f0c1d22013-10-19 21:24:34 +0200303 /* store the BTS this TBF belongs to */
304 BTS *bts;
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200305
Max59e4a4f2017-12-20 18:01:55 +0100306 uint8_t m_n3101; /* N3101 counter */
307
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100308 /*
309 * private fields. We can't make it private as it is breaking the
310 * llist macros.
311 */
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100312 uint8_t m_tfi;
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100313 time_t m_created_ts;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100314
sivasankari53950732016-12-08 17:15:17 +0530315 struct rate_ctr_group *m_ctrs;
316
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200317protected:
318 gprs_rlcmac_bts *bts_data() const;
Max25a3ca42017-12-13 18:47:52 +0100319 void enable_egprs();
Jacob Erlbecke8f5fe52015-12-14 13:23:15 +0100320 int set_tlli_from_ul(uint32_t new_tlli);
Jacob Erlbeck28c40b12015-08-16 18:19:32 +0200321 void merge_and_clear_ms(GprsMs *old_ms);
Holger Hans Peter Freyther4c06d912013-11-25 23:05:26 +0100322
Alexander Couzensd38b92e2016-08-21 19:38:30 +0200323 gprs_llc_queue *llc_queue();
324 const gprs_llc_queue *llc_queue() const;
325
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200326 static const char *tbf_state_name[6];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100327
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200328 class GprsMs *m_ms;
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200329
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200330 /* Fields to take the TA/MS class values if no MS is associated */
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200331 uint8_t m_ta;
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200332 uint8_t m_ms_class;
Jacob Erlbeck6dbe8222015-05-29 10:37:09 +0200333
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100334private:
Max50818062017-12-06 13:35:08 +0100335 enum gprs_rlcmac_tbf_state state;
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100336 LListHead<gprs_rlcmac_tbf> m_list;
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200337 LListHead<gprs_rlcmac_tbf> m_ms_list;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100338 bool m_egprs_enabled;
Maxb2de1f72017-12-20 18:05:29 +0100339 struct osmo_timer_list T[T_MAX];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100340 mutable char m_name_buf[60];
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200341};
342
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +0200343
Daniel Willmann0d12a2f2014-07-10 17:44:07 +0200344struct gprs_rlcmac_ul_tbf *tbf_alloc_ul(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100345 int8_t use_trx, uint8_t ms_class, uint8_t egprs_ms_class,
Jacob Erlbecke2e004e2015-06-18 17:16:26 +0200346 uint32_t tlli, uint8_t ta, GprsMs *ms);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200347
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200348struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200349 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100350 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200351
352struct gprs_rlcmac_dl_tbf *tbf_alloc_dl_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200353 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100354 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200355
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200356void tbf_free(struct gprs_rlcmac_tbf *tbf);
357
aravind sirsikare9a138e2017-01-24 12:36:08 +0530358struct gprs_rlcmac_ul_tbf *handle_tbf_reject(struct gprs_rlcmac_bts *bts,
359 GprsMs *ms, uint32_t tlli, uint8_t trx_no, uint8_t ts_no);
360
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200361int tbf_assign_control_ts(struct gprs_rlcmac_tbf *tbf);
362
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200363inline bool gprs_rlcmac_tbf::state_is(enum gprs_rlcmac_tbf_state rhs) const
364{
365 return state == rhs;
366}
367
368inline bool gprs_rlcmac_tbf::state_is_not(enum gprs_rlcmac_tbf_state rhs) const
369{
370 return state != rhs;
371}
372
Daniel Willmanneb100242014-08-08 11:43:53 +0200373const char *tbf_name(gprs_rlcmac_tbf *tbf);
374
Daniel Willmann08e57c82014-08-15 18:11:57 +0200375inline const char *gprs_rlcmac_tbf::state_name() const
376{
377 return tbf_state_name[state];
378}
379
Max8dce1de2018-01-02 14:17:04 +0100380/* Set assignment state and corrsponding flags */
381inline void gprs_rlcmac_tbf::set_assigned_on(uint8_t state_flag, bool check_ccch)
382{
383 set_state(GPRS_RLCMAC_ASSIGN);
384 if (check_ccch) {
385 if (!(state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)))
386 state_flags |= (1 << state_flag);
387 } else
388 state_flags |= (1 << state_flag);
389}
390
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200391inline void gprs_rlcmac_tbf::set_state(enum gprs_rlcmac_tbf_state new_state)
392{
Daniel Willmanneb100242014-08-08 11:43:53 +0200393 LOGP(DRLCMAC, LOGL_DEBUG, "%s changes state from %s to %s\n",
394 tbf_name(this),
395 tbf_state_name[state], tbf_state_name[new_state]);
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200396 state = new_state;
397}
Holger Hans Peter Freytherbd449f52013-10-27 16:39:36 +0100398
Max8dce1de2018-01-02 14:17:04 +0100399inline bool gprs_rlcmac_tbf::check_n_clear(uint8_t state_flag)
400{
401 if ((state_flags & (1 << state_flag))) {
402 state_flags &= ~(1 << state_flag);
403 return true;
404 }
405
406 return false;
407}
408
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100409inline LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list()
410{
411 return this->m_list;
412}
413
414inline const LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list() const
415{
416 return this->m_list;
417}
418
Jacob Erlbeck10ed7952015-06-02 11:37:22 +0200419inline GprsMs *gprs_rlcmac_tbf::ms() const
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200420{
421 return m_ms;
422}
423
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100424inline bool gprs_rlcmac_tbf::is_tlli_valid() const
425{
Jacob Erlbeck767193e2015-05-20 12:06:46 +0200426 return tlli() != 0;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100427}
428
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100429inline bool gprs_rlcmac_tbf::is_tfi_assigned() const
430{
431 /* The TBF is established or has been assigned by a IMM.ASS for
432 * download */
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200433 return state > GPRS_RLCMAC_ASSIGN ||
434 (direction == GPRS_RLCMAC_DL_TBF &&
435 state == GPRS_RLCMAC_ASSIGN &&
436 (state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)));
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100437}
438
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100439inline uint8_t gprs_rlcmac_tbf::tfi() const
440{
441 return m_tfi;
442}
443
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100444inline time_t gprs_rlcmac_tbf::created_ts() const
Daniel Willmann80367aa2014-01-15 17:40:28 +0100445{
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100446 return m_created_ts;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100447}
448
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100449inline bool gprs_rlcmac_tbf::is_egprs_enabled() const
450{
451 return m_egprs_enabled;
452}
453
454inline void gprs_rlcmac_tbf::enable_egprs()
455{
456 m_egprs_enabled = true;
457}
458
459inline void gprs_rlcmac_tbf::disable_egprs()
460{
461 m_egprs_enabled = false;
462}
463
Daniel Willmann078bb712014-07-10 17:44:06 +0200464struct gprs_rlcmac_dl_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200465 gprs_rlcmac_dl_tbf(BTS *bts);
Maxea98b7d2018-01-04 15:13:27 +0100466 gprs_rlc_dl_window *window();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200467 void cleanup();
Max25a3ca42017-12-13 18:47:52 +0100468 void enable_egprs();
Daniel Willmann30168882014-08-07 12:48:29 +0200469 /* dispatch Unitdata.DL messages */
470 static int handle(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200471 const uint32_t tlli, const uint32_t old_tlli,
472 const char *imsi, const uint8_t ms_class,
Jacob Erlbeck14e00f82015-11-27 18:10:39 +0100473 const uint8_t egprs_ms_class, const uint16_t delay_csec,
474 const uint8_t *data, const uint16_t len);
Daniel Willmann30168882014-08-07 12:48:29 +0200475
Daniel Willmann538ac5b2014-07-30 19:12:27 +0200476 int append_data(const uint8_t ms_class,
477 const uint16_t pdu_delay_csec,
478 const uint8_t *data, const uint16_t len);
479
Max7df82d42017-12-15 11:14:30 +0100480 int rcvd_dl_ack(bool final, uint8_t ssn, uint8_t *rbb);
481 int rcvd_dl_ack(bool final_ack, unsigned first_bsn, struct bitvec *rbb);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200482 struct msgb *create_dl_acked_block(uint32_t fn, uint8_t ts);
Maxa10c3982017-07-07 18:25:41 +0200483 void trigger_ass(struct gprs_rlcmac_tbf *old_tbf);
Max8dce1de2018-01-02 14:17:04 +0100484
Maxaae1bfb2017-07-07 13:49:29 +0200485 bool handle_ack_nack();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100486 void request_dl_ack();
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100487 bool need_control_ts() const;
488 bool have_data() const;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100489 int frames_since_last_poll(unsigned fn) const;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100490 int frames_since_last_drain(unsigned fn) const;
491 bool keep_open(unsigned fn) const;
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200492 int release();
Jacob Erlbeckf04a5b32016-01-21 20:42:40 +0100493 int abort();
Maxa4f570f2017-12-15 11:21:57 +0100494 uint16_t window_size() const;
Max9d7357e2017-12-14 15:02:33 +0100495 void set_window_size();
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530496 void update_coding_scheme_counter_dl(const GprsCodingScheme cs);
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +0530497
Daniel Willmanncf706b02014-08-07 17:35:22 +0200498 /* TODO: add the gettimeofday as parameter */
499 struct msgb *llc_dequeue(bssgp_bvc_ctx *bctx);
500
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200501 /* Please note that all variables here will be reset when changing
502 * from WAIT RELEASE back to FLOW state (re-use of TBF).
503 * All states that need reset must be in this struct, so this is why
504 * variables are in both (dl and ul) structs and not outside union.
505 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200506 int32_t m_tx_counter; /* count all transmitted blocks */
507 uint8_t m_wait_confirm; /* wait for CCCH IMM.ASS cnf */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100508 bool m_dl_ack_requested;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100509 int32_t m_last_dl_poll_fn;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100510 int32_t m_last_dl_drained_fn;
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200511
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200512 struct BandWidth {
Daniel Willmann418a4232014-08-08 11:21:04 +0200513 struct timeval dl_bw_tv; /* timestamp for dl bw calculation */
514 uint32_t dl_bw_octets; /* number of octets since bw_tv */
sivasankari53950732016-12-08 17:15:17 +0530515 uint32_t dl_throughput; /* throughput to be displayed in stats */
Daniel Willmann418a4232014-08-08 11:21:04 +0200516
517 struct timeval dl_loss_tv; /* timestamp for loss calculation */
518 uint16_t dl_loss_lost; /* sum of lost packets */
519 uint16_t dl_loss_received; /* sum of received packets */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200520
521 BandWidth();
Daniel Willmann418a4232014-08-08 11:21:04 +0200522 } m_bw;
523
sivasankari53950732016-12-08 17:15:17 +0530524 struct rate_ctr_group *m_dl_gprs_ctrs;
525 struct rate_ctr_group *m_dl_egprs_ctrs;
526
Daniel Willmannb8f26012014-07-30 19:12:28 +0200527protected:
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200528 struct ana_result {
529 unsigned received_packets;
530 unsigned lost_packets;
531 unsigned received_bytes;
532 unsigned lost_bytes;
533 };
534
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100535 int take_next_bsn(uint32_t fn, int previous_bsn,
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100536 bool *may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100537 bool restart_bsn_cycle();
538 int create_new_bsn(const uint32_t fn, GprsCodingScheme cs);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200539 struct msgb *create_dl_acked_block(const uint32_t fn, const uint8_t ts,
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100540 int index, int index2 = -1);
Daniel Willmann30168882014-08-07 12:48:29 +0200541 int update_window(const uint8_t ssn, const uint8_t *rbb);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100542 int update_window(unsigned first_bsn, const struct bitvec *rbb);
Daniel Willmann30168882014-08-07 12:48:29 +0200543 int maybe_start_new_window();
544 bool dl_window_stalled() const;
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200545 void reuse_tbf();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200546 void start_llc_timer();
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200547 int analyse_errors(char *show_rbb, uint8_t ssn, ana_result *res);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200548 void schedule_next_frame();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200549
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530550 enum egprs_rlc_dl_reseg_bsn_state egprs_dl_get_data
551 (int bsn, uint8_t **block_data);
552 unsigned int get_egprs_dl_spb_status(int bsn);
553 enum egprs_rlcmac_dl_spb get_egprs_dl_spb(int bsn);
554
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200555 struct osmo_timer_list m_llc_timer;
Maxea98b7d2018-01-04 15:13:27 +0100556
557 /* Please note that all variables below will be reset when changing
558 * from WAIT RELEASE back to FLOW state (re-use of TBF).
559 * All states that need reset must be in this struct, so this is why
560 * variables are in both (dl and ul) structs and not outside union.
561 */
562 gprs_rlc_dl_window m_window;
Daniel Willmann078bb712014-07-10 17:44:06 +0200563};
564
565struct gprs_rlcmac_ul_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200566 gprs_rlcmac_ul_tbf(BTS *bts);
Maxea98b7d2018-01-04 15:13:27 +0100567 gprs_rlc_ul_window *window();
Jacob Erlbeck5a3c84d2016-01-22 17:25:38 +0100568 struct msgb *create_ul_ack(uint32_t fn, uint8_t ts);
Maxfd13f6c2017-07-07 14:29:36 +0200569 bool ctrl_ack_to_toggle();
570 bool handle_ctrl_ack();
Max25a3ca42017-12-13 18:47:52 +0100571 void enable_egprs();
Daniel Willmann350f64d2014-08-07 14:54:11 +0200572 /* blocks were acked */
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100573 int rcv_data_block_acknowledged(
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100574 const struct gprs_rlc_data_info *rlc,
Jacob Erlbeckfc1b3e62016-01-11 09:58:11 +0100575 uint8_t *data, struct pcu_l1_meas *meas);
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100576
Daniel Willmann350f64d2014-08-07 14:54:11 +0200577
Daniel Willmanne2732e22014-08-07 17:32:01 +0200578 /* TODO: extract LLC class? */
579 int assemble_forward_llc(const gprs_rlc_data *data);
580 int snd_ul_ud();
581
Aravind Sirsikar505a86d2016-07-26 18:26:21 +0530582 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_spb(
583 const struct gprs_rlc_data_info *rlc,
584 struct gprs_rlc_data *block,
585 uint8_t *data, const uint8_t block_idx);
586
587 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_first_seg(
588 const struct gprs_rlc_data_info *rlc,
589 struct gprs_rlc_data *block,
590 uint8_t *data, const uint8_t block_idx);
591
592 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_second_seg(
593 const struct gprs_rlc_data_info *rlc,
594 struct gprs_rlc_data *block,
595 uint8_t *data, const uint8_t block_idx);
596
Maxa4f570f2017-12-15 11:21:57 +0100597 uint16_t window_size() const;
Max9d7357e2017-12-14 15:02:33 +0100598 void set_window_size();
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530599 void update_coding_scheme_counter_ul(const GprsCodingScheme cs);
600
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200601 /* Please note that all variables here will be reset when changing
602 * from WAIT RELEASE back to FLOW state (re-use of TBF).
603 * All states that need reset must be in this struct, so this is why
604 * variables are in both (dl and ul) structs and not outside union.
605 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200606 int32_t m_rx_counter; /* count all received blocks */
607 uint8_t m_n3103; /* N3103 counter */
608 uint8_t m_usf[8]; /* list USFs per PDCH (timeslot) */
609 uint8_t m_contention_resolution_done; /* set after done */
610 uint8_t m_final_ack_sent; /* set if we sent final ack */
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200611
sivasankarida7250a2016-12-16 12:57:18 +0530612 struct rate_ctr_group *m_ul_gprs_ctrs;
613 struct rate_ctr_group *m_ul_egprs_ctrs;
614
Daniel Willmann350f64d2014-08-07 14:54:11 +0200615protected:
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100616 void maybe_schedule_uplink_acknack(const gprs_rlc_data_info *rlc);
Maxea98b7d2018-01-04 15:13:27 +0100617
618 /* Please note that all variables below will be reset when changing
619 * from WAIT RELEASE back to FLOW state (re-use of TBF).
620 * All states that need reset must be in this struct, so this is why
621 * variables are in both (dl and ul) structs and not outside union.
622 */
623 gprs_rlc_ul_window m_window;
Daniel Willmann078bb712014-07-10 17:44:06 +0200624};
625
Max701afa42017-12-01 17:13:22 +0100626#ifdef __cplusplus
627extern "C" {
628#endif
629void update_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, int8_t ta_delta);
630void set_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, uint8_t ta);
631#ifdef __cplusplus
632}
633#endif
634
Jacob Erlbeckac89a552015-06-29 14:18:46 +0200635inline enum gprs_rlcmac_tbf_direction reverse(enum gprs_rlcmac_tbf_direction dir)
636{
637 return (enum gprs_rlcmac_tbf_direction)
638 ((int)GPRS_RLCMAC_UL_TBF - (int)dir + (int)GPRS_RLCMAC_DL_TBF);
639}
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100640
Maxa4f570f2017-12-15 11:21:57 +0100641inline uint16_t gprs_rlcmac_ul_tbf::window_size() const
642{
643 return m_window.ws();
644}
645
646inline uint16_t gprs_rlcmac_dl_tbf::window_size() const
647{
648 return m_window.ws();
649}
650
Max25a3ca42017-12-13 18:47:52 +0100651inline void gprs_rlcmac_ul_tbf::enable_egprs()
652{
653 m_window.set_sns(RLC_EGPRS_SNS);
654 gprs_rlcmac_tbf::enable_egprs();
655}
656
657inline void gprs_rlcmac_dl_tbf::enable_egprs()
658{
659 m_window.set_sns(RLC_EGPRS_SNS);
660 gprs_rlcmac_tbf::enable_egprs();
661}
662
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100663inline gprs_rlcmac_ul_tbf *as_ul_tbf(gprs_rlcmac_tbf *tbf)
664{
665 if (tbf && tbf->direction == GPRS_RLCMAC_UL_TBF)
666 return static_cast<gprs_rlcmac_ul_tbf *>(tbf);
667 else
668 return NULL;
669}
670
671inline gprs_rlcmac_dl_tbf *as_dl_tbf(gprs_rlcmac_tbf *tbf)
672{
673 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
674 return static_cast<gprs_rlcmac_dl_tbf *>(tbf);
675 else
676 return NULL;
677}
678
Max9d7357e2017-12-14 15:02:33 +0100679uint16_t egprs_window_size(const struct gprs_rlcmac_bts *bts_data, uint8_t slots);
680
Daniel Willmannafa72f52014-01-15 17:06:19 +0100681#endif