Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [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 | |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 5 | #ifndef SHILL_MODEM_H_ |
| 6 | #define SHILL_MODEM_H_ |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 7 | |
| 8 | #include <string> |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 9 | #include <vector> |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 10 | |
| 11 | #include <base/basictypes.h> |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 12 | #include <base/file_util.h> |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 13 | #include <base/memory/scoped_ptr.h> |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 14 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 15 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 16 | #include "shill/cellular.h" |
| 17 | #include "shill/dbus_objectmanager_proxy_interface.h" |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 18 | #include "shill/dbus_properties_proxy_interface.h" |
| 19 | #include "shill/refptr_types.h" |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 20 | |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 21 | struct mobile_provider_db; |
| 22 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 23 | namespace shill { |
| 24 | |
| 25 | class ControlInterface; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 26 | class EventDispatcher; |
| 27 | class Manager; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 28 | class Metrics; |
Darin Petkov | ab565bb | 2011-10-06 02:55:51 -0700 | [diff] [blame] | 29 | class ProxyFactory; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 30 | |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 31 | // Handles an instance of ModemManager.Modem and an instance of a Cellular |
| 32 | // device. |
Jason Glasgow | 9c09e36 | 2012-04-18 15:16:29 -0400 | [diff] [blame] | 33 | class Modem { |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 34 | public: |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 35 | // |owner| is the ModemManager DBus service owner (e.g., ":1.17"). |path| is |
| 36 | // the ModemManager.Modem DBus object path (e.g., |
| 37 | // "/org/chromium/ModemManager/Gobi/0"). |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 38 | Modem(const std::string &owner, |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 39 | const std::string &service, |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 40 | const std::string &path, |
| 41 | ControlInterface *control_interface, |
| 42 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 43 | Metrics *metrics, |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 44 | Manager *manager, |
| 45 | mobile_provider_db *provider_db); |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 46 | ~Modem(); |
| 47 | |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 48 | // Asynchronously initializes support for the modem. |
| 49 | // If the |properties| are valid and the MAC address is present, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 50 | // constructs and registers a Cellular device in |device_| based on |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 51 | // |properties|. |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 52 | virtual void CreateDeviceFromModemProperties( |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 53 | const DBusInterfaceToProperties &properties); |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 54 | |
Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 55 | void OnDeviceInfoAvailable(const std::string &link_name); |
| 56 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 57 | const std::string &owner() const { return owner_; } |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 58 | const std::string &service() const { return service_; } |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 59 | const std::string &path() const { return path_; } |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 60 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 61 | void set_type(Cellular::Type type) { type_ = type; } |
| 62 | |
| 63 | protected: |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 64 | static const char kPropertyLinkName[]; |
| 65 | static const char kPropertyIPMethod[]; |
| 66 | static const char kPropertyType[]; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 67 | |
Eric Shienbrood | 11567d0 | 2012-04-10 18:08:49 -0400 | [diff] [blame] | 68 | virtual void Init(); |
| 69 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 70 | ControlInterface *control_interface() const { return control_interface_; } |
| 71 | CellularRefPtr device() const { return device_; } |
| 72 | EventDispatcher *dispatcher() const { return dispatcher_; } |
| 73 | Manager *manager() const { return manager_; } |
| 74 | Metrics *metrics() const { return metrics_; } |
| 75 | mobile_provider_db *provider_db() const { return provider_db_; } |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 76 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 77 | virtual Cellular *ConstructCellular(const std::string &link_name, |
| 78 | const std::string &device_name, |
| 79 | int interface_index); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 80 | virtual bool GetLinkName(const DBusPropertiesMap &properties, |
| 81 | std::string *name) const = 0; |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 82 | // Returns the name of the DBUS Modem interface. |
| 83 | virtual std::string GetModemInterface(void) const = 0; |
Darin Petkov | c5f5656 | 2011-08-06 16:40:05 -0700 | [diff] [blame] | 84 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 85 | private: |
| 86 | friend class ModemTest; |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 87 | friend class Modem1Test; |
| 88 | FRIEND_TEST(Modem1Test, Init); |
| 89 | FRIEND_TEST(Modem1Test, CreateDeviceMM1); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 90 | FRIEND_TEST(ModemManager1Test, Connect); |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 91 | FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 92 | FRIEND_TEST(ModemManagerClassicTest, Connect); |
| 93 | FRIEND_TEST(ModemManagerCoreTest, ShouldAddModem); |
| 94 | FRIEND_TEST(ModemTest, CreateDeviceEarlyFailures); |
| 95 | FRIEND_TEST(ModemTest, EarlyDeviceProperties); |
| 96 | FRIEND_TEST(ModemTest, Init); |
| 97 | FRIEND_TEST(ModemTest, PendingDevicePropertiesAndCreate); |
Darin Petkov | ab565bb | 2011-10-06 02:55:51 -0700 | [diff] [blame] | 98 | |
Eric Shienbrood | 11567d0 | 2012-04-10 18:08:49 -0400 | [diff] [blame] | 99 | virtual void OnDBusPropertiesChanged( |
| 100 | const std::string &interface, |
| 101 | const DBusPropertiesMap &changed_properties, |
| 102 | const std::vector<std::string> &invalidated_properties); |
| 103 | virtual void OnModemManagerPropertiesChanged( |
| 104 | const std::string &interface, |
| 105 | const DBusPropertiesMap &properties); |
| 106 | |
| 107 | // A proxy to the org.freedesktop.DBusProperties interface used to obtain |
| 108 | // ModemManager.Modem properties and watch for property changes |
| 109 | scoped_ptr<DBusPropertiesProxyInterface> dbus_properties_proxy_; |
| 110 | |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 111 | DBusInterfaceToProperties initial_properties_; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 112 | |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 113 | const std::string owner_; |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 114 | const std::string service_; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 115 | const std::string path_; |
| 116 | |
| 117 | CellularRefPtr device_; |
| 118 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 119 | ControlInterface *control_interface_; |
| 120 | EventDispatcher *dispatcher_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 121 | Metrics *metrics_; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 122 | Manager *manager_; |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 123 | mobile_provider_db *provider_db_; |
Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 124 | std::string link_name_; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 125 | Cellular::Type type_; |
Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 126 | bool pending_device_info_; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 127 | RTNLHandler *rtnl_handler_; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 128 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 129 | // Store cached copies of singletons for speed/ease of testing. |
| 130 | ProxyFactory *proxy_factory_; |
| 131 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 132 | DISALLOW_COPY_AND_ASSIGN(Modem); |
| 133 | }; |
| 134 | |
Eric Shienbrood | 11567d0 | 2012-04-10 18:08:49 -0400 | [diff] [blame] | 135 | class ModemClassic : public Modem { |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 136 | public: |
| 137 | ModemClassic(const std::string &owner, |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 138 | const std::string &service, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 139 | const std::string &path, |
| 140 | ControlInterface *control_interface, |
| 141 | EventDispatcher *dispatcher, |
| 142 | Metrics *metrics, |
| 143 | Manager *manager, |
| 144 | mobile_provider_db *provider_db); |
| 145 | virtual ~ModemClassic(); |
| 146 | |
| 147 | // Gathers information and passes it to CreateDeviceFromModemProperties. |
| 148 | void CreateDeviceClassic(const DBusPropertiesMap &modem_properties); |
| 149 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 150 | protected: |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 151 | virtual bool GetLinkName(const DBusPropertiesMap &modem_properties, |
| 152 | std::string *name) const; |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 153 | virtual std::string GetModemInterface(void) const; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 154 | |
| 155 | private: |
| 156 | DISALLOW_COPY_AND_ASSIGN(ModemClassic); |
| 157 | }; |
| 158 | |
| 159 | class Modem1 : public Modem { |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 160 | public: |
| 161 | Modem1(const std::string &owner, |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 162 | const std::string &service, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 163 | const std::string &path, |
| 164 | ControlInterface *control_interface, |
| 165 | EventDispatcher *dispatcher, |
| 166 | Metrics *metrics, |
| 167 | Manager *manager, |
| 168 | mobile_provider_db *provider_db); |
| 169 | virtual ~Modem1(); |
| 170 | |
| 171 | // Gathers information and passes it to CreateDeviceFromModemProperties. |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 172 | void CreateDeviceMM1(const DBusInterfaceToProperties &properties); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 173 | |
| 174 | protected: |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 175 | virtual bool GetLinkName(const DBusPropertiesMap &modem_properties, |
| 176 | std::string *name) const; |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 177 | virtual std::string GetModemInterface(void) const; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 178 | |
| 179 | private: |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 180 | friend class Modem1Test; |
| 181 | |
| 182 | FilePath netfiles_path_; // Used for testing |
| 183 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 184 | DISALLOW_COPY_AND_ASSIGN(Modem1); |
| 185 | }; |
| 186 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 187 | } // namespace shill |
| 188 | |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 189 | #endif // SHILL_MODEM_H_ |