blob: 044dd7593241a5222d18df1395911333e63df2f2 [file] [log] [blame]
Harald Welte033cef02010-12-19 22:47:14 +01001% ITU-T Q.71x SCCP Message coding / decoding
2
3% (C) 2010 by Harald Welte <laforge@gnumonks.org>
4%
5% All Rights Reserved
6%
7% This program is free software; you can redistribute it and/or modify
8% it under the terms of the GNU Affero General Public License as
9% published by the Free Software Foundation; either version 3 of the
10% License, or (at your option) any later version.
11%
12% This program is distributed in the hope that it will be useful,
13% but WITHOUT ANY WARRANTY; without even the implied warranty of
14% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15% GNU General Public License for more details.
16%
17% You should have received a copy of the GNU Affero General Public License
18% along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20-module(sccp_codec).
21-author('Harald Welte <laforge@gnumonks.org>').
22-include("sccp.hrl").
23
Harald Welte9abbbad2011-04-21 12:19:41 +020024-export([parse_sccp_msg/1, encode_sccp_msg/1, encode_sccp_msgt/2,
25 is_connectionless/1]).
Harald Welte033cef02010-12-19 22:47:14 +010026
Harald Welte9baab6d2011-12-08 00:46:00 +010027-export([gen_gt_helper/1, gen_addr_helper/2, gen_addr_helper/3]).
28
Harald Welte033cef02010-12-19 22:47:14 +010029-compile(export_all).
30
Harald Welte2edaf552011-04-02 16:46:16 +020031-compile({parse_transform, exprecs}).
Harald Welte0f2f5962011-04-04 15:59:49 +020032-export_records([global_title, sccp_addr, sccp_msg]).
Harald Welte2edaf552011-04-02 16:46:16 +020033
Harald Welted9c318f2011-12-10 22:17:11 +010034binarify(In) when is_binary(In) ->
35 In;
36binarify(In) when is_list(In) ->
37 list_to_binary(In).
38
Harald Welte2b4b2672011-02-03 12:50:41 +010039parse_point_code(BinPC, PCind) when is_binary(BinPC) ->
Harald Welteba6fdbb2011-01-23 22:04:39 +010040 case PCind of
41 1 ->
Harald Welte9c3b1bb2011-10-12 17:00:34 +020042 <<PointCode:16/little, Remain/binary>> = BinPC;
Harald Welteba6fdbb2011-01-23 22:04:39 +010043 _ ->
44 Remain = BinPC,
Harald Welteb5936ba2011-12-08 00:58:51 +010045 PointCode = undefined
Harald Welteba6fdbb2011-01-23 22:04:39 +010046 end,
Harald Welte2b4b2672011-02-03 12:50:41 +010047 {Remain, PointCode}.
Harald Welteba6fdbb2011-01-23 22:04:39 +010048
Harald Welte2b4b2672011-02-03 12:50:41 +010049parse_ssn(BinSSN, SSNind) ->
Harald Welteba6fdbb2011-01-23 22:04:39 +010050 case SSNind of
51 1 ->
Harald Welte2b4b2672011-02-03 12:50:41 +010052 <<SSN:8, Remain/binary>> = BinSSN;
Harald Welteba6fdbb2011-01-23 22:04:39 +010053 _ ->
54 Remain = BinSSN,
Harald Welteb5936ba2011-12-08 00:58:51 +010055 SSN = undefined
Harald Welteba6fdbb2011-01-23 22:04:39 +010056 end,
Harald Welte2b4b2672011-02-03 12:50:41 +010057 {Remain, SSN}.
Harald Welteba6fdbb2011-01-23 22:04:39 +010058
59enc_is_odd(Enc) ->
60 case Enc of
61 1 -> 1;
62 _ -> 0
63 end.
64
Harald Welte2b4b2672011-02-03 12:50:41 +010065parse_gt(BinGT, GTind) ->
Harald Welteba6fdbb2011-01-23 22:04:39 +010066 case GTind of
67 ?SCCP_GTI_NO_GT ->
Harald Welteb5936ba2011-12-08 00:58:51 +010068 undefined;
Harald Welteba6fdbb2011-01-23 22:04:39 +010069 ?SCCP_GTI_NAT_ONLY ->
70 % Figure 7/Q.713
71 <<Odd:1, Nature:7, Digits/binary>> = BinGT,
72 PhoneNum = isup_codec:parse_isup_party(Digits, Odd),
Harald Welte2b4b2672011-02-03 12:50:41 +010073 #global_title{gti = GTind,
74 nature_of_addr_ind = Nature,
75 phone_number = PhoneNum};
Harald Welteba6fdbb2011-01-23 22:04:39 +010076 ?SCCP_GTI_TT_ONLY ->
77 % Figure 9/Q.913
78 <<TransType:8, Digits/binary>> = BinGT,
79 % Used in national interfaces only, we cannot parse Digits
Harald Welte2b4b2672011-02-03 12:50:41 +010080 #global_title{gti = GTind,
81 trans_type = TransType,
82 phone_number = Digits};
Harald Welteba6fdbb2011-01-23 22:04:39 +010083 ?SCCP_GTI_TT_NP_ENC ->
84 % Figure 10/Q.713
85 <<TransType:8, NumPlan:4, Enc:4, Digits/binary>> = BinGT,
86 PhoneNum = isup_codec:parse_isup_party(Digits, enc_is_odd(Enc)),
Harald Welte2b4b2672011-02-03 12:50:41 +010087 #global_title{gti = GTind,
88 trans_type = TransType, encoding = Enc,
89 numbering_plan = NumPlan,
90 phone_number = PhoneNum};
Harald Welteba6fdbb2011-01-23 22:04:39 +010091 ?SCCP_GTI_TT_NP_ENC_NAT ->
92 % Figure 11/Q.713
93 <<TransType:8, NumPlan:4, Enc:4, 0:1, Nature:7, Digits/binary>> = BinGT,
94 PhoneNum = isup_codec:parse_isup_party(Digits, enc_is_odd(Enc)),
Harald Welte2b4b2672011-02-03 12:50:41 +010095 #global_title{gti = GTind,
96 trans_type = TransType, encoding = Enc,
97 numbering_plan = NumPlan,
98 nature_of_addr_ind = Nature,
99 phone_number = PhoneNum};
Harald Welteba6fdbb2011-01-23 22:04:39 +0100100 _ ->
Harald Welte2b4b2672011-02-03 12:50:41 +0100101 BinGT
102 end.
Harald Welteba6fdbb2011-01-23 22:04:39 +0100103
104% parse SCCP Address
105parse_sccp_addr(BinAddr) when is_binary(BinAddr) ->
106 <<ResNatUse:1, RoutInd:1, GTind:4, SSNind:1, PCind:1, Remain/binary>> = BinAddr,
Harald Welte2b4b2672011-02-03 12:50:41 +0100107 {RemainPC, OptPC} = parse_point_code(Remain, PCind),
108 {RemainSSN, OptSSN} = parse_ssn(RemainPC, SSNind),
109 OptGT = parse_gt(RemainSSN, GTind),
110 #sccp_addr{res_nat_use = ResNatUse, route_on_ssn = RoutInd,
111 point_code = OptPC, ssn = OptSSN, global_title = OptGT}.
Harald Welte033cef02010-12-19 22:47:14 +0100112
113% parse SCCP Optional Part
114parse_sccp_opt(OptType, OptLen, Content) ->
115 {OptType, {OptLen, Content}}.
116
117parse_sccp_opts(<<>>, OptList) ->
118 % empty list
119 OptList;
120parse_sccp_opts(<<0>>, OptList) ->
121 % end of options
122 OptList;
123parse_sccp_opts(OptBin, OptList) ->
124 <<OptType, OptLen, Content:OptLen/binary, Remain/binary>> = OptBin,
125 NewOpt = parse_sccp_opt(OptType, OptLen, Content),
126 parse_sccp_opts(Remain, [NewOpt|OptList]).
127
128% Parse incoming SCCP message, one function for every message type
129parse_sccp_msgt(?SCCP_MSGT_CR, DataBin) ->
130 % first get the fixed part
Harald Welte11565772011-04-15 10:37:57 +0200131 <<_:8, SrcLocalRef:24/big, PCOpt:4, ProtoClass:4, RemainVar/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100132 % variable length fixed part
133 <<PtrVar:8, PtrOpt:8, _/binary>> = RemainVar,
134 CalledPartyLen = binary:at(RemainVar, PtrVar),
135 CalledParty = binary:part(RemainVar, PtrVar+1, CalledPartyLen),
Harald Welte234c9562011-02-03 13:51:12 +0100136 CalledPartyDec = parse_sccp_addr(CalledParty),
Harald Welte033cef02010-12-19 22:47:14 +0100137 % optional part
138 OptBin = binary:part(RemainVar, 1 + PtrOpt, byte_size(RemainVar)-(1+PtrOpt)),
139 OptList = parse_sccp_opts(OptBin, []),
140 %OptList = [],
141 % build parsed list of message
Harald Welte11565772011-04-15 10:37:57 +0200142 [{src_local_ref, SrcLocalRef},{protocol_class, {ProtoClass, PCOpt}},
143 {called_party_addr, CalledPartyDec} | OptList];
Harald Welte033cef02010-12-19 22:47:14 +0100144parse_sccp_msgt(?SCCP_MSGT_CC, DataBin) ->
145 % first get the fixed part
Harald Welte11565772011-04-15 10:37:57 +0200146 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big, PCOpt:4, ProtoClass:4, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100147 % optional part
148 OptList = parse_sccp_opts(Remain, []),
149 % build parsed list of message
Harald Welte11565772011-04-15 10:37:57 +0200150 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef},
151 {protocol_class, {ProtoClass, PCOpt}} | OptList];
Harald Welte033cef02010-12-19 22:47:14 +0100152parse_sccp_msgt(?SCCP_MSGT_CREF, DataBin) ->
153 % first get the fixed part
Harald Welte56ee7a62010-12-20 13:34:32 +0100154 <<_:8, DstLocalRef:24/big, RefusalCause:8, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100155 % optional part
156 OptList = parse_sccp_opts(Remain, []),
157 % build parsed list of message
158 [{dst_local_ref, DstLocalRef},{refusal_cause, RefusalCause}|OptList];
159parse_sccp_msgt(?SCCP_MSGT_RLSD, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100160 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big, ReleaseCause:8, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100161 % optional part
162 OptList = parse_sccp_opts(Remain, []),
163 % build parsed list of message
164 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef},{release_cause, ReleaseCause}|OptList];
165parse_sccp_msgt(?SCCP_MSGT_RLC, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100166 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100167 % build parsed list of message
168 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef}];
169parse_sccp_msgt(?SCCP_MSGT_DT1, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100170 <<_:8, DstLocalRef:24/big, SegmReass:8, DataPtr:8, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100171 DataLen = binary:at(Remain, DataPtr-1),
172 UserData = binary:part(Remain, DataPtr-1+1, DataLen),
173 % build parsed list of message
174 [{dst_local_ref, DstLocalRef},{segm_reass, SegmReass},{user_data, UserData}];
175parse_sccp_msgt(?SCCP_MSGT_DT2, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100176 <<_:8, DstLocalRef:24/big, SeqSegm:16, DataPtr:8, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100177 DataLen = binary:at(Remain, DataPtr-1),
178 UserData = binary:part(Remain, DataPtr-1+1, DataLen),
179 % build parsed list of message
180 [{dst_local_ref, DstLocalRef},{seq_segm, SeqSegm},{user_data, UserData}];
181parse_sccp_msgt(?SCCP_MSGT_AK, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100182 <<_:8, DstLocalRef:24/big, RxSeqnr:8, Credit:8>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100183 [{dst_local_ref, DstLocalRef},{rx_seq_nr, RxSeqnr},{credit, Credit}];
184parse_sccp_msgt(?SCCP_MSGT_UDT, DataBin) ->
Harald Welte11565772011-04-15 10:37:57 +0200185 <<_:8, PCOpt:4, ProtoClass:4, CalledPartyPtr:8, CallingPartyPtr:8, DataPtr:8, Remain/binary >> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100186 % variable part
187 CalledPartyLen = binary:at(Remain, CalledPartyPtr-3),
188 CalledParty = binary:part(Remain, CalledPartyPtr-3+1, CalledPartyLen),
Harald Welte234c9562011-02-03 13:51:12 +0100189 CalledPartyDec = parse_sccp_addr(CalledParty),
Harald Welte033cef02010-12-19 22:47:14 +0100190 CallingPartyLen = binary:at(Remain, CallingPartyPtr-2),
191 CallingParty = binary:part(Remain, CallingPartyPtr-2+1, CallingPartyLen),
Harald Welte234c9562011-02-03 13:51:12 +0100192 CallingPartyDec = parse_sccp_addr(CallingParty),
Harald Welte033cef02010-12-19 22:47:14 +0100193 DataLen = binary:at(Remain, DataPtr-1),
194 UserData = binary:part(Remain, DataPtr-1+1, DataLen),
Harald Welte11565772011-04-15 10:37:57 +0200195 [{protocol_class, {ProtoClass, PCOpt}},{called_party_addr, CalledPartyDec},
Harald Welte234c9562011-02-03 13:51:12 +0100196 {calling_party_addr, CallingPartyDec},{user_data, UserData}];
Harald Welte033cef02010-12-19 22:47:14 +0100197parse_sccp_msgt(?SCCP_MSGT_UDTS, DataBin) ->
Harald Welte030f1092011-03-11 19:08:07 +0100198 <<_:8, ReturnCause:8, CalledPartyPtr:8, CallingPartyPtr:8, DataPtr:8, Remain/binary >> = DataBin,
199 % variable part
200 CalledPartyLen = binary:at(Remain, CalledPartyPtr-3),
201 CalledParty = binary:part(Remain, CalledPartyPtr-3+1, CalledPartyLen),
202 CalledPartyDec = parse_sccp_addr(CalledParty),
203 CallingPartyLen = binary:at(Remain, CallingPartyPtr-2),
204 CallingParty = binary:part(Remain, CallingPartyPtr-2+1, CallingPartyLen),
205 CallingPartyDec = parse_sccp_addr(CallingParty),
206 DataLen = binary:at(Remain, DataPtr-1),
207 UserData = binary:part(Remain, DataPtr-1+1, DataLen),
208 [{return_cause, ReturnCause},{called_party_addr, CalledPartyDec},
209 {calling_party_addr, CallingPartyDec},{user_data, UserData}];
Harald Welte033cef02010-12-19 22:47:14 +0100210parse_sccp_msgt(?SCCP_MSGT_ED, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100211 <<_:8, DstLocalRef:24/big, DataPtr:8, Remain/binary>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100212 DataLen = binary:at(Remain, DataPtr-1),
213 UserData = binary:part(Remain, DataPtr-1+1, DataLen),
214 [{dst_local_ref, DstLocalRef}, {user_data, UserData}];
215parse_sccp_msgt(?SCCP_MSGT_EA, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100216 <<_:8, DstLocalRef:24/big>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100217 [{dst_local_ref, DstLocalRef}];
218parse_sccp_msgt(?SCCP_MSGT_RSR, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100219 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big, ResetCause:8>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100220 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef},{reset_cause, ResetCause}];
221parse_sccp_msgt(?SCCP_MSGT_RSC, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100222 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100223 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef}];
224parse_sccp_msgt(?SCCP_MSGT_ERR, DataBin) ->
Harald Welte56ee7a62010-12-20 13:34:32 +0100225 <<_:8, DstLocalRef:24/big, ErrCause:8>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100226 [{dst_local_ref, DstLocalRef},{error_cause, ErrCause}];
227parse_sccp_msgt(?SCCP_MSGT_IT, DataBin) ->
Harald Welte11565772011-04-15 10:37:57 +0200228 <<_:8, DstLocalRef:24/big, SrcLocalRef:24/big, PCOpt: 4, ProtoClass:4, SegmSeq:16, Credit:8>> = DataBin,
Harald Welte033cef02010-12-19 22:47:14 +0100229 [{dst_local_ref, DstLocalRef},{src_local_ref, SrcLocalRef},
Harald Welte11565772011-04-15 10:37:57 +0200230 {protocol_class, {ProtoClass, PCOpt}},{seq_segm, SegmSeq},{credit, Credit}].
Harald Welte033cef02010-12-19 22:47:14 +0100231% FIXME: XUDT/XUDTS, LUDT/LUDTS
232
233% process one incoming SCCP message
234parse_sccp_msg(DataBin) ->
235 MsgType = binary:first(DataBin),
236 Parsed = parse_sccp_msgt(MsgType, DataBin),
237 {ok, #sccp_msg{msg_type = MsgType, parameters = Parsed}}.
238
239% Encoding Part
240
Harald Welte0e1709c2011-02-06 22:17:53 +0100241gt_enc_by_odd(Odd) ->
242 if Odd == 1 ->
243 1;
244 true ->
245 2
246 end.
247
Harald Welte5a1cf3c2011-04-14 21:55:13 +0200248encode_gt(undefined) ->
249 {?SCCP_GTI_NO_GT, <<>>};
Harald Welte234c9562011-02-03 13:51:12 +0100250encode_gt(#global_title{gti = GTind, phone_number = PhoneNum,
251 nature_of_addr_ind = Nature,
Harald Welte0e1709c2011-02-06 22:17:53 +0100252 trans_type = TransType, encoding = _EncOrig,
Harald Welte234c9562011-02-03 13:51:12 +0100253 numbering_plan = NumPlan}) ->
254 case GTind of
255 ?SCCP_GTI_NO_GT ->
256 {GTind, <<>>};
257 ?SCCP_GTI_NAT_ONLY ->
258 % Figure 7/Q.713
259 {PhoneBin, OddEven} = isup_codec:encode_isup_party(PhoneNum),
260 {GTind, <<OddEven:1, Nature:7, PhoneBin/binary>>};
261 ?SCCP_GTI_TT_ONLY ->
262 % Figure 9/Q.913
263 % Used in national interfaces only, we cannot parse Digits
264 {GTind, <<TransType:8, PhoneNum/binary>>};
265 ?SCCP_GTI_TT_NP_ENC ->
266 % Figure 10/Q.713
Harald Welte0e1709c2011-02-06 22:17:53 +0100267 {PhoneBin, OddEven} = isup_codec:encode_isup_party(PhoneNum),
268 Enc = gt_enc_by_odd(OddEven),
Harald Welte234c9562011-02-03 13:51:12 +0100269 {GTind, <<TransType:8, NumPlan:4, Enc:4, PhoneBin/binary>>};
270 ?SCCP_GTI_TT_NP_ENC_NAT ->
271 % Figure 11/Q.713
Harald Welte0e1709c2011-02-06 22:17:53 +0100272 {PhoneBin, OddEven} = isup_codec:encode_isup_party(PhoneNum),
273 Enc = gt_enc_by_odd(OddEven),
Harald Welte234c9562011-02-03 13:51:12 +0100274 {GTind, <<TransType:8, NumPlan:4, Enc:4, 0:1, Nature:7, PhoneBin/binary>>}
275 end.
276
Harald Welte683ed232011-12-08 00:56:54 +0100277encode_pc(PointCode) when is_integer(PointCode) ->
Harald Welte234c9562011-02-03 13:51:12 +0100278 case PointCode of
Harald Welteb5936ba2011-12-08 00:58:51 +0100279 undefined ->
Harald Welte234c9562011-02-03 13:51:12 +0100280 {0, <<>>};
281 _ ->
Harald Welte9c3b1bb2011-10-12 17:00:34 +0200282 {1, <<PointCode:16/little>>}
Harald Welte683ed232011-12-08 00:56:54 +0100283 end;
284encode_pc(PcRec) ->
285 PcInt = osmo_util:pointcode2int(PcRec),
286 encode_pc(PcInt).
Harald Welte234c9562011-02-03 13:51:12 +0100287
288encode_ssn(SSN) ->
289 case SSN of
Harald Welteb5936ba2011-12-08 00:58:51 +0100290 undefined ->
Harald Welte234c9562011-02-03 13:51:12 +0100291 {0, <<>>};
292 _ ->
293 {1, <<SSN:8>>}
294 end.
295
Harald Welte5a1cf3c2011-04-14 21:55:13 +0200296undef_or_true(Foo) ->
297 case Foo of
298 undefined -> 0;
299 0 -> 0;
300 _ -> 1
301 end.
302
303
Harald Welte234c9562011-02-03 13:51:12 +0100304encode_sccp_addr(#sccp_addr{res_nat_use = ResNatUse,
305 route_on_ssn = RoutInd,
306 point_code = PointCode,
307 ssn = SSN,
308 global_title = GT}) ->
309
310 {GTind, GTbin} = encode_gt(GT),
311 {SSNind, SSNbin} = encode_ssn(SSN),
312 {PCind, PCbin} = encode_pc(PointCode),
Harald Welte5a1cf3c2011-04-14 21:55:13 +0200313 ResNatOut = undef_or_true(ResNatUse),
314 RoutIndOut = undef_or_true(RoutInd),
315 <<ResNatOut:1, RoutIndOut:1, GTind:4, SSNind:1, PCind:1, PCbin/binary, SSNbin/binary, GTbin/binary>>.
Harald Welte234c9562011-02-03 13:51:12 +0100316
317
Harald Welte033cef02010-12-19 22:47:14 +0100318encode_sccp_opt({OptNum, {DataBinLen, DataBin}}) when is_integer(OptNum) ->
319 DataBinLen8 = DataBinLen*8,
320 <<OptNum:8, DataBinLen:8, DataBin:DataBinLen8>>;
321encode_sccp_opt({OptAtom,_}) when is_atom(OptAtom) ->
322 <<>>.
323
324encode_sccp_opts([], OptEnc) ->
325 % end of options + convert to binary
326 list_to_binary([OptEnc, ?SCCP_PNC_END_OF_OPTIONAL]);
327encode_sccp_opts([CurOpt|OptPropList], OptEnc) ->
328 CurOptEnc = encode_sccp_opt(CurOpt),
329 encode_sccp_opts(OptPropList, list_to_binary([OptEnc,CurOptEnc])).
330
331
332
333encode_sccp_msgt(?SCCP_MSGT_CR, Params) ->
334 SrcLocalRef = proplists:get_value(src_local_ref, Params),
Harald Welte11565772011-04-15 10:37:57 +0200335 {ProtoClass, PCOpt} = proplists:get_value(protocol_class, Params),
Harald Welte033cef02010-12-19 22:47:14 +0100336 OptBin = encode_sccp_opts(Params, []),
Harald Welte11565772011-04-15 10:37:57 +0200337 <<?SCCP_MSGT_CR:8, SrcLocalRef:24/big, PCOpt:4, ProtoClass:4, OptBin/binary>>;
Harald Welte033cef02010-12-19 22:47:14 +0100338encode_sccp_msgt(?SCCP_MSGT_CC, Params) ->
339 SrcLocalRef = proplists:get_value(src_local_ref, Params),
340 DstLocalRef = proplists:get_value(dst_local_ref, Params),
Harald Welte11565772011-04-15 10:37:57 +0200341 {ProtoClass, PCOpt} = proplists:get_value(protocol_class, Params),
Harald Welte033cef02010-12-19 22:47:14 +0100342 OptBin = encode_sccp_opts(Params, []),
Harald Welte11565772011-04-15 10:37:57 +0200343 <<?SCCP_MSGT_CC:8, DstLocalRef:24/big, SrcLocalRef:24/big, PCOpt:4, ProtoClass:4, OptBin/binary>>;
Harald Welte033cef02010-12-19 22:47:14 +0100344encode_sccp_msgt(?SCCP_MSGT_CREF, Params) ->
345 DstLocalRef = proplists:get_value(dst_local_ref, Params),
346 RefusalCause = proplists:get_value(refusal_cause, Params),
Harald Weltec0696b02010-12-20 00:09:37 +0100347 OptBin = encode_sccp_opts(Params, []),
Harald Welte56ee7a62010-12-20 13:34:32 +0100348 <<?SCCP_MSGT_CREF:8, DstLocalRef:24/big, RefusalCause:8, OptBin/binary>>;
Harald Welte033cef02010-12-19 22:47:14 +0100349encode_sccp_msgt(?SCCP_MSGT_RLSD, Params) ->
350 SrcLocalRef = proplists:get_value(src_local_ref, Params),
351 DstLocalRef = proplists:get_value(dst_local_ref, Params),
352 ReleaseCause = proplists:get_value(release_cause, Params),
Harald Weltec0696b02010-12-20 00:09:37 +0100353 OptBin = encode_sccp_opts(Params, []),
Harald Welte56ee7a62010-12-20 13:34:32 +0100354 <<?SCCP_MSGT_RLSD:8, DstLocalRef:24/big, SrcLocalRef:24/big, ReleaseCause:8, OptBin/binary>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100355encode_sccp_msgt(?SCCP_MSGT_RLC, Params) ->
356 SrcLocalRef = proplists:get_value(src_local_ref, Params),
357 DstLocalRef = proplists:get_value(dst_local_ref, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100358 <<?SCCP_MSGT_RLC:8, DstLocalRef:24/big, SrcLocalRef:24/big>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100359encode_sccp_msgt(?SCCP_MSGT_DT1, Params) ->
360 DstLocalRef = proplists:get_value(dst_local_ref, Params),
361 SegmReass = proplists:get_value(segm_reass, Params),
Harald Welted9c318f2011-12-10 22:17:11 +0100362 UserData = binarify(proplists:get_value(user_data, Params)),
Harald Weltec0696b02010-12-20 00:09:37 +0100363 UserDataLen = byte_size(UserData),
Harald Welte56ee7a62010-12-20 13:34:32 +0100364 <<?SCCP_MSGT_DT1:8, DstLocalRef:24/big, SegmReass:8, 1:8, UserDataLen:8, UserData/binary>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100365encode_sccp_msgt(?SCCP_MSGT_DT2, Params) ->
366 DstLocalRef = proplists:get_value(dst_local_ref, Params),
367 SeqSegm = proplists:get_value(seq_segm, Params),
Harald Welted9c318f2011-12-10 22:17:11 +0100368 UserData = binarify(proplists:get_value(user_data, Params)),
Harald Weltec0696b02010-12-20 00:09:37 +0100369 UserDataLen = byte_size(UserData),
Harald Welte56ee7a62010-12-20 13:34:32 +0100370 <<?SCCP_MSGT_DT2:8, DstLocalRef:24/big, SeqSegm:16, 1:8, UserDataLen:8, UserData/binary>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100371encode_sccp_msgt(?SCCP_MSGT_AK, Params) ->
372 DstLocalRef = proplists:get_value(dst_local_ref, Params),
373 RxSeqnr = proplists:get_value(rx_seqnr, Params),
374 Credit = proplists:get_value(credit, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100375 <<?SCCP_MSGT_AK:8, DstLocalRef:24/big, RxSeqnr:8, Credit:8>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100376encode_sccp_msgt(?SCCP_MSGT_UDT, Params) ->
Harald Welte11565772011-04-15 10:37:57 +0200377 {ProtoClass, PCOpt} = proplists:get_value(protocol_class, Params),
Harald Weltec0696b02010-12-20 00:09:37 +0100378 CalledParty = proplists:get_value(called_party_addr, Params),
Harald Welte234c9562011-02-03 13:51:12 +0100379 CalledPartyEnc = encode_sccp_addr(CalledParty),
380 CalledPartyLen = byte_size(CalledPartyEnc),
Harald Weltec0696b02010-12-20 00:09:37 +0100381 CallingParty = proplists:get_value(calling_party_addr, Params),
Harald Welte234c9562011-02-03 13:51:12 +0100382 CallingPartyEnc = encode_sccp_addr(CallingParty),
383 CallingPartyLen = byte_size(CallingPartyEnc),
Harald Welted9c318f2011-12-10 22:17:11 +0100384 UserData = binarify(proplists:get_value(user_data, Params)),
Harald Weltec0696b02010-12-20 00:09:37 +0100385 UserDataLen = byte_size(UserData),
386 % variable part
387 CalledPartyPtr = 3,
388 CallingPartyPtr = 2 + (1 + CalledPartyLen),
389 DataPtr = 1 + (1 + CalledPartyLen) + (1 + CallingPartyLen),
Harald Welte234c9562011-02-03 13:51:12 +0100390 Remain = <<CalledPartyLen:8, CalledPartyEnc/binary,
391 CallingPartyLen:8, CallingPartyEnc/binary,
Harald Weltec0696b02010-12-20 00:09:37 +0100392 UserDataLen:8, UserData/binary>>,
Harald Welte11565772011-04-15 10:37:57 +0200393 <<?SCCP_MSGT_UDT:8, PCOpt:4, ProtoClass:4, CalledPartyPtr:8, CallingPartyPtr:8, DataPtr:8, Remain/binary>>;
Harald Welte030f1092011-03-11 19:08:07 +0100394encode_sccp_msgt(?SCCP_MSGT_UDTS, Params) ->
395 ReturnCause = proplists:get_value(return_cause, Params),
396 CalledParty = proplists:get_value(called_party_addr, Params),
397 CalledPartyEnc = encode_sccp_addr(CalledParty),
398 CalledPartyLen = byte_size(CalledPartyEnc),
399 CallingParty = proplists:get_value(calling_party_addr, Params),
400 CallingPartyEnc = encode_sccp_addr(CallingParty),
401 CallingPartyLen = byte_size(CallingPartyEnc),
Harald Welted9c318f2011-12-10 22:17:11 +0100402 UserData = binarify(proplists:get_value(user_data, Params)),
Harald Welte030f1092011-03-11 19:08:07 +0100403 UserDataLen = byte_size(UserData),
404 % variable part
405 CalledPartyPtr = 3,
406 CallingPartyPtr = 2 + (1 + CalledPartyLen),
407 DataPtr = 1 + (1 + CalledPartyLen) + (1 + CallingPartyLen),
408 Remain = <<CalledPartyLen:8, CalledPartyEnc/binary,
409 CallingPartyLen:8, CallingPartyEnc/binary,
410 UserDataLen:8, UserData/binary>>,
411 <<?SCCP_MSGT_UDTS:8, ReturnCause:8, CalledPartyPtr:8, CallingPartyPtr:8, DataPtr:8, Remain/binary>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100412encode_sccp_msgt(?SCCP_MSGT_ED, Params) ->
413 DstLocalRef = proplists:get_value(dst_local_ref, Params),
Harald Welted9c318f2011-12-10 22:17:11 +0100414 UserData = binarify(proplists:get_value(user_data, Params)),
Harald Weltec0696b02010-12-20 00:09:37 +0100415 UserDataLen = byte_size(UserData),
416 DataPtr = 1,
Harald Welte56ee7a62010-12-20 13:34:32 +0100417 <<?SCCP_MSGT_ED:8, DstLocalRef:24/big, DataPtr:8, UserDataLen:8, UserData/binary>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100418encode_sccp_msgt(?SCCP_MSGT_EA, Params) ->
419 DstLocalRef = proplists:get_value(dst_local_ref, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100420 <<?SCCP_MSGT_EA:8, DstLocalRef:24/big>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100421encode_sccp_msgt(?SCCP_MSGT_RSR, Params) ->
422 DstLocalRef = proplists:get_value(dst_local_ref, Params),
423 SrcLocalRef = proplists:get_value(src_local_ref, Params),
424 ResetCause = proplists:get_value(reset_cause, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100425 <<?SCCP_MSGT_RSR:8, DstLocalRef:24/big, SrcLocalRef:24/big, ResetCause:8>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100426encode_sccp_msgt(?SCCP_MSGT_RSC, Params) ->
427 DstLocalRef = proplists:get_value(dst_local_ref, Params),
428 SrcLocalRef = proplists:get_value(src_local_ref, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100429 <<?SCCP_MSGT_RSC:8, DstLocalRef:24/big, SrcLocalRef:24/big>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100430encode_sccp_msgt(?SCCP_MSGT_ERR, Params) ->
431 DstLocalRef = proplists:get_value(dst_local_ref, Params),
432 ErrCause = proplists:get_value(error_cause, Params),
Harald Welte56ee7a62010-12-20 13:34:32 +0100433 <<?SCCP_MSGT_ERR:8, DstLocalRef:24/big, ErrCause:8>>;
Harald Weltec0696b02010-12-20 00:09:37 +0100434encode_sccp_msgt(?SCCP_MSGT_IT, Params) ->
435 DstLocalRef = proplists:get_value(dst_local_ref, Params),
436 SrcLocalRef = proplists:get_value(src_local_ref, Params),
Harald Welte11565772011-04-15 10:37:57 +0200437 {ProtoClass, PCOpt} = proplists:get_value(protocol_class, Params),
Harald Welte09b43992010-12-20 12:21:03 +0100438 SegmSeq = proplists:get_value(seq_segm, Params),
Harald Weltec0696b02010-12-20 00:09:37 +0100439 Credit = proplists:get_value(credit, Params),
Harald Welte11565772011-04-15 10:37:57 +0200440 <<?SCCP_MSGT_IT:8, DstLocalRef:24/big, SrcLocalRef:24/big, PCOpt:4, ProtoClass:4, SegmSeq:16, Credit:8>>.
Harald Weltec0696b02010-12-20 00:09:37 +0100441% FIXME: XUDT/XUDTS, LUDT/LUDTS
442
Harald Welte033cef02010-12-19 22:47:14 +0100443
444% encode one sccp message data structure into the on-wire format
445encode_sccp_msg(#sccp_msg{msg_type = MsgType, parameters = Params}) ->
446 encode_sccp_msgt(MsgType, Params).
Harald Welte9abbbad2011-04-21 12:19:41 +0200447
448% is the supplied message type a connectionless message?
449is_connectionless(#sccp_msg{msg_type = MsgType}) ->
450 is_connectionless(MsgType);
451is_connectionless(MsgType) ->
452 case MsgType of
453 ?SCCP_MSGT_UDT -> true;
454 ?SCCP_MSGT_UDTS -> true;
455 ?SCCP_MSGT_XUDT -> true;
456 ?SCCP_MSGT_XUDTS -> true;
457 ?SCCP_MSGT_LUDT -> true;
458 ?SCCP_MSGT_LUDTS -> true;
459 _ -> false
460 end.
Harald Welte9baab6d2011-12-08 00:46:00 +0100461
462
463gen_gt_helper(Number) when is_list(Number) ->
464 #global_title{gti=?SCCP_GTI_NAT_ONLY,
465 nature_of_addr_ind=?SCCP_NAI_INTERNATIONAL,
466 phone_number = Number}.
467
468gen_addr_helper(Gt, Pc, Ssn) when is_record(Gt, global_title) ->
469 #sccp_addr{point_code=Pc, ssn=Ssn, global_title=Gt};
470gen_addr_helper(Number, Pc, Ssn) when is_list(Number) ->
471 Gt = gen_gt_helper(Number),
472 gen_addr_helper(Gt, Pc, Ssn).
473
474
475gen_addr_helper(Gt, Pc) when is_record(Gt, global_title) ->
476 #sccp_addr{point_code=Pc, global_title=Gt};
477gen_addr_helper(Number, Pc) when is_list(Number) ->
478 Gt = gen_gt_helper(Number),
479 gen_addr_helper(Gt, Pc).