| // Copyright (c) 2013 The Chromium OS Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef SHILL_CELLULAR_CAPABILITY_UNIVERSAL_H_ |
| #define SHILL_CELLULAR_CAPABILITY_UNIVERSAL_H_ |
| |
| #include <deque> |
| #include <map> |
| #include <string> |
| #include <vector> |
| |
| #include <base/memory/scoped_ptr.h> |
| #include <base/memory/weak_ptr.h> |
| #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| #include <ModemManager/ModemManager.h> |
| |
| #include "shill/accessor_interface.h" |
| #include "shill/cellular.h" |
| #include "shill/cellular_capability.h" |
| #include "shill/mm1_bearer_proxy_interface.h" |
| #include "shill/mm1_modem_modem3gpp_proxy_interface.h" |
| #include "shill/mm1_modem_proxy_interface.h" |
| #include "shill/mm1_modem_simple_proxy_interface.h" |
| #include "shill/mm1_sim_proxy_interface.h" |
| |
| |
| struct mobile_provider; |
| |
| namespace shill { |
| |
| class ModemInfo; |
| |
| // CellularCapabilityUniversal handles modems using the |
| // org.chromium.ModemManager1 DBUS interface. This class is used for |
| // all types of modems, i.e. CDMA, GSM, and LTE modems. |
| class CellularCapabilityUniversal : public CellularCapability { |
| public: |
| typedef std::vector<DBusPropertiesMap> ScanResults; |
| typedef DBusPropertiesMap ScanResult; |
| typedef std::map< uint32_t, uint32_t > LockRetryData; |
| |
| // Constants used in connect method call. Make available to test matchers. |
| // TODO(jglasgow): Generate from modem manager into |
| // ModemManager-names.h. |
| // See http://crosbug.com/30551. |
| static const char kConnectPin[]; |
| static const char kConnectOperatorId[]; |
| static const char kConnectBands[]; |
| static const char kConnectAllowedModes[]; |
| static const char kConnectPreferredMode[]; |
| static const char kConnectApn[]; |
| static const char kConnectIPType[]; |
| static const char kConnectUser[]; |
| static const char kConnectPassword[]; |
| static const char kConnectNumber[]; |
| static const char kConnectAllowRoaming[]; |
| static const char kConnectRMProtocol[]; |
| |
| CellularCapabilityUniversal(Cellular *cellular, |
| ProxyFactory *proxy_factory, |
| ModemInfo *modem_info); |
| |
| // Inherited from CellularCapability. |
| // Checks the modem state. If the state is kModemStateDisabled, then the |
| // modem is enabled. Otherwise, the enable command is buffered until the |
| // modem becomes disabled. ModemManager rejects the enable command if the |
| // modem is not disabled, for exmaple, if it is initializing insted. |
| virtual void StartModem(Error *error, const ResultCallback &callback); |
| virtual void StopModem(Error *error, const ResultCallback &callback); |
| virtual void Connect(const DBusPropertiesMap &properties, Error *error, |
| const ResultCallback &callback); |
| virtual void Disconnect(Error *error, const ResultCallback &callback); |
| virtual void DisconnectCleanup(); |
| virtual void Activate(const std::string &carrier, |
| Error *error, const ResultCallback &callback); |
| virtual void CompleteActivation(Error *error); |
| |
| virtual void OnServiceCreated(); |
| virtual void SetupConnectProperties(DBusPropertiesMap *properties); |
| virtual void GetProperties(); |
| virtual bool IsRegistered(); |
| virtual bool IsServiceActivationRequired() const; |
| virtual void Register(const ResultCallback &callback); |
| |
| virtual void RegisterOnNetwork(const std::string &network_id, |
| Error *error, |
| const ResultCallback &callback); |
| virtual void SetUnregistered(bool searching); |
| virtual std::string CreateFriendlyServiceName(); |
| virtual void RequirePIN(const std::string &pin, bool require, |
| Error *error, const ResultCallback &callback); |
| virtual void EnterPIN(const std::string &pin, |
| Error *error, const ResultCallback &callback); |
| virtual void UnblockPIN(const std::string &unblock_code, |
| const std::string &pin, |
| Error *error, const ResultCallback &callback); |
| virtual void ChangePIN(const std::string &old_pin, |
| const std::string &new_pin, |
| Error *error, const ResultCallback &callback); |
| virtual void Reset(Error *error, const ResultCallback &callback); |
| |
| virtual void Scan(Error *error, const ResultCallback &callback); |
| virtual std::string GetNetworkTechnologyString() const; |
| virtual std::string GetRoamingStateString() const; |
| virtual void GetSignalQuality(); |
| virtual std::string GetTypeString() const; |
| virtual void OnDBusPropertiesChanged( |
| const std::string &interface, |
| const DBusPropertiesMap &changed_properties, |
| const std::vector<std::string> &invalidated_properties); |
| virtual bool AllowRoaming(); |
| virtual bool ShouldDetectOutOfCredit() const; |
| |
| protected: |
| virtual void InitProxies(); |
| virtual void ReleaseProxies(); |
| |
| // Updates the |sim_path_| variable and creates a new proxy to the |
| // DBUS ModemManager1.Sim interface. |
| // TODO(armansito): Put this method in a 3GPP-only subclass. |
| virtual void OnSimPathChanged(const std::string &sim_path); |
| |
| // Updates the online payment portal information, if any, for the cellular |
| // provider. |
| virtual void UpdateOLP(); |
| |
| const std::string &mdn() const { return mdn_; }; |
| |
| const std::string &meid() const { return meid_; } |
| void set_meid(const std::string &meid) { meid_ = meid; } |
| |
| const std::string &esn() const { return esn_; } |
| void set_esn(const std::string &esn) { esn_ = esn; } |
| |
| private: |
| // Constants used in scan results. Make available to unit tests. |
| // TODO(jglasgow): Generate from modem manager into ModemManager-names.h. |
| // See http://crosbug.com/30551. |
| static const char kStatusProperty[]; |
| static const char kOperatorLongProperty[]; |
| static const char kOperatorShortProperty[]; |
| static const char kOperatorCodeProperty[]; |
| static const char kOperatorAccessTechnologyProperty[]; |
| |
| // Modem Model ID strings. From modem firmware via modemmanager. |
| static const char kE362ModelId[]; |
| |
| // Generic service name prefix, shown when the correct carrier name is |
| // unknown. |
| static const char kGenericServiceNamePrefix[]; |
| |
| static const int64 kActivationRegistrationTimeoutMilliseconds; |
| static const int64 kDefaultScanningOrSearchingTimeoutMilliseconds; |
| static const int kSetPowerStateTimeoutMilliseconds; |
| |
| |
| // Root path. The SIM path is reported by ModemManager to be the root path |
| // when no SIM is present. |
| static const char kRootPath[]; |
| |
| friend class CellularTest; |
| friend class CellularCapabilityTest; |
| friend class CellularCapabilityUniversalTest; |
| friend class CellularCapabilityUniversalCDMATest; |
| FRIEND_TEST(CellularCapabilityUniversalCDMATest, PropertiesChanged); |
| FRIEND_TEST(CellularCapabilityUniversalCDMATest, UpdateOLP); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, AllowRoaming); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| ActivationWaitForRegisterTimeout); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, Connect); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, ConnectApns); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, CreateFriendlyServiceName); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, DisconnectNoProxy); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| GetNetworkTechnologyStringOnE362); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, GetTypeString); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, IsMdnValid); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, IsServiceActivationRequired); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, IsValidSimPath); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, NormalizeMdn); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, OnListBearersReply); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| OnModemCurrentCapabilitiesChanged); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, PropertiesChanged); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, Reset); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, Scan); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, ScanFailure); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, SetHomeProvider); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| ShouldDetectOutOfCredit); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, SimLockStatusChanged); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, SimPathChanged); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, SimPropertiesChanged); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, StartModem); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, StopModem); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, StopModemConnected); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateIccidActivationState); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| UpdateServiceActivationState); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateServiceName); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateStorageIdentifier); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateOLP); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateOperatorInfo); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, |
| UpdateOperatorInfoViaOperatorId); |
| FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateScanningProperty); |
| FRIEND_TEST(CellularCapabilityUniversalTimerTest, CompleteActivation); |
| FRIEND_TEST(CellularCapabilityUniversalTimerTest, |
| UpdateScanningPropertyTimeout); |
| FRIEND_TEST(CellularTest, EnableTrafficMonitor); |
| FRIEND_TEST(CellularTest, |
| HandleNewRegistrationStateForServiceRequiringActivation); |
| FRIEND_TEST(CellularTest, ModemStateChangeLostRegistration); |
| |
| // Methods used in starting a modem |
| void EnableModem(Error *error, const ResultCallback &callback); |
| void Start_ModemAlreadyEnabled(const ResultCallback &callback); |
| void Start_EnableModemCompleted(const ResultCallback &callback, |
| const Error &error); |
| |
| // Methods used in stopping a modem |
| void Stop_DisconnectCompleted(const ResultCallback &callback, |
| const Error &error); |
| void Stop_Disable(const ResultCallback &callback); |
| void Stop_DisableCompleted(const ResultCallback &callback, |
| const Error &error); |
| void Stop_PowerDown(const ResultCallback &callback); |
| void Stop_PowerDownCompleted(const ResultCallback &callback, |
| const Error &error); |
| |
| // Updates the name property that is exposed by the service to Chrome. |
| void UpdateServiceName(); |
| |
| void UpdateScanningProperty(); |
| |
| // Methods used in acquiring information related to the carrier; |
| |
| // Updates the Universal operator name and country based on a newly |
| // obtained network id. |
| void UpdateOperatorInfo(); |
| |
| // Sets the upper level information about the home cellular provider from the |
| // modem's IMSI and SPN. |
| void SetHomeProvider(); |
| |
| // Updates the serving operator on the active service. |
| void UpdateServingOperator(); |
| |
| // Initializes the |apn_list_| property based on the current |home_provider_|. |
| void InitAPNList(); |
| |
| // Updates |bearer_path_| to match the currently active bearer. |
| void UpdateBearerPath(); |
| |
| // Updates the storage identifier used for the current cellular service. |
| void UpdateStorageIdentifier(); |
| |
| |
| Stringmap ParseScanResult(const ScanResult &result); |
| |
| KeyValueStore SimLockStatusToProperty(Error *error); |
| |
| void SetupApnTryList(); |
| void FillConnectPropertyMap(DBusPropertiesMap *properties); |
| |
| void HelpRegisterConstDerivedKeyValueStore( |
| const std::string &name, |
| KeyValueStore(CellularCapabilityUniversal::*get)(Error *error)); |
| |
| // Returns true if a connect error should be retried. This function |
| // abstracts modem specific behavior for modems which do a lousy job |
| // of returning specific errors on connect failures. |
| bool RetriableConnectError(const Error &error) const; |
| |
| // Signal callbacks |
| void OnNetworkModeSignal(uint32 mode); |
| void OnModemStateChangedSignal(int32 old_state, |
| int32 new_state, |
| uint32 reason); |
| |
| // Property Change notification handlers |
| void OnModemPropertiesChanged( |
| const DBusPropertiesMap &properties, |
| const std::vector<std::string> &invalidated_properties); |
| |
| void OnSignalQualityChanged(uint32 quality); |
| |
| void OnModemCapabilitesChanged(uint32 capabilities); |
| void OnModemCurrentCapabilitiesChanged(uint32 current_capabilities); |
| void OnMdnChanged(const std::string &mdn); |
| void OnModemManufacturerChanged(const std::string &manufacturer); |
| void OnModemModelChanged(const std::string &model); |
| void OnModemRevisionChanged(const std::string &revision); |
| void OnModemStateChanged(Cellular::ModemState state); |
| void OnAccessTechnologiesChanged(uint32 access_technologies); |
| void OnSupportedModesChanged(uint32 supported_modes); |
| void OnAllowedModesChanged(uint32 allowed_modes); |
| void OnPreferredModeChanged(MMModemMode preferred_mode); |
| void OnLockRetriesChanged(MMModemLock unlock_required, |
| const LockRetryData &lock_retries); |
| void OnSimLockStatusChanged(); |
| |
| // Returns false if the MDN is empty or if the MDN consists of all 0s. |
| bool IsMdnValid() const; |
| |
| // 3GPP property change handlers |
| virtual void OnModem3GPPPropertiesChanged( |
| const DBusPropertiesMap &properties, |
| const std::vector<std::string> &invalidated_properties); |
| void OnImeiChanged(const std::string &imei); |
| void On3GPPRegistrationChanged(MMModem3gppRegistrationState state, |
| const std::string &operator_code, |
| const std::string &operator_name); |
| void OnFacilityLocksChanged(uint32 locks); |
| |
| // SIM property change handlers |
| // TODO(armansito): Put these methods in a 3GPP-only subclass. |
| void OnSimPropertiesChanged( |
| const DBusPropertiesMap &props, |
| const std::vector<std::string> &invalidated_properties); |
| void OnImsiChanged(const std::string &imsi); |
| void OnSpnChanged(const std::string &spn); |
| void OnSimIdentifierChanged(const std::string &id); |
| void OnOperatorIdChanged(const std::string &operator_id); |
| void OnOperatorNameChanged(const std::string &operator_name); |
| |
| // Method callbacks |
| void OnRegisterReply(const ResultCallback &callback, |
| const Error &error); |
| void OnResetReply(const ResultCallback &callback, const Error &error); |
| void OnScanReply(const ResultCallback &callback, |
| const ScanResults &results, |
| const Error &error); |
| void OnConnectReply(const ResultCallback &callback, |
| const DBus::Path &bearer, |
| const Error &error); |
| void OnListBearersReply(const std::vector<DBus::Path> &paths, |
| const Error &error); |
| |
| // Timeout callback for the network scan initiated when Cellular connectivity |
| // gets enabled. |
| void OnScanningOrSearchingTimeout(); |
| |
| // Timeout callback that is called if the modem takes too long to register to |
| // a network after online payment is complete. Resets the modem. |
| void OnActivationWaitForRegisterTimeout(); |
| |
| // Returns true, if |sim_path| constitutes a valid SIM path. Currently, a |
| // path is accepted to be valid, as long as it is not equal to one of "" |
| // and "/". |
| bool IsValidSimPath(const std::string &sim_path) const; |
| |
| // Returns the normalized version of |mdn| by keeping only digits in |mdn| |
| // and removing other non-digit characters. |
| std::string NormalizeMdn(const std::string &mdn) const; |
| |
| static std::string GenerateNewGenericServiceName(); |
| |
| // Post-payment activation handlers. |
| void UpdateIccidActivationState(); |
| void ResetAfterActivation(); |
| void UpdateServiceActivationState(); |
| void OnResetAfterActivationReply(const Error &error); |
| |
| scoped_ptr<mm1::ModemModem3gppProxyInterface> modem_3gpp_proxy_; |
| scoped_ptr<mm1::ModemProxyInterface> modem_proxy_; |
| scoped_ptr<mm1::ModemSimpleProxyInterface> modem_simple_proxy_; |
| scoped_ptr<mm1::SimProxyInterface> sim_proxy_; |
| |
| base::WeakPtrFactory<CellularCapabilityUniversal> weak_ptr_factory_; |
| |
| MMModem3gppRegistrationState registration_state_; |
| |
| // Bits based on MMModemCapabilities |
| uint32 capabilities_; // technologies supported, may require reload |
| uint32 current_capabilities_; // technologies supportsed without a reload |
| uint32 access_technologies_; // Bits based on MMModemAccessTechnology |
| uint32 supported_modes_; // Bits based on MMModemMode |
| uint32 allowed_modes_; // Bits based on MMModemMode |
| MMModemMode preferred_mode_; // A single MMModemMode bit |
| |
| Cellular::Operator serving_operator_; |
| std::string spn_; |
| std::string sim_identifier_; |
| std::string operator_id_; |
| mobile_provider *home_provider_; |
| bool provider_requires_roaming_; |
| std::string desired_network_; |
| |
| // Properties. |
| std::string carrier_; |
| std::string esn_; |
| std::string firmware_revision_; |
| std::string hardware_revision_; |
| std::string imei_; |
| std::string imsi_; |
| std::string manufacturer_; |
| std::string mdn_; |
| std::string meid_; |
| std::string min_; |
| std::string model_id_; |
| std::string selected_network_; |
| Stringmaps found_networks_; |
| std::deque<Stringmap> apn_try_list_; |
| bool resetting_; |
| bool scanning_supported_; |
| bool scanning_; |
| bool scanning_or_searching_; |
| uint16 scan_interval_; |
| SimLockStatus sim_lock_status_; |
| Stringmaps apn_list_; |
| std::string sim_path_; |
| bool sim_present_; |
| DBus::Path bearer_path_; |
| bool reset_done_; |
| |
| // If the modem is not in a state to be enabled when StartModem is called, |
| // enabling is deferred using this callback. |
| base::Closure deferred_enable_modem_callback_; |
| |
| // Sometimes modems may be stuck in the SEARCHING state during the lack of |
| // presence of a network. During this indefinite duration of time, keeping |
| // the Device.Scanning property as |true| causes a bad user experience. |
| // This callback sets it to |false| after a timeout period has passed. |
| base::CancelableClosure scanning_or_searching_timeout_callback_; |
| int64 scanning_or_searching_timeout_milliseconds_; |
| |
| base::CancelableClosure activation_wait_for_registration_callback_; |
| int64 activation_registration_timeout_milliseconds_; |
| |
| static unsigned int friendly_service_name_id_; |
| |
| DISALLOW_COPY_AND_ASSIGN(CellularCapabilityUniversal); |
| }; |
| |
| } // namespace shill |
| |
| #endif // SHILL_CELLULAR_CAPABILITY_UNIVERSAL_H_ |