aboutsummaryrefslogtreecommitdiffstats
path: root/src/gsm/gsm44021.c
blob: 5e9d5ab8d4ac25016eae626f6be6b029ba240961 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/*************************************************************************
 * GSM CSD modified V.110 frame decoding/encoding (ubits <-> struct with D/S/X/E bits)
 *************************************************************************/

/* (C) 2022 by Harald Welte <laforge@osmocom.org>
 *
 * SPDX-License-Identifier: GPL-2.0+
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 */

#include <errno.h>
#include <osmocom/core/bits.h>
#include <osmocom/isdn/v110.h>

/*! Decode a 60-bit GSM 12kbit/s CSD frame present as 60 ubits into a struct osmo_v110_decoded_frame.
 *  \param[out] caller-allocated output data structure, filled by this function
 *  \param[in] ra_bits One V.110 frame as 60 unpacked bits. */
int osmo_csd_12k_6k_decode_frame(struct osmo_v110_decoded_frame *fr, const ubit_t *ra_bits, size_t n_bits)
{
	/* 3GPP TS 44.021 Section 8.1.2 / 8.1.3
	D1	D2	D3	D4	D5	D6	S1
	D7	D8	D9	D10	D11	D12	X
	D13	D14	D15	D16	D17	D18	S3
	D19	D20	D21	D22	D23	D24	S4
	E4	E5	E6	E7	D25	D26	D27
	D28	D29	D30	S6	D31	D32	D33
	D34	D35	D36	X	D37	D38	D39
	D40	D41	D42	S8	D43	D44	D45
	D46	D47	D48	S9 */

	if (n_bits < 60)
		return -EINVAL;

	/* X1 .. X2 */
	fr->x_bits[0] = ra_bits[1 * 7 + 6];
	fr->x_bits[1] = ra_bits[6 * 7 + 3];

	/* S1, S3, S4, S6, S8, S9 */
	fr->s_bits[0] = ra_bits[0 * 7 + 6];
	fr->s_bits[2] = ra_bits[2 * 7 + 6];
	fr->s_bits[3] = ra_bits[3 * 7 + 6];
	fr->s_bits[5] = ra_bits[5 * 7 + 3];
	fr->s_bits[7] = ra_bits[7 * 7 + 3];
	fr->s_bits[8] = ra_bits[8 * 7 + 3];

	/* E1 .. E3 must be set by out-of-band knowledge! */

	/* E4 .. E7 */
	memcpy(fr->e_bits+3, ra_bits + 4 * 7 + 0, 4);

	/* D-bits */
	memcpy(fr->d_bits + 0 * 6 + 0, ra_bits + 0 * 7 + 0, 6);
	memcpy(fr->d_bits + 1 * 6 + 0, ra_bits + 1 * 7 + 0, 6);
	memcpy(fr->d_bits + 2 * 6 + 0, ra_bits + 2 * 7 + 0, 6);
	memcpy(fr->d_bits + 3 * 6 + 0, ra_bits + 3 * 7 + 0, 6);
	memcpy(fr->d_bits + 4 * 6 + 0, ra_bits + 4 * 7 + 4, 3);
	memcpy(fr->d_bits + 4 * 6 + 3, ra_bits + 5 * 7 + 0, 3);
	memcpy(fr->d_bits + 5 * 6 + 0, ra_bits + 5 * 7 + 4, 3);
	memcpy(fr->d_bits + 5 * 6 + 3, ra_bits + 6 * 7 + 0, 3);
	memcpy(fr->d_bits + 6 * 6 + 0, ra_bits + 6 * 7 + 4, 3);
	memcpy(fr->d_bits + 6 * 6 + 3, ra_bits + 7 * 7 + 0, 3);
	memcpy(fr->d_bits + 7 * 6 + 0, ra_bits + 7 * 7 + 4, 3);
	memcpy(fr->d_bits + 7 * 6 + 3, ra_bits + 8 * 7 + 0, 3);

	return 0;
}

