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 | * |
| 7 | * (C) 2017 by Harald Welte <laforge@gnumonks.org> |
| 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. |
| 12 | */ |
| 13 | |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 14 | import from Osmocom_Types all; |
| 15 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 16 | type enumerated IpaStreamId { |
Harald Welte | da9d36c | 2017-12-07 17:57:17 +0100 | [diff] [blame] | 17 | IPAC_PROTO_RSL_TRX0 (0), |
| 18 | IPAC_PROTO_RSL_TRX1 (1), |
| 19 | IPAC_PROTO_RSL_TRX2 (2), |
| 20 | IPAC_PROTO_RSL_TRX3 (3), |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 21 | IPAC_PROTO_OSMO (238), |
| 22 | IPAC_PROTO_MGCP_OLD (252), |
| 23 | IPAC_PROTO_SCCP (253), |
| 24 | IPAC_PROTO_CCM (254), |
| 25 | IPAC_PROTO_OML (255) |
| 26 | } with { variant "FIELDLENGTH(8)" } |
| 27 | |
| 28 | type enumerated IpaExtStreamId { |
| 29 | IPAC_PROTO_EXT_CTRL ('00'H), |
| 30 | IPAC_PROTO_EXT_MGCP ('01'H), |
| 31 | IPAC_PROTO_EXT_LAC ('02'H), |
| 32 | IPAC_PROTO_EXT_SMSC ('03'H), |
| 33 | IPAC_PROTO_EXT_ORC ('04'H), |
| 34 | IPAC_PROTO_EXT_GSUP ('05'H), |
| 35 | IPAC_PROTO_EXT_OAP ('06'H) |
| 36 | } with { variant "FIELDLENGTH(8)" } |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 37 | |
| 38 | external function enc_PDU_IPA(in PDU_IPA pdu) return octetstring |
| 39 | with { extension "prototype(convert)" |
| 40 | extension "encode(RAW)" |
| 41 | } |
| 42 | |
| 43 | external function dec_PDU_IPA(in octetstring stream) return PDU_IPA |
| 44 | with { extension "prototype(convert)" |
| 45 | extension "decode(RAW)" |
| 46 | } |
| 47 | |
| 48 | type record PDU_IPA |
| 49 | { |
| 50 | uint16_t lengthInd, |
| 51 | IpaStreamId streamId, |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 52 | IpaExtStreamId streamIdExt optional, |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 53 | octetstring payloadData |
| 54 | } with { |
Harald Welte | 19ad52b | 2017-11-24 19:54:55 +0100 | [diff] [blame] | 55 | variant (lengthInd) "LENGTHTO(streamIdExt,payloadData)"; |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 56 | variant (lengthInd) "FIELDLENGTH(16)"; |
| 57 | variant (lengthInd) "BYTEORDER(last)"; |
Harald Welte | 2a8f847 | 2017-11-23 21:11:34 +0100 | [diff] [blame] | 58 | variant (streamIdExt) "PRESENCE(streamId=IPAC_PROTO_OSMO)"; |
Harald Welte | 00566f5 | 2017-11-21 16:43:49 +0100 | [diff] [blame] | 59 | } |
| 60 | |
Harald Welte | 4c5ef5b | 2017-12-12 15:53:40 +0100 | [diff] [blame] | 61 | template PDU_IPA ts_PDU_IPA(IpaStreamId id, template octetstring payload) := { |
| 62 | lengthInd := 0, |
| 63 | streamId := id, |
| 64 | streamIdExt := omit, |
| 65 | payloadData := valueof(payload) |
| 66 | } |
| 67 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 68 | |
| 69 | type enumerated IpaCcmMsgtype { |
| 70 | IPAC_MSGT_PING ('00'H), |
| 71 | IPAC_MSGT_PONG ('01'H), |
| 72 | IPAC_MSGT_ID_GET ('04'H), |
| 73 | IPAC_MSGT_ID_RESP ('05'H), |
| 74 | IPAC_MSGT_ID_ACK ('06'H) |
| 75 | } with { variant "FIELDLENGTH(8)" } |
| 76 | |
| 77 | type enumerated IpaCcmIdTag { |
| 78 | IPAC_IDTAG_SERNR ('00'H), |
| 79 | IPAC_IDTAG_UNITNAME ('01'H), |
| 80 | IPAC_IDTAG_LOCATION1 ('02'H), |
| 81 | IPAC_IDTAG_LOCATION2 ('03'H), |
| 82 | IPAC_IDTAG_EQUIPVERS ('04'H), |
| 83 | IPAC_IDTAG_SWVERSION ('05'H), |
| 84 | IPAC_IDTAG_IPADDR ('06'H), |
| 85 | IPAC_IDTAG_MACADDR ('07'H), |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 86 | IPAC_IDTAG_UNIT ('08'H), |
| 87 | IPAC_IDTAG_OSMO_RAND ('23'H) |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 88 | } with { variant "FIELDLENGTH(8)" } |
| 89 | |
| 90 | |
| 91 | type record IpaCcmGetPart { |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 92 | uint8_t len, |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 93 | IpaCcmIdTag tag |
Harald Welte | 92e9816 | 2017-11-29 11:09:13 +0100 | [diff] [blame] | 94 | } with { variant (len) "LENGTHTO(tag)" } |
| 95 | |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 96 | type set of IpaCcmGetPart IpaCcmIdGet; |
| 97 | |
| 98 | type record IpaCcmRespPart { |
| 99 | uint16_t len, |
| 100 | IpaCcmIdTag tag, |
| 101 | charstring data |
| 102 | } with { variant (len) "LENGTHTO(data,tag)" } |
| 103 | type set of IpaCcmRespPart IpaCcmIdResp; |
| 104 | |
| 105 | type union IpaCcmUnion { |
| 106 | IpaCcmIdGet get, |
| 107 | IpaCcmIdResp resp, |
| 108 | octetstring other |
| 109 | } |
| 110 | |
| 111 | type record PDU_IPA_CCM { |
| 112 | IpaCcmMsgtype msg_type, |
| 113 | IpaCcmUnion u optional |
Harald Welte | a1f0cbc | 2017-11-29 11:04:40 +0100 | [diff] [blame] | 114 | } with { variant (u) "CROSSTAG( |
| 115 | get, msg_type = IPAC_MSGT_ID_GET; |
| 116 | resp, msg_type = IPAC_MSGT_ID_RESP; |
| 117 | other, OTHERWISE; |
| 118 | )" }; |
Harald Welte | d86cdc6 | 2017-11-22 00:45:07 +0100 | [diff] [blame] | 119 | |
| 120 | |
| 121 | external function enc_PDU_IPA_CCM(in PDU_IPA_CCM pdu) return octetstring |
| 122 | with { extension "prototype(convert)" |
| 123 | extension "encode(RAW)" |
| 124 | } |
| 125 | |
| 126 | external function dec_PDU_IPA_CCM(in octetstring stream) return PDU_IPA_CCM |
| 127 | with { extension "prototype(convert)" |
| 128 | extension "decode(RAW)" |
| 129 | } |
| 130 | |
| 131 | |
| 132 | } with { encode "RAW" } |