aaa9dce8efd2057698366486bb393ff23d81d708
[obnox/wireshark/wip.git] / asn1 / camel / CAP-SMS-ops-args.asn
1 -- $Id$
2 -- 3GPP TS 29.078 9.2.0 (2010-06)
3 -- 7    SMS Control
4 -- 7.1  SMS operations and arguments
5 CAP-SMS-ops-args {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-SMS-ops-args(105) version8(7)}
6 -- The module CAP-SMS-ops-args is updated to version8(7) for Rel-6. The OPERATION definitions
7 -- are not modified.
8
9 DEFINITIONS IMPLICIT TAGS::= BEGIN
10
11 -- This module contains the operations and operation arguments used for the
12 -- smsSSF\96 gsmSCF interface, for the control of MO-SMS and MT-SMS.
13
14 -- The table in subclause 2.1 lists the specifications that contain the modules
15 -- that are used by CAP.
16
17 IMPORTS
18
19         errortypes,
20         datatypes,
21         operationcodes,
22         classes,
23         ros-InformationObjects,
24         tc-Messages
25 FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0)
26 umts-network(1) modules(3) cap-object-identifiers(100) version8(7)}
27
28         OPERATION
29 FROM Remote-Operations-Information-Objects ros-InformationObjects
30
31         ServiceKey
32 FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1)
33 modules(0) cs1-datatypes(2) version1(0)}
34
35         MiscCallInfo
36 FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1)
37 cs2(20) modules(0) in-cs2-datatypes (0) version1(0)}
38
39         IMEI,
40         IMSI,
41         ISDN-AddressString
42 FROM MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0)
43 gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)}
44
45         GPRSMSClass,
46         LocationInformation,
47         MS-Classmark2
48 FROM MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0)
49 gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)}
50
51         PARAMETERS-BOUND
52 FROM CAP-classes classes
53
54         opcode-connectSMS,
55         opcode-continueSMS,
56         opcode-eventReportSMS,
57         opcode-furnishChargingInformationSMS,
58         opcode-initialDPSMS,
59         opcode-releaseSMS,
60         opcode-requestReportSMSEvent,
61         opcode-resetTimerSMS
62 FROM CAP-operationcodes operationcodes
63 -- The CAP Operation identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as in Rel-5.
64
65         CalledPartyBCDNumber {},
66         EventSpecificInformationSMS,
67         EventTypeSMS,
68         Extensions {},
69         FCISMSBillingChargingCharacteristics,
70         LocationInformationGPRS,
71         RPCause,
72         SMS-AddressString,
73         SMSEvent,
74         TimeAndTimezone {},
75         TimerID,
76         TimerValue,
77         TPDataCodingScheme,
78         TPProtocolIdentifier,
79         TPShortMessageSpecificInfo,
80         TPValidityPeriod
81 FROM CAP-datatypes datatypes
82 -- For Rel-6, the CAP-datatypes module is updated to version8(7); Object Identifier 'datatypes'
83 -- is also updated to version8(7). As a result, the present module uses Rel-6 data type definitions.
84
85         missingCustomerRecord,
86         missingParameter,
87         parameterOutOfRange,
88         systemFailure,
89         taskRefused,
90         unexpectedComponentSequence,
91         unexpectedDataValue,
92         unexpectedParameter
93 FROM CAP-errortypes errortypes
94 -- For Rel-6, the CAP-errortypes module is updated to version8(7); Object Identifier
95 -- 'errortypes' is also updated to version8(7). As a result, the present module uses Rel-6
96 -- error type definitions.
97
98         CallReferenceNumber
99 FROM MAP-CH-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0)
100 gsm-Network(1) modules(3) map-CH-DataTypes(13) version12(12)}
101
102 ;
103
104 connectSMS {PARAMETERS-BOUND : bound} OPERATION ::= {
105         ARGUMENT                ConnectSMSArg {bound}
106         RETURN RESULT   FALSE
107         ERRORS                  {missingParameter |
108                                         parameterOutOfRange |
109                                         systemFailure |
110                                         taskRefused |
111                                         unexpectedComponentSequence |
112                                         unexpectedDataValue |
113                                         unexpectedParameter}
114         CODE                    opcode-connectSMS}
115 --  Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Tconsms
116 --  This operation is used to request the smsSSF to perform the SMS processing
117 --  actions to route or forward a short message to a specified destination.
118
119 ConnectSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE {
120         callingPartysNumber                                     [0] SMS-AddressString                                           OPTIONAL,
121         destinationSubscriberNumber                     [1] CalledPartyBCDNumber {bound}                        OPTIONAL,
122         sMSCAddress                                                     [2] ISDN-AddressString                                          OPTIONAL,
123         extensions                                                      [10] Extensions {bound}                                         OPTIONAL,
124         ...
125         }
126
127 continueSMS OPERATION ::= {
128         RETURN RESULT   FALSE
129         ALWAYS RESPONDS FALSE
130         CODE                    opcode-continueSMS}
131 -- Direction: gsmSCF -> smsSSF, Timer: Tcuesms 
132 -- This operation is used to request the smsSSF to proceed with
133 -- Short Message processing at the DP at which it previously suspended
134 -- Short Message processing to await gsmSCF instructions (i.e. proceed
135 -- to the next Point in Association in the SMS FSM). The smsSSF
136 -- continues SMS processing without substituting new data from the gsmSCF.
137
138 eventReportSMS {PARAMETERS-BOUND : bound} OPERATION ::= {
139         ARGUMENT                EventReportSMSArg {bound}
140         RETURN RESULT   FALSE
141         ALWAYS RESPONDS FALSE
142         CODE                    opcode-eventReportSMS}
143 --  Direction: gsmSSF or gprsSSF -> gsmSCF, Timer: Terbsms
144 --  This operation is used to notify the gsmSCF of a Short Message related event (FSM events
145 --  such as submission, delivery or failure) previously requested by the gsmSCF in a
146 --  RequestReportSMSEvent operation.
147
148 EventReportSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE {
149         eventTypeSMS                                            [0] EventTypeSMS,
150         eventSpecificInformationSMS                     [1] EventSpecificInformationSMS                         OPTIONAL,
151         miscCallInfo                                            [2] MiscCallInfo DEFAULT {messageType request},
152         extensions                                                      [10] Extensions {bound}                                         OPTIONAL,
153         ...
154         }
155
156 furnishChargingInformationSMS {PARAMETERS-BOUND : bound} OPERATION ::= {
157         ARGUMENT                FurnishChargingInformationSMSArg {bound}
158         RETURN RESULT   FALSE
159         ERRORS                  {missingParameter |
160                                         taskRefused |
161                                         unexpectedComponentSequence |
162                                         unexpectedDataValue |
163                                         unexpectedParameter}
164         CODE                    opcode-furnishChargingInformationSMS}
165 --  Direction: gsmSCF ?? gsmSSF or gprsSSF, Timer: Tfcisms 
166 --  This operation is used to request the smsSSF to generate, register a charging record
167 --  or to include some information in the default SM record. The registered charging record is
168 --  intended for off line charging of the Short Message.
169
170 FurnishChargingInformationSMSArg {PARAMETERS-BOUND : bound} ::=
171         FCISMSBillingChargingCharacteristics {bound}
172
173 initialDPSMS {PARAMETERS-BOUND : bound} OPERATION ::= {
174         ARGUMENT                InitialDPSMSArg {bound}
175         RETURN RESULT   FALSE
176         ERRORS                  {missingCustomerRecord |
177                                         missingParameter |
178                                         parameterOutOfRange |
179                                         systemFailure |
180                                         taskRefused |
181                                         unexpectedComponentSequence |
182                                         unexpectedDataValue |
183                                         unexpectedParameter}
184         CODE                    opcode-initialDPSMS}
185 --  Direction: gsmSSF or gprsSSF -> gsmSCF, Timer: Tidpsms
186 --  This operation is used after a TDP to indicate request for service.
187
188 InitialDPSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE {
189         serviceKey                                                      [0] ServiceKey,
190         destinationSubscriberNumber                     [1] CalledPartyBCDNumber {bound}                        OPTIONAL,
191         callingPartyNumber                                      [2] SMS-AddressString                                           OPTIONAL,
192         eventTypeSMS                                            [3] EventTypeSMS                                                        OPTIONAL,
193         iMSI                                                            [4] IMSI                                                                        OPTIONAL,
194         locationInformationMSC                          [5] LocationInformation                                         OPTIONAL,
195         locationInformationGPRS                         [6] LocationInformationGPRS                                     OPTIONAL,
196         sMSCAddress                                                     [7] ISDN-AddressString                                          OPTIONAL,
197         timeAndTimezone                                         [8] TimeAndTimezone {bound}                                     OPTIONAL,
198         tPShortMessageSpecificInfo                      [9] TPShortMessageSpecificInfo                          OPTIONAL,
199         tPProtocolIdentifier                            [10] TPProtocolIdentifier                                       OPTIONAL,
200         tPDataCodingScheme                                      [11] TPDataCodingScheme                                         OPTIONAL,
201         tPValidityPeriod                                        [12] TPValidityPeriod                                           OPTIONAL,
202         extensions                                                      [13] Extensions {bound}                                         OPTIONAL,
203         ...,
204         smsReferenceNumber                                      [14] CallReferenceNumber                                        OPTIONAL,
205         mscAddress                                                      [15] ISDN-AddressString                                         OPTIONAL,
206         sgsn-Number                                                     [16] ISDN-AddressString                                         OPTIONAL,
207         ms-Classmark2                                           [17] MS-Classmark2                                                      OPTIONAL,
208         gPRSMSClass                                             [18] GPRSMSClass                                                        OPTIONAL,
209         iMEI                                                            [19] IMEI                                                                       OPTIONAL,
210         calledPartyNumber                                       [20] ISDN-AddressString                                         OPTIONAL
211         }
212
213 --  The UserCSGInformation is conveyed in the LocationInformation for CS and LocationInformationGPRS
214 --  for GPRS. The encoding of the parameter is as defined in 3GPP TS 29.002 [11].
215
216 releaseSMS OPERATION ::= {
217         ARGUMENT                ReleaseSMSArg
218         RETURN RESULT   FALSE
219         ALWAYS RESPONDS FALSE
220         CODE                    opcode-releaseSMS}
221 --  Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Trelsms
222 --  This operation is used to prevent an attempt to submit or deliver a short message. 
223
224 ReleaseSMSArg ::= RPCause
225
226 requestReportSMSEvent {PARAMETERS-BOUND : bound} OPERATION ::= {
227         ARGUMENT                RequestReportSMSEventArg {bound}
228         RETURN RESULT   FALSE
229         ERRORS                  {missingParameter |
230                                         parameterOutOfRange |
231                                         systemFailure |
232                                         taskRefused |
233                                         unexpectedComponentSequence |
234                                         unexpectedDataValue |
235                                         unexpectedParameter}
236         CODE                    opcode-requestReportSMSEvent}
237 --  Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Trrbsms
238 --  This operation is used to request the gsmSSF or gprsSSF to monitor for a
239 --  Short Message related event (FSM events such as submission, delivery or failure)
240 --  and to send a notification to the gsmSCF when the event is detected.
241
242 RequestReportSMSEventArg {PARAMETERS-BOUND : bound} ::= SEQUENCE {
243         sMSEvents                                                       [0] SEQUENCE SIZE (1..bound.&numOfSMSEvents) OF SMSEvent,
244         extensions                                                      [10] Extensions {bound}                                         OPTIONAL,
245         ...
246         }
247 --  Indicates the Short Message related events(s) for notification.
248
249 resetTimerSMS {PARAMETERS-BOUND : bound} OPERATION ::= {
250         ARGUMENT                ResetTimerSMSArg {bound}
251         RETURN RESULT   FALSE
252         ERRORS                  {missingParameter |
253                                         parameterOutOfRange |
254                                         taskRefused |
255                                         unexpectedComponentSequence |
256                                         unexpectedDataValue |
257                                         unexpectedParameter}
258         CODE                    opcode-resetTimerSMS}
259 -- Direction: gsmSCF -> smsSSF, Timer: Trtsms 
260 -- This operation is used to request the smsSSF to refresh an application
261 -- timer in the smsSSF.
262
263 ResetTimerSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE {
264         timerID                                                         [0] TimerID     DEFAULT tssf,
265         timervalue                                                      [1] TimerValue,
266         extensions                                                      [2] Extensions {bound}                                          OPTIONAL,
267         ...
268         }
269
270 END