Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 1 | /* gprs_rlcmac.h |
| 2 | * |
| 3 | * Copyright (C) 2012 Ivan Klyuchnikov |
Holger Hans Peter Freyther | d6bd91e | 2013-08-24 21:16:55 +0200 | [diff] [blame] | 4 | * Copyright (C) 2013 by Holger Hans Peter Freyther |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version 2 |
| 9 | * of the License, or (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 19 | */ |
| 20 | |
| 21 | #ifndef GPRS_RLCMAC_H |
| 22 | #define GPRS_RLCMAC_H |
| 23 | |
Andreas Eversberg | 8b761a3 | 2012-07-20 21:50:31 +0200 | [diff] [blame] | 24 | #ifdef __cplusplus |
Ivan Kluchnikov | 835f91e | 2012-04-30 18:00:36 +0400 | [diff] [blame] | 25 | #include <bitvector.h> |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 26 | #include <gsm_rlcmac.h> |
Ivan Kluchnikov | 61a33f7 | 2012-04-12 15:22:06 +0400 | [diff] [blame] | 27 | #include <gsm_timer.h> |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 28 | |
| 29 | extern "C" { |
| 30 | #include <osmocom/core/linuxlist.h> |
Ivan Kluchnikov | 61a33f7 | 2012-04-12 15:22:06 +0400 | [diff] [blame] | 31 | #include <osmocom/core/timer.h> |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 32 | } |
Andreas Eversberg | 8b761a3 | 2012-07-20 21:50:31 +0200 | [diff] [blame] | 33 | #endif |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 34 | |
Andreas Eversberg | b83e2a7 | 2012-10-07 15:26:00 +0200 | [diff] [blame] | 35 | /* generate a diagram for debugging timing issues */ |
| 36 | //#define DEBUG_DIAGRAM |
| 37 | |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 38 | /* This special feature will delay assignment of downlink TBF by one second, |
| 39 | * in case there is already a TBF. |
| 40 | * This is usefull to debug downlink establishment during packet idle mode. |
| 41 | */ |
| 42 | //#define DEBUG_DL_ASS_IDLE |
Ivan Kluchnikov | c5d8c27 | 2012-06-04 21:55:02 +0400 | [diff] [blame] | 43 | |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 44 | |
| 45 | struct gprs_rlcmac_tbf; |
Holger Hans Peter Freyther | b6acfda | 2013-10-17 19:41:11 +0200 | [diff] [blame] | 46 | struct gprs_rlcmac_bts; |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 47 | |
Andreas Eversberg | 8b761a3 | 2012-07-20 21:50:31 +0200 | [diff] [blame] | 48 | #ifdef __cplusplus |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 49 | /* |
Andreas Eversberg | 2b91464 | 2012-07-19 13:06:26 +0200 | [diff] [blame] | 50 | * paging entry |
| 51 | */ |
| 52 | struct gprs_rlcmac_paging { |
| 53 | struct llist_head list; |
| 54 | uint8_t chan_needed; |
| 55 | uint8_t identity_lv[9]; |
| 56 | }; |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 57 | |
Andreas Eversberg | 07e97cf | 2012-08-07 16:00:56 +0200 | [diff] [blame] | 58 | /* |
| 59 | * single block allocation entry |
| 60 | */ |
| 61 | struct gprs_rlcmac_sba { |
| 62 | struct llist_head list; |
| 63 | uint8_t trx; |
| 64 | uint8_t ts; |
| 65 | uint32_t fn; |
| 66 | uint8_t ta; |
| 67 | }; |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 68 | |
Andreas Eversberg | 3b1332c | 2012-10-03 14:20:53 +0200 | [diff] [blame] | 69 | /* |
| 70 | * coding scheme info |
| 71 | */ |
| 72 | struct gprs_rlcmac_cs { |
| 73 | uint8_t block_length; |
| 74 | uint8_t block_data; |
| 75 | uint8_t block_payload; |
| 76 | }; |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 77 | |
Andreas Eversberg | 3b1332c | 2012-10-03 14:20:53 +0200 | [diff] [blame] | 78 | extern struct gprs_rlcmac_cs gprs_rlcmac_cs[]; |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 79 | |
Andreas Eversberg | b83e2a7 | 2012-10-07 15:26:00 +0200 | [diff] [blame] | 80 | #ifdef DEBUG_DIAGRAM |
| 81 | void debug_diagram(int diag, const char *format, ...); |
| 82 | #else |
| 83 | #define debug_diagram(a, b, args...) ; |
| 84 | #endif |
| 85 | |
Andreas Eversberg | 050ace2 | 2013-03-16 16:22:02 +0100 | [diff] [blame] | 86 | int gprs_rlcmac_received_lost(struct gprs_rlcmac_tbf *tbf, uint16_t received, |
| 87 | uint16_t lost); |
| 88 | |
| 89 | int gprs_rlcmac_lost_rep(struct gprs_rlcmac_tbf *tbf); |
| 90 | |
| 91 | int gprs_rlcmac_meas_rep(Packet_Measurement_Report_t *pmr); |
| 92 | |
| 93 | int gprs_rlcmac_rssi(struct gprs_rlcmac_tbf *tbf, int8_t rssi); |
| 94 | |
| 95 | int gprs_rlcmac_rssi_rep(struct gprs_rlcmac_tbf *tbf); |
| 96 | |
| 97 | int gprs_rlcmac_dl_bw(struct gprs_rlcmac_tbf *tbf, uint16_t octets); |
| 98 | |
Holger Hans Peter Freyther | 173a240 | 2013-10-16 21:47:45 +0200 | [diff] [blame] | 99 | int sba_alloc(struct gprs_rlcmac_bts *bts, uint8_t *_trx, uint8_t *_ts, uint32_t *_fn, uint8_t ta); |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 100 | |
Andreas Eversberg | 07e97cf | 2012-08-07 16:00:56 +0200 | [diff] [blame] | 101 | struct gprs_rlcmac_sba *sba_find(uint8_t trx, uint8_t ts, uint32_t fn); |
| 102 | |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 103 | /* TS 44.060 Section 10.4.7 Table 10.4.7.1: Payload Type field */ |
| 104 | enum gprs_rlcmac_block_type { |
| 105 | GPRS_RLCMAC_DATA_BLOCK = 0x0, |
| 106 | GPRS_RLCMAC_CONTROL_BLOCK = 0x1, |
| 107 | GPRS_RLCMAC_CONTROL_BLOCK_OPT = 0x2, |
| 108 | GPRS_RLCMAC_RESERVED = 0x3 |
| 109 | }; |
| 110 | |
Holger Hans Peter Freyther | 698b612 | 2013-10-17 13:44:18 +0200 | [diff] [blame] | 111 | int gprs_rlcmac_rcv_block(struct gprs_rlcmac_bts *bts, |
| 112 | uint8_t trx, uint8_t ts, uint8_t *data, uint8_t len, |
Andreas Eversberg | 570b44b | 2013-03-16 16:15:01 +0100 | [diff] [blame] | 113 | uint32_t fn, int8_t rssi); |
Ivan Kluchnikov | a9e6dc5 | 2012-06-17 08:30:06 +0400 | [diff] [blame] | 114 | |
Holger Hans Peter Freyther | ee7a535 | 2013-10-17 15:41:36 +0200 | [diff] [blame] | 115 | int write_immediate_assignment( |
| 116 | struct gprs_rlcmac_bts *bts, |
| 117 | bitvec * dest, uint8_t downlink, uint8_t ra, |
Andreas Eversberg | 07e97cf | 2012-08-07 16:00:56 +0200 | [diff] [blame] | 118 | uint32_t ref_fn, uint8_t ta, uint16_t arfcn, uint8_t ts, uint8_t tsc, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 119 | uint8_t tfi, uint8_t usf, uint32_t tlli, uint8_t polling, |
Andreas Eversberg | afdd9e1 | 2012-10-07 17:08:55 +0200 | [diff] [blame] | 120 | uint32_t fn, uint8_t single_block, uint8_t alpha, uint8_t gamma, |
| 121 | int8_t ta_idx); |
Ivan Kluchnikov | cf7b3a5 | 2012-06-26 16:54:22 +0400 | [diff] [blame] | 122 | |
Holger Hans Peter Freyther | 485860c | 2013-10-17 15:38:23 +0200 | [diff] [blame] | 123 | void write_packet_uplink_assignment( |
| 124 | struct gprs_rlcmac_bts *bts, |
| 125 | bitvec * dest, uint8_t old_tfi, |
Andreas Eversberg | b0c7ea7 | 2012-07-13 14:46:03 +0200 | [diff] [blame] | 126 | uint8_t old_downlink, uint32_t tlli, uint8_t use_tlli, |
Andreas Eversberg | aafcbbb | 2012-09-27 09:20:45 +0200 | [diff] [blame] | 127 | struct gprs_rlcmac_tbf *tbf, uint8_t poll, uint8_t alpha, |
Andreas Eversberg | afdd9e1 | 2012-10-07 17:08:55 +0200 | [diff] [blame] | 128 | uint8_t gamma, int8_t ta_idx); |
Ivan Kluchnikov | a9e6dc5 | 2012-06-17 08:30:06 +0400 | [diff] [blame] | 129 | |
Ivan Kluchnikov | ef7f28c | 2012-07-12 14:49:15 +0400 | [diff] [blame] | 130 | void write_packet_downlink_assignment(RlcMacDownlink_t * block, uint8_t old_tfi, |
Andreas Eversberg | aafcbbb | 2012-09-27 09:20:45 +0200 | [diff] [blame] | 131 | uint8_t old_downlink, struct gprs_rlcmac_tbf *tbf, uint8_t poll, |
Andreas Eversberg | afdd9e1 | 2012-10-07 17:08:55 +0200 | [diff] [blame] | 132 | uint8_t alpha, uint8_t gamma, int8_t ta_idx, uint8_t ta_ts); |
Andreas Eversberg | b0c7ea7 | 2012-07-13 14:46:03 +0200 | [diff] [blame] | 133 | |
| 134 | |
Ivan Kluchnikov | a9e6dc5 | 2012-06-17 08:30:06 +0400 | [diff] [blame] | 135 | |
Holger Hans Peter Freyther | ae947fc | 2013-10-17 13:29:03 +0200 | [diff] [blame] | 136 | void write_packet_uplink_ack(struct gprs_rlcmac_bts *bts, RlcMacDownlink_t * block, struct gprs_rlcmac_tbf *tbf, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 137 | uint8_t final); |
Ivan Kluchnikov | a9e6dc5 | 2012-06-17 08:30:06 +0400 | [diff] [blame] | 138 | |
Andreas Eversberg | 3e372d5 | 2012-07-06 09:28:15 +0200 | [diff] [blame] | 139 | int gprs_rlcmac_tx_ul_ud(gprs_rlcmac_tbf *tbf); |
Ivan Kluchnikov | a9e6dc5 | 2012-06-17 08:30:06 +0400 | [diff] [blame] | 140 | |
Holger Hans Peter Freyther | 344ff48 | 2013-10-17 12:01:04 +0200 | [diff] [blame] | 141 | int gprs_rlcmac_poll_timeout(struct gprs_rlcmac_bts *bts, struct gprs_rlcmac_tbf *tbf); |
Andreas Eversberg | 0aed654 | 2012-06-23 10:33:16 +0200 | [diff] [blame] | 142 | |
Andreas Eversberg | a004e6a | 2013-05-13 16:45:21 +0200 | [diff] [blame] | 143 | int gprs_rlcmac_sba_timeout(struct gprs_rlcmac_sba *sba); |
| 144 | |
Holger Hans Peter Freyther | b0250eb | 2013-10-17 13:46:19 +0200 | [diff] [blame] | 145 | int gprs_rlcmac_rcv_rach(struct gprs_rlcmac_bts *bts, uint8_t ra, uint32_t Fn, int16_t qta); |
Ivan Kluchnikov | 5310d45 | 2012-04-17 22:00:31 +0400 | [diff] [blame] | 146 | |
Holger Hans Peter Freyther | 8d7a632 | 2013-10-17 15:23:49 +0200 | [diff] [blame] | 147 | int gprs_rlcmac_rcv_control_block(struct gprs_rlcmac_bts *bts, |
| 148 | bitvec *rlc_block, uint8_t trx, uint8_t ts, |
Andreas Eversberg | b0c7ea7 | 2012-07-13 14:46:03 +0200 | [diff] [blame] | 149 | uint32_t fn); |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 150 | |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 151 | struct msgb *gprs_rlcmac_send_packet_uplink_assignment( |
Holger Hans Peter Freyther | d507ce6 | 2013-10-17 15:32:37 +0200 | [diff] [blame] | 152 | struct gprs_rlcmac_bts *bts, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 153 | struct gprs_rlcmac_tbf *tbf, uint32_t fn); |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 154 | |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 155 | struct msgb *gprs_rlcmac_send_packet_downlink_assignment( |
Holger Hans Peter Freyther | 9f521cd | 2013-10-17 13:48:11 +0200 | [diff] [blame] | 156 | struct gprs_rlcmac_bts *bts, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 157 | struct gprs_rlcmac_tbf *tbf, uint32_t fn); |
Ivan Kluchnikov | c320d86 | 2012-03-18 15:04:48 +0400 | [diff] [blame] | 158 | |
Holger Hans Peter Freyther | 344ff48 | 2013-10-17 12:01:04 +0200 | [diff] [blame] | 159 | void gprs_rlcmac_trigger_downlink_assignment(struct gprs_rlcmac_bts *bts, |
| 160 | struct gprs_rlcmac_tbf *tbf, |
Holger Hans Peter Freyther | 52c911b | 2013-08-24 18:30:54 +0200 | [diff] [blame] | 161 | struct gprs_rlcmac_tbf *old_tbf, const char *imsi); |
Ivan Kluchnikov | c7e7f68 | 2012-06-29 22:53:15 +0400 | [diff] [blame] | 162 | |
Holger Hans Peter Freyther | 344ff48 | 2013-10-17 12:01:04 +0200 | [diff] [blame] | 163 | int gprs_rlcmac_downlink_ack(struct gprs_rlcmac_bts *bts, |
| 164 | struct gprs_rlcmac_tbf *tbf, uint8_t final, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 165 | uint8_t ssn, uint8_t *rbb); |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 166 | |
Andreas Eversberg | 8c3680d | 2012-10-08 12:30:56 +0200 | [diff] [blame] | 167 | int gprs_rlcmac_paging_request(uint8_t *ptmsi, uint16_t ptmsi_len, |
| 168 | const char *imsi); |
| 169 | |
Andreas Eversberg | 2b91464 | 2012-07-19 13:06:26 +0200 | [diff] [blame] | 170 | unsigned write_packet_paging_request(bitvec * dest); |
| 171 | |
| 172 | unsigned write_repeated_page_info(bitvec * dest, unsigned& wp, uint8_t len, |
| 173 | uint8_t *identity, uint8_t chan_needed); |
| 174 | |
Holger Hans Peter Freyther | 698b612 | 2013-10-17 13:44:18 +0200 | [diff] [blame] | 175 | int gprs_rlcmac_rcv_data_block_acknowledged(struct gprs_rlcmac_bts *bts, |
| 176 | uint8_t trx, uint8_t ts, |
Andreas Eversberg | 570b44b | 2013-03-16 16:15:01 +0100 | [diff] [blame] | 177 | uint8_t *data, uint8_t len, int8_t rssi); |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 178 | |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 179 | struct msgb *gprs_rlcmac_send_data_block_acknowledged( |
Holger Hans Peter Freyther | 4ffc260 | 2013-10-17 15:21:10 +0200 | [diff] [blame] | 180 | struct gprs_rlcmac_bts *bts, |
Andreas Eversberg | 592e04a | 2012-07-15 06:25:37 +0200 | [diff] [blame] | 181 | struct gprs_rlcmac_tbf *tbf, uint32_t fn, uint8_t ts); |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 182 | |
Holger Hans Peter Freyther | ae947fc | 2013-10-17 13:29:03 +0200 | [diff] [blame] | 183 | struct msgb *gprs_rlcmac_send_uplink_ack(struct gprs_rlcmac_bts *bts, |
| 184 | struct gprs_rlcmac_tbf *tbf, |
Andreas Eversberg | 5dac2f0 | 2012-06-27 15:52:04 +0200 | [diff] [blame] | 185 | uint32_t fn); |
Ivan Kluchnikov | 9c795ab | 2012-05-24 23:12:59 +0400 | [diff] [blame] | 186 | |
Holger Hans Peter Freyther | b19d726 | 2013-10-17 18:12:18 +0200 | [diff] [blame] | 187 | int gprs_rlcmac_rcv_rts_block(struct gprs_rlcmac_bts *bts, |
| 188 | uint8_t trx, uint8_t ts, uint16_t arfcn, |
Andreas Eversberg | e6228b3 | 2012-07-03 13:36:03 +0200 | [diff] [blame] | 189 | uint32_t fn, uint8_t block_nr); |
| 190 | |
Andreas Eversberg | a9be154 | 2012-09-27 09:23:24 +0200 | [diff] [blame] | 191 | int gprs_rlcmac_imm_ass_cnf(uint8_t *data, uint32_t fn); |
| 192 | |
Holger Hans Peter Freyther | 1af73f6 | 2013-10-17 15:51:39 +0200 | [diff] [blame] | 193 | int gprs_rlcmac_add_paging(struct gprs_rlcmac_bts *bts, uint8_t chan_needed, uint8_t *identity_lv); |
Andreas Eversberg | 2b91464 | 2012-07-19 13:06:26 +0200 | [diff] [blame] | 194 | |
| 195 | struct gprs_rlcmac_paging *gprs_rlcmac_dequeue_paging( |
| 196 | struct gprs_rlcmac_pdch *pdch); |
| 197 | |
| 198 | struct msgb *gprs_rlcmac_send_packet_paging_request( |
| 199 | struct gprs_rlcmac_pdch *pdch); |
Andreas Eversberg | a1503fa | 2012-07-22 08:58:09 +0200 | [diff] [blame] | 200 | |
Andreas Eversberg | a004e6a | 2013-05-13 16:45:21 +0200 | [diff] [blame] | 201 | int remember_timing_advance(uint32_t tlli, uint8_t ta); |
| 202 | |
| 203 | int recall_timing_advance(uint32_t tlli); |
| 204 | |
| 205 | int flush_timing_advance(void); |
| 206 | |
Andreas Eversberg | a1503fa | 2012-07-22 08:58:09 +0200 | [diff] [blame] | 207 | extern "C" { |
| 208 | #endif |
Holger Hans Peter Freyther | b67a8a3 | 2013-07-28 18:55:14 +0200 | [diff] [blame] | 209 | int alloc_algorithm_a(struct gprs_rlcmac_bts *bts, |
| 210 | struct gprs_rlcmac_tbf *old_tbf, |
Andreas Eversberg | f01929b | 2012-10-08 12:40:49 +0200 | [diff] [blame] | 211 | struct gprs_rlcmac_tbf *tbf, uint32_t cust, uint8_t single); |
Andreas Eversberg | a1503fa | 2012-07-22 08:58:09 +0200 | [diff] [blame] | 212 | |
Holger Hans Peter Freyther | b67a8a3 | 2013-07-28 18:55:14 +0200 | [diff] [blame] | 213 | int alloc_algorithm_b(struct gprs_rlcmac_bts *bts, |
| 214 | struct gprs_rlcmac_tbf *old_tbf, |
Andreas Eversberg | f01929b | 2012-10-08 12:40:49 +0200 | [diff] [blame] | 215 | struct gprs_rlcmac_tbf *tbf, uint32_t cust, uint8_t single); |
Andreas Eversberg | a1503fa | 2012-07-22 08:58:09 +0200 | [diff] [blame] | 216 | #ifdef __cplusplus |
| 217 | } |
Andreas Eversberg | 8b761a3 | 2012-07-20 21:50:31 +0200 | [diff] [blame] | 218 | #endif |
Andreas Eversberg | 2b91464 | 2012-07-19 13:06:26 +0200 | [diff] [blame] | 219 | |
Ivan Kluchnikov | 8ee6051 | 2012-03-05 19:24:57 +0400 | [diff] [blame] | 220 | #endif // GPRS_RLCMAC_H |