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 | |
| 34 | enum State { |
| 35 | kStateDisabled, |
| 36 | kStateEnabled, |
| 37 | kStateRegistered, |
| 38 | kStateConnected, |
| 39 | }; |
| 40 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame^] | 41 | // These should be kept in sync with ModemManager's mm-modem.h:MMModemState. |
| 42 | enum ModemState { |
| 43 | kModemStateUnknown = 0, |
| 44 | kModemStateDisabled = 10, |
| 45 | kModemStateDisabling = 20, |
| 46 | kModemStateEnabling = 30, |
| 47 | kModemStateEnabled = 40, |
| 48 | kModemStateSearching = 50, |
| 49 | kModemStateRegistered = 60, |
| 50 | kModemStateDisconnecting = 70, |
| 51 | kModemStateConnecting = 80, |
| 52 | kModemStateConnected = 90, |
| 53 | }; |
| 54 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 55 | class Network { |
| 56 | public: |
| 57 | Network(); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 58 | ~Network(); |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 59 | |
| 60 | const std::string &GetStatus() const; |
| 61 | void SetStatus(const std::string &status); |
| 62 | |
| 63 | const std::string &GetId() const; |
| 64 | void SetId(const std::string &id); |
| 65 | |
| 66 | const std::string &GetShortName() const; |
| 67 | void SetShortName(const std::string &name); |
| 68 | |
| 69 | const std::string &GetLongName() const; |
| 70 | void SetLongName(const std::string &name); |
| 71 | |
| 72 | const std::string &GetTechnology() const; |
| 73 | void SetTechnology(const std::string &technology); |
| 74 | |
| 75 | const Stringmap &ToDict() const; |
| 76 | |
| 77 | private: |
| 78 | Stringmap dict_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 79 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 80 | DISALLOW_COPY_AND_ASSIGN(Network); |
| 81 | }; |
| 82 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 83 | struct CDMA { |
| 84 | CDMA(); |
| 85 | |
| 86 | uint32 registration_state_evdo; |
| 87 | uint32 registration_state_1x; |
| 88 | uint32 activation_state; |
| 89 | }; |
| 90 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 91 | struct SimLockStatus { |
| 92 | public: |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 93 | SimLockStatus() : retries_left(0) {} |
| 94 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 95 | std::string lock_type; |
| 96 | uint32 retries_left; |
| 97 | }; |
| 98 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 99 | static const char kConnectPropertyPhoneNumber[]; |
| 100 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 101 | // |owner| is the ModemManager DBus service owner (e.g., ":1.17"). |path| is |
| 102 | // the ModemManager.Modem DBus object path (e.g., |
| 103 | // "/org/chromium/ModemManager/Gobi/0"). |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 104 | Cellular(ControlInterface *control_interface, |
| 105 | EventDispatcher *dispatcher, |
| 106 | Manager *manager, |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 107 | const std::string &link_name, |
| 108 | int interface_index, |
| 109 | Type type, |
| 110 | const std::string &owner, |
| 111 | const std::string &path); |
| 112 | virtual ~Cellular(); |
| 113 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 114 | // Asynchronously connects the modem to the network. |
| 115 | void Connect(); |
| 116 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame^] | 117 | void set_modem_state(ModemState state) { modem_state_ = state; } |
| 118 | ModemState modem_state() const { return modem_state_; } |
| 119 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 120 | // Inherited from Device. |
| 121 | virtual void Start(); |
| 122 | virtual void Stop(); |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 123 | virtual bool TechnologyIs(Technology type) const; |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 124 | |
| 125 | private: |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 126 | FRIEND_TEST(CellularTest, Connect); |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 127 | FRIEND_TEST(CellularTest, GetCDMARegistrationState); |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 128 | FRIEND_TEST(CellularTest, GetCDMASignalQuality); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 129 | FRIEND_TEST(CellularTest, GetModemInfo); |
| 130 | FRIEND_TEST(CellularTest, GetModemStatus); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 131 | FRIEND_TEST(CellularTest, GetStateString); |
| 132 | FRIEND_TEST(CellularTest, GetTypeString); |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 133 | FRIEND_TEST(CellularTest, InitProxiesCDMA); |
| 134 | FRIEND_TEST(CellularTest, InitProxiesGSM); |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 135 | FRIEND_TEST(CellularTest, Start); |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame^] | 136 | FRIEND_TEST(CellularTest, StartConnected); |
| 137 | FRIEND_TEST(CellularTest, StartRegister); |
| 138 | |
| 139 | static const char kPhoneNumberCDMA[]; |
| 140 | static const char kPhoneNumberGSM[]; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 141 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 142 | void ConnectTask(const DBusPropertiesMap &properties); |
| 143 | |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame^] | 144 | // Invoked when the modem is connected to the cellular network to transition |
| 145 | // to the network-connected state and bring the network interface up. |
| 146 | void EstablishLink(); |
| 147 | |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 148 | Stringmaps EnumerateNetworks(); |
| 149 | StrIntPair SimLockStatusToProperty(); |
| 150 | void HelpRegisterDerivedStringmaps(const std::string &name, |
| 151 | Stringmaps(Cellular::*get)(void), |
| 152 | bool(Cellular::*set)(const Stringmaps&)); |
| 153 | void HelpRegisterDerivedStrIntPair(const std::string &name, |
| 154 | StrIntPair(Cellular::*get)(void), |
| 155 | bool(Cellular::*set)(const StrIntPair&)); |
| 156 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 157 | void InitProxies(); |
| 158 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 159 | std::string GetTypeString(); |
| 160 | std::string GetStateString(); |
| 161 | |
Darin Petkov | f5f61e0 | 2011-07-29 11:35:40 -0700 | [diff] [blame] | 162 | void EnableModem(); |
| 163 | void GetModemStatus(); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 164 | void GetGSMProperties(); |
| 165 | void RegisterGSMModem(); |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 166 | |
| 167 | // Obtains the modem identifiers: MEID for CDMA; IMEI, IMSI, SPN and MSISDN |
| 168 | // for GSM. |
| 169 | void GetModemIdentifiers(); |
| 170 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 171 | // Obtains modem's manufacturer, model ID, and hardware revision. |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 172 | void GetModemInfo(); |
Darin Petkov | f5f61e0 | 2011-07-29 11:35:40 -0700 | [diff] [blame] | 173 | |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 174 | void GetModemRegistrationState(); |
| 175 | void GetCDMARegistrationState(); |
| 176 | void GetGSMRegistrationState(); |
| 177 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 178 | // Processes a change in the modem registration state, possibly creating, |
| 179 | // destroying or updating the CellularService. |
| 180 | void HandleNewRegistrationState(); |
| 181 | |
| 182 | void CreateService(); |
| 183 | |
| 184 | void GetModemSignalQuality(); |
| 185 | uint32 GetCDMASignalQuality(); |
| 186 | uint32 GetGSMSignalQuality(); |
| 187 | |
| 188 | void HandleNewSignalQuality(uint32 strength); |
| 189 | |
| 190 | // Returns true if the modem is registered. Note that this method looks at the |
| 191 | // latest CDMA/GSM registration info obtained from the modem rather than the |
| 192 | // device |state_|. |
| 193 | bool IsModemRegistered(); |
| 194 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 195 | // Signal callbacks inherited from ModemCDMAProxyListener. |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 196 | virtual void OnCDMARegistrationStateChanged(uint32 state_1x, |
| 197 | uint32 state_evdo); |
| 198 | virtual void OnCDMASignalQualityChanged(uint32 strength); |
| 199 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 200 | // Signal callbacks inherited from ModemProxyListener. |
| 201 | virtual void OnModemStateChanged(uint32 old_state, |
| 202 | uint32 new_state, |
| 203 | uint32 reason); |
| 204 | |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 205 | Type type_; |
| 206 | State state_; |
Darin Petkov | bac9600 | 2011-08-09 13:22:00 -0700 | [diff] [blame^] | 207 | ModemState modem_state_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 208 | |
| 209 | const std::string dbus_owner_; // ModemManager.Modem |
| 210 | const std::string dbus_path_; // ModemManager.Modem |
| 211 | scoped_ptr<ModemProxyInterface> proxy_; |
Darin Petkov | e604f70 | 2011-07-28 15:51:17 -0700 | [diff] [blame] | 212 | scoped_ptr<ModemSimpleProxyInterface> simple_proxy_; |
Darin Petkov | bec79a2 | 2011-08-01 14:47:17 -0700 | [diff] [blame] | 213 | scoped_ptr<ModemCDMAProxyInterface> cdma_proxy_; |
| 214 | |
| 215 | CDMA cdma_; |
Darin Petkov | e9d12e0 | 2011-07-27 15:09:37 -0700 | [diff] [blame] | 216 | |
Darin Petkov | d966195 | 2011-08-03 16:25:42 -0700 | [diff] [blame] | 217 | CellularServiceRefPtr service_; |
Chris Masone | 853b81b | 2011-06-24 14:11:41 -0700 | [diff] [blame] | 218 | bool service_registered_; |
| 219 | |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 220 | ScopedRunnableMethodFactory<Cellular> task_factory_; |
| 221 | |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 222 | // Properties |
| 223 | bool allow_roaming_; |
| 224 | std::string carrier_; |
| 225 | std::string meid_; |
| 226 | std::string imei_; |
| 227 | std::string imsi_; |
| 228 | std::string esn_; |
| 229 | std::string mdn_; |
| 230 | std::string min_; |
| 231 | std::string model_id_; |
| 232 | std::string manufacturer_; |
| 233 | std::string firmware_revision_; |
| 234 | std::string hardware_revision_; |
Darin Petkov | ceb6817 | 2011-07-29 14:47:48 -0700 | [diff] [blame] | 235 | uint16 prl_version_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 236 | bool scanning_; |
| 237 | uint16 scan_interval_; |
Chris Masone | 889666b | 2011-07-03 12:58:50 -0700 | [diff] [blame] | 238 | std::vector<Network> found_networks_; |
| 239 | SimLockStatus sim_lock_status_; |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 240 | |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 241 | DISALLOW_COPY_AND_ASSIGN(Cellular); |
| 242 | }; |
| 243 | |
| 244 | } // namespace shill |
| 245 | |
| 246 | #endif // SHILL_CELLULAR_ |