blob: 4f1ac79dcb21cc6b8297a9fee4b84fac22e7d9c6 [file] [log] [blame]
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001/*
2 * (C) 2013 by Andreas Eversberg <jolly@eversberg.eu>
3 * (C) 2015 by Alexander Chemeris <Alexander.Chemeris@fairwaves.co>
4 * (C) 2016 by Tom Tsou <tom.tsou@ettus.com>
Harald Weltec6636782017-06-12 14:59:37 +02005 * (C) 2017 by Harald Welte <laforge@gnumonks.org>
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07006 *
7 * All Rights Reserved
8 *
Harald Weltee08da972017-11-13 01:00:26 +09009 * SPDX-License-Identifier: GPL-2.0+
10 *
Vadim Yanitskiy3262f822016-09-23 01:48:59 +070011 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
Vadim Yanitskiy3262f822016-09-23 01:48:59 +070020 */
21
22#include <stdio.h>
23#include <stdint.h>
24#include <string.h>
25#include <stdlib.h>
Maxc8cf8202017-05-22 16:07:04 +020026#include <errno.h>
Vadim Yanitskiy3262f822016-09-23 01:48:59 +070027
28#include <osmocom/core/bits.h>
29#include <osmocom/core/conv.h>
30#include <osmocom/core/utils.h>
31#include <osmocom/core/crcgen.h>
32#include <osmocom/core/endian.h>
33
Pau Espin Pedrol0158b052023-02-17 12:30:57 +010034#include <osmocom/gsm/protocol/gsm_44_060.h>
Vadim Yanitskiy3262f822016-09-23 01:48:59 +070035#include <osmocom/gsm/protocol/gsm_04_08.h>
36#include <osmocom/gsm/gsm0503.h>
37#include <osmocom/codec/codec.h>
38
39#include <osmocom/coding/gsm0503_interleaving.h>
40#include <osmocom/coding/gsm0503_mapping.h>
41#include <osmocom/coding/gsm0503_tables.h>
42#include <osmocom/coding/gsm0503_coding.h>
43#include <osmocom/coding/gsm0503_parity.h>
Philipp Maier898c9c62020-02-06 14:25:01 +010044#include <osmocom/coding/gsm0503_amr_dtx.h>
Vadim Yanitskiy3262f822016-09-23 01:48:59 +070045
Harald Weltec6636782017-06-12 14:59:37 +020046/*! \mainpage libosmocoding Documentation
47 *
48 * \section sec_intro Introduction
49 * This library is a collection of definitions, tables and functions
50 * implementing the GSM/GPRS/EGPRS channel coding (and decoding) as
51 * specified in 3GPP TS 05.03 / 45.003.
52 *
Vadim Yanitskiy9a232fd2018-01-19 03:05:32 +060053 * libosmocoding is developed as part of the Osmocom (Open Source Mobile
Harald Weltec6636782017-06-12 14:59:37 +020054 * Communications) project, a community-based, collaborative development
55 * project to create Free and Open Source implementations of mobile
56 * communications systems. For more information about Osmocom, please
57 * see https://osmocom.org/
58 *
59 * \section sec_copyright Copyright and License
60 * Copyright © 2013 by Andreas Eversberg\n
61 * Copyright © 2015 by Alexander Chemeris\n
62 * Copyright © 2016 by Tom Tsou\n
63 * Documentation Copyright © 2017 by Harald Welte\n
64 * All rights reserved. \n\n
65 * The source code of libosmocoding is licensed under the terms of the GNU
66 * General Public License as published by the Free Software Foundation;
67 * either version 2 of the License, or (at your option) any later
68 * version.\n
69 * See <http://www.gnu.org/licenses/> or COPYING included in the source
70 * code package istelf.\n
71 * The information detailed here is provided AS IS with NO WARRANTY OF
72 * ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND
73 * FITNESS FOR A PARTICULAR PURPOSE.
74 * \n\n
75 *
76 * \section sec_tracker Homepage + Issue Tracker
77 * libosmocoding is distributed as part of libosmocore and shares its
78 * project page at http://osmocom.org/projects/libosmocore
79 *
80 * An Issue Tracker can be found at
81 * https://osmocom.org/projects/libosmocore/issues
82 *
83 * \section sec_contact Contact and Support
84 * Community-based support is available at the OpenBSC mailing list
85 * <http://lists.osmocom.org/mailman/listinfo/openbsc>\n
86 * Commercial support options available upon request from
87 * <http://sysmocom.de/>
88 */
89
90
91/*! \addtogroup coding
92 * @{
93 *
Neels Hofmeyr87e45502017-06-20 00:17:59 +020094 * GSM TS 05.03 coding
Harald Weltec6636782017-06-12 14:59:37 +020095 *
96 * This module is the "master module" of libosmocoding. It uses the
97 * various other modules (mapping, parity, interleaving) in order to
98 * implement the complete channel coding (and decoding) chain for the
99 * various channel types as defined in TS 05.03 / 45.003.
Neels Hofmeyr17518fe2017-06-20 04:35:06 +0200100 *
101 * \file gsm0503_coding.c */
Harald Weltec6636782017-06-12 14:59:37 +0200102
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700103/*
104 * EGPRS coding limits
105 */
106
107/* Max header size with parity bits */
108#define EGPRS_HDR_UPP_MAX 54
109
110/* Max encoded header size */
111#define EGPRS_HDR_C_MAX 162
112
113/* Max punctured header size */
114#define EGPRS_HDR_HC_MAX 160
115
116/* Max data block size with parity bits */
117#define EGPRS_DATA_U_MAX 612
118
119/* Max encoded data block size */
120#define EGPRS_DATA_C_MAX 1836
121
122/* Max single block punctured data size */
123#define EGPRS_DATA_DC_MAX 1248
124
125/* Dual block punctured data size */
126#define EGPRS_DATA_C1 612
127#define EGPRS_DATA_C2 EGPRS_DATA_C1
128
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200129/*! union across the three different EGPRS Uplink header types */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700130union gprs_rlc_ul_hdr_egprs {
131 struct gprs_rlc_ul_header_egprs_1 type1;
132 struct gprs_rlc_ul_header_egprs_2 type2;
133 struct gprs_rlc_ul_header_egprs_3 type3;
134};
135
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200136/*! union across the three different EGPRS Downlink header types */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700137union gprs_rlc_dl_hdr_egprs {
138 struct gprs_rlc_dl_header_egprs_1 type1;
139 struct gprs_rlc_dl_header_egprs_2 type2;
140 struct gprs_rlc_dl_header_egprs_3 type3;
141};
142
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200143/*! Structure describing a Modulation and Coding Scheme */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700144struct gsm0503_mcs_code {
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200145 /*! Modulation and Coding Scheme (MSC) number */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700146 uint8_t mcs;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200147 /*! Length of Uplink Stealing Flag (USF) in bits */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700148 uint8_t usf_len;
149
150 /* Header coding */
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200151 /*! Length of header (bits) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700152 uint8_t hdr_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200153 /*! Length of header convolutional code */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700154 uint8_t hdr_code_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200155 /*! Length of header code puncturing sequence */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700156 uint8_t hdr_punc_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200157 /*! header convolutional code */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700158 const struct osmo_conv_code *hdr_conv;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200159 /*! header puncturing sequence */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700160 const uint8_t *hdr_punc;
161
162 /* Data coding */
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200163 /*! length of data (bits) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700164 uint16_t data_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200165 /*! length of data convolutional code */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700166 uint16_t data_code_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200167 /*! length of data code puncturing sequence */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700168 uint16_t data_punc_len;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200169 /*! data convolutional code */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700170 const struct osmo_conv_code *data_conv;
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200171 /*! data puncturing sequences */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700172 const uint8_t *data_punc[3];
173};
174
175/*
176 * EGPRS UL coding parameters
177 */
Harald Welte2f984ea2017-06-12 15:05:21 +0200178const struct gsm0503_mcs_code gsm0503_mcs_ul_codes[EGPRS_NUM_MCS] = {
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700179 {
180 .mcs = EGPRS_MCS0,
181 },
182 {
183 .mcs = EGPRS_MCS1,
184 .hdr_len = 31,
185 .hdr_code_len = 117,
186 .hdr_punc_len = 80,
187 .hdr_conv = &gsm0503_mcs1_ul_hdr,
188 .hdr_punc = gsm0503_puncture_mcs1_ul_hdr,
189
190 .data_len = 178,
191 .data_code_len = 588,
192 .data_punc_len = 372,
193 .data_conv = &gsm0503_mcs1,
194 .data_punc = {
195 gsm0503_puncture_mcs1_p1,
196 gsm0503_puncture_mcs1_p2,
197 NULL,
198 },
199 },
200 {
201 .mcs = EGPRS_MCS2,
202 .hdr_len = 31,
203 .hdr_code_len = 117,
204 .hdr_punc_len = 80,
205 .hdr_conv = &gsm0503_mcs1_ul_hdr,
206 .hdr_punc = gsm0503_puncture_mcs1_ul_hdr,
207
208 .data_len = 226,
209 .data_code_len = 732,
210 .data_punc_len = 372,
211 .data_conv = &gsm0503_mcs2,
212 .data_punc = {
213 gsm0503_puncture_mcs2_p1,
214 gsm0503_puncture_mcs2_p2,
215 NULL,
216 },
217 },
218 {
219 .mcs = EGPRS_MCS3,
220 .hdr_len = 31,
221 .hdr_code_len = 117,
222 .hdr_punc_len = 80,
223 .hdr_conv = &gsm0503_mcs1_ul_hdr,
224 .hdr_punc = gsm0503_puncture_mcs1_ul_hdr,
225
226 .data_len = 298,
227 .data_code_len = 948,
228 .data_punc_len = 372,
229 .data_conv = &gsm0503_mcs3,
230 .data_punc = {
231 gsm0503_puncture_mcs3_p1,
232 gsm0503_puncture_mcs3_p2,
233 gsm0503_puncture_mcs3_p3,
234 },
235 },
236 {
237 .mcs = EGPRS_MCS4,
238 .hdr_len = 31,
239 .hdr_code_len = 117,
240 .hdr_punc_len = 80,
241 .hdr_conv = &gsm0503_mcs1_ul_hdr,
242 .hdr_punc = gsm0503_puncture_mcs1_ul_hdr,
243
244 .data_len = 354,
245 .data_code_len = 1116,
246 .data_punc_len = 372,
247 .data_conv = &gsm0503_mcs4,
248 .data_punc = {
249 gsm0503_puncture_mcs4_p1,
250 gsm0503_puncture_mcs4_p2,
251 gsm0503_puncture_mcs4_p3,
252 },
253 },
254 {
255 .mcs = EGPRS_MCS5,
256 .hdr_len = 37,
257 .hdr_code_len = 135,
258 .hdr_punc_len = 136,
259 .hdr_conv = &gsm0503_mcs5_ul_hdr,
260 .hdr_punc = NULL,
261
262 .data_len = 450,
263 .data_code_len = 1404,
264 .data_punc_len = 1248,
265 .data_conv = &gsm0503_mcs5,
266 .data_punc = {
267 gsm0503_puncture_mcs5_p1,
268 gsm0503_puncture_mcs5_p2,
269 NULL,
270 },
271 },
272 {
273 .mcs = EGPRS_MCS6,
274 .hdr_len = 37,
275 .hdr_code_len = 135,
276 .hdr_punc_len = 136,
277 .hdr_conv = &gsm0503_mcs5_ul_hdr,
278 .hdr_punc = NULL,
279
280 .data_len = 594,
281 .data_code_len = 1836,
282 .data_punc_len = 1248,
283 .data_conv = &gsm0503_mcs6,
284 .data_punc = {
285 gsm0503_puncture_mcs6_p1,
286 gsm0503_puncture_mcs6_p2,
287 NULL,
288 },
289 },
290 {
291 .mcs = EGPRS_MCS7,
292 .hdr_len = 46,
293 .hdr_code_len = 162,
294 .hdr_punc_len = 160,
295 .hdr_conv = &gsm0503_mcs7_ul_hdr,
296 .hdr_punc = gsm0503_puncture_mcs7_ul_hdr,
297
298 .data_len = 900,
299 .data_code_len = 1404,
300 .data_punc_len = 612,
301 .data_conv = &gsm0503_mcs7,
302 .data_punc = {
303 gsm0503_puncture_mcs7_p1,
304 gsm0503_puncture_mcs7_p2,
305 gsm0503_puncture_mcs7_p3,
306 }
307 },
308 {
309 .mcs = EGPRS_MCS8,
310 .hdr_len = 46,
311 .hdr_code_len = 162,
312 .hdr_punc_len = 160,
313 .hdr_conv = &gsm0503_mcs7_ul_hdr,
314 .hdr_punc = gsm0503_puncture_mcs7_ul_hdr,
315
316 .data_len = 1092,
317 .data_code_len = 1692,
318 .data_punc_len = 612,
319 .data_conv = &gsm0503_mcs8,
320 .data_punc = {
321 gsm0503_puncture_mcs8_p1,
322 gsm0503_puncture_mcs8_p2,
323 gsm0503_puncture_mcs8_p3,
324 }
325 },
326 {
327 .mcs = EGPRS_MCS9,
328 .hdr_len = 46,
329 .hdr_code_len = 162,
330 .hdr_punc_len = 160,
331 .hdr_conv = &gsm0503_mcs7_ul_hdr,
332 .hdr_punc = gsm0503_puncture_mcs7_ul_hdr,
333
334 .data_len = 1188,
335 .data_code_len = 1836,
336 .data_punc_len = 612,
337 .data_conv = &gsm0503_mcs9,
338 .data_punc = {
339 gsm0503_puncture_mcs9_p1,
340 gsm0503_puncture_mcs9_p2,
341 gsm0503_puncture_mcs9_p3,
342 }
343 },
344};
345
346/*
347 * EGPRS DL coding parameters
348 */
Harald Welte2f984ea2017-06-12 15:05:21 +0200349const struct gsm0503_mcs_code gsm0503_mcs_dl_codes[EGPRS_NUM_MCS] = {
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700350 {
351 .mcs = EGPRS_MCS0,
352 },
353 {
354 .mcs = EGPRS_MCS1,
355 .usf_len = 3,
356 .hdr_len = 28,
357 .hdr_code_len = 108,
358 .hdr_punc_len = 68,
359 .hdr_conv = &gsm0503_mcs1_dl_hdr,
360 .hdr_punc = gsm0503_puncture_mcs1_dl_hdr,
361
362 .data_len = 178,
363 .data_code_len = 588,
364 .data_punc_len = 372,
365 .data_conv = &gsm0503_mcs1,
366 .data_punc = {
367 gsm0503_puncture_mcs1_p1,
368 gsm0503_puncture_mcs1_p2,
369 NULL,
370 },
371 },
372 {
373 .mcs = EGPRS_MCS2,
374 .usf_len = 3,
375 .hdr_len = 28,
376 .hdr_code_len = 108,
377 .hdr_punc_len = 68,
378 .hdr_conv = &gsm0503_mcs1_dl_hdr,
379 .hdr_punc = gsm0503_puncture_mcs1_dl_hdr,
380
381 .data_len = 226,
382 .data_code_len = 732,
383 .data_punc_len = 372,
384 .data_conv = &gsm0503_mcs2,
385 .data_punc = {
386 gsm0503_puncture_mcs2_p1,
387 gsm0503_puncture_mcs2_p2,
388 NULL,
389 },
390 },
391 {
392 .mcs = EGPRS_MCS3,
393 .usf_len = 3,
394 .hdr_len = 28,
395 .hdr_code_len = 108,
396 .hdr_punc_len = 68,
397 .hdr_conv = &gsm0503_mcs1_dl_hdr,
398 .hdr_punc = gsm0503_puncture_mcs1_dl_hdr,
399
400 .data_len = 298,
401 .data_code_len = 948,
402 .data_punc_len = 372,
403 .data_conv = &gsm0503_mcs3,
404 .data_punc = {
405 gsm0503_puncture_mcs3_p1,
406 gsm0503_puncture_mcs3_p2,
407 gsm0503_puncture_mcs3_p3,
408 },
409 },
410 {
411 .mcs = EGPRS_MCS4,
412 .usf_len = 3,
413 .hdr_len = 28,
414 .hdr_code_len = 108,
415 .hdr_punc_len = 68,
416 .hdr_conv = &gsm0503_mcs1_dl_hdr,
417 .hdr_punc = gsm0503_puncture_mcs1_dl_hdr,
418
419 .data_len = 354,
420 .data_code_len = 1116,
421 .data_punc_len = 372,
422 .data_conv = &gsm0503_mcs4,
423 .data_punc = {
424 gsm0503_puncture_mcs4_p1,
425 gsm0503_puncture_mcs4_p2,
426 gsm0503_puncture_mcs4_p3,
427 },
428 },
429 {
430 .mcs = EGPRS_MCS5,
431 .usf_len = 3,
432 .hdr_len = 25,
433 .hdr_code_len = 99,
434 .hdr_punc_len = 100,
435 .hdr_conv = &gsm0503_mcs5_dl_hdr,
436 .hdr_punc = NULL,
437
438 .data_len = 450,
439 .data_code_len = 1404,
440 .data_punc_len = 1248,
441 .data_conv = &gsm0503_mcs5,
442 .data_punc = {
443 gsm0503_puncture_mcs5_p1,
444 gsm0503_puncture_mcs5_p2,
445 NULL,
446 },
447 },
448 {
449 .mcs = EGPRS_MCS6,
450 .usf_len = 3,
451 .hdr_len = 25,
452 .hdr_code_len = 99,
453 .hdr_punc_len = 100,
454 .hdr_conv = &gsm0503_mcs5_dl_hdr,
455 .hdr_punc = NULL,
456
457 .data_len = 594,
458 .data_code_len = 1836,
459 .data_punc_len = 1248,
460 .data_conv = &gsm0503_mcs6,
461 .data_punc = {
462 gsm0503_puncture_mcs6_p1,
463 gsm0503_puncture_mcs6_p2,
464 NULL,
465 },
466 },
467 {
468 .mcs = EGPRS_MCS7,
469 .usf_len = 3,
470 .hdr_len = 37,
471 .hdr_code_len = 135,
472 .hdr_punc_len = 124,
473 .hdr_conv = &gsm0503_mcs7_dl_hdr,
474 .hdr_punc = gsm0503_puncture_mcs7_dl_hdr,
475
476 .data_len = 900,
477 .data_code_len = 1404,
478 .data_punc_len = 612,
479 .data_conv = &gsm0503_mcs7,
480 .data_punc = {
481 gsm0503_puncture_mcs7_p1,
482 gsm0503_puncture_mcs7_p2,
483 gsm0503_puncture_mcs7_p3,
484 }
485 },
486 {
487 .mcs = EGPRS_MCS8,
488 .usf_len = 3,
489 .hdr_len = 37,
490 .hdr_code_len = 135,
491 .hdr_punc_len = 124,
492 .hdr_conv = &gsm0503_mcs7_dl_hdr,
493 .hdr_punc = gsm0503_puncture_mcs7_dl_hdr,
494
495 .data_len = 1092,
496 .data_code_len = 1692,
497 .data_punc_len = 612,
498 .data_conv = &gsm0503_mcs8,
499 .data_punc = {
500 gsm0503_puncture_mcs8_p1,
501 gsm0503_puncture_mcs8_p2,
502 gsm0503_puncture_mcs8_p3,
503 }
504 },
505 {
506 .mcs = EGPRS_MCS9,
507 .usf_len = 3,
508 .hdr_len = 37,
509 .hdr_code_len = 135,
510 .hdr_punc_len = 124,
511 .hdr_conv = &gsm0503_mcs7_dl_hdr,
512 .hdr_punc = gsm0503_puncture_mcs7_dl_hdr,
513
514 .data_len = 1188,
515 .data_code_len = 1836,
516 .data_punc_len = 612,
517 .data_conv = &gsm0503_mcs9,
518 .data_punc = {
519 gsm0503_puncture_mcs9_p1,
520 gsm0503_puncture_mcs9_p2,
521 gsm0503_puncture_mcs9_p3,
522 }
523 },
524};
525
Alexander Chemeris147051f2018-07-14 21:02:29 +0200526/*! Convolutional Decode + compute BER for punctured codes
Harald Weltec6636782017-06-12 14:59:37 +0200527 * \param[in] code Description of Convolutional Code
528 * \param[in] input Input soft-bits (-127...127)
529 * \param[out] output bits
530 * \param[out] n_errors Number of bit-errors
531 * \param[out] n_bits_total Number of bits
Alexander Chemeris147051f2018-07-14 21:02:29 +0200532 * \param[in] data_punc Puncturing mask array. Can be NULL.
Harald Weltec6636782017-06-12 14:59:37 +0200533 */
Alexander Chemeris147051f2018-07-14 21:02:29 +0200534static int osmo_conv_decode_ber_punctured(const struct osmo_conv_code *code,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700535 const sbit_t *input, ubit_t *output,
Alexander Chemeris147051f2018-07-14 21:02:29 +0200536 int *n_errors, int *n_bits_total,
537 const uint8_t *data_punc)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700538{
539 int res, i, coded_len;
540 ubit_t recoded[EGPRS_DATA_C_MAX];
541
542 res = osmo_conv_decode(code, input, output);
543
Pau Espin Pedrold2737e62022-05-13 13:07:21 +0200544 if (!n_bits_total && !n_errors)
545 return res;
546
547 coded_len = osmo_conv_encode(code, output, recoded);
Pau Espin Pedrol6c58d152022-05-13 14:03:27 +0200548 OSMO_ASSERT(ARRAY_SIZE(recoded) >= coded_len);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700549
550 /* Count bit errors */
551 if (n_errors) {
552 *n_errors = 0;
553 for (i = 0; i < coded_len; i++) {
Alexander Chemeris147051f2018-07-14 21:02:29 +0200554 if (((!data_punc) || (data_punc && !data_punc[i])) &&
555 !((recoded[i] && input[i] < 0) ||
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700556 (!recoded[i] && input[i] > 0)) )
557 *n_errors += 1;
558 }
559 }
560
561 if (n_bits_total)
562 *n_bits_total = coded_len;
563
564 return res;
565}
566
Alexander Chemeris147051f2018-07-14 21:02:29 +0200567/*! Convolutional Decode + compute BER for non-punctured codes
568 * \param[in] code Description of Convolutional Code
569 * \param[in] input Input soft-bits (-127...127)
570 * \param[out] output bits
571 * \param[out] n_errors Number of bit-errors
572 * \param[out] n_bits_total Number of bits
573 */
574static int osmo_conv_decode_ber(const struct osmo_conv_code *code,
575 const sbit_t *input, ubit_t *output,
576 int *n_errors, int *n_bits_total)
577{
578 return osmo_conv_decode_ber_punctured(code, input, output,
579 n_errors, n_bits_total, NULL);
580}
581
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200582/*! convenience wrapper for decoding coded bits
Harald Weltec6636782017-06-12 14:59:37 +0200583 * \param[out] l2_data caller-allocated buffer for L2 Frame
584 * \param[in] cB 456 coded (soft) bits as per TS 05.03 4.1.3
585 * \param[out] n_errors Number of detected errors
586 * \param[out] n_bits_total Number of total coded bits
587 * \returns 0 on success; -1 on CRC error */
Harald Welteb9946d32017-06-12 09:40:16 +0200588static int _xcch_decode_cB(uint8_t *l2_data, const sbit_t *cB,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700589 int *n_errors, int *n_bits_total)
590{
591 ubit_t conv[224];
592 int rv;
593
594 osmo_conv_decode_ber(&gsm0503_xcch, cB,
595 conv, n_errors, n_bits_total);
596
597 rv = osmo_crc64gen_check_bits(&gsm0503_fire_crc40,
598 conv, 184, conv + 184);
599 if (rv)
600 return -1;
601
602 osmo_ubit2pbit_ext(l2_data, 0, conv, 0, 184, 1);
603
604 return 0;
605}
606
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200607/*! convenience wrapper for encoding to coded bits
Harald Weltec6636782017-06-12 14:59:37 +0200608 * \param[out] cB caller-allocated buffer for 456 coded bits as per TS 05.03 4.1.3
Vadim Yanitskiyfed02e02023-05-15 23:25:05 +0700609 * \param[in] l2_data to-be-encoded L2 Frame
Harald Weltec6636782017-06-12 14:59:37 +0200610 * \returns 0 */
Harald Welteb9946d32017-06-12 09:40:16 +0200611static int _xcch_encode_cB(ubit_t *cB, const uint8_t *l2_data)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700612{
613 ubit_t conv[224];
614
615 osmo_pbit2ubit_ext(conv, 0, l2_data, 0, 184, 1);
616
617 osmo_crc64gen_set_bits(&gsm0503_fire_crc40, conv, 184, conv + 184);
618
619 osmo_conv_encode(&gsm0503_xcch, conv, cB);
620
621 return 0;
622}
623
624/*
625 * GSM xCCH block transcoding
626 */
Harald Weltec6636782017-06-12 14:59:37 +0200627
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200628/*! Decoding of xCCH data from bursts to L2 frame
Harald Weltec6636782017-06-12 14:59:37 +0200629 * \param[out] l2_data caller-allocated output data buffer
630 * \param[in] bursts four GSM bursts in soft-bits
631 * \param[out] n_errors Number of detected errors
632 * \param[out] n_bits_total Number of total coded bits
633 */
Harald Welteb9946d32017-06-12 09:40:16 +0200634int gsm0503_xcch_decode(uint8_t *l2_data, const sbit_t *bursts,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700635 int *n_errors, int *n_bits_total)
636{
637 sbit_t iB[456], cB[456];
638 int i;
639
640 for (i = 0; i < 4; i++)
641 gsm0503_xcch_burst_unmap(&iB[i * 114], &bursts[i * 116], NULL, NULL);
642
643 gsm0503_xcch_deinterleave(cB, iB);
644
645 return _xcch_decode_cB(l2_data, cB, n_errors, n_bits_total);
646}
647
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200648/*! Encoding of xCCH data from L2 frame to bursts
Harald Weltec6636782017-06-12 14:59:37 +0200649 * \param[out] bursts caller-allocated burst data (unpacked bits)
650 * \param[in] l2_data L2 input data (MAC block)
651 * \returns 0
652 */
Harald Welteb9946d32017-06-12 09:40:16 +0200653int gsm0503_xcch_encode(ubit_t *bursts, const uint8_t *l2_data)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700654{
655 ubit_t iB[456], cB[456], hl = 1, hn = 1;
656 int i;
657
658 _xcch_encode_cB(cB, l2_data);
659
660 gsm0503_xcch_interleave(cB, iB);
661
662 for (i = 0; i < 4; i++)
663 gsm0503_xcch_burst_map(&iB[i * 114], &bursts[i * 116], &hl, &hn);
664
665 return 0;
666}
667
668/*
669 * EGPRS PDTCH UL block decoding
670 */
671
672/*
673 * Type 3 - MCS-1,2,3,4
674 * Unmapping and deinterleaving
675 */
676static int egprs_type3_unmap(const sbit_t *bursts, sbit_t *hc, sbit_t *dc)
677{
678 int i;
679 sbit_t iB[456], q[8];
680
681 for (i = 0; i < 4; i++) {
682 gsm0503_xcch_burst_unmap(&iB[i * 114], &bursts[i * 116],
683 q + i * 2, q + i * 2 + 1);
684 }
685
686 gsm0503_mcs1_ul_deinterleave(hc, dc, iB);
687
688 return 0;
689}
690
691/*
692 * Type 2 - MCS-5,6
693 * Unmapping and deinterleaving
694 */
695static int egprs_type2_unmap(const sbit_t *bursts, sbit_t *hc, sbit_t *dc)
696{
697 int i;
698 sbit_t burst[348];
699 sbit_t hi[EGPRS_HDR_HC_MAX];
700 sbit_t di[EGPRS_DATA_DC_MAX];
701
702 for (i = 0; i < 4; i++) {
703 memcpy(burst, &bursts[i * 348], 348);
704
705 gsm0503_mcs5_burst_swap(burst);
706 gsm0503_mcs5_ul_burst_unmap(di, burst, hi, i);
707 }
708
709 gsm0503_mcs5_ul_deinterleave(hc, dc, hi, di);
710
711 return 0;
712}
713
714/*
715 * Type 1 - MCS-7,8,9
716 * Unmapping and deinterleaving - Note that MCS-7 interleaver is unique
717 */
718static int egprs_type1_unmap(const sbit_t *bursts, sbit_t *hc,
719 sbit_t *c1, sbit_t *c2, int msc)
720{
721 int i;
722 sbit_t burst[348];
723 sbit_t hi[EGPRS_HDR_HC_MAX];
724 sbit_t di[EGPRS_DATA_C1 * 2];
725
726 for (i = 0; i < 4; i++) {
727 memcpy(burst, &bursts[i * 348], 348);
728
729 gsm0503_mcs5_burst_swap(burst);
730 gsm0503_mcs7_ul_burst_unmap(di, burst, hi, i);
731 }
732
733 if (msc == EGPRS_MCS7)
734 gsm0503_mcs7_ul_deinterleave(hc, c1, c2, hi, di);
735 else
736 gsm0503_mcs8_ul_deinterleave(hc, c1, c2, hi, di);
737
738 return 0;
739}
740
741/*
742 * Decode EGPRS UL header section
743 *
744 * 1. Depuncture
745 * 2. Convolutional decoding
746 * 3. CRC check
747 */
748static int _egprs_decode_hdr(const sbit_t *hc, int mcs,
749 union gprs_rlc_ul_hdr_egprs *hdr)
750{
751 sbit_t C[EGPRS_HDR_C_MAX];
752 ubit_t upp[EGPRS_HDR_UPP_MAX];
753 int i, j, rc;
Harald Welte2f984ea2017-06-12 15:05:21 +0200754 const struct gsm0503_mcs_code *code;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700755
756 code = &gsm0503_mcs_ul_codes[mcs];
757
758 /* Skip depuncturing on MCS-5,6 header */
759 if ((mcs == EGPRS_MCS5) || (mcs == EGPRS_MCS6)) {
760 memcpy(C, hc, code->hdr_code_len);
761 goto hdr_conv_decode;
762 }
763
764 if (!code->hdr_punc) {
765 /* Invalid MCS-X header puncture matrix */
766 return -1;
767 }
768
769 i = code->hdr_code_len - 1;
770 j = code->hdr_punc_len - 1;
771
772 for (; i >= 0; i--) {
773 if (!code->hdr_punc[i])
774 C[i] = hc[j--];
775 else
776 C[i] = 0;
777 }
778
779hdr_conv_decode:
780 osmo_conv_decode_ber(code->hdr_conv, C, upp, NULL, NULL);
781 rc = osmo_crc8gen_check_bits(&gsm0503_mcs_crc8_hdr, upp,
782 code->hdr_len, upp + code->hdr_len);
783 if (rc)
784 return -1;
785
786 osmo_ubit2pbit_ext((pbit_t *) hdr, 0, upp, 0, code->hdr_len, 1);
787
788 return 0;
789}
790
791/*
792 * Blind MCS header decoding based on burst length and CRC validation.
793 * Ignore 'q' value coding identification. This approach provides
794 * the strongest chance of header recovery.
795 */
796static int egprs_decode_hdr(union gprs_rlc_ul_hdr_egprs *hdr,
797 const sbit_t *bursts, uint16_t nbits)
798{
799 int rc;
800 sbit_t hc[EGPRS_HDR_HC_MAX];
801
802 if (nbits == GSM0503_GPRS_BURSTS_NBITS) {
803 /* MCS-1,2,3,4 */
804 egprs_type3_unmap(bursts, hc, NULL);
805 rc = _egprs_decode_hdr(hc, EGPRS_MCS1, hdr);
806 if (!rc)
807 return EGPRS_HDR_TYPE3;
808 } else if (nbits == GSM0503_EGPRS_BURSTS_NBITS) {
809 /* MCS-5,6 */
810 egprs_type2_unmap(bursts, hc, NULL);
811 rc = _egprs_decode_hdr(hc, EGPRS_MCS5, hdr);
812 if (!rc)
813 return EGPRS_HDR_TYPE2;
814
815 /* MCS-7,8,9 */
816 egprs_type1_unmap(bursts, hc, NULL, NULL, EGPRS_MCS7);
817 rc = _egprs_decode_hdr(hc, EGPRS_MCS7, hdr);
818 if (!rc)
819 return EGPRS_HDR_TYPE1;
820 }
821
822 return -1;
823}
824
825/*
826 * Parse EGPRS UL header for coding and puncturing scheme (CPS)
827 *
828 * Type 1 - MCS-7,8,9
829 * Type 2 - MCS-5,6
830 * Type 3 - MCS-1,2,3,4
831 */
832static int egprs_parse_ul_cps(struct egprs_cps *cps,
833 union gprs_rlc_ul_hdr_egprs *hdr, int type)
834{
835 uint8_t bits;
836
837 switch (type) {
838 case EGPRS_HDR_TYPE1:
839 bits = hdr->type1.cps;
840 break;
841 case EGPRS_HDR_TYPE2:
842 bits = (hdr->type2.cps_lo << 2) | hdr->type2.cps_hi;
843 break;
844 case EGPRS_HDR_TYPE3:
845 bits = (hdr->type3.cps_lo << 2) | hdr->type3.cps_hi;
846 break;
847 default:
848 return -1;
849 }
850
851 return egprs_get_cps(cps, type, bits);
852}
853
854/*
855 * Decode EGPRS UL data section
856 *
857 * 1. Depuncture
858 * 2. Convolutional decoding
859 * 3. CRC check
860 * 4. Block combining (MCS-7,8,9 only)
861 */
Harald Welteb9946d32017-06-12 09:40:16 +0200862static int egprs_decode_data(uint8_t *l2_data, const sbit_t *c,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700863 int mcs, int p, int blk, int *n_errors, int *n_bits_total)
864{
865 ubit_t u[EGPRS_DATA_U_MAX];
866 sbit_t C[EGPRS_DATA_C_MAX];
867
868 int i, j, rc, data_len;
Harald Welte2f984ea2017-06-12 15:05:21 +0200869 const struct gsm0503_mcs_code *code;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700870
871 if (blk && mcs < EGPRS_MCS7) {
872 /* Invalid MCS-X block state */
873 return -1;
874 }
875
876 code = &gsm0503_mcs_ul_codes[mcs];
877 if (!code->data_punc[p]) {
878 /* Invalid MCS-X data puncture matrix */
879 return -1;
880 }
881
882 /*
883 * MCS-1,6 - single block processing
884 * MCS-7,9 - dual block processing
885 */
886 if (mcs >= EGPRS_MCS7)
887 data_len = code->data_len / 2;
888 else
889 data_len = code->data_len;
890
891 i = code->data_code_len - 1;
892 j = code->data_punc_len - 1;
893
894 for (; i >= 0; i--) {
895 if (!code->data_punc[p][i])
896 C[i] = c[j--];
897 else
898 C[i] = 0;
899 }
900
Alexander Chemeris147051f2018-07-14 21:02:29 +0200901 osmo_conv_decode_ber_punctured(code->data_conv, C, u,
902 n_errors, n_bits_total, code->data_punc[p]);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700903 rc = osmo_crc16gen_check_bits(&gsm0503_mcs_crc12, u,
904 data_len, u + data_len);
905 if (rc)
906 return -1;
907
908 /* Offsets output pointer on the second block of Type 1 MCS */
909 osmo_ubit2pbit_ext(l2_data, code->hdr_len + blk * data_len,
910 u, 0, data_len, 1);
911
912 /* Return the number of bytes required for the bit message */
Maxdd75bac2017-06-13 15:07:01 +0200913 return OSMO_BYTES_FOR_BITS(code->hdr_len + code->data_len);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700914}
915
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200916/*! Decode EGPRS UL message
Harald Weltec6636782017-06-12 14:59:37 +0200917 * 1. Header section decoding
918 * 2. Extract CPS settings
919 * 3. Burst unmapping and deinterleaving
920 * 4. Data section decoding
921 * \param[out] l2_data caller-allocated buffer for L2 Frame
922 * \param[in] bursts burst input data as soft unpacked bits
923 * \param[in] nbits number of bits in \a bursts
924 * \param usf_p unused argument ?!?
925 * \param[out] n_errors number of detected bit-errors
Alexander Chemerised7d2dd2018-07-14 21:06:27 +0200926 * \param[out] n_bits_total total number of decoded bits
Harald Weltec6636782017-06-12 14:59:37 +0200927 * \returns 0 on success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +0200928int gsm0503_pdtch_egprs_decode(uint8_t *l2_data, const sbit_t *bursts, uint16_t nbits,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700929 uint8_t *usf_p, int *n_errors, int *n_bits_total)
930{
931 sbit_t dc[EGPRS_DATA_DC_MAX];
932 sbit_t c1[EGPRS_DATA_C1], c2[EGPRS_DATA_C2];
933 int type, rc;
934 struct egprs_cps cps;
935 union gprs_rlc_ul_hdr_egprs *hdr;
936
Alexander Chemeris50f7d742018-07-14 21:07:27 +0200937 if (n_errors)
938 *n_errors = 0;
939 if (n_bits_total)
940 *n_bits_total = 0;
941
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700942 if ((nbits != GSM0503_GPRS_BURSTS_NBITS) &&
943 (nbits != GSM0503_EGPRS_BURSTS_NBITS)) {
944 /* Invalid EGPRS bit length */
Maxc8cf8202017-05-22 16:07:04 +0200945 return -EOVERFLOW;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700946 }
947
948 hdr = (union gprs_rlc_ul_hdr_egprs *) l2_data;
949 type = egprs_decode_hdr(hdr, bursts, nbits);
950 if (egprs_parse_ul_cps(&cps, hdr, type) < 0)
Maxc8cf8202017-05-22 16:07:04 +0200951 return -EIO;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700952
953 switch (cps.mcs) {
Maxc8cf8202017-05-22 16:07:04 +0200954 case EGPRS_MCS0:
955 return -ENOTSUP;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700956 case EGPRS_MCS1:
957 case EGPRS_MCS2:
958 case EGPRS_MCS3:
959 case EGPRS_MCS4:
960 egprs_type3_unmap(bursts, NULL, dc);
961 break;
962 case EGPRS_MCS5:
963 case EGPRS_MCS6:
964 egprs_type2_unmap(bursts, NULL, dc);
965 break;
966 case EGPRS_MCS7:
967 case EGPRS_MCS8:
968 case EGPRS_MCS9:
969 egprs_type1_unmap(bursts, NULL, c1, c2, cps.mcs);
970 break;
971 default:
972 /* Invalid MCS-X */
Maxc8cf8202017-05-22 16:07:04 +0200973 return -EINVAL;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700974 }
975
976 /* Decode MCS-X block, where X = cps.mcs */
977 if (cps.mcs < EGPRS_MCS7) {
978 rc = egprs_decode_data(l2_data, dc, cps.mcs, cps.p[0],
979 0, n_errors, n_bits_total);
980 if (rc < 0)
Maxc8cf8202017-05-22 16:07:04 +0200981 return -EFAULT;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700982 } else {
Alexander Chemeris94443262018-07-14 21:09:54 +0200983 /* Bit counters for the second block */
984 int n_errors2, n_bits_total2;
985
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700986 /* MCS-7,8,9 block 1 */
987 rc = egprs_decode_data(l2_data, c1, cps.mcs, cps.p[0],
988 0, n_errors, n_bits_total);
989 if (rc < 0)
Maxc8cf8202017-05-22 16:07:04 +0200990 return -EFAULT;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700991
992 /* MCS-7,8,9 block 2 */
993 rc = egprs_decode_data(l2_data, c2, cps.mcs, cps.p[1],
Alexander Chemeris94443262018-07-14 21:09:54 +0200994 1, &n_errors2, &n_bits_total2);
995 if (n_errors)
996 *n_errors += n_errors2;
997 if (n_bits_total)
998 *n_bits_total += n_bits_total2;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700999 if (rc < 0)
Maxc8cf8202017-05-22 16:07:04 +02001000 return -EFAULT;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001001 }
1002
1003 return rc;
1004}
1005
1006/*
1007 * GSM PDTCH block transcoding
1008 */
1009
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001010/*! Decode GPRS PDTCH
Harald Weltec6636782017-06-12 14:59:37 +02001011 * \param[out] l2_data caller-allocated buffer for L2 Frame
1012 * \param[in] bursts burst input data as soft unpacked bits
1013 * \param[out] usf_p uplink stealing flag
1014 * \param[out] n_errors number of detected bit-errors
1015 * \param[out] n_bits_total total number of dcoded bits
1016 * \returns 0 on success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02001017int gsm0503_pdtch_decode(uint8_t *l2_data, const sbit_t *bursts, uint8_t *usf_p,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001018 int *n_errors, int *n_bits_total)
1019{
1020 sbit_t iB[456], cB[676], hl_hn[8];
1021 ubit_t conv[456];
1022 int i, j, k, rv, best = 0, cs = 0, usf = 0; /* make GCC happy */
1023
1024 for (i = 0; i < 4; i++)
1025 gsm0503_xcch_burst_unmap(&iB[i * 114], &bursts[i * 116],
1026 hl_hn + i * 2, hl_hn + i * 2 + 1);
1027
1028 for (i = 0; i < 4; i++) {
1029 for (j = 0, k = 0; j < 8; j++)
1030 k += abs(((int)gsm0503_pdtch_hl_hn_sbit[i][j]) - ((int)hl_hn[j]));
1031
1032 if (i == 0 || k < best) {
1033 best = k;
1034 cs = i + 1;
1035 }
1036 }
1037
1038 gsm0503_xcch_deinterleave(cB, iB);
1039
1040 switch (cs) {
1041 case 1:
1042 osmo_conv_decode_ber(&gsm0503_xcch, cB,
1043 conv, n_errors, n_bits_total);
1044
1045 rv = osmo_crc64gen_check_bits(&gsm0503_fire_crc40,
1046 conv, 184, conv + 184);
1047 if (rv)
1048 return -1;
1049
1050 osmo_ubit2pbit_ext(l2_data, 0, conv, 0, 184, 1);
1051
1052 return 23;
1053 case 2:
1054 for (i = 587, j = 455; i >= 0; i--) {
1055 if (!gsm0503_puncture_cs2[i])
1056 cB[i] = cB[j--];
1057 else
1058 cB[i] = 0;
1059 }
1060
1061 osmo_conv_decode_ber(&gsm0503_cs2_np, cB,
1062 conv, n_errors, n_bits_total);
1063
1064 for (i = 0; i < 8; i++) {
1065 for (j = 0, k = 0; j < 6; j++)
1066 k += abs(((int)gsm0503_usf2six[i][j]) - ((int)conv[j]));
1067
1068 if (i == 0 || k < best) {
1069 best = k;
1070 usf = i;
1071 }
1072 }
1073
1074 conv[3] = usf & 1;
1075 conv[4] = (usf >> 1) & 1;
1076 conv[5] = (usf >> 2) & 1;
1077 if (usf_p)
1078 *usf_p = usf;
1079
1080 rv = osmo_crc16gen_check_bits(&gsm0503_cs234_crc16,
1081 conv + 3, 271, conv + 3 + 271);
1082 if (rv)
1083 return -1;
1084
1085 osmo_ubit2pbit_ext(l2_data, 0, conv, 3, 271, 1);
1086
1087 return 34;
1088 case 3:
1089 for (i = 675, j = 455; i >= 0; i--) {
1090 if (!gsm0503_puncture_cs3[i])
1091 cB[i] = cB[j--];
1092 else
1093 cB[i] = 0;
1094 }
1095
1096 osmo_conv_decode_ber(&gsm0503_cs3_np, cB,
1097 conv, n_errors, n_bits_total);
1098
1099 for (i = 0; i < 8; i++) {
1100 for (j = 0, k = 0; j < 6; j++)
1101 k += abs(((int)gsm0503_usf2six[i][j]) - ((int)conv[j]));
1102
1103 if (i == 0 || k < best) {
1104 best = k;
1105 usf = i;
1106 }
1107 }
1108
1109 conv[3] = usf & 1;
1110 conv[4] = (usf >> 1) & 1;
1111 conv[5] = (usf >> 2) & 1;
1112 if (usf_p)
1113 *usf_p = usf;
1114
1115 rv = osmo_crc16gen_check_bits(&gsm0503_cs234_crc16,
1116 conv + 3, 315, conv + 3 + 315);
1117 if (rv)
1118 return -1;
1119
1120 osmo_ubit2pbit_ext(l2_data, 0, conv, 3, 315, 1);
1121
1122 return 40;
1123 case 4:
1124 for (i = 12; i < 456; i++)
1125 conv[i] = (cB[i] < 0) ? 1 : 0;
1126
1127 for (i = 0; i < 8; i++) {
1128 for (j = 0, k = 0; j < 12; j++)
1129 k += abs(((int)gsm0503_usf2twelve_sbit[i][j]) - ((int)cB[j]));
1130
1131 if (i == 0 || k < best) {
1132 best = k;
1133 usf = i;
1134 }
1135 }
1136
1137 conv[9] = usf & 1;
1138 conv[10] = (usf >> 1) & 1;
1139 conv[11] = (usf >> 2) & 1;
1140 if (usf_p)
1141 *usf_p = usf;
1142
1143 rv = osmo_crc16gen_check_bits(&gsm0503_cs234_crc16,
1144 conv + 9, 431, conv + 9 + 431);
1145 if (rv) {
1146 *n_bits_total = 456 - 12;
1147 *n_errors = *n_bits_total;
1148 return -1;
1149 }
1150
1151 *n_bits_total = 456 - 12;
1152 *n_errors = 0;
1153
1154 osmo_ubit2pbit_ext(l2_data, 0, conv, 9, 431, 1);
1155
1156 return 54;
1157 default:
1158 *n_bits_total = 0;
1159 *n_errors = 0;
1160 break;
1161 }
1162
1163 return -1;
1164}
1165
1166/*
Pau Espin Pedrolf62f0732020-04-07 13:12:11 +02001167 * EGPRS PDTCH DL block encoding
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001168 */
Harald Welteb9946d32017-06-12 09:40:16 +02001169static int egprs_type3_map(ubit_t *bursts, const ubit_t *hc, const ubit_t *dc, int usf)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001170{
1171 int i;
1172 ubit_t iB[456];
1173 const ubit_t *hl_hn = gsm0503_pdtch_hl_hn_ubit[3];
1174
Pau Espin Pedrol63ebc362020-04-07 13:15:36 +02001175 gsm0503_mcs1_dl_interleave(gsm0503_usf2twelve_ubit[usf], hc, dc, iB);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001176
1177 for (i = 0; i < 4; i++) {
1178 gsm0503_xcch_burst_map(&iB[i * 114], &bursts[i * 116],
1179 hl_hn + i * 2, hl_hn + i * 2 + 1);
1180 }
1181
1182 return 0;
1183}
1184
Harald Welteb9946d32017-06-12 09:40:16 +02001185static int egprs_type2_map(ubit_t *bursts, const ubit_t *hc, const ubit_t *dc, int usf)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001186{
1187 int i;
1188 const ubit_t *up;
1189 ubit_t hi[EGPRS_HDR_HC_MAX];
1190 ubit_t di[EGPRS_DATA_DC_MAX];
1191
1192 gsm0503_mcs5_dl_interleave(hc, dc, hi, di);
1193 up = gsm0503_mcs5_usf_precode_table[usf];
1194
1195 for (i = 0; i < 4; i++) {
1196 gsm0503_mcs5_dl_burst_map(di, &bursts[i * 348], hi, up, i);
1197 gsm0503_mcs5_burst_swap((sbit_t *) &bursts[i * 348]);
1198 }
1199
1200 return 0;
1201}
1202
Harald Welteb9946d32017-06-12 09:40:16 +02001203static int egprs_type1_map(ubit_t *bursts, const ubit_t *hc,
1204 const ubit_t *c1, const ubit_t *c2, int usf, int mcs)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001205{
1206 int i;
1207 const ubit_t *up;
1208 ubit_t hi[EGPRS_HDR_HC_MAX];
1209 ubit_t di[EGPRS_DATA_C1 * 2];
1210
1211 if (mcs == EGPRS_MCS7)
1212 gsm0503_mcs7_dl_interleave(hc, c1, c2, hi, di);
1213 else
1214 gsm0503_mcs8_dl_interleave(hc, c1, c2, hi, di);
1215
1216 up = gsm0503_mcs5_usf_precode_table[usf];
1217
1218 for (i = 0; i < 4; i++) {
1219 gsm0503_mcs7_dl_burst_map(di, &bursts[i * 348], hi, up, i);
1220 gsm0503_mcs5_burst_swap((sbit_t *) &bursts[i * 348]);
1221 }
1222
1223 return 0;
1224}
1225
Harald Welteb9946d32017-06-12 09:40:16 +02001226static int egprs_encode_hdr(ubit_t *hc, const uint8_t *l2_data, int mcs)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001227{
1228 int i, j;
1229 ubit_t upp[EGPRS_HDR_UPP_MAX], C[EGPRS_HDR_C_MAX];
Harald Welte2f984ea2017-06-12 15:05:21 +02001230 const struct gsm0503_mcs_code *code;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001231
1232 code = &gsm0503_mcs_dl_codes[mcs];
1233
1234 osmo_pbit2ubit_ext(upp, 0, l2_data, code->usf_len, code->hdr_len, 1);
1235 osmo_crc8gen_set_bits(&gsm0503_mcs_crc8_hdr, upp,
1236 code->hdr_len, upp + code->hdr_len);
1237
1238 osmo_conv_encode(code->hdr_conv, upp, C);
1239
1240 /* MCS-5,6 header direct puncture instead of table */
1241 if ((mcs == EGPRS_MCS5) || (mcs == EGPRS_MCS6)) {
1242 memcpy(hc, C, code->hdr_code_len);
1243 hc[99] = hc[98];
1244 return 0;
1245 }
1246
1247 if (!code->hdr_punc) {
1248 /* Invalid MCS-X header puncture matrix */
1249 return -1;
1250 }
1251
1252 for (i = 0, j = 0; i < code->hdr_code_len; i++) {
1253 if (!code->hdr_punc[i])
1254 hc[j++] = C[i];
1255 }
1256
1257 return 0;
1258}
1259
Harald Welteb9946d32017-06-12 09:40:16 +02001260static int egprs_encode_data(ubit_t *c, const uint8_t *l2_data,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001261 int mcs, int p, int blk)
1262{
1263 int i, j, data_len;
1264 ubit_t u[EGPRS_DATA_U_MAX], C[EGPRS_DATA_C_MAX];
Harald Welte2f984ea2017-06-12 15:05:21 +02001265 const struct gsm0503_mcs_code *code;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001266
1267 code = &gsm0503_mcs_dl_codes[mcs];
1268
1269 /*
1270 * Dual block - MCS-7,8,9
1271 * Single block - MCS-1,2,3,4,5,6
1272 */
1273 if (mcs >= EGPRS_MCS7)
1274 data_len = code->data_len / 2;
1275 else
1276 data_len = code->data_len;
1277
1278 osmo_pbit2ubit_ext(u, 0, l2_data,
1279 code->usf_len + code->hdr_len + blk * data_len, data_len, 1);
1280
1281 osmo_crc16gen_set_bits(&gsm0503_mcs_crc12, u, data_len, u + data_len);
1282
1283 osmo_conv_encode(code->data_conv, u, C);
1284
1285 if (!code->data_punc[p]) {
1286 /* Invalid MCS-X data puncture matrix */
1287 return -1;
1288 }
1289
1290 for (i = 0, j = 0; i < code->data_code_len; i++) {
1291 if (!code->data_punc[p][i])
1292 c[j++] = C[i];
1293 }
1294
1295 return 0;
1296}
1297
1298/*
1299 * Parse EGPRS DL header for coding and puncturing scheme (CPS)
1300 *
1301 * Type 1 - MCS-7,8,9
1302 * Type 2 - MCS-5,6
1303 * Type 3 - MCS-1,2,3,4
1304 */
1305static int egprs_parse_dl_cps(struct egprs_cps *cps,
Harald Welteb9946d32017-06-12 09:40:16 +02001306 const union gprs_rlc_dl_hdr_egprs *hdr, int type)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001307{
1308 uint8_t bits;
1309
1310 switch (type) {
1311 case EGPRS_HDR_TYPE1:
1312 bits = hdr->type1.cps;
1313 break;
1314 case EGPRS_HDR_TYPE2:
1315 bits = hdr->type2.cps;
1316 break;
1317 case EGPRS_HDR_TYPE3:
1318 bits = hdr->type3.cps;
1319 break;
1320 default:
1321 return -1;
1322 }
1323
1324 return egprs_get_cps(cps, type, bits);
1325}
1326
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001327/*! EGPRS DL message encoding
Harald Weltec6636782017-06-12 14:59:37 +02001328 * \param[out] bursts caller-allocated buffer for unpacked burst bits
1329 * \param[in] l2_data L2 (MAC) block to be encoded
1330 * \param[in] l2_len length of l2_data in bytes, used to determine MCS
Vadim Yanitskiy8055cdd2020-03-30 18:16:38 +07001331 * \returns number of bits encoded; negative on error */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001332int gsm0503_pdtch_egprs_encode(ubit_t *bursts,
Harald Welteb9946d32017-06-12 09:40:16 +02001333 const uint8_t *l2_data, uint8_t l2_len)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001334{
1335 ubit_t hc[EGPRS_DATA_C_MAX], dc[EGPRS_DATA_DC_MAX];
1336 ubit_t c1[EGPRS_DATA_C1], c2[EGPRS_DATA_C2];
1337 uint8_t mcs;
1338 struct egprs_cps cps;
1339 union gprs_rlc_dl_hdr_egprs *hdr;
1340
1341 switch (l2_len) {
1342 case 27:
1343 mcs = EGPRS_MCS1;
1344 break;
1345 case 33:
1346 mcs = EGPRS_MCS2;
1347 break;
1348 case 42:
1349 mcs = EGPRS_MCS3;
1350 break;
1351 case 49:
1352 mcs = EGPRS_MCS4;
1353 break;
1354 case 60:
1355 mcs = EGPRS_MCS5;
1356 break;
1357 case 78:
1358 mcs = EGPRS_MCS6;
1359 break;
1360 case 118:
1361 mcs = EGPRS_MCS7;
1362 break;
1363 case 142:
1364 mcs = EGPRS_MCS8;
1365 break;
1366 case 154:
1367 mcs = EGPRS_MCS9;
1368 break;
1369 default:
1370 return -1;
1371 }
1372
1373 /* Read header for USF and puncturing matrix selection. */
1374 hdr = (union gprs_rlc_dl_hdr_egprs *) l2_data;
1375
1376 switch (mcs) {
1377 case EGPRS_MCS1:
1378 case EGPRS_MCS2:
1379 case EGPRS_MCS3:
1380 case EGPRS_MCS4:
1381 /* Check for valid CPS and matching MCS to message size */
1382 if ((egprs_parse_dl_cps(&cps, hdr, EGPRS_HDR_TYPE3) < 0) ||
1383 (cps.mcs != mcs))
1384 goto bad_header;
1385
1386 egprs_encode_hdr(hc, l2_data, mcs);
1387 egprs_encode_data(dc, l2_data, mcs, cps.p[0], 0);
1388 egprs_type3_map(bursts, hc, dc, hdr->type3.usf);
1389 break;
1390 case EGPRS_MCS5:
1391 case EGPRS_MCS6:
1392 if ((egprs_parse_dl_cps(&cps, hdr, EGPRS_HDR_TYPE2) < 0) ||
1393 (cps.mcs != mcs))
1394 goto bad_header;
1395
1396 egprs_encode_hdr(hc, l2_data, mcs);
1397 egprs_encode_data(dc, l2_data, mcs, cps.p[0], 0);
1398 egprs_type2_map(bursts, hc, dc, hdr->type2.usf);
1399 break;
1400 case EGPRS_MCS7:
1401 case EGPRS_MCS8:
1402 case EGPRS_MCS9:
1403 if ((egprs_parse_dl_cps(&cps, hdr, EGPRS_HDR_TYPE1) < 0) ||
1404 (cps.mcs != mcs))
1405 goto bad_header;
1406
1407 egprs_encode_hdr(hc, l2_data, mcs);
1408 egprs_encode_data(c1, l2_data, mcs, cps.p[0], 0);
1409 egprs_encode_data(c2, l2_data, mcs, cps.p[1], 1);
1410 egprs_type1_map(bursts, hc, c1, c2, hdr->type1.usf, mcs);
1411 break;
1412 }
1413
1414 return mcs >= EGPRS_MCS5 ?
1415 GSM0503_EGPRS_BURSTS_NBITS : GSM0503_GPRS_BURSTS_NBITS;
1416
1417bad_header:
1418 /* Invalid EGPRS MCS-X header */
1419 return -1;
1420}
1421
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001422/*! GPRS DL message encoding
Harald Weltec6636782017-06-12 14:59:37 +02001423 * \param[out] bursts caller-allocated buffer for unpacked burst bits
1424 * \param[in] l2_data L2 (MAC) block to be encoded
1425 * \param[in] l2_len length of l2_data in bytes, used to determine CS
Vadim Yanitskiy8055cdd2020-03-30 18:16:38 +07001426 * \returns number of bits encoded; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02001427int gsm0503_pdtch_encode(ubit_t *bursts, const uint8_t *l2_data, uint8_t l2_len)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001428{
1429 ubit_t iB[456], cB[676];
1430 const ubit_t *hl_hn;
1431 ubit_t conv[334];
1432 int i, j, usf;
1433
1434 switch (l2_len) {
1435 case 23:
1436 osmo_pbit2ubit_ext(conv, 0, l2_data, 0, 184, 1);
1437
1438 osmo_crc64gen_set_bits(&gsm0503_fire_crc40, conv, 184, conv + 184);
1439
1440 osmo_conv_encode(&gsm0503_xcch, conv, cB);
1441
1442 hl_hn = gsm0503_pdtch_hl_hn_ubit[0];
1443
1444 break;
1445 case 34:
1446 osmo_pbit2ubit_ext(conv, 3, l2_data, 0, 271, 1);
1447 usf = l2_data[0] & 0x7;
1448
1449 osmo_crc16gen_set_bits(&gsm0503_cs234_crc16, conv + 3,
1450 271, conv + 3 + 271);
1451
1452 memcpy(conv, gsm0503_usf2six[usf], 6);
1453
1454 osmo_conv_encode(&gsm0503_cs2_np, conv, cB);
1455
1456 for (i = 0, j = 0; i < 588; i++)
1457 if (!gsm0503_puncture_cs2[i])
1458 cB[j++] = cB[i];
1459
1460 hl_hn = gsm0503_pdtch_hl_hn_ubit[1];
1461
1462 break;
1463 case 40:
1464 osmo_pbit2ubit_ext(conv, 3, l2_data, 0, 315, 1);
1465 usf = l2_data[0] & 0x7;
1466
1467 osmo_crc16gen_set_bits(&gsm0503_cs234_crc16, conv + 3,
1468 315, conv + 3 + 315);
1469
1470 memcpy(conv, gsm0503_usf2six[usf], 6);
1471
1472 osmo_conv_encode(&gsm0503_cs3_np, conv, cB);
1473
1474 for (i = 0, j = 0; i < 676; i++)
1475 if (!gsm0503_puncture_cs3[i])
1476 cB[j++] = cB[i];
1477
1478 hl_hn = gsm0503_pdtch_hl_hn_ubit[2];
1479
1480 break;
1481 case 54:
1482 osmo_pbit2ubit_ext(cB, 9, l2_data, 0, 431, 1);
1483 usf = l2_data[0] & 0x7;
1484
1485 osmo_crc16gen_set_bits(&gsm0503_cs234_crc16, cB + 9,
1486 431, cB + 9 + 431);
1487
1488 memcpy(cB, gsm0503_usf2twelve_ubit[usf], 12);
1489
1490 hl_hn = gsm0503_pdtch_hl_hn_ubit[3];
1491
1492 break;
1493 default:
1494 return -1;
1495 }
1496
1497 gsm0503_xcch_interleave(cB, iB);
1498
1499 for (i = 0; i < 4; i++) {
1500 gsm0503_xcch_burst_map(&iB[i * 114], &bursts[i * 116],
1501 hl_hn + i * 2, hl_hn + i * 2 + 1);
1502 }
1503
1504 return GSM0503_GPRS_BURSTS_NBITS;
1505}
1506
1507/*
1508 * GSM TCH/F FR/EFR transcoding
1509 */
1510
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001511/*! assemble a FR codec frame in format as used inside RTP
Harald Weltec6636782017-06-12 14:59:37 +02001512 * \param[out] tch_data Codec frame in RTP format
1513 * \param[in] b_bits Codec frame in 'native' format
1514 * \param[in] net_order FIXME */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001515static void tch_fr_reassemble(uint8_t *tch_data,
Harald Welteb9946d32017-06-12 09:40:16 +02001516 const ubit_t *b_bits, int net_order)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001517{
1518 int i, j, k, l, o;
1519
1520 tch_data[0] = 0xd << 4;
1521 memset(tch_data + 1, 0, 32);
1522
1523 if (net_order) {
1524 for (i = 0, j = 4; i < 260; i++, j++)
1525 tch_data[j >> 3] |= (b_bits[i] << (7 - (j & 7)));
1526
1527 return;
1528 }
1529
1530 /* reassemble d-bits */
1531 i = 0; /* counts bits */
1532 j = 4; /* counts output bits */
1533 k = gsm0503_gsm_fr_map[0]-1; /* current number bit in element */
1534 l = 0; /* counts element bits */
1535 o = 0; /* offset input bits */
1536 while (i < 260) {
1537 tch_data[j >> 3] |= (b_bits[k + o] << (7 - (j & 7)));
1538 if (--k < 0) {
1539 o += gsm0503_gsm_fr_map[l];
1540 k = gsm0503_gsm_fr_map[++l]-1;
1541 }
1542 i++;
1543 j++;
1544 }
1545}
1546
1547static void tch_fr_disassemble(ubit_t *b_bits,
Harald Welteb9946d32017-06-12 09:40:16 +02001548 const uint8_t *tch_data, int net_order)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001549{
1550 int i, j, k, l, o;
1551
1552 if (net_order) {
1553 for (i = 0, j = 4; i < 260; i++, j++)
1554 b_bits[i] = (tch_data[j >> 3] >> (7 - (j & 7))) & 1;
1555
1556 return;
1557 }
1558
1559 i = 0; /* counts bits */
1560 j = 4; /* counts input bits */
1561 k = gsm0503_gsm_fr_map[0] - 1; /* current number bit in element */
1562 l = 0; /* counts element bits */
1563 o = 0; /* offset output bits */
1564 while (i < 260) {
1565 b_bits[k + o] = (tch_data[j >> 3] >> (7 - (j & 7))) & 1;
1566 if (--k < 0) {
1567 o += gsm0503_gsm_fr_map[l];
1568 k = gsm0503_gsm_fr_map[++l] - 1;
1569 }
1570 i++;
1571 j++;
1572 }
1573}
1574
Harald Weltec6636782017-06-12 14:59:37 +02001575/* assemble a HR codec frame in format as used inside RTP */
Harald Welteb9946d32017-06-12 09:40:16 +02001576static void tch_hr_reassemble(uint8_t *tch_data, const ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001577{
1578 int i, j;
1579
1580 tch_data[0] = 0x00; /* F = 0, FT = 000 */
1581 memset(tch_data + 1, 0, 14);
1582
1583 for (i = 0, j = 8; i < 112; i++, j++)
1584 tch_data[j >> 3] |= (b_bits[i] << (7 - (j & 7)));
1585}
1586
Harald Welteb9946d32017-06-12 09:40:16 +02001587static void tch_hr_disassemble(ubit_t *b_bits, const uint8_t *tch_data)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001588{
Mychaela N. Falconia8d8d5af2023-05-23 16:41:05 +00001589 int i;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001590
Mychaela N. Falconia8d8d5af2023-05-23 16:41:05 +00001591 for (i = 0; i < 112; i++)
1592 b_bits[i] = (tch_data[i >> 3] >> (7 - (i & 7))) & 1;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001593}
1594
Harald Weltec6636782017-06-12 14:59:37 +02001595/* assemble a EFR codec frame in format as used inside RTP */
Harald Welteb9946d32017-06-12 09:40:16 +02001596static void tch_efr_reassemble(uint8_t *tch_data, const ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001597{
1598 int i, j;
1599
1600 tch_data[0] = 0xc << 4;
1601 memset(tch_data + 1, 0, 30);
1602
1603 for (i = 0, j = 4; i < 244; i++, j++)
1604 tch_data[j >> 3] |= (b_bits[i] << (7 - (j & 7)));
1605}
1606
Harald Welteb9946d32017-06-12 09:40:16 +02001607static void tch_efr_disassemble(ubit_t *b_bits, const uint8_t *tch_data)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001608{
1609 int i, j;
1610
1611 for (i = 0, j = 4; i < 244; i++, j++)
1612 b_bits[i] = (tch_data[j >> 3] >> (7 - (j & 7))) & 1;
1613}
1614
Harald Weltec6636782017-06-12 14:59:37 +02001615/* assemble a AMR codec frame in format as used inside RTP */
Harald Welteb9946d32017-06-12 09:40:16 +02001616static void tch_amr_reassemble(uint8_t *tch_data, const ubit_t *d_bits, int len)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001617{
1618 int i, j;
1619
1620 memset(tch_data, 0, (len + 7) >> 3);
1621
1622 for (i = 0, j = 0; i < len; i++, j++)
1623 tch_data[j >> 3] |= (d_bits[i] << (7 - (j & 7)));
1624}
1625
Harald Welteb9946d32017-06-12 09:40:16 +02001626static void tch_amr_disassemble(ubit_t *d_bits, const uint8_t *tch_data, int len)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001627{
1628 int i, j;
1629
1630 for (i = 0, j = 0; i < len; i++, j++)
1631 d_bits[i] = (tch_data[j >> 3] >> (7 - (j & 7))) & 1;
1632}
1633
Philipp Maier898c9c62020-02-06 14:25:01 +01001634/* Append STI and MI bits to the SID_UPDATE frame, see also
1635 * 3GPP TS 26.101, chapter 4.2.3 AMR Core Frame with comfort noise bits */
1636static void tch_amr_sid_update_append(ubit_t *sid_update, uint8_t sti, uint8_t mi)
1637{
1638 /* Zero out the space that had been used by the CRC14 */
1639 memset(sid_update + 35, 0, 14);
1640
1641 /* Append STI and MI parameters */
1642 sid_update[35] = sti & 1;
1643 sid_update[36] = mi & 1;
1644 sid_update[37] = mi >> 1 & 1;
1645 sid_update[38] = mi >> 2 & 1;
1646}
1647
1648/* Extract a SID UPDATE fram the sbits of an FR AMR frame */
1649static void extract_afs_sid_update(sbit_t *sid_update, const sbit_t *sbits)
1650{
1651
1652 unsigned int i;
1653
1654 sbits += 32;
1655
1656 for (i = 0; i < 53; i++) {
1657 sid_update[0] = sbits[0];
1658 sid_update[1] = sbits[1];
1659 sid_update[2] = sbits[2];
1660 sid_update[3] = sbits[3];
1661 sid_update += 4;
1662 sbits += 8;
1663 }
1664
1665}
1666
Harald Weltec6636782017-06-12 14:59:37 +02001667/* re-arrange according to TS 05.03 Table 2 (receiver) */
Harald Welteb9946d32017-06-12 09:40:16 +02001668static void tch_fr_d_to_b(ubit_t *b_bits, const ubit_t *d_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001669{
1670 int i;
1671
1672 for (i = 0; i < 260; i++)
1673 b_bits[gsm610_bitorder[i]] = d_bits[i];
1674}
1675
Harald Weltec6636782017-06-12 14:59:37 +02001676/* re-arrange according to TS 05.03 Table 2 (transmitter) */
Harald Welteb9946d32017-06-12 09:40:16 +02001677static void tch_fr_b_to_d(ubit_t *d_bits, const ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001678{
1679 int i;
1680
1681 for (i = 0; i < 260; i++)
1682 d_bits[i] = b_bits[gsm610_bitorder[i]];
1683}
1684
Harald Weltec6636782017-06-12 14:59:37 +02001685/* re-arrange according to TS 05.03 Table 3a (receiver) */
Harald Welteb9946d32017-06-12 09:40:16 +02001686static void tch_hr_d_to_b(ubit_t *b_bits, const ubit_t *d_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001687{
1688 int i;
1689
1690 const uint16_t *map;
1691
1692 if (!d_bits[93] && !d_bits[94])
1693 map = gsm620_unvoiced_bitorder;
1694 else
1695 map = gsm620_voiced_bitorder;
1696
1697 for (i = 0; i < 112; i++)
1698 b_bits[map[i]] = d_bits[i];
1699}
1700
Harald Weltec6636782017-06-12 14:59:37 +02001701/* re-arrange according to TS 05.03 Table 3a (transmitter) */
Harald Welteb9946d32017-06-12 09:40:16 +02001702static void tch_hr_b_to_d(ubit_t *d_bits, const ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001703{
1704 int i;
1705 const uint16_t *map;
1706
1707 if (!b_bits[34] && !b_bits[35])
1708 map = gsm620_unvoiced_bitorder;
1709 else
1710 map = gsm620_voiced_bitorder;
1711
1712 for (i = 0; i < 112; i++)
1713 d_bits[i] = b_bits[map[i]];
1714}
1715
Harald Weltec6636782017-06-12 14:59:37 +02001716/* re-arrange according to TS 05.03 Table 6 (receiver) */
Harald Welteb9946d32017-06-12 09:40:16 +02001717static void tch_efr_d_to_w(ubit_t *b_bits, const ubit_t *d_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001718{
1719 int i;
1720
1721 for (i = 0; i < 260; i++)
1722 b_bits[gsm660_bitorder[i]] = d_bits[i];
1723}
1724
Harald Weltec6636782017-06-12 14:59:37 +02001725/* re-arrange according to TS 05.03 Table 6 (transmitter) */
Harald Welteb9946d32017-06-12 09:40:16 +02001726static void tch_efr_w_to_d(ubit_t *d_bits, const ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001727{
1728 int i;
1729
1730 for (i = 0; i < 260; i++)
1731 d_bits[i] = b_bits[gsm660_bitorder[i]];
1732}
1733
Harald Weltec6636782017-06-12 14:59:37 +02001734/* extract the 65 protected class1a+1b bits */
Harald Welteb9946d32017-06-12 09:40:16 +02001735static void tch_efr_protected(const ubit_t *s_bits, ubit_t *b_bits)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001736{
1737 int i;
1738
1739 for (i = 0; i < 65; i++)
1740 b_bits[i] = s_bits[gsm0503_gsm_efr_protected_bits[i] - 1];
1741}
1742
Harald Welteb9946d32017-06-12 09:40:16 +02001743static void tch_fr_unreorder(ubit_t *d, ubit_t *p, const ubit_t *u)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001744{
1745 int i;
1746
1747 for (i = 0; i < 91; i++) {
1748 d[i << 1] = u[i];
1749 d[(i << 1) + 1] = u[184 - i];
1750 }
1751
1752 for (i = 0; i < 3; i++)
1753 p[i] = u[91 + i];
1754}
1755
Harald Welteb9946d32017-06-12 09:40:16 +02001756static void tch_fr_reorder(ubit_t *u, const ubit_t *d, const ubit_t *p)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001757{
1758 int i;
1759
1760 for (i = 0; i < 91; i++) {
1761 u[i] = d[i << 1];
1762 u[184 - i] = d[(i << 1) + 1];
1763 }
1764
1765 for (i = 0; i < 3; i++)
1766 u[91 + i] = p[i];
1767}
1768
Harald Welteb9946d32017-06-12 09:40:16 +02001769static void tch_hr_unreorder(ubit_t *d, ubit_t *p, const ubit_t *u)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001770{
1771 memcpy(d, u, 95);
1772 memcpy(p, u + 95, 3);
1773}
1774
Harald Welteb9946d32017-06-12 09:40:16 +02001775static void tch_hr_reorder(ubit_t *u, const ubit_t *d, const ubit_t *p)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001776{
1777 memcpy(u, d, 95);
1778 memcpy(u + 95, p, 3);
1779}
1780
Harald Welteb9946d32017-06-12 09:40:16 +02001781static void tch_efr_reorder(ubit_t *w, const ubit_t *s, const ubit_t *p)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001782{
1783 memcpy(w, s, 71);
1784 w[71] = w[72] = s[69];
1785 memcpy(w + 73, s + 71, 50);
1786 w[123] = w[124] = s[119];
1787 memcpy(w + 125, s + 121, 53);
1788 w[178] = w[179] = s[172];
1789 memcpy(w + 180, s + 174, 50);
1790 w[230] = w[231] = s[222];
1791 memcpy(w + 232, s + 224, 20);
1792 memcpy(w + 252, p, 8);
1793}
1794
Harald Welteb9946d32017-06-12 09:40:16 +02001795static void tch_efr_unreorder(ubit_t *s, ubit_t *p, const ubit_t *w)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001796{
1797 int sum;
1798
1799 memcpy(s, w, 71);
1800 sum = s[69] + w[71] + w[72];
Niro Mahasinghec526dbc2017-11-03 12:24:30 +01001801 s[69] = (sum >= 2);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001802 memcpy(s + 71, w + 73, 50);
1803 sum = s[119] + w[123] + w[124];
Niro Mahasinghec526dbc2017-11-03 12:24:30 +01001804 s[119] = (sum >= 2);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001805 memcpy(s + 121, w + 125, 53);
1806 sum = s[172] + w[178] + w[179];
Mychaela N. Falconiaf3e47452023-05-17 18:58:40 +00001807 s[172] = (sum >= 2);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001808 memcpy(s + 174, w + 180, 50);
Niro Mahasinghe834e2ac2017-11-03 12:22:34 +01001809 sum = s[222] + w[230] + w[231];
Niro Mahasinghec526dbc2017-11-03 12:24:30 +01001810 s[222] = (sum >= 2);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001811 memcpy(s + 224, w + 232, 20);
1812 memcpy(p, w + 252, 8);
1813}
1814
Harald Welteb9946d32017-06-12 09:40:16 +02001815static void tch_amr_merge(ubit_t *u, const ubit_t *d, const ubit_t *p, int len, int prot)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001816{
1817 memcpy(u, d, prot);
1818 memcpy(u + prot, p, 6);
1819 memcpy(u + prot + 6, d + prot, len - prot);
1820}
1821
Harald Welteb9946d32017-06-12 09:40:16 +02001822static void tch_amr_unmerge(ubit_t *d, ubit_t *p, const ubit_t *u, int len, int prot)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001823{
1824 memcpy(d, u, prot);
1825 memcpy(p, u + prot, 6);
1826 memcpy(d + prot, u + prot + 6, len - prot);
1827}
1828
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001829/*! Perform channel decoding of a FR/EFR channel according TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02001830 * \param[out] tch_data Codec frame in RTP payload format
1831 * \param[in] bursts buffer containing the symbols of 8 bursts
1832 * \param[in] net_order FIXME
1833 * \param[in] efr Is this channel using EFR (1) or FR (0)
1834 * \param[out] n_errors Number of detected bit errors
1835 * \param[out] n_bits_total Total number of bits
Pau Espin Pedrolf81d03f2018-07-19 13:49:41 +02001836 * \returns length of bytes used in \a tch_data output buffer; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02001837int gsm0503_tch_fr_decode(uint8_t *tch_data, const sbit_t *bursts,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001838 int net_order, int efr, int *n_errors, int *n_bits_total)
1839{
1840 sbit_t iB[912], cB[456], h;
1841 ubit_t conv[185], s[244], w[260], b[65], d[260], p[8];
1842 int i, rv, len, steal = 0;
1843
Harald Weltec6636782017-06-12 14:59:37 +02001844 /* map from 8 bursts to interleaved data bits (iB) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001845 for (i = 0; i < 8; i++) {
1846 gsm0503_tch_burst_unmap(&iB[i * 114],
1847 &bursts[i * 116], &h, i >> 2);
1848 steal -= h;
1849 }
Harald Weltec6636782017-06-12 14:59:37 +02001850 /* we now have the bits of the four bursts (interface 4 in
1851 * Figure 1a of TS 05.03 */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001852
1853 gsm0503_tch_fr_deinterleave(cB, iB);
Harald Weltec6636782017-06-12 14:59:37 +02001854 /* we now have the coded bits c(B): interface 3 in Fig. 1a */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001855
1856 if (steal > 0) {
1857 rv = _xcch_decode_cB(tch_data, cB, n_errors, n_bits_total);
1858 if (rv) {
1859 /* Error decoding FACCH frame */
1860 return -1;
1861 }
1862
Vadim Yanitskiyc0305b62023-05-20 16:33:38 +07001863 return GSM_MACBLOCK_LEN;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001864 }
1865
1866 osmo_conv_decode_ber(&gsm0503_tch_fr, cB, conv, n_errors, n_bits_total);
Harald Weltec6636782017-06-12 14:59:37 +02001867 /* we now have the data bits 'u': interface 2 in Fig. 1a */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001868
Harald Weltec6636782017-06-12 14:59:37 +02001869 /* input: 'conv', output: d[ata] + p[arity] */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001870 tch_fr_unreorder(d, p, conv);
1871
1872 for (i = 0; i < 78; i++)
1873 d[i + 182] = (cB[i + 378] < 0) ? 1 : 0;
1874
Harald Weltec6636782017-06-12 14:59:37 +02001875 /* check if parity of first 50 (class 1) 'd'-bits match 'p' */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001876 rv = osmo_crc8gen_check_bits(&gsm0503_tch_fr_crc3, d, 50, p);
1877 if (rv) {
1878 /* Error checking CRC8 for the FR part of an EFR/FR frame */
1879 return -1;
1880 }
1881
1882 if (efr) {
1883 tch_efr_d_to_w(w, d);
Harald Weltec6636782017-06-12 14:59:37 +02001884 /* we now have the preliminary-coded bits w(k) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001885
1886 tch_efr_unreorder(s, p, w);
Harald Weltec6636782017-06-12 14:59:37 +02001887 /* we now have the data delivered to the preliminary
1888 * channel encoding unit s(k) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001889
Harald Weltec6636782017-06-12 14:59:37 +02001890 /* extract the 65 most important bits according TS 05.03 3.1.1.1 */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001891 tch_efr_protected(s, b);
1892
Harald Weltec6636782017-06-12 14:59:37 +02001893 /* perform CRC-8 on 65 most important bits (50 bits of
1894 * class 1a + 15 bits of class 1b) */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001895 rv = osmo_crc8gen_check_bits(&gsm0503_tch_efr_crc8, b, 65, p);
1896 if (rv) {
1897 /* Error checking CRC8 for the EFR part of an EFR frame */
1898 return -1;
1899 }
1900
1901 tch_efr_reassemble(tch_data, s);
1902
1903 len = GSM_EFR_BYTES;
1904 } else {
1905 tch_fr_d_to_b(w, d);
1906
1907 tch_fr_reassemble(tch_data, w, net_order);
1908
1909 len = GSM_FR_BYTES;
1910 }
1911
1912 return len;
1913}
1914
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001915/*! Perform channel encoding on a TCH/FS channel according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02001916 * \param[out] bursts caller-allocated output buffer for bursts bits
1917 * \param[in] tch_data Codec input data in RTP payload format
1918 * \param[in] len Length of \a tch_data in bytes
1919 * \param[in] net_order FIXME
1920 * \returns 0 in case of success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02001921int gsm0503_tch_fr_encode(ubit_t *bursts, const uint8_t *tch_data,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001922 int len, int net_order)
1923{
1924 ubit_t iB[912], cB[456], h;
1925 ubit_t conv[185], w[260], b[65], s[244], d[260], p[8];
1926 int i;
1927
1928 switch (len) {
1929 case GSM_EFR_BYTES: /* TCH EFR */
1930
1931 tch_efr_disassemble(s, tch_data);
1932
1933 tch_efr_protected(s, b);
1934
1935 osmo_crc8gen_set_bits(&gsm0503_tch_efr_crc8, b, 65, p);
1936
1937 tch_efr_reorder(w, s, p);
1938
1939 tch_efr_w_to_d(d, w);
1940
1941 goto coding_efr_fr;
1942 case GSM_FR_BYTES: /* TCH FR */
1943 tch_fr_disassemble(w, tch_data, net_order);
1944
1945 tch_fr_b_to_d(d, w);
1946
1947coding_efr_fr:
1948 osmo_crc8gen_set_bits(&gsm0503_tch_fr_crc3, d, 50, p);
1949
1950 tch_fr_reorder(conv, d, p);
1951
1952 memcpy(cB + 378, d + 182, 78);
1953
1954 osmo_conv_encode(&gsm0503_tch_fr, conv, cB);
1955
1956 h = 0;
1957
1958 break;
1959 case GSM_MACBLOCK_LEN: /* FACCH */
1960 _xcch_encode_cB(cB, tch_data);
1961
1962 h = 1;
1963
1964 break;
1965 default:
1966 return -1;
1967 }
1968
1969 gsm0503_tch_fr_interleave(cB, iB);
1970
1971 for (i = 0; i < 8; i++) {
1972 gsm0503_tch_burst_map(&iB[i * 114],
1973 &bursts[i * 116], &h, i >> 2);
1974 }
1975
1976 return 0;
1977}
1978
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001979/*! Perform channel decoding of a HR(v1) channel according TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02001980 * \param[out] tch_data Codec frame in RTP payload format
1981 * \param[in] bursts buffer containing the symbols of 8 bursts
1982 * \param[in] odd Odd (1) or even (0) frame number
1983 * \param[out] n_errors Number of detected bit errors
1984 * \param[out] n_bits_total Total number of bits
Pau Espin Pedrolf81d03f2018-07-19 13:49:41 +02001985 * \returns length of bytes used in \a tch_data output buffer; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02001986int gsm0503_tch_hr_decode(uint8_t *tch_data, const sbit_t *bursts, int odd,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07001987 int *n_errors, int *n_bits_total)
1988{
1989 sbit_t iB[912], cB[456], h;
1990 ubit_t conv[98], b[112], d[112], p[3];
1991 int i, rv, steal = 0;
1992
1993 /* Only unmap the stealing bits */
1994 if (!odd) {
1995 for (i = 0; i < 4; i++) {
1996 gsm0503_tch_burst_unmap(NULL, &bursts[i * 116], &h, 0);
1997 steal -= h;
1998 }
1999
Mychaela N. Falconia920c0ed2023-05-23 14:06:53 +00002000 for (i = 2; i < 6; i++) {
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002001 gsm0503_tch_burst_unmap(NULL, &bursts[i * 116], &h, 1);
2002 steal -= h;
2003 }
2004 }
2005
2006 /* If we found a stole FACCH, but only at correct alignment */
2007 if (steal > 0) {
2008 for (i = 0; i < 6; i++) {
2009 gsm0503_tch_burst_unmap(&iB[i * 114],
2010 &bursts[i * 116], NULL, i >> 2);
2011 }
2012
2013 for (i = 2; i < 4; i++) {
2014 gsm0503_tch_burst_unmap(&iB[i * 114 + 456],
2015 &bursts[i * 116], NULL, 1);
2016 }
2017
2018 gsm0503_tch_fr_deinterleave(cB, iB);
2019
2020 rv = _xcch_decode_cB(tch_data, cB, n_errors, n_bits_total);
2021 if (rv) {
2022 /* Error decoding FACCH frame */
2023 return -1;
2024 }
2025
2026 return GSM_MACBLOCK_LEN;
2027 }
2028
2029 for (i = 0; i < 4; i++) {
2030 gsm0503_tch_burst_unmap(&iB[i * 114],
2031 &bursts[i * 116], NULL, i >> 1);
2032 }
2033
2034 gsm0503_tch_hr_deinterleave(cB, iB);
2035
2036 osmo_conv_decode_ber(&gsm0503_tch_hr, cB, conv, n_errors, n_bits_total);
2037
2038 tch_hr_unreorder(d, p, conv);
2039
2040 for (i = 0; i < 17; i++)
2041 d[i + 95] = (cB[i + 211] < 0) ? 1 : 0;
2042
2043 rv = osmo_crc8gen_check_bits(&gsm0503_tch_fr_crc3, d + 73, 22, p);
2044 if (rv) {
2045 /* Error checking CRC8 for an HR frame */
2046 return -1;
2047 }
2048
2049 tch_hr_d_to_b(b, d);
2050
2051 tch_hr_reassemble(tch_data, b);
2052
2053 return 15;
2054}
2055
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002056/*! Perform channel encoding on a TCH/HS channel according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02002057 * \param[out] bursts caller-allocated output buffer for bursts bits
2058 * \param[in] tch_data Codec input data in RTP payload format
2059 * \param[in] len Length of \a tch_data in bytes
2060 * \returns 0 in case of success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02002061int gsm0503_tch_hr_encode(ubit_t *bursts, const uint8_t *tch_data, int len)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002062{
2063 ubit_t iB[912], cB[456], h;
2064 ubit_t conv[98], b[112], d[112], p[3];
2065 int i;
2066
2067 switch (len) {
Mychaela N. Falconia8d8d5af2023-05-23 16:41:05 +00002068 case GSM_HR_BYTES_RTP_RFC5993: /* TCH HR with RFC 5993 prefix */
2069 tch_data++;
2070 /* fall-through */
2071 case GSM_HR_BYTES: /* TCH HR in "pure" form */
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002072 tch_hr_disassemble(b, tch_data);
2073
2074 tch_hr_b_to_d(d, b);
2075
2076 osmo_crc8gen_set_bits(&gsm0503_tch_fr_crc3, d + 73, 22, p);
2077
2078 tch_hr_reorder(conv, d, p);
2079
2080 osmo_conv_encode(&gsm0503_tch_hr, conv, cB);
2081
2082 memcpy(cB + 211, d + 95, 17);
2083
2084 h = 0;
2085
2086 gsm0503_tch_hr_interleave(cB, iB);
2087
2088 for (i = 0; i < 4; i++) {
2089 gsm0503_tch_burst_map(&iB[i * 114],
2090 &bursts[i * 116], &h, i >> 1);
2091 }
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002092 break;
2093 case GSM_MACBLOCK_LEN: /* FACCH */
2094 _xcch_encode_cB(cB, tch_data);
2095
2096 h = 1;
2097
2098 gsm0503_tch_fr_interleave(cB, iB);
2099
2100 for (i = 0; i < 6; i++) {
2101 gsm0503_tch_burst_map(&iB[i * 114],
2102 &bursts[i * 116], &h, i >> 2);
2103 }
2104
2105 for (i = 2; i < 4; i++) {
2106 gsm0503_tch_burst_map(&iB[i * 114 + 456],
2107 &bursts[i * 116], &h, 1);
2108 }
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002109 break;
2110 default:
2111 return -1;
2112 }
2113
2114 return 0;
2115}
2116
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002117/* TCH/AFS: parse codec ID (CMI or CMC/CMR) from coded in-band data (16 bit) */
2118static uint8_t gsm0503_tch_afs_decode_inband(const sbit_t *cB)
2119{
2120 unsigned int id = 0, best = 0;
2121 unsigned int i, j, k;
2122
2123 for (i = 0; i < 4; i++) {
2124 /* FIXME: why not using remaining (16 - 8) soft-bits here? */
2125 for (j = 0, k = 0; j < 8; j++)
2126 k += abs(((int)gsm0503_afs_ic_sbit[i][j]) - ((int)cB[j]));
2127
2128 if (i == 0 || k < best) {
2129 best = k;
2130 id = i;
2131 }
2132 }
2133
2134 return id;
2135}
2136
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002137/*! Perform channel decoding of a TCH/AFS channel according TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02002138 * \param[out] tch_data Codec frame in RTP payload format
2139 * \param[in] bursts buffer containing the symbols of 8 bursts
2140 * \param[in] codec_mode_req is this CMR (1) or CMC (0)
2141 * \param[in] codec array of active codecs (active codec set)
2142 * \param[in] codecs number of codecs in \a codec
2143 * \param ft Frame Type; Input if \a codec_mode_req = 1, Output * otherwise
2144 * \param[out] cmr Output in \a codec_mode_req = 1
2145 * \param[out] n_errors Number of detected bit errors
2146 * \param[out] n_bits_total Total number of bits
Pau Espin Pedrolf81d03f2018-07-19 13:49:41 +02002147 * \returns (>=4) length of bytes used in \a tch_data output buffer; ([0,3])
2148 * codec out of range; negative on error
2149 */
Harald Welteb9946d32017-06-12 09:40:16 +02002150int gsm0503_tch_afs_decode(uint8_t *tch_data, const sbit_t *bursts,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002151 int codec_mode_req, uint8_t *codec, int codecs, uint8_t *ft,
2152 uint8_t *cmr, int *n_errors, int *n_bits_total)
2153{
Philipp Maier898c9c62020-02-06 14:25:01 +01002154 return gsm0503_tch_afs_decode_dtx(tch_data, bursts, codec_mode_req,
2155 codec, codecs, ft, cmr, n_errors,
2156 n_bits_total, NULL);
2157}
2158
2159/*! Perform channel decoding of a TCH/AFS channel according TS 05.03
2160 * \param[out] tch_data Codec frame in RTP payload format
2161 * \param[in] bursts buffer containing the symbols of 8 bursts
2162 * \param[in] codec_mode_req is this CMR (1) or CMC (0)
2163 * \param[in] codec array of active codecs (active codec set)
2164 * \param[in] codecs number of codecs in \a codec
2165 * \param ft Frame Type; Input if \a codec_mode_req = 1, Output * otherwise
2166 * \param[out] cmr Output in \a codec_mode_req = 1
2167 * \param[out] n_errors Number of detected bit errors
2168 * \param[out] n_bits_total Total number of bits
2169 * \param[inout] dtx DTX frame type output, previous DTX frame type input
2170 * \returns (>=4) length of bytes used in \a tch_data output buffer; ([0,3])
2171 * codec out of range; negative on error
2172 */
2173int gsm0503_tch_afs_decode_dtx(uint8_t *tch_data, const sbit_t *bursts,
2174 int codec_mode_req, uint8_t *codec, int codecs, uint8_t *ft,
2175 uint8_t *cmr, int *n_errors, int *n_bits_total, uint8_t *dtx)
2176{
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002177 sbit_t iB[912], cB[456], h;
2178 ubit_t d[244], p[6], conv[250];
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002179 int i, rv, len, steal = 0, id = -1;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002180 *n_errors = 0; *n_bits_total = 0;
Philipp Maier898c9c62020-02-06 14:25:01 +01002181 static ubit_t sid_first_dummy[64] = { 0 };
2182 sbit_t sid_update_enc[256];
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002183
2184 for (i=0; i<8; i++) {
2185 gsm0503_tch_burst_unmap(&iB[i * 114], &bursts[i * 116], &h, i >> 2);
2186 steal -= h;
2187 }
2188
2189 gsm0503_tch_fr_deinterleave(cB, iB);
2190
2191 if (steal > 0) {
Vadim Yanitskiya2bee8b2022-05-16 19:40:45 +03002192 /* If not NULL, dtx indicates type of previously decoded TCH/AFS frame.
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002193 * It's normally updated by gsm0503_detect_afs_dtx_frame2(), which is not
Vadim Yanitskiya2bee8b2022-05-16 19:40:45 +03002194 * reached in case of FACCH. Reset it here to avoid FACCH/F frames being
2195 * misinterpreted as AMR's special DTX frames. */
2196 if (dtx != NULL)
2197 *dtx = AMR_OTHER;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002198 rv = _xcch_decode_cB(tch_data, cB, n_errors, n_bits_total);
2199 if (rv) {
2200 /* Error decoding FACCH frame */
2201 return -1;
2202 }
2203
2204 return GSM_MACBLOCK_LEN;
2205 }
2206
Philipp Maier898c9c62020-02-06 14:25:01 +01002207 /* Determine the DTX frame type (SID_UPDATE, ONSET etc...) */
2208 if (dtx) {
Vadim Yanitskiybf2d5e92022-05-15 15:58:10 +03002209 const enum gsm0503_amr_dtx_frames dtx_prev = *dtx;
2210
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002211 *dtx = gsm0503_detect_afs_dtx_frame2(n_errors, n_bits_total, &id, cB);
Philipp Maier898c9c62020-02-06 14:25:01 +01002212
Vadim Yanitskiyeebaccd2022-05-15 14:46:08 +03002213 switch (*dtx) {
2214 case AMR_OTHER:
Philipp Maier898c9c62020-02-06 14:25:01 +01002215 /* NOTE: The AFS_SID_UPDATE frame is splitted into
2216 * two half rate frames. If the id marker frame
2217 * (AFS_SID_UPDATE) is detected the following frame
2218 * contains the actual comfort noised data part of
2219 * (AFS_SID_UPDATE_CN). */
Vadim Yanitskiyeebaccd2022-05-15 14:46:08 +03002220 if (dtx_prev != AFS_SID_UPDATE)
2221 break;
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002222 /* TODO: parse CMI _and_ CMC/CMR (16 + 16 bit) */
Philipp Maier898c9c62020-02-06 14:25:01 +01002223 *dtx = AFS_SID_UPDATE_CN;
2224
2225 extract_afs_sid_update(sid_update_enc, cB);
2226 osmo_conv_decode_ber(&gsm0503_tch_axs_sid_update,
2227 sid_update_enc, conv, n_errors,
2228 n_bits_total);
2229 rv = osmo_crc16gen_check_bits(&gsm0503_amr_crc14, conv,
2230 35, conv + 35);
2231 if (rv != 0) {
2232 /* Error checking CRC14 for an AMR SID_UPDATE frame */
2233 return -1;
2234 }
2235
2236 tch_amr_sid_update_append(conv, 1,
2237 (codec_mode_req) ? codec[*ft]
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002238 : codec[id > 0 ? id : 0]);
Philipp Maier898c9c62020-02-06 14:25:01 +01002239 tch_amr_reassemble(tch_data, conv, 39);
2240 len = 5;
2241 goto out;
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002242 case AFS_SID_FIRST: /* TODO: parse CMI or CMC/CMR (16 bit) */
Philipp Maier898c9c62020-02-06 14:25:01 +01002243 tch_amr_sid_update_append(sid_first_dummy, 0,
2244 (codec_mode_req) ? codec[*ft]
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002245 : codec[id > 0 ? id : 0]);
Philipp Maier898c9c62020-02-06 14:25:01 +01002246 tch_amr_reassemble(tch_data, conv, 39);
2247 len = 5;
2248 goto out;
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002249 case AFS_SID_UPDATE: /* TODO: parse CMI _and_ CMC/CMR (16 + 16 bit) */
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002250 case AFS_ONSET:
Philipp Maier898c9c62020-02-06 14:25:01 +01002251 len = 0;
2252 goto out;
Vadim Yanitskiyeebaccd2022-05-15 14:46:08 +03002253 default:
2254 break;
Philipp Maier898c9c62020-02-06 14:25:01 +01002255 }
2256 }
2257
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002258 /* Parse codec ID (CMI or CMC/CMR) and check if it fits into range of codecs */
2259 if ((id = gsm0503_tch_afs_decode_inband(&cB[0])) >= codecs) {
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002260 /* Codec mode out of range, return id */
2261 return id;
2262 }
2263
2264 switch ((codec_mode_req) ? codec[*ft] : codec[id]) {
2265 case 7: /* TCH/AFS12.2 */
2266 osmo_conv_decode_ber(&gsm0503_tch_afs_12_2, cB + 8,
2267 conv, n_errors, n_bits_total);
2268
2269 tch_amr_unmerge(d, p, conv, 244, 81);
2270
2271 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 81, p);
2272 if (rv) {
2273 /* Error checking CRC8 for an AMR 12.2 frame */
2274 return -1;
2275 }
2276
2277 tch_amr_reassemble(tch_data, d, 244);
2278
2279 len = 31;
2280
2281 break;
2282 case 6: /* TCH/AFS10.2 */
2283 osmo_conv_decode_ber(&gsm0503_tch_afs_10_2, cB + 8,
2284 conv, n_errors, n_bits_total);
2285
2286 tch_amr_unmerge(d, p, conv, 204, 65);
2287
2288 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 65, p);
2289 if (rv) {
2290 /* Error checking CRC8 for an AMR 10.2 frame */
2291 return -1;
2292 }
2293
2294 tch_amr_reassemble(tch_data, d, 204);
2295
2296 len = 26;
2297
2298 break;
2299 case 5: /* TCH/AFS7.95 */
2300 osmo_conv_decode_ber(&gsm0503_tch_afs_7_95, cB + 8,
2301 conv, n_errors, n_bits_total);
2302
2303 tch_amr_unmerge(d, p, conv, 159, 75);
2304
2305 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 75, p);
2306 if (rv) {
2307 /* Error checking CRC8 for an AMR 7.95 frame */
2308 return -1;
2309 }
2310
2311 tch_amr_reassemble(tch_data, d, 159);
2312
2313 len = 20;
2314
2315 break;
2316 case 4: /* TCH/AFS7.4 */
2317 osmo_conv_decode_ber(&gsm0503_tch_afs_7_4, cB + 8,
2318 conv, n_errors, n_bits_total);
2319
2320 tch_amr_unmerge(d, p, conv, 148, 61);
2321
2322 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 61, p);
2323 if (rv) {
2324 /* Error checking CRC8 for an AMR 7.4 frame */
2325 return -1;
2326 }
2327
2328 tch_amr_reassemble(tch_data, d, 148);
2329
2330 len = 19;
2331
2332 break;
2333 case 3: /* TCH/AFS6.7 */
2334 osmo_conv_decode_ber(&gsm0503_tch_afs_6_7, cB + 8,
2335 conv, n_errors, n_bits_total);
2336
2337 tch_amr_unmerge(d, p, conv, 134, 55);
2338
2339 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 55, p);
2340 if (rv) {
2341 /* Error checking CRC8 for an AMR 6.7 frame */
2342 return -1;
2343 }
2344
2345 tch_amr_reassemble(tch_data, d, 134);
2346
2347 len = 17;
2348
2349 break;
2350 case 2: /* TCH/AFS5.9 */
2351 osmo_conv_decode_ber(&gsm0503_tch_afs_5_9, cB + 8,
2352 conv, n_errors, n_bits_total);
2353
2354 tch_amr_unmerge(d, p, conv, 118, 55);
2355
2356 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 55, p);
2357 if (rv) {
2358 /* Error checking CRC8 for an AMR 5.9 frame */
2359 return -1;
2360 }
2361
2362 tch_amr_reassemble(tch_data, d, 118);
2363
2364 len = 15;
2365
2366 break;
2367 case 1: /* TCH/AFS5.15 */
2368 osmo_conv_decode_ber(&gsm0503_tch_afs_5_15, cB + 8,
2369 conv, n_errors, n_bits_total);
2370
2371 tch_amr_unmerge(d, p, conv, 103, 49);
2372
2373 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 49, p);
2374 if (rv) {
2375 /* Error checking CRC8 for an AMR 5.15 frame */
2376 return -1;
2377 }
2378
2379 tch_amr_reassemble(tch_data, d, 103);
2380
2381 len = 13;
2382
2383 break;
2384 case 0: /* TCH/AFS4.75 */
2385 osmo_conv_decode_ber(&gsm0503_tch_afs_4_75, cB + 8,
2386 conv, n_errors, n_bits_total);
2387
2388 tch_amr_unmerge(d, p, conv, 95, 39);
2389
2390 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 39, p);
2391 if (rv) {
2392 /* Error checking CRC8 for an AMR 4.75 frame */
2393 return -1;
2394 }
2395
2396 tch_amr_reassemble(tch_data, d, 95);
2397
2398 len = 12;
2399
2400 break;
2401 default:
2402 /* Unknown frame type */
2403 *n_bits_total = 448;
2404 *n_errors = *n_bits_total;
2405 return -1;
2406 }
2407
Philipp Maier898c9c62020-02-06 14:25:01 +01002408out:
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002409 /* Change codec request / indication, if frame is valid */
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002410 if (id != -1) {
2411 if (codec_mode_req)
2412 *cmr = id;
2413 else
2414 *ft = id;
2415 }
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002416
2417 return len;
2418}
2419
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002420/*! Perform channel encoding on a TCH/AFS channel according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02002421 * \param[out] bursts caller-allocated output buffer for bursts bits
2422 * \param[in] tch_data Codec input data in RTP payload format
2423 * \param[in] len Length of \a tch_data in bytes
2424 * \param[in] codec_mode_req Use CMR (1) or FT (0)
2425 * \param[in] codec Array of codecs (active codec set)
2426 * \param[in] codecs Number of entries in \a codec
2427 * \param[in] ft Frame Type to be used for encoding (index to \a codec)
2428 * \param[in] cmr Codec Mode Request (used in codec_mode_req = 1 only)
2429 * \returns 0 in case of success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02002430int gsm0503_tch_afs_encode(ubit_t *bursts, const uint8_t *tch_data, int len,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002431 int codec_mode_req, uint8_t *codec, int codecs, uint8_t ft,
2432 uint8_t cmr)
2433{
2434 ubit_t iB[912], cB[456], h;
2435 ubit_t d[244], p[6], conv[250];
2436 int i;
2437 uint8_t id;
2438
2439 if (len == GSM_MACBLOCK_LEN) { /* FACCH */
2440 _xcch_encode_cB(cB, tch_data);
2441
2442 h = 1;
2443
2444 goto facch;
2445 }
2446
2447 h = 0;
2448
2449 if (codec_mode_req) {
2450 if (cmr >= codecs) {
2451 /* FIXME: CMR ID is not in codec list! */
2452 return -1;
2453 }
2454 id = cmr;
2455 } else {
2456 if (ft >= codecs) {
2457 /* FIXME: FT ID is not in codec list! */
2458 return -1;
2459 }
2460 id = ft;
2461 }
2462
2463 switch (codec[ft]) {
2464 case 7: /* TCH/AFS12.2 */
2465 if (len != 31)
2466 goto invalid_length;
2467
2468 tch_amr_disassemble(d, tch_data, 244);
2469
2470 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 81, p);
2471
2472 tch_amr_merge(conv, d, p, 244, 81);
2473
2474 osmo_conv_encode(&gsm0503_tch_afs_12_2, conv, cB + 8);
2475
2476 break;
2477 case 6: /* TCH/AFS10.2 */
2478 if (len != 26)
2479 goto invalid_length;
2480
2481 tch_amr_disassemble(d, tch_data, 204);
2482
2483 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 65, p);
2484
2485 tch_amr_merge(conv, d, p, 204, 65);
2486
2487 osmo_conv_encode(&gsm0503_tch_afs_10_2, conv, cB + 8);
2488
2489 break;
2490 case 5: /* TCH/AFS7.95 */
2491 if (len != 20)
2492 goto invalid_length;
2493
2494 tch_amr_disassemble(d, tch_data, 159);
2495
2496 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 75, p);
2497
2498 tch_amr_merge(conv, d, p, 159, 75);
2499
2500 osmo_conv_encode(&gsm0503_tch_afs_7_95, conv, cB + 8);
2501
2502 break;
2503 case 4: /* TCH/AFS7.4 */
2504 if (len != 19)
2505 goto invalid_length;
2506
2507 tch_amr_disassemble(d, tch_data, 148);
2508
2509 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 61, p);
2510
2511 tch_amr_merge(conv, d, p, 148, 61);
2512
2513 osmo_conv_encode(&gsm0503_tch_afs_7_4, conv, cB + 8);
2514
2515 break;
2516 case 3: /* TCH/AFS6.7 */
2517 if (len != 17)
2518 goto invalid_length;
2519
2520 tch_amr_disassemble(d, tch_data, 134);
2521
2522 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 55, p);
2523
2524 tch_amr_merge(conv, d, p, 134, 55);
2525
2526 osmo_conv_encode(&gsm0503_tch_afs_6_7, conv, cB + 8);
2527
2528 break;
2529 case 2: /* TCH/AFS5.9 */
2530 if (len != 15)
2531 goto invalid_length;
2532
2533 tch_amr_disassemble(d, tch_data, 118);
2534
2535 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 55, p);
2536
2537 tch_amr_merge(conv, d, p, 118, 55);
2538
2539 osmo_conv_encode(&gsm0503_tch_afs_5_9, conv, cB + 8);
2540
2541 break;
2542 case 1: /* TCH/AFS5.15 */
2543 if (len != 13)
2544 goto invalid_length;
2545
2546 tch_amr_disassemble(d, tch_data, 103);
2547
2548 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 49, p);
2549
2550 tch_amr_merge(conv, d, p, 103, 49);
2551
2552 osmo_conv_encode(&gsm0503_tch_afs_5_15, conv, cB + 8);
2553
2554 break;
2555 case 0: /* TCH/AFS4.75 */
2556 if (len != 12)
2557 goto invalid_length;
2558
2559 tch_amr_disassemble(d, tch_data, 95);
2560
2561 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 39, p);
2562
2563 tch_amr_merge(conv, d, p, 95, 39);
2564
2565 osmo_conv_encode(&gsm0503_tch_afs_4_75, conv, cB + 8);
2566
2567 break;
2568 default:
2569 /* FIXME: FT %ft is not supported */
2570 return -1;
2571 }
2572
2573 memcpy(cB, gsm0503_afs_ic_ubit[id], 8);
2574
2575facch:
2576 gsm0503_tch_fr_interleave(cB, iB);
2577
2578 for (i = 0; i < 8; i++) {
2579 gsm0503_tch_burst_map(&iB[i * 114],
2580 &bursts[i * 116], &h, i >> 2);
2581 }
2582
2583 return 0;
2584
2585invalid_length:
2586 /* FIXME: payload length %len does not comply with codec type %ft */
2587 return -1;
2588}
2589
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002590/* TCH/AHS: parse codec ID (CMI or CMC/CMR) from coded in-band data (16 bit) */
2591static uint8_t gsm0503_tch_ahs_decode_inband(const sbit_t *cB)
2592{
2593 unsigned int id = 0, best = 0;
2594 unsigned int i, j, k;
2595
2596 for (i = 0, k = 0; i < 4; i++) {
2597 /* FIXME: why not using remaining (16 - 4) soft-bits here? */
2598 for (j = 0, k = 0; j < 4; j++)
2599 k += abs(((int)gsm0503_ahs_ic_sbit[i][j]) - ((int)cB[j]));
2600
2601 if (i == 0 || k < best) {
2602 best = k;
2603 id = i;
2604 }
2605 }
2606
2607 return id;
2608}
2609
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002610/*! Perform channel decoding of a TCH/AFS channel according TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02002611 * \param[out] tch_data Codec frame in RTP payload format
2612 * \param[in] bursts buffer containing the symbols of 8 bursts
2613 * \param[in] odd Is this an odd (1) or even (0) frame number?
2614 * \param[in] codec_mode_req is this CMR (1) or CMC (0)
2615 * \param[in] codec array of active codecs (active codec set)
2616 * \param[in] codecs number of codecs in \a codec
2617 * \param ft Frame Type; Input if \a codec_mode_req = 1, Output * otherwise
2618 * \param[out] cmr Output in \a codec_mode_req = 1
2619 * \param[out] n_errors Number of detected bit errors
2620 * \param[out] n_bits_total Total number of bits
Pau Espin Pedrolf81d03f2018-07-19 13:49:41 +02002621 * \returns (>=4) length of bytes used in \a tch_data output buffer; ([0,3])
2622 * codec out of range; negative on error
2623 */
Harald Welteb9946d32017-06-12 09:40:16 +02002624int gsm0503_tch_ahs_decode(uint8_t *tch_data, const sbit_t *bursts, int odd,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002625 int codec_mode_req, uint8_t *codec, int codecs, uint8_t *ft,
2626 uint8_t *cmr, int *n_errors, int *n_bits_total)
2627{
Philipp Maier898c9c62020-02-06 14:25:01 +01002628 return gsm0503_tch_ahs_decode_dtx(tch_data, bursts, odd, codec_mode_req,
2629 codec, codecs, ft, cmr, n_errors,
2630 n_bits_total, NULL);
2631}
2632
2633/*! Perform channel decoding of a TCH/AFS channel according TS 05.03
2634 * \param[out] tch_data Codec frame in RTP payload format
2635 * \param[in] bursts buffer containing the symbols of 8 bursts
2636 * \param[in] odd Is this an odd (1) or even (0) frame number?
2637 * \param[in] codec_mode_req is this CMR (1) or CMC (0)
2638 * \param[in] codec array of active codecs (active codec set)
2639 * \param[in] codecs number of codecs in \a codec
2640 * \param ft Frame Type; Input if \a codec_mode_req = 1, Output * otherwise
2641 * \param[out] cmr Output in \a codec_mode_req = 1
2642 * \param[out] n_errors Number of detected bit errors
2643 * \param[out] n_bits_total Total number of bits
2644 * \param[inout] dtx DTX frame type output, previous DTX frame type input
2645 * \returns (>=4) length of bytes used in \a tch_data output buffer; ([0,3])
2646 * codec out of range; negative on error
2647 */
2648int gsm0503_tch_ahs_decode_dtx(uint8_t *tch_data, const sbit_t *bursts, int odd,
2649 int codec_mode_req, uint8_t *codec, int codecs, uint8_t *ft,
2650 uint8_t *cmr, int *n_errors, int *n_bits_total, uint8_t *dtx)
2651{
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002652 sbit_t iB[912], cB[456], h;
2653 ubit_t d[244], p[6], conv[135];
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002654 int i, rv, len, steal = 0, id = -1;
Philipp Maier898c9c62020-02-06 14:25:01 +01002655 static ubit_t sid_first_dummy[64] = { 0 };
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002656
2657 /* only unmap the stealing bits */
2658 if (!odd) {
2659 for (i = 0; i < 4; i++) {
2660 gsm0503_tch_burst_unmap(NULL, &bursts[i * 116], &h, 0);
2661 steal -= h;
2662 }
2663 for (i = 2; i < 5; i++) {
2664 gsm0503_tch_burst_unmap(NULL, &bursts[i * 116], &h, 1);
2665 steal -= h;
2666 }
2667 }
2668
2669 /* if we found a stole FACCH, but only at correct alignment */
2670 if (steal > 0) {
Vadim Yanitskiya2bee8b2022-05-16 19:40:45 +03002671 /* If not NULL, dtx indicates type of previously decoded TCH/AHS frame.
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002672 * It's normally updated by gsm0503_detect_ahs_dtx_frame2(), which is not
Vadim Yanitskiya2bee8b2022-05-16 19:40:45 +03002673 * reached in case of FACCH. Reset it here to avoid FACCH/H frames being
2674 * misinterpreted as AMR's special DTX frames. */
2675 if (dtx != NULL)
2676 *dtx = AMR_OTHER;
2677
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002678 for (i = 0; i < 6; i++) {
2679 gsm0503_tch_burst_unmap(&iB[i * 114],
2680 &bursts[i * 116], NULL, i >> 2);
2681 }
2682
2683 for (i = 2; i < 4; i++) {
2684 gsm0503_tch_burst_unmap(&iB[i * 114 + 456],
2685 &bursts[i * 116], NULL, 1);
2686 }
2687
2688 gsm0503_tch_fr_deinterleave(cB, iB);
2689
2690 rv = _xcch_decode_cB(tch_data, cB, n_errors, n_bits_total);
2691 if (rv) {
2692 /* Error decoding FACCH frame */
2693 return -1;
2694 }
2695
2696 return GSM_MACBLOCK_LEN;
2697 }
2698
2699 for (i = 0; i < 4; i++) {
2700 gsm0503_tch_burst_unmap(&iB[i * 114],
2701 &bursts[i * 116], NULL, i >> 1);
2702 }
2703
2704 gsm0503_tch_hr_deinterleave(cB, iB);
2705
Philipp Maier898c9c62020-02-06 14:25:01 +01002706 /* Determine the DTX frame type (SID_UPDATE, ONSET etc...) */
2707 if (dtx) {
Vadim Yanitskiy77904592022-05-19 17:43:57 +03002708 int n_bits_total_sid;
2709 int n_errors_sid;
Vadim Yanitskiybf2d5e92022-05-15 15:58:10 +03002710
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002711 *dtx = gsm0503_detect_ahs_dtx_frame2(n_errors, n_bits_total, &id, cB);
Vadim Yanitskiy77904592022-05-19 17:43:57 +03002712 /* TODO: detect and handle AHS_SID_UPDATE + AHS_SID_UPDATE_INH */
Philipp Maier898c9c62020-02-06 14:25:01 +01002713
Vadim Yanitskiyeebaccd2022-05-15 14:46:08 +03002714 switch (*dtx) {
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002715 case AHS_SID_UPDATE: /* TODO: parse CMI _and_ CMC/CMR (16 + 16 bit) */
Vadim Yanitskiy77904592022-05-19 17:43:57 +03002716 /* cB[] contains 16 bits of coded in-band data and 212 bits containing
2717 * the identification marker. We need to unmap/deinterleave 114 odd
2718 * bits from the last two blocks, 114 even bits from the first two
2719 * blocks and combine them together. */
2720 gsm0503_tch_burst_unmap(&iB[0 * 114], &bursts[2 * 116], NULL, 0);
2721 gsm0503_tch_burst_unmap(&iB[1 * 114], &bursts[3 * 116], NULL, 0);
2722 gsm0503_tch_burst_unmap(&iB[2 * 114], &bursts[0 * 116], NULL, 1);
2723 gsm0503_tch_burst_unmap(&iB[3 * 114], &bursts[1 * 116], NULL, 1);
2724 gsm0503_tch_hr_deinterleave(cB, iB);
2725
2726 /* cB[] is expected to contain 16 bits of coded in-band data and
2727 * 212 bits containing the coded data (53 bits coded at 1/4 rate). */
Philipp Maier898c9c62020-02-06 14:25:01 +01002728 *dtx = AHS_SID_UPDATE_CN;
2729
2730 osmo_conv_decode_ber(&gsm0503_tch_axs_sid_update,
Vadim Yanitskiy77904592022-05-19 17:43:57 +03002731 cB + 16, conv, &n_errors_sid,
2732 &n_bits_total_sid);
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002733 /* gsm0503_detect_ahs_dtx_frame2() calculates BER for the marker,
Vadim Yanitskiy77904592022-05-19 17:43:57 +03002734 * osmo_conv_decode_ber() calculates BER for the coded data. */
2735 if (n_errors != NULL)
2736 *n_errors += n_errors_sid;
2737 if (n_bits_total != NULL)
2738 *n_bits_total += n_bits_total_sid;
Philipp Maier898c9c62020-02-06 14:25:01 +01002739 rv = osmo_crc16gen_check_bits(&gsm0503_amr_crc14, conv,
2740 35, conv + 35);
2741 if (rv != 0) {
2742 /* Error checking CRC14 for an AMR SID_UPDATE frame */
2743 return -1;
2744 }
2745
2746 tch_amr_sid_update_append(conv, 1,
2747 (codec_mode_req) ? codec[*ft]
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002748 : codec[id > 0 ? id : 0]);
Philipp Maier898c9c62020-02-06 14:25:01 +01002749 tch_amr_reassemble(tch_data, conv, 39);
2750 len = 5;
2751 goto out;
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002752 case AHS_SID_FIRST_P2:
Philipp Maier898c9c62020-02-06 14:25:01 +01002753 tch_amr_sid_update_append(sid_first_dummy, 0,
2754 (codec_mode_req) ? codec[*ft]
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002755 : codec[id > 0 ? id : 0]);
Philipp Maier898c9c62020-02-06 14:25:01 +01002756 tch_amr_reassemble(tch_data, sid_first_dummy, 39);
2757 len = 5;
2758 goto out;
Vadim Yanitskiycc4213e2022-05-24 04:17:23 +07002759 case AHS_ONSET:
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002760 case AHS_SID_FIRST_INH: /* TODO: parse CMI or CMC/CMR (16 bit) */
2761 case AHS_SID_UPDATE_INH: /* TODO: parse CMI or CMC/CMR (16 bit) */
2762 case AHS_SID_FIRST_P1: /* TODO: parse CMI or CMC/CMR (16 bit) */
Philipp Maier898c9c62020-02-06 14:25:01 +01002763 len = 0;
2764 goto out;
Vadim Yanitskiyeebaccd2022-05-15 14:46:08 +03002765 default:
2766 break;
Philipp Maier898c9c62020-02-06 14:25:01 +01002767 }
2768 }
2769
Vadim Yanitskiyb57e6392022-05-24 02:51:50 +07002770 /* Parse codec ID (CMI or CMC/CMR) and check if it fits into range of codecs */
2771 if ((id = gsm0503_tch_ahs_decode_inband(&cB[0])) >= codecs) {
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002772 /* Codec mode out of range, return id */
2773 return id;
2774 }
2775
2776 switch ((codec_mode_req) ? codec[*ft] : codec[id]) {
2777 case 5: /* TCH/AHS7.95 */
2778 osmo_conv_decode_ber(&gsm0503_tch_ahs_7_95, cB + 4,
2779 conv, n_errors, n_bits_total);
2780
2781 tch_amr_unmerge(d, p, conv, 123, 67);
2782
2783 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 67, p);
2784 if (rv) {
2785 /* Error checking CRC8 for an AMR 7.95 frame */
2786 return -1;
2787 }
2788
2789 for (i = 0; i < 36; i++)
2790 d[i + 123] = (cB[i + 192] < 0) ? 1 : 0;
2791
2792 tch_amr_reassemble(tch_data, d, 159);
2793
2794 len = 20;
2795
2796 break;
2797 case 4: /* TCH/AHS7.4 */
2798 osmo_conv_decode_ber(&gsm0503_tch_ahs_7_4, cB + 4,
2799 conv, n_errors, n_bits_total);
2800
2801 tch_amr_unmerge(d, p, conv, 120, 61);
2802
2803 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 61, p);
2804 if (rv) {
2805 /* Error checking CRC8 for an AMR 7.4 frame */
2806 return -1;
2807 }
2808
2809 for (i = 0; i < 28; i++)
2810 d[i + 120] = (cB[i + 200] < 0) ? 1 : 0;
2811
2812 tch_amr_reassemble(tch_data, d, 148);
2813
2814 len = 19;
2815
2816 break;
2817 case 3: /* TCH/AHS6.7 */
2818 osmo_conv_decode_ber(&gsm0503_tch_ahs_6_7, cB + 4,
2819 conv, n_errors, n_bits_total);
2820
2821 tch_amr_unmerge(d, p, conv, 110, 55);
2822
2823 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 55, p);
2824 if (rv) {
2825 /* Error checking CRC8 for an AMR 6.7 frame */
2826 return -1;
2827 }
2828
2829 for (i = 0; i < 24; i++)
2830 d[i + 110] = (cB[i + 204] < 0) ? 1 : 0;
2831
2832 tch_amr_reassemble(tch_data, d, 134);
2833
2834 len = 17;
2835
2836 break;
2837 case 2: /* TCH/AHS5.9 */
2838 osmo_conv_decode_ber(&gsm0503_tch_ahs_5_9, cB + 4,
2839 conv, n_errors, n_bits_total);
2840
2841 tch_amr_unmerge(d, p, conv, 102, 55);
2842
2843 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 55, p);
2844 if (rv) {
2845 /* Error checking CRC8 for an AMR 5.9 frame */
2846 return -1;
2847 }
2848
2849 for (i = 0; i < 16; i++)
2850 d[i + 102] = (cB[i + 212] < 0) ? 1 : 0;
2851
2852 tch_amr_reassemble(tch_data, d, 118);
2853
2854 len = 15;
2855
2856 break;
2857 case 1: /* TCH/AHS5.15 */
2858 osmo_conv_decode_ber(&gsm0503_tch_ahs_5_15, cB + 4,
2859 conv, n_errors, n_bits_total);
2860
2861 tch_amr_unmerge(d, p, conv, 91, 49);
2862
2863 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 49, p);
2864 if (rv) {
2865 /* Error checking CRC8 for an AMR 5.15 frame */
2866 return -1;
2867 }
2868
2869 for (i = 0; i < 12; i++)
2870 d[i + 91] = (cB[i + 216] < 0) ? 1 : 0;
2871
2872 tch_amr_reassemble(tch_data, d, 103);
2873
2874 len = 13;
2875
2876 break;
2877 case 0: /* TCH/AHS4.75 */
2878 osmo_conv_decode_ber(&gsm0503_tch_ahs_4_75, cB + 4,
2879 conv, n_errors, n_bits_total);
2880
2881 tch_amr_unmerge(d, p, conv, 83, 39);
2882
2883 rv = osmo_crc8gen_check_bits(&gsm0503_amr_crc6, d, 39, p);
2884 if (rv) {
2885 /* Error checking CRC8 for an AMR 4.75 frame */
2886 return -1;
2887 }
2888
2889 for (i = 0; i < 12; i++)
2890 d[i + 83] = (cB[i + 216] < 0) ? 1 : 0;
2891
2892 tch_amr_reassemble(tch_data, d, 95);
2893
2894 len = 12;
2895
2896 break;
2897 default:
2898 /* Unknown frame type */
2899 *n_bits_total = 159;
2900 *n_errors = *n_bits_total;
2901 return -1;
2902 }
2903
Philipp Maier898c9c62020-02-06 14:25:01 +01002904out:
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002905 /* Change codec request / indication, if frame is valid */
Vadim Yanitskiyd6dca0c2022-05-21 18:36:54 +03002906 if (id != -1) {
2907 if (codec_mode_req)
2908 *cmr = id;
2909 else
2910 *ft = id;
2911 }
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002912
2913 return len;
2914}
2915
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002916/*! Perform channel encoding on a TCH/AHS channel according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02002917 * \param[out] bursts caller-allocated output buffer for bursts bits
2918 * \param[in] tch_data Codec input data in RTP payload format
2919 * \param[in] len Length of \a tch_data in bytes
2920 * \param[in] codec_mode_req Use CMR (1) or FT (0)
2921 * \param[in] codec Array of codecs (active codec set)
2922 * \param[in] codecs Number of entries in \a codec
2923 * \param[in] ft Frame Type to be used for encoding (index to \a codec)
2924 * \param[in] cmr Codec Mode Request (used in codec_mode_req = 1 only)
2925 * \returns 0 in case of success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02002926int gsm0503_tch_ahs_encode(ubit_t *bursts, const uint8_t *tch_data, int len,
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07002927 int codec_mode_req, uint8_t *codec, int codecs, uint8_t ft,
2928 uint8_t cmr)
2929{
2930 ubit_t iB[912], cB[456], h;
2931 ubit_t d[244], p[6], conv[135];
2932 int i;
2933 uint8_t id;
2934
2935 if (len == GSM_MACBLOCK_LEN) { /* FACCH */
2936 _xcch_encode_cB(cB, tch_data);
2937
2938 h = 1;
2939
2940 gsm0503_tch_fr_interleave(cB, iB);
2941
2942 for (i = 0; i < 6; i++)
2943 gsm0503_tch_burst_map(&iB[i * 114], &bursts[i * 116],
2944 &h, i >> 2);
2945 for (i = 2; i < 4; i++)
2946 gsm0503_tch_burst_map(&iB[i * 114 + 456],
2947 &bursts[i * 116], &h, 1);
2948
2949 return 0;
2950 }
2951
2952 h = 0;
2953
2954 if (codec_mode_req) {
2955 if (cmr >= codecs) {
2956 /* FIXME: CMR ID %d not in codec list */
2957 return -1;
2958 }
2959 id = cmr;
2960 } else {
2961 if (ft >= codecs) {
2962 /* FIXME: FT ID %d not in codec list */
2963 return -1;
2964 }
2965 id = ft;
2966 }
2967
2968 switch (codec[ft]) {
2969 case 5: /* TCH/AHS7.95 */
2970 if (len != 20)
2971 goto invalid_length;
2972
2973 tch_amr_disassemble(d, tch_data, 159);
2974
2975 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 67, p);
2976
2977 tch_amr_merge(conv, d, p, 123, 67);
2978
2979 osmo_conv_encode(&gsm0503_tch_ahs_7_95, conv, cB + 4);
2980
2981 memcpy(cB + 192, d + 123, 36);
2982
2983 break;
2984 case 4: /* TCH/AHS7.4 */
2985 if (len != 19)
2986 goto invalid_length;
2987
2988 tch_amr_disassemble(d, tch_data, 148);
2989
2990 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 61, p);
2991
2992 tch_amr_merge(conv, d, p, 120, 61);
2993
2994 osmo_conv_encode(&gsm0503_tch_ahs_7_4, conv, cB + 4);
2995
2996 memcpy(cB + 200, d + 120, 28);
2997
2998 break;
2999 case 3: /* TCH/AHS6.7 */
3000 if (len != 17)
3001 goto invalid_length;
3002
3003 tch_amr_disassemble(d, tch_data, 134);
3004
3005 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 55, p);
3006
3007 tch_amr_merge(conv, d, p, 110, 55);
3008
3009 osmo_conv_encode(&gsm0503_tch_ahs_6_7, conv, cB + 4);
3010
3011 memcpy(cB + 204, d + 110, 24);
3012
3013 break;
3014 case 2: /* TCH/AHS5.9 */
3015 if (len != 15)
3016 goto invalid_length;
3017
3018 tch_amr_disassemble(d, tch_data, 118);
3019
3020 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 55, p);
3021
3022 tch_amr_merge(conv, d, p, 102, 55);
3023
3024 osmo_conv_encode(&gsm0503_tch_ahs_5_9, conv, cB + 4);
3025
3026 memcpy(cB + 212, d + 102, 16);
3027
3028 break;
3029 case 1: /* TCH/AHS5.15 */
3030 if (len != 13)
3031 goto invalid_length;
3032
3033 tch_amr_disassemble(d, tch_data, 103);
3034
3035 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 49, p);
3036
3037 tch_amr_merge(conv, d, p, 91, 49);
3038
3039 osmo_conv_encode(&gsm0503_tch_ahs_5_15, conv, cB + 4);
3040
3041 memcpy(cB + 216, d + 91, 12);
3042
3043 break;
3044 case 0: /* TCH/AHS4.75 */
3045 if (len != 12)
3046 goto invalid_length;
3047
3048 tch_amr_disassemble(d, tch_data, 95);
3049
3050 osmo_crc8gen_set_bits(&gsm0503_amr_crc6, d, 39, p);
3051
3052 tch_amr_merge(conv, d, p, 83, 39);
3053
3054 osmo_conv_encode(&gsm0503_tch_ahs_4_75, conv, cB + 4);
3055
3056 memcpy(cB + 216, d + 83, 12);
3057
3058 break;
3059 default:
3060 /* FIXME: FT %ft is not supported */
3061 return -1;
3062 }
3063
Philipp Maiercfea39b2021-08-31 16:02:31 +02003064 memcpy(cB, gsm0503_ahs_ic_ubit[id], 4);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003065
3066 gsm0503_tch_hr_interleave(cB, iB);
3067
3068 for (i = 0; i < 4; i++)
3069 gsm0503_tch_burst_map(&iB[i * 114], &bursts[i * 116], &h, i >> 1);
3070
3071 return 0;
3072
3073invalid_length:
3074 /* FIXME: payload length %len does not comply with codec type %ft */
3075 return -1;
3076}
3077
3078/*
3079 * GSM RACH transcoding
3080 */
3081
3082/*
3083 * GSM RACH apply BSIC to parity
3084 *
3085 * p(j) = p(j) xor b(j) j = 0, ..., 5
3086 * b(0) = MSB of PLMN colour code
3087 * b(5) = LSB of BS colour code
3088 */
Max32e56412017-10-16 14:58:00 +02003089static inline void rach_apply_bsic(ubit_t *d, uint8_t bsic, uint8_t start)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003090{
3091 int i;
3092
3093 /* Apply it */
3094 for (i = 0; i < 6; i++)
Max32e56412017-10-16 14:58:00 +02003095 d[start + i] ^= ((bsic >> (5 - i)) & 1);
3096}
3097
Harald Welte6950b192018-02-26 11:48:00 +01003098static inline int16_t rach_decode_ber(const sbit_t *burst, uint8_t bsic, bool is_11bit,
3099 int *n_errors, int *n_bits_total)
Max32e56412017-10-16 14:58:00 +02003100{
3101 ubit_t conv[17];
3102 uint8_t ra[2] = { 0 }, nbits = is_11bit ? 11 : 8;
3103 int rv;
3104
Harald Welte6950b192018-02-26 11:48:00 +01003105 osmo_conv_decode_ber(is_11bit ? &gsm0503_rach_ext : &gsm0503_rach, burst, conv,
3106 n_errors, n_bits_total);
Max32e56412017-10-16 14:58:00 +02003107
3108 rach_apply_bsic(conv, bsic, nbits);
3109
3110 rv = osmo_crc8gen_check_bits(&gsm0503_rach_crc6, conv, nbits, conv + nbits);
3111 if (rv)
3112 return -1;
3113
3114 osmo_ubit2pbit_ext(ra, 0, conv, 0, nbits, 1);
3115
Vadim Yanitskiy9e713f32020-03-31 19:40:09 +07003116 return is_11bit ? ((ra[0] << 3) | (ra[1] & 0x07)) : ra[0];
Max32e56412017-10-16 14:58:00 +02003117}
3118
3119/*! Decode the Extended (11-bit) RACH according to 3GPP TS 45.003
3120 * \param[out] ra output buffer for RACH data
3121 * \param[in] burst Input burst data
3122 * \param[in] bsic BSIC used in this cell
3123 * \returns 0 on success; negative on error (e.g. CRC error) */
3124int gsm0503_rach_ext_decode(uint16_t *ra, const sbit_t *burst, uint8_t bsic)
3125{
Harald Welte6950b192018-02-26 11:48:00 +01003126 int16_t r = rach_decode_ber(burst, bsic, true, NULL, NULL);
Max32e56412017-10-16 14:58:00 +02003127
3128 if (r < 0)
3129 return r;
3130
3131 *ra = r;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003132
3133 return 0;
3134}
3135
Neels Hofmeyr87e45502017-06-20 00:17:59 +02003136/*! Decode the (8-bit) RACH according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02003137 * \param[out] ra output buffer for RACH data
3138 * \param[in] burst Input burst data
3139 * \param[in] bsic BSIC used in this cell
3140 * \returns 0 on success; negative on error (e.g. CRC error) */
Harald Welteb9946d32017-06-12 09:40:16 +02003141int gsm0503_rach_decode(uint8_t *ra, const sbit_t *burst, uint8_t bsic)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003142{
Harald Welte6950b192018-02-26 11:48:00 +01003143 int16_t r = rach_decode_ber(burst, bsic, false, NULL, NULL);
3144 if (r < 0)
3145 return r;
3146
3147 *ra = r;
3148 return 0;
3149}
3150
3151/*! Decode the Extended (11-bit) RACH according to 3GPP TS 45.003
3152 * \param[out] ra output buffer for RACH data
3153 * \param[in] burst Input burst data
3154 * \param[in] bsic BSIC used in this cell
3155 * \param[out] n_errors Number of detected bit errors
3156 * \param[out] n_bits_total Total number of bits
3157 * \returns 0 on success; negative on error (e.g. CRC error) */
3158int gsm0503_rach_ext_decode_ber(uint16_t *ra, const sbit_t *burst, uint8_t bsic,
3159 int *n_errors, int *n_bits_total)
3160{
3161 int16_t r = rach_decode_ber(burst, bsic, true, n_errors, n_bits_total);
3162 if (r < 0)
3163 return r;
3164
3165 *ra = r;
3166 return 0;
3167}
3168
3169/*! Decode the (8-bit) RACH according to TS 05.03
3170 * \param[out] ra output buffer for RACH data
3171 * \param[in] burst Input burst data
3172 * \param[in] bsic BSIC used in this cell
3173 * \param[out] n_errors Number of detected bit errors
3174 * \param[out] n_bits_total Total number of bits
3175 * \returns 0 on success; negative on error (e.g. CRC error) */
3176int gsm0503_rach_decode_ber(uint8_t *ra, const sbit_t *burst, uint8_t bsic,
3177 int *n_errors, int *n_bits_total)
3178{
3179 int16_t r = rach_decode_ber(burst, bsic, false, n_errors, n_bits_total);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003180
Max32e56412017-10-16 14:58:00 +02003181 if (r < 0)
3182 return r;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003183
Max32e56412017-10-16 14:58:00 +02003184 *ra = r;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003185
3186 return 0;
3187}
3188
Neels Hofmeyr87e45502017-06-20 00:17:59 +02003189/*! Encode the (8-bit) RACH according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02003190 * \param[out] burst Caller-allocated output burst buffer
3191 * \param[in] ra Input RACH data
3192 * \param[in] bsic BSIC used in this cell
3193 * \returns 0 on success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02003194int gsm0503_rach_encode(ubit_t *burst, const uint8_t *ra, uint8_t bsic)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003195{
Max32e56412017-10-16 14:58:00 +02003196 return gsm0503_rach_ext_encode(burst, *ra, bsic, false);
3197}
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003198
Max32e56412017-10-16 14:58:00 +02003199/*! Encode the Extended (11-bit) or regular (8-bit) RACH according to 3GPP TS 45.003
3200 * \param[out] burst Caller-allocated output burst buffer
3201 * \param[in] ra11 Input RACH data
3202 * \param[in] bsic BSIC used in this cell
3203 * \param[in] is_11bit whether given RA is 11 bit or not
3204 * \returns 0 on success; negative on error */
3205int gsm0503_rach_ext_encode(ubit_t *burst, uint16_t ra11, uint8_t bsic, bool is_11bit)
3206{
3207 ubit_t conv[17];
3208 uint8_t ra[2] = { 0 }, nbits = 8;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003209
Max32e56412017-10-16 14:58:00 +02003210 if (is_11bit) {
Vadim Yanitskiy9e713f32020-03-31 19:40:09 +07003211 ra[0] = (uint8_t) (ra11 >> 3);
3212 ra[1] = (uint8_t) (ra11 & 0x07);
Max32e56412017-10-16 14:58:00 +02003213 nbits = 11;
3214 } else
3215 ra[0] = (uint8_t)ra11;
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003216
Max32e56412017-10-16 14:58:00 +02003217 osmo_pbit2ubit_ext(conv, 0, ra, 0, nbits, 1);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003218
Max32e56412017-10-16 14:58:00 +02003219 osmo_crc8gen_set_bits(&gsm0503_rach_crc6, conv, nbits, conv + nbits);
3220
3221 rach_apply_bsic(conv, bsic, nbits);
3222
3223 osmo_conv_encode(is_11bit ? &gsm0503_rach_ext : &gsm0503_rach, conv, burst);
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003224
3225 return 0;
3226}
3227
3228/*
3229 * GSM SCH transcoding
3230 */
Harald Weltec6636782017-06-12 14:59:37 +02003231
Neels Hofmeyr87e45502017-06-20 00:17:59 +02003232/*! Decode the SCH according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02003233 * \param[out] sb_info output buffer for SCH data
3234 * \param[in] burst Input burst data
3235 * \returns 0 on success; negative on error (e.g. CRC error) */
Harald Welteb9946d32017-06-12 09:40:16 +02003236int gsm0503_sch_decode(uint8_t *sb_info, const sbit_t *burst)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003237{
3238 ubit_t conv[35];
3239 int rv;
3240
3241 osmo_conv_decode(&gsm0503_sch, burst, conv);
3242
3243 rv = osmo_crc16gen_check_bits(&gsm0503_sch_crc10, conv, 25, conv + 25);
3244 if (rv)
3245 return -1;
3246
3247 osmo_ubit2pbit_ext(sb_info, 0, conv, 0, 25, 1);
3248
3249 return 0;
3250}
3251
Neels Hofmeyr87e45502017-06-20 00:17:59 +02003252/*! Encode the SCH according to TS 05.03
Harald Weltec6636782017-06-12 14:59:37 +02003253 * \param[out] burst Caller-allocated output burst buffer
3254 * \param[in] sb_info Input SCH data
3255 * \returns 0 on success; negative on error */
Harald Welteb9946d32017-06-12 09:40:16 +02003256int gsm0503_sch_encode(ubit_t *burst, const uint8_t *sb_info)
Vadim Yanitskiy3262f822016-09-23 01:48:59 +07003257{
3258 ubit_t conv[35];
3259
3260 osmo_pbit2ubit_ext(conv, 0, sb_info, 0, 25, 1);
3261
3262 osmo_crc16gen_set_bits(&gsm0503_sch_crc10, conv, 25, conv + 25);
3263
3264 osmo_conv_encode(&gsm0503_sch, conv, burst);
3265
3266 return 0;
3267}
Harald Weltec6636782017-06-12 14:59:37 +02003268
3269/*! @} */