Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 1 | module IPA_Types { |
| 2 | |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 3 | /* Definitions of abstract data types for the IPA multiplex protocol. |
| 4 | * Uses the TITAN "RAW" codec syntax to auto-generate encoder and decoder |
| 5 | * functions. |
| 6 | * |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 7 | * (C) 2017-2018 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 8 | * All rights reserved. |
| 9 | * |
| 10 | * Released under the terms of GNU General Public License, Version 2 or |
| 11 | * (at your option) any later version. |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 12 | * |
| 13 | * SPDX-License-Identifier: GPL-2.0-or-later |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 14 | */ |
| 15 | |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 16 | import from Osmocom_Types all; |
| 17 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 18 | type enumerated IpaStreamId { |
Harald Welte | da9d36c | 2017-12-07 17:57:17 +0100 | [diff] [blame] | 19 | IPAC_PROTO_RSL_TRX0 (0), |
| 20 | IPAC_PROTO_RSL_TRX1 (1), |
| 21 | IPAC_PROTO_RSL_TRX2 (2), |
| 22 | IPAC_PROTO_RSL_TRX3 (3), |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 23 | IPAC_PROTO_OSMO (238), |
| 24 | IPAC_PROTO_MGCP_OLD (252), |
| 25 | IPAC_PROTO_SCCP (253), |
| 26 | IPAC_PROTO_CCM (254), |
| 27 | IPAC_PROTO_OML (255) |
| 28 | } with { variant "FIELDLENGTH(8)" } |
| 29 | |
| 30 | type enumerated IpaExtStreamId { |
| 31 | IPAC_PROTO_EXT_CTRL ('00'H), |
| 32 | IPAC_PROTO_EXT_MGCP ('01'H), |
| 33 | IPAC_PROTO_EXT_LAC ('02'H), |
| 34 | IPAC_PROTO_EXT_SMSC ('03'H), |
| 35 | IPAC_PROTO_EXT_ORC ('04'H), |
| 36 | IPAC_PROTO_EXT_GSUP ('05'H), |
Harald Welte | 7460a72 | 2018-10-10 12:28:27 +0200 | [diff] [blame] | 37 | IPAC_PROTO_EXT_OAP ('06'H), |
Pau Espin Pedrol | 6924ef7 | 2021-06-09 16:19:26 +0200 | [diff] [blame] | 38 | IPAC_PROTO_EXT_RSPRO ('07'H), |
| 39 | IPAC_PROTO_EXT_OSMO_PCU ('08'H) |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 40 | } with { variant "FIELDLENGTH(8)" } |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 41 | |
| 42 | external function enc_PDU_IPA(in PDU_IPA pdu) return octetstring |
| 43 | with { extension "prototype(convert)" |
| 44 | extension "encode(RAW)" |
| 45 | } |
| 46 | |
| 47 | external function dec_PDU_IPA(in octetstring stream) return PDU_IPA |
| 48 | with { extension "prototype(convert)" |
| 49 | extension "decode(RAW)" |
| 50 | } |
| 51 | |
| 52 | type record PDU_IPA |
| 53 | { |
| 54 | uint16_t lengthInd, |
| 55 | IpaStreamId streamId, |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 56 | IpaExtStreamId streamIdExt optional, |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 57 | octetstring payloadData |
| 58 | } with { |
Harald Welte | 19ad52b | 2017-11-24 19:54:55 +0100 | [diff] [blame] | 59 | variant (lengthInd) "LENGTHTO(streamIdExt,payloadData)"; |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 60 | variant (lengthInd) "FIELDLENGTH(16)"; |
| 61 | variant (lengthInd) "BYTEORDER(last)"; |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 62 | variant (streamIdExt) "PRESENCE(streamId=IPAC_PROTO_OSMO)"; |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 63 | } |
| 64 | |
Harald Welte | 4c5ef5b | 2017-12-12 15:53:40 +0100 | [diff] [blame] | 65 | template PDU_IPA ts_PDU_IPA(IpaStreamId id, template octetstring payload) := { |
| 66 | lengthInd := 0, |
| 67 | streamId := id, |
| 68 | streamIdExt := omit, |
| 69 | payloadData := valueof(payload) |
| 70 | } |
| 71 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 72 | |
| 73 | type enumerated IpaCcmMsgtype { |
| 74 | IPAC_MSGT_PING ('00'H), |
| 75 | IPAC_MSGT_PONG ('01'H), |
| 76 | IPAC_MSGT_ID_GET ('04'H), |
| 77 | IPAC_MSGT_ID_RESP ('05'H), |
| 78 | IPAC_MSGT_ID_ACK ('06'H) |
| 79 | } with { variant "FIELDLENGTH(8)" } |
| 80 | |
| 81 | type enumerated IpaCcmIdTag { |
| 82 | IPAC_IDTAG_SERNR ('00'H), |
| 83 | IPAC_IDTAG_UNITNAME ('01'H), |
| 84 | IPAC_IDTAG_LOCATION1 ('02'H), |
| 85 | IPAC_IDTAG_LOCATION2 ('03'H), |
| 86 | IPAC_IDTAG_EQUIPVERS ('04'H), |
| 87 | IPAC_IDTAG_SWVERSION ('05'H), |
| 88 | IPAC_IDTAG_IPADDR ('06'H), |
| 89 | IPAC_IDTAG_MACADDR ('07'H), |
Vadim Yanitskiy | 44f0c48 | 2020-05-24 20:49:29 +0700 | [diff] [blame] | 90 | IPAC_IDTAG_UNITID ('08'H), |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 91 | IPAC_IDTAG_OSMO_RAND ('23'H) |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 92 | } with { variant "FIELDLENGTH(8)" } |
| 93 | |
| 94 | |
| 95 | type record IpaCcmGetPart { |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 96 | uint8_t len, |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 97 | IpaCcmIdTag tag |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 98 | } with { variant (len) "LENGTHTO(tag)" } |
| 99 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 100 | type set of IpaCcmGetPart IpaCcmIdGet; |
| 101 | |
| 102 | type record IpaCcmRespPart { |
| 103 | uint16_t len, |
| 104 | IpaCcmIdTag tag, |
Harald Welte | 95686e0 | 2018-08-02 15:05:43 +0200 | [diff] [blame] | 105 | octetstring data |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 106 | } with { variant (len) "LENGTHTO(data,tag)" } |
| 107 | type set of IpaCcmRespPart IpaCcmIdResp; |
| 108 | |
| 109 | type union IpaCcmUnion { |
| 110 | IpaCcmIdGet get, |
| 111 | IpaCcmIdResp resp, |
| 112 | octetstring other |
| 113 | } |
| 114 | |
| 115 | type record PDU_IPA_CCM { |
| 116 | IpaCcmMsgtype msg_type, |
| 117 | IpaCcmUnion u optional |
Harald Welte | a1f0cbc | 2017-11-29 11:04:40 +0100 | [diff] [blame] | 118 | } with { variant (u) "CROSSTAG( |
| 119 | get, msg_type = IPAC_MSGT_ID_GET; |
| 120 | resp, msg_type = IPAC_MSGT_ID_RESP; |
| 121 | other, OTHERWISE; |
| 122 | )" }; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 123 | |
| 124 | |
| 125 | external function enc_PDU_IPA_CCM(in PDU_IPA_CCM pdu) return octetstring |
| 126 | with { extension "prototype(convert)" |
| 127 | extension "encode(RAW)" |
| 128 | } |
| 129 | |
| 130 | external function dec_PDU_IPA_CCM(in octetstring stream) return PDU_IPA_CCM |
| 131 | with { extension "prototype(convert)" |
| 132 | extension "decode(RAW)" |
| 133 | } |
| 134 | |
Vadim Yanitskiy | 89be8e2 | 2020-05-25 23:37:00 +0700 | [diff] [blame] | 135 | /* Example: 1234/0/0 (site_id=1234, bts_id=0, trx_id=0) */ |
| 136 | type record IpaUnitId { |
| 137 | integer site_id, |
| 138 | integer bts_id, |
| 139 | integer trx_id |
| 140 | } with { |
| 141 | encode "TEXT" |
| 142 | variant "SEPARATOR('/')" |
| 143 | /* workaround for https://gitlab.eclipse.org/eclipse/titan/titan.core/-/issues/725 */ |
| 144 | variant (trx_id) "TEXT_CODING(,,'\d+')" |
| 145 | }; |
| 146 | |
| 147 | external function enc_IpaUnitId(in IpaUnitId unit_id) return charstring |
| 148 | with { extension "prototype(convert) encode(TEXT)" } |
| 149 | external function dec_IpaUnitId(in charstring stream) return IpaUnitId |
| 150 | with { extension "prototype(convert) decode(TEXT)" } |
| 151 | |
| 152 | template (value) IpaUnitId ts_IpaUnitId(integer site_id := 1234, |
| 153 | integer bts_id := 0, |
| 154 | integer trx_id := 0) := { |
| 155 | site_id := site_id, |
| 156 | bts_id := bts_id, |
| 157 | trx_id := trx_id |
| 158 | }; |
| 159 | template (present) IpaUnitId tr_IpaUnitId(template (present) integer site_id := ?, |
| 160 | template (present) integer bts_id := ?, |
| 161 | template (present) integer trx_id := ?) := { |
| 162 | site_id := site_id, |
| 163 | bts_id := bts_id, |
| 164 | trx_id := trx_id |
| 165 | }; |
| 166 | |
Vadim Yanitskiy | 6de2fcb | 2020-05-25 19:40:45 +0700 | [diff] [blame] | 167 | /* Finds an IE with the given tag in IPA IDENTITY RESPONSE. |
| 168 | * Returns index of an IE if found, -1 otherwise. */ |
| 169 | function f_ipa_id_resp_find_ie(in IpaCcmIdResp resp, IpaCcmIdTag tag) |
| 170 | return integer { |
| 171 | for (var integer i := 0; i < sizeof(resp); i := i + 1) { |
| 172 | if (resp[i].tag == tag) { |
| 173 | return i; |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | return -1; |
| 178 | } |
| 179 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 180 | |
| 181 | } with { encode "RAW" } |