Blame - include/osmocom/coding/gsm0503_coding.h - libosmocore

blob: 2112b0f8a79916f9f79a7a64d4467b37ab6738a5 [file] [log] [blame]

Neels Hofmeyr	17518fe	2017-06-20 04:35:06 +0200	[diff] [blame]	1	/*! \file gsm0503_coding.h
				2	* GSM TS 05.03 coding
				3	*/
				4
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	5	#pragma once
				6
				7	#include <stdint.h>
Max	32e5641	2017-10-16 14:58:00 +0200	[diff] [blame]	8
				9	#include <osmocom/core/defs.h>
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	10	#include <osmocom/core/bits.h>
				11
Harald Welte	c663678	2017-06-12 14:59:37 +0200	[diff] [blame]	12	/*! \addtogroup coding
				13	* @{
Neels Hofmeyr	17518fe	2017-06-20 04:35:06 +0200	[diff] [blame]	14	* \file gsm0503_coding.h */
Harald Welte	c663678	2017-06-12 14:59:37 +0200	[diff] [blame]	15
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	16	#define GSM0503_GPRS_BURSTS_NBITS (116 * 4)
				17	#define GSM0503_EGPRS_BURSTS_NBITS (348 * 4)
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	18
				19	enum gsm0503_egprs_mcs {
				20	EGPRS_MCS0,
				21	EGPRS_MCS1,
				22	EGPRS_MCS2,
				23	EGPRS_MCS3,
				24	EGPRS_MCS4,
				25	EGPRS_MCS5,
				26	EGPRS_MCS6,
				27	EGPRS_MCS7,
				28	EGPRS_MCS8,
				29	EGPRS_MCS9,
				30	EGPRS_NUM_MCS,
				31	};
				32
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	33	int gsm0503_xcch_encode(ubit_t bursts, const uint8_t l2_data);
				34	int gsm0503_xcch_decode(uint8_t l2_data, const sbit_t bursts,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	35	int n_errors, int n_bits_total);
				36
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	37	int gsm0503_pdtch_encode(ubit_t bursts, const uint8_t l2_data, uint8_t l2_len);
				38	int gsm0503_pdtch_decode(uint8_t l2_data, const sbit_t bursts, uint8_t *usf_p,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	39	int n_errors, int n_bits_total);
				40
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	41	int gsm0503_pdtch_egprs_encode(ubit_t bursts, const uint8_t l2_data,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	42	uint8_t l2_len);
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	43	int gsm0503_pdtch_egprs_decode(uint8_t l2_data, const sbit_t bursts,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	44	uint16_t nbits, uint8_t usf_p, int n_errors, int *n_bits_total);
				45
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	46	int gsm0503_tch_fr_encode(ubit_t bursts, const uint8_t tch_data, int len,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	47	int net_order);
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	48	int gsm0503_tch_fr_decode(uint8_t tch_data, const sbit_t bursts, int net_order,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	49	int efr, int n_errors, int n_bits_total);
				50
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	51	int gsm0503_tch_hr_encode(ubit_t bursts, const uint8_t tch_data, int len);
				52	int gsm0503_tch_hr_decode(uint8_t tch_data, const sbit_t bursts, int odd,
Mychaela N. Falconia	57a3b3a	2023-05-23 16:09:27 +0000	[diff] [blame^]	53	int n_errors, int n_bits_total)
				54	OSMO_DEPRECATED("Use gsm0503_tch_hr_decode2() instead");
				55	int gsm0503_tch_hr_decode2(uint8_t tch_data, const sbit_t bursts, int odd,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	56	int n_errors, int n_bits_total);
				57
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	58	int gsm0503_tch_afs_encode(ubit_t bursts, const uint8_t tch_data, int len,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	59	int codec_mode_req, uint8_t *codec, int codecs, uint8_t ft,
				60	uint8_t cmr);
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	61	int gsm0503_tch_afs_decode(uint8_t tch_data, const sbit_t bursts,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	62	int codec_mode_req, uint8_t codec, int codecs, uint8_t ft,
				63	uint8_t cmr, int n_errors, int *n_bits_total);
Philipp Maier	898c9c6	2020-02-06 14:25:01 +0100	[diff] [blame]	64	int gsm0503_tch_afs_decode_dtx(uint8_t tch_data, const sbit_t bursts,
				65	int codec_mode_req, uint8_t codec, int codecs, uint8_t ft,
				66	uint8_t cmr, int n_errors, int n_bits_total, uint8_t dtx);
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	67
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	68	int gsm0503_tch_ahs_encode(ubit_t bursts, const uint8_t tch_data, int len,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	69	int codec_mode_req, uint8_t *codec, int codecs, uint8_t ft, uint8_t cmr);
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	70	int gsm0503_tch_ahs_decode(uint8_t tch_data, const sbit_t bursts, int odd,
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	71	int codec_mode_req, uint8_t codec, int codecs, uint8_t ft,
				72	uint8_t cmr, int n_errors, int *n_bits_total);
Philipp Maier	898c9c6	2020-02-06 14:25:01 +0100	[diff] [blame]	73	int gsm0503_tch_ahs_decode_dtx(uint8_t tch_data, const sbit_t bursts, int odd,
				74	int codec_mode_req, uint8_t codec, int codecs, uint8_t ft,
				75	uint8_t cmr, int n_errors, int n_bits_total, uint8_t dtx);
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	76
Max	32e5641	2017-10-16 14:58:00 +0200	[diff] [blame]	77	int gsm0503_rach_ext_encode(ubit_t *burst, uint16_t ra, uint8_t bsic, bool is_11bit);
				78	int gsm0503_rach_encode(ubit_t burst, const uint8_t ra, uint8_t bsic) OSMO_DEPRECATED("Use gsm0503_rach_ext_encode() instead");
				79
Harald Welte	6950b19	2018-02-26 11:48:00 +0100	[diff] [blame]	80	int gsm0503_rach_decode(uint8_t ra, const sbit_t burst, uint8_t bsic)
				81	OSMO_DEPRECATED("Use gsm0503_rach_decode_ber() instead");
				82	int gsm0503_rach_decode_ber(uint8_t ra, const sbit_t burst, uint8_t bsic,
				83	int n_errors, int n_bits_total);
				84	int gsm0503_rach_ext_decode(uint16_t ra, const sbit_t burst, uint8_t bsic)
				85	OSMO_DEPRECATED("Use gsm0503_rach_ext_decode_ber() instead");
				86	int gsm0503_rach_ext_decode_ber(uint16_t ra, const sbit_t burst, uint8_t bsic,
				87	int n_errors, int n_bits_total);
Vadim Yanitskiy	3262f82	2016-09-23 01:48:59 +0700	[diff] [blame]	88
Harald Welte	b9946d3	2017-06-12 09:40:16 +0200	[diff] [blame]	89	int gsm0503_sch_encode(ubit_t burst, const uint8_t sb_info);
				90	int gsm0503_sch_decode(uint8_t sb_info, const sbit_t burst);
Harald Welte	c663678	2017-06-12 14:59:37 +0200	[diff] [blame]	91
				92	/! @} /