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 | 887f298 | 2011-07-14 16:10:17 -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 | c54afe5 | 2014-11-05 10:28:08 -0800 | [diff] [blame] | 5 | #ifndef SHILL_CELLULAR_MODEM_MANAGER_H_ |
| 6 | #define SHILL_CELLULAR_MODEM_MANAGER_H_ |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 7 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 8 | #include <map> |
Alex Vakulenko | 8a53229 | 2014-06-16 17:18:44 -0700 | [diff] [blame] | 9 | #include <memory> |
Alex Vakulenko | a41ab51 | 2014-07-23 14:24:23 -0700 | [diff] [blame] | 10 | #include <string> |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 11 | #include <vector> |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 12 | |
Ben Chan | cc67c52 | 2014-09-03 07:19:18 -0700 | [diff] [blame] | 13 | #include <base/macros.h> |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 14 | #include <base/memory/weak_ptr.h> |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 15 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 16 | |
Ben Chan | c54afe5 | 2014-11-05 10:28:08 -0800 | [diff] [blame] | 17 | #include "shill/cellular/dbus_objectmanager_proxy_interface.h" |
| 18 | #include "shill/cellular/modem_info.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 19 | #include "shill/dbus_properties_proxy_interface.h" |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 20 | #include "shill/glib.h" |
| 21 | |
| 22 | namespace shill { |
| 23 | |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 24 | class ControlInterface; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 25 | class DBusObjectManagerProxyInterface; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 26 | class DBusPropertiesProxyInterface; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 27 | class Modem1; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 28 | class Modem; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 29 | class ModemClassic; |
Darin Petkov | c90fe52 | 2011-07-15 13:59:47 -0700 | [diff] [blame] | 30 | class ModemManagerProxyInterface; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 31 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 32 | // Handles a modem manager service and creates and destroys modem instances. |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 33 | class ModemManager { |
| 34 | public: |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 35 | ModemManager(ControlInterface* control_interface, |
| 36 | const std::string& service, |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 37 | const std::string& path, |
| 38 | ModemInfo* modem_info); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 39 | virtual ~ModemManager(); |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 40 | |
| 41 | // Starts watching for and handling the DBus modem manager service. |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 42 | virtual void Start() = 0; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 43 | |
| 44 | // Stops watching for the DBus modem manager service and destroys any |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 45 | // associated modems. |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 46 | virtual void Stop() = 0; |
Ben Chan | 66174a1 | 2014-01-08 21:27:00 -0800 | [diff] [blame] | 47 | |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 48 | void OnDeviceInfoAvailable(const std::string& link_name); |
Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 49 | |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 50 | protected: |
Ben Chan | e2ee5e0 | 2014-09-19 19:29:42 -0700 | [diff] [blame] | 51 | typedef std::map<std::string, std::shared_ptr<Modem>> Modems; |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 52 | |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 53 | const std::string& service() const { return service_; } |
| 54 | const std::string& path() const { return path_; } |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 55 | ControlInterface* control_interface() const { return control_interface_; } |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 56 | ModemInfo* modem_info() const { return modem_info_; } |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 57 | |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 58 | // Service availability callbacks. |
| 59 | void OnAppeared(); |
| 60 | void OnVanished(); |
| 61 | |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 62 | // Connect/Disconnect to a modem manager service. |
| 63 | // Inheriting classes must call this superclass method. |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 64 | virtual void Connect(); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 65 | // Inheriting classes must call this superclass method. |
| 66 | virtual void Disconnect(); |
| 67 | |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 68 | bool ModemExists(const std::string& path) const; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 69 | // Put the modem into our modem map |
Alex Vakulenko | 8a53229 | 2014-06-16 17:18:44 -0700 | [diff] [blame] | 70 | void RecordAddedModem(std::shared_ptr<Modem> modem); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 71 | |
| 72 | // Removes a modem on |path|. |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 73 | void RemoveModem(const std::string& path); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 74 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 75 | private: |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 76 | friend class ModemManagerCoreTest; |
| 77 | friend class ModemManagerClassicTest; |
| 78 | friend class ModemManager1Test; |
| 79 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 80 | FRIEND_TEST(ModemInfoTest, RegisterModemManager); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 81 | FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces); |
| 82 | FRIEND_TEST(ModemManager1Test, Connect); |
| 83 | FRIEND_TEST(ModemManagerClassicTest, Connect); |
| 84 | FRIEND_TEST(ModemManagerCoreTest, AddRemoveModem); |
Ben Chan | 66174a1 | 2014-01-08 21:27:00 -0800 | [diff] [blame] | 85 | FRIEND_TEST(ModemManagerCoreTest, ConnectDisconnect); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 86 | FRIEND_TEST(ModemManagerCoreTest, OnAppearVanish); |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 87 | |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 88 | ControlInterface* control_interface_; |
Darin Petkov | ab565bb | 2011-10-06 02:55:51 -0700 | [diff] [blame] | 89 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 90 | const std::string service_; |
| 91 | const std::string path_; |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 92 | bool service_connected_; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 93 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 94 | Modems modems_; // Maps a modem |path| to a modem instance. |
| 95 | |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 96 | ModemInfo* modem_info_; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 97 | |
| 98 | DISALLOW_COPY_AND_ASSIGN(ModemManager); |
| 99 | }; |
| 100 | |
Jason Glasgow | 9c09e36 | 2012-04-18 15:16:29 -0400 | [diff] [blame] | 101 | class ModemManagerClassic : public ModemManager { |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 102 | public: |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 103 | ModemManagerClassic(ControlInterface* control_interface, |
| 104 | const std::string& service, |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 105 | const std::string& path, |
| 106 | ModemInfo* modem_info); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 107 | |
Ben Chan | 5ea763b | 2014-08-13 11:07:54 -0700 | [diff] [blame] | 108 | ~ModemManagerClassic() override; |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 109 | |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 110 | void Start() override; |
| 111 | void Stop() override; |
| 112 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 113 | // Called by our dbus proxy |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 114 | void OnDeviceAdded(const std::string& path); |
| 115 | void OnDeviceRemoved(const std::string& path); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 116 | |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 117 | protected: |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 118 | void Connect() override; |
Yunlian Jiang | 6acd966 | 2015-01-30 08:36:10 -0800 | [diff] [blame] | 119 | void Disconnect() override; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 120 | |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 121 | virtual void AddModemClassic(const std::string& path); |
Alex Vakulenko | 8a53229 | 2014-06-16 17:18:44 -0700 | [diff] [blame] | 122 | virtual void InitModemClassic(std::shared_ptr<ModemClassic> modem); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 123 | |
| 124 | private: |
Ben Chan | c20ed13 | 2014-10-16 12:25:03 -0700 | [diff] [blame] | 125 | std::unique_ptr<ModemManagerProxyInterface> proxy_; // DBus service proxy |
| 126 | std::unique_ptr<DBusPropertiesProxyInterface> dbus_properties_proxy_; |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 127 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 128 | FRIEND_TEST(ModemManagerClassicTest, Connect); |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 129 | FRIEND_TEST(ModemManagerClassicTest, StartStop); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 130 | |
| 131 | DISALLOW_COPY_AND_ASSIGN(ModemManagerClassic); |
| 132 | }; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 133 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 134 | class ModemManager1 : public ModemManager { |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 135 | public: |
Peter Qiu | 608ec29 | 2015-07-30 15:46:16 -0700 | [diff] [blame] | 136 | ModemManager1(ControlInterface* control_interface, |
| 137 | const std::string& service, |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 138 | const std::string& path, |
| 139 | ModemInfo* modem_info); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 140 | |
Ben Chan | 5ea763b | 2014-08-13 11:07:54 -0700 | [diff] [blame] | 141 | ~ModemManager1() override; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 142 | |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 143 | void Start() override; |
| 144 | void Stop() override; |
| 145 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 146 | protected: |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 147 | void AddModem1(const std::string& path, |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 148 | const InterfaceToProperties& properties); |
Alex Vakulenko | 8a53229 | 2014-06-16 17:18:44 -0700 | [diff] [blame] | 149 | virtual void InitModem1(std::shared_ptr<Modem1> modem, |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 150 | const InterfaceToProperties& properties); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 151 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 152 | // ModemManager methods |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 153 | void Connect() override; |
Yunlian Jiang | 6acd966 | 2015-01-30 08:36:10 -0800 | [diff] [blame] | 154 | void Disconnect() override; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 155 | |
| 156 | // DBusObjectManagerProxyDelegate signal methods |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 157 | virtual void OnInterfacesAddedSignal( |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 158 | const std::string& object_path, |
| 159 | const InterfaceToProperties& properties); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 160 | virtual void OnInterfacesRemovedSignal( |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 161 | const std::string& object_path, |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 162 | const std::vector<std::string>& interfaces); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 163 | |
| 164 | // DBusObjectManagerProxyDelegate method callbacks |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 165 | virtual void OnGetManagedObjectsReply( |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 166 | const ObjectsWithProperties& objects_with_properties, |
Paul Stewart | f58b28e | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 167 | const Error& error); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 168 | |
| 169 | private: |
Ben Chan | 1e2ba23 | 2014-01-27 16:35:45 -0800 | [diff] [blame] | 170 | friend class ModemManager1Test; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 171 | FRIEND_TEST(ModemManager1Test, Connect); |
| 172 | FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces); |
Peter Qiu | 05d87e3 | 2015-08-14 23:46:21 -0700 | [diff] [blame^] | 173 | FRIEND_TEST(ModemManager1Test, StartStop); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 174 | |
Ben Chan | c20ed13 | 2014-10-16 12:25:03 -0700 | [diff] [blame] | 175 | std::unique_ptr<DBusObjectManagerProxyInterface> proxy_; |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 176 | base::WeakPtrFactory<ModemManager1> weak_ptr_factory_; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 177 | |
| 178 | DISALLOW_COPY_AND_ASSIGN(ModemManager1); |
| 179 | }; |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 180 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 181 | } // namespace shill |
| 182 | |
Ben Chan | c54afe5 | 2014-11-05 10:28:08 -0800 | [diff] [blame] | 183 | #endif // SHILL_CELLULAR_MODEM_MANAGER_H_ |