blob: 6d7edbcf64796eb191080ebfb8204550835c9d38 [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
Jacob Erlbeck13965ae2016-01-19 14:10:40 +0100196 gprs_rlc_window *window();
197
Holger Hans Peter Freyther8f399de2013-12-25 20:22:35 +0100198 uint8_t tsc() const;
Holger Hans Peter Freythera1da2512013-11-07 07:32:51 +0100199
Holger Hans Peter Freyther7380bab2013-10-16 18:09:19 +0200200 int rlcmac_diag();
Holger Hans Peter Freyther964ddb62013-10-16 17:53:23 +0200201
Jacob Erlbecke0c734d2015-07-03 14:03:33 +0200202 int update();
Holger Hans Peter Freytheraf8094d2013-10-26 17:56:15 +0200203 void handle_timeout();
Maxee5be3a2017-12-20 17:31:13 +0100204 void stop_timers(const char *reason);
205 bool timers_pending(enum tbf_timers t);
206 void t_stop(enum tbf_timers t, const char *reason);
Max467f6332017-12-20 18:13:29 +0100207 void t_start(enum tbf_timers t, uint32_t sec, uint32_t microsec, const char *reason, bool force,
208 const char *file, unsigned line);
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200209 int establish_dl_tbf_on_pacch();
Holger Hans Peter Freytheraa9c3262013-10-26 17:49:36 +0200210
Jacob Erlbeckf2694b72016-01-26 21:46:26 +0100211 int check_polling(uint32_t fn, uint8_t ts,
212 uint32_t *poll_fn, unsigned int *rrbp);
Maxf60cf622017-07-10 14:40:09 +0200213 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 +0200214 void poll_timeout();
215
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100216 /** tlli handling */
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100217 uint32_t tlli() const;
218 bool is_tlli_valid() const;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100219
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200220 /** MS updating */
Jacob Erlbeckbe0cbc12015-05-18 14:35:11 +0200221 void update_ms(uint32_t tlli, enum gprs_rlcmac_tbf_direction);
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200222
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100223 uint8_t tfi() const;
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100224 bool is_tfi_assigned() const;
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100225
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100226 const char *imsi() const;
227 void assign_imsi(const char *imsi);
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200228 uint8_t ta() const;
229 void set_ta(uint8_t);
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200230 uint8_t ms_class() const;
231 void set_ms_class(uint8_t);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100232 GprsCodingScheme current_cs() const;
Max869c0c22018-01-03 12:00:36 +0100233 size_t llc_queue_size() const;
Holger Hans Peter Freyther5464c9b2013-10-27 20:57:35 +0100234
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100235 time_t created_ts() const;
Jacob Erlbeck617c7122015-06-30 09:18:30 +0200236 uint8_t dl_slots() const;
237 uint8_t ul_slots() const;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100238
Jacob Erlbeck646da1b2016-01-22 17:41:33 +0100239 bool is_control_ts(uint8_t ts) const;
240
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100241 /* EGPRS */
242 bool is_egprs_enabled() const;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100243 void disable_egprs();
244
Holger Hans Peter Freyther7a5f3c22013-11-26 13:08:12 +0100245 /* attempt to make things a bit more fair */
246 void rotate_in_list();
247
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200248 LListHead<gprs_rlcmac_tbf>& ms_list() {return this->m_ms_list;}
249 const LListHead<gprs_rlcmac_tbf>& ms_list() const {return this->m_ms_list;}
250
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100251 LListHead<gprs_rlcmac_tbf>& list();
252 const LListHead<gprs_rlcmac_tbf>& list() const;
253
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200254 uint32_t state_flags;
255 enum gprs_rlcmac_tbf_direction direction;
Holger Hans Peter Freyther743bafa2013-09-29 07:50:50 +0200256 struct gprs_rlcmac_trx *trx;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200257 uint8_t first_ts; /* first TS used by TBF */
258 uint8_t first_common_ts; /* first TS that the phone can send and
259 reveive simultaniously */
260 uint8_t control_ts; /* timeslot control messages and polling */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200261 struct gprs_rlcmac_pdch *pdch[8]; /* list of PDCHs allocated to TBF */
Holger Hans Peter Freyther28e53782013-11-06 20:23:56 +0100262
263 gprs_llc m_llc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200264
265 enum gprs_rlcmac_tbf_dl_ass_state dl_ass_state;
266 enum gprs_rlcmac_tbf_ul_ass_state ul_ass_state;
267 enum gprs_rlcmac_tbf_ul_ack_state ul_ack_state;
268
269 enum gprs_rlcmac_tbf_poll_state poll_state;
270 uint32_t poll_fn; /* frame number to poll */
Jacob Erlbeck8eb17142016-01-22 17:58:17 +0100271 uint8_t poll_ts; /* TS to poll */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200272
Holger Hans Peter Freyther9241fd02013-11-13 19:51:55 +0100273 gprs_rlc m_rlc;
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200274
275 uint8_t n3105; /* N3105 counter */
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200276
277 struct osmo_gsm_timer_list gsm_timer;
278 unsigned int fT; /* fTxxxx number */
279 unsigned int num_fT_exp; /* number of consecutive fT expirations */
280
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200281 struct Meas {
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200282 struct timeval rssi_tv; /* timestamp for rssi calculation */
283 int32_t rssi_sum; /* sum of rssi values */
284 int rssi_num; /* number of rssi values added since rssi_tv */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200285
286 Meas();
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200287 } meas;
288
Daniel Willmann73191a42014-05-30 17:58:00 +0200289 /* Remember if the tbf was in wait_release state when we want to
290 * schedule a new dl assignment */
291 uint8_t was_releasing;
292
Daniel Willmanncf1fae72014-05-30 17:58:01 +0200293 /* Can/should we upgrade this tbf to use multiple slots? */
294 uint8_t upgrade_to_multislot;
295
Holger Hans Peter Freyther9f0c1d22013-10-19 21:24:34 +0200296 /* store the BTS this TBF belongs to */
297 BTS *bts;
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200298
Max59e4a4f2017-12-20 18:01:55 +0100299 uint8_t m_n3101; /* N3101 counter */
300
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100301 /*
302 * private fields. We can't make it private as it is breaking the
303 * llist macros.
304 */
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100305 uint8_t m_tfi;
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100306 time_t m_created_ts;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100307
sivasankari53950732016-12-08 17:15:17 +0530308 struct rate_ctr_group *m_ctrs;
309
Holger Hans Peter Freytherd9262b32013-10-26 20:12:59 +0200310protected:
311 gprs_rlcmac_bts *bts_data() const;
Max25a3ca42017-12-13 18:47:52 +0100312 void enable_egprs();
Jacob Erlbecke8f5fe52015-12-14 13:23:15 +0100313 int set_tlli_from_ul(uint32_t new_tlli);
Jacob Erlbeck28c40b12015-08-16 18:19:32 +0200314 void merge_and_clear_ms(GprsMs *old_ms);
Holger Hans Peter Freyther4c06d912013-11-25 23:05:26 +0100315
Alexander Couzensd38b92e2016-08-21 19:38:30 +0200316 gprs_llc_queue *llc_queue();
317 const gprs_llc_queue *llc_queue() const;
318
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200319 static const char *tbf_state_name[6];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100320
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200321 class GprsMs *m_ms;
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200322
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200323 /* Fields to take the TA/MS class values if no MS is associated */
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200324 uint8_t m_ta;
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200325 uint8_t m_ms_class;
Jacob Erlbeck6dbe8222015-05-29 10:37:09 +0200326
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100327private:
Max50818062017-12-06 13:35:08 +0100328 enum gprs_rlcmac_tbf_state state;
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100329 LListHead<gprs_rlcmac_tbf> m_list;
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200330 LListHead<gprs_rlcmac_tbf> m_ms_list;
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100331 bool m_egprs_enabled;
Maxb2de1f72017-12-20 18:05:29 +0100332 struct osmo_timer_list T[T_MAX];
Jacob Erlbeckadcdf152015-03-03 14:45:55 +0100333 mutable char m_name_buf[60];
Holger Hans Peter Freyther099535a2013-10-16 17:42:31 +0200334};
335
Holger Hans Peter Freyther17c31ce2013-08-24 18:31:27 +0200336
Daniel Willmann0d12a2f2014-07-10 17:44:07 +0200337struct gprs_rlcmac_ul_tbf *tbf_alloc_ul(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100338 int8_t use_trx, uint8_t ms_class, uint8_t egprs_ms_class,
Jacob Erlbecke2e004e2015-06-18 17:16:26 +0200339 uint32_t tlli, uint8_t ta, GprsMs *ms);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200340
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200341struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200342 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100343 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Daniel Willmann48aa0b02014-07-16 18:54:10 +0200344
345struct gprs_rlcmac_dl_tbf *tbf_alloc_dl_tbf(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck5879c642015-07-10 10:41:36 +0200346 GprsMs *ms, int8_t use_trx,
Jacob Erlbeck86b6f052015-11-27 15:17:34 +0100347 uint8_t ms_class, uint8_t egprs_ms_class, uint8_t single_slot);
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200348
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200349void tbf_free(struct gprs_rlcmac_tbf *tbf);
350
aravind sirsikare9a138e2017-01-24 12:36:08 +0530351struct gprs_rlcmac_ul_tbf *handle_tbf_reject(struct gprs_rlcmac_bts *bts,
352 GprsMs *ms, uint32_t tlli, uint8_t trx_no, uint8_t ts_no);
353
Holger Hans Peter Freyther9e21d842013-10-16 17:48:12 +0200354int tbf_assign_control_ts(struct gprs_rlcmac_tbf *tbf);
355
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200356inline bool gprs_rlcmac_tbf::state_is(enum gprs_rlcmac_tbf_state rhs) const
357{
358 return state == rhs;
359}
360
361inline bool gprs_rlcmac_tbf::state_is_not(enum gprs_rlcmac_tbf_state rhs) const
362{
363 return state != rhs;
364}
365
Daniel Willmanneb100242014-08-08 11:43:53 +0200366const char *tbf_name(gprs_rlcmac_tbf *tbf);
367
Daniel Willmann08e57c82014-08-15 18:11:57 +0200368inline const char *gprs_rlcmac_tbf::state_name() const
369{
370 return tbf_state_name[state];
371}
372
Max8dce1de2018-01-02 14:17:04 +0100373/* Set assignment state and corrsponding flags */
374inline void gprs_rlcmac_tbf::set_assigned_on(uint8_t state_flag, bool check_ccch)
375{
376 set_state(GPRS_RLCMAC_ASSIGN);
377 if (check_ccch) {
378 if (!(state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)))
379 state_flags |= (1 << state_flag);
380 } else
381 state_flags |= (1 << state_flag);
382}
383
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200384inline void gprs_rlcmac_tbf::set_state(enum gprs_rlcmac_tbf_state new_state)
385{
Daniel Willmanneb100242014-08-08 11:43:53 +0200386 LOGP(DRLCMAC, LOGL_DEBUG, "%s changes state from %s to %s\n",
387 tbf_name(this),
388 tbf_state_name[state], tbf_state_name[new_state]);
Holger Hans Peter Freyther1c344e22013-10-16 18:33:18 +0200389 state = new_state;
390}
Holger Hans Peter Freytherbd449f52013-10-27 16:39:36 +0100391
Max8dce1de2018-01-02 14:17:04 +0100392inline bool gprs_rlcmac_tbf::check_n_clear(uint8_t state_flag)
393{
394 if ((state_flags & (1 << state_flag))) {
395 state_flags &= ~(1 << state_flag);
396 return true;
397 }
398
399 return false;
400}
401
Jacob Erlbecked2dbf62015-12-28 19:15:40 +0100402inline LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list()
403{
404 return this->m_list;
405}
406
407inline const LListHead<gprs_rlcmac_tbf>& gprs_rlcmac_tbf::list() const
408{
409 return this->m_list;
410}
411
Jacob Erlbeck10ed7952015-06-02 11:37:22 +0200412inline GprsMs *gprs_rlcmac_tbf::ms() const
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200413{
414 return m_ms;
415}
416
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100417inline bool gprs_rlcmac_tbf::is_tlli_valid() const
418{
Jacob Erlbeck767193e2015-05-20 12:06:46 +0200419 return tlli() != 0;
Holger Hans Peter Freyther474685e2013-10-27 17:01:14 +0100420}
421
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100422inline bool gprs_rlcmac_tbf::is_tfi_assigned() const
423{
424 /* The TBF is established or has been assigned by a IMM.ASS for
425 * download */
Neels Hofmeyr4ea45262016-06-08 15:27:40 +0200426 return state > GPRS_RLCMAC_ASSIGN ||
427 (direction == GPRS_RLCMAC_DL_TBF &&
428 state == GPRS_RLCMAC_ASSIGN &&
429 (state_flags & (1 << GPRS_RLCMAC_FLAG_CCCH)));
Jacob Erlbeck6b356a52016-01-29 16:39:21 +0100430}
431
Holger Hans Peter Freyther34f6e5e2013-10-27 20:31:47 +0100432inline uint8_t gprs_rlcmac_tbf::tfi() const
433{
434 return m_tfi;
435}
436
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100437inline time_t gprs_rlcmac_tbf::created_ts() const
Daniel Willmann80367aa2014-01-15 17:40:28 +0100438{
Holger Hans Peter Freythera0047992014-01-16 10:07:20 +0100439 return m_created_ts;
Daniel Willmann80367aa2014-01-15 17:40:28 +0100440}
441
Jacob Erlbeck5643f352015-11-27 16:17:40 +0100442inline bool gprs_rlcmac_tbf::is_egprs_enabled() const
443{
444 return m_egprs_enabled;
445}
446
447inline void gprs_rlcmac_tbf::enable_egprs()
448{
449 m_egprs_enabled = true;
450}
451
452inline void gprs_rlcmac_tbf::disable_egprs()
453{
454 m_egprs_enabled = false;
455}
456
Daniel Willmann078bb712014-07-10 17:44:06 +0200457struct gprs_rlcmac_dl_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200458 gprs_rlcmac_dl_tbf(BTS *bts);
Jacob Erlbeck444bc822015-08-20 17:49:03 +0200459
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200460 void cleanup();
Max25a3ca42017-12-13 18:47:52 +0100461 void enable_egprs();
Daniel Willmann30168882014-08-07 12:48:29 +0200462 /* dispatch Unitdata.DL messages */
463 static int handle(struct gprs_rlcmac_bts *bts,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200464 const uint32_t tlli, const uint32_t old_tlli,
465 const char *imsi, const uint8_t ms_class,
Jacob Erlbeck14e00f82015-11-27 18:10:39 +0100466 const uint8_t egprs_ms_class, const uint16_t delay_csec,
467 const uint8_t *data, const uint16_t len);
Daniel Willmann30168882014-08-07 12:48:29 +0200468
Daniel Willmann538ac5b2014-07-30 19:12:27 +0200469 int append_data(const uint8_t ms_class,
470 const uint16_t pdu_delay_csec,
471 const uint8_t *data, const uint16_t len);
472
Max7df82d42017-12-15 11:14:30 +0100473 int rcvd_dl_ack(bool final, uint8_t ssn, uint8_t *rbb);
474 int rcvd_dl_ack(bool final_ack, unsigned first_bsn, struct bitvec *rbb);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200475 struct msgb *create_dl_acked_block(uint32_t fn, uint8_t ts);
Maxa10c3982017-07-07 18:25:41 +0200476 void trigger_ass(struct gprs_rlcmac_tbf *old_tbf);
Max8dce1de2018-01-02 14:17:04 +0100477
Maxaae1bfb2017-07-07 13:49:29 +0200478 bool handle_ack_nack();
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100479 void request_dl_ack();
Jacob Erlbeckeceb9102015-03-20 14:41:50 +0100480 bool need_control_ts() const;
481 bool have_data() const;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100482 int frames_since_last_poll(unsigned fn) const;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100483 int frames_since_last_drain(unsigned fn) const;
484 bool keep_open(unsigned fn) const;
Jacob Erlbeck91ff7d12015-09-01 11:20:29 +0200485 int release();
Jacob Erlbeckf04a5b32016-01-21 20:42:40 +0100486 int abort();
Maxa4f570f2017-12-15 11:21:57 +0100487 uint16_t window_size() const;
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +0530488 void egprs_calc_window_size();
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530489 void update_coding_scheme_counter_dl(const GprsCodingScheme cs);
Aravind Sirsikar8e70bb52016-09-15 17:51:16 +0530490
Daniel Willmanncf706b02014-08-07 17:35:22 +0200491 /* TODO: add the gettimeofday as parameter */
492 struct msgb *llc_dequeue(bssgp_bvc_ctx *bctx);
493
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200494 /* Please note that all variables here will be reset when changing
495 * from WAIT RELEASE back to FLOW state (re-use of TBF).
496 * All states that need reset must be in this struct, so this is why
497 * variables are in both (dl and ul) structs and not outside union.
498 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200499 gprs_rlc_dl_window m_window;
500 int32_t m_tx_counter; /* count all transmitted blocks */
501 uint8_t m_wait_confirm; /* wait for CCCH IMM.ASS cnf */
Jacob Erlbeck7c444152015-03-12 12:08:54 +0100502 bool m_dl_ack_requested;
Jacob Erlbeck005ee7f2015-03-20 14:53:54 +0100503 int32_t m_last_dl_poll_fn;
Jacob Erlbeck3bed5d12015-03-19 11:22:38 +0100504 int32_t m_last_dl_drained_fn;
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200505
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200506 struct BandWidth {
Daniel Willmann418a4232014-08-08 11:21:04 +0200507 struct timeval dl_bw_tv; /* timestamp for dl bw calculation */
508 uint32_t dl_bw_octets; /* number of octets since bw_tv */
sivasankari53950732016-12-08 17:15:17 +0530509 uint32_t dl_throughput; /* throughput to be displayed in stats */
Daniel Willmann418a4232014-08-08 11:21:04 +0200510
511 struct timeval dl_loss_tv; /* timestamp for loss calculation */
512 uint16_t dl_loss_lost; /* sum of lost packets */
513 uint16_t dl_loss_received; /* sum of received packets */
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200514
515 BandWidth();
Daniel Willmann418a4232014-08-08 11:21:04 +0200516 } m_bw;
517
sivasankari53950732016-12-08 17:15:17 +0530518 struct rate_ctr_group *m_dl_gprs_ctrs;
519 struct rate_ctr_group *m_dl_egprs_ctrs;
520
Daniel Willmannb8f26012014-07-30 19:12:28 +0200521protected:
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200522 struct ana_result {
523 unsigned received_packets;
524 unsigned lost_packets;
525 unsigned received_bytes;
526 unsigned lost_bytes;
527 };
528
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100529 int take_next_bsn(uint32_t fn, int previous_bsn,
Jacob Erlbeck64e7b832016-02-04 15:16:47 +0100530 bool *may_combine);
Jacob Erlbeckd6752492016-02-02 18:12:46 +0100531 bool restart_bsn_cycle();
532 int create_new_bsn(const uint32_t fn, GprsCodingScheme cs);
Daniel Willmannb8f26012014-07-30 19:12:28 +0200533 struct msgb *create_dl_acked_block(const uint32_t fn, const uint8_t ts,
Jacob Erlbeckbe314d92016-02-02 15:32:10 +0100534 int index, int index2 = -1);
Daniel Willmann30168882014-08-07 12:48:29 +0200535 int update_window(const uint8_t ssn, const uint8_t *rbb);
Jacob Erlbeckeb08f862016-02-05 17:07:12 +0100536 int update_window(unsigned first_bsn, const struct bitvec *rbb);
Daniel Willmann30168882014-08-07 12:48:29 +0200537 int maybe_start_new_window();
538 bool dl_window_stalled() const;
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200539 void reuse_tbf();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200540 void start_llc_timer();
Jacob Erlbeck2db0f082015-09-07 18:49:00 +0200541 int analyse_errors(char *show_rbb, uint8_t ssn, ana_result *res);
Jacob Erlbeck409efa12015-06-12 14:06:09 +0200542 void schedule_next_frame();
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200543
Aravind Sirsikar50b09702016-08-22 17:21:10 +0530544 enum egprs_rlc_dl_reseg_bsn_state egprs_dl_get_data
545 (int bsn, uint8_t **block_data);
546 unsigned int get_egprs_dl_spb_status(int bsn);
547 enum egprs_rlcmac_dl_spb get_egprs_dl_spb(int bsn);
548
Jacob Erlbeckd0261b72015-04-02 13:58:09 +0200549 struct osmo_timer_list m_llc_timer;
Daniel Willmann078bb712014-07-10 17:44:06 +0200550};
551
552struct gprs_rlcmac_ul_tbf : public gprs_rlcmac_tbf {
Jacob Erlbeckb6b3c7e2015-08-28 12:07:14 +0200553 gprs_rlcmac_ul_tbf(BTS *bts);
Jacob Erlbeck444bc822015-08-20 17:49:03 +0200554
Jacob Erlbeck5a3c84d2016-01-22 17:25:38 +0100555 struct msgb *create_ul_ack(uint32_t fn, uint8_t ts);
Maxfd13f6c2017-07-07 14:29:36 +0200556 bool ctrl_ack_to_toggle();
557 bool handle_ctrl_ack();
Max25a3ca42017-12-13 18:47:52 +0100558 void enable_egprs();
Daniel Willmann350f64d2014-08-07 14:54:11 +0200559 /* blocks were acked */
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100560 int rcv_data_block_acknowledged(
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100561 const struct gprs_rlc_data_info *rlc,
Jacob Erlbeckfc1b3e62016-01-11 09:58:11 +0100562 uint8_t *data, struct pcu_l1_meas *meas);
Jacob Erlbeckb3100e12015-12-14 13:36:13 +0100563
Daniel Willmann350f64d2014-08-07 14:54:11 +0200564
Daniel Willmanne2732e22014-08-07 17:32:01 +0200565 /* TODO: extract LLC class? */
566 int assemble_forward_llc(const gprs_rlc_data *data);
567 int snd_ul_ud();
568
Aravind Sirsikar505a86d2016-07-26 18:26:21 +0530569 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_spb(
570 const struct gprs_rlc_data_info *rlc,
571 struct gprs_rlc_data *block,
572 uint8_t *data, const uint8_t block_idx);
573
574 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_first_seg(
575 const struct gprs_rlc_data_info *rlc,
576 struct gprs_rlc_data *block,
577 uint8_t *data, const uint8_t block_idx);
578
579 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_second_seg(
580 const struct gprs_rlc_data_info *rlc,
581 struct gprs_rlc_data *block,
582 uint8_t *data, const uint8_t block_idx);
583
sivasankari8adfcd02017-01-16 15:41:21 +0530584 void egprs_calc_ulwindow_size();
Maxa4f570f2017-12-15 11:21:57 +0100585 uint16_t window_size() const;
Mrinal Mishraf86307e2016-11-10 18:16:30 +0530586 void update_coding_scheme_counter_ul(const GprsCodingScheme cs);
587
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200588 /* Please note that all variables here will be reset when changing
589 * from WAIT RELEASE back to FLOW state (re-use of TBF).
590 * All states that need reset must be in this struct, so this is why
591 * variables are in both (dl and ul) structs and not outside union.
592 */
Daniel Willmann7e994e32014-08-07 15:49:21 +0200593 gprs_rlc_ul_window m_window;
594 int32_t m_rx_counter; /* count all received blocks */
595 uint8_t m_n3103; /* N3103 counter */
596 uint8_t m_usf[8]; /* list USFs per PDCH (timeslot) */
597 uint8_t m_contention_resolution_done; /* set after done */
598 uint8_t m_final_ack_sent; /* set if we sent final ack */
Daniel Willmann6a8a1dc2014-08-07 15:14:08 +0200599
sivasankarida7250a2016-12-16 12:57:18 +0530600 struct rate_ctr_group *m_ul_gprs_ctrs;
601 struct rate_ctr_group *m_ul_egprs_ctrs;
602
Daniel Willmann350f64d2014-08-07 14:54:11 +0200603protected:
Jacob Erlbeckf2ba4cb2016-01-07 18:59:28 +0100604 void maybe_schedule_uplink_acknack(const gprs_rlc_data_info *rlc);
Daniel Willmann078bb712014-07-10 17:44:06 +0200605};
606
Max701afa42017-12-01 17:13:22 +0100607#ifdef __cplusplus
608extern "C" {
609#endif
610void update_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, int8_t ta_delta);
611void set_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, uint8_t ta);
612#ifdef __cplusplus
613}
614#endif
615
Jacob Erlbeckac89a552015-06-29 14:18:46 +0200616inline enum gprs_rlcmac_tbf_direction reverse(enum gprs_rlcmac_tbf_direction dir)
617{
618 return (enum gprs_rlcmac_tbf_direction)
619 ((int)GPRS_RLCMAC_UL_TBF - (int)dir + (int)GPRS_RLCMAC_DL_TBF);
620}
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100621
Maxa4f570f2017-12-15 11:21:57 +0100622inline uint16_t gprs_rlcmac_ul_tbf::window_size() const
623{
624 return m_window.ws();
625}
626
627inline uint16_t gprs_rlcmac_dl_tbf::window_size() const
628{
629 return m_window.ws();
630}
631
Max25a3ca42017-12-13 18:47:52 +0100632inline void gprs_rlcmac_ul_tbf::enable_egprs()
633{
634 m_window.set_sns(RLC_EGPRS_SNS);
635 gprs_rlcmac_tbf::enable_egprs();
636}
637
638inline void gprs_rlcmac_dl_tbf::enable_egprs()
639{
640 m_window.set_sns(RLC_EGPRS_SNS);
641 gprs_rlcmac_tbf::enable_egprs();
642}
643
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100644inline gprs_rlcmac_ul_tbf *as_ul_tbf(gprs_rlcmac_tbf *tbf)
645{
646 if (tbf && tbf->direction == GPRS_RLCMAC_UL_TBF)
647 return static_cast<gprs_rlcmac_ul_tbf *>(tbf);
648 else
649 return NULL;
650}
651
652inline gprs_rlcmac_dl_tbf *as_dl_tbf(gprs_rlcmac_tbf *tbf)
653{
654 if (tbf && tbf->direction == GPRS_RLCMAC_DL_TBF)
655 return static_cast<gprs_rlcmac_dl_tbf *>(tbf);
656 else
657 return NULL;
658}
659
Jacob Erlbeck13965ae2016-01-19 14:10:40 +0100660inline gprs_rlc_window *gprs_rlcmac_tbf::window()
661{
662 switch (direction)
663 {
664 case GPRS_RLCMAC_UL_TBF: return &as_ul_tbf(this)->m_window;
665 case GPRS_RLCMAC_DL_TBF: return &as_dl_tbf(this)->m_window;
666 }
667 return NULL;
668}
669
Daniel Willmannafa72f52014-01-15 17:06:19 +0100670#endif