blob: 21762d3be03c415f20ea709499ac0f6d85198179 [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
sivasankari53950732016-12-08 17:15:17 +053095enum tbf_counters {
96 TBF_CTR_RLC_NACKED,
97};
98
99enum tbf_gprs_counters {
100 TBF_CTR_GPRS_DL_CS1,
101 TBF_CTR_GPRS_DL_CS2,
102 TBF_CTR_GPRS_DL_CS3,
103 TBF_CTR_GPRS_DL_CS4,
104};
105
106enum tbf_egprs_counters {
107 TBF_CTR_EGPRS_DL_MCS1,
108 TBF_CTR_EGPRS_DL_MCS2,
109 TBF_CTR_EGPRS_DL_MCS3,
110 TBF_CTR_EGPRS_DL_MCS4,
111 TBF_CTR_EGPRS_DL_MCS5,
112 TBF_CTR_EGPRS_DL_MCS6,
113 TBF_CTR_EGPRS_DL_MCS7,
114 TBF_CTR_EGPRS_DL_MCS8,
115 TBF_CTR_EGPRS_DL_MCS9,
116};
117
sivasankarida7250a2016-12-16 12:57:18 +0530118enum tbf_gprs_ul_counters {
119 TBF_CTR_GPRS_UL_CS1,
120 TBF_CTR_GPRS_UL_CS2,
121 TBF_CTR_GPRS_UL_CS3,
122 TBF_CTR_GPRS_UL_CS4,
123};
124
125enum tbf_egprs_ul_counters {
126 TBF_CTR_EGPRS_UL_MCS1,
127 TBF_CTR_EGPRS_UL_MCS2,
128 TBF_CTR_EGPRS_UL_MCS3,
129 TBF_CTR_EGPRS_UL_MCS4,
130 TBF_CTR_EGPRS_UL_MCS5,
131 TBF_CTR_EGPRS_UL_MCS6,
132 TBF_CTR_EGPRS_UL_MCS7,
133 TBF_CTR_EGPRS_UL_MCS8,
134 TBF_CTR_EGPRS_UL_MCS9,
135};
136
Maxc21f0072017-12-15 17:36:45 +0100137#define LOGPTBF(tbf, level, fmt, args...) LOGP(DRLCMAC, level, "%s " fmt, tbf_name(tbf), ## args)
138#define LOGPTBFUL(tbf, level, fmt, args...) LOGP(DRLCMACUL, level, "%s " fmt, tbf_name(tbf), ## args)
139#define LOGPTBFDL(tbf, level, fmt, args...) LOGP(DRLCMACDL, level, "%s " fmt, tbf_name(tbf), ## args)
140
Maxee5be3a2017-12-20 17:31:13 +0100141enum tbf_timers {
Maxb2de1f72017-12-20 18:05:29 +0100142 /* internal assign/reject timer */
143 T0,
144
Maxee5be3a2017-12-20 17:31:13 +0100145 /* Wait for reuse of USF and TFI(s) after the MS uplink assignment for this TBF is invalid. */
146 T3169,
147
148 /* Wait for reuse of TFI(s) after sending of the last RLC Data Block on this TBF.
149 Wait for reuse of TFI(s) after sending the PACKET TBF RELEASE for an MBMS radio bearer. */
150 T3191,
151
152 /* Wait for reuse of TFI(s) after reception of the final PACKET DOWNLINK ACK/NACK from the
153 MS for this TBF. */
154 T3193,
155
156 /* Wait for reuse of TFI(s) when there is no response from the MS
157 (radio failure or cell change) for this TBF/MBMS radio bearer. */
158 T3195,
159 T_MAX
160};
161
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200162#define GPRS_RLCMAC_FLAG_CCCH 0 /* assignment on CCCH */
163#define GPRS_RLCMAC_FLAG_PACCH 1 /* assignment on PACCH */
164#define GPRS_RLCMAC_FLAG_UL_DATA 2 /* uplink data received */
165#define GPRS_RLCMAC_FLAG_DL_ACK 3 /* downlink acknowledge received */
166#define GPRS_RLCMAC_FLAG_TO_UL_ACK 4
167#define GPRS_RLCMAC_FLAG_TO_DL_ACK 5
168#define GPRS_RLCMAC_FLAG_TO_UL_ASS 6
169#define GPRS_RLCMAC_FLAG_TO_DL_ASS 7
170#define GPRS_RLCMAC_FLAG_TO_MASK 0xf0 /* timeout bits */
171
Max467f6332017-12-20 18:13:29 +0100172#define T_START(tbf, t, sec, usec, r, f) tbf->t_start(t, sec, usec, r, f, __FILE__, __LINE__)
173
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200174struct gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200175 gprs_rlcmac_tbf(BTS *bts_, gprs_rlcmac_tbf_direction dir);
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200176
177 static void free_all(struct gprs_rlcmac_trx *trx);
Holger Hans Peter Freyther4f6a4e5d2013-10-16 17:58:46 +0200178 static void free_all(struct gprs_rlcmac_pdch *pdch);
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200179
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200180 bool state_is(enum gprs_rlcmac_tbf_state rhs) const;
181 bool state_is_not(enum gprs_rlcmac_tbf_state rhs) const;
182 void set_state(enum gprs_rlcmac_tbf_state new_state);
Max8dce1de2018-01-02 14:17:04 +0100183 bool check_n_clear(uint8_t state_flag);
184 void set_assigned_on(uint8_t state_flag, bool check_ccch);
Daniel Willmann08e57c82014-08-15 18:11:57 +0200185 const char *state_name() const;
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200186
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100187 const char *name() const;
188
Jacob Erlbeck5a3c84d2016-01-22 17:25:38 +0100189 struct msgb *create_dl_ass(uint32_t fn, uint8_t ts);
190 struct msgb *create_ul_ass(uint32_t fn, uint8_t ts);
aravind sirsikared3413e2016-11-11 17:15:10 +0530191 struct msgb *create_packet_access_reject();
Holger Hans Peter Freyther2db7e7e2013-10-26 20:45:35 +0200192
Jacob Erlbeck10ed7952015-06-02 11:37:22 +0200193 GprsMs *ms() const;
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200194 void set_ms(GprsMs *ms);
195
Holger Hans Peter Freyther8f399de2013-12-25 20:22:35 +0100196 uint8_t tsc() const;
Holger Hans Peter Freythera1da2512013-11-07 07:32:51 +0100197
Holger Hans Peter Freyther7380bab2013-10-16 18:09:19 +0200198 int rlcmac_diag();
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200199
Jacob Erlbecke0c734d2015-07-03 14:03:33 +0200200 int update();
Holger Hans Peter Freytheraf8094d2013-10-26 17:56:15 +0200201 void handle_timeout();
Maxee5be3a2017-12-20 17:31:13 +0100202 void stop_timers(const char *reason);
203 bool timers_pending(enum tbf_timers t);
204 void t_stop(enum tbf_timers t, const char *reason);
Max467f6332017-12-20 18:13:29 +0100205 void t_start(enum tbf_timers t, uint32_t sec, uint32_t microsec, const char *reason, bool force,
206 const char *file, unsigned line);
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200207 int establish_dl_tbf_on_pacch();
Holger Hans Peter Freytheraa9c3262013-10-26 17:49:36 +0200208
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100209 int check_polling(uint32_t fn, uint8_t ts,
210 uint32_t *poll_fn, unsigned int *rrbp);
Maxf60cf622017-07-10 14:40:09 +0200211 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 +0200212 void poll_timeout();
213
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100214 /** tlli handling */
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100215 uint32_t tlli() const;
216 bool is_tlli_valid() const;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100217
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200218 /** MS updating */
Jacob Erlbeckbe0cbc12015-05-18 14:35:11 +0200219 void update_ms(uint32_t tlli, enum gprs_rlcmac_tbf_direction);
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200220
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100221 uint8_t tfi() const;
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100222 bool is_tfi_assigned() const;
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100223
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100224 const char *imsi() const;
225 void assign_imsi(const char *imsi);
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200226 uint8_t ta() const;
227 void set_ta(uint8_t);
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200228 uint8_t ms_class() const;
229 void set_ms_class(uint8_t);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100230 GprsCodingScheme current_cs() const;
Max869c0c22018-01-03 12:00:36 +0100231 size_t llc_queue_size() const;
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100232
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100233 time_t created_ts() const;
Jacob Erlbeck617c7122015-06-30 09:18:30 +0200234 uint8_t dl_slots() const;
235 uint8_t ul_slots() const;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100236
Jacob Erlbeck646da1b2016-01-22 17:41:33 +0100237 bool is_control_ts(uint8_t ts) const;
238
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100239 /* EGPRS */
240 bool is_egprs_enabled() const;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100241 void disable_egprs();
242
Holger Hans Peter Freyther7a5f3c22013-11-26 13:08:12 +0100243 /* attempt to make things a bit more fair */
244 void rotate_in_list();
245
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200246 LListHead<gprs_rlcmac_tbf>& ms_list() {return this->m_ms_list;}
247 const LListHead<gprs_rlcmac_tbf>& ms_list() const {return this->m_ms_list;}
248
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100249 LListHead<gprs_rlcmac_tbf>& list();
250 const LListHead<gprs_rlcmac_tbf>& list() const;
251
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200252 uint32_t state_flags;
253 enum gprs_rlcmac_tbf_direction direction;
Holger Hans Peter Freyther743bafa2013-09-29 07:50:50 +0200254 struct gprs_rlcmac_trx *trx;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200255 uint8_t first_ts; /* first TS used by TBF */
256 uint8_t first_common_ts; /* first TS that the phone can send and
257 reveive simultaniously */
258 uint8_t control_ts; /* timeslot control messages and polling */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200259 struct gprs_rlcmac_pdch *pdch[8]; /* list of PDCHs allocated to TBF */
Holger Hans Peter Freyther28e53782013-11-06 20:23:56 +0100260
261 gprs_llc m_llc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200262
263 enum gprs_rlcmac_tbf_dl_ass_state dl_ass_state;
264 enum gprs_rlcmac_tbf_ul_ass_state ul_ass_state;
265 enum gprs_rlcmac_tbf_ul_ack_state ul_ack_state;
266
267 enum gprs_rlcmac_tbf_poll_state poll_state;
268 uint32_t poll_fn; /* frame number to poll */
Jacob Erlbeck8eb17142016-01-22 17:58:17 +0100269 uint8_t poll_ts; /* TS to poll */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200270
Holger Hans Peter Freyther9241fd02013-11-13 19:51:55 +0100271 gprs_rlc m_rlc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200272
273 uint8_t n3105; /* N3105 counter */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200274
275 struct osmo_gsm_timer_list gsm_timer;
276 unsigned int fT; /* fTxxxx number */
277 unsigned int num_fT_exp; /* number of consecutive fT expirations */
278
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200279 struct Meas {
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200280 struct timeval rssi_tv; /* timestamp for rssi calculation */
281 int32_t rssi_sum; /* sum of rssi values */
282 int rssi_num; /* number of rssi values added since rssi_tv */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200283
284 Meas();
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200285 } meas;
286
Daniel Willmann73191a42014-05-30 17:58:00 +0200287 /* Remember if the tbf was in wait_release state when we want to
288 * schedule a new dl assignment */
289 uint8_t was_releasing;
290
Daniel Willmanncf1fae72014-05-30 17:58:01 +0200291 /* Can/should we upgrade this tbf to use multiple slots? */
292 uint8_t upgrade_to_multislot;
293
Holger Hans Peter Freyther9f0c1d22013-10-19 21:24:34 +0200294 /* store the BTS this TBF belongs to */
295 BTS *bts;
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200296
Max59e4a4f2017-12-20 18:01:55 +0100297 uint8_t m_n3101; /* N3101 counter */
298
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100299 /*
300 * private fields. We can't make it private as it is breaking the
301 * llist macros.
302 */
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100303 uint8_t m_tfi;
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100304 time_t m_created_ts;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100305
sivasankari53950732016-12-08 17:15:17 +0530306 struct rate_ctr_group *m_ctrs;
307
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200308protected:
309 gprs_rlcmac_bts *bts_data() const;
Max25a3ca42017-12-13 18:47:52 +0100310 void enable_egprs();
Jacob Erlbecke8f5fe52015-12-14 13:23:15 +0100311 int set_tlli_from_ul(uint32_t new_tlli);
Jacob Erlbeck28c40b12015-08-16 18:19:32 +0200312 void merge_and_clear_ms(GprsMs *old_ms);
Holger Hans Peter Freyther4c06d912013-11-25 23:05:26 +0100313
Alexander Couzensd38b92e2016-08-21 19:38:30 +0200314 gprs_llc_queue *llc_queue();
315 const gprs_llc_queue *llc_queue() const;
316
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200317 static const char *tbf_state_name[6];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100318
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200319 class GprsMs *m_ms;
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200320
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200321 /* Fields to take the TA/MS class values if no MS is associated */
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200322 uint8_t m_ta;
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200323 uint8_t m_ms_class;
Jacob Erlbeck6dbe8222015-05-29 10:37:09 +0200324
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100325private:
Max50818062017-12-06 13:35:08 +0100326 enum gprs_rlcmac_tbf_state state;
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100327 LListHead<gprs_rlcmac_tbf> m_list;
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200328 LListHead<gprs_rlcmac_tbf> m_ms_list;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100329 bool m_egprs_enabled;
Maxb2de1f72017-12-20 18:05:29 +0100330 struct osmo_timer_list T[T_MAX];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100331 mutable char m_name_buf[60];
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200332};
333
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +0200334
Daniel Willmann0d12a2f2014-07-10 17:44:07 +0200335struct gprs_rlcmac_ul_tbf *tbf_alloc_ul(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100336 int8_t use_trx, uint8_t ms_class, uint8_t egprs_ms_class,
Jacob Erlbecke2e004e2015-06-18 17:16:26 +0200337 uint32_t tlli, uint8_t ta, GprsMs *ms);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200338
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200339struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200340 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100341 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200342
343struct gprs_rlcmac_dl_tbf *tbf_alloc_dl_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200344 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100345 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200346
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200347void tbf_free(struct gprs_rlcmac_tbf *tbf);
348
aravind sirsikare9a138e2017-01-24 12:36:08 +0530349struct gprs_rlcmac_ul_tbf *handle_tbf_reject(struct gprs_rlcmac_bts *bts,
350 GprsMs *ms, uint32_t tlli, uint8_t trx_no, uint8_t ts_no);
351
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200352int tbf_assign_control_ts(struct gprs_rlcmac_tbf *tbf);
353
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200354inline bool gprs_rlcmac_tbf::state_is(enum gprs_rlcmac_tbf_state rhs) const
355{
356 return state == rhs;
357}
358
359inline bool gprs_rlcmac_tbf::state_is_not(enum gprs_rlcmac_tbf_state rhs) const
360{
361 return state != rhs;
362}
363
Daniel Willmanneb100242014-08-08 11:43:53 +0200364const char *tbf_name(gprs_rlcmac_tbf *tbf);
365
Daniel Willmann08e57c82014-08-15 18:11:57 +0200366inline const char *gprs_rlcmac_tbf::state_name() const
367{
368 return tbf_state_name[state];
369}
370
Max8dce1de2018-01-02 14:17:04 +0100371/* Set assignment state and corrsponding flags */
372inline void gprs_rlcmac_tbf::set_assigned_on(uint8_t state_flag, bool check_ccch)
373{
374 set_state(GPRS_RLCMAC_ASSIGN);
375 if (check_ccch) {
376 if (!(state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)))
377 state_flags |= (1 << state_flag);
378 } else
379 state_flags |= (1 << state_flag);
380}
381
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200382inline void gprs_rlcmac_tbf::set_state(enum gprs_rlcmac_tbf_state new_state)
383{
Daniel Willmanneb100242014-08-08 11:43:53 +0200384 LOGP(DRLCMAC, LOGL_DEBUG, "%s changes state from %s to %s\n",
385 tbf_name(this),
386 tbf_state_name[state], tbf_state_name[new_state]);
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200387 state = new_state;
388}
Holger Hans Peter Freytherbd449f52013-10-27 16:39:36 +0100389
Max8dce1de2018-01-02 14:17:04 +0100390inline bool gprs_rlcmac_tbf::check_n_clear(uint8_t state_flag)
391{
392 if ((state_flags & (1 << state_flag))) {
393 state_flags &= ~(1 << state_flag);
394 return true;
395 }
396
397 return false;
398}
399
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100400inline LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list()
401{
402 return this->m_list;
403}
404
405inline const LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list() const
406{
407 return this->m_list;
408}
409
Jacob Erlbeck10ed7952015-06-02 11:37:22 +0200410inline GprsMs *gprs_rlcmac_tbf::ms() const
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200411{
412 return m_ms;
413}
414
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100415inline bool gprs_rlcmac_tbf::is_tlli_valid() const
416{
Jacob Erlbeck767193e2015-05-20 12:06:46 +0200417 return tlli() != 0;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100418}
419
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100420inline bool gprs_rlcmac_tbf::is_tfi_assigned() const
421{
422 /* The TBF is established or has been assigned by a IMM.ASS for
423 * download */
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200424 return state > GPRS_RLCMAC_ASSIGN ||
425 (direction == GPRS_RLCMAC_DL_TBF &&
426 state == GPRS_RLCMAC_ASSIGN &&
427 (state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)));
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100428}
429
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100430inline uint8_t gprs_rlcmac_tbf::tfi() const
431{
432 return m_tfi;
433}
434
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100435inline time_t gprs_rlcmac_tbf::created_ts() const
Daniel Willmann80367aa2014-01-15 17:40:28 +0100436{
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100437 return m_created_ts;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100438}
439
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100440inline bool gprs_rlcmac_tbf::is_egprs_enabled() const
441{
442 return m_egprs_enabled;
443}
444
445inline void gprs_rlcmac_tbf::enable_egprs()
446{
447 m_egprs_enabled = true;
448}
449
450inline void gprs_rlcmac_tbf::disable_egprs()
451{
452 m_egprs_enabled = false;
453}
454
Daniel Willmann078bb712014-07-10 17:44:06 +0200455struct gprs_rlcmac_dl_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200456 gprs_rlcmac_dl_tbf(BTS *bts);
Maxea98b7d2018-01-04 15:13:27 +0100457 gprs_rlc_dl_window *window();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200458 void cleanup();
Max25a3ca42017-12-13 18:47:52 +0100459 void enable_egprs();
Daniel Willmann30168882014-08-07 12:48:29 +0200460 /* dispatch Unitdata.DL messages */
461 static int handle(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200462 const uint32_t tlli, const uint32_t old_tlli,
463 const char *imsi, const uint8_t ms_class,
Jacob Erlbeck14e00f82015-11-27 18:10:39 +0100464 const uint8_t egprs_ms_class, const uint16_t delay_csec,
465 const uint8_t *data, const uint16_t len);
Daniel Willmann30168882014-08-07 12:48:29 +0200466
Daniel Willmann538ac5b2014-07-30 19:12:27 +0200467 int append_data(const uint8_t ms_class,
468 const uint16_t pdu_delay_csec,
469 const uint8_t *data, const uint16_t len);
470
Max7df82d42017-12-15 11:14:30 +0100471 int rcvd_dl_ack(bool final, uint8_t ssn, uint8_t *rbb);
472 int rcvd_dl_ack(bool final_ack, unsigned first_bsn, struct bitvec *rbb);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200473 struct msgb *create_dl_acked_block(uint32_t fn, uint8_t ts);
Maxa10c3982017-07-07 18:25:41 +0200474 void trigger_ass(struct gprs_rlcmac_tbf *old_tbf);
Max8dce1de2018-01-02 14:17:04 +0100475
Maxaae1bfb2017-07-07 13:49:29 +0200476 bool handle_ack_nack();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100477 void request_dl_ack();
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100478 bool need_control_ts() const;
479 bool have_data() const;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100480 int frames_since_last_poll(unsigned fn) const;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100481 int frames_since_last_drain(unsigned fn) const;
482 bool keep_open(unsigned fn) const;
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200483 int release();
Jacob Erlbeckf04a5b32016-01-21 20:42:40 +0100484 int abort();
Maxa4f570f2017-12-15 11:21:57 +0100485 uint16_t window_size() const;
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +0530486 void egprs_calc_window_size();
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530487 void update_coding_scheme_counter_dl(const GprsCodingScheme cs);
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +0530488
Daniel Willmanncf706b02014-08-07 17:35:22 +0200489 /* TODO: add the gettimeofday as parameter */
490 struct msgb *llc_dequeue(bssgp_bvc_ctx *bctx);
491
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200492 /* Please note that all variables here will be reset when changing
493 * from WAIT RELEASE back to FLOW state (re-use of TBF).
494 * All states that need reset must be in this struct, so this is why
495 * variables are in both (dl and ul) structs and not outside union.
496 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200497 int32_t m_tx_counter; /* count all transmitted blocks */
498 uint8_t m_wait_confirm; /* wait for CCCH IMM.ASS cnf */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100499 bool m_dl_ack_requested;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100500 int32_t m_last_dl_poll_fn;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100501 int32_t m_last_dl_drained_fn;
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200502
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200503 struct BandWidth {
Daniel Willmann418a4232014-08-08 11:21:04 +0200504 struct timeval dl_bw_tv; /* timestamp for dl bw calculation */
505 uint32_t dl_bw_octets; /* number of octets since bw_tv */
sivasankari53950732016-12-08 17:15:17 +0530506 uint32_t dl_throughput; /* throughput to be displayed in stats */
Daniel Willmann418a4232014-08-08 11:21:04 +0200507
508 struct timeval dl_loss_tv; /* timestamp for loss calculation */
509 uint16_t dl_loss_lost; /* sum of lost packets */
510 uint16_t dl_loss_received; /* sum of received packets */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200511
512 BandWidth();
Daniel Willmann418a4232014-08-08 11:21:04 +0200513 } m_bw;
514
sivasankari53950732016-12-08 17:15:17 +0530515 struct rate_ctr_group *m_dl_gprs_ctrs;
516 struct rate_ctr_group *m_dl_egprs_ctrs;
517
Daniel Willmannb8f26012014-07-30 19:12:28 +0200518protected:
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200519 struct ana_result {
520 unsigned received_packets;
521 unsigned lost_packets;
522 unsigned received_bytes;
523 unsigned lost_bytes;
524 };
525
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100526 int take_next_bsn(uint32_t fn, int previous_bsn,
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100527 bool *may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100528 bool restart_bsn_cycle();
529 int create_new_bsn(const uint32_t fn, GprsCodingScheme cs);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200530 struct msgb *create_dl_acked_block(const uint32_t fn, const uint8_t ts,
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100531 int index, int index2 = -1);
Daniel Willmann30168882014-08-07 12:48:29 +0200532 int update_window(const uint8_t ssn, const uint8_t *rbb);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100533 int update_window(unsigned first_bsn, const struct bitvec *rbb);
Daniel Willmann30168882014-08-07 12:48:29 +0200534 int maybe_start_new_window();
535 bool dl_window_stalled() const;
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200536 void reuse_tbf();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200537 void start_llc_timer();
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200538 int analyse_errors(char *show_rbb, uint8_t ssn, ana_result *res);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200539 void schedule_next_frame();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200540
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530541 enum egprs_rlc_dl_reseg_bsn_state egprs_dl_get_data
542 (int bsn, uint8_t **block_data);
543 unsigned int get_egprs_dl_spb_status(int bsn);
544 enum egprs_rlcmac_dl_spb get_egprs_dl_spb(int bsn);
545
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200546 struct osmo_timer_list m_llc_timer;
Maxea98b7d2018-01-04 15:13:27 +0100547
548 /* Please note that all variables below will be reset when changing
549 * from WAIT RELEASE back to FLOW state (re-use of TBF).
550 * All states that need reset must be in this struct, so this is why
551 * variables are in both (dl and ul) structs and not outside union.
552 */
553 gprs_rlc_dl_window m_window;
Daniel Willmann078bb712014-07-10 17:44:06 +0200554};
555
556struct gprs_rlcmac_ul_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200557 gprs_rlcmac_ul_tbf(BTS *bts);
Maxea98b7d2018-01-04 15:13:27 +0100558 gprs_rlc_ul_window *window();
Jacob Erlbeck5a3c84d2016-01-22 17:25:38 +0100559 struct msgb *create_ul_ack(uint32_t fn, uint8_t ts);
Maxfd13f6c2017-07-07 14:29:36 +0200560 bool ctrl_ack_to_toggle();
561 bool handle_ctrl_ack();
Max25a3ca42017-12-13 18:47:52 +0100562 void enable_egprs();
Daniel Willmann350f64d2014-08-07 14:54:11 +0200563 /* blocks were acked */
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100564 int rcv_data_block_acknowledged(
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100565 const struct gprs_rlc_data_info *rlc,
Jacob Erlbeckfc1b3e62016-01-11 09:58:11 +0100566 uint8_t *data, struct pcu_l1_meas *meas);
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100567
Daniel Willmann350f64d2014-08-07 14:54:11 +0200568
Daniel Willmanne2732e22014-08-07 17:32:01 +0200569 /* TODO: extract LLC class? */
570 int assemble_forward_llc(const gprs_rlc_data *data);
571 int snd_ul_ud();
572
Aravind Sirsikar505a86d2016-07-26 18:26:21 +0530573 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_spb(
574 const struct gprs_rlc_data_info *rlc,
575 struct gprs_rlc_data *block,
576 uint8_t *data, const uint8_t block_idx);
577
578 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_first_seg(
579 const struct gprs_rlc_data_info *rlc,
580 struct gprs_rlc_data *block,
581 uint8_t *data, const uint8_t block_idx);
582
583 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_second_seg(
584 const struct gprs_rlc_data_info *rlc,
585 struct gprs_rlc_data *block,
586 uint8_t *data, const uint8_t block_idx);
587
sivasankari8adfcd02017-01-16 15:41:21 +0530588 void egprs_calc_ulwindow_size();
Maxa4f570f2017-12-15 11:21:57 +0100589 uint16_t window_size() const;
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530590 void update_coding_scheme_counter_ul(const GprsCodingScheme cs);
591
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200592 /* Please note that all variables here will be reset when changing
593 * from WAIT RELEASE back to FLOW state (re-use of TBF).
594 * All states that need reset must be in this struct, so this is why
595 * variables are in both (dl and ul) structs and not outside union.
596 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200597 int32_t m_rx_counter; /* count all received blocks */
598 uint8_t m_n3103; /* N3103 counter */
599 uint8_t m_usf[8]; /* list USFs per PDCH (timeslot) */
600 uint8_t m_contention_resolution_done; /* set after done */
601 uint8_t m_final_ack_sent; /* set if we sent final ack */
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200602
sivasankarida7250a2016-12-16 12:57:18 +0530603 struct rate_ctr_group *m_ul_gprs_ctrs;
604 struct rate_ctr_group *m_ul_egprs_ctrs;
605
Daniel Willmann350f64d2014-08-07 14:54:11 +0200606protected:
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100607 void maybe_schedule_uplink_acknack(const gprs_rlc_data_info *rlc);
Maxea98b7d2018-01-04 15:13:27 +0100608
609 /* Please note that all variables below will be reset when changing
610 * from WAIT RELEASE back to FLOW state (re-use of TBF).
611 * All states that need reset must be in this struct, so this is why
612 * variables are in both (dl and ul) structs and not outside union.
613 */
614 gprs_rlc_ul_window m_window;
Daniel Willmann078bb712014-07-10 17:44:06 +0200615};
616
Max701afa42017-12-01 17:13:22 +0100617#ifdef __cplusplus
618extern "C" {
619#endif
620void update_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, int8_t ta_delta);
621void set_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, uint8_t ta);
622#ifdef __cplusplus
623}
624#endif
625
Jacob Erlbeckac89a552015-06-29 14:18:46 +0200626inline enum gprs_rlcmac_tbf_direction reverse(enum gprs_rlcmac_tbf_direction dir)
627{
628 return (enum gprs_rlcmac_tbf_direction)
629 ((int)GPRS_RLCMAC_UL_TBF - (int)dir + (int)GPRS_RLCMAC_DL_TBF);
630}
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100631
Maxa4f570f2017-12-15 11:21:57 +0100632inline uint16_t gprs_rlcmac_ul_tbf::window_size() const
633{
634 return m_window.ws();
635}
636
637inline uint16_t gprs_rlcmac_dl_tbf::window_size() const
638{
639 return m_window.ws();
640}
641
Max25a3ca42017-12-13 18:47:52 +0100642inline void gprs_rlcmac_ul_tbf::enable_egprs()
643{
644 m_window.set_sns(RLC_EGPRS_SNS);
645 gprs_rlcmac_tbf::enable_egprs();
646}
647
648inline void gprs_rlcmac_dl_tbf::enable_egprs()
649{
650 m_window.set_sns(RLC_EGPRS_SNS);
651 gprs_rlcmac_tbf::enable_egprs();
652}
653
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100654inline gprs_rlcmac_ul_tbf *as_ul_tbf(gprs_rlcmac_tbf *tbf)
655{
656 if (tbf && tbf->direction == GPRS_RLCMAC_UL_TBF)
657 return static_cast<gprs_rlcmac_ul_tbf *>(tbf);
658 else
659 return NULL;
660}
661
662inline gprs_rlcmac_dl_tbf *as_dl_tbf(gprs_rlcmac_tbf *tbf)
663{
664 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
665 return static_cast<gprs_rlcmac_dl_tbf *>(tbf);
666 else
667 return NULL;
668}
669
Daniel Willmannafa72f52014-01-15 17:06:19 +0100670#endif