blob: 2171fc0d6703a17a368ad532dc9923cdcda5cd5f [file] [log] [blame]
Harald Welte643e2a62017-11-27 15:03:18 +01001module RSL_Types {
2
3 import from General_Types all;
4 import from Osmocom_Types all;
5 import from GSM_Types all;
6
7 /* Section 9.1 */
8 type enumerated RSL_MessageGroup {
9 RSL_MDISC_RESERVED ('0000000'B),
10 RSL_MDISC_RLL ('0000001'B),
11 RSL_MDISC_DCHAN ('0000100'B),
12 RSL_MDISC_CCHAN ('0000110'B),
13 RSL_MDISC_TRX_MGMT ('0001000'B),
14 RSL_MDISC_LCS ('0010000'B),
15 RSL_MDISC_IPACCESS ('0111111'B)
16 } with { variant "FIELDLENGTH(7)" };
17
18 /* Section 9.1 */
19 type record RSL_MessageDiscriminator {
20 RSL_MessageGroup msg_group,
21 boolean transparent
22 } with { variant "FIELDORDER(msb)" };
23
24 template RSL_MessageDiscriminator ts_RSL_MsgDisc(RSL_MessageGroup mg, boolean t := true) := {
25 msg_group := mg,
26 transparent := t
27 }
28
29 /* Section 9.2 */
30 type enumerated RSL_MessageType {
31 /* Radio Link Layer Management */
32 RSL_MT_DATA_REQ ('00000001'B),
33 RSL_MT_DATA_IND ('00000010'B),
34 RSL_MT_ERROR_IND ('00000011'B),
35 RSL_MT_EST_REQ ('00000100'B),
36 RSL_MT_EST_CONF ('00000101'B),
37 RSL_MT_EST_IND ('00000110'B),
38 RSL_MT_REL_REQ ('00000111'B),
39 RSL_MT_REL_CONF ('00001000'B),
40 RSL_MT_REL_IND ('00001001'B),
41 RSL_MT_UNIT_DATA_REQ ('00001010'B),
42 RSL_MT_UNIT_DATA_IND ('00001011'B),
43
44 /* non-standard below */
45 RSL_MT_SUSP_REQ ('00001100'B),
46 RSL_MT_SUSP_CONF ('00001101'B),
47 RSL_MT_RES_REQ ('00001110'B),
48 RSL_MT_RECON_REQ ('00001111'B),
49
50 /* Common Channel Management / TRX Management */
51 RSL_MT_BCCH_INFO ('00010001'B),
Harald Welte319be822017-12-07 17:50:26 +010052 RSL_MT_CCCH_LOAD_IND ('00010010'B),
53 RSL_MT_CHAN_RQD ('00010011'B),
54 RSL_MT_DELETE_IND ('00010100'B),
55 RSL_MT_PAGING_CMD ('00010101'B),
56 RSL_MT_IMMEDIATE_ASSIGN_CMD ('00010110'B),
57 RSL_MT_SMS_BC_REQ ('00010111'B),
58 RSL_MT_CHAN_CONF ('00011000'B), /* non-standard element */
Harald Welte643e2a62017-11-27 15:03:18 +010059 /* empty */
60 RSL_MT_RF_RES_IND ('00011001'B),
Harald Welte319be822017-12-07 17:50:26 +010061 RSL_MT_SACCH_FILL ('00011010'B),
62 RSL_MT_OVERLOAD ('00011011'B),
63 RSL_MT_ERROR_REPORT ('00011100'B),
64 RSL_MT_SMS_BC_CMD ('00011101'B),
65 RSL_MT_CBCH_LOAD_IND ('00011110'B),
66 RSL_MT_NOT_CMD ('00011111'B),
Harald Welte643e2a62017-11-27 15:03:18 +010067
68 /* Dedicate Channel Management */
69 RSL_MT_CHAN_ACTIV ('00100001'B),
Harald Welte319be822017-12-07 17:50:26 +010070 RSL_MT_CHAN_ACTIV_ACK ('00100010'B),
71 RSL_MT_CHAN_ACTIV_NACK ('00100011'B),
72 RSL_MT_CONN_FAIL ('00100100'B),
73 RSL_MT_DEACTIVATE_SACCH ('00100101'B),
74 RSL_MT_ENCR_CMD ('00100110'B),
75 RSL_MT_HANDO_DET ('00100111'B),
76 RSL_MT_MEAS_RES ('00101000'B),
77 RSL_MT_MODE_MODIFY_REQ ('00101001'B),
78 RSL_MT_MODE_MODIFY_ACK ('00101010'B),
79 RSL_MT_MODE_MODIFY_NACK ('00101011'B),
80 RSL_MT_PHY_CONTEXT_REQ ('00101100'B),
81 RSL_MT_PHY_CONTEXT_CONF ('00101101'B),
82 RSL_MT_RF_CHAN_REL ('00101110'B),
83 RSL_MT_MS_POWER_CONTROL ('00101111'B),
84 RSL_MT_BS_POWER_CONTROL ('00110000'B), /* 0x30 */
85 RSL_MT_PREPROC_CONFIG ('00110001'B),
86 RSL_MT_PREPROC_MEAS_RES ('00110010'B),
87 RSL_MT_RF_CHAN_REL_ACK ('00110011'B),
88 RSL_MT_SACCH_INFO_MODIFY('00110100'B),
89 RSL_MT_TALKER_DET ('00110101'B),
90 RSL_MT_LISTENER_DET ('00110110'B),
91 RSL_MT_REMOTE_CODEC_CONF_REP ('00110111'B),
92 RSL_MT_RTD_REP ('00111000'B),
93 RSL_MT_PRE_HANDO_NOTIF ('00111001'B),
94 RSL_MT_MR_CODEC_MOD_REQ ('00111010'B),
95 RSL_MT_MR_CODEC_MOD_ACK ('00111011'B),
96 RSL_MT_MR_CODEC_MOD_NACK ('00111100'B),
97 RSL_MT_MR_CODEC_MOD_PER ('00111101'B),
98 RSL_MT_TFO_REP ('00111110'B),
99 RSL_MT_TFO_MOD_REQ ('00111111'B), /* 0x3f */
Harald Welte643e2a62017-11-27 15:03:18 +0100100
101 RSL_MT_LOCATION_INFO ('01000001'B),
102
103 /* ip.access specific RSL message types */
104 RSL_MT_IPAC_DIR_RETR_ENQ ('01000000'B),
105
106 RSL_MT_IPAC_PDCH_ACT ('01001000'B),
Harald Welte319be822017-12-07 17:50:26 +0100107 RSL_MT_IPAC_PDCH_ACT_ACK ('01001001'B),
108 RSL_MT_IPAC_PDCH_ACT_NACK ('01001010'B),
Harald Welte643e2a62017-11-27 15:03:18 +0100109 RSL_MT_IPAC_PDCH_DEACT ('01001011'B),
Harald Welte319be822017-12-07 17:50:26 +0100110 RSL_MT_IPAC_PDCH_DEACT_ACK ('01001100'B),
111 RSL_MT_IPAC_PDCH_DEACT_NACK ('01001101'B),
Harald Welte643e2a62017-11-27 15:03:18 +0100112
113 RSL_MT_IPAC_CONNECT_MUX ('01010000'B),
114 RSL_MT_IPAC_CONNECT_MUX_ACK,
115 RSL_MT_IPAC_CONNECT_MUX_NACK,
116 RSL_MT_IPAC_BIND_MUX,
117 RSL_MT_IPAC_BIND_MUX_ACK,
118 RSL_MT_IPAC_BIND_MUX_NACK,
119 RSL_MT_IPAC_DISC_MUX,
120 RSL_MT_IPAC_DISC_MUX_ACK,
121 RSL_MT_IPAC_DISC_MUX_NACK,
122 RSL_MT_IPAC_MEAS_PREPROC_DFT ('01100000'B),
123 RSL_MT_IPAC_HO_CAN_ENQ,
124 RSL_MT_IPAC_HO_CAN_RES,
125 RSL_MT_IPAC_CRCX,
126 RSL_MT_IPAC_CRCX_ACK,
127 RSL_MT_IPAC_CRCX_NACK,
128 RSL_MT_IPAC_MDCX,
129 RSL_MT_IPAC_MDCX_ACK,
130 RSL_MT_IPAC_MDCX_NACK,
131 RSL_MT_IPAC_DLCX_IND,
132 RSL_MT_IPAC_DLCX,
133 RSL_MT_IPAC_DLCX_ACK,
134 RSL_MT_IPAC_DLCX_NACK
135 } with { variant "FIELDLENGTH(8)" };
136
137 /*! RSL Information Element Identifiers (Chapter 9.3) */
138 type enumerated RSL_IE_Type {
139 RSL_IE_CHAN_NR ('00000001'B),
Harald Welte319be822017-12-07 17:50:26 +0100140 RSL_IE_LINK_IDENT ('00000010'B),
141 RSL_IE_ACT_TYPE ('00000011'B),
142 RSL_IE_BS_POWER ('00000100'B),
143 RSL_IE_CHAN_IDENT ('00000101'B),
144 RSL_IE_CHAN_MODE ('00000110'B),
145 RSL_IE_ENCR_INFO ('00000111'B),
146 RSL_IE_FRAME_NUMBER ('00001000'B),
147 RSL_IE_HANDO_REF ('00001001'B),
148 RSL_IE_L1_INFO ('00001010'B),
149 RSL_IE_L3_INFO ('00001011'B),
150 RSL_IE_MS_IDENTITY ('00001100'B),
151 RSL_IE_MS_POWER ('00001101'B),
152 RSL_IE_PAGING_GROUP ('00001110'B),
153 RSL_IE_PAGING_LOAD ('00001111'B),
154 RSL_IE_PYHS_CONTEXT ('00010000'B),
155 RSL_IE_ACCESS_DELAY ('00010001'B),
156 RSL_IE_RACH_LOAD ('00010010'B),
157 RSL_IE_REQ_REFERENCE ('00010011'B),
158 RSL_IE_RELEASE_MODE ('00010100'B),
159 RSL_IE_RESOURCE_INFO ('00010101'B),
160 RSL_IE_RLM_CAUSE ('00010110'B),
161 RSL_IE_STARTNG_TIME ('00010111'B),
162 RSL_IE_TIMING_ADVANCE ('00011000'B),
163 RSL_IE_UPLINK_MEAS ('00011001'B),
164 RSL_IE_CAUSE ('00011010'B),
165 RSL_IE_MEAS_RES_NR ('00011011'B),
166 RSL_IE_MSG_ID ('00011100'B),
Harald Welte643e2a62017-11-27 15:03:18 +0100167 /* reserved */
168 RSL_IE_SYSINFO_TYPE ('00011110'B),
Harald Welte319be822017-12-07 17:50:26 +0100169 RSL_IE_MS_POWER_PARAM ('00011111'B),
170 RSL_IE_BS_POWER_PARAM ('00100000'B),
171 RSL_IE_PREPROC_PARAM ('00100001'B),
172 RSL_IE_PREPROC_MEAS ('00100010'B),
173 RSL_IE_IMM_ASS_INFO ('00100011'B),/* Phase 1 (3.6.0), later Full below */
174 RSL_IE_SMSCB_INFO ('00100100'B),
175 RSL_IE_MS_TIMING_OFFSET ('00100101'B),
176 RSL_IE_ERR_MSG ('00100110'B),
177 RSL_IE_FULL_BCCH_INFO ('00100111'B),
178 RSL_IE_CHAN_NEEDED ('00101000'B),
179 RSL_IE_CB_CMD_TYPE ('00101001'B),
180 RSL_IE_SMSCB_MSG ('00101010'B),
181 RSL_IE_FULL_IMM_ASS_INFO ('00101011'B),
182 RSL_IE_SACCH_INFO ('00101100'B),
183 RSL_IE_CBCH_LOAD_INFO ('00101101'B),
184 RSL_IE_SMSCB_CHAN_INDICATOR ('00101110'B),
185 RSL_IE_GROUP_CALL_REF ('00101111'B),
186 RSL_IE_CHAN_DESC ('00110000'B),
187 RSL_IE_NCH_DRX_INFO ('00110001'B),
188 RSL_IE_CMD_INDICATOR ('00110010'B),
189 RSL_IE_EMLPP_PRIO ('00110011'B),
190 RSL_IE_UIC ('00110100'B),
191 RSL_IE_MAIN_CHAN_REF ('00110101'B),
192 RSL_IE_MR_CONFIG ('00110110'B),
193 RSL_IE_MR_CONTROL ('00110111'B),
194 RSL_IE_SUP_CODEC_TYPES ('00111000'B),
195 RSL_IE_CODEC_CONFIG ('00111001'B),
196 RSL_IE_RTD ('00111010'B),
197 RSL_IE_TFO_STATUS ('00111011'B),
198 RSL_IE_LLP_APDU ('00111100'B),
Harald Welte643e2a62017-11-27 15:03:18 +0100199
200 /* ip.access */
201 RSL_IE_IPAC_SRTP_CONFIG ('11100000'B),
Harald Welte319be822017-12-07 17:50:26 +0100202 RSL_IE_IPAC_PROXY_UDP ('11100001'B),
203 RSL_IE_IPAC_BSCMPL_TOUT ('11100010'B),
Harald Welte643e2a62017-11-27 15:03:18 +0100204
205 RSL_IE_IPAC_REMOTE_IP ('11110000'B),
Harald Welte319be822017-12-07 17:50:26 +0100206 RSL_IE_IPAC_REMOTE_PORT ('11110001'B),
207 RSL_IE_IPAC_RTP_PAYLOAD ('11110010'B),
208 RSL_IE_IPAC_LOCAL_PORT ('11110011'B),
209 RSL_IE_IPAC_SPEECH_MODE ('11110100'B),
210 RSL_IE_IPAC_LOCAL_IP ('11110101'B),
211 RSL_IE_IPAC_CONN_STAT ('11110110'B),
212 RSL_IE_IPAC_HO_C_PARMS ('11110111'B),
213 RSL_IE_IPAC_CONN_ID ('11111000'B),
214 RSL_IE_IPAC_RTP_CSD_FMT ('11111001'B),
215 RSL_IE_IPAC_RTP_JIT_BUF ('11111010'B),
216 RSL_IE_IPAC_RTP_COMPR ('11111011'B),
217 RSL_IE_IPAC_RTP_PAYLOAD2 ('11111100'B),
218 RSL_IE_IPAC_RTP_MPLEX ('11111101'B),
219 RSL_IE_IPAC_RTP_MPLEX_ID ('11111110'B)
Harald Welte643e2a62017-11-27 15:03:18 +0100220 } with { variant "FIELDLENGTH(8)" };
221
222 type record RSL_LV {
223 uint8_t len,
224 octetstring payload
225 } with { variant (len) "LENGTHTO(payload)" }
226
227 template RSL_LV ts_RSL_LV(template octetstring pl) := {
228 len := 0,
229 payload := pl
230 }
231
Harald Welte15bb5b52017-12-07 17:52:04 +0100232 type record RSL_L16V {
233 uint16_t len,
234 octetstring payload
235 } with { variant (len) "LENGTHTO(payload)" }
236
237 template RSL_L16V ts_RSL_L16V(template octetstring pl) := {
238 len := 0,
239 payload := pl
240 }
241
Harald Welte643e2a62017-11-27 15:03:18 +0100242 type record RSL_IE_V {
243 uint8_t val
244 }
245
246 /* 9.3.3 */
247 type record RSL_IE_ActivationType {
248 boolean reactivation,
249 uint4_t reserved,
250 uint3_t a_bits
251 }
252
253 template RSL_IE_ActivationType t_RSL_IE_ActType := {
254 reactivation := false,
255 reserved := 0,
256 a_bits := 0 /* related to immediate assignment */
257 }
258
259 /* 9.3.6 */
260 type enumerated RSL_SpeechDataInd {
261 RSL_SPDI_SPEECH ('00000001'B),
262 RSL_SPDI_DATA ('00000010'B),
263 RSL_SPDI_SIGN ('00000011'B)
264 } with { variant "FIELDLENGTH(8)" };
265 type enumerated RSL_ChanRateType {
266 RSL_CHRT_SDCCH ('00000001'B),
267 RSL_CHRT_TCH_F ('00001000'B),
268 RSL_CHRT_TCH_H ('00001001'B),
269 RSL_CHRT_TCH_F_BD_MSLOT ('00001010'B),
270 RSL_CHRT_TCH_F_DL_MSLOT ('00011010'B),
271 RSL_CHRT_TCH_F_GROUP ('00011000'B),
272 RSL_CHRT_TCH_H_GROUP ('00011001'B),
273 RSL_CHRT_TCH_F_BCAST ('00101000'B),
274 RSL_CHRT_TCH_H_BCAST ('00101001'B)
275 } with { variant "FIELDLENGTH(8)" };
276 type enumerated RSL_SpeechAlgo {
277 RSL_CMOD_NO_RESOURCE ('00000000'B),
278 RSL_CMOD_SP_GSM1 ('00000001'B),
279 RSL_CMOD_SP_GSM2 ('00010001'B),
280 RSL_CMOD_SP_GSM3 ('00100001'B),
281 RSL_CMOD_SP_GSM4 ('00110001'B),
282 RSL_CMOD_SP_GSM5 ('00001001'B),
283 RSL_CMOD_SP_GSM6 ('00001101'B)
284 } with { variant "FIELDLENGTH(8)" };
285 type record RSL_IE_ChannelMode {
Harald Welte8f2c21d2017-12-07 17:52:40 +0100286 uint8_t len,
Harald Welte643e2a62017-11-27 15:03:18 +0100287 BIT6 reserved,
288 boolean dtx_d,
289 boolean dtx_u,
290 RSL_SpeechDataInd spd_ind,
291 RSL_ChanRateType ch_rate_type,
292 RSL_SpeechAlgo coding_alg_rate
Harald Welte8f2c21d2017-12-07 17:52:40 +0100293 } with { variant (len) "LENGTHTO(reserved,dtx_d,dtx_u,spd_ind,ch_rate_type,coding_alg_rate)" }
Harald Welte643e2a62017-11-27 15:03:18 +0100294
295 template RSL_IE_ChannelMode ts_RSL_ChanMode_SIGN := {
Harald Welte8f2c21d2017-12-07 17:52:40 +0100296 len := 0, /* overwritten */
Harald Welte643e2a62017-11-27 15:03:18 +0100297 reserved := '000000'B,
298 dtx_d := false,
299 dtx_u := false,
300 spd_ind := RSL_SPDI_SIGN,
301 ch_rate_type := RSL_CHRT_SDCCH,
302 coding_alg_rate := RSL_CMOD_NO_RESOURCE
303 }
304
305 template RSL_IE_ChannelMode ts_RSL_ChanMode(RSL_ChanRateType t, RSL_SpeechAlgo alg) := {
Harald Welte8f2c21d2017-12-07 17:52:40 +0100306 len := 0, /* overwritten */
Harald Welte643e2a62017-11-27 15:03:18 +0100307 reserved := '000000'B,
308 dtx_d := false,
309 dtx_u := false,
310 spd_ind := RSL_SPDI_SPEECH,
311 ch_rate_type := t,
312 coding_alg_rate := alg
313 }
314
315 /* 9.3.4 */
316 type record RSL_IE_BS_Power {
317 uint1_t reserved,
318 boolean epc,
319 boolean fpc,
320 uint5_t power_level
321 }
322
323 /* 9.3.8 */
324 type record RSL_IE_FrameNumber {
325 uint5_t t1_p,
326 uint6_t t3,
327 uint5_t t2
328 }
329 type RSL_IE_FrameNumber RSL_IE_StartingTime;
330
331 /* 9.3.10 */
332 type record RSL_IE_L1Info {
333 uint5_t ms_power_lvl,
334 boolean fpc,
335 uint2_t reserved,
336 uint8_t actual_ta
337 }
338
339 /* 9.3.13 */
340 type record RSL_IE_MS_Power {
341 uint2_t reserved,
342 boolean fpc_epc,
343 uint5_t power_level
344 }
345
Harald Welted5f521e2017-12-07 17:53:06 +0100346 /* 9.3.18 */
347 type record RSL_IE_RachLoad {
348 uint8_t len,
349 uint16_t slot_count,
350 uint16_t busy_count,
351 uint16_t access_count
352 } with { variant (len) "LENGTHTO(slot_count,busy_count,access_count)" }
353
354 template RSL_IE_RachLoad ts_RSL_IE_RachLoad(uint16_t slot, uint16_t busy, uint16_t acc) := {
355 len := 0, /* overwritten */
356 slot_count := slot,
357 busy_count := busy,
358 access_count := acc
359 }
360
Harald Welte643e2a62017-11-27 15:03:18 +0100361 /* 9.3.19 */
362 type record RSL_IE_RequestRef {
363 OCT1 ra,
364 RSL_IE_FrameNumber frame_nr
365 }
366
367 /* 3GPP TS 44.018 / 10.5.2.38 Starting Time */
368 template RSL_IE_FrameNumber ts_RSL_IE_FrameNumber(GsmFrameNumber fn) := {
369 t1_p := (fn / 1326) mod 32,
370 t3 := fn mod 51,
371 t2 := fn mod 26
372 }
373
374 template RSL_IE_RequestRef ts_RSL_IE_ReqRef(OCT1 ra, GsmFrameNumber frame_nr) := {
375 ra := ra,
376 frame_nr := ts_RSL_IE_FrameNumber(frame_nr)
377 }
378
379 /* 9.3.26 */
380 type uint7_t RSL_Cause;
381 type record RSL_IE_Cause {
382 uint1_t e,
383 RSL_Cause cause,
384 octetstring cause_ext optional
385 }
386
387 template RSL_IE_Cause ts_RSL_IE_Cause(RSL_Cause cause) := {
388 e := 0,
389 cause := cause,
390 cause_ext := omit
391 }
392
393 /* 9.3.40 */
394 type enumerated RSL_ChanNeeded {
395 RSL_CHANNEED_ANY ('00'B),
396 RSL_CHANNEED_SDCCH ('01'B),
397 RSL_CHANNEED_TCH_F ('10'B),
398 RSL_CHANNEED_TCH_ForH ('11'B)
399 }
400 type record RSL_IE_ChanNeeded {
401 uint6_t reserved,
402 RSL_ChanNeeded chan_needed
403 }
404
405 /* 9.3.53 */
406 type record RSL_IE_MultirateCtrl {
407 uint3_t spare,
408 boolean od,
409 boolean pre,
410 uint2_t rae,
411 boolean tfo
412 }
413
414 type enumerated RSL_IE_SysinfoType {
415 RSL_SYSTEM_INFO_8 ('00000000'B),
416 RSL_SYSTEM_INFO_1 ('00000001'B),
417 RSL_SYSTEM_INFO_2 ('00000010'B),
418 RSL_SYSTEM_INFO_3 ('00000011'B),
419 RSL_SYSTEM_INFO_4 ('00000100'B),
420 RSL_SYSTEM_INFO_5 ('00000101'B),
421 RSL_SYSTEM_INFO_6 ('00000110'B),
422 RSL_SYSTEM_INFO_7 ('00000111'B),
423 RSL_SYSTEM_INFO_16 ('00001000'B),
424 RSL_SYSTEM_INFO_17 ('00001001'B),
425 RSL_SYSTEM_INFO_2bis ('00001010'B),
426 RSL_SYSTEM_INFO_2ter ('00001011'B),
427 RSL_SYSTEM_INFO_5bis ('00001101'B),
428 RSL_SYSTEM_INFO_5ter ('00001110'B),
429 RSL_SYSTEM_INFO_10 ('00001111'B),
430 RSL_EXT_MEAS_ORDER ('01000111'B),
431 RSL_MEAS_INFO ('01001000'B),
432 RSL_SYSTEM_INFO_13 ('00101000'B),
433 RSL_ERIC_SYSTEM_INFO_13 ('00001100'B),
434 RSL_SYSTEM_INFO_2quater ('00101001'B),
435 RSL_SYSTEM_INFO_9 ('00101010'B),
436 RSL_SYSTEM_INFO_18 ('00101011'B),
437 RSL_SYSTEM_INFO_19 ('00101100'B),
438 RSL_SYSTEM_INFO_20 ('00101101'B)
439 } with { variant "FIELDLENGTH(8)" }
440
441 /* union of all IE bodies */
442 type union RSL_IE_Body {
443 RslChannelNr chan_nr,
444 RslLinkId link_id,
Harald Welte15bb5b52017-12-07 17:52:04 +0100445 RSL_L16V l3_info,
Harald Welte643e2a62017-11-27 15:03:18 +0100446 RSL_LV rlm_cause,
447 uint8_t release_mode,
448 RSL_IE_ActivationType act_type,
449 RSL_IE_ChannelMode chan_mode,
450 uint8_t handover_ref,
451 RSL_IE_BS_Power bs_power,
452 RSL_IE_MS_Power ms_power,
453 uint8_t timing_adv,
454 RSL_IE_MultirateCtrl multirate_ctrl,
455 RSL_IE_FrameNumber frame_nr,
456 RSL_IE_Cause cause,
457 uint8_t access_delay,
Harald Welted5f521e2017-12-07 17:53:06 +0100458 RSL_IE_RachLoad rach_load,
Harald Welte643e2a62017-11-27 15:03:18 +0100459 uint8_t meas_res_nr,
460 RSL_IE_L1Info l1_info,
461 RSL_IE_SysinfoType sysinfo_type,
462 uint16_t paging_load,
463 uint8_t paging_group,
464 RSL_IE_ChanNeeded chan_needed,
465 RSL_IE_StartingTime starting_time,
466 RSL_IE_RequestRef req_ref,
467 RSL_LV full_imm_ass_info,
Harald Weltefff69302017-12-07 17:53:42 +0100468 RSL_LV ms_identity,
Harald Welte643e2a62017-11-27 15:03:18 +0100469
470 RSL_LV other
471 }
472
473 type record RSL_IE {
474 RSL_IE_Type iei,
475 RSL_IE_Body body
476 } with { variant (body) "CROSSTAG(
477 chan_nr, iei = RSL_IE_CHAN_NR;
478 link_id, iei = RSL_IE_LINK_IDENT;
479 l3_info, iei = RSL_IE_L3_INFO;
480 rlm_cause, iei = RSL_IE_RLM_CAUSE;
481 release_mode, iei = RSL_IE_RELEASE_MODE;
482 act_type, iei = RSL_IE_ACT_TYPE;
483 chan_mode, iei = RSL_IE_CHAN_MODE;
484 handover_ref, iei = RSL_IE_HANDO_REF;
485 bs_power, iei = RSL_IE_BS_POWER;
486 ms_power, iei = RSL_IE_MS_POWER;
487 timing_adv, iei = RSL_IE_TIMING_ADVANCE;
488 multirate_ctrl, iei = RSL_IE_MR_CONTROL;
489
490 frame_nr, iei = RSL_IE_FRAME_NUMBER;
491 cause, iei = RSL_IE_CAUSE;
492 access_delay, iei = RSL_IE_ACCESS_DELAY;
Harald Welted5f521e2017-12-07 17:53:06 +0100493 rach_load, iei = RSL_IE_RACH_LOAD;
Harald Welte643e2a62017-11-27 15:03:18 +0100494 meas_res_nr, iei = RSL_IE_MEAS_RES_NR;
495 l1_info, iei = RSL_IE_L1_INFO;
496 sysinfo_type, iei = RSL_IE_SYSINFO_TYPE;
497 paging_load, iei = RSL_IE_PAGING_LOAD;
498 paging_group, iei = RSL_IE_PAGING_GROUP;
499 chan_needed, iei = RSL_IE_CHAN_NEEDED;
500 starting_time, iei = RSL_IE_STARTNG_TIME;
501
502 req_ref, iei = RSL_IE_REQ_REFERENCE;
Harald Weltefff69302017-12-07 17:53:42 +0100503 full_imm_ass_info, iei = RSL_IE_FULL_IMM_ASS_INFO;
504 ms_identity, iei = RSL_IE_MS_IDENTITY;
505 other, iei = RSL_IE_FULL_BCCH_INFO;
Harald Welte643e2a62017-11-27 15:03:18 +0100506
507 other, OTHERWISE;
508 )" };
509
510 template RSL_IE t_RSL_IE(template RSL_IE_Body body) := {
511 iei := RSL_IE_CHAN_NR, /* overwritten? */
512 body := body
513 }
514
Harald Weltec2877752017-12-07 17:54:35 +0100515 template RSL_IE tr_RSL_IE(template RSL_IE_Body body) := {
516 iei := ?, /* overwritten? */
517 body := body
518 }
519
520
Harald Welte643e2a62017-11-27 15:03:18 +0100521 type record of RSL_IE RSL_IE_List;
522
523 type record RSL_Message {
524 RSL_MessageDiscriminator msg_disc,
525 RSL_MessageType msg_type,
526 RSL_IE_List ies optional
527 }
528
529 external function enc_RSL_Message(in RSL_Message msg) return octetstring
530 with { extension "prototype(convert) encode(RAW)" };
531 external function dec_RSL_Message(in octetstring stream) return RSL_Message
532 with { extension "prototype(convert) decode(RAW)" };
533
Harald Weltebc330be2017-12-09 00:56:36 +0100534 template RSL_Message tr_RSL_MsgDiscType(template RSL_MessageDiscriminator m_disc,
Harald Welte643e2a62017-11-27 15:03:18 +0100535 RSL_MessageType m_type) := {
536 msg_disc := m_disc,
537 msg_type := m_type,
538 ies := *
539 }
540
Harald Weltebc330be2017-12-09 00:56:36 +0100541template RSL_Message tr_RSL_MsgType(template RSL_MessageType msg_type) := {
542 msg_disc := ?,
543 msg_type := msg_type,
544 ies := *
545}
546
547/* Common Channel Management */
548template RSL_Message tr_RSL_MsgTypeC(template RSL_MessageType msg_type) modifies tr_RSL_MsgType := {
549 msg_disc := { RSL_MDISC_CCHAN, ? }
550}
551
552/* RLL */
553template RSL_Message tr_RSL_MsgTypeR(template RSL_MessageType msg_type) modifies tr_RSL_MsgType := {
554 msg_disc := { RSL_MDISC_RLL, true }
555}
556
557/* Dedicated Channel Management */
558template RSL_Message tr_RSL_MsgTypeD(template RSL_MessageType msg_type) modifies tr_RSL_MsgType := {
559 msg_disc := { RSL_MDISC_DCHAN, ? }
560}
561
562/* Dedicated Channel Management */
563template RSL_Message tr_RSL_MsgTypeT(template RSL_MessageType msg_type) modifies tr_RSL_MsgType := {
564 msg_disc := { RSL_MDISC_TRX_MGMT, ? }
565}
566
567
568/* dedicated channel or RLL */
569template RSL_Message tr_RSL_MsgTypeDR(template RSL_MessageType msg_type) modifies tr_RSL_MsgType := {
570 msg_disc := ({RSL_MDISC_DCHAN,?}, {RSL_MDISC_RLL,true})
571}
572
573
Harald Welte643e2a62017-11-27 15:03:18 +0100574 /* 8.3.1 BSC -> BTS */
575 template RSL_Message ts_RSL_DATA_REQ(RslChannelNr chan_nr, RslLinkId link_id, octetstring l3_info) := {
576 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, true),
577 msg_type := RSL_MT_DATA_REQ,
578 ies :={
579 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
580 t_RSL_IE(RSL_IE_Body:{link_id := link_id}),
Harald Welte15bb5b52017-12-07 17:52:04 +0100581 t_RSL_IE(RSL_IE_Body:{l3_info := ts_RSL_L16V(l3_info)})
Harald Welte643e2a62017-11-27 15:03:18 +0100582 }
583 }
584
585 /* 8.3.2 BTS -> BSC */
586 template RSL_Message ts_RSL_DATA_IND(RslChannelNr chan_nr, RslLinkId link_id, octetstring l3_info) := {
587 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, true),
588 msg_type := RSL_MT_DATA_IND,
589 ies :={
590 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
591 t_RSL_IE(RSL_IE_Body:{link_id := link_id}),
Harald Welte15bb5b52017-12-07 17:52:04 +0100592 t_RSL_IE(RSL_IE_Body:{l3_info := ts_RSL_L16V(l3_info)})
Harald Welte643e2a62017-11-27 15:03:18 +0100593 }
594 }
595
596 /* 8.3.3 BTS -> BSC */
597 template RSL_Message ts_RSL_ERROR_IND(RslChannelNr chan_nr, RslLinkId link_id, RSL_Cause cause) := {
598 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, false),
599 msg_type := RSL_MT_ERROR_IND,
600 ies :={
601 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
602 t_RSL_IE(RSL_IE_Body:{link_id := link_id}),
603 t_RSL_IE(RSL_IE_Body:{cause := ts_RSL_IE_Cause(cause)})
604 }
605 }
606
607 /* 8.3.6 BTS -> BSC */
608 template RSL_Message ts_RSL_EST_IND(RslChannelNr chan_nr, RslLinkId link_id, octetstring l3_info) := {
609 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, false),
610 msg_type := RSL_MT_EST_IND,
611 ies := {
612 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
613 t_RSL_IE(RSL_IE_Body:{link_id := link_id}),
Harald Welte15bb5b52017-12-07 17:52:04 +0100614 t_RSL_IE(RSL_IE_Body:{l3_info := ts_RSL_L16V(l3_info)})
Harald Welte643e2a62017-11-27 15:03:18 +0100615 }
616 }
617
618 /* 8.3.7 BSC -> BTS */
619 template RSL_Message ts_RSL_REL_REQ(RslChannelNr chan_nr, RslLinkId link_id) := {
620 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, false),
621 msg_type := RSL_MT_REL_REQ,
622 ies :={
623 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
624 t_RSL_IE(RSL_IE_Body:{link_id := link_id})
625 }
626 }
627
628 /* 8.3.8 BTS -> BSC */
629 template RSL_Message ts_RSL_REL_CONF(RslChannelNr chan_nr, RslLinkId link_id) := {
630 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, false),
631 msg_type := RSL_MT_REL_CONF,
632 ies :={
633 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
634 t_RSL_IE(RSL_IE_Body:{link_id := link_id})
635 }
636 }
637
638 /* 8.3.9 BTS -> BSC */
639 template RSL_Message ts_RSL_REL_IND(RslChannelNr chan_nr, RslLinkId link_id) := {
640 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_RLL, false),
641 msg_type := RSL_MT_REL_IND,
642 ies :={
643 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
644 t_RSL_IE(RSL_IE_Body:{link_id := link_id})
645 }
646 }
647
648 /* 8.3.10 BSC -> BTS */
649 template RSL_Message ts_RSL_UNITDATA_REQ(RslChannelNr chan_nr, RslLinkId link_id, octetstring l3_info)
650 modifies ts_RSL_DATA_REQ := {
651 msg_type := RSL_MT_UNIT_DATA_REQ
652 }
653
654 /* 8.3.11 BTS -> BSC */
655 template RSL_Message ts_RSL_UNITDATA_IND(RslChannelNr chan_nr, RslLinkId link_id, octetstring l3_info)
656 modifies ts_RSL_DATA_IND := {
657 msg_type := RSL_MT_UNIT_DATA_IND
658 }
659
660
661 /* DEDICATED CANNEL MANAGEMENT MESSAGES */
662
663 /* 8.4.1 BSC -> BTS */
664 template RSL_Message ts_RSL_CHAN_ACT(RslChannelNr chan_nr, RSL_IE_ChannelMode mode) := {
665 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_DCHAN, false),
666 msg_type := RSL_MT_CHAN_ACTIV,
667 ies :={
668 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
669 t_RSL_IE(RSL_IE_Body:{act_type := t_RSL_IE_ActType}),
670 t_RSL_IE(RSL_IE_Body:{chan_mode := mode})
671 /* lots of optional IEs */
672 }
673 }
674
675 /* 8.4.2 BTS -> BSC */
676 template RSL_Message ts_RSL_CHAN_ACT_ACK(RslChannelNr chan_nr, GsmFrameNumber fn) := {
677 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_DCHAN, false),
678 msg_type := RSL_MT_CHAN_ACTIV_ACK,
679 ies :={
680 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
681 t_RSL_IE(RSL_IE_Body:{frame_nr := ts_RSL_IE_FrameNumber(fn)})
682 }
683 }
684
685 /* 8.4.3 BTS -> BSC */
686 template RSL_Message ts_RSL_CHAN_ACT_NACK(RslChannelNr chan_nr, RSL_Cause cause) := {
687 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_DCHAN, false),
688 msg_type := RSL_MT_CHAN_ACTIV_NACK,
689 ies :={
690 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
691 t_RSL_IE(RSL_IE_Body:{cause := ts_RSL_IE_Cause(cause)})
692 }
693 }
694
695 /* 8.4.4 BTS -> BSC */
696 template RSL_Message ts_RSL_CONN_FAIL_IND(RslChannelNr chan_nr, RSL_Cause cause) := {
697 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_DCHAN, false),
698 msg_type := RSL_MT_CONN_FAIL,
699 ies :={
700 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
701 t_RSL_IE(RSL_IE_Body:{cause := ts_RSL_IE_Cause(cause)})
702 }
703 }
704
705 /* 8.4.11 BTS -> BSC */
706 template RSL_Message ts_RSL_MODE_MODIFY_NACK(RslChannelNr chan_nr, RSL_Cause cause)
707 modifies ts_RSL_CHAN_ACT_NACK := {
708 msg_type := RSL_MT_MODE_MODIFY_NACK
709 }
710
711 /* COMMON CHANNEL MANAGEMENT MESSAGES */
712
Harald Welte7ae93142017-12-07 17:56:15 +0100713 /* 8.5.2 BTS -> BSC */
714 template RSL_Message ts_RSL_RACH_LOAD_IND(uint16_t slot_ct, uint16_t busy_ct, uint16_t acc_ct) := {
715 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
716 msg_type := RSL_MT_CCCH_LOAD_IND,
717 ies := {
718 t_RSL_IE(RSL_IE_Body:{chan_nr := t_RslChanNr_RACH(0)}),
719 t_RSL_IE(RSL_IE_Body:{rach_load := ts_RSL_IE_RachLoad(slot_ct, busy_ct, acc_ct)})
720 }
721 }
722 template RSL_Message ts_RSL_PAGING_LOAD_IND(uint16_t buffer_space) := {
723 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
724 msg_type := RSL_MT_CCCH_LOAD_IND,
725 ies := {
726 t_RSL_IE(RSL_IE_Body:{chan_nr := t_RslChanNr_PCH_AGCH(0)}),
727 t_RSL_IE(RSL_IE_Body:{paging_load := buffer_space})
728 }
729 }
730
Harald Welte643e2a62017-11-27 15:03:18 +0100731 /* 8.5.3 BTS -> BSC */
Harald Welte101fbed2017-12-07 17:56:38 +0100732 template RSL_Message ts_RSL_CHAN_RQD(OCT1 ra, GsmFrameNumber fn, uint8_t acc_del := 0) := {
Harald Welte643e2a62017-11-27 15:03:18 +0100733 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
734 msg_type := RSL_MT_CHAN_RQD,
735 ies := {
736 t_RSL_IE(RSL_IE_Body:{chan_nr := t_RslChanNr_RACH(0)}),
Harald Welte101fbed2017-12-07 17:56:38 +0100737 t_RSL_IE(RSL_IE_Body:{req_ref := ts_RSL_IE_ReqRef(ra, fn)}),
738 t_RSL_IE(RSL_IE_Body:{access_delay := acc_del})
Harald Welte643e2a62017-11-27 15:03:18 +0100739 }
740 }
741
742 /* 8.5.4 BTS -> BSC */
743 template RSL_Message ts_DELETE_IND(RslChannelNr chan_nr, octetstring imm_ass) := {
744 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
745 msg_type := RSL_MT_DELETE_IND,
746 ies := {
747 t_RSL_IE(RSL_IE_Body:{chan_nr := chan_nr}),
748 t_RSL_IE(RSL_IE_Body:{full_imm_ass_info := ts_RSL_LV(imm_ass)})
749 }
750 }
751
Harald Weltec2877752017-12-07 17:54:35 +0100752 /* 8.5.5 BSC -> BTS */
753 template RSL_Message tr_RSL_PAGING_CMD(template octetstring identity, template uint3_t tn := ?) := {
754 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
755 msg_type := RSL_MT_PAGING_CMD,
756 ies := {
757 tr_RSL_IE(RSL_IE_Body:{chan_nr := t_RslChanNr_PCH_AGCH(tn)}),
758 tr_RSL_IE(RSL_IE_Body:{paging_group := ?}),
759 tr_RSL_IE(RSL_IE_Body:{ms_identity := ts_RSL_LV(identity)}),
760 * /* opt: channel needed, eMLPP prio */
761 }
762 }
763
764 /* 8.5.6 BSC -> BTS */
765 template RSL_Message tr_RSL_IMM_ASSIGN(template uint3_t tn := ?) := {
766 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
767 msg_type := RSL_MT_IMMEDIATE_ASSIGN_CMD,
768 ies := {
769 tr_RSL_IE(RSL_IE_Body:{chan_nr := t_RslChanNr_PCH_AGCH(tn)}),
770 tr_RSL_IE(RSL_IE_Body:{full_imm_ass_info := ?})
771 }
772 }
773
774
Harald Welte643e2a62017-11-27 15:03:18 +0100775 /* 8.6.4 BTS -> BSC */
776 template RSL_Message ts_RSL_ERROR_REPORT(RSL_Cause cause) := {
777 msg_disc := ts_RSL_MsgDisc(RSL_MDISC_CCHAN, false),
778 msg_type := RSL_MT_ERROR_IND,
779 ies := {
780 t_RSL_IE(RSL_IE_Body:{cause := ts_RSL_IE_Cause(cause)})
781 }
782 }
783
784} with { encode "RAW" ; variant "FIELDORDER(msb)" }