CarrierConfigManager.java revision 42ecc9eb902ef90876cd345a906c24e0d58720a3
1/* 2 * Copyright (C) 2015 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 17package android.telephony; 18 19import com.android.internal.telephony.ICarrierConfigLoader; 20 21import android.annotation.NonNull; 22import android.annotation.Nullable; 23import android.annotation.SystemApi; 24import android.content.Context; 25import android.os.PersistableBundle; 26import android.os.RemoteException; 27import android.os.ServiceManager; 28 29/** 30 * Provides access to telephony configuration values that are carrier-specific. 31 * <p> 32 * Users should obtain an instance of this class by calling 33 * {@code mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);} 34 * </p> 35 * 36 * @see Context#getSystemService 37 * @see Context#CARRIER_CONFIG_SERVICE 38 */ 39public class CarrierConfigManager { 40 /** 41 * @hide 42 */ 43 public CarrierConfigManager() { 44 } 45 46 /** 47 * This intent is broadcast by the system when carrier config changes. 48 */ 49 public static final String 50 ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED"; 51 52 /** 53 * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED 54 * events from the Sim. 55 * If true, this will prevent the IccNetworkDepersonalizationPanel from being shown, and 56 * effectively disable the "Sim network lock" feature. 57 */ 58 public static final String 59 BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS = "bool_ignore_sim_network_locked_events"; 60 61 /** 62 * Flag indicating whether the Phone app should provide a "Dismiss" button on the SIM network 63 * unlock screen. The default value is true. If set to false, there will be *no way* to dismiss 64 * the SIM network unlock screen if you don't enter the correct unlock code. (One important 65 * consequence: there will be no way to make an Emergency Call if your SIM is network-locked and 66 * you don't know the PIN.) 67 */ 68 public static final String 69 BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS = "bool_sim_network_unlock_allow_dismiss"; 70 71 /** Flag indicating if the phone is a world phone */ 72 public static final String BOOL_WORLD_PHONE = "bool_world_phone"; 73 74 /** 75 * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity. 76 * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be 77 * consistent with the regular Dialer, this value should agree with the corresponding values 78 * from config.xml under apps/Contacts. 79 */ 80 public static final String 81 BOOL_ENABLE_DIALER_KEY_VIBRATION = "bool_enable_dialer_key_vibration"; 82 83 /** Flag indicating if dtmf tone type is enabled */ 84 public static final String BOOL_DTMF_TYPE_ENABLED = "bool_dtmf_type_enabled"; 85 86 /** Flag indicating if auto retry is enabled */ 87 public static final String BOOL_AUTO_RETRY_ENABLED = "bool_auto_retry_enabled"; 88 89 /** 90 * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle 91 * playing of the tones. 92 */ 93 public static final String BOOL_ALLOW_LOCAL_DTMF_TONES = "bool_allow_local_dtmf_tones"; 94 95 /** 96 * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all 97 * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled 98 * by a flag here (which can be overridden on a per-product basis.) 99 */ 100 public static final String BOOL_SHOW_ONSCREEN_DIAL_BUTTON = "bool_show_onscreen_dial_button"; 101 102 /** Determines if device implements a noise suppression device for in call audio. */ 103 public static final String 104 BOOL_HAS_IN_CALL_NOISE_SUPPRESSION = "bool_has_in_call_noise_suppression"; 105 106 /** 107 * Determines if the current device should allow emergency numbers to be logged in the Call Log. 108 * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of 109 * accidental redialing from the call log UI. This is a good idea, so the default here is 110 * false.) 111 * <p> 112 * TODO: on the other hand, it might still be useful to have some record of the emergency calls 113 * you've made, or to be able to look up the exact date/time of an emergency call. So perhaps we 114 * <b>should</b> log those calls, but instead fix the call log to disable the "call" button for 115 * emergency numbers. 116 */ 117 public static final String 118 BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG = "bool_allow_emergency_numbers_in_call_log"; 119 120 /** If true, removes the Voice Privacy option from Call Settings */ 121 public static final String BOOL_VOICE_PRIVACY_DISABLE = "bool_voice_privacy_disable"; 122 123 /** Control whether users can reach the carrier portions of Cellular Network Settings. */ 124 public static final String 125 BOOL_HIDE_CARRIER_NETWORK_SETTINGS = "bool_hide_carrier_network_settings"; 126 127 /** Control whether users can edit APNs in Settings. */ 128 public static final String BOOL_APN_EXPAND = "bool_apn_expand"; 129 130 /** Control whether users can choose a network operator. */ 131 public static final String BOOL_OPERATOR_SELECTION_EXPAND = "bool_operator_selection_expand"; 132 133 /** Used in Cellular Network Settings for preferred network type. */ 134 public static final String BOOL_PREFER_2G = "bool_prefer_2g"; 135 136 /** Show cdma network mode choices 1x, 3G, global etc. */ 137 public static final String BOOL_SHOW_CDMA_CHOICES = "bool_show_cdma_choices"; 138 139 /** CDMA activation goes through HFA */ 140 public static final String BOOL_USE_HFA_FOR_PROVISIONING = "bool_use_hfa_for_provisioning"; 141 142 /** 143 * CDMA activation goes through OTASP. 144 * <p> 145 * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum 146 * (NONE, HFA, OTASP). 147 */ 148 public static final String BOOL_USE_OTASP_FOR_PROVISIONING = "bool_use_otasp_for_provisioning"; 149 150 /** Display carrier settings menu if true */ 151 public static final String BOOL_CARRIER_SETTINGS_ENABLE = "bool_carrier_settings_enable"; 152 153 /** Does not display additional call seting for IMS phone based on GSM Phone */ 154 public static final String BOOL_ADDITIONAL_CALL_SETTING = "bool_additional_call_setting"; 155 156 /** Show APN Settings for some CDMA carriers */ 157 public static final String BOOL_SHOW_APN_SETTING_CDMA = "bool_show_apn_setting_cdma"; 158 159 /** After a CDMA conference call is merged, the swap button should be displayed. */ 160 public static final String BOOL_SUPPORT_SWAP_AFTER_MERGE = "bool_support_swap_after_merge"; 161 162 /** 163 * Determine whether the voicemail notification is persistent in the notification bar. If true, 164 * the voicemail notifications cannot be dismissed from the notification bar. 165 */ 166 public static final String 167 BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT = "bool_voicemail_notification_persistent"; 168 169 /** For IMS video over LTE calls, determines whether video pause signalling is supported. */ 170 public static final String 171 BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS = "bool_support_pause_ims_video_calls"; 172 173 /** 174 * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is 175 * potentially harmful by locking the SIM to 3G. 176 */ 177 public static final String 178 BOOL_DISABLE_CDMA_ACTIVATION_CODE = "bool_disable_cdma_activation_code"; 179 180 /** 181 * Flag specifying whether VoLTE should be available for carrier, independent of carrier 182 * provisioning. If false: hard disabled. If true: then depends on carrier provisioning, 183 * availability, etc. 184 */ 185 public static final String BOOL_CARRIER_VOLTE_AVAILABLE = "bool_carrier_volte_available"; 186 187 /** Flag specifying whether VoLTE availability is based on provisioning. */ 188 public static final String BOOL_CARRIER_VOLTE_PROVISIONED = "bool_carrier_volte_provisioned"; 189 190 /** Flag specifying whether VoLTE TTY is supported. */ 191 public static final String BOOL_CARRIER_VOLTE_TTY_SUPPORTED 192 = "bool_carrier_volte_tty_supported"; 193 194 /** 195 * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0 196 * this is the value that should be used instead. A configuration value of 197 * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default 198 * assumption for phone type (GSM) should be used. 199 */ 200 public static final String INT_VOLTE_REPLACEMENT_RAT = "int_volte_replacement_rat"; 201 202 /* The following 3 fields are related to carrier visual voicemail. */ 203 204 /** 205 * The carrier number MO sms messages are sent to. 206 * 207 * @hide 208 */ 209 public static final String STRING_VVM_DESTINATION_NUMBER = "string_vvm_destination_number"; 210 211 /** 212 * The port through which the MO sms messages are sent through. 213 * 214 * @hide 215 */ 216 public static final String INT_VVM_PORT_NUMBER = "int_vvm_port_number"; 217 218 /** 219 * The type of visual voicemail protocol the carrier adheres to (see below). 220 * 221 * @hide 222 */ 223 public static final String STRING_VVM_TYPE = "string_vvm_type"; 224 225 private final static String TAG = "CarrierConfigManager"; 226 227 /** The default value for every variable. */ 228 private final static PersistableBundle sDefaults; 229 230 static { 231 sDefaults = new PersistableBundle(); 232 sDefaults.putBoolean(BOOL_ADDITIONAL_CALL_SETTING, true); 233 sDefaults.putBoolean(BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG, false); 234 sDefaults.putBoolean(BOOL_ALLOW_LOCAL_DTMF_TONES, true); 235 sDefaults.putBoolean(BOOL_APN_EXPAND, true); 236 sDefaults.putBoolean(BOOL_AUTO_RETRY_ENABLED, false); 237 sDefaults.putBoolean(BOOL_CARRIER_SETTINGS_ENABLE, false); 238 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_AVAILABLE, false); 239 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_PROVISIONED, false); 240 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_TTY_SUPPORTED, true); 241 sDefaults.putBoolean(BOOL_DISABLE_CDMA_ACTIVATION_CODE, false); 242 sDefaults.putBoolean(BOOL_DTMF_TYPE_ENABLED, false); 243 sDefaults.putBoolean(BOOL_ENABLE_DIALER_KEY_VIBRATION, true); 244 sDefaults.putBoolean(BOOL_HAS_IN_CALL_NOISE_SUPPRESSION, false); 245 sDefaults.putBoolean(BOOL_HIDE_CARRIER_NETWORK_SETTINGS, false); 246 sDefaults.putBoolean(BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS, false); 247 sDefaults.putBoolean(BOOL_OPERATOR_SELECTION_EXPAND, true); 248 sDefaults.putBoolean(BOOL_PREFER_2G, true); 249 sDefaults.putBoolean(BOOL_SHOW_APN_SETTING_CDMA, false); 250 sDefaults.putBoolean(BOOL_SHOW_CDMA_CHOICES, false); 251 sDefaults.putBoolean(BOOL_SHOW_ONSCREEN_DIAL_BUTTON, true); 252 sDefaults.putBoolean(BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS, true); 253 sDefaults.putBoolean(BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS, true); 254 sDefaults.putBoolean(BOOL_SUPPORT_SWAP_AFTER_MERGE, true); 255 sDefaults.putBoolean(BOOL_USE_HFA_FOR_PROVISIONING, false); 256 sDefaults.putBoolean(BOOL_USE_OTASP_FOR_PROVISIONING, false); 257 sDefaults.putBoolean(BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT, false); 258 sDefaults.putBoolean(BOOL_VOICE_PRIVACY_DISABLE, false); 259 sDefaults.putBoolean(BOOL_WORLD_PHONE, false); 260 sDefaults.putInt(INT_VOLTE_REPLACEMENT_RAT, 0); 261 sDefaults.putInt(INT_VVM_PORT_NUMBER, 0); 262 sDefaults.putString(STRING_VVM_DESTINATION_NUMBER, ""); 263 sDefaults.putString(STRING_VVM_TYPE, ""); 264 } 265 266 /** 267 * Gets the configuration values for a particular subscription, which is associated with a 268 * specific SIM card. If an invalid subId is used, the returned config will contain default 269 * values. 270 * 271 * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}. 272 * @return A {@link PersistableBundle} containing the config for the given subId, or default 273 * values for an invalid subId. 274 */ 275 @Nullable 276 public PersistableBundle getConfigForSubId(int subId) { 277 try { 278 return getICarrierConfigLoader().getConfigForSubId(subId); 279 } catch (RemoteException ex) { 280 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 281 + ex.toString()); 282 } catch (NullPointerException ex) { 283 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 284 + ex.toString()); 285 } 286 return null; 287 } 288 289 /** 290 * Gets the configuration values for the default subscription. 291 * 292 * @see #getConfigForSubId 293 */ 294 @Nullable 295 public PersistableBundle getConfig() { 296 return getConfigForSubId(SubscriptionManager.getDefaultSubId()); 297 } 298 299 /** 300 * Calling this method triggers telephony services to fetch the current carrier configuration. 301 * <p> 302 * Normally this does not need to be called because the platform reloads config on its own. Call 303 * this method if your app wants to update config at an arbitrary moment. 304 * </p> 305 * <p> 306 * This method returns before the reload has completed, and 307 * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an 308 * arbitrary thread. 309 * </p> 310 */ 311 public void reloadCarrierConfigForSubId(int subId) { 312 try { 313 getICarrierConfigLoader().reloadCarrierConfigForSubId(subId); 314 } catch (RemoteException ex) { 315 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 316 } catch (NullPointerException ex) { 317 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 318 } 319 } 320 321 /** 322 * Request the carrier config loader to update the cofig for phoneId. 323 * <p> 324 * Depending on simState, the config may be cleared or loaded from config app. This is only used 325 * by SubscriptionInfoUpdater. 326 * </p> 327 * 328 * @hide 329 */ 330 @SystemApi 331 public void updateConfigForPhoneId(int phoneId, String simState) { 332 try { 333 getICarrierConfigLoader().updateConfigForPhoneId(phoneId, simState); 334 } catch (RemoteException ex) { 335 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 336 } catch (NullPointerException ex) { 337 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 338 } 339 } 340 341 /** 342 * Returns a new bundle with the default value for every supported configuration variable. 343 * 344 * @hide 345 */ 346 @NonNull 347 @SystemApi 348 public static PersistableBundle getDefaultConfig() { 349 return new PersistableBundle(sDefaults); 350 } 351 352 /** @hide */ 353 private ICarrierConfigLoader getICarrierConfigLoader() { 354 return ICarrierConfigLoader.Stub 355 .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE)); 356 } 357} 358