blob: c29c1cfed3524a401735f28939cb126979c3d2e3 [file] [log] [blame]
//
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include "shill/cellular/cellular_capability_universal.h"
#include <memory>
#include <utility>
#include <base/bind.h>
#include <base/stl_util.h>
#include <base/strings/string_util.h>
#include <chromeos/dbus/service_constants.h>
#include <ModemManager/ModemManager.h>
#include <string>
#include <vector>
#include "shill/adaptor_interfaces.h"
#include "shill/cellular/cellular_bearer.h"
#include "shill/cellular/cellular_service.h"
#include "shill/cellular/mobile_operator_info.h"
#include "shill/control_interface.h"
#include "shill/dbus_properties_proxy_interface.h"
#include "shill/device_id.h"
#include "shill/error.h"
#include "shill/logging.h"
#include "shill/pending_activation_store.h"
#include "shill/property_accessor.h"
#ifdef MM_MODEM_CDMA_REGISTRATION_STATE_UNKNOWN
#error "Do not include mm-modem.h"
#endif
using base::Bind;
using base::Closure;
using std::string;
using std::vector;
namespace shill {
namespace Logging {
static auto kModuleLogScope = ScopeLogger::kCellular;
static string ObjectID(CellularCapabilityUniversal* c) {
return c->cellular()->GetRpcIdentifier();
}
}
// static
const char CellularCapabilityUniversal::kConnectApn[] = "apn";
const char CellularCapabilityUniversal::kConnectUser[] = "user";
const char CellularCapabilityUniversal::kConnectPassword[] = "password";
const char CellularCapabilityUniversal::kConnectNumber[] = "number";
const char CellularCapabilityUniversal::kConnectAllowRoaming[] =
"allow-roaming";
const int64_t CellularCapabilityUniversal::kEnterPinTimeoutMilliseconds = 20000;
const int64_t
CellularCapabilityUniversal::kRegistrationDroppedUpdateTimeoutMilliseconds =
15000;
const char CellularCapabilityUniversal::kRootPath[] = "/";
const char CellularCapabilityUniversal::kStatusProperty[] = "status";
const char CellularCapabilityUniversal::kOperatorLongProperty[] =
"operator-long";
const char CellularCapabilityUniversal::kOperatorShortProperty[] =
"operator-short";
const char CellularCapabilityUniversal::kOperatorCodeProperty[] =
"operator-code";
const char CellularCapabilityUniversal::kOperatorAccessTechnologyProperty[] =
"access-technology";
const char CellularCapabilityUniversal::kAltairLTEMMPlugin[] = "Altair LTE";
const char CellularCapabilityUniversal::kNovatelLTEMMPlugin[] = "Novatel LTE";
const char CellularCapabilityUniversal::kTelitMMPlugin[] = "Telit";
const int CellularCapabilityUniversal::kSetPowerStateTimeoutMilliseconds =
20000;
namespace {
const char kConnectAllowedAuth[] = "allowed-auth";
const char kPhoneNumber[] = "*99#";
// This identifier is specified in the serviceproviders.prototxt file.
const char kVzwIdentifier[] = "c83d6597-dc91-4d48-a3a7-d86b80123751";
const size_t kVzwMdnLength = 10;
string AccessTechnologyToString(uint32_t access_technologies) {
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_LTE)
return kNetworkTechnologyLte;
if (access_technologies & (MM_MODEM_ACCESS_TECHNOLOGY_EVDO0 |
MM_MODEM_ACCESS_TECHNOLOGY_EVDOA |
MM_MODEM_ACCESS_TECHNOLOGY_EVDOB))
return kNetworkTechnologyEvdo;
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_1XRTT)
return kNetworkTechnology1Xrtt;
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_HSPA_PLUS)
return kNetworkTechnologyHspaPlus;
if (access_technologies & (MM_MODEM_ACCESS_TECHNOLOGY_HSPA |
MM_MODEM_ACCESS_TECHNOLOGY_HSUPA |
MM_MODEM_ACCESS_TECHNOLOGY_HSDPA))
return kNetworkTechnologyHspa;
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_UMTS)
return kNetworkTechnologyUmts;
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_EDGE)
return kNetworkTechnologyEdge;
if (access_technologies & MM_MODEM_ACCESS_TECHNOLOGY_GPRS)
return kNetworkTechnologyGprs;
if (access_technologies & (MM_MODEM_ACCESS_TECHNOLOGY_GSM_COMPACT |
MM_MODEM_ACCESS_TECHNOLOGY_GSM))
return kNetworkTechnologyGsm;
return "";
}
string AccessTechnologyToTechnologyFamily(uint32_t access_technologies) {
if (access_technologies & (MM_MODEM_ACCESS_TECHNOLOGY_LTE |
MM_MODEM_ACCESS_TECHNOLOGY_HSPA_PLUS |
MM_MODEM_ACCESS_TECHNOLOGY_HSPA |
MM_MODEM_ACCESS_TECHNOLOGY_HSUPA |
MM_MODEM_ACCESS_TECHNOLOGY_HSDPA |
MM_MODEM_ACCESS_TECHNOLOGY_UMTS |
MM_MODEM_ACCESS_TECHNOLOGY_EDGE |
MM_MODEM_ACCESS_TECHNOLOGY_GPRS |
MM_MODEM_ACCESS_TECHNOLOGY_GSM_COMPACT |
MM_MODEM_ACCESS_TECHNOLOGY_GSM))
return kTechnologyFamilyGsm;
if (access_technologies & (MM_MODEM_ACCESS_TECHNOLOGY_EVDO0 |
MM_MODEM_ACCESS_TECHNOLOGY_EVDOA |
MM_MODEM_ACCESS_TECHNOLOGY_EVDOB |
MM_MODEM_ACCESS_TECHNOLOGY_1XRTT))
return kTechnologyFamilyCdma;
return "";
}
} // namespace
CellularCapabilityUniversal::CellularCapabilityUniversal(Cellular* cellular,
ModemInfo* modem_info)
: CellularCapability(cellular, modem_info),
mobile_operator_info_(
new MobileOperatorInfo(cellular->dispatcher(), "ParseScanResult")),
registration_state_(MM_MODEM_3GPP_REGISTRATION_STATE_UNKNOWN),
current_capabilities_(MM_MODEM_CAPABILITY_NONE),
access_technologies_(MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN),
resetting_(false),
subscription_state_(kSubscriptionStateUnknown),
reset_done_(false),
registration_dropped_update_timeout_milliseconds_(
kRegistrationDroppedUpdateTimeoutMilliseconds),
weak_ptr_factory_(this) {
SLOG(this, 2) << "Cellular capability constructed: Universal";
mobile_operator_info_->Init();
HelpRegisterConstDerivedKeyValueStore(
kSIMLockStatusProperty,
&CellularCapabilityUniversal::SimLockStatusToProperty);
}
CellularCapabilityUniversal::~CellularCapabilityUniversal() {}
KeyValueStore CellularCapabilityUniversal::SimLockStatusToProperty(
Error* /*error*/) {
KeyValueStore status;
string lock_type;
switch (sim_lock_status_.lock_type) {
case MM_MODEM_LOCK_SIM_PIN:
lock_type = "sim-pin";
break;
case MM_MODEM_LOCK_SIM_PUK:
lock_type = "sim-puk";
break;
default:
lock_type = "";
break;
}
status.SetBool(kSIMLockEnabledProperty, sim_lock_status_.enabled);
status.SetString(kSIMLockTypeProperty, lock_type);
status.SetInt(kSIMLockRetriesLeftProperty, sim_lock_status_.retries_left);
return status;
}
void CellularCapabilityUniversal::HelpRegisterConstDerivedKeyValueStore(
const string& name,
KeyValueStore(CellularCapabilityUniversal::*get)(Error* error)) {
cellular()->mutable_store()->RegisterDerivedKeyValueStore(
name,
KeyValueStoreAccessor(
new CustomAccessor<CellularCapabilityUniversal, KeyValueStore>(
this, get, nullptr)));
}
void CellularCapabilityUniversal::InitProxies() {
modem_3gpp_proxy_ = control_interface()->CreateMM1ModemModem3gppProxy(
cellular()->dbus_path(), cellular()->dbus_service());
modem_proxy_ = control_interface()->CreateMM1ModemProxy(
cellular()->dbus_path(), cellular()->dbus_service());
modem_simple_proxy_ = control_interface()->CreateMM1ModemSimpleProxy(
cellular()->dbus_path(), cellular()->dbus_service());
modem_location_proxy_ = control_interface()->CreateMM1ModemLocationProxy(
cellular()->dbus_path(), cellular()->dbus_service());
modem_proxy_->set_state_changed_callback(
Bind(&CellularCapabilityUniversal::OnModemStateChangedSignal,
weak_ptr_factory_.GetWeakPtr()));
// Do not create a SIM proxy until the device is enabled because we
// do not yet know the object path of the sim object.
// TODO(jglasgow): register callbacks
}
void CellularCapabilityUniversal::StartModem(Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
InitProxies();
deferred_enable_modem_callback_.Reset();
EnableModem(true, error, callback);
}
void CellularCapabilityUniversal::EnableModem(bool deferrable,
Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__ << "(deferrable=" << deferrable << ")";
CHECK(!callback.is_null());
Error local_error(Error::kOperationInitiated);
modem_info()->metrics()->NotifyDeviceEnableStarted(
cellular()->interface_index());
modem_proxy_->Enable(
true,
&local_error,
Bind(&CellularCapabilityUniversal::EnableModemCompleted,
weak_ptr_factory_.GetWeakPtr(), deferrable, callback),
kTimeoutEnable);
if (local_error.IsFailure()) {
SLOG(this, 2) << __func__ << "Call to modem_proxy_->Enable() failed";
}
if (error) {
error->CopyFrom(local_error);
}
}
void CellularCapabilityUniversal::EnableModemCompleted(
bool deferrable, const ResultCallback& callback, const Error& error) {
SLOG(this, 3) << __func__ << "(deferrable=" << deferrable
<< ", error=" << error << ")";
// If the enable operation failed with Error::kWrongState, the modem is not
// in the expected state (i.e. disabled). If |deferrable| indicates that the
// enable operation can be deferred, we defer the operation until the modem
// goes into the expected state (see OnModemStateChangedSignal).
//
// Note that when the SIM is locked, the enable operation also fails with
// Error::kWrongState. The enable operation is deferred until the modem goes
// into the disabled state after the SIM is unlocked. We may choose not to
// defer the enable operation when the SIM is locked, but the UI needs to
// trigger the enable operation after the SIM is unlocked, which is currently
// not the case.
if (error.IsFailure()) {
if (!deferrable || error.type() != Error::kWrongState) {
callback.Run(error);
return;
}
if (deferred_enable_modem_callback_.is_null()) {
SLOG(this, 2) << "Defer enable operation.";
// The Enable operation to be deferred should not be further deferrable.
deferred_enable_modem_callback_ =
Bind(&CellularCapabilityUniversal::EnableModem,
weak_ptr_factory_.GetWeakPtr(),
false, // non-deferrable
nullptr,
callback);
}
if (IsLocationUpdateSupported()) {
ResultCallback setup_callback =
Bind(&CellularCapabilityUniversal::OnSetupLocationReply,
weak_ptr_factory_.GetWeakPtr());
SetupLocation(MM_MODEM_LOCATION_SOURCE_3GPP_LAC_CI, false,
setup_callback);
}
return;
}
// After modem is enabled, it should be possible to get properties
// TODO(jglasgow): handle errors from GetProperties
GetProperties();
// We expect the modem to start scanning after it has been enabled.
// Change this if this behavior is no longer the case in the future.
modem_info()->metrics()->NotifyDeviceEnableFinished(
cellular()->interface_index());
modem_info()->metrics()->NotifyDeviceScanStarted(
cellular()->interface_index());
callback.Run(error);
}
void CellularCapabilityUniversal::StopModem(Error* error,
const ResultCallback& callback) {
CHECK(!callback.is_null());
CHECK(error);
// If there is an outstanding registration change, simply ignore it since
// the service will be destroyed anyway.
if (!registration_dropped_update_callback_.IsCancelled()) {
registration_dropped_update_callback_.Cancel();
SLOG(this, 2) << __func__ << " Cancelled delayed deregister.";
}
// Some modems will implicitly disconnect the bearer when transitioning to
// low power state. For such modems, it's faster to let the modem disconnect
// the bearer. To do that, we just remove the bearer from the list so
// ModemManager doesn't try to disconnect it during disable.
Closure task;
if (cellular()->mm_plugin() == kAltairLTEMMPlugin) {
task = Bind(&CellularCapabilityUniversal::Stop_DeleteActiveBearer,
weak_ptr_factory_.GetWeakPtr(),
callback);
} else {
task = Bind(&CellularCapabilityUniversal::Stop_Disable,
weak_ptr_factory_.GetWeakPtr(),
callback);
}
cellular()->dispatcher()->PostTask(FROM_HERE, task);
deferred_enable_modem_callback_.Reset();
}
void CellularCapabilityUniversal::Stop_DeleteActiveBearer(
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
if (!active_bearer_) {
Stop_Disable(callback);
return;
}
Error error;
modem_proxy_->DeleteBearer(
active_bearer_->dbus_path(), &error,
Bind(&CellularCapabilityUniversal::Stop_DeleteActiveBearerCompleted,
weak_ptr_factory_.GetWeakPtr(), callback),
kTimeoutDefault);
if (error.IsFailure())
callback.Run(error);
}
void CellularCapabilityUniversal::Stop_DeleteActiveBearerCompleted(
const ResultCallback& callback, const Error& error) {
SLOG(this, 3) << __func__;
// Disregard the error from the bearer deletion since the disable will clean
// up any remaining bearers.
Stop_Disable(callback);
}
void CellularCapabilityUniversal::Stop_Disable(const ResultCallback& callback) {
SLOG(this, 3) << __func__;
Error error;
modem_info()->metrics()->NotifyDeviceDisableStarted(
cellular()->interface_index());
modem_proxy_->Enable(
false, &error,
Bind(&CellularCapabilityUniversal::Stop_DisableCompleted,
weak_ptr_factory_.GetWeakPtr(), callback),
kTimeoutEnable);
if (error.IsFailure())
callback.Run(error);
}
void CellularCapabilityUniversal::Stop_DisableCompleted(
const ResultCallback& callback, const Error& error) {
SLOG(this, 3) << __func__;
if (error.IsSuccess()) {
// The modem has been successfully disabled, but we still need to power it
// down.
Stop_PowerDown(callback);
} else {
// An error occurred; terminate the disable sequence.
callback.Run(error);
}
}
void CellularCapabilityUniversal::Stop_PowerDown(
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
Error error;
modem_proxy_->SetPowerState(
MM_MODEM_POWER_STATE_LOW,
&error,
Bind(&CellularCapabilityUniversal::Stop_PowerDownCompleted,
weak_ptr_factory_.GetWeakPtr(), callback),
kSetPowerStateTimeoutMilliseconds);
if (error.IsFailure())
// This really shouldn't happen, but if it does, report success,
// because a stop initiated power down is only called if the
// modem was successfully disabled, but the failure of this
// operation should still be propagated up as a successful disable.
Stop_PowerDownCompleted(callback, error);
}
// Note: if we were in the middle of powering down the modem when the
// system suspended, we might not get this event from
// ModemManager. And we might not even get a timeout from dbus-c++,
// because StartModem re-initializes proxies.
void CellularCapabilityUniversal::Stop_PowerDownCompleted(
const ResultCallback& callback,
const Error& error) {
SLOG(this, 3) << __func__;
if (error.IsFailure())
SLOG(this, 2) << "Ignoring error returned by SetPowerState: " << error;
// Since the disable succeeded, if power down fails, we currently fail
// silently, i.e. we need to report the disable operation as having
// succeeded.
modem_info()->metrics()->NotifyDeviceDisableFinished(
cellular()->interface_index());
ReleaseProxies();
callback.Run(Error());
}
void CellularCapabilityUniversal::Connect(const KeyValueStore& properties,
Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
RpcIdentifierCallback cb = Bind(&CellularCapabilityUniversal::OnConnectReply,
weak_ptr_factory_.GetWeakPtr(),
callback);
modem_simple_proxy_->Connect(properties, error, cb, kTimeoutConnect);
}
void CellularCapabilityUniversal::Disconnect(Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
if (modem_simple_proxy_.get()) {
SLOG(this, 2) << "Disconnect all bearers.";
// If "/" is passed as the bearer path, ModemManager will disconnect all
// bearers.
modem_simple_proxy_->Disconnect(kRootPath,
error,
callback,
kTimeoutDisconnect);
}
}
void CellularCapabilityUniversal::CompleteActivation(Error* error) {
SLOG(this, 3) << __func__;
// Persist the ICCID as "Pending Activation".
// We're assuming that when this function gets called,
// |cellular()->sim_identifier()| will be non-empty. We still check here that
// is non-empty, though something is wrong if it is empty.
const string& sim_identifier = cellular()->sim_identifier();
if (sim_identifier.empty()) {
SLOG(this, 2) << "SIM identifier not available. Nothing to do.";
return;
}
modem_info()->pending_activation_store()->SetActivationState(
PendingActivationStore::kIdentifierICCID,
sim_identifier,
PendingActivationStore::kStatePending);
UpdatePendingActivationState();
SLOG(this, 2) << "Resetting modem for activation.";
ResetAfterActivation();
}
void CellularCapabilityUniversal::ResetAfterActivation() {
SLOG(this, 3) << __func__;
// Here the initial call to Reset might fail in rare cases. Simply ignore.
Error error;
ResultCallback callback = Bind(
&CellularCapabilityUniversal::OnResetAfterActivationReply,
weak_ptr_factory_.GetWeakPtr());
Reset(&error, callback);
if (error.IsFailure())
SLOG(this, 2) << "Failed to reset after activation.";
}
void CellularCapabilityUniversal::OnResetAfterActivationReply(
const Error& error) {
SLOG(this, 3) << __func__;
if (error.IsFailure()) {
SLOG(this, 2) << "Failed to reset after activation. Try again later.";
// TODO(armansito): Maybe post a delayed reset task?
return;
}
reset_done_ = true;
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::UpdatePendingActivationState() {
SLOG(this, 3) << __func__;
const string& sim_identifier = cellular()->sim_identifier();
bool registered =
registration_state_ == MM_MODEM_3GPP_REGISTRATION_STATE_HOME;
// We know a service is activated if |subscription_state_| is
// kSubscriptionStateProvisioned / kSubscriptionStateOutOfData
// In the case that |subscription_state_| is kSubscriptionStateUnknown, we
// fallback on checking for a valid MDN.
bool activated =
((subscription_state_ == kSubscriptionStateProvisioned) ||
(subscription_state_ == kSubscriptionStateOutOfData)) ||
((subscription_state_ == kSubscriptionStateUnknown) && IsMdnValid());
if (activated && !sim_identifier.empty())
modem_info()->pending_activation_store()->RemoveEntry(
PendingActivationStore::kIdentifierICCID,
sim_identifier);
CellularServiceRefPtr service = cellular()->service();
if (!service.get())
return;
if (service->activation_state() == kActivationStateActivated)
// Either no service or already activated. Nothing to do.
return;
// If the ICCID is not available, the following logic can be delayed until it
// becomes available.
if (sim_identifier.empty())
return;
PendingActivationStore::State state =
modem_info()->pending_activation_store()->GetActivationState(
PendingActivationStore::kIdentifierICCID,
sim_identifier);
switch (state) {
case PendingActivationStore::kStatePending:
// Always mark the service as activating here, as the ICCID could have
// been unavailable earlier.
service->SetActivationState(kActivationStateActivating);
if (reset_done_) {
SLOG(this, 2) << "Post-payment activation reset complete.";
modem_info()->pending_activation_store()->SetActivationState(
PendingActivationStore::kIdentifierICCID,
sim_identifier,
PendingActivationStore::kStateActivated);
}
break;
case PendingActivationStore::kStateActivated:
if (registered) {
// Trigger auto connect here.
SLOG(this, 2) << "Modem has been reset at least once, try to "
<< "autoconnect to force MDN to update.";
service->AutoConnect();
}
break;
case PendingActivationStore::kStateUnknown:
// No entry exists for this ICCID. Nothing to do.
break;
default:
NOTREACHED();
}
}
string CellularCapabilityUniversal::GetMdnForOLP(
const MobileOperatorInfo* operator_info) const {
// TODO(benchan): This is ugly. Remove carrier specific code once we move
// mobile activation logic to carrier-specifc extensions (crbug.com/260073).
const string& mdn = cellular()->mdn();
if (!operator_info->IsMobileNetworkOperatorKnown()) {
// Can't make any carrier specific modifications.
return mdn;
}
if (operator_info->uuid() == kVzwIdentifier) {
// subscription_state_ is the definitive indicator of whether we need
// activation. The OLP expects an all zero MDN in that case.
if (subscription_state_ == kSubscriptionStateUnprovisioned || mdn.empty()) {
return string(kVzwMdnLength, '0');
}
if (mdn.length() > kVzwMdnLength) {
return mdn.substr(mdn.length() - kVzwMdnLength);
}
}
return mdn;
}
void CellularCapabilityUniversal::ReleaseProxies() {
SLOG(this, 3) << __func__;
modem_3gpp_proxy_.reset();
modem_proxy_.reset();
modem_location_proxy_.reset();
modem_simple_proxy_.reset();
// |sim_proxy_| is managed through OnSimPathChanged() and thus shouldn't be
// cleared here in order to keep it in sync with |sim_path_|.
}
bool CellularCapabilityUniversal::AreProxiesInitialized() const {
return (modem_3gpp_proxy_.get() && modem_proxy_.get() &&
modem_simple_proxy_.get() && sim_proxy_.get() &&
modem_location_proxy_.get());
}
void CellularCapabilityUniversal::UpdateServiceActivationState() {
if (!cellular()->service().get())
return;
const string& sim_identifier = cellular()->sim_identifier();
string activation_state;
PendingActivationStore::State state =
modem_info()->pending_activation_store()->GetActivationState(
PendingActivationStore::kIdentifierICCID,
sim_identifier);
if ((subscription_state_ == kSubscriptionStateUnknown ||
subscription_state_ == kSubscriptionStateUnprovisioned) &&
!sim_identifier.empty() &&
state == PendingActivationStore::kStatePending) {
activation_state = kActivationStateActivating;
} else if (IsServiceActivationRequired()) {
activation_state = kActivationStateNotActivated;
} else {
activation_state = kActivationStateActivated;
// Mark an activated service for auto-connect by default. Since data from
// the user profile will be loaded after the call to OnServiceCreated, this
// property will be corrected based on the user data at that time.
// NOTE: This function can be called outside the service initialization
// path so make sure we don't overwrite the auto-connect setting.
if (cellular()->service()->activation_state() != activation_state)
cellular()->service()->SetAutoConnect(true);
}
cellular()->service()->SetActivationState(activation_state);
}
void CellularCapabilityUniversal::OnServiceCreated() {
// ModemManager might have issued some property updates before the service
// object was created to receive the udpates, so we explicitly refresh the
// properties here.
GetProperties();
cellular()->service()->SetActivationType(CellularService::kActivationTypeOTA);
UpdateServiceActivationState();
// WORKAROUND:
// E362 modems on Verizon network does not properly redirect when a SIM
// runs out of credits, we need to enforce out-of-credits detection.
//
// The out-of-credits detection is also needed on ALT3100 modems until the PCO
// support is ready (crosbug.com/p/20461).
cellular()->service()->InitOutOfCreditsDetection(
GetOutOfCreditsDetectionType());
// Make sure that the network technology is set when the service gets
// created, just in case.
cellular()->service()->SetNetworkTechnology(GetNetworkTechnologyString());
}
void CellularCapabilityUniversal::SetupConnectProperties(
KeyValueStore* properties) {
apn_try_list_ = cellular()->BuildApnTryList();
FillConnectPropertyMap(properties);
}
void CellularCapabilityUniversal::FillConnectPropertyMap(
KeyValueStore* properties) {
// TODO(jglasgow): Is this really needed anymore?
properties->SetString(kConnectNumber, kPhoneNumber);
properties->SetBool(kConnectAllowRoaming,
cellular()->IsRoamingAllowedOrRequired());
if (!apn_try_list_.empty()) {
// Leave the APN at the front of the list, so that it can be recorded
// if the connect attempt succeeds.
Stringmap apn_info = apn_try_list_.front();
SLOG(this, 2) << __func__ << ": Using APN " << apn_info[kApnProperty];
properties->SetString(kConnectApn, apn_info[kApnProperty]);
if (base::ContainsKey(apn_info, kApnUsernameProperty))
properties->SetString(kConnectUser, apn_info[kApnUsernameProperty]);
if (base::ContainsKey(apn_info, kApnPasswordProperty))
properties->SetString(kConnectPassword, apn_info[kApnPasswordProperty]);
if (base::ContainsKey(apn_info, kApnAuthenticationProperty)) {
properties->SetString(kConnectAllowedAuth,
apn_info[kApnAuthenticationProperty]);
}
}
}
void CellularCapabilityUniversal::OnConnectReply(const ResultCallback& callback,
const string& path,
const Error& error) {
SLOG(this, 3) << __func__ << "(" << error << ")";
CellularServiceRefPtr service = cellular()->service();
if (!service) {
// The service could have been deleted before our Connect() request
// completes if the modem was enabled and then quickly disabled.
apn_try_list_.clear();
} else if (error.IsFailure()) {
service->ClearLastGoodApn();
// The APN that was just tried (and failed) is still at the
// front of the list, about to be removed. If the list is empty
// after that, try one last time without an APN. This may succeed
// with some modems in some cases.
if (RetriableConnectError(error) && !apn_try_list_.empty()) {
apn_try_list_.pop_front();
SLOG(this, 2) << "Connect failed with invalid APN, "
<< apn_try_list_.size() << " remaining APNs to try";
KeyValueStore props;
FillConnectPropertyMap(&props);
Error error;
Connect(props, &error, callback);
return;
}
} else {
if (!apn_try_list_.empty()) {
service->SetLastGoodApn(apn_try_list_.front());
apn_try_list_.clear();
}
SLOG(this, 2) << "Connected bearer " << path;
}
if (!callback.is_null())
callback.Run(error);
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::GetProperties() {
SLOG(this, 3) << __func__;
std::unique_ptr<DBusPropertiesProxyInterface> properties_proxy =
control_interface()->CreateDBusPropertiesProxy(
cellular()->dbus_path(), cellular()->dbus_service());
KeyValueStore properties(
properties_proxy->GetAll(MM_DBUS_INTERFACE_MODEM));
OnModemPropertiesChanged(properties, vector<string>());
properties = properties_proxy->GetAll(MM_DBUS_INTERFACE_MODEM_MODEM3GPP);
OnModem3gppPropertiesChanged(properties, vector<string>());
}
void CellularCapabilityUniversal::UpdateServiceOLP() {
SLOG(this, 3) << __func__;
// OLP is based off of the Home Provider.
if (!cellular()->home_provider_info()->IsMobileNetworkOperatorKnown()) {
return;
}
const vector<MobileOperatorInfo::OnlinePortal>& olp_list =
cellular()->home_provider_info()->olp_list();
if (olp_list.empty()) {
return;
}
if (olp_list.size() > 1) {
SLOG(this, 1) << "Found multiple online portals. Choosing the first.";
}
string post_data = olp_list[0].post_data;
base::ReplaceSubstringsAfterOffset(
&post_data, 0, "${iccid}", cellular()->sim_identifier());
base::ReplaceSubstringsAfterOffset(
&post_data, 0, "${imei}", cellular()->imei());
base::ReplaceSubstringsAfterOffset(
&post_data, 0, "${imsi}", cellular()->imsi());
base::ReplaceSubstringsAfterOffset(
&post_data, 0, "${mdn}", GetMdnForOLP(cellular()->home_provider_info()));
base::ReplaceSubstringsAfterOffset(
&post_data, 0, "${min}", cellular()->min());
cellular()->service()->SetOLP(olp_list[0].url, olp_list[0].method, post_data);
}
void CellularCapabilityUniversal::UpdateActiveBearer() {
SLOG(this, 3) << __func__;
// Look for the first active bearer and use its path as the connected
// one. Right now, we don't allow more than one active bearer.
active_bearer_.reset();
for (const auto& path : bearer_paths_) {
auto bearer = std::make_unique<CellularBearer>(
control_interface(), path, cellular()->dbus_service());
// The bearer object may have vanished before ModemManager updates the
// 'Bearers' property.
if (!bearer->Init())
continue;
if (!bearer->connected())
continue;
SLOG(this, 2) << "Found active bearer \"" << path << "\".";
CHECK(!active_bearer_) << "Found more than one active bearer.";
active_bearer_ = std::move(bearer);
}
if (!active_bearer_)
SLOG(this, 2) << "No active bearer found.";
}
bool CellularCapabilityUniversal::IsServiceActivationRequired() const {
const string& sim_identifier = cellular()->sim_identifier();
// subscription_state_ is the definitive answer. If that does not work,
// fallback on MDN based logic.
if (subscription_state_ == kSubscriptionStateProvisioned ||
subscription_state_ == kSubscriptionStateOutOfData)
return false;
// We are in the process of activating, ignore all other clues from the
// network and use our own knowledge about the activation state.
if (!sim_identifier.empty() &&
modem_info()->pending_activation_store()->GetActivationState(
PendingActivationStore::kIdentifierICCID,
sim_identifier) != PendingActivationStore::kStateUnknown)
return false;
// Network notification that the service needs to be activated.
if (subscription_state_ == kSubscriptionStateUnprovisioned)
return true;
// If there is no online payment portal information, it's safer to assume
// the service does not require activation.
if (!cellular()->home_provider_info()->IsMobileNetworkOperatorKnown() ||
cellular()->home_provider_info()->olp_list().empty()) {
return false;
}
// If the MDN is invalid (i.e. empty or contains only zeros), the service
// requires activation.
return !IsMdnValid();
}
bool CellularCapabilityUniversal::IsMdnValid() const {
const string& mdn = cellular()->mdn();
// Note that |mdn| is normalized to contain only digits in OnMdnChanged().
for (size_t i = 0; i < mdn.size(); ++i) {
if (mdn[i] != '0')
return true;
}
return false;
}
// always called from an async context
void CellularCapabilityUniversal::Register(const ResultCallback& callback) {
SLOG(this, 3) << __func__ << " \"" << cellular()->selected_network()
<< "\"";
CHECK(!callback.is_null());
Error error;
ResultCallback cb = Bind(&CellularCapabilityUniversal::OnRegisterReply,
weak_ptr_factory_.GetWeakPtr(), callback);
modem_3gpp_proxy_->Register(cellular()->selected_network(), &error, cb,
kTimeoutRegister);
if (error.IsFailure())
callback.Run(error);
}
void CellularCapabilityUniversal::RegisterOnNetwork(
const string& network_id,
Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__ << "(" << network_id << ")";
CHECK(error);
desired_network_ = network_id;
ResultCallback cb = Bind(&CellularCapabilityUniversal::OnRegisterReply,
weak_ptr_factory_.GetWeakPtr(), callback);
modem_3gpp_proxy_->Register(network_id, error, cb, kTimeoutRegister);
}
void CellularCapabilityUniversal::OnRegisterReply(
const ResultCallback& callback,
const Error& error) {
SLOG(this, 3) << __func__ << "(" << error << ")";
if (error.IsSuccess()) {
cellular()->set_selected_network(desired_network_);
desired_network_.clear();
callback.Run(error);
return;
}
// If registration on the desired network failed,
// try to register on the home network.
if (!desired_network_.empty()) {
desired_network_.clear();
cellular()->set_selected_network("");
LOG(INFO) << "Couldn't register on selected network, trying home network";
Register(callback);
return;
}
callback.Run(error);
}
bool CellularCapabilityUniversal::IsRegistered() const {
return IsRegisteredState(registration_state_);
}
bool CellularCapabilityUniversal::IsRegisteredState(
MMModem3gppRegistrationState state) {
return (state == MM_MODEM_3GPP_REGISTRATION_STATE_HOME ||
state == MM_MODEM_3GPP_REGISTRATION_STATE_ROAMING);
}
void CellularCapabilityUniversal::SetUnregistered(bool searching) {
// If we're already in some non-registered state, don't override that
if (registration_state_ == MM_MODEM_3GPP_REGISTRATION_STATE_HOME ||
registration_state_ == MM_MODEM_3GPP_REGISTRATION_STATE_ROAMING) {
registration_state_ =
(searching ? MM_MODEM_3GPP_REGISTRATION_STATE_SEARCHING :
MM_MODEM_3GPP_REGISTRATION_STATE_IDLE);
}
}
void CellularCapabilityUniversal::RequirePIN(
const string& pin, bool require,
Error* error, const ResultCallback& callback) {
CHECK(error);
sim_proxy_->EnablePin(pin, require, error, callback, kTimeoutDefault);
}
void CellularCapabilityUniversal::EnterPIN(const string& pin,
Error* error,
const ResultCallback& callback) {
CHECK(error);
SLOG(this, 3) << __func__;
sim_proxy_->SendPin(pin, error, callback, kEnterPinTimeoutMilliseconds);
}
void CellularCapabilityUniversal::UnblockPIN(const string& unblock_code,
const string& pin,
Error* error,
const ResultCallback& callback) {
CHECK(error);
sim_proxy_->SendPuk(unblock_code, pin, error, callback, kTimeoutDefault);
}
void CellularCapabilityUniversal::ChangePIN(
const string& old_pin, const string& new_pin,
Error* error, const ResultCallback& callback) {
CHECK(error);
sim_proxy_->ChangePin(old_pin, new_pin, error, callback, kTimeoutDefault);
}
void CellularCapabilityUniversal::Reset(Error* error,
const ResultCallback& callback) {
SLOG(this, 3) << __func__;
CHECK(error);
if (resetting_) {
Error::PopulateAndLog(FROM_HERE, error, Error::kInProgress,
"Already resetting");
return;
}
ResultCallback cb = Bind(&CellularCapabilityUniversal::OnResetReply,
weak_ptr_factory_.GetWeakPtr(), callback);
modem_proxy_->Reset(error, cb, kTimeoutReset);
if (!error->IsFailure()) {
resetting_ = true;
}
}
void CellularCapabilityUniversal::OnResetReply(const ResultCallback& callback,
const Error& error) {
SLOG(this, 3) << __func__;
resetting_ = false;
if (!callback.is_null())
callback.Run(error);
}
void CellularCapabilityUniversal::Scan(
Error* error,
const ResultStringmapsCallback& callback) {
KeyValueStoresCallback cb = Bind(&CellularCapabilityUniversal::OnScanReply,
weak_ptr_factory_.GetWeakPtr(), callback);
modem_3gpp_proxy_->Scan(error, cb, kTimeoutScan);
}
void CellularCapabilityUniversal::OnScanReply(
const ResultStringmapsCallback& callback,
const ScanResults& results,
const Error& error) {
Stringmaps found_networks;
for (const auto& result : results)
found_networks.push_back(ParseScanResult(result));
callback.Run(found_networks, error);
}
Stringmap CellularCapabilityUniversal::ParseScanResult(
const ScanResult& result) {
/* ScanResults contain the following keys:
"status"
A MMModem3gppNetworkAvailability value representing network
availability status, given as an unsigned integer (signature "u").
This key will always be present.
"operator-long"
Long-format name of operator, given as a string value (signature
"s"). If the name is unknown, this field should not be present.
"operator-short"
Short-format name of operator, given as a string value
(signature "s"). If the name is unknown, this field should not
be present.
"operator-code"
Mobile code of the operator, given as a string value (signature
"s"). Returned in the format "MCCMNC", where MCC is the
three-digit ITU E.212 Mobile Country Code and MNC is the two- or
three-digit GSM Mobile Network Code. e.g. "31026" or "310260".
"access-technology"
A MMModemAccessTechnology value representing the generic access
technology used by this mobile network, given as an unsigned
integer (signature "u").
*/
Stringmap parsed;
if (result.ContainsUint(kStatusProperty)) {
uint32_t status = result.GetUint(kStatusProperty);
// numerical values are taken from 3GPP TS 27.007 Section 7.3.
static const char* const kStatusString[] = {
"unknown", // MM_MODEM_3GPP_NETWORK_AVAILABILITY_UNKNOWN
"available", // MM_MODEM_3GPP_NETWORK_AVAILABILITY_AVAILABLE
"current", // MM_MODEM_3GPP_NETWORK_AVAILABILITY_CURRENT
"forbidden", // MM_MODEM_3GPP_NETWORK_AVAILABILITY_FORBIDDEN
};
parsed[kStatusProperty] = kStatusString[status];
}
// MMModemAccessTechnology
if (result.ContainsUint(kOperatorAccessTechnologyProperty)) {
parsed[kTechnologyProperty] =
AccessTechnologyToString(
result.GetUint(kOperatorAccessTechnologyProperty));
}
string operator_long, operator_short, operator_code;
if (result.ContainsString(kOperatorLongProperty))
parsed[kLongNameProperty] = result.GetString(kOperatorLongProperty);
if (result.ContainsString(kOperatorShortProperty))
parsed[kShortNameProperty] = result.GetString(kOperatorShortProperty);
if (result.ContainsString(kOperatorCodeProperty))
parsed[kNetworkIdProperty] = result.GetString(kOperatorCodeProperty);
// If the long name is not available but the network ID is, look up the long
// name in the mobile provider database.
if ((!base::ContainsKey(parsed, kLongNameProperty) ||
parsed[kLongNameProperty].empty()) &&
base::ContainsKey(parsed, kNetworkIdProperty)) {
mobile_operator_info_->Reset();
mobile_operator_info_->UpdateMCCMNC(parsed[kNetworkIdProperty]);
if (mobile_operator_info_->IsMobileNetworkOperatorKnown() &&
!mobile_operator_info_->operator_name().empty()) {
parsed[kLongNameProperty] = mobile_operator_info_->operator_name();
}
}
return parsed;
}
void CellularCapabilityUniversal::SetupLocation(
uint32_t sources,
bool signal_location,
const ResultCallback& callback) {
Error error;
modem_location_proxy_->Setup(sources, signal_location, &error, callback,
kTimeoutSetupLocation);
}
void CellularCapabilityUniversal::OnSetupLocationReply(const Error& error) {
SLOG(this, 3) << __func__;
if (error.IsFailure()) {
// Not fatal: most devices already enable this when
// ModemManager starts. This failure is only likely for devices
// which don't support location gathering.
SLOG(this, 2) << "Failed to setup modem location capability.";
return;
}
}
void CellularCapabilityUniversal::GetLocation(const StringCallback& callback) {
BrilloAnyCallback cb = Bind(&CellularCapabilityUniversal::OnGetLocationReply,
weak_ptr_factory_.GetWeakPtr(), callback);
Error error;
modem_location_proxy_->GetLocation(&error, cb, kTimeoutGetLocation);
}
void CellularCapabilityUniversal::OnGetLocationReply(
const StringCallback& callback,
const std::map<uint32_t, brillo::Any>& results,
const Error& error) {
SLOG(this, 3) << __func__;
if (error.IsFailure()) {
SLOG(this, 2) << "Error getting location.";
return;
}
// For 3G modems we currently only care about the "MCC,MNC,LAC,CI" location
auto it = results.find(MM_MODEM_LOCATION_SOURCE_3GPP_LAC_CI);
if (it != results.end()) {
brillo::Any gpp_value = it->second;
const string& location_string = gpp_value.Get<const string>();
callback.Run(location_string, Error());
} else {
callback.Run(std::string(), Error());
}
}
bool CellularCapabilityUniversal::IsLocationUpdateSupported() {
// Whitelist modems as they're tested / needed
return cellular()->mm_plugin() == kTelitMMPlugin;
}
CellularBearer* CellularCapabilityUniversal::GetActiveBearer() const {
return active_bearer_.get();
}
string CellularCapabilityUniversal::GetNetworkTechnologyString() const {
// If we know that the modem is an E362 modem supported by the Novatel LTE
// plugin, return LTE here to make sure that Chrome sees LTE as the network
// technology even if the actual technology is unknown.
//
// This hack will cause the UI to display LTE even if the modem doesn't
// support it at a given time. This might be problematic if we ever want to
// support switching between access technologies (e.g. falling back to 3G
// when LTE is not available).
if (cellular()->mm_plugin() == kNovatelLTEMMPlugin)
return kNetworkTechnologyLte;
// Order is important. Return the highest speed technology
// TODO(jglasgow): change shill interfaces to a capability model
return AccessTechnologyToString(access_technologies_);
}
string CellularCapabilityUniversal::GetRoamingStateString() const {
switch (registration_state_) {
case MM_MODEM_3GPP_REGISTRATION_STATE_HOME:
return kRoamingStateHome;
case MM_MODEM_3GPP_REGISTRATION_STATE_ROAMING:
return kRoamingStateRoaming;
default:
break;
}
return kRoamingStateUnknown;
}
// TODO(armansito): Remove this method once cromo is deprecated.
void CellularCapabilityUniversal::GetSignalQuality() {
// ModemManager always returns the cached value, so there is no need to
// trigger an update here. The true value is updated through a property
// change signal.
}
string CellularCapabilityUniversal::GetTypeString() const {
return AccessTechnologyToTechnologyFamily(access_technologies_);
}
void CellularCapabilityUniversal::OnModemPropertiesChanged(
const KeyValueStore& properties,
const vector<string>& /* invalidated_properties */) {
// Update the bearers property before the modem state property as
// OnModemStateChanged may call UpdateActiveBearer, which reads the bearers
// property.
if (properties.ContainsRpcIdentifiers(MM_MODEM_PROPERTY_BEARERS)) {
RpcIdentifiers bearers =
properties.GetRpcIdentifiers(MM_MODEM_PROPERTY_BEARERS);
OnBearersChanged(bearers);
}
// This solves a bootstrapping problem: If the modem is not yet
// enabled, there are no proxy objects associated with the capability
// object, so modem signals like StateChanged aren't seen. By monitoring
// changes to the State property via the ModemManager, we're able to
// get the initialization process started, which will result in the
// creation of the proxy objects.
//
// The first time we see the change to State (when the modem state
// is Unknown), we simply update the state, and rely on the Manager to
// enable the device when it is registered with the Manager. On subsequent
// changes to State, we need to explicitly enable the device ourselves.
if (properties.ContainsInt(MM_MODEM_PROPERTY_STATE)) {
int32_t istate = properties.GetInt(MM_MODEM_PROPERTY_STATE);
Cellular::ModemState state = static_cast<Cellular::ModemState>(istate);
OnModemStateChanged(state);
}
if (properties.ContainsRpcIdentifier(MM_MODEM_PROPERTY_SIM))
OnSimPathChanged(properties.GetRpcIdentifier(MM_MODEM_PROPERTY_SIM));
if (properties.ContainsUint32s(MM_MODEM_PROPERTY_SUPPORTEDCAPABILITIES)) {
OnSupportedCapabilitesChanged(
properties.GetUint32s(MM_MODEM_PROPERTY_SUPPORTEDCAPABILITIES));
}
if (properties.ContainsUint(MM_MODEM_PROPERTY_CURRENTCAPABILITIES)) {
OnModemCurrentCapabilitiesChanged(
properties.GetUint(MM_MODEM_PROPERTY_CURRENTCAPABILITIES));
}
// not needed: MM_MODEM_PROPERTY_MAXBEARERS
// not needed: MM_MODEM_PROPERTY_MAXACTIVEBEARERS
if (properties.ContainsString(MM_MODEM_PROPERTY_MANUFACTURER)) {
cellular()->set_manufacturer(
properties.GetString(MM_MODEM_PROPERTY_MANUFACTURER));
}
if (properties.ContainsString(MM_MODEM_PROPERTY_MODEL)) {
cellular()->set_model_id(properties.GetString(MM_MODEM_PROPERTY_MODEL));
}
if (properties.ContainsString(MM_MODEM_PROPERTY_PLUGIN)) {
cellular()->set_mm_plugin(properties.GetString(MM_MODEM_PROPERTY_PLUGIN));
}
if (properties.ContainsString(MM_MODEM_PROPERTY_REVISION)) {
OnModemRevisionChanged(properties.GetString(MM_MODEM_PROPERTY_REVISION));
}
if (properties.ContainsString(MM_MODEM_PROPERTY_HARDWAREREVISION)) {
OnModemHardwareRevisionChanged(properties.GetString(MM_MODEM_PROPERTY_HARDWAREREVISION));
}
if (properties.ContainsString(MM_MODEM_PROPERTY_DEVICE)) {
OnModemDevicePathChanged(properties.GetString(MM_MODEM_PROPERTY_DEVICE));
}
// not needed: MM_MODEM_PROPERTY_DEVICEIDENTIFIER
// not needed: MM_MODEM_PROPERTY_DRIVER
if (properties.ContainsString(MM_MODEM_PROPERTY_EQUIPMENTIDENTIFIER)) {
cellular()->set_equipment_id(
properties.GetString(MM_MODEM_PROPERTY_EQUIPMENTIDENTIFIER));
}
// Unlock required and SimLock
bool lock_status_changed = false;
if (properties.ContainsUint(MM_MODEM_PROPERTY_UNLOCKREQUIRED)) {
uint32_t unlock_required =
properties.GetUint(MM_MODEM_PROPERTY_UNLOCKREQUIRED);
OnLockTypeChanged(static_cast<MMModemLock>(unlock_required));
lock_status_changed = true;
}
// Unlock retries
if (properties.Contains(MM_MODEM_PROPERTY_UNLOCKRETRIES)) {
OnLockRetriesChanged(
properties.Get(MM_MODEM_PROPERTY_UNLOCKRETRIES).Get<LockRetryData>());
lock_status_changed = true;
}
if (lock_status_changed)
OnSimLockStatusChanged();
if (properties.ContainsUint(MM_MODEM_PROPERTY_ACCESSTECHNOLOGIES)) {
OnAccessTechnologiesChanged(
properties.GetUint(MM_MODEM_PROPERTY_ACCESSTECHNOLOGIES));
}
if (properties.Contains(MM_MODEM_PROPERTY_SIGNALQUALITY)) {
SignalQuality quality =
properties.Get(MM_MODEM_PROPERTY_SIGNALQUALITY).Get<SignalQuality>();
OnSignalQualityChanged(std::get<0>(quality));
}
if (properties.ContainsStrings(MM_MODEM_PROPERTY_OWNNUMBERS)) {
vector<string> numbers =
properties.GetStrings(MM_MODEM_PROPERTY_OWNNUMBERS);
string mdn;
if (numbers.size() > 0)
mdn = numbers[0];
OnMdnChanged(mdn);
}
if (properties.Contains(MM_MODEM_PROPERTY_SUPPORTEDMODES)) {
SupportedModes mm_supported_modes =
properties.Get(MM_MODEM_PROPERTY_SUPPORTEDMODES).Get<SupportedModes>();
vector<ModemModes> supported_modes;
for (const auto& modes : mm_supported_modes) {
supported_modes.push_back(
ModemModes(std::get<0>(modes),
static_cast<MMModemMode>(std::get<1>(modes))));
}
OnSupportedModesChanged(supported_modes);
}
if (properties.Contains(MM_MODEM_PROPERTY_CURRENTMODES)) {
ModesData current_modes =
properties.Get(MM_MODEM_PROPERTY_CURRENTMODES).Get<ModesData>();
OnCurrentModesChanged(
ModemModes(std::get<0>(current_modes),
static_cast<MMModemMode>(std::get<1>(current_modes))));
}
// au: MM_MODEM_PROPERTY_SUPPORTEDBANDS,
// au: MM_MODEM_PROPERTY_BANDS
}
void CellularCapabilityUniversal::OnPropertiesChanged(
const string& interface,
const KeyValueStore& changed_properties,
const vector<string>& invalidated_properties) {
SLOG(this, 3) << __func__ << "(" << interface << ")";
if (interface == MM_DBUS_INTERFACE_MODEM) {
OnModemPropertiesChanged(changed_properties, invalidated_properties);
}
if (interface == MM_DBUS_INTERFACE_MODEM_MODEM3GPP) {
OnModem3gppPropertiesChanged(changed_properties, invalidated_properties);
}
if (interface == MM_DBUS_INTERFACE_SIM) {
OnSimPropertiesChanged(changed_properties, invalidated_properties);
}
}
bool CellularCapabilityUniversal::RetriableConnectError(
const Error& error) const {
if (error.type() == Error::kInvalidApn)
return true;
// ModemManager does not ever return kInvalidApn for an E362 modem (with
// firmware version 1.41) supported by the Novatel LTE plugin.
if ((cellular()->mm_plugin() == kNovatelLTEMMPlugin) &&
(error.type() == Error::kOperationFailed)) {
return true;
}
return false;
}
void CellularCapabilityUniversal::OnNetworkModeSignal(uint32_t /*mode*/) {
// TODO(petkov): Implement this.
NOTIMPLEMENTED();
}
bool CellularCapabilityUniversal::IsValidSimPath(const string& sim_path) const {
return !sim_path.empty() && sim_path != kRootPath;
}
string CellularCapabilityUniversal::NormalizeMdn(const string& mdn) const {
string normalized_mdn;
for (size_t i = 0; i < mdn.size(); ++i) {
if (base::IsAsciiDigit(mdn[i]))
normalized_mdn += mdn[i];
}
return normalized_mdn;
}
void CellularCapabilityUniversal::OnSimPathChanged(
const string& sim_path) {
if (sim_path == sim_path_)
return;
sim_proxy_ = nullptr;
if (IsValidSimPath(sim_path)) {
sim_proxy_ = control_interface()->CreateMM1SimProxy(
sim_path, cellular()->dbus_service());
}
sim_path_ = sim_path;
if (!IsValidSimPath(sim_path)) {
// Clear all data about the sim
cellular()->set_imsi("");
spn_ = "";
cellular()->set_sim_present(false);
OnSimIdentifierChanged("");
OnOperatorIdChanged("");
cellular()->home_provider_info()->Reset();
} else {
cellular()->set_sim_present(true);
std::unique_ptr<DBusPropertiesProxyInterface> properties_proxy =
control_interface()->CreateDBusPropertiesProxy(
sim_path, cellular()->dbus_service());
// TODO(jglasgow): convert to async interface
KeyValueStore properties(properties_proxy->GetAll(MM_DBUS_INTERFACE_SIM));
OnSimPropertiesChanged(properties, vector<string>());
}
}
void CellularCapabilityUniversal::OnSupportedCapabilitesChanged(
const vector<uint32_t>& supported_capabilities) {
supported_capabilities_ = supported_capabilities;
}
void CellularCapabilityUniversal::OnModemCurrentCapabilitiesChanged(
uint32_t current_capabilities) {
current_capabilities_ = current_capabilities;
// Only allow network scan when the modem's current capabilities support
// GSM/UMTS.
//
// TODO(benchan): We should consider having the modem plugins in ModemManager
// reporting whether network scan is supported.
cellular()->set_scanning_supported(
(current_capabilities & MM_MODEM_CAPABILITY_GSM_UMTS) != 0);
}
void CellularCapabilityUniversal::OnMdnChanged(
const string& mdn) {
cellular()->set_mdn(NormalizeMdn(mdn));
UpdateServiceActivationState();
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::OnModemRevisionChanged(
const string& revision) {
cellular()->set_firmware_revision(revision);
}
void CellularCapabilityUniversal::OnModemHardwareRevisionChanged(
const string& hardware_revision) {
cellular()->set_hardware_revision(hardware_revision);
}
void CellularCapabilityUniversal::OnModemDevicePathChanged(const string& path) {
cellular()->set_device_id(ReadDeviceIdFromSysfs(base::FilePath(path)));
}
void CellularCapabilityUniversal::OnModemStateChanged(
Cellular::ModemState state) {
SLOG(this, 3) << __func__ << ": " << Cellular::GetModemStateString(state);
if (state == Cellular::kModemStateConnected) {
// This assumes that ModemManager updates the Bearers list and the Bearer
// properties before changing Modem state to Connected.
SLOG(this, 2) << "Update active bearer.";
UpdateActiveBearer();
}
cellular()->OnModemStateChanged(state);
// TODO(armansito): Move the deferred enable logic to Cellular
// (See crbug.com/279499).
if (!deferred_enable_modem_callback_.is_null() &&
state == Cellular::kModemStateDisabled) {
SLOG(this, 2) << "Enabling modem after deferring.";
deferred_enable_modem_callback_.Run();
deferred_enable_modem_callback_.Reset();
}
}
void CellularCapabilityUniversal::OnAccessTechnologiesChanged(
uint32_t access_technologies) {
if (access_technologies_ != access_technologies) {
const string old_type_string(GetTypeString());
access_technologies_ = access_technologies;
const string new_type_string(GetTypeString());
if (new_type_string != old_type_string) {
// TODO(jglasgow): address layering violation of emitting change
// signal here for a property owned by Cellular.
cellular()->adaptor()->EmitStringChanged(
kTechnologyFamilyProperty, new_type_string);
}
if (cellular()->service().get()) {
cellular()->service()->SetNetworkTechnology(GetNetworkTechnologyString());
}
}
}
void CellularCapabilityUniversal::OnSupportedModesChanged(
const vector<ModemModes>& supported_modes) {
supported_modes_ = supported_modes;
}
void CellularCapabilityUniversal::OnCurrentModesChanged(
const ModemModes& current_modes) {
current_modes_ = current_modes;
}
void CellularCapabilityUniversal::OnBearersChanged(
const RpcIdentifiers& bearers) {
bearer_paths_ = bearers;
}
void CellularCapabilityUniversal::OnLockRetriesChanged(
const LockRetryData& lock_retries) {
SLOG(this, 3) << __func__;
// Look for the retries left for the current lock. Try the obtain the count
// that matches the current count. If no count for the current lock is
// available, report the first one in the dictionary.
LockRetryData::const_iterator it =
lock_retries.find(sim_lock_status_.lock_type);
if (it == lock_retries.end())
it = lock_retries.begin();
if (it != lock_retries.end())
sim_lock_status_.retries_left = it->second;
else
// Unknown, use 999
sim_lock_status_.retries_left = 999;
}
void CellularCapabilityUniversal::OnLockTypeChanged(
MMModemLock lock_type) {
SLOG(this, 3) << __func__ << ": " << lock_type;
sim_lock_status_.lock_type = lock_type;
// If the SIM is in a locked state |sim_lock_status_.enabled| might be false.
// This is because the corresponding property 'EnabledFacilityLocks' is on
// the 3GPP interface and the 3GPP interface is not available while the Modem
// is in the 'LOCKED' state.
if (lock_type != MM_MODEM_LOCK_NONE &&
lock_type != MM_MODEM_LOCK_UNKNOWN &&
!sim_lock_status_.enabled)
sim_lock_status_.enabled = true;
}
void CellularCapabilityUniversal::OnSimLockStatusChanged() {
SLOG(this, 3) << __func__;
cellular()->adaptor()->EmitKeyValueStoreChanged(
kSIMLockStatusProperty, SimLockStatusToProperty(nullptr));
// If the SIM is currently unlocked, assume that we need to refresh
// carrier information, since a locked SIM prevents shill from obtaining
// the necessary data to establish a connection later (e.g. IMSI).
if (IsValidSimPath(sim_path_) &&
(sim_lock_status_.lock_type == MM_MODEM_LOCK_NONE ||
sim_lock_status_.lock_type == MM_MODEM_LOCK_UNKNOWN)) {
std::unique_ptr<DBusPropertiesProxyInterface> properties_proxy =
control_interface()->CreateDBusPropertiesProxy(
sim_path_, cellular()->dbus_service());
KeyValueStore properties(
properties_proxy->GetAll(MM_DBUS_INTERFACE_SIM));
OnSimPropertiesChanged(properties, vector<string>());
}
}
void CellularCapabilityUniversal::OnModem3gppPropertiesChanged(
const KeyValueStore& properties,
const vector<string>& /* invalidated_properties */) {
SLOG(this, 3) << __func__;
if (properties.ContainsString(MM_MODEM_MODEM3GPP_PROPERTY_IMEI))
cellular()->set_imei(
properties.GetString(MM_MODEM_MODEM3GPP_PROPERTY_IMEI));
// Handle registration state changes as a single change
Stringmap::const_iterator it;
string operator_code;
string operator_name;
it = serving_operator_.find(kOperatorCodeKey);
if (it != serving_operator_.end())
operator_code = it->second;
it = serving_operator_.find(kOperatorNameKey);
if (it != serving_operator_.end())
operator_name = it->second;
MMModem3gppRegistrationState state = registration_state_;
bool registration_changed = false;
if (properties.ContainsUint(MM_MODEM_MODEM3GPP_PROPERTY_REGISTRATIONSTATE)) {
state = static_cast<MMModem3gppRegistrationState>(
properties.GetUint(MM_MODEM_MODEM3GPP_PROPERTY_REGISTRATIONSTATE));
registration_changed = true;
}
if (properties.ContainsString(MM_MODEM_MODEM3GPP_PROPERTY_OPERATORCODE)) {
operator_code =
properties.GetString(MM_MODEM_MODEM3GPP_PROPERTY_OPERATORCODE);
registration_changed = true;
}
if (properties.ContainsString(MM_MODEM_MODEM3GPP_PROPERTY_OPERATORNAME)) {
operator_name =
properties.GetString(MM_MODEM_MODEM3GPP_PROPERTY_OPERATORNAME);
registration_changed = true;
}
if (registration_changed)
On3gppRegistrationChanged(state, operator_code, operator_name);
if (properties.ContainsUint(MM_MODEM_MODEM3GPP_PROPERTY_SUBSCRIPTIONSTATE))
On3gppSubscriptionStateChanged(
static_cast<MMModem3gppSubscriptionState>(
properties.GetUint(MM_MODEM_MODEM3GPP_PROPERTY_SUBSCRIPTIONSTATE)));
CellularServiceRefPtr service = cellular()->service();
if (service.get() &&
properties.ContainsUint(MM_MODEM_MODEM3GPP_PROPERTY_SUBSCRIPTIONSTATE)) {
uint32_t subscription_state =
properties.GetUint(MM_MODEM_MODEM3GPP_PROPERTY_SUBSCRIPTIONSTATE);
SLOG(this, 3) << __func__ << ": Subscription state = "
<< subscription_state;
service->out_of_credits_detector()->NotifySubscriptionStateChanged(
subscription_state);
}
if (properties.ContainsUint(MM_MODEM_MODEM3GPP_PROPERTY_ENABLEDFACILITYLOCKS))
OnFacilityLocksChanged(
properties.GetUint(MM_MODEM_MODEM3GPP_PROPERTY_ENABLEDFACILITYLOCKS));
}
void CellularCapabilityUniversal::On3gppRegistrationChanged(
MMModem3gppRegistrationState state,
const string& operator_code,
const string& operator_name) {
SLOG(this, 3) << __func__ << ": regstate=" << state
<< ", opercode=" << operator_code
<< ", opername=" << operator_name;
// While the modem is connected, if the state changed from a registered state
// to a non registered state, defer the state change by 15 seconds.
if (cellular()->modem_state() == Cellular::kModemStateConnected &&
IsRegistered() && !IsRegisteredState(state)) {
if (!registration_dropped_update_callback_.IsCancelled()) {
LOG(WARNING) << "Modem reported consecutive 3GPP registration drops. "
<< "Ignoring earlier notifications.";
registration_dropped_update_callback_.Cancel();
} else {
// This is not a repeated post. So, count this instance of delayed drop
// posted.
modem_info()->metrics()->Notify3GPPRegistrationDelayedDropPosted();
}
SLOG(this, 2) << "Posted deferred registration state update";
registration_dropped_update_callback_.Reset(
Bind(&CellularCapabilityUniversal::Handle3gppRegistrationChange,
weak_ptr_factory_.GetWeakPtr(),
state,
operator_code,
operator_name));
cellular()->dispatcher()->PostDelayedTask(
FROM_HERE,
registration_dropped_update_callback_.callback(),
registration_dropped_update_timeout_milliseconds_);
} else {
if (!registration_dropped_update_callback_.IsCancelled()) {
SLOG(this, 2) << "Cancelled a deferred registration state update";
registration_dropped_update_callback_.Cancel();
// If we cancelled the callback here, it means we had flaky network for a
// small duration.
modem_info()->metrics()->Notify3GPPRegistrationDelayedDropCanceled();
}
Handle3gppRegistrationChange(state, operator_code, operator_name);
}
}
void CellularCapabilityUniversal::Handle3gppRegistrationChange(
MMModem3gppRegistrationState updated_state,
const string& updated_operator_code,
const string& updated_operator_name) {
SLOG(this, 3) << __func__ << ": regstate=" << updated_state
<< ", opercode=" << updated_operator_code
<< ", opername=" << updated_operator_name;
registration_state_ = updated_state;
serving_operator_[kOperatorCodeKey] = updated_operator_code;
serving_operator_[kOperatorNameKey] = updated_operator_name;
cellular()->serving_operator_info()->UpdateMCCMNC(updated_operator_code);
cellular()->serving_operator_info()->UpdateOperatorName(
updated_operator_name);
cellular()->HandleNewRegistrationState();
// A finished callback does not qualify as a canceled callback.
// We test for a canceled callback to check for outstanding callbacks.
// So, explicitly cancel the callback here.
// Caution: Do not use any function arguments post the call to Cancel().
// Cancel() call invalidates the arguments that were copied when creating
// the callback.
registration_dropped_update_callback_.Cancel();
// If the modem registered with the network and the current ICCID is pending
// activation, then reset the modem.
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::On3gppSubscriptionStateChanged(
MMModem3gppSubscriptionState updated_state) {
SLOG(this, 3) << __func__ << ": Updated subscription state = "
<< updated_state;
// A one-to-one enum mapping.
SubscriptionState new_subscription_state;
switch (updated_state) {
case MM_MODEM_3GPP_SUBSCRIPTION_STATE_UNKNOWN:
new_subscription_state = kSubscriptionStateUnknown;
break;
case MM_MODEM_3GPP_SUBSCRIPTION_STATE_PROVISIONED:
new_subscription_state = kSubscriptionStateProvisioned;
break;
case MM_MODEM_3GPP_SUBSCRIPTION_STATE_UNPROVISIONED:
new_subscription_state = kSubscriptionStateUnprovisioned;
break;
case MM_MODEM_3GPP_SUBSCRIPTION_STATE_OUT_OF_DATA:
new_subscription_state = kSubscriptionStateOutOfData;
break;
default:
LOG(ERROR) << "Unrecognized MMModem3gppSubscriptionState: "
<< updated_state;
new_subscription_state = kSubscriptionStateUnknown;
return;
}
if (new_subscription_state == subscription_state_)
return;
subscription_state_ = new_subscription_state;
UpdateServiceActivationState();
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::OnModemStateChangedSignal(
int32_t old_state, int32_t new_state, uint32_t reason) {
Cellular::ModemState old_modem_state =
static_cast<Cellular::ModemState>(old_state);
Cellular::ModemState new_modem_state =
static_cast<Cellular::ModemState>(new_state);
SLOG(this, 3) << __func__ << "("
<< Cellular::GetModemStateString(old_modem_state)
<< ", "
<< Cellular::GetModemStateString(new_modem_state)
<< ", "
<< reason << ")";
}
void CellularCapabilityUniversal::OnSignalQualityChanged(uint32_t quality) {
cellular()->HandleNewSignalQuality(quality);
}
void CellularCapabilityUniversal::OnFacilityLocksChanged(uint32_t locks) {
bool sim_enabled = !!(locks & MM_MODEM_3GPP_FACILITY_SIM);
if (sim_lock_status_.enabled != sim_enabled) {
sim_lock_status_.enabled = sim_enabled;
OnSimLockStatusChanged();
}
}
void CellularCapabilityUniversal::OnSimPropertiesChanged(
const KeyValueStore& props,
const vector<string>& /* invalidated_properties */) {
SLOG(this, 3) << __func__;
if (props.ContainsString(MM_SIM_PROPERTY_SIMIDENTIFIER))
OnSimIdentifierChanged(props.GetString(MM_SIM_PROPERTY_SIMIDENTIFIER));
if (props.ContainsString(MM_SIM_PROPERTY_OPERATORIDENTIFIER))
OnOperatorIdChanged(props.GetString(MM_SIM_PROPERTY_OPERATORIDENTIFIER));
if (props.ContainsString(MM_SIM_PROPERTY_OPERATORNAME))
OnSpnChanged(props.GetString(MM_SIM_PROPERTY_OPERATORNAME));
if (props.ContainsString(MM_SIM_PROPERTY_IMSI)) {
string imsi = props.GetString(MM_SIM_PROPERTY_IMSI);
cellular()->set_imsi(imsi);
cellular()->home_provider_info()->UpdateIMSI(imsi);
// We do not obtain IMSI OTA right now. Provide the value from the SIM to
// serving operator as well, to aid in MVNO identification.
cellular()->serving_operator_info()->UpdateIMSI(imsi);
}
}
void CellularCapabilityUniversal::OnSpnChanged(const std::string& spn) {
spn_ = spn;
cellular()->home_provider_info()->UpdateOperatorName(spn);
}
void CellularCapabilityUniversal::OnSimIdentifierChanged(const string& id) {
cellular()->set_sim_identifier(id);
cellular()->home_provider_info()->UpdateICCID(id);
// Provide ICCID to serving operator as well to aid in MVNO identification.
cellular()->serving_operator_info()->UpdateICCID(id);
UpdateServiceActivationState();
UpdatePendingActivationState();
}
void CellularCapabilityUniversal::OnOperatorIdChanged(
const string& operator_id) {
SLOG(this, 2) << "Operator ID = '" << operator_id << "'";
cellular()->home_provider_info()->UpdateMCCMNC(operator_id);
}
OutOfCreditsDetector::OOCType
CellularCapabilityUniversal::GetOutOfCreditsDetectionType() const {
if (cellular()->mm_plugin() == kAltairLTEMMPlugin) {
return OutOfCreditsDetector::OOCTypeSubscriptionState;
} else {
return OutOfCreditsDetector::OOCTypeNone;
}
}
} // namespace shill