blob: a735f227a02e21f7aa6bf6fc075dc5c889a9c6ef [file] [log] [blame]
Darin Petkov41c0e0a2012-01-09 16:38:53 +01001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Darin Petkov5c97ac52011-07-19 16:30:49 -07002// 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_MODEM_
6#define SHILL_MODEM_
7
8#include <string>
Hristo Stefanoved2c28c2011-11-29 15:37:30 -08009#include <vector>
Darin Petkov5c97ac52011-07-19 16:30:49 -070010
11#include <base/basictypes.h>
Jason Glasgow82f9ab32012-04-04 14:27:19 -040012#include <base/file_util.h>
Darin Petkov5c97ac52011-07-19 16:30:49 -070013#include <base/memory/scoped_ptr.h>
Darin Petkove0a312e2011-07-20 13:45:28 -070014#include <gtest/gtest_prod.h> // for FRIEND_TEST
15
David Rochbergfa1d31d2012-03-20 10:38:07 -040016#include "shill/cellular.h"
17#include "shill/dbus_objectmanager_proxy_interface.h"
Darin Petkove0a312e2011-07-20 13:45:28 -070018#include "shill/dbus_properties_proxy_interface.h"
19#include "shill/refptr_types.h"
Darin Petkov5c97ac52011-07-19 16:30:49 -070020
Darin Petkov137884a2011-10-26 18:52:47 +020021struct mobile_provider_db;
22
Darin Petkov5c97ac52011-07-19 16:30:49 -070023namespace shill {
24
25class ControlInterface;
Darin Petkov5c97ac52011-07-19 16:30:49 -070026class EventDispatcher;
27class Manager;
Thieu Le3426c8f2012-01-11 17:35:11 -080028class Metrics;
Darin Petkovab565bb2011-10-06 02:55:51 -070029class ProxyFactory;
Darin Petkov5c97ac52011-07-19 16:30:49 -070030
Darin Petkove0a312e2011-07-20 13:45:28 -070031// Handles an instance of ModemManager.Modem and an instance of a Cellular
32// device.
Eric Shienbrood11567d02012-04-10 18:08:49 -040033class Modem : public DBusPropertiesProxyDelegate {
Darin Petkov5c97ac52011-07-19 16:30:49 -070034 public:
Darin Petkove0a312e2011-07-20 13:45:28 -070035 // |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 Petkov5c97ac52011-07-19 16:30:49 -070038 Modem(const std::string &owner,
39 const std::string &path,
40 ControlInterface *control_interface,
41 EventDispatcher *dispatcher,
Thieu Le3426c8f2012-01-11 17:35:11 -080042 Metrics *metrics,
Darin Petkov137884a2011-10-26 18:52:47 +020043 Manager *manager,
44 mobile_provider_db *provider_db);
Darin Petkov5c97ac52011-07-19 16:30:49 -070045 ~Modem();
46
David Rochbergfa1d31d2012-03-20 10:38:07 -040047 // Asynchronously initializes support for the modem. If the
48 // |modem_properties| are valid and the MAC address is present,
49 // constructs and registers a Cellular device in |device_| based on
50 // |modem_properties|.
51 virtual void CreateDeviceFromModemProperties(
52 const DBusPropertiesMap &modem_properties);
Darin Petkove0a312e2011-07-20 13:45:28 -070053
Darin Petkov41c0e0a2012-01-09 16:38:53 +010054 void OnDeviceInfoAvailable(const std::string &link_name);
55
David Rochbergfa1d31d2012-03-20 10:38:07 -040056 const std::string &owner() const { return owner_; }
57 const std::string &path() const { return path_; }
Darin Petkove0a312e2011-07-20 13:45:28 -070058
David Rochbergfa1d31d2012-03-20 10:38:07 -040059 void set_type(Cellular::Type type) { type_ = type; }
60
61 protected:
Darin Petkove0a312e2011-07-20 13:45:28 -070062 static const char kPropertyLinkName[];
63 static const char kPropertyIPMethod[];
Darin Petkovbac96002011-08-09 13:22:00 -070064 static const char kPropertyState[];
Darin Petkove0a312e2011-07-20 13:45:28 -070065 static const char kPropertyType[];
Darin Petkove0a312e2011-07-20 13:45:28 -070066
Eric Shienbrood11567d02012-04-10 18:08:49 -040067 virtual void Init();
68
David Rochbergfa1d31d2012-03-20 10:38:07 -040069 ControlInterface *control_interface() const { return control_interface_; }
70 CellularRefPtr device() const { return device_; }
71 EventDispatcher *dispatcher() const { return dispatcher_; }
72 Manager *manager() const { return manager_; }
73 Metrics *metrics() const { return metrics_; }
74 mobile_provider_db *provider_db() const { return provider_db_; }
Darin Petkove0a312e2011-07-20 13:45:28 -070075
David Rochbergfa1d31d2012-03-20 10:38:07 -040076 virtual Cellular *ConstructCellular(const std::string &link_name,
77 const std::string &device_name,
78 int interface_index);
79 virtual Cellular::ModemState ConvertMmToCellularModemState(
80 uint32 input) const = 0;
81 virtual bool GetLinkName(const DBusPropertiesMap &properties,
82 std::string *name) const = 0;
Jason Glasgow4c0724a2012-04-17 15:47:40 -040083 // Returns the name of the DBUS Modem interface.
84 virtual std::string GetModemInterface(void) const = 0;
Darin Petkovc5f56562011-08-06 16:40:05 -070085
David Rochbergfa1d31d2012-03-20 10:38:07 -040086 private:
87 friend class ModemTest;
Jason Glasgow82f9ab32012-04-04 14:27:19 -040088 friend class Modem1Test;
89 FRIEND_TEST(Modem1Test, Init);
90 FRIEND_TEST(Modem1Test, CreateDeviceMM1);
David Rochbergfa1d31d2012-03-20 10:38:07 -040091 FRIEND_TEST(ModemManager1Test, Connect);
Jason Glasgow82f9ab32012-04-04 14:27:19 -040092 FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces);
David Rochbergfa1d31d2012-03-20 10:38:07 -040093 FRIEND_TEST(ModemManagerClassicTest, Connect);
94 FRIEND_TEST(ModemManagerCoreTest, ShouldAddModem);
95 FRIEND_TEST(ModemTest, CreateDeviceEarlyFailures);
96 FRIEND_TEST(ModemTest, EarlyDeviceProperties);
97 FRIEND_TEST(ModemTest, Init);
98 FRIEND_TEST(ModemTest, PendingDevicePropertiesAndCreate);
Darin Petkovab565bb2011-10-06 02:55:51 -070099
Eric Shienbrood11567d02012-04-10 18:08:49 -0400100 // Signal callbacks inherited from DBusPropertiesProxyDelegate.
101 virtual void OnDBusPropertiesChanged(
102 const std::string &interface,
103 const DBusPropertiesMap &changed_properties,
104 const std::vector<std::string> &invalidated_properties);
105 virtual void OnModemManagerPropertiesChanged(
106 const std::string &interface,
107 const DBusPropertiesMap &properties);
108
109 // A proxy to the org.freedesktop.DBusProperties interface used to obtain
110 // ModemManager.Modem properties and watch for property changes
111 scoped_ptr<DBusPropertiesProxyInterface> dbus_properties_proxy_;
112
David Rochbergfa1d31d2012-03-20 10:38:07 -0400113 DBusPropertiesMap initial_modem_properties_;
Darin Petkov5c97ac52011-07-19 16:30:49 -0700114
Darin Petkove0a312e2011-07-20 13:45:28 -0700115 const std::string owner_;
116 const std::string path_;
117
118 CellularRefPtr device_;
119
Darin Petkov5c97ac52011-07-19 16:30:49 -0700120 ControlInterface *control_interface_;
121 EventDispatcher *dispatcher_;
Thieu Le3426c8f2012-01-11 17:35:11 -0800122 Metrics *metrics_;
Darin Petkov5c97ac52011-07-19 16:30:49 -0700123 Manager *manager_;
Darin Petkov137884a2011-10-26 18:52:47 +0200124 mobile_provider_db *provider_db_;
Darin Petkov41c0e0a2012-01-09 16:38:53 +0100125 std::string link_name_;
David Rochbergfa1d31d2012-03-20 10:38:07 -0400126 Cellular::Type type_;
Darin Petkov41c0e0a2012-01-09 16:38:53 +0100127 bool pending_device_info_;
David Rochbergfa1d31d2012-03-20 10:38:07 -0400128 RTNLHandler *rtnl_handler_;
Darin Petkov5c97ac52011-07-19 16:30:49 -0700129
Jason Glasgow82f9ab32012-04-04 14:27:19 -0400130 // Store cached copies of singletons for speed/ease of testing.
131 ProxyFactory *proxy_factory_;
132
Darin Petkov5c97ac52011-07-19 16:30:49 -0700133 DISALLOW_COPY_AND_ASSIGN(Modem);
134};
135
Eric Shienbrood11567d02012-04-10 18:08:49 -0400136class ModemClassic : public Modem {
David Rochbergfa1d31d2012-03-20 10:38:07 -0400137 public:
138 ModemClassic(const std::string &owner,
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 Rochbergfa1d31d2012-03-20 10:38:07 -0400150 protected:
151 virtual Cellular::ModemState ConvertMmToCellularModemState(
152 uint32 input) const;
153 virtual bool GetLinkName(const DBusPropertiesMap &modem_properties,
154 std::string *name) const;
Jason Glasgow4c0724a2012-04-17 15:47:40 -0400155 virtual std::string GetModemInterface(void) const;
David Rochbergfa1d31d2012-03-20 10:38:07 -0400156
157 private:
158 DISALLOW_COPY_AND_ASSIGN(ModemClassic);
159};
160
161class Modem1 : public Modem {
David Rochbergfa1d31d2012-03-20 10:38:07 -0400162 public:
163 Modem1(const std::string &owner,
164 const std::string &path,
165 ControlInterface *control_interface,
166 EventDispatcher *dispatcher,
167 Metrics *metrics,
168 Manager *manager,
169 mobile_provider_db *provider_db);
170 virtual ~Modem1();
171
172 // Gathers information and passes it to CreateDeviceFromModemProperties.
173 void CreateDeviceMM1(const DBusInterfaceToProperties &i_to_p);
174
175 protected:
176 virtual Cellular::ModemState ConvertMmToCellularModemState(
177 uint32 input) const;
178 virtual bool GetLinkName(const DBusPropertiesMap &modem_properties,
179 std::string *name) const;
Jason Glasgow4c0724a2012-04-17 15:47:40 -0400180 virtual std::string GetModemInterface(void) const;
David Rochbergfa1d31d2012-03-20 10:38:07 -0400181
182 private:
Jason Glasgow82f9ab32012-04-04 14:27:19 -0400183 friend class Modem1Test;
184
185 FilePath netfiles_path_; // Used for testing
186
David Rochbergfa1d31d2012-03-20 10:38:07 -0400187 DISALLOW_COPY_AND_ASSIGN(Modem1);
188};
189
Darin Petkov5c97ac52011-07-19 16:30:49 -0700190} // namespace shill
191
192#endif // SHILL_MODEM_