int osmo_csd_12k_6k_encode_frame(ubit_t *ra_bits, size_t ra_bits_size, const struct osmo_v110_decoded_frame *fr)
{
	if (ra_bits_size < 60)
		return -EINVAL;

	/* X1 .. X2 */
	ra_bits[1 * 7 + 6] = fr->x_bits[0];
	ra_bits[6 * 7 + 3] = fr->x_bits[1];

	/* S1, S3, S4, S6, S8, S9 */
	ra_bits[0 * 7 + 6] = fr->s_bits[0];
	ra_bits[2 * 7 + 6] = fr->s_bits[2];
	ra_bits[3 * 7 + 6] = fr->s_bits[3];
	ra_bits[5 * 7 + 3] = fr->s_bits[5];
	ra_bits[7 * 7 + 3] = fr->s_bits[7];
	ra_bits[8 * 7 + 3] = fr->s_bits[8];

	/* E1 .. E3 are dropped */

	/* E4 .. E7 */
	memcpy(ra_bits + 4 * 7 + 0, fr->e_bits+3, 4);

	/* D-bits */
	memcpy(ra_bits + 0 * 7 + 0, fr->d_bits + 0 * 6 + 0, 6);
	memcpy(ra_bits + 1 * 7 + 0, fr->d_bits + 1 * 6 + 0, 6);
	memcpy(ra_bits + 2 * 7 + 0, fr->d_bits + 2 * 6 + 0, 6);
	memcpy(ra_bits + 3 * 7 + 0, fr->d_bits + 3 * 6 + 0, 6);
	memcpy(ra_bits + 4 * 7 + 4, fr->d_bits + 4 * 6 + 0, 3);
	memcpy(ra_bits + 5 * 7 + 0, fr->d_bits + 4 * 6 + 3, 3);
	memcpy(ra_bits + 5 * 7 + 4, fr->d_bits + 5 * 6 + 0, 3);
	memcpy(ra_bits + 6 * 7 + 0, fr->d_bits + 5 * 6 + 3, 3);
	memcpy(ra_bits + 6 * 7 + 4, fr->d_bits + 6 * 6 + 0, 3);
	memcpy(ra_bits + 7 * 7 + 0, fr->d_bits + 6 * 6 + 3, 3);
	memcpy(ra_bits + 7 * 7 + 4, fr->d_bits + 7 * 6 + 0, 3);
	memcpy(ra_bits + 8 * 7 + 0, fr->d_bits + 7 * 6 + 3, 3);

	return 60;
}

/*! Decode a 36-bit GSM 3k6kbit/s CSD frame present as 36 ubits into a struct osmo_v110_decoded_frame.
 *  \param[out] caller-allocated output data structure, filled by this function
 *  \param[in] ra_bits One V.110 frame as 36 unpacked bits. */
int osmo_csd_3k6_decode_frame(struct osmo_v110_decoded_frame *fr, const ubit_t *ra_bits, size_t n_bits)
{

	/* 3GPP TS 44.021 Section 8.1.4
	D1	D2	D3	S1	D4	D5	D6	X
	D7	D8	D9	S3	D10	D11	D12	S4
	E4	E5	E6	E7	D13	D14	D15	S6
	D16	D17	D18	X	D19	D20	D21	S8
	D22	D23	D24	S9
	*/

	if (n_bits < 36)
		return -EINVAL;

	/* X1 .. X2 */
	fr->x_bits[0] = ra_bits[0 * 8 + 7];
	fr->x_bits[1] = ra_bits[3 * 8 + 3];

	/* S1, S3, S4, S6, S8, S9 */
	fr->s_bits[0] = ra_bits[0 * 8 + 3];
	fr->s_bits[2] = ra_bits[1 * 8 + 3];
	fr->s_bits[3] = ra_bits[1 * 8 + 7];
	fr->s_bits[5] = ra_bits[2 * 8 + 7];
	fr->s_bits[7] = ra_bits[3 * 8 + 7];
	fr->s_bits[8] = ra_bits[4 * 8 + 3];

	/* E1 .. E3 must be set by out-of-band knowledge! */

	/* E4 .. E7 */
	memcpy(fr->e_bits+3, ra_bits + 2 * 8 + 0, 4);

	/* D-bits */
	unsigned int d_idx = 0;
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 0];	/* D1 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 0];	/* D1 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 1];	/* D2 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 1];	/* D2 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 2];	/* D3 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 2];	/* D3 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 4];	/* D4 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 4];	/* D4 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 5];	/* D5 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 5];	/* D5 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 6];	/* D6 */
	fr->d_bits[d_idx++] = ra_bits[0 * 8 + 6];	/* D6 */

	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 0];	/* D7 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 0];	/* D7 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 1];	/* D8 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 1];	/* D8 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 2];	/* D9 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 2];	/* D9 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 4];	/* D10 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 4];	/* D10 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 5];	/* D11 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 5];	/* D11 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 6];	/* D12 */
	fr->d_bits[d_idx++] = ra_bits[1 * 8 + 6];	/* D12 */

	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 4];	/* D13 */
	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 4];	/* D13 */
	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 5];	/* D14 */
	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 5];	/* D14 */
	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 6];	/* D15 */
	fr->d_bits[d_idx++] = ra_bits[2 * 8 + 6];	/* D15 */

	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 0];	/* D16 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 0];	/* D16 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 1];	/* D17 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 1];	/* D17 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 2];	/* D18 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 2];	/* D18 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 4];	/* D19 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 4];	/* D19 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 5];	/* D20 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 5];	/* D20 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 6];	/* D21 */
	fr->d_bits[d_idx++] = ra_bits[3 * 8 + 6];	/* D21 */

	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 0];	/* D22 */
	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 0];	/* D22 */
	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 1];	/* D23 */
	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 1];	/* D23 */
	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 2];	/* D24 */
	fr->d_bits[d_idx++] = ra_bits[4 * 8 + 2];	/* D24 */

	OSMO_ASSERT(d_idx == 48);

	return 0;
}

