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> |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 9 | #include <base/task.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 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 22 | class CellularCapabilityGSM : public CellularCapability, |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 23 | public ModemGSMCardProxyDelegate, |
| 24 | public ModemGSMNetworkProxyDelegate { |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 25 | public: |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 26 | static const char kPropertyUnlockRequired[]; |
| 27 | static const char kPropertyUnlockRetries[]; |
| 28 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 29 | CellularCapabilityGSM(Cellular *cellular); |
| 30 | |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 31 | // Inherited from CellularCapability. |
Darin Petkov | 5f316f6 | 2011-11-18 12:10:26 +0100 | [diff] [blame] | 32 | virtual void OnDeviceStarted(); |
| 33 | virtual void OnDeviceStopped(); |
| 34 | virtual void OnServiceCreated(); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 35 | virtual void UpdateStatus(const DBusPropertiesMap &properties); |
| 36 | virtual void SetupConnectProperties(DBusPropertiesMap *properties); |
Darin Petkov | 3e50924 | 2011-11-10 14:46:44 +0100 | [diff] [blame] | 37 | virtual void GetSignalQuality(); |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 38 | virtual void GetRegistrationState(); |
| 39 | virtual void GetProperties(); |
| 40 | virtual void Register(); |
| 41 | virtual void RegisterOnNetwork(const std::string &network_id, Error *error); |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 42 | virtual bool IsRegistered(); |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame^] | 43 | virtual void RequirePIN( |
| 44 | const std::string &pin, bool require, ReturnerInterface *returner); |
Darin Petkov | e5bc2cb | 2011-12-07 14:47:32 +0100 | [diff] [blame] | 45 | virtual void EnterPIN(const std::string &pin, ReturnerInterface *returner); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 46 | virtual void UnblockPIN(const std::string &unblock_code, |
| 47 | const std::string &pin, |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame^] | 48 | ReturnerInterface *returner); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 49 | virtual void ChangePIN(const std::string &old_pin, |
| 50 | const std::string &new_pin, |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame^] | 51 | ReturnerInterface *returner); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 52 | virtual void Scan(Error *error); |
Darin Petkov | 20c13ec | 2011-11-09 15:07:15 +0100 | [diff] [blame] | 53 | virtual std::string GetNetworkTechnologyString() const; |
| 54 | virtual std::string GetRoamingStateString() const; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 55 | virtual void OnModemManagerPropertiesChanged( |
| 56 | const DBusPropertiesMap &properties); |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 57 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 58 | // Obtains the IMEI, IMSI, SPN and MSISDN. |
| 59 | virtual void GetIdentifiers(); |
| 60 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 61 | const std::string &spn() const { return spn_; } |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 62 | const std::string &sim_lock_type() const { |
| 63 | return sim_lock_status_.lock_type; |
| 64 | } |
| 65 | uint32 sim_lock_retries_left() const { return sim_lock_status_.retries_left; } |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 66 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 67 | private: |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 68 | friend class CellularCapabilityGSMTest; |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 69 | FRIEND_TEST(CellularCapabilityGSMTest, InitAPNList); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 70 | FRIEND_TEST(CellularCapabilityGSMTest, ParseScanResult); |
| 71 | FRIEND_TEST(CellularCapabilityGSMTest, ParseScanResultProviderLookup); |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 72 | FRIEND_TEST(CellularCapabilityGSMTest, RegisterOnNetwork); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 73 | FRIEND_TEST(CellularCapabilityGSMTest, Scan); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 74 | FRIEND_TEST(CellularCapabilityGSMTest, SetAccessTechnology); |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 75 | FRIEND_TEST(CellularCapabilityGSMTest, SetHomeProvider); |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 76 | FRIEND_TEST(CellularCapabilityGSMTest, UpdateOperatorInfo); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 77 | |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 78 | struct SimLockStatus { |
| 79 | public: |
| 80 | SimLockStatus() : retries_left(0) {} |
| 81 | SimLockStatus(const std::string &in_lock_type, uint32 in_retries_left) |
| 82 | : lock_type(in_lock_type), |
| 83 | retries_left(in_retries_left) {} |
| 84 | |
| 85 | std::string lock_type; |
| 86 | uint32 retries_left; |
| 87 | }; |
| 88 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 89 | static const char kNetworkPropertyAccessTechnology[]; |
| 90 | static const char kNetworkPropertyID[]; |
| 91 | static const char kNetworkPropertyLongName[]; |
| 92 | static const char kNetworkPropertyShortName[]; |
| 93 | static const char kNetworkPropertyStatus[]; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 94 | static const char kPhoneNumber[]; |
| 95 | static const char kPropertyAccessTechnology[]; |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 96 | |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 97 | void RegisterOnNetworkTask(const std::string &network_id); |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame^] | 98 | void RequirePINTask( |
| 99 | const std::string &pin, bool require, ReturnerInterface *returner); |
Darin Petkov | e5bc2cb | 2011-12-07 14:47:32 +0100 | [diff] [blame] | 100 | void EnterPINTask(const std::string &pin, ReturnerInterface *returner); |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame^] | 101 | void UnblockPINTask(const std::string &unblock_code, |
| 102 | const std::string &pin, |
| 103 | ReturnerInterface *returner); |
| 104 | void ChangePINTask(const std::string &old_pin, |
| 105 | const std::string &new_pin, |
| 106 | ReturnerInterface *returner); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 107 | void ScanTask(); |
| 108 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 109 | void SetAccessTechnology(uint32 access_technology); |
| 110 | |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 111 | // Sets the upper level information about the home cellular provider from the |
| 112 | // modem's IMSI and SPN. |
| 113 | void SetHomeProvider(); |
| 114 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 115 | // Updates the GSM operator name and country based on a newly obtained network |
| 116 | // id. |
| 117 | void UpdateOperatorInfo(); |
| 118 | |
| 119 | // Updates the serving operator on the active service. |
| 120 | void UpdateServingOperator(); |
| 121 | |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 122 | // Initializes the |apn_list_| property based on the current |home_provider_|. |
| 123 | void InitAPNList(); |
| 124 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 125 | Stringmap ParseScanResult( |
| 126 | const ModemGSMNetworkProxyInterface::ScanResult &result); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 127 | |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 128 | StrIntPair SimLockStatusToProperty(Error *error); |
| 129 | |
| 130 | void HelpRegisterDerivedStrIntPair( |
| 131 | const std::string &name, |
| 132 | StrIntPair(CellularCapabilityGSM::*get)(Error *), |
| 133 | void(CellularCapabilityGSM::*set)(const StrIntPair&, Error *)); |
| 134 | |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 135 | // Signal callbacks inherited from ModemGSMNetworkProxyDelegate. |
| 136 | virtual void OnGSMNetworkModeChanged(uint32 mode); |
| 137 | virtual void OnGSMRegistrationInfoChanged(uint32 status, |
| 138 | const std::string &operator_code, |
| 139 | const std::string &operator_name); |
| 140 | virtual void OnGSMSignalQualityChanged(uint32 quality); |
| 141 | |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 142 | scoped_ptr<ModemGSMCardProxyInterface> card_proxy_; |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 143 | scoped_ptr<ModemGSMNetworkProxyInterface> network_proxy_; |
Darin Petkov | cb54773 | 2011-11-09 13:55:26 +0100 | [diff] [blame] | 144 | |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 145 | ScopedRunnableMethodFactory<CellularCapabilityGSM> task_factory_; |
| 146 | |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 147 | uint32 registration_state_; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 148 | uint32 access_technology_; |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 149 | Cellular::Operator serving_operator_; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 150 | std::string spn_; |
Darin Petkov | 0a4dfeb | 2011-11-18 19:36:13 +0100 | [diff] [blame] | 151 | mobile_provider *home_provider_; |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 152 | |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 153 | // Properties. |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 154 | std::string selected_network_; |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 155 | Stringmaps found_networks_; |
| 156 | bool scanning_; |
| 157 | uint16 scan_interval_; |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 158 | SimLockStatus sim_lock_status_; |
Darin Petkov | 3cfbf21 | 2011-11-21 16:02:09 +0100 | [diff] [blame] | 159 | Stringmaps apn_list_; |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 160 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 161 | DISALLOW_COPY_AND_ASSIGN(CellularCapabilityGSM); |
| 162 | }; |
| 163 | |
| 164 | } // namespace shill |
| 165 | |
| 166 | #endif // SHILL_CELLULAR_CAPABILITY_GSM_ |