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 | |
Darin Petkov | c37a9c4 | 2012-09-06 15:28:22 +0200 | [diff] [blame] | 5 | #ifndef SHILL_CELLULAR_CAPABILITY_H_ |
| 6 | #define SHILL_CELLULAR_CAPABILITY_H_ |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 7 | |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 8 | #include <string> |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 9 | #include <vector> |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 10 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 11 | #include <base/basictypes.h> |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 12 | #include <base/callback.h> |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 13 | #include <base/memory/scoped_ptr.h> |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 14 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 15 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 16 | #include "shill/callbacks.h" |
Eric Shienbrood | 7fce52c | 2012-04-13 19:11:02 -0400 | [diff] [blame] | 17 | #include "shill/cellular.h" |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 18 | #include "shill/dbus_properties.h" |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 19 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 20 | namespace shill { |
| 21 | |
| 22 | class Cellular; |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 23 | class Error; |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 24 | class ProxyFactory; |
| 25 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 26 | // Cellular devices instantiate subclasses of CellularCapability that |
| 27 | // handle the specific modem technologies and capabilities. |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 28 | // |
| 29 | // The CellularCapability is directly subclassed by: |
| 30 | // * CelllularCapabilityUniversal which handles all modems managed by |
| 31 | // a modem manager using the the org.chromium.ModemManager1 DBUS |
| 32 | // interface |
| 33 | // * CellularCapabilityClassic which handles all modems managed by a |
| 34 | // modem manager using the older org.chromium.ModemManager DBUS |
| 35 | // interface. This class is further subclassed to represent CDMA |
| 36 | // and GSM modems |
| 37 | // |
| 38 | // Pictorially: |
| 39 | // |
| 40 | // CellularCapability |
| 41 | // | |
| 42 | // |-- CellularCapabilityUniversal |
| 43 | // | |
| 44 | // |-- CellularCapabilityClassic |
| 45 | // | |
| 46 | // |-- CellularCapabilityGSM |
| 47 | // | |
| 48 | // |-- CellularCapabilityCDMA |
| 49 | // |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 50 | class CellularCapability { |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 51 | public: |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 52 | // SimLockStatus represents the fields in the Cellular.SIMLockStatus |
| 53 | // DBUS property of the shill device. |
| 54 | struct SimLockStatus { |
| 55 | SimLockStatus() : enabled(false), retries_left(0) {} |
| 56 | |
| 57 | bool enabled; |
| 58 | std::string lock_type; |
| 59 | uint32 retries_left; |
| 60 | }; |
| 61 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 62 | static const int kTimeoutActivate; |
| 63 | static const int kTimeoutConnect; |
| 64 | static const int kTimeoutDefault; |
Thieu Le | 049adb5 | 2012-11-12 17:14:51 -0800 | [diff] [blame] | 65 | static const int kTimeoutDisconnect; |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 66 | static const int kTimeoutEnable; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 67 | static const int kTimeoutRegister; |
| 68 | static const int kTimeoutScan; |
| 69 | |
Eric Shienbrood | 7fce52c | 2012-04-13 19:11:02 -0400 | [diff] [blame] | 70 | static const char kModemPropertyIMSI[]; |
| 71 | static const char kModemPropertyState[]; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 72 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 73 | // |cellular| is the parent Cellular device. |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 74 | CellularCapability(Cellular *cellular, ProxyFactory *proxy_factory); |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 75 | virtual ~CellularCapability(); |
| 76 | |
| 77 | Cellular *cellular() const { return cellular_; } |
| 78 | ProxyFactory *proxy_factory() const { return proxy_factory_; } |
Darin Petkov | 5f316f6 | 2011-11-18 12:10:26 +0100 | [diff] [blame] | 79 | |
| 80 | // Invoked by the parent Cellular device when a new service is created. |
| 81 | virtual void OnServiceCreated() = 0; |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 82 | |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 83 | virtual void SetupConnectProperties(DBusPropertiesMap *properties) = 0; |
| 84 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 85 | // StartModem attempts to put the modem in a state in which it is |
| 86 | // usable for creating services and establishing connections (if |
| 87 | // network conditions permit). It potentially consists of multiple |
| 88 | // non-blocking calls to the modem-manager server. After each call, |
| 89 | // control is passed back up to the main loop. Each time a reply to |
| 90 | // a non-blocking call is received, the operation advances to the next |
| 91 | // step, until either an error occurs in one of them, or all the steps |
| 92 | // have been completed, at which point StartModem() is finished. |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 93 | virtual void StartModem(Error *error, |
| 94 | const ResultCallback &callback) = 0; |
Thieu Le | 923006b | 2012-04-05 16:32:58 -0700 | [diff] [blame] | 95 | // StopModem disconnects and disables a modem asynchronously. |
| 96 | // |callback| is invoked when this completes and the result is passed |
| 97 | // to the callback. |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 98 | virtual void StopModem(Error *error, const ResultCallback &callback) = 0; |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 99 | virtual void Connect(const DBusPropertiesMap &properties, Error *error, |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 100 | const ResultCallback &callback) = 0; |
| 101 | virtual void Disconnect(Error *error, const ResultCallback &callback) = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 102 | |
| 103 | // Activates the modem. Returns an Error on failure. |
| 104 | // The default implementation fails by returning a kNotSupported error |
| 105 | // to the caller. |
| 106 | virtual void Activate(const std::string &carrier, |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 107 | Error *error, const ResultCallback &callback) = 0; |
Darin Petkov | a3d3be5 | 2011-11-14 21:34:16 +0100 | [diff] [blame] | 108 | |
Ben Chan | 1578603 | 2012-11-04 21:28:02 -0800 | [diff] [blame] | 109 | // Returns true if service activation is required. Returns false by default |
| 110 | // in this base class. |
| 111 | virtual bool IsServiceActivationRequired() const; |
| 112 | |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 113 | // Network registration. |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 114 | virtual void RegisterOnNetwork(const std::string &network_id, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 115 | Error *error, |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 116 | const ResultCallback &callback) = 0; |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 117 | virtual bool IsRegistered() = 0; |
Eric Shienbrood | 7fce52c | 2012-04-13 19:11:02 -0400 | [diff] [blame] | 118 | // If we are informed by means of something other than a signal indicating |
| 119 | // a registration state change that the modem has unregistered from the |
| 120 | // network, we need to update the network-type-specific capability object. |
| 121 | virtual void SetUnregistered(bool searching) = 0; |
Darin Petkov | 184c54e | 2011-11-15 12:44:39 +0100 | [diff] [blame] | 122 | |
Darin Petkov | ac635a8 | 2012-01-10 16:51:58 +0100 | [diff] [blame] | 123 | virtual std::string CreateFriendlyServiceName() = 0; |
| 124 | |
Darin Petkov | c64fe5e | 2012-01-11 12:46:13 +0100 | [diff] [blame] | 125 | // PIN management. The default implementation fails by returning an error. |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 126 | virtual void RequirePIN(const std::string &pin, bool require, |
| 127 | Error *error, const ResultCallback &callback); |
| 128 | virtual void EnterPIN(const std::string &pin, |
| 129 | Error *error, const ResultCallback &callback); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 130 | virtual void UnblockPIN(const std::string &unblock_code, |
| 131 | const std::string &pin, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 132 | Error *error, const ResultCallback &callback); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 133 | virtual void ChangePIN(const std::string &old_pin, |
| 134 | const std::string &new_pin, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 135 | Error *error, const ResultCallback &callback); |
Darin Petkov | b05315f | 2011-11-07 10:14:25 +0100 | [diff] [blame] | 136 | |
Darin Petkov | c37a9c4 | 2012-09-06 15:28:22 +0200 | [diff] [blame] | 137 | // The default implementation fails by returning an error. |
| 138 | virtual void SetCarrier(const std::string &carrier, |
| 139 | Error *error, const ResultCallback &callback); |
| 140 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 141 | // Asks the modem to scan for networks. |
| 142 | // |
| 143 | // The default implementation fails by filling error with |
| 144 | // kNotSupported. |
| 145 | // |
| 146 | // Subclasses should implement this by fetching scan results |
| 147 | // asynchronously. When the results are ready, update the |
| 148 | // flimflam::kFoundNetworksProperty and send a property change |
| 149 | // notification. Finally, callback must be invoked to inform the |
| 150 | // caller that the scan has completed. |
| 151 | // |
| 152 | // Errors are not generally reported, but on error the |
| 153 | // kFoundNetworksProperty should be cleared and a property change |
| 154 | // notification sent out. |
| 155 | // |
| 156 | // TODO(jglasgow): Refactor to reuse code by putting notification |
| 157 | // logic into Cellular or CellularCapability. |
| 158 | // |
| 159 | // TODO(jglasgow): Implement real error handling. |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 160 | virtual void Scan(Error *error, const ResultCallback &callback); |
Darin Petkov | 1272a43 | 2011-11-10 15:53:37 +0100 | [diff] [blame] | 161 | |
Darin Petkov | 20c13ec | 2011-11-09 15:07:15 +0100 | [diff] [blame] | 162 | // Returns an empty string if the network technology is unknown. |
| 163 | virtual std::string GetNetworkTechnologyString() const = 0; |
| 164 | |
| 165 | virtual std::string GetRoamingStateString() const = 0; |
| 166 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 167 | virtual void GetSignalQuality() = 0; |
| 168 | |
Eric Shienbrood | 0db6a9b | 2012-03-30 16:11:39 -0400 | [diff] [blame] | 169 | virtual std::string GetTypeString() const = 0; |
| 170 | |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 171 | // Called when ModemManager has sent a property change notification |
| 172 | // signal over DBUS. |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 173 | virtual void OnDBusPropertiesChanged( |
| 174 | const std::string &interface, |
| 175 | const DBusPropertiesMap &changed_properties, |
| 176 | const std::vector<std::string> &invalidated_properties) = 0; |
Darin Petkov | ae0c64e | 2011-11-15 15:50:27 +0100 | [diff] [blame] | 177 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 178 | // Should this device allow roaming? |
| 179 | // The decision to allow roaming or not is based on the home |
| 180 | // provider as well as on the user modifiable "allow_roaming" |
| 181 | // property. |
| 182 | virtual bool AllowRoaming() = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 183 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 184 | protected: |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 185 | // Releases all proxies held by the object. This is most useful |
| 186 | // during unit tests. |
| 187 | virtual void ReleaseProxies() = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 188 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 189 | static void OnUnsupportedOperation(const char *operation, Error *error); |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 190 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 191 | // accessor for subclasses to read the allow roaming property |
Jason Glasgow | 7b461df | 2012-05-01 16:38:45 -0400 | [diff] [blame] | 192 | bool allow_roaming_property() const { |
| 193 | return cellular_->allow_roaming_property(); |
| 194 | } |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 195 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 196 | private: |
Thieu Le | 923006b | 2012-04-05 16:32:58 -0700 | [diff] [blame] | 197 | friend class CellularCapabilityGSMTest; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 198 | friend class CellularCapabilityTest; |
Jason Glasgow | ef96556 | 2012-04-10 16:12:35 -0400 | [diff] [blame] | 199 | friend class CellularCapabilityUniversalTest; |
Thieu Le | 923006b | 2012-04-05 16:32:58 -0700 | [diff] [blame] | 200 | friend class CellularTest; |
Darin Petkov | 9c1dcef | 2012-02-07 15:58:26 +0100 | [diff] [blame] | 201 | FRIEND_TEST(CellularCapabilityTest, AllowRoaming); |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 202 | FRIEND_TEST(CellularTest, Connect); |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 203 | FRIEND_TEST(CellularTest, TearDown); |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 204 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 205 | Cellular *cellular_; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 206 | |
| 207 | // Store cached copies of singletons for speed/ease of testing. |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 208 | ProxyFactory *proxy_factory_; |
| 209 | |
Darin Petkov | daf4386 | 2011-10-27 11:37:28 +0200 | [diff] [blame] | 210 | DISALLOW_COPY_AND_ASSIGN(CellularCapability); |
| 211 | }; |
| 212 | |
| 213 | } // namespace shill |
| 214 | |
Darin Petkov | c37a9c4 | 2012-09-06 15:28:22 +0200 | [diff] [blame] | 215 | #endif // SHILL_CELLULAR_CAPABILITY_H_ |