Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef SHILL_CELLULAR_CAPABILITY_GSM_ |
| 6 | #define SHILL_CELLULAR_CAPABILITY_GSM_ |
| 7 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 8 | #include <base/memory/scoped_ptr.h> |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 9 | #include <base/memory/weak_ptr.h> |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 10 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 11 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 12 | #include "shill/accessor_interface.h" |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 13 | #include "shill/cellular.h" |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 14 | #include "shill/cellular_capability.h" |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 15 | #include "shill/modem_gsm_card_proxy_interface.h" |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 16 | #include "shill/modem_gsm_network_proxy_interface.h" |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 17 | |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 18 | struct mobile_provider; |
| 19 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 20 | namespace shill { |
| 21 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 22 | class CellularCapabilityGSM : public CellularCapability { |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 23 | public: |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 24 | CellularCapabilityGSM(Cellular *cellular, ProxyFactory *proxy_factory); |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 25 | |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 26 | // Inherited from CellularCapability. |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 27 | virtual void StartModem(Error *error, const ResultCallback &callback); |
| 28 | virtual void StopModem(Error *error, const ResultCallback &callback); |
Darin Petkov | 5f316f6 | 2011-11-18 12:10:26 +0100 | [diff] [blame] | 29 | virtual void OnServiceCreated(); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 30 | virtual void UpdateStatus(const DBusPropertiesMap &properties); |
| 31 | virtual void SetupConnectProperties(DBusPropertiesMap *properties); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 32 | // The following two methods never need to report results |
| 33 | // via callbacks, which is why they don't take callbacks |
| 34 | // as arguments. |
Darin Petkov | 3e50924 | 2011-11-10 14:46:44 +0100 | [diff] [blame] | 35 | virtual void GetSignalQuality(); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 36 | virtual void GetRegistrationState(); |
| 37 | // The following six methods are only ever called as |
| 38 | // callbacks (from the main loop), which is why they |
| 39 | // don't take an Error * argument. |
| 40 | virtual void GetProperties(const ResultCallback &callback); |
| 41 | virtual void GetIMEI(const ResultCallback &callback); |
| 42 | virtual void GetIMSI(const ResultCallback &callback); |
| 43 | virtual void GetSPN(const ResultCallback &callback); |
| 44 | virtual void GetMSISDN(const ResultCallback &callback); |
| 45 | virtual void Register(const ResultCallback &callback); |
| 46 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 47 | virtual void RegisterOnNetwork(const std::string &network_id, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 48 | Error *error, |
| 49 | const ResultCallback &callback); |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 50 | virtual bool IsRegistered(); |
Darin Petkov | ac635a8 | 2012-01-10 16:51:58 +0100 | [diff] [blame] | 51 | virtual std::string CreateFriendlyServiceName(); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 52 | virtual void RequirePIN(const std::string &pin, bool require, |
| 53 | Error *error, const ResultCallback &callback); |
| 54 | virtual void EnterPIN(const std::string &pin, |
| 55 | Error *error, const ResultCallback &callback); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 56 | virtual void UnblockPIN(const std::string &unblock_code, |
| 57 | const std::string &pin, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 58 | Error *error, const ResultCallback &callback); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 59 | virtual void ChangePIN(const std::string &old_pin, |
| 60 | const std::string &new_pin, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 61 | Error *error, const ResultCallback &callback); |
| 62 | virtual void Scan(Error *error, const ResultCallback &callback); |
Darin Petkov | 20c13ec | 2011-11-09 15:07:15 +0100 | [diff] [blame] | 63 | virtual std::string GetNetworkTechnologyString() const; |
| 64 | virtual std::string GetRoamingStateString() const; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 65 | virtual void OnModemManagerPropertiesChanged( |
| 66 | const DBusPropertiesMap &properties); |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 67 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 68 | protected: |
| 69 | virtual void InitProxies(); |
| 70 | virtual void ReleaseProxies(); |
| 71 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 72 | private: |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 73 | friend class CellularTest; |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 74 | friend class CellularCapabilityGSMTest; |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 75 | friend class CellularCapabilityTest; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 76 | FRIEND_TEST(CellularCapabilityGSMTest, CreateDeviceFromProperties); |
Darin Petkov | ac635a8 | 2012-01-10 16:51:58 +0100 | [diff] [blame] | 77 | FRIEND_TEST(CellularCapabilityGSMTest, CreateFriendlyServiceName); |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 78 | FRIEND_TEST(CellularCapabilityGSMTest, GetIMEI); |
| 79 | FRIEND_TEST(CellularCapabilityGSMTest, GetIMSI); |
| 80 | FRIEND_TEST(CellularCapabilityGSMTest, GetMSISDN); |
| 81 | FRIEND_TEST(CellularCapabilityGSMTest, GetSPN); |
| 82 | FRIEND_TEST(CellularCapabilityGSMTest, RequirePIN); |
| 83 | FRIEND_TEST(CellularCapabilityGSMTest, EnterPIN); |
| 84 | FRIEND_TEST(CellularCapabilityGSMTest, UnblockPIN); |
| 85 | FRIEND_TEST(CellularCapabilityGSMTest, ChangePIN); |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 86 | FRIEND_TEST(CellularCapabilityGSMTest, InitAPNList); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 87 | FRIEND_TEST(CellularCapabilityGSMTest, ParseScanResult); |
| 88 | FRIEND_TEST(CellularCapabilityGSMTest, ParseScanResultProviderLookup); |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 89 | FRIEND_TEST(CellularCapabilityGSMTest, RegisterOnNetwork); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 90 | FRIEND_TEST(CellularCapabilityGSMTest, Scan); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 91 | FRIEND_TEST(CellularCapabilityGSMTest, SetAccessTechnology); |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 92 | FRIEND_TEST(CellularCapabilityGSMTest, SetHomeProvider); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 93 | FRIEND_TEST(CellularCapabilityGSMTest, UpdateOperatorInfo); |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 94 | FRIEND_TEST(CellularCapabilityGSMTest, GetRegistrationState); |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 95 | FRIEND_TEST(CellularCapabilityGSMTest, OnModemManagerPropertiesChanged); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 96 | FRIEND_TEST(CellularCapabilityTest, AllowRoaming); |
| 97 | FRIEND_TEST(CellularTest, StartGSMRegister); |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 98 | FRIEND_TEST(ModemTest, CreateDeviceFromProperties); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 99 | |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 100 | struct SimLockStatus { |
| 101 | public: |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 102 | SimLockStatus() : enabled(false), retries_left(0) {} |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 103 | |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 104 | bool enabled; |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 105 | std::string lock_type; |
| 106 | uint32 retries_left; |
| 107 | }; |
| 108 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 109 | static const char kNetworkPropertyAccessTechnology[]; |
| 110 | static const char kNetworkPropertyID[]; |
| 111 | static const char kNetworkPropertyLongName[]; |
| 112 | static const char kNetworkPropertyShortName[]; |
| 113 | static const char kNetworkPropertyStatus[]; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 114 | static const char kPhoneNumber[]; |
| 115 | static const char kPropertyAccessTechnology[]; |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 116 | static const char kPropertyEnabledFacilityLocks[]; |
| 117 | static const char kPropertyUnlockRequired[]; |
| 118 | static const char kPropertyUnlockRetries[]; |
| 119 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 120 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 121 | void SetAccessTechnology(uint32 access_technology); |
| 122 | |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 123 | // Sets the upper level information about the home cellular provider from the |
| 124 | // modem's IMSI and SPN. |
| 125 | void SetHomeProvider(); |
| 126 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 127 | // Updates the GSM operator name and country based on a newly obtained network |
| 128 | // id. |
| 129 | void UpdateOperatorInfo(); |
| 130 | |
| 131 | // Updates the serving operator on the active service. |
| 132 | void UpdateServingOperator(); |
| 133 | |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 134 | // Initializes the |apn_list_| property based on the current |home_provider_|. |
| 135 | void InitAPNList(); |
| 136 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 137 | Stringmap ParseScanResult(const GSMScanResult &result); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 138 | |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 139 | KeyValueStore SimLockStatusToProperty(Error *error); |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 140 | |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 141 | void HelpRegisterDerivedKeyValueStore( |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 142 | const std::string &name, |
Darin Petkov | 63138a9 | 2012-02-06 14:09:15 +0100 | [diff] [blame] | 143 | KeyValueStore(CellularCapabilityGSM::*get)(Error *error), |
| 144 | void(CellularCapabilityGSM::*set)( |
| 145 | const KeyValueStore &value, Error *error)); |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 146 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 147 | // Signal callbacks |
| 148 | virtual void OnNetworkModeSignal(uint32 mode); |
| 149 | virtual void OnRegistrationInfoSignal(uint32 status, |
| 150 | const std::string &operator_code, |
| 151 | const std::string &operator_name); |
| 152 | virtual void OnSignalQualitySignal(uint32 quality); |
| 153 | |
| 154 | // Method callbacks |
| 155 | virtual void OnGetRegistrationInfoReply(uint32 status, |
| 156 | const std::string &operator_code, |
| 157 | const std::string &operator_name, |
| 158 | const Error &error); |
| 159 | virtual void OnGetSignalQualityReply(uint32 quality, const Error &error); |
| 160 | virtual void OnRegisterReply(const ResultCallback &callback, |
| 161 | const Error &error); |
| 162 | virtual void OnGetIMEIReply(const ResultCallback &callback, |
| 163 | const std::string &imei, |
| 164 | const Error &error); |
| 165 | virtual void OnGetIMSIReply(const ResultCallback &callback, |
| 166 | const std::string &imsi, |
| 167 | const Error &error); |
| 168 | virtual void OnGetSPNReply(const ResultCallback &callback, |
| 169 | const std::string &spn, |
| 170 | const Error &error); |
| 171 | virtual void OnGetMSISDNReply(const ResultCallback &callback, |
| 172 | const std::string &msisdn, |
| 173 | const Error &error); |
| 174 | virtual void OnScanReply(const ResultCallback &callback, |
| 175 | const GSMScanResults &results, |
| 176 | const Error &error); |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 177 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 178 | scoped_ptr<ModemGSMCardProxyInterface> card_proxy_; |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 179 | scoped_ptr<ModemGSMNetworkProxyInterface> network_proxy_; |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 180 | base::WeakPtrFactory<CellularCapabilityGSM> weak_ptr_factory_; |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 181 | |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 182 | uint32 registration_state_; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 183 | uint32 access_technology_; |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 184 | Cellular::Operator serving_operator_; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 185 | std::string spn_; |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 186 | mobile_provider *home_provider_; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 187 | std::string desired_network_; |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 188 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 189 | // Properties. |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 190 | std::string selected_network_; |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 191 | Stringmaps found_networks_; |
| 192 | bool scanning_; |
| 193 | uint16 scan_interval_; |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 194 | SimLockStatus sim_lock_status_; |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 195 | Stringmaps apn_list_; |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 196 | |
Darin Petkov | ac635a8 | 2012-01-10 16:51:58 +0100 | [diff] [blame] | 197 | static unsigned int friendly_service_name_id_; |
| 198 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 199 | DISALLOW_COPY_AND_ASSIGN(CellularCapabilityGSM); |
| 200 | }; |
| 201 | |
| 202 | } // namespace shill |
| 203 | |
| 204 | #endif // SHILL_CELLULAR_CAPABILITY_GSM_ |