1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.telephony;
18 
19 import android.annotation.SystemApi;
20 
21 /**
22  * Contains precise disconnect call causes generated by the framework and the RIL.
23  * @hide
24  */
25 @SystemApi
26 public final class PreciseDisconnectCause {
27 
28     /** The disconnect cause is not valid (Not received a disconnect cause).*/
29     public static final int NOT_VALID                                        = -1;
30     /** No disconnect cause provided. Generally a local disconnect or an incoming missed call. */
31     public static final int NO_DISCONNECT_CAUSE_AVAILABLE                    = 0;
32     /**
33      * The destination cannot be reached because the number, although valid,
34      * is not currently assigned.
35      */
36     public static final int UNOBTAINABLE_NUMBER                              = 1;
37     /**
38      * The user cannot be reached because the network through which the call has been routed does
39      * not serve the destination desired.
40      */
41     public static final int NO_ROUTE_TO_DESTINATION                          = 3;
42     /**
43      * The channel most recently identified is not acceptable to the sending entity for use in this
44      * call.
45      */
46     public static final int CHANNEL_UNACCEPTABLE                             = 6;
47     /**
48      * The mobile station (MS) has tried to access a service that the MS's network operator or
49      * service provider is not prepared to allow.
50      */
51     public static final int OPERATOR_DETERMINED_BARRING                      = 8;
52     /** One of the users involved in the call has requested that the call is cleared. */
53     public static final int NORMAL                                           = 16;
54     /** The called user is unable to accept another call. */
55     public static final int BUSY                                             = 17;
56     /**
57      * The user does not respond to a call establishment message with either an alerting or connect
58      * indication within the prescribed period of time allocated.
59      */
60     public static final int NO_USER_RESPONDING                               = 18;
61     /**
62      * The user has provided an alerting indication but has not provided a connect indication
63      * within a prescribed period of time.
64      */
65     public static final int NO_ANSWER_FROM_USER                              = 19;
66     /** The equipment sending this cause does not wish to accept this call. */
67     public static final int CALL_REJECTED                                    = 21;
68     /** The called number is no longer assigned. */
69     public static final int NUMBER_CHANGED                                   = 22;
70     /**
71      * This cause is returned to the network when a mobile station clears an active call which is
72      * being pre-empted by another call with higher precedence.
73      */
74     public static final int PREEMPTION                                       = 25;
75     /**
76      * The destination indicated by the mobile station cannot be reached because the interface to
77      * the destination is not functioning correctly.
78      */
79     public static final int DESTINATION_OUT_OF_ORDER                         = 27;
80     /** The called party number is not a valid format or is not complete. */
81     public static final int INVALID_NUMBER_FORMAT                            = 28;
82     /** The facility requested by user can not be provided by the network. */
83     public static final int FACILITY_REJECTED                                = 29;
84     /** Provided in response to a STATUS ENQUIRY message. */
85     public static final int STATUS_ENQUIRY                                   = 30;
86     /** Reports a normal disconnect only when no other normal cause applies. */
87     public static final int NORMAL_UNSPECIFIED                               = 31;
88     /** There is no channel presently available to handle the call. */
89     public static final int NO_CIRCUIT_AVAIL                                 = 34;
90     /**
91      * The network is not functioning correctly and that the condition is likely to last a
92      * relatively long period of time.
93      */
94     public static final int NETWORK_OUT_OF_ORDER                             = 38;
95     /**
96      * The network is not functioning correctly and the condition is not likely to last a long
97      * period of time.
98      */
99     public static final int TEMPORARY_FAILURE                                = 41;
100     /** The switching equipment is experiencing a period of high traffic. */
101     public static final int SWITCHING_CONGESTION                             = 42;
102     /** The network could not deliver access information to the remote user as requested. */
103     public static final int ACCESS_INFORMATION_DISCARDED                     = 43;
104     /** The channel cannot be provided. */
105     public static final int CHANNEL_NOT_AVAIL                                = 44;
106     /**
107      * This cause is used to report a resource unavailable event only when no other cause in the
108      * resource unavailable class applies.
109      */
110     public static final int RESOURCES_UNAVAILABLE_OR_UNSPECIFIED             = 47;
111     /** The requested quality of service (ITU-T X.213) cannot be provided. */
112     public static final int QOS_NOT_AVAIL                                    = 49;
113     /**
114      * The facility could not be provided by the network because the user has no complete
115      * subscription.
116      */
117     public static final int REQUESTED_FACILITY_NOT_SUBSCRIBED                = 50;
118     /** Incoming calls are not allowed within this calling user group (CUG). */
119     public static final int INCOMING_CALLS_BARRED_WITHIN_CUG                 = 55;
120     /** The mobile station is not authorized to use bearer capability requested. */
121     public static final int BEARER_CAPABILITY_NOT_AUTHORIZED                 = 57;
122     /** The requested bearer capability is not available at this time. */
123     public static final int BEARER_NOT_AVAIL                                 = 58;
124     /** The service option is not availble at this time. */
125     public static final int SERVICE_OPTION_NOT_AVAILABLE                     = 63;
126     /** The equipment sending this cause does not support the bearer capability requested. */
127     public static final int BEARER_SERVICE_NOT_IMPLEMENTED                   = 65;
128     /** The call clearing is due to ACM being greater than or equal to ACMmax. */
129     public static final int ACM_LIMIT_EXCEEDED                               = 68;
130     /** The equipment sending this cause does not support the requested facility. */
131     public static final int REQUESTED_FACILITY_NOT_IMPLEMENTED               = 69;
132     /**
133      * The equipment sending this cause only supports the restricted version of the requested bearer
134      * capability.
135      */
136     public static final int ONLY_DIGITAL_INFORMATION_BEARER_AVAILABLE        = 70;
137     /** The service requested is not implemented at network. */
138     public static final int SERVICE_OR_OPTION_NOT_IMPLEMENTED                = 79;
139     /**
140      * The equipment sending this cause has received a message with a transaction identifier
141      * which is not currently in use on the mobile station network interface.
142      */
143     public static final int INVALID_TRANSACTION_IDENTIFIER                   = 81;
144     /**
145      * The called user for the incoming CUG call is not a member of the specified calling user
146      * group (CUG).
147      */
148     public static final int USER_NOT_MEMBER_OF_CUG                           = 87;
149     /** The equipment sending this cause has received a request which can't be accomodated. */
150     public static final int INCOMPATIBLE_DESTINATION                         = 88;
151     /** This cause is used to report receipt of a message with semantically incorrect contents. */
152     public static final int SEMANTICALLY_INCORRECT_MESSAGE                   = 95;
153     /**
154      * The equipment sending this cause has received a message with a non-semantical mandatory
155      * information element (IE) error.
156      */
157     public static final int INVALID_MANDATORY_INFORMATION                    = 96;
158     /**
159      * This is sent in response to a message which is not defined, or defined but not implemented
160      * by the equipment sending this cause.
161      */
162     public static final int MESSAGE_TYPE_NON_IMPLEMENTED                     = 97;
163     /**
164      * The equipment sending this cause has received a message not compatible with the protocol
165      * state.
166      */
167     public static final int MESSAGE_TYPE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE  = 98;
168     /**
169      * The equipment sending this cause has received a message which includes information
170      * elements not recognized because its identifier is not defined or it is defined but not
171      * implemented by the equipment sending the cause.
172      */
173     public static final int INFORMATION_ELEMENT_NON_EXISTENT                 = 99;
174     /** The equipment sending this cause has received a message with conditional IE errors. */
175     public static final int CONDITIONAL_IE_ERROR                             = 100;
176     /** The message has been received which is incompatible with the protocol state. */
177     public static final int MESSAGE_NOT_COMPATIBLE_WITH_PROTOCOL_STATE       = 101;
178     /**
179      * The procedure has been initiated by the expiry of a timer in association with
180      * 3GPP TS 24.008 error handling procedures.
181      */
182     public static final int RECOVERY_ON_TIMER_EXPIRED                        = 102;
183     /**
184      * This protocol error event is reported only when no other cause in the protocol error class
185      * applies.
186      */
187     public static final int PROTOCOL_ERROR_UNSPECIFIED                       = 111;
188     /**
189      * Interworking with a network which does not provide causes for actions it takes thus, the
190      * precise cause for a message which is being sent cannot be ascertained.
191      */
192     public static final int INTERWORKING_UNSPECIFIED                         = 127;
193     /** The call is restricted. */
194     public static final int CALL_BARRED                                      = 240;
195     /** The call is blocked by the Fixed Dialing Number list. */
196     public static final int FDN_BLOCKED                                      = 241;
197     /** The given IMSI is not known at the Visitor Location Register (VLR) TS 24.008 cause . */
198     public static final int IMSI_UNKNOWN_IN_VLR                              = 242;
199     /**
200      * The network does not accept emergency call establishment using an IMEI or not accept attach
201      * procedure for emergency services using an IMEI.
202      */
203     public static final int IMEI_NOT_ACCEPTED                                = 243;
204     /** The call cannot be established because RADIO is OFF. */
205     public static final int RADIO_OFF                                        = 247;
206     /** The call cannot be established because of no cell coverage. */
207     public static final int OUT_OF_SRV                                       = 248;
208     /** The call cannot be established because of no valid SIM. */
209     public static final int NO_VALID_SIM                                     = 249;
210     /** The call is dropped or failed internally by modem. */
211     public static final int RADIO_INTERNAL_ERROR                             = 250;
212     /** Call failed because of UE timer expired while waiting for a response from network. */
213     public static final int NETWORK_RESP_TIMEOUT                             = 251;
214     /** Call failed because of a network reject. */
215     public static final int NETWORK_REJECT                                   = 252;
216     /** Call failed because of radio access failure. ex. RACH failure. */
217     public static final int RADIO_ACCESS_FAILURE                             = 253;
218     /** Call failed/dropped because of a Radio Link Failure (RLF). */
219     public static final int RADIO_LINK_FAILURE                               = 254;
220     /** Call failed/dropped because of radio link lost. */
221     public static final int RADIO_LINK_LOST                                  = 255;
222     /** Call failed because of a radio uplink issue. */
223     public static final int RADIO_UPLINK_FAILURE                             = 256;
224     /** Call failed because of a RRC (Radio Resource Control) connection setup failure. */
225     public static final int RADIO_SETUP_FAILURE                              = 257;
226     /** Call failed/dropped because of RRC (Radio Resource Control) connection release from NW. */
227     public static final int RADIO_RELEASE_NORMAL                             = 258;
228     /**
229      * Call failed/dropped because of RRC (Radio Resource Control) abnormally released by
230      * modem/network.
231      */
232     public static final int RADIO_RELEASE_ABNORMAL                           = 259;
233     /** Call setup failed because of access class barring. */
234     public static final int ACCESS_CLASS_BLOCKED                             = 260;
235     /** Call failed/dropped because of a network detach. */
236     public static final int NETWORK_DETACH                                   = 261;
237 
238     /** Mobile station (MS) is locked until next power cycle. */
239     public static final int CDMA_LOCKED_UNTIL_POWER_CYCLE                    = 1000;
240     /** Drop call. */
241     public static final int CDMA_DROP                                        = 1001;
242     /** INTERCEPT order received, Mobile station (MS) state idle entered. */
243     public static final int CDMA_INTERCEPT                                   = 1002;
244     /** Mobile station (MS) has been redirected, call is cancelled. */
245     public static final int CDMA_REORDER                                     = 1003;
246     /** Service option rejection. */
247     public static final int CDMA_SO_REJECT                                   = 1004;
248     /** Requested service is rejected, retry delay is set. */
249     public static final int CDMA_RETRY_ORDER                                 = 1005;
250     /** Unable to obtain access to the CDMA system. */
251     public static final int CDMA_ACCESS_FAILURE                              = 1006;
252     /** Not a preempted call. */
253     public static final int CDMA_PREEMPTED                                   = 1007;
254     /** Not an emergency call. */
255     public static final int CDMA_NOT_EMERGENCY                               = 1008;
256     /** Access Blocked by CDMA network. */
257     public static final int CDMA_ACCESS_BLOCKED                              = 1009;
258 
259     /* OEM specific error codes. To be used by OEMs when they don't want to
260        reveal error code which would be replaced by ERROR_UNSPECIFIED */
261     public static final int OEM_CAUSE_1                                      = 0xf001;
262     public static final int OEM_CAUSE_2                                      = 0xf002;
263     public static final int OEM_CAUSE_3                                      = 0xf003;
264     public static final int OEM_CAUSE_4                                      = 0xf004;
265     public static final int OEM_CAUSE_5                                      = 0xf005;
266     public static final int OEM_CAUSE_6                                      = 0xf006;
267     public static final int OEM_CAUSE_7                                      = 0xf007;
268     public static final int OEM_CAUSE_8                                      = 0xf008;
269     public static final int OEM_CAUSE_9                                      = 0xf009;
270     public static final int OEM_CAUSE_10                                     = 0xf00a;
271     public static final int OEM_CAUSE_11                                     = 0xf00b;
272     public static final int OEM_CAUSE_12                                     = 0xf00c;
273     public static final int OEM_CAUSE_13                                     = 0xf00d;
274     public static final int OEM_CAUSE_14                                     = 0xf00e;
275     public static final int OEM_CAUSE_15                                     = 0xf00f;
276 
277     /** Disconnected due to unspecified reasons. */
278     public static final int ERROR_UNSPECIFIED                                = 0xffff;
279 
280     /** Private constructor to avoid class instantiation. */
PreciseDisconnectCause()281     private PreciseDisconnectCause() {
282         // Do nothing.
283     }
284 }
285