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 | |
Max | 807dde0 | 2019-02-26 19:59:46 +0100 | [diff] [blame] | 24 | enum Family { |
| 25 | FAMILY_INVALID, |
| 26 | FAMILY_A, |
| 27 | FAMILY_B, |
| 28 | FAMILY_C, |
| 29 | }; |
| 30 | |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 31 | static struct { |
| 32 | struct { |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 33 | uint8_t bytes; |
| 34 | uint8_t ext_bits; |
| 35 | uint8_t data_header_bits; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 36 | } uplink, downlink; |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 37 | uint8_t data_bytes; |
| 38 | uint8_t optional_padding_bits; |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 39 | enum HeaderType data_hdr; |
Max | 807dde0 | 2019-02-26 19:59:46 +0100 | [diff] [blame] | 40 | enum Family family; |
Max | bea2edb | 2019-03-06 17:04:59 +0100 | [diff] [blame] | 41 | } mcs_info[NUM_SCHEMES] = { |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 42 | {{0, 0}, {0, 0}, 0, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 43 | HEADER_INVALID, FAMILY_INVALID}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 44 | {{23, 0}, {23, 0}, 20, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 45 | HEADER_GPRS_DATA, FAMILY_INVALID}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 46 | {{33, 7}, {33, 7}, 30, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 47 | HEADER_GPRS_DATA, FAMILY_INVALID}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 48 | {{39, 3}, {39, 3}, 36, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 49 | HEADER_GPRS_DATA, FAMILY_INVALID}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 50 | {{53, 7}, {53, 7}, 50, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 51 | HEADER_GPRS_DATA, FAMILY_INVALID}, |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 52 | |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 53 | {{26, 1}, {26, 1}, 22, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 54 | HEADER_EGPRS_DATA_TYPE_3, FAMILY_C}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 55 | {{32, 1}, {32, 1}, 28, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 56 | HEADER_EGPRS_DATA_TYPE_3, FAMILY_B}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 57 | {{41, 1}, {41, 1}, 37, 48, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 58 | HEADER_EGPRS_DATA_TYPE_3, FAMILY_A}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 59 | {{48, 1}, {48, 1}, 44, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 60 | HEADER_EGPRS_DATA_TYPE_3, FAMILY_C}, |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 61 | |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 62 | {{60, 7}, {59, 6}, 56, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 63 | HEADER_EGPRS_DATA_TYPE_2, FAMILY_B}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 64 | {{78, 7}, {77, 6}, 74, 48, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 65 | HEADER_EGPRS_DATA_TYPE_2, FAMILY_A}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 66 | {{118, 2}, {117, 4}, 56, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 67 | HEADER_EGPRS_DATA_TYPE_1, FAMILY_B}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 68 | {{142, 2}, {141, 4}, 68, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 69 | HEADER_EGPRS_DATA_TYPE_1, FAMILY_A}, |
Max | 136ebcc | 2019-03-05 14:59:03 +0100 | [diff] [blame] | 70 | {{154, 2}, {153, 4}, 74, 0, |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 71 | HEADER_EGPRS_DATA_TYPE_1, FAMILY_A}, |
Jacob Erlbeck | 22f8087 | 2016-01-11 10:56:50 +0100 | [diff] [blame] | 72 | }; |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 73 | |
| 74 | GprsCodingScheme GprsCodingScheme::getBySizeUL(unsigned size) |
| 75 | { |
| 76 | switch (size) { |
| 77 | case 23: return GprsCodingScheme(CS1); |
| 78 | case 27: return GprsCodingScheme(MCS1); |
| 79 | case 33: return GprsCodingScheme(MCS2); |
| 80 | case 34: return GprsCodingScheme(CS2); |
| 81 | case 40: return GprsCodingScheme(CS3); |
| 82 | case 42: return GprsCodingScheme(MCS3); |
| 83 | case 49: return GprsCodingScheme(MCS4); |
| 84 | case 54: return GprsCodingScheme(CS4); |
| 85 | case 61: return GprsCodingScheme(MCS5); |
| 86 | case 79: return GprsCodingScheme(MCS6); |
| 87 | case 119: return GprsCodingScheme(MCS7); |
| 88 | case 143: return GprsCodingScheme(MCS8); |
| 89 | case 155: return GprsCodingScheme(MCS9); |
| 90 | } |
| 91 | |
| 92 | return GprsCodingScheme(UNKNOWN); |
| 93 | } |
| 94 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 95 | uint8_t GprsCodingScheme::sizeUL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 96 | { |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 97 | return mcs_info[m_scheme].uplink.bytes + (spareBitsUL() ? 1 : 0); |
| 98 | } |
| 99 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 100 | uint8_t GprsCodingScheme::usedSizeUL() const |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 101 | { |
| 102 | if (mcs_info[m_scheme].data_hdr == HEADER_GPRS_DATA) |
| 103 | return mcs_info[m_scheme].uplink.bytes; |
| 104 | else |
| 105 | return sizeUL(); |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 106 | } |
| 107 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 108 | uint8_t GprsCodingScheme::maxBytesUL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 109 | { |
| 110 | return mcs_info[m_scheme].uplink.bytes; |
| 111 | } |
| 112 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 113 | uint8_t GprsCodingScheme::spareBitsUL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 114 | { |
| 115 | return mcs_info[m_scheme].uplink.ext_bits; |
| 116 | } |
| 117 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 118 | uint8_t GprsCodingScheme::sizeDL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 119 | { |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 120 | return mcs_info[m_scheme].downlink.bytes + (spareBitsDL() ? 1 : 0); |
| 121 | } |
| 122 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 123 | uint8_t GprsCodingScheme::usedSizeDL() const |
Jacob Erlbeck | fc1b3e6 | 2016-01-11 09:58:11 +0100 | [diff] [blame] | 124 | { |
| 125 | if (mcs_info[m_scheme].data_hdr == HEADER_GPRS_DATA) |
| 126 | return mcs_info[m_scheme].downlink.bytes; |
| 127 | else |
| 128 | return sizeDL(); |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 129 | } |
| 130 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 131 | uint8_t GprsCodingScheme::maxBytesDL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 132 | { |
| 133 | return mcs_info[m_scheme].downlink.bytes; |
| 134 | } |
| 135 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 136 | uint8_t GprsCodingScheme::spareBitsDL() const |
Jacob Erlbeck | 409f980 | 2015-11-30 18:06:50 +0100 | [diff] [blame] | 137 | { |
| 138 | return mcs_info[m_scheme].downlink.ext_bits; |
| 139 | } |
| 140 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 141 | uint8_t GprsCodingScheme::maxDataBlockBytes() const |
Jacob Erlbeck | 392a545 | 2015-12-14 10:38:29 +0100 | [diff] [blame] | 142 | { |
| 143 | return mcs_info[m_scheme].data_bytes; |
| 144 | } |
| 145 | |
Max | b3a17d6 | 2017-12-21 12:11:33 +0100 | [diff] [blame] | 146 | uint8_t GprsCodingScheme::optionalPaddingBits() const |
Jacob Erlbeck | 215e18c | 2016-02-03 18:22:34 +0100 | [diff] [blame] | 147 | { |
| 148 | return mcs_info[m_scheme].optional_padding_bits; |
| 149 | } |
| 150 | |
Max | 51754b6 | 2019-03-13 17:14:13 +0100 | [diff] [blame] | 151 | enum HeaderType GprsCodingScheme::headerTypeData() const |
Jacob Erlbeck | 6c3dc61 | 2015-12-14 10:21:26 +0100 | [diff] [blame] | 152 | { |
| 153 | return mcs_info[m_scheme].data_hdr; |
| 154 | } |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 155 | |
Max | a4de02d | 2019-03-13 16:35:09 +0100 | [diff] [blame] | 156 | void GprsCodingScheme::inc(enum mcs_kind mode) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 157 | { |
| 158 | if (!isCompatible(mode)) |
| 159 | /* This should not happen. TODO: Use assert? */ |
| 160 | return; |
| 161 | |
Max | bea2edb | 2019-03-06 17:04:59 +0100 | [diff] [blame] | 162 | CodingScheme new_cs(CodingScheme(m_scheme + 1)); |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 163 | if (!GprsCodingScheme(new_cs).isCompatible(mode)) |
| 164 | /* Clipping, do not change the value */ |
| 165 | return; |
| 166 | |
| 167 | m_scheme = new_cs; |
| 168 | } |
| 169 | |
Max | a4de02d | 2019-03-13 16:35:09 +0100 | [diff] [blame] | 170 | void GprsCodingScheme::dec(enum mcs_kind mode) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 171 | { |
| 172 | if (!isCompatible(mode)) |
| 173 | /* This should not happen. TODO: Use assert? */ |
| 174 | return; |
| 175 | |
Max | bea2edb | 2019-03-06 17:04:59 +0100 | [diff] [blame] | 176 | CodingScheme new_cs(CodingScheme(m_scheme - 1)); |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 177 | if (!GprsCodingScheme(new_cs).isCompatible(mode)) |
| 178 | /* Clipping, do not change the value */ |
| 179 | return; |
| 180 | |
| 181 | m_scheme = new_cs; |
| 182 | } |
| 183 | |
| 184 | void GprsCodingScheme::inc() |
| 185 | { |
Max | 8a8e0fb | 2019-03-25 16:32:50 +0100 | [diff] [blame] | 186 | if (mcs_is_gprs(m_scheme) && m_scheme == CS4) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 187 | return; |
| 188 | |
Max | 8a8e0fb | 2019-03-25 16:32:50 +0100 | [diff] [blame] | 189 | if (mcs_is_edge(m_scheme) && m_scheme == MCS9) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 190 | return; |
| 191 | |
| 192 | if (!isValid()) |
| 193 | return; |
| 194 | |
Max | bea2edb | 2019-03-06 17:04:59 +0100 | [diff] [blame] | 195 | m_scheme = CodingScheme(m_scheme + 1); |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | void GprsCodingScheme::dec() |
| 199 | { |
Max | 8a8e0fb | 2019-03-25 16:32:50 +0100 | [diff] [blame] | 200 | if (mcs_is_gprs(m_scheme) && m_scheme == CS1) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 201 | return; |
| 202 | |
Max | 8a8e0fb | 2019-03-25 16:32:50 +0100 | [diff] [blame] | 203 | if (mcs_is_edge(m_scheme) && m_scheme == MCS1) |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 204 | return; |
| 205 | |
| 206 | if (!isValid()) |
| 207 | return; |
| 208 | |
Max | bea2edb | 2019-03-06 17:04:59 +0100 | [diff] [blame] | 209 | m_scheme = CodingScheme(m_scheme - 1); |
Jacob Erlbeck | 4c9e549 | 2016-01-04 16:00:05 +0100 | [diff] [blame] | 210 | } |
Jacob Erlbeck | 7b57997 | 2016-01-05 15:54:24 +0100 | [diff] [blame] | 211 | |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 212 | bool GprsCodingScheme::isFamilyCompatible(GprsCodingScheme o) const |
| 213 | { |
| 214 | if (*this == o) |
| 215 | return true; |
| 216 | |
Max | 807dde0 | 2019-02-26 19:59:46 +0100 | [diff] [blame] | 217 | if (mcs_info[m_scheme].family == FAMILY_INVALID) |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 218 | return false; |
| 219 | |
Max | 807dde0 | 2019-02-26 19:59:46 +0100 | [diff] [blame] | 220 | return mcs_info[m_scheme].family == mcs_info[o.m_scheme].family; |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 221 | } |
| 222 | |
Jacob Erlbeck | 2305afd | 2016-02-03 15:25:04 +0100 | [diff] [blame] | 223 | void GprsCodingScheme::decToSingleBlock(bool *needStuffing) |
| 224 | { |
| 225 | switch (m_scheme) { |
| 226 | case MCS7: *needStuffing = false; m_scheme = MCS5; break; |
| 227 | case MCS8: *needStuffing = true; m_scheme = MCS6; break; |
| 228 | case MCS9: *needStuffing = false; m_scheme = MCS6; break; |
| 229 | default: *needStuffing = false; break; |
| 230 | } |
| 231 | } |