NetworkManager/src/nm-gsm-device.c
Dan Williams bcbf96cf7f 2008-04-17 Dan Williams <dcbw@redhat.com>
* src/nm-serial-device.c
	  src/nm-serial-device.h
		- (wait_for_reply_got_data): break input into lines, and search each
			line for responses _and_ terminator strings; also make sure that
			the read loop doesn't continue after the timeout is supposed to fire
		- (nm_serial_device_wait_for_reply): take an array of terminators too

	* src/nm-gsm-device.c
	  src/nm-cdma-device.c
		- Send terminators to nm_serial_device_wait_for_reply()



git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@3570 4912f4e0-d625-0410-9fb7-b9a5a253dbdc
2008-04-17 11:08:52 +00:00

789 lines
20 KiB
C

/* -*- Mode: C; tab-width: 5; indent-tabs-mode: t; c-basic-offset: 5 -*- */
#include <stdio.h>
#include <string.h>
#include "nm-gsm-device.h"
#include "nm-device-interface.h"
#include "nm-device-private.h"
#include "nm-setting-gsm.h"
#include "nm-utils.h"
#include "nm-properties-changed-signal.h"
#include "nm-gsm-device-glue.h"
G_DEFINE_TYPE (NMGsmDevice, nm_gsm_device, NM_TYPE_SERIAL_DEVICE)
#define NM_GSM_DEVICE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_GSM_DEVICE, NMGsmDevicePrivate))
typedef enum {
NM_GSM_SECRET_NONE = 0,
NM_GSM_SECRET_PIN,
NM_GSM_SECRET_PUK
} NMGsmSecret;
typedef struct {
char *monitor_iface;
NMSerialDevice *monitor_device;
NMGsmSecret need_secret;
guint pending_id;
guint state_to_disconnected_id;
} NMGsmDevicePrivate;
enum {
PROP_0,
PROP_MONITOR_IFACE,
LAST_PROP
};
enum {
PROPERTIES_CHANGED,
LAST_SIGNAL
};
static guint signals[LAST_SIGNAL] = { 0 };
static void enter_pin (NMSerialDevice *device, gboolean retry);
static void automatic_registration (NMSerialDevice *device);
NMGsmDevice *
nm_gsm_device_new (const char *udi,
const char *data_iface,
const char *monitor_iface,
const char *driver,
gboolean managed)
{
g_return_val_if_fail (udi != NULL, NULL);
g_return_val_if_fail (data_iface != NULL, NULL);
g_return_val_if_fail (driver != NULL, NULL);
return (NMGsmDevice *) g_object_new (NM_TYPE_GSM_DEVICE,
NM_DEVICE_INTERFACE_UDI, udi,
NM_DEVICE_INTERFACE_IFACE, data_iface,
NM_DEVICE_INTERFACE_DRIVER, driver,
NM_GSM_DEVICE_MONITOR_IFACE, monitor_iface,
NM_DEVICE_INTERFACE_MANAGED, managed,
NULL);
}
static inline void
gsm_device_set_pending (NMGsmDevice *device, guint pending_id)
{
NM_GSM_DEVICE_GET_PRIVATE (device)->pending_id = pending_id;
}
static NMSetting *
gsm_device_get_setting (NMGsmDevice *device, GType setting_type)
{
NMActRequest *req;
NMSetting *setting = NULL;
req = nm_device_get_act_request (NM_DEVICE (device));
if (req) {
NMConnection *connection;
connection = nm_act_request_get_connection (req);
if (connection)
setting = nm_connection_get_setting (connection, setting_type);
}
return setting;
}
static void
dial_done (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
gboolean success = FALSE;
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
nm_info ("Connected, Woo!");
success = TRUE;
break;
case 1:
nm_info ("Busy");
break;
case 2:
nm_warning ("No dial tone");
break;
case 3:
nm_warning ("No carrier");
break;
case -1:
nm_warning ("Dialing timed out");
break;
default:
nm_warning ("Dialing failed");
break;
}
if (success)
nm_device_activate_schedule_stage2_device_config (NM_DEVICE (device));
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
static void
do_dial (NMSerialDevice *device)
{
NMSettingGsm *setting;
char *command;
guint id;
char *responses[] = { "CONNECT", "BUSY", "NO DIAL TONE", "NO CARRIER", NULL };
gboolean success;
setting = NM_SETTING_GSM (gsm_device_get_setting (NM_GSM_DEVICE (device), NM_TYPE_SETTING_GSM));
command = g_strconcat ("ATDT", setting->number, NULL);
success = nm_serial_device_send_command_string (device, command);
g_free (command);
if (success) {
id = nm_serial_device_wait_for_reply (device, 60, responses, responses, dial_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
} else {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
}
static void
manual_registration_done (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
do_dial (device);
break;
case -1:
nm_warning ("Manual registration timed out");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
default:
nm_warning ("Manual registration failed");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
}
}
static void
manual_registration (NMSerialDevice *device)
{
NMSettingGsm *setting;
char *command;
guint id;
char *responses[] = { "OK", "ERROR", "ERR", NULL };
gboolean success;
setting = NM_SETTING_GSM (gsm_device_get_setting (NM_GSM_DEVICE (device), NM_TYPE_SETTING_GSM));
command = g_strdup_printf ("AT+COPS=1,2,\"%s\"", setting->network_id);
success = nm_serial_device_send_command_string (device, command);
g_free (command);
if (success) {
id = nm_serial_device_wait_for_reply (device, 30, responses, responses, manual_registration_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
} else {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
}
static void
get_network_done (NMSerialDevice *device,
const char *response,
gpointer user_data)
{
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
if (response)
nm_info ("Associated with network: %s", response);
else
nm_warning ("Couldn't read active network name");
do_dial (device);
}
static void
automatic_registration_get_network (NMSerialDevice *device)
{
guint id;
const char terminators[] = { '\r', '\n', '\0' };
if (!nm_serial_device_send_command_string (device, "AT+COPS?")) {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
id = nm_serial_device_get_reply (device, 10, terminators, get_network_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
static gboolean
automatic_registration_again (gpointer data)
{
automatic_registration (NM_SERIAL_DEVICE (data));
return FALSE;
}
static void
automatic_registration_response (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
nm_info ("Registered on Home network");
automatic_registration_get_network (device);
break;
case 1:
nm_info ("Registered on Roaming network");
automatic_registration_get_network (device);
break;
case 2:
gsm_device_set_pending (NM_GSM_DEVICE (device),
g_timeout_add (1000, automatic_registration_again, device));
break;
case 3:
nm_warning ("Automatic registration failed: not registered and not searching.");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
case -1:
nm_warning ("Automatic registration timed out");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
default:
nm_warning ("Automatic registration failed");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
}
}
static void
automatic_registration (NMSerialDevice *device)
{
guint id;
char *responses[] = { "+CREG: 0,1", "+CREG: 0,5", "+CREG: 0,2", "+CREG: 0,0", NULL };
char *terminators[] = { "OK", "ERROR", "ERR", NULL };
if (!nm_serial_device_send_command_string (device, "AT+CREG?")) {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
id = nm_serial_device_wait_for_reply (device, 60, responses, terminators, automatic_registration_response, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
static void
do_register (NMSerialDevice *device)
{
NMSettingGsm *setting;
setting = NM_SETTING_GSM (gsm_device_get_setting (NM_GSM_DEVICE (device), NM_TYPE_SETTING_GSM));
if (setting->network_id)
manual_registration (device);
else
automatic_registration (device);
}
static void
enter_pin_done (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
NMSettingGsm *setting;
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
do_register (device);
break;
case -1:
nm_warning ("Did not receive response for secret");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
default:
nm_warning ("Invalid secret");
setting = NM_SETTING_GSM (gsm_device_get_setting (NM_GSM_DEVICE (device), NM_TYPE_SETTING_GSM));
/* Make sure we don't use the invalid PIN/PUK again
as it may lock up the SIM card */
switch (NM_GSM_DEVICE_GET_PRIVATE (device)->need_secret) {
case NM_GSM_SECRET_PIN:
g_free (setting->pin);
setting->pin = NULL;
break;
case NM_GSM_SECRET_PUK:
g_free (setting->puk);
setting->puk = NULL;
break;
default:
break;
}
enter_pin (device, TRUE);
break;
}
}
static void
enter_pin (NMSerialDevice *device, gboolean retry)
{
NMSettingGsm *setting;
NMActRequest *req;
NMConnection *connection;
char *secret;
char *secret_setting_name;
req = nm_device_get_act_request (NM_DEVICE (device));
g_assert (req);
connection = nm_act_request_get_connection (req);
g_assert (connection);
setting = NM_SETTING_GSM (nm_connection_get_setting (connection, NM_TYPE_SETTING_GSM));
switch (NM_GSM_DEVICE_GET_PRIVATE (device)->need_secret) {
case NM_GSM_SECRET_PIN:
secret = setting->pin;
secret_setting_name = NM_SETTING_GSM_PIN;
break;
case NM_GSM_SECRET_PUK:
secret = setting->puk;
secret_setting_name = NM_SETTING_GSM_PIN;
break;
default:
do_register (device);
return;
}
if (secret) {
char *command;
guint id;
char *responses[] = { "OK", "ERROR", "ERR", NULL };
gboolean success;
command = g_strdup_printf ("AT+CPIN=\"%s\"", secret);
success = nm_serial_device_send_command_string (device, command);
g_free (command);
if (success) {
id = nm_serial_device_wait_for_reply (device, 3, responses, responses, enter_pin_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
} else {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
} else {
nm_info ("%s required", secret_setting_name);
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_NEED_AUTH);
nm_act_request_request_connection_secrets (req, secret_setting_name, retry);
}
}
static void
check_pin_done (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
do_register (device);
break;
case 1:
NM_GSM_DEVICE_GET_PRIVATE (device)->need_secret = NM_GSM_SECRET_PIN;
enter_pin (device, FALSE);
break;
case 2:
NM_GSM_DEVICE_GET_PRIVATE (device)->need_secret = NM_GSM_SECRET_PUK;
enter_pin (device, FALSE);
break;
case -1:
nm_warning ("PIN checking timed out");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
default:
nm_warning ("PIN checking failed");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
}
static void
check_pin (NMSerialDevice *device)
{
guint id;
char *responses[] = { "READY", "SIM PIN", "SIM PUK", "ERROR", "ERR", NULL };
char *terminators[] = { "OK", "ERROR", "ERR", NULL };
if (!nm_serial_device_send_command_string (device, "AT+CPIN?")) {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
id = nm_serial_device_wait_for_reply (device, 3, responses, terminators, check_pin_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
static void
init_done (NMSerialDevice *device,
int reply_index,
gpointer user_data)
{
gsm_device_set_pending (NM_GSM_DEVICE (device), 0);
switch (reply_index) {
case 0:
check_pin (device);
break;
case -1:
nm_warning ("Modem initialization timed out");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
break;
default:
nm_warning ("Modem initialization failed");
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
}
static void
init_modem (NMSerialDevice *device, gpointer user_data)
{
guint id;
char *responses[] = { "OK", "ERROR", "ERR", NULL };
if (!nm_serial_device_send_command_string (device, "ATZ E0")) {
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
return;
}
id = nm_serial_device_wait_for_reply (device, 10, responses, responses, init_done, NULL);
if (id)
gsm_device_set_pending (NM_GSM_DEVICE (device), id);
else
nm_device_state_changed (NM_DEVICE (device), NM_DEVICE_STATE_FAILED);
}
static NMActStageReturn
real_act_stage1_prepare (NMDevice *device)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (device);
NMSerialDevice *serial_device = NM_SERIAL_DEVICE (device);
NMSettingSerial *setting;
priv->need_secret = NM_GSM_SECRET_NONE;
setting = NM_SETTING_SERIAL (gsm_device_get_setting (NM_GSM_DEVICE (device), NM_TYPE_SETTING_SERIAL));
if (!nm_serial_device_open (serial_device, setting))
return NM_ACT_STAGE_RETURN_FAILURE;
priv->pending_id = nm_serial_device_flash (serial_device, 100, init_modem, NULL);
return priv->pending_id ? NM_ACT_STAGE_RETURN_POSTPONE : NM_ACT_STAGE_RETURN_FAILURE;
}
static guint32
real_get_generic_capabilities (NMDevice *dev)
{
return NM_DEVICE_CAP_NM_SUPPORTED;
}
static void
real_connection_secrets_updated (NMDevice *dev,
NMConnection *connection,
GSList *updated_settings)
{
NMActRequest *req;
gboolean found = FALSE;
GSList *iter;
if (nm_device_get_state (dev) != NM_DEVICE_STATE_NEED_AUTH)
return;
for (iter = updated_settings; iter; iter = g_slist_next (iter)) {
const char *setting_name = (const char *) iter->data;
if (!strcmp (setting_name, NM_SETTING_GSM_SETTING_NAME))
found = TRUE;
else
nm_warning ("Ignoring updated secrets for setting '%s'.", setting_name);
}
if (!found)
return;
req = nm_device_get_act_request (dev);
g_assert (req);
g_return_if_fail (nm_act_request_get_connection (req) == connection);
nm_device_activate_schedule_stage1_device_prepare (dev);
}
static void
real_deactivate_quickly (NMDevice *device)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (device);
if (priv->pending_id) {
g_source_remove (priv->pending_id);
priv->pending_id = 0;
}
NM_DEVICE_CLASS (nm_gsm_device_parent_class)->deactivate_quickly (device);
}
/*****************************************************************************/
/* Monitor device handling */
static gboolean
monitor_device_got_data (GIOChannel *source,
GIOCondition condition,
gpointer data)
{
gsize bytes_read;
char buf[4096];
GIOStatus status;
if (condition & G_IO_IN) {
do {
status = g_io_channel_read_chars (source, buf, 4096, &bytes_read, NULL);
if (bytes_read) {
buf[bytes_read] = '\0';
/* Do nothing with the data for now */
nm_debug ("Monitor got unhandled data: '%s'", buf);
}
} while (bytes_read == 4096 || status == G_IO_STATUS_AGAIN);
}
if (condition & G_IO_HUP || condition & G_IO_ERR) {
return FALSE;
}
return TRUE;
}
static gboolean
setup_monitor_device (NMGsmDevice *device)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (device);
GIOChannel *channel;
NMSettingSerial *setting;
if (!priv->monitor_iface) {
nm_debug ("No monitoring udi provided");
return FALSE;
}
priv->monitor_device = g_object_new (NM_TYPE_SERIAL_DEVICE,
NM_DEVICE_INTERFACE_UDI, nm_device_get_udi (NM_DEVICE (device)),
NM_DEVICE_INTERFACE_IFACE, priv->monitor_iface,
NULL);
if (!priv->monitor_device) {
nm_warning ("Creation of the monitoring device failed");
return FALSE;
}
setting = NM_SETTING_SERIAL (nm_setting_serial_new ());
if (!nm_serial_device_open (priv->monitor_device, setting)) {
nm_warning ("Monitoring device open failed");
g_object_unref (setting);
g_object_unref (priv->monitor_device);
return FALSE;
}
g_object_unref (setting);
channel = nm_serial_device_get_io_channel (priv->monitor_device);
g_io_add_watch (channel, G_IO_IN | G_IO_ERR | G_IO_HUP,
monitor_device_got_data, device);
g_io_channel_unref (channel);
return TRUE;
}
/*****************************************************************************/
static void
nm_gsm_device_init (NMGsmDevice *self)
{
nm_device_set_device_type (NM_DEVICE (self), DEVICE_TYPE_GSM);
}
static gboolean
unavailable_to_disconnected (gpointer user_data)
{
nm_device_state_changed (NM_DEVICE (user_data), NM_DEVICE_STATE_DISCONNECTED);
return FALSE;
}
static void
device_state_changed (NMDeviceInterface *device, NMDeviceState state, gpointer user_data)
{
NMGsmDevice *self = NM_GSM_DEVICE (user_data);
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (self);
/* Remove any previous delayed transition to disconnected */
if (priv->state_to_disconnected_id) {
g_source_remove (priv->state_to_disconnected_id);
priv->state_to_disconnected_id = 0;
}
/* If transitioning to UNAVAILBLE and we have a carrier, transition to
* DISCONNECTED because the device is ready to use. Otherwise the carrier-on
* handler will handle the transition to DISCONNECTED when the carrier is detected.
*/
if (state == NM_DEVICE_STATE_UNAVAILABLE)
priv->state_to_disconnected_id = g_idle_add (unavailable_to_disconnected, self);
}
static GObject*
constructor (GType type,
guint n_construct_params,
GObjectConstructParam *construct_params)
{
GObject *object;
object = G_OBJECT_CLASS (nm_gsm_device_parent_class)->constructor (type,
n_construct_params,
construct_params);
if (!object)
return NULL;
/* FIXME: Make the monitor device not required for now */
setup_monitor_device (NM_GSM_DEVICE (object));
#if 0
if (!setup_monitor_device (NM_GSM_DEVICE (object))) {
g_object_unref (object);
object = NULL;
}
#endif
g_signal_connect (NM_DEVICE (object), "state-changed",
G_CALLBACK (device_state_changed), NM_GSM_DEVICE (object));
return object;
}
static void
set_property (GObject *object, guint prop_id,
const GValue *value, GParamSpec *pspec)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (object);
switch (prop_id) {
case PROP_MONITOR_IFACE:
/* Construct only */
priv->monitor_iface = g_value_dup_string (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (object);
switch (prop_id) {
case PROP_MONITOR_IFACE:
g_value_set_string (value, priv->monitor_iface);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
finalize (GObject *object)
{
NMGsmDevicePrivate *priv = NM_GSM_DEVICE_GET_PRIVATE (object);
if (priv->monitor_device)
g_object_unref (priv->monitor_device);
g_free (priv->monitor_iface);
if (priv->state_to_disconnected_id) {
g_source_remove (priv->state_to_disconnected_id);
priv->state_to_disconnected_id = 0;
}
G_OBJECT_CLASS (nm_gsm_device_parent_class)->finalize (object);
}
static void
nm_gsm_device_class_init (NMGsmDeviceClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
NMDeviceClass *device_class = NM_DEVICE_CLASS (klass);
g_type_class_add_private (object_class, sizeof (NMGsmDevicePrivate));
object_class->constructor = constructor;
object_class->get_property = get_property;
object_class->set_property = set_property;
object_class->finalize = finalize;
device_class->get_generic_capabilities = real_get_generic_capabilities;
device_class->act_stage1_prepare = real_act_stage1_prepare;
device_class->connection_secrets_updated = real_connection_secrets_updated;
device_class->deactivate_quickly = real_deactivate_quickly;
/* Properties */
g_object_class_install_property
(object_class, PROP_MONITOR_IFACE,
g_param_spec_string (NM_GSM_DEVICE_MONITOR_IFACE,
"Monitoring interface",
"Monitoring interface",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/* Signals */
signals[PROPERTIES_CHANGED] =
nm_properties_changed_signal_new (object_class,
G_STRUCT_OFFSET (NMGsmDeviceClass, properties_changed));
dbus_g_object_type_install_info (G_TYPE_FROM_CLASS (klass),
&dbus_glib_nm_gsm_device_object_info);
}