Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 1 | /* mslot_class.c |
| 2 | * |
| 3 | * Copyright (C) 2012 Ivan Klyuchnikov |
| 4 | * Copyright (C) 2012 Andreas Eversberg <jolly@eversberg.eu> |
| 5 | * Copyright (C) 2013 by Holger Hans Peter Freyther |
| 6 | * Copyright (C) 2017 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or |
| 9 | * modify it under the terms of the GNU General Public License |
| 10 | * as published by the Free Software Foundation; either version 2 |
| 11 | * of the License, or (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License |
| 19 | * along with this program; if not, write to the Free Software |
| 20 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 21 | */ |
| 22 | |
| 23 | #include <mslot_class.h> |
Max | f633b8d | 2018-01-31 15:28:53 +0100 | [diff] [blame] | 24 | #include <gprs_debug.h> |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 25 | |
Max | 77988d4 | 2018-02-19 18:00:38 +0100 | [diff] [blame] | 26 | #include <osmocom/core/bits.h> |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 27 | #include <osmocom/core/utils.h> |
| 28 | #include <osmocom/core/logging.h> |
| 29 | |
| 30 | #include <errno.h> |
| 31 | |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 32 | /* 3GPP TS 45.002 Annex B Table B.1 */ |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 33 | |
| 34 | struct gprs_ms_multislot_class { |
| 35 | uint8_t rx, tx, sum; /* Maximum Number of Slots: RX, Tx, Sum Rx+Tx */ |
| 36 | uint8_t ta, tb, ra, rb; /* Minimum Number of Slots */ |
| 37 | uint8_t type; /* Type of Mobile */ |
| 38 | }; |
| 39 | |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 40 | static const struct gprs_ms_multislot_class gprs_ms_multislot_class[] = { |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 41 | /* M-S Class | Max # of slots | Min # of slots | Type */ |
| 42 | /* | Rx Tx Sum | Tta Ttb Tra Trb | */ |
| 43 | /* N/A */ { MS_NA, MS_NA, MS_NA, MS_NA, MS_NA, MS_NA, MS_NA, MS_NA }, |
| 44 | /* 1 */ { 1, 1, 2, 3, 2, 4, 2, 1 }, |
| 45 | /* 2 */ { 2, 1, 3, 3, 2, 3, 1, 1 }, |
| 46 | /* 3 */ { 2, 2, 3, 3, 2, 3, 1, 1 }, |
| 47 | /* 4 */ { 3, 1, 4, 3, 1, 3, 1, 1 }, |
| 48 | /* 5 */ { 2, 2, 4, 3, 1, 3, 1, 1 }, |
| 49 | /* 6 */ { 3, 2, 4, 3, 1, 3, 1, 1 }, |
| 50 | /* 7 */ { 3, 3, 4, 3, 1, 3, 1, 1 }, |
| 51 | /* 8 */ { 4, 1, 5, 3, 1, 2, 1, 1 }, |
| 52 | /* 9 */ { 3, 2, 5, 3, 1, 2, 1, 1 }, |
| 53 | /* 10 */ { 4, 2, 5, 3, 1, 2, 1, 1 }, |
| 54 | /* 11 */ { 4, 3, 5, 3, 1, 2, 1, 1 }, |
| 55 | /* 12 */ { 4, 4, 5, 2, 1, 2, 1, 1 }, |
| 56 | /* 13 */ { 3, 3, MS_NA, MS_NA, MS_A, 3, MS_A, 2 }, |
| 57 | /* 14 */ { 4, 4, MS_NA, MS_NA, MS_A, 3, MS_A, 2 }, |
| 58 | /* 15 */ { 5, 5, MS_NA, MS_NA, MS_A, 3, MS_A, 2 }, |
| 59 | /* 16 */ { 6, 6, MS_NA, MS_NA, MS_A, 2, MS_A, 2 }, |
| 60 | /* 17 */ { 7, 7, MS_NA, MS_NA, MS_A, 1, 0, 2 }, |
| 61 | /* 18 */ { 8, 8, MS_NA, MS_NA, 0, 0, 0, 2 }, |
| 62 | /* 19 */ { 6, 2, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 63 | /* 20 */ { 6, 3, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 64 | /* 21 */ { 6, 4, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 65 | /* 22 */ { 6, 4, MS_NA, 2, MS_B, 2, MS_C, 1 }, |
| 66 | /* 23 */ { 6, 6, MS_NA, 2, MS_B, 2, MS_C, 1 }, |
| 67 | /* 24 */ { 8, 2, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 68 | /* 25 */ { 8, 3, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 69 | /* 26 */ { 8, 4, MS_NA, 3, MS_B, 2, MS_C, 1 }, |
| 70 | /* 27 */ { 8, 4, MS_NA, 2, MS_B, 2, MS_C, 1 }, |
| 71 | /* 28 */ { 8, 6, MS_NA, 2, MS_B, 2, MS_C, 1 }, |
| 72 | /* 29 */ { 8, 8, MS_NA, 2, MS_B, 2, MS_C, 1 }, |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 73 | /* 30 */ { 5, 1, 6, 2, 1, 1, 1, 1 }, |
| 74 | /* 31 */ { 5, 2, 6, 2, 1, 1, 1, 1 }, |
| 75 | /* 32 */ { 5, 3, 6, 2, 1, 1, 1, 1 }, |
| 76 | /* 33 */ { 5, 4, 6, 2, 1, 1, 1, 1 }, |
| 77 | /* 34 */ { 5, 5, 6, 2, 1, 1, 1, 1 }, |
| 78 | /* 35 */ { 5, 1, 6, 2, 1, MS_TO, 1, 1 }, |
| 79 | /* 36 */ { 5, 2, 6, 2, 1, MS_TO, 1, 1 }, |
| 80 | /* 37 */ { 5, 3, 6, 2, 1, MS_TO, 1, 1 }, |
| 81 | /* 38 */ { 5, 4, 6, 2, 1, MS_TO, 1, 1 }, |
| 82 | /* 39 */ { 5, 5, 6, 2, 1, MS_TO, 1, 1 }, |
| 83 | /* 40 */ { 6, 1, 7, 1, 1, 1, MS_TO, 1 }, |
| 84 | /* 41 */ { 6, 2, 7, 1, 1, 1, MS_TO, 1 }, |
| 85 | /* 42 */ { 6, 3, 7, 1, 1, 1, MS_TO, 1 }, |
| 86 | /* 43 */ { 6, 4, 7, 1, 1, 1, MS_TO, 1 }, |
| 87 | /* 44 */ { 6, 5, 7, 1, 1, 1, MS_TO, 1 }, |
| 88 | /* 45 */ { 6, 6, 7, 1, 1, 1, MS_TO, 1 }, |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 89 | }; |
| 90 | |
| 91 | static inline const struct gprs_ms_multislot_class *get_mslot_table(uint8_t ms_cl) |
| 92 | { |
| 93 | uint8_t index = ms_cl ? ms_cl : DEFAULT_MSLOT_CLASS; |
| 94 | |
| 95 | if (ms_cl >= ARRAY_SIZE(gprs_ms_multislot_class)) |
| 96 | index = 0; |
| 97 | |
| 98 | return &gprs_ms_multislot_class[index]; |
| 99 | } |
| 100 | |
Max | 327e121 | 2017-11-21 13:01:19 +0100 | [diff] [blame] | 101 | uint8_t mslot_class_max() |
| 102 | { |
| 103 | return ARRAY_SIZE(gprs_ms_multislot_class); |
| 104 | } |
| 105 | |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 106 | uint8_t mslot_class_get_ta(uint8_t ms_cl) |
| 107 | { |
| 108 | return get_mslot_table(ms_cl)->ta; |
| 109 | } |
| 110 | |
| 111 | /* TODO: Set it to 1 if FH is implemented and enabled |
| 112 | * MS_A and MS_B are 0 iff FH is disabled and there is no Tx/Rx change. |
| 113 | * This is never the case with the current implementation, so 1 will always be used. */ |
| 114 | uint8_t mslot_class_get_tb(uint8_t ms_cl) |
| 115 | { |
| 116 | const struct gprs_ms_multislot_class *t = get_mslot_table(ms_cl); |
| 117 | |
| 118 | switch (t->tb) { |
| 119 | case MS_A: |
| 120 | return 0; |
| 121 | case MS_B: |
| 122 | return 1; |
| 123 | default: |
| 124 | return t->tb; |
| 125 | } |
| 126 | } |
| 127 | |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 128 | uint8_t mslot_class_get_ra(uint8_t ms_cl, uint8_t ta) |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 129 | { |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 130 | const struct gprs_ms_multislot_class *t = get_mslot_table(ms_cl); |
| 131 | |
| 132 | switch (t->ra) { |
| 133 | case MS_TO: |
| 134 | return ta + 1; |
| 135 | default: |
| 136 | return t->ra; |
| 137 | } |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 138 | } |
| 139 | |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 140 | uint8_t mslot_class_get_rb(uint8_t ms_cl, uint8_t ta) |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 141 | { |
| 142 | const struct gprs_ms_multislot_class *t = get_mslot_table(ms_cl); |
| 143 | |
| 144 | switch (t->rb) { |
| 145 | case MS_A: |
| 146 | return 0; |
| 147 | case MS_C: |
| 148 | return 1; |
Max | 01bd0cc | 2018-01-23 20:58:49 +0100 | [diff] [blame] | 149 | case MS_TO: |
| 150 | return ta; |
Max | 842d781 | 2017-11-01 18:11:24 +0100 | [diff] [blame] | 151 | default: |
| 152 | return t->rb; |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | uint8_t mslot_class_get_tx(uint8_t ms_cl) |
| 157 | { |
| 158 | return get_mslot_table(ms_cl)->tx; |
| 159 | } |
| 160 | |
| 161 | uint8_t mslot_class_get_rx(uint8_t ms_cl) |
| 162 | { |
| 163 | return get_mslot_table(ms_cl)->rx; |
| 164 | } |
| 165 | |
| 166 | uint8_t mslot_class_get_sum(uint8_t ms_cl) |
| 167 | { |
| 168 | return get_mslot_table(ms_cl)->sum; |
| 169 | } |
| 170 | |
| 171 | uint8_t mslot_class_get_type(uint8_t ms_cl) |
| 172 | { |
| 173 | return get_mslot_table(ms_cl)->type; |
| 174 | } |
Max | f633b8d | 2018-01-31 15:28:53 +0100 | [diff] [blame] | 175 | |
| 176 | /*! Fill in RX mask table for a given MS Class |
| 177 | * |
| 178 | * \param[in] ms_cl MS Class pointer |
| 179 | * \param[in] num_tx Number of TX slots to consider |
| 180 | * \param[out] rx_mask RX mask table |
| 181 | */ |
| 182 | void mslot_fill_rx_mask(uint8_t mslot_class, uint8_t num_tx, uint8_t *rx_mask) |
| 183 | { |
| 184 | static const char *digit[10] = { "0","1","2","3","4","5","6","7","8","9" }; |
| 185 | uint8_t Tx = mslot_class_get_tx(mslot_class), /* Max number of Tx slots */ |
| 186 | Sum = mslot_class_get_sum(mslot_class), /* Max number of Tx + Rx slots */ |
| 187 | Type = mslot_class_get_type(mslot_class), /* Type of Mobile */ |
| 188 | Tta = mslot_class_get_ta(mslot_class), /* Minimum number of slots */ |
| 189 | Ttb = mslot_class_get_tb(mslot_class), |
| 190 | /* FIXME: use actual TA offset for computation - make sure to adjust "1 + MS_TO" accordingly |
| 191 | see also "Offset required" bit in 3GPP TS 24.008 ยง10.5.1.7 */ |
| 192 | Tra = mslot_class_get_ra(mslot_class, 0), |
| 193 | Trb = mslot_class_get_rb(mslot_class, 0); |
| 194 | |
| 195 | if (num_tx == 1) /* it's enough to log this once per TX slot set iteration */ |
| 196 | LOGP(DRLCMAC, LOGL_DEBUG, |
| 197 | "Rx=%d Tx=%d Sum Rx+Tx=%s, Tta=%s Ttb=%d, Tra=%d Trb=%d, Type=%d\n", |
| 198 | mslot_class_get_rx(mslot_class), Tx, |
| 199 | (Sum == MS_NA) ? "N/A" : digit[Sum], |
| 200 | (Tta == MS_NA) ? "N/A" : digit[Tta], Ttb, Tra, Trb, Type); |
| 201 | |
| 202 | if (Type == 1) { |
| 203 | rx_mask[MASK_TT] = (0x100 >> OSMO_MAX(Ttb, Tta)) - 1; |
| 204 | rx_mask[MASK_TT] &= ~((1 << (Trb + num_tx)) - 1); |
| 205 | rx_mask[MASK_TR] = (0x100 >> Ttb) - 1; |
| 206 | rx_mask[MASK_TR] &= ~((1 << (OSMO_MAX(Trb, Tra) + num_tx)) - 1); |
| 207 | } else { |
| 208 | /* Class type 2 MS have independant RX and TX */ |
| 209 | rx_mask[MASK_TT] = 0xff; |
| 210 | rx_mask[MASK_TR] = 0xff; |
| 211 | } |
| 212 | |
| 213 | rx_mask[MASK_TT] = (rx_mask[MASK_TT] << 3) | (rx_mask[MASK_TT] >> 5); |
| 214 | rx_mask[MASK_TR] = (rx_mask[MASK_TR] << 3) | (rx_mask[MASK_TR] >> 5); |
| 215 | } |
Max | adca67b | 2018-01-31 15:22:36 +0100 | [diff] [blame] | 216 | |
| 217 | /* look for USF, don't use USF=7 */ |
| 218 | int8_t find_free_usf(uint8_t usf_map) |
| 219 | { |
| 220 | uint8_t usf; |
| 221 | |
| 222 | if (usf_map == (1 << 7) - 1) |
| 223 | return -1; |
| 224 | |
| 225 | for (usf = 0; usf < 7; usf++) { |
| 226 | if (!(usf_map & (1 << usf))) |
| 227 | return usf; |
| 228 | } |
| 229 | |
| 230 | return -1; |
| 231 | } |
Max | 0cc7212 | 2018-01-31 17:00:06 +0100 | [diff] [blame] | 232 | |
Max | c5407c7 | 2018-02-05 16:11:36 +0100 | [diff] [blame] | 233 | /* look for USF, don't use USF=7 */ |
| 234 | int8_t find_free_tfi(uint32_t tfi_map) |
| 235 | { |
| 236 | int8_t tfi; |
| 237 | |
| 238 | if (tfi_map == NO_FREE_TFI) |
| 239 | return -1; |
| 240 | |
| 241 | for (tfi = 0; tfi < 32; tfi++) { |
Neels Hofmeyr | 8b4bd46 | 2018-03-26 23:24:14 +0200 | [diff] [blame] | 242 | if (!(tfi_map & (((uint32_t)1) << tfi))) |
Max | c5407c7 | 2018-02-05 16:11:36 +0100 | [diff] [blame] | 243 | return tfi; |
| 244 | } |
| 245 | |
| 246 | return -1; |
| 247 | } |
| 248 | |
Max | 0cc7212 | 2018-01-31 17:00:06 +0100 | [diff] [blame] | 249 | void masked_override_with(char *buf, uint8_t mask, char set_char) |
| 250 | { |
| 251 | int i; |
| 252 | for (i = 0; mask; i++, mask >>= 1) |
| 253 | if (mask & 1) |
| 254 | buf[i] = set_char; |
| 255 | } |
Max | 77988d4 | 2018-02-19 18:00:38 +0100 | [diff] [blame] | 256 | |
| 257 | void ts_format(char *buf, uint8_t dl_mask, uint8_t ul_mask) |
| 258 | { |
| 259 | snprintf(buf, 9, OSMO_BIT_SPEC, OSMO_BIT_PRINT_EX(dl_mask, 'D')); |
| 260 | masked_override_with(buf, ul_mask, 'U'); |
| 261 | masked_override_with(buf, ul_mask & dl_mask, 'C'); |
| 262 | } |
Max | 731e2bb | 2018-02-05 16:15:30 +0100 | [diff] [blame] | 263 | |
| 264 | uint16_t mslot_wrap_window(uint16_t win) |
| 265 | { |
| 266 | return (win | win >> 8) & 0xFF; |
| 267 | } |
| 268 | |
| 269 | bool mslot_test_and_set_bit(uint32_t *bits, size_t elem) |
| 270 | { |
Neels Hofmeyr | f753814 | 2018-03-26 23:24:14 +0200 | [diff] [blame] | 271 | bool was_set = bits[elem/32] & (((uint32_t)1) << (elem % 32)); |
| 272 | bits[elem/32] |= (((uint32_t)1) << (elem % 32)); |
Max | 731e2bb | 2018-02-05 16:15:30 +0100 | [diff] [blame] | 273 | |
| 274 | return was_set; |
| 275 | } |
| 276 | |
| 277 | /*! Filter out bad slots |
| 278 | * |
| 279 | * \param[in] mask TS selection mask |
| 280 | * \param[in] ul_slots set of UL timeslots |
| 281 | * \param[in] dl_slots set of DL timeslots |
| 282 | * \param[in] rx_valid_win Mask for valid RX window value |
| 283 | * \returns negative error code or RX window on success |
| 284 | */ |
| 285 | int16_t mslot_filter_bad(uint8_t mask, uint8_t ul_slots, uint8_t dl_slots, uint16_t rx_valid_win) |
| 286 | { |
| 287 | uint8_t rx_good; |
| 288 | uint16_t rx_bad = (uint16_t)(0xFF & ~mask) << ul_slots; |
| 289 | |
| 290 | /* TODO: CHECK this calculation -> separate function for unit testing */ |
| 291 | rx_bad = (rx_bad | (rx_bad >> 8)) & 0xFF; |
| 292 | rx_good = dl_slots & ~rx_bad; |
| 293 | if (!rx_good) |
| 294 | return -1; |
| 295 | |
| 296 | return rx_good & rx_valid_win; |
| 297 | } |