Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 1 | /* gprs_coding_scheme.cpp |
| 2 | * |
| 3 | * Copyright (C) 2015 by Sysmocom s.f.m.c. GmbH |
| 4 | * Author: Jacob Erlbeck <jerlbeck@sysmocom.de> |
| 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 | |
| 22 | #include "gprs_coding_scheme.h" |
| 23 | |
Aravind Sirsikar | 9149552 | 2016-07-12 14:17:12 +0530 | [diff] [blame] | 24 | /* |
| 25 | * 44.060 Table 8.1.1.1 and Table 8.1.1.2 |
| 26 | * It has 3 level indexing. 0th level is ARQ type |
| 27 | * 1st level is Original MCS( index 0 corresponds to MCS1 and so on) |
| 28 | * 2nd level is MS MCS (index 0 corresponds to MCS1 and so on) |
| 29 | */ |
| 30 | enum GprsCodingScheme::Scheme GprsCodingScheme::egprs_mcs_retx_tbl[MAX_NUM_ARQ] |
| 31 | [MAX_NUM_MCS][MAX_NUM_MCS] = { |
| 32 | { |
| 33 | {MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1}, |
| 34 | {MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2}, |
| 35 | {MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3}, |
| 36 | {MCS1, MCS1, MCS1, MCS4, MCS4, MCS4, MCS4, MCS4, MCS4}, |
| 37 | {MCS2, MCS2, MCS2, MCS2, MCS5, MCS5, MCS7, MCS7, MCS7}, |
| 38 | {MCS3, MCS3, MCS3, MCS3, MCS3, MCS6, MCS6, MCS6, MCS9}, |
| 39 | {MCS2, MCS2, MCS2, MCS2, MCS5, MCS5, MCS7, MCS7, MCS7}, |
| 40 | {MCS3, MCS3, MCS3, MCS3, MCS3, MCS6, MCS6, MCS8, MCS8}, |
| 41 | {MCS3, MCS3, MCS3, MCS3, MCS3, MCS6, MCS6, MCS6, MCS9} |
| 42 | }, |
| 43 | { |
| 44 | {MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1, MCS1}, |
| 45 | {MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2, MCS2}, |
| 46 | {MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3, MCS3}, |
| 47 | {MCS4, MCS4, MCS4, MCS4, MCS4, MCS4, MCS4, MCS4, MCS4}, |
| 48 | {MCS5, MCS5, MCS5, MCS5, MCS5, MCS5, MCS7, MCS7, MCS7}, |
| 49 | {MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS9}, |
| 50 | {MCS5, MCS5, MCS5, MCS5, MCS5, MCS5, MCS7, MCS7, MCS7}, |
| 51 | {MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS8, MCS8}, |
| 52 | {MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS6, MCS9} |
| 53 | } |
| 54 | }; |
| 55 | |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 56 | static struct { |
| 57 | struct { |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 58 | unsigned int bytes; |
| 59 | unsigned int ext_bits; |
Jacob Erlbeck | 22f8087 | 2016-01-11 10:56:50 +0100 | [diff] [blame] | 60 | unsigned int data_header_bits; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 61 | } uplink, downlink; |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 62 | unsigned int data_bytes; |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 63 | unsigned int optional_padding_bits; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 64 | const char *name; |
Jacob Erlbeck | 6c3dc61 | 2015-12-14 10:21:26 +0100 | [diff] [blame] | 65 | GprsCodingScheme::HeaderType data_hdr; |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 66 | GprsCodingScheme::Family family; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 67 | } mcs_info[GprsCodingScheme::NUM_SCHEMES] = { |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 68 | {{0, 0}, {0, 0}, 0, 0, "UNKNOWN", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 69 | GprsCodingScheme::HEADER_INVALID, GprsCodingScheme::FAMILY_INVALID}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 70 | {{23, 0}, {23, 0}, 20, 0, "CS-1", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 71 | GprsCodingScheme::HEADER_GPRS_DATA, GprsCodingScheme::FAMILY_INVALID}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 72 | {{33, 7}, {33, 7}, 30, 0, "CS-2", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 73 | GprsCodingScheme::HEADER_GPRS_DATA, GprsCodingScheme::FAMILY_INVALID}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 74 | {{39, 3}, {39, 3}, 36, 0, "CS-3", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 75 | GprsCodingScheme::HEADER_GPRS_DATA, GprsCodingScheme::FAMILY_INVALID}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 76 | {{53, 7}, {53, 7}, 50, 0, "CS-4", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 77 | GprsCodingScheme::HEADER_GPRS_DATA, GprsCodingScheme::FAMILY_INVALID}, |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 78 | |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 79 | {{26, 1}, {26, 1}, 22, 0, "MCS-1", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 80 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_3, GprsCodingScheme::FAMILY_C}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 81 | {{32, 1}, {32, 1}, 28, 0, "MCS-2", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 82 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_3, GprsCodingScheme::FAMILY_B}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 83 | {{41, 1}, {41, 1}, 37, 48, "MCS-3", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 84 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_3, GprsCodingScheme::FAMILY_A}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 85 | {{48, 1}, {48, 1}, 44, 0, "MCS-4", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 86 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_3, GprsCodingScheme::FAMILY_C}, |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 87 | |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 88 | {{60, 7}, {59, 6}, 56, 0, "MCS-5", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 89 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_2, GprsCodingScheme::FAMILY_B}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 90 | {{78, 7}, {77, 6}, 74, 48, "MCS-6", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 91 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_2, GprsCodingScheme::FAMILY_A}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 92 | {{118, 2}, {117, 4}, 56, 0, "MCS-7", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 93 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_1, GprsCodingScheme::FAMILY_B}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 94 | {{142, 2}, {141, 4}, 68, 0, "MCS-8", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 95 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_1, GprsCodingScheme::FAMILY_A}, |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 96 | {{154, 2}, {153, 4}, 74, 0, "MCS-9", |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 97 | GprsCodingScheme::HEADER_EGPRS_DATA_TYPE_1, GprsCodingScheme::FAMILY_A}, |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 98 | }; |
| 99 | |
Jacob Erlbeck | 22f8087 | 2016-01-11 10:56:50 +0100 | [diff] [blame] | 100 | static struct { |
| 101 | struct { |
| 102 | int data_header_bits; |
| 103 | } uplink, downlink; |
| 104 | unsigned int data_block_header_bits; |
| 105 | unsigned int num_blocks; |
| 106 | const char *name; |
| 107 | } hdr_type_info[GprsCodingScheme::NUM_HEADER_TYPES] = { |
| 108 | {{0}, {0}, 0, 0, "INVALID"}, |
| 109 | {{1*8 + 0}, {1*8 + 0}, 0, 0, "CONTROL"}, |
| 110 | {{3*8 + 0}, {3*8 + 0}, 0, 1, "GPRS_DATA"}, |
| 111 | {{5*8 + 6}, {5*8 + 0}, 2, 2, "EGPRS_DATA_TYPE1"}, |
| 112 | {{4*8 + 5}, {3*8 + 4}, 2, 1, "EGPRS_DATA_TYPE2"}, |
| 113 | {{3*8 + 7}, {3*8 + 7}, 2, 1, "EGPRS_DATA_TYPE3"}, |
| 114 | }; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 115 | |
| 116 | GprsCodingScheme GprsCodingScheme::getBySizeUL(unsigned size) |
| 117 | { |
| 118 | switch (size) { |
| 119 | case 23: return GprsCodingScheme(CS1); |
| 120 | case 27: return GprsCodingScheme(MCS1); |
| 121 | case 33: return GprsCodingScheme(MCS2); |
| 122 | case 34: return GprsCodingScheme(CS2); |
| 123 | case 40: return GprsCodingScheme(CS3); |
| 124 | case 42: return GprsCodingScheme(MCS3); |
| 125 | case 49: return GprsCodingScheme(MCS4); |
| 126 | case 54: return GprsCodingScheme(CS4); |
| 127 | case 61: return GprsCodingScheme(MCS5); |
| 128 | case 79: return GprsCodingScheme(MCS6); |
| 129 | case 119: return GprsCodingScheme(MCS7); |
| 130 | case 143: return GprsCodingScheme(MCS8); |
| 131 | case 155: return GprsCodingScheme(MCS9); |
| 132 | } |
| 133 | |
| 134 | return GprsCodingScheme(UNKNOWN); |
| 135 | } |
| 136 | |
| 137 | unsigned int GprsCodingScheme::sizeUL() const |
| 138 | { |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 139 | return mcs_info[m_scheme].uplink.bytes + (spareBitsUL() ? 1 : 0); |
| 140 | } |
| 141 | |
| 142 | unsigned int GprsCodingScheme::usedSizeUL() const |
| 143 | { |
| 144 | if (mcs_info[m_scheme].data_hdr == HEADER_GPRS_DATA) |
| 145 | return mcs_info[m_scheme].uplink.bytes; |
| 146 | else |
| 147 | return sizeUL(); |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | unsigned int GprsCodingScheme::maxBytesUL() const |
| 151 | { |
| 152 | return mcs_info[m_scheme].uplink.bytes; |
| 153 | } |
| 154 | |
| 155 | unsigned int GprsCodingScheme::spareBitsUL() const |
| 156 | { |
| 157 | return mcs_info[m_scheme].uplink.ext_bits; |
| 158 | } |
| 159 | |
| 160 | unsigned int GprsCodingScheme::sizeDL() const |
| 161 | { |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 162 | return mcs_info[m_scheme].downlink.bytes + (spareBitsDL() ? 1 : 0); |
| 163 | } |
| 164 | |
| 165 | unsigned int GprsCodingScheme::usedSizeDL() const |
| 166 | { |
| 167 | if (mcs_info[m_scheme].data_hdr == HEADER_GPRS_DATA) |
| 168 | return mcs_info[m_scheme].downlink.bytes; |
| 169 | else |
| 170 | return sizeDL(); |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | unsigned int GprsCodingScheme::maxBytesDL() const |
| 174 | { |
| 175 | return mcs_info[m_scheme].downlink.bytes; |
| 176 | } |
| 177 | |
| 178 | unsigned int GprsCodingScheme::spareBitsDL() const |
| 179 | { |
| 180 | return mcs_info[m_scheme].downlink.ext_bits; |
| 181 | } |
| 182 | |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 183 | unsigned int GprsCodingScheme::maxDataBlockBytes() const |
| 184 | { |
| 185 | return mcs_info[m_scheme].data_bytes; |
| 186 | } |
| 187 | |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 188 | unsigned int GprsCodingScheme::optionalPaddingBits() const |
| 189 | { |
| 190 | return mcs_info[m_scheme].optional_padding_bits; |
| 191 | } |
| 192 | |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 193 | unsigned int GprsCodingScheme::numDataBlocks() const |
| 194 | { |
Jacob Erlbeck | 22f8087 | 2016-01-11 10:56:50 +0100 | [diff] [blame] | 195 | return hdr_type_info[headerTypeData()].num_blocks; |
| 196 | } |
| 197 | |
| 198 | unsigned int GprsCodingScheme::numDataHeaderBitsUL() const |
| 199 | { |
| 200 | return hdr_type_info[headerTypeData()].uplink.data_header_bits; |
| 201 | } |
| 202 | |
| 203 | unsigned int GprsCodingScheme::numDataHeaderBitsDL() const |
| 204 | { |
| 205 | return hdr_type_info[headerTypeData()].downlink.data_header_bits; |
| 206 | } |
| 207 | |
| 208 | unsigned int GprsCodingScheme::numDataBlockHeaderBits() const |
| 209 | { |
| 210 | return hdr_type_info[headerTypeData()].data_block_header_bits; |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 211 | } |
| 212 | |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 213 | const char *GprsCodingScheme::name() const |
| 214 | { |
| 215 | return mcs_info[m_scheme].name; |
| 216 | } |
Jacob Erlbeck | 6c3dc61 | 2015-12-14 10:21:26 +0100 | [diff] [blame] | 217 | |
| 218 | GprsCodingScheme::HeaderType GprsCodingScheme::headerTypeData() const |
| 219 | { |
| 220 | return mcs_info[m_scheme].data_hdr; |
| 221 | } |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 222 | |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 223 | GprsCodingScheme::Family GprsCodingScheme::family() const |
| 224 | { |
| 225 | return mcs_info[m_scheme].family; |
| 226 | } |
| 227 | |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 228 | void GprsCodingScheme::inc(Mode mode) |
| 229 | { |
| 230 | if (!isCompatible(mode)) |
| 231 | /* This should not happen. TODO: Use assert? */ |
| 232 | return; |
| 233 | |
| 234 | Scheme new_cs(Scheme(m_scheme + 1)); |
| 235 | if (!GprsCodingScheme(new_cs).isCompatible(mode)) |
| 236 | /* Clipping, do not change the value */ |
| 237 | return; |
| 238 | |
| 239 | m_scheme = new_cs; |
| 240 | } |
| 241 | |
| 242 | void GprsCodingScheme::dec(Mode mode) |
| 243 | { |
| 244 | if (!isCompatible(mode)) |
| 245 | /* This should not happen. TODO: Use assert? */ |
| 246 | return; |
| 247 | |
| 248 | Scheme new_cs(Scheme(m_scheme - 1)); |
| 249 | if (!GprsCodingScheme(new_cs).isCompatible(mode)) |
| 250 | /* Clipping, do not change the value */ |
| 251 | return; |
| 252 | |
| 253 | m_scheme = new_cs; |
| 254 | } |
| 255 | |
| 256 | void GprsCodingScheme::inc() |
| 257 | { |
| 258 | if (isGprs() && m_scheme == CS4) |
| 259 | return; |
| 260 | |
| 261 | if (isEgprs() && m_scheme == MCS9) |
| 262 | return; |
| 263 | |
| 264 | if (!isValid()) |
| 265 | return; |
| 266 | |
| 267 | m_scheme = Scheme(m_scheme + 1); |
| 268 | } |
| 269 | |
| 270 | void GprsCodingScheme::dec() |
| 271 | { |
| 272 | if (isGprs() && m_scheme == CS1) |
| 273 | return; |
| 274 | |
| 275 | if (isEgprs() && m_scheme == MCS1) |
| 276 | return; |
| 277 | |
| 278 | if (!isValid()) |
| 279 | return; |
| 280 | |
| 281 | m_scheme = Scheme(m_scheme - 1); |
| 282 | } |
Jacob Erlbeck | 7b57997 | 2016-01-05 15:54:24 +0100 | [diff] [blame] | 283 | |
| 284 | const char *GprsCodingScheme::modeName(Mode mode) |
| 285 | { |
| 286 | switch (mode) { |
| 287 | case GPRS: return "GPRS"; |
| 288 | case EGPRS_GMSK: return "EGPRS_GMSK-only"; |
| 289 | case EGPRS: return "EGPRS"; |
| 290 | default: return "???"; |
| 291 | } |
| 292 | } |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 293 | |
| 294 | bool GprsCodingScheme::isFamilyCompatible(GprsCodingScheme o) const |
| 295 | { |
| 296 | if (*this == o) |
| 297 | return true; |
| 298 | |
| 299 | if (family() == FAMILY_INVALID) |
| 300 | return false; |
| 301 | |
| 302 | return family() == o.family(); |
| 303 | } |
| 304 | |
| 305 | bool GprsCodingScheme::isCombinable(GprsCodingScheme o) const |
| 306 | { |
| 307 | return numDataBlocks() == o.numDataBlocks(); |
| 308 | } |
| 309 | |
| 310 | void GprsCodingScheme::decToSingleBlock(bool *needStuffing) |
| 311 | { |
| 312 | switch (m_scheme) { |
| 313 | case MCS7: *needStuffing = false; m_scheme = MCS5; break; |
| 314 | case MCS8: *needStuffing = true; m_scheme = MCS6; break; |
| 315 | case MCS9: *needStuffing = false; m_scheme = MCS6; break; |
| 316 | default: *needStuffing = false; break; |
| 317 | } |
| 318 | } |