int osmo_csd_3k6_encode_frame(ubit_t *ra_bits, size_t ra_bits_size, const struct osmo_v110_decoded_frame *fr)
{
	if (ra_bits_size < 36)
		return -EINVAL;

	/* X1 .. X2 */
	ra_bits[0 * 8 + 7] = fr->x_bits[0];
	ra_bits[3 * 8 + 3] = fr->x_bits[1];

	/* S1, S3, S4, S6, S8, S9 */
	ra_bits[0 * 8 + 3] = fr->s_bits[0];
	ra_bits[1 * 8 + 3] = fr->s_bits[2];
	ra_bits[1 * 8 + 7] = fr->s_bits[3];
	ra_bits[2 * 8 + 7] = fr->s_bits[5];
	ra_bits[3 * 8 + 7] = fr->s_bits[7];
	ra_bits[4 * 8 + 3] = fr->s_bits[8];

	/* E1 .. E3 are ignored */

	/* E4 .. E7 */
	memcpy(ra_bits + 2 * 8 + 0, fr->e_bits+3, 4);

	/* D-bits */
	unsigned int d_idx = 0;
	ra_bits[0 * 8 + 0] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[0 * 8 + 1] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[0 * 8 + 2] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[0 * 8 + 4] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[0 * 8 + 5] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[0 * 8 + 6] = fr->d_bits[d_idx]; d_idx += 2;

	ra_bits[1 * 8 + 0] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[1 * 8 + 1] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[1 * 8 + 2] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[1 * 8 + 4] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[1 * 8 + 5] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[1 * 8 + 6] = fr->d_bits[d_idx]; d_idx += 2;

	ra_bits[2 * 8 + 4] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[2 * 8 + 5] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[2 * 8 + 6] = fr->d_bits[d_idx]; d_idx += 2;

	ra_bits[3 * 8 + 0] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[3 * 8 + 1] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[3 * 8 + 2] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[3 * 8 + 4] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[3 * 8 + 5] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[3 * 8 + 6] = fr->d_bits[d_idx]; d_idx += 2;

	ra_bits[4 * 8 + 0] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[4 * 8 + 1] = fr->d_bits[d_idx]; d_idx += 2;
	ra_bits[4 * 8 + 2] = fr->d_bits[d_idx]; d_idx += 2;

	OSMO_ASSERT(d_idx == 48);

	return 36;
}

/*! Print a encoded "CSD modififed V.110" frame in the same table-like structure as the spec.
 *  \param outf output FILE stream to which to dump
 *  \param[in] fr unpacked bits to dump
 *  \param[in] in_len length of unpacked bits available at fr. */
void osmo_csd_ubit_dump(FILE *outf, const ubit_t *fr, size_t in_len)
{
	switch (in_len) {
	case 60:
		for (unsigned int septet = 0; septet < 9; septet++) {
			if (septet < 8) {
				fprintf(outf, "%d\t%d\t%d\t%d\t%d\t%d\t%d\n", fr[septet * 7 + 0],
					fr[septet * 7 + 1], fr[septet * 7 + 2], fr[septet * 7 + 3],
					fr[septet * 7 + 4], fr[septet * 7 + 5], fr[septet*7 + 6]);
			} else {
				fprintf(outf, "%d\t%d\t%d\t%d\n", fr[septet * 7 + 0],
					fr[septet * 7 + 1], fr[septet * 7 + 2], fr[septet * 7 + 3]);
			}
		}
		break;
	case 36:
		for (unsigned int octet = 0; octet < 5; octet++) {
			if (octet < 4) {
				fprintf(outf, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
					fr[octet * 8 + 0], fr[octet * 8 + 1], fr[octet * 8 + 2],
					fr[octet * 8 + 3], fr[octet * 8 + 4], fr[octet * 8 + 5],
					fr[octet * 8 + 6], fr[octet * 8 + 7]);
			} else {
				fprintf(outf, "%d\t%d\t%d\t%d\n", fr[octet * 8 + 0],
					fr[octet * 8 + 1], fr[octet * 8 + 2], fr[octet * 8 + 3]);
			}
		}
		break;
	default:
		fprintf(outf, "invalid input data length: %zu\n", in_len);
	}
}