Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium OS Authors. All rights reserved. |
| 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_ |
| 6 | #define SHILL_CELLULAR_ |
| 7 | |
| 8 | #include <string> |
| 9 | |
| 10 | #include <base/basictypes.h> |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 11 | #include <base/task.h> |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 12 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 13 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 14 | #include "shill/dbus_properties.h" |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 15 | #include "shill/device.h" |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 16 | #include "shill/modem_cdma_proxy_interface.h" |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 17 | #include "shill/modem_proxy_interface.h" |
Chris Masone | 2b10554 | 2011-06-22 10:58:09 -0700 | [diff] [blame] | 18 | #include "shill/refptr_types.h" |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 19 | #include "shill/shill_event.h" |
| 20 | |
| 21 | namespace shill { |
| 22 | |
Darin Petkov | e604f70 | 2011-07-28 15:51:17 -0700 | [diff] [blame] | 23 | class ModemSimpleProxyInterface; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 24 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 25 | class Cellular : public Device, |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 26 | public ModemCDMAProxyListener, |
| 27 | public ModemProxyListener { |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 28 | public: |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 29 | enum Type { |
| 30 | kTypeGSM, |
| 31 | kTypeCDMA |
| 32 | }; |
| 33 | |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 34 | // The device states progress linearly from Disabled to Linked. |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 35 | enum State { |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 36 | // This is the initial state of the modem and indicates that the modem radio |
| 37 | // is not turned on. |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 38 | kStateDisabled, |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 39 | // This state indicates that the modem radio is turned on, and it should be |
| 40 | // possible to measure signal strength. |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 41 | kStateEnabled, |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 42 | // The modem has registered with a network and has signal quality |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 43 | // measurements. A cellular service object is created. |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 44 | kStateRegistered, |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 45 | // The modem has connected to a network. |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 46 | kStateConnected, |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 47 | // The network interface is UP. |
| 48 | kStateLinked, |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 49 | }; |
| 50 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 51 | // These should be kept in sync with ModemManager's mm-modem.h:MMModemState. |
| 52 | enum ModemState { |
| 53 | kModemStateUnknown = 0, |
| 54 | kModemStateDisabled = 10, |
| 55 | kModemStateDisabling = 20, |
| 56 | kModemStateEnabling = 30, |
| 57 | kModemStateEnabled = 40, |
| 58 | kModemStateSearching = 50, |
| 59 | kModemStateRegistered = 60, |
| 60 | kModemStateDisconnecting = 70, |
| 61 | kModemStateConnecting = 80, |
| 62 | kModemStateConnected = 90, |
| 63 | }; |
| 64 | |
Darin Petkov | 3335b37 | 2011-08-22 11:05:32 -0700 | [diff] [blame^] | 65 | class Operator { |
| 66 | public: |
| 67 | Operator(); |
| 68 | ~Operator(); |
| 69 | |
| 70 | void CopyFrom(const Operator &oper); |
| 71 | |
| 72 | const std::string &GetName() const; |
| 73 | void SetName(const std::string &name); |
| 74 | |
| 75 | const std::string &GetCode() const; |
| 76 | void SetCode(const std::string &code); |
| 77 | |
| 78 | const std::string &GetCountry() const; |
| 79 | void SetCountry(const std::string &country); |
| 80 | |
| 81 | const Stringmap &ToDict() const; |
| 82 | |
| 83 | private: |
| 84 | Stringmap dict_; |
| 85 | |
| 86 | DISALLOW_COPY_AND_ASSIGN(Operator); |
| 87 | }; |
| 88 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 89 | class Network { |
| 90 | public: |
| 91 | Network(); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 92 | ~Network(); |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 93 | |
| 94 | const std::string &GetStatus() const; |
| 95 | void SetStatus(const std::string &status); |
| 96 | |
| 97 | const std::string &GetId() const; |
| 98 | void SetId(const std::string &id); |
| 99 | |
| 100 | const std::string &GetShortName() const; |
| 101 | void SetShortName(const std::string &name); |
| 102 | |
| 103 | const std::string &GetLongName() const; |
| 104 | void SetLongName(const std::string &name); |
| 105 | |
| 106 | const std::string &GetTechnology() const; |
| 107 | void SetTechnology(const std::string &technology); |
| 108 | |
| 109 | const Stringmap &ToDict() const; |
| 110 | |
| 111 | private: |
| 112 | Stringmap dict_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 113 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 114 | DISALLOW_COPY_AND_ASSIGN(Network); |
| 115 | }; |
| 116 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 117 | struct CDMA { |
| 118 | CDMA(); |
| 119 | |
| 120 | uint32 registration_state_evdo; |
| 121 | uint32 registration_state_1x; |
| 122 | uint32 activation_state; |
Darin Petkov | cc04442 | 2011-08-17 13:30:06 -0700 | [diff] [blame] | 123 | |
| 124 | uint16 prl_version; |
| 125 | std::string payment_url; |
| 126 | std::string usage_url; |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 127 | }; |
| 128 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 129 | struct SimLockStatus { |
| 130 | public: |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 131 | SimLockStatus() : retries_left(0) {} |
| 132 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 133 | std::string lock_type; |
| 134 | uint32 retries_left; |
| 135 | }; |
| 136 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 137 | static const char kConnectPropertyPhoneNumber[]; |
| 138 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 139 | // |owner| is the ModemManager DBus service owner (e.g., ":1.17"). |path| is |
| 140 | // the ModemManager.Modem DBus object path (e.g., |
| 141 | // "/org/chromium/ModemManager/Gobi/0"). |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 142 | Cellular(ControlInterface *control_interface, |
| 143 | EventDispatcher *dispatcher, |
| 144 | Manager *manager, |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 145 | const std::string &link_name, |
Chris Masone | 626719f | 2011-08-18 16:58:48 -0700 | [diff] [blame] | 146 | const std::string &address, |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 147 | int interface_index, |
| 148 | Type type, |
| 149 | const std::string &owner, |
| 150 | const std::string &path); |
| 151 | virtual ~Cellular(); |
| 152 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 153 | // Asynchronously connects the modem to the network. |
| 154 | void Connect(); |
| 155 | |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 156 | // Asynchronously activates the modem. |
| 157 | void Activate(const std::string &carrier); |
| 158 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 159 | void set_modem_state(ModemState state) { modem_state_ = state; } |
| 160 | ModemState modem_state() const { return modem_state_; } |
| 161 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 162 | // Inherited from Device. |
| 163 | virtual void Start(); |
| 164 | virtual void Stop(); |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 165 | virtual bool TechnologyIs(Technology type) const; |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 166 | virtual void LinkEvent(unsigned int flags, unsigned int change); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 167 | |
| 168 | private: |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 169 | FRIEND_TEST(CellularTest, Activate); |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 170 | FRIEND_TEST(CellularTest, ActivateError); |
Darin Petkov | 3335b37 | 2011-08-22 11:05:32 -0700 | [diff] [blame^] | 171 | FRIEND_TEST(CellularTest, CreateService); |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 172 | FRIEND_TEST(CellularTest, Connect); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 173 | FRIEND_TEST(CellularTest, GetCDMAActivationStateString); |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 174 | FRIEND_TEST(CellularTest, GetCDMAActivationErrorString); |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 175 | FRIEND_TEST(CellularTest, GetCDMARegistrationState); |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 176 | FRIEND_TEST(CellularTest, GetCDMASignalQuality); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 177 | FRIEND_TEST(CellularTest, GetModemInfo); |
| 178 | FRIEND_TEST(CellularTest, GetModemStatus); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 179 | FRIEND_TEST(CellularTest, GetStateString); |
| 180 | FRIEND_TEST(CellularTest, GetTypeString); |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 181 | FRIEND_TEST(CellularTest, InitProxiesCDMA); |
| 182 | FRIEND_TEST(CellularTest, InitProxiesGSM); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 183 | FRIEND_TEST(CellularTest, Start); |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 184 | FRIEND_TEST(CellularTest, StartConnected); |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 185 | FRIEND_TEST(CellularTest, StartLinked); |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 186 | FRIEND_TEST(CellularTest, StartRegister); |
| 187 | |
| 188 | static const char kPhoneNumberCDMA[]; |
| 189 | static const char kPhoneNumberGSM[]; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 190 | |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 191 | void SetState(State state); |
| 192 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 193 | void ConnectTask(const DBusPropertiesMap &properties); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 194 | void ActivateTask(const std::string &carrier); |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 195 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 196 | // Invoked when the modem is connected to the cellular network to transition |
| 197 | // to the network-connected state and bring the network interface up. |
| 198 | void EstablishLink(); |
| 199 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 200 | Stringmaps EnumerateNetworks(); |
| 201 | StrIntPair SimLockStatusToProperty(); |
| 202 | void HelpRegisterDerivedStringmaps(const std::string &name, |
| 203 | Stringmaps(Cellular::*get)(void), |
| 204 | bool(Cellular::*set)(const Stringmaps&)); |
| 205 | void HelpRegisterDerivedStrIntPair(const std::string &name, |
| 206 | StrIntPair(Cellular::*get)(void), |
| 207 | bool(Cellular::*set)(const StrIntPair&)); |
| 208 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 209 | void InitProxies(); |
| 210 | |
Darin Petkov | cc04442 | 2011-08-17 13:30:06 -0700 | [diff] [blame] | 211 | std::string GetTypeString() const; |
| 212 | static std::string GetStateString(State state); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 213 | |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 214 | static std::string GetCDMAActivationStateString(uint32 state); |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 215 | static std::string GetCDMAActivationErrorString(uint32 error); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 216 | |
Darin Petkov | f5f61e0 | 2011-07-29 11:35:40 -0700 | [diff] [blame] | 217 | void EnableModem(); |
| 218 | void GetModemStatus(); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 219 | void GetGSMProperties(); |
| 220 | void RegisterGSMModem(); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 221 | |
| 222 | // Obtains the modem identifiers: MEID for CDMA; IMEI, IMSI, SPN and MSISDN |
| 223 | // for GSM. |
| 224 | void GetModemIdentifiers(); |
| 225 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 226 | // Obtains modem's manufacturer, model ID, and hardware revision. |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 227 | void GetModemInfo(); |
Darin Petkov | f5f61e0 | 2011-07-29 11:35:40 -0700 | [diff] [blame] | 228 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 229 | void GetModemRegistrationState(); |
| 230 | void GetCDMARegistrationState(); |
| 231 | void GetGSMRegistrationState(); |
| 232 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 233 | // Processes a change in the modem registration state, possibly creating, |
| 234 | // destroying or updating the CellularService. |
| 235 | void HandleNewRegistrationState(); |
Darin Petkov | 0828f5f | 2011-08-11 10:18:52 -0700 | [diff] [blame] | 236 | void HandleNewRegistrationStateTask(); |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 237 | |
| 238 | void CreateService(); |
| 239 | |
| 240 | void GetModemSignalQuality(); |
| 241 | uint32 GetCDMASignalQuality(); |
| 242 | uint32 GetGSMSignalQuality(); |
| 243 | |
| 244 | void HandleNewSignalQuality(uint32 strength); |
| 245 | |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 246 | void HandleNewCDMAActivationState(uint32 error); |
| 247 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 248 | // Returns true if the modem is registered. Note that this method looks at the |
| 249 | // latest CDMA/GSM registration info obtained from the modem rather than the |
| 250 | // device |state_|. |
| 251 | bool IsModemRegistered(); |
| 252 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 253 | // Signal callbacks inherited from ModemCDMAProxyListener. |
Darin Petkov | b27e544 | 2011-08-16 14:36:45 -0700 | [diff] [blame] | 254 | virtual void OnCDMAActivationStateChanged( |
| 255 | uint32 activation_state, |
| 256 | uint32 activation_error, |
| 257 | const DBusPropertiesMap &status_changes); |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 258 | virtual void OnCDMARegistrationStateChanged(uint32 state_1x, |
| 259 | uint32 state_evdo); |
| 260 | virtual void OnCDMASignalQualityChanged(uint32 strength); |
| 261 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 262 | // Signal callbacks inherited from ModemProxyListener. |
| 263 | virtual void OnModemStateChanged(uint32 old_state, |
| 264 | uint32 new_state, |
| 265 | uint32 reason); |
| 266 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 267 | Type type_; |
| 268 | State state_; |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame] | 269 | ModemState modem_state_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 270 | |
| 271 | const std::string dbus_owner_; // ModemManager.Modem |
| 272 | const std::string dbus_path_; // ModemManager.Modem |
| 273 | scoped_ptr<ModemProxyInterface> proxy_; |
Darin Petkov | e604f70 | 2011-07-28 15:51:17 -0700 | [diff] [blame] | 274 | scoped_ptr<ModemSimpleProxyInterface> simple_proxy_; |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 275 | scoped_ptr<ModemCDMAProxyInterface> cdma_proxy_; |
| 276 | |
| 277 | CDMA cdma_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 278 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 279 | CellularServiceRefPtr service_; |
Chris Masone | 853b81b | 2011-06-24 14:11:41 -0700 | [diff] [blame] | 280 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 281 | ScopedRunnableMethodFactory<Cellular> task_factory_; |
| 282 | |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 283 | // Properties |
| 284 | bool allow_roaming_; |
| 285 | std::string carrier_; |
| 286 | std::string meid_; |
| 287 | std::string imei_; |
| 288 | std::string imsi_; |
| 289 | std::string esn_; |
| 290 | std::string mdn_; |
| 291 | std::string min_; |
| 292 | std::string model_id_; |
| 293 | std::string manufacturer_; |
| 294 | std::string firmware_revision_; |
| 295 | std::string hardware_revision_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 296 | bool scanning_; |
| 297 | uint16 scan_interval_; |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 298 | std::vector<Network> found_networks_; |
| 299 | SimLockStatus sim_lock_status_; |
Darin Petkov | 3335b37 | 2011-08-22 11:05:32 -0700 | [diff] [blame^] | 300 | Operator home_provider_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 301 | |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 302 | DISALLOW_COPY_AND_ASSIGN(Cellular); |
| 303 | }; |
| 304 | |
| 305 | } // namespace shill |
| 306 | |
| 307 | #endif // SHILL_CELLULAR_ |