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