aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmocom/gsm/protocol/gsm_25_415.h
blob: 5c4dd2bbbad3c304c31ddfa878b2513ad7faf35f (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
#pragma once
/* Iu User Plane (IuUP) Definitions as per 3GPP TS 25.415 */
/* (C) 2017 by Harald Welte <laforge@gnumonks.org>
 * All Rights Reserved.
 *
 * SPDX-License-Identifier: GPL-2.0+
 */

#include <stdint.h>
#include <osmocom/core/endian.h>

/* 3GPP TS 25.415 Section 6.6.2.1 */
struct iuup_pdutype0_hdr {
#if OSMO_IS_LITTLE_ENDIAN
	/* control part */
	uint8_t frame_nr:4,
		pdu_type:4;
	uint8_t rfci:6,
		fqc:2;
	/* checksum part */
	uint8_t payload_crc_hi:2, header_crc:6;
	uint8_t payload_crc_lo;

	/* payload part */
	uint8_t payload[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint8_t pdu_type:4, frame_nr:4;
	uint8_t fqc:2, rfci:6;
	uint8_t header_crc:6, payload_crc_hi:2;
	uint8_t payload_crc_lo;
	uint8_t payload[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.2 */
struct iuup_pdutype1_hdr {
#if OSMO_IS_LITTLE_ENDIAN
	/* control part */
	uint8_t frame_nr:4,
		pdu_type:4;
	uint8_t rfci:6,
		fqc:2;
	/* checksum part */
	uint8_t spare:2,
		header_crc:6;
	/* payload part */
	uint8_t payload[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint8_t pdu_type:4, frame_nr:4;
	uint8_t fqc:2, rfci:6;
	uint8_t header_crc:6, spare:2;
	uint8_t payload[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.3 */
struct iuup_pdutype14_hdr {
#if OSMO_IS_LITTLE_ENDIAN
	/* control part */
	uint8_t frame_nr:2,
		ack_nack:2,
		pdu_type:4;
	uint8_t proc_ind:4,
		mode_version:4;
	/* checksum part */
	uint8_t payload_crc_hi:2, header_crc:6;
	uint8_t payload_crc_lo;
	/* payload part */
	uint8_t payload[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint8_t pdu_type:4, ack_nack:2, frame_nr:2;
	uint8_t mode_version:4, proc_ind:4;
	uint8_t header_crc:6, payload_crc_hi:2;
	uint8_t payload_crc_lo;
	uint8_t payload[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.3.4.1 */
struct iuup_ctrl_init_rfci_hdr {
#if OSMO_IS_LITTLE_ENDIAN
	uint8_t rfci:6,
		li:1,
		lri:1;
	uint8_t subflow_length[0]; /* 1 or 2 bytes depending on li */
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint8_t lri:1, li:1, rfci:6;
	uint8_t subflow_length[0];
#endif
} __attribute__((packed));
struct iuup_ctrl_init_hdr {
#if OSMO_IS_LITTLE_ENDIAN
	uint8_t chain_ind:1,
		num_subflows_per_rfci:3,
		ti:1,
		spare:3;
	uint8_t rfci_data[0]; /* struct iuup_ctrl_init_rfci_hdr* */
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint8_t spare:3, ti:1, num_subflows_per_rfci:3, chain_ind:1;
	uint8_t rfci_data[0]; /* struct iuup_ctrl_init_rfci_hdr* */
;
#endif
} __attribute__((packed));
struct iuup_ctrl_init_tail {
#if OSMO_IS_LITTLE_ENDIAN
	uint16_t versions_supported;
	uint8_t spare:4,
		data_pdu_type:4;
	uint8_t spare_extension[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	uint16_t versions_supported;
	uint8_t data_pdu_type:4, spare:4;
	uint8_t spare_extension[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.3.4.4 */
struct iuup_ctrl_error_event {
#if OSMO_IS_LITTLE_ENDIAN
	struct iuup_pdutype14_hdr hdr;
	uint8_t error_cause:6,
		error_distance:2;
	uint8_t spare_extension[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	struct iuup_pdutype14_hdr hdr;
	uint8_t error_distance:2, error_cause:6;
	uint8_t spare_extension[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.3.2 */
struct iuup_ctrl_ack {
	struct iuup_pdutype14_hdr hdr;
	uint8_t spare_extension[0];
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2.3.3 */
struct iuup_ctrl_nack {
#if OSMO_IS_LITTLE_ENDIAN
	struct iuup_pdutype14_hdr hdr;
	uint8_t spare:2,
		error_cause:6;
	uint8_t spare_extension[0];
#elif OSMO_IS_BIG_ENDIAN
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianness.py) */
	struct iuup_pdutype14_hdr hdr;
	uint8_t error_cause:6, spare:2;
	uint8_t spare_extension[0];
#endif
} __attribute__((packed));

/* 3GPP TS 25.415 Section 6.6.2 + 6.6.3.1 */
enum iuup_pdu_type {
	IUUP_PDU_T_DATA_CRC	= 0,
	IUUP_PDU_T_DATA_NOCRC	= 1,
	IUUP_PDU_T_CONTROL	= 14,
};

/* 3GPP TS 25.415 Section 6.6.3.2 */
enum iuup_ack_nack {
	IUUP_AN_PROCEDURE	= 0,
	IUUP_AN_ACK		= 1,
	IUUP_AN_NACK		= 2,
};

/* 3GPP TS 25.415 Section 6.6.3.5 */
enum iuup_fqc {
	IUUP_FQC_FRAME_GOOD	= 0,
	IUUP_FQC_FRAME_BAD	= 1,
	IUUP_FQC_FRAME_BAD_RADIO = 2,
};

/* 3GPP TS 25.415 Section 6.6.3.7 */
enum iuup_procedure {
	IUUP_PROC_INIT		= 0,
	IUUP_PROC_RATE_CTRL	= 1,
	IUUP_PROC_TIME_ALIGN	= 2,
	IUUP_PROC_ERR_EVENT	= 3,
};


/* 3GPP TS 25.415 Section 6.6.3.15 */
enum iuup_error_distance {
	IUUP_ERR_DIST_LOCAL		= 0,
	IUUP_ERR_DIST_FIRST_FWD		= 1,
	IUUP_ERR_DIST_SECOND_FWD	= 2,
	IUUP_ERR_DIST_RESERVED		= 3,
};


/* 3GPP TS 25.415 Section 6.6.3.16 */
enum iuup_error_cause {
	IUUP_ERR_CAUSE_CRC_ERR_HDR	= 0,
	IUUP_ERR_CAUSE_CRC_ERR_DATA	= 1,
	IUUP_ERR_CAUSE_UNEXPECTED_FN	= 2,
	IUUP_ERR_CAUSE_FRAME_LOSS	= 3,
	IUUP_ERR_CAUSE_UNKNOWN_PDUTYPE	= 4,
	IUUP_ERR_CAUSE_UNKNOWN_PROC	= 5,
	IUUP_ERR_CAUSE_UNKNNOWN_RES_VAL	= 6,
	IUUP_ERR_CAUSE_UNKNNOWN_FIELD	= 7,
	IUUP_ERR_CAUSE_FRAME_TOO_SHORT	= 8,
	IUUP_ERR_CAUSE_MISSING_FIELDS	= 9,
	IUUP_ERR_CAUSE_UNEXPECTED_PDU_T	= 16,
	IUUP_ERR_CAUSE_UNEXPECTED_PROC	= 18,
	IUUP_ERR_CAUSE_UNEXPECTED_RFCI	= 19,
	IUUP_ERR_CAUSE_UNEXPECTED_VALUE	= 20,
	IUUP_ERR_CAUSE_INIT_FAILURE	= 42,
	IUUP_ERR_CAUSE_INIT_FAILURE_NET_TMR = 43,
	IUUP_ERR_CAUSE_INIT_FAILURE_REP_NACK = 44,
	IUUP_ERR_CAUSE_RATE_CTRL_FAILURE = 45,
	IUUP_ERR_CAUSE_ERR_EVENT_FAIL	= 46,
	IUUP_ERR_CAUSE_TIME_ALIGN_NOTSUPP = 47,
	IUUP_ERR_CAUSE_REQ_TIME_ALIGN_NOTPOSS = 48,
	IUUP_ERR_CAUSE_MODE_VERSION_NOT_SUPPORTED = 49,
};