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