blob: 9396633bd617002cf0cc799eb87b3d95b8347134 [file] [log] [blame]
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +02001/*
2 * Copyright (C) 2013 by Holger Hans Peter Freyther
3 * Copyright (C) 2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20#pragma once
21
22#ifdef __cplusplus
23
Pau Espin Pedrolc33a0242020-05-15 16:57:48 +020024#include <stdbool.h>
25
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020026#include "tbf.h"
27/*
28 * TBF instance
29 */
30
31enum tbf_gprs_ul_counters {
32 TBF_CTR_GPRS_UL_CS1,
33 TBF_CTR_GPRS_UL_CS2,
34 TBF_CTR_GPRS_UL_CS3,
35 TBF_CTR_GPRS_UL_CS4,
36};
37
38enum tbf_egprs_ul_counters {
39 TBF_CTR_EGPRS_UL_MCS1,
40 TBF_CTR_EGPRS_UL_MCS2,
41 TBF_CTR_EGPRS_UL_MCS3,
42 TBF_CTR_EGPRS_UL_MCS4,
43 TBF_CTR_EGPRS_UL_MCS5,
44 TBF_CTR_EGPRS_UL_MCS6,
45 TBF_CTR_EGPRS_UL_MCS7,
46 TBF_CTR_EGPRS_UL_MCS8,
47 TBF_CTR_EGPRS_UL_MCS9,
48};
49
Pau Espin Pedrol7bd92a32021-03-24 13:14:09 +010050/* Used in ul_tbf->m_usf[] to flag unassigned USF on a given TS: */
51#define USF_INVALID 0xFF
52
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020053#define LOGPTBFUL(tbf, level, fmt, args...) LOGP(DTBFUL, level, "%s " fmt, tbf_name(tbf), ## args)
54
55struct gprs_rlcmac_ul_tbf : public gprs_rlcmac_tbf {
Pau Espin Pedrol2182e622021-01-14 16:48:38 +010056 gprs_rlcmac_ul_tbf(struct gprs_rlcmac_bts *bts, GprsMs *ms);
Pau Espin Pedrolb3f23972020-10-23 21:00:23 +020057 gprs_rlc_window *window();
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020058 struct msgb *create_ul_ack(uint32_t fn, uint8_t ts);
59 bool ctrl_ack_to_toggle();
Pau Espin Pedrol86580e12021-03-29 18:15:30 +020060 bool handle_ctrl_ack(enum pdch_ulc_tbf_poll_reason reason);
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020061 /* blocks were acked */
62 int rcv_data_block_acknowledged(
63 const struct gprs_rlc_data_info *rlc,
64 uint8_t *data, struct pcu_l1_meas *meas);
65
66
67 /* TODO: extract LLC class? */
68 int assemble_forward_llc(const gprs_rlc_data *data);
69 int snd_ul_ud();
70
71 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_spb(
72 const struct gprs_rlc_data_info *rlc,
73 struct gprs_rlc_data *block,
74 uint8_t *data, const uint8_t block_idx);
75
76 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_first_seg(
77 const struct gprs_rlc_data_info *rlc,
78 struct gprs_rlc_data *block,
79 uint8_t *data, const uint8_t block_idx);
80
81 egprs_rlc_ul_reseg_bsn_state handle_egprs_ul_second_seg(
82 const struct gprs_rlc_data_info *rlc,
83 struct gprs_rlc_data *block,
84 uint8_t *data, const uint8_t block_idx);
85
86 uint16_t window_size() const;
87 void set_window_size();
88 void update_coding_scheme_counter_ul(enum CodingScheme cs);
Pau Espin Pedrol0b998b12021-03-24 14:45:43 +010089 void usf_timeout();
Pau Espin Pedrol4b6f0bf2021-05-10 18:54:52 +020090 void contention_resolution_start();
91 void contention_resolution_success();
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +020092
93 /* Please note that all variables here will be reset when changing
94 * from WAIT RELEASE back to FLOW state (re-use of TBF).
95 * All states that need reset must be in this struct, so this is why
96 * variables are in both (dl and ul) structs and not outside union.
97 */
98 int32_t m_rx_counter; /* count all received blocks */
Pau Espin Pedrol7bd92a32021-03-24 13:14:09 +010099 uint8_t m_usf[8]; /* list USFs per PDCH (timeslot), initialized to USF_INVALID */
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +0200100 uint8_t m_contention_resolution_done; /* set after done */
101 uint8_t m_final_ack_sent; /* set if we sent final ack */
102
103 struct rate_ctr_group *m_ul_gprs_ctrs;
104 struct rate_ctr_group *m_ul_egprs_ctrs;
105
106protected:
Pau Espin Pedrolc33a0242020-05-15 16:57:48 +0200107 void maybe_schedule_uplink_acknack(const gprs_rlc_data_info *rlc, bool countdown_finished);
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +0200108
109 /* Please note that all variables below will be reset when changing
110 * from WAIT RELEASE back to FLOW state (re-use of TBF).
111 * All states that need reset must be in this struct, so this is why
112 * variables are in both (dl and ul) structs and not outside union.
113 */
114 gprs_rlc_ul_window m_window;
115};
116
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +0200117inline uint16_t gprs_rlcmac_ul_tbf::window_size() const
118{
119 return m_window.ws();
120}
121
Pau Espin Pedrol442198c2020-10-23 22:30:04 +0200122struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_tbf(struct gprs_rlcmac_bts *bts, GprsMs *ms, int8_t use_trx, bool single_slot);
Pau Espin Pedrolc6571b52021-05-10 17:10:37 +0200123struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_pacch(struct gprs_rlcmac_bts *bts, GprsMs *ms,
124 int8_t use_trx, uint32_t tlli);
Pau Espin Pedrol20271c42021-05-10 17:21:03 +0200125struct gprs_rlcmac_ul_tbf *tbf_alloc_ul_ccch(struct gprs_rlcmac_bts *bts, struct GprsMs *ms);
Pau Espin Pedrol442198c2020-10-23 22:30:04 +0200126struct gprs_rlcmac_ul_tbf *handle_tbf_reject(struct gprs_rlcmac_bts *bts,
Pau Espin Pedrol54742f22021-04-26 16:48:34 +0200127 GprsMs *ms, uint8_t trx_no, uint8_t ts_no);
Pau Espin Pedrol442198c2020-10-23 22:30:04 +0200128
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100129#else /* ifdef __cplusplus */
130struct gprs_rlcmac_ul_tbf;
131#endif
132
133
134#ifdef __cplusplus
135extern "C" {
136#endif
137void update_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, int8_t ta_delta);
138void set_tbf_ta(struct gprs_rlcmac_ul_tbf *tbf, uint8_t ta);
139struct gprs_rlcmac_ul_tbf *as_ul_tbf(struct gprs_rlcmac_tbf *tbf);
Pau Espin Pedrol0b998b12021-03-24 14:45:43 +0100140void tbf_usf_timeout(struct gprs_rlcmac_ul_tbf *tbf);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100141#ifdef __cplusplus
142}
Pau Espin Pedrol9d1cdb12019-09-25 17:47:02 +0200143#endif