Imported Upstream version 0.3upstream/0.3

1 files changed, 129 insertions, 0 deletions

diff --git a/src/mm-generic-gsm.h b/src/mm-generic-gsm.h
new file mode 100644
index 0000000..de0b00b
--- /dev/null
+++ b/src/mm-generic-gsm.h
@@ -0,0 +1,129 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details:
+ *
+ * Copyright (C) 2008 - 2009 Novell, Inc.
+ * Copyright (C) 2009 Red Hat, Inc.
+ */
+
+#ifndef MM_GENERIC_GSM_H
+#define MM_GENERIC_GSM_H
+
+#include "mm-modem-gsm.h"
+#include "mm-modem-gsm-network.h"
+#include "mm-modem-base.h"
+#include "mm-serial-port.h"
+#include "mm-callback-info.h"
+
+#define MM_TYPE_GENERIC_GSM            (mm_generic_gsm_get_type ())
+#define MM_GENERIC_GSM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_GENERIC_GSM, MMGenericGsm))
+#define MM_GENERIC_GSM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_GENERIC_GSM, MMGenericGsmClass))
+#define MM_IS_GENERIC_GSM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_GENERIC_GSM))
+#define MM_IS_GENERIC_GSM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_GENERIC_GSM))
+#define MM_GENERIC_GSM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_GENERIC_GSM, MMGenericGsmClass))
+
+#define MM_GENERIC_GSM_POWER_UP_CMD       "power-up-cmd"
+#define MM_GENERIC_GSM_POWER_DOWN_CMD     "power-down-cmd"
+#define MM_GENERIC_GSM_INIT_CMD           "init-cmd"
+#define MM_GENERIC_GSM_INIT_CMD_OPTIONAL  "init-cmd-optional"
+
+typedef enum {
+    MM_GENERIC_GSM_PROP_FIRST = 0x2000,
+
+    MM_GENERIC_GSM_PROP_POWER_UP_CMD,
+    MM_GENERIC_GSM_PROP_POWER_DOWN_CMD,
+    MM_GENERIC_GSM_PROP_INIT_CMD,
+    MM_GENERIC_GSM_PROP_SUPPORTED_BANDS,
+    MM_GENERIC_GSM_PROP_SUPPORTED_MODES,
+    MM_GENERIC_GSM_PROP_INIT_CMD_OPTIONAL
+} MMGenericGsmProp;
+
+
+typedef struct {
+    MMModemBase parent;
+} MMGenericGsm;
+
+typedef struct {
+    MMModemBaseClass parent;
+
+    /* Called after opening the primary serial port and updating the modem's
+     * state to ENABLING, but before sending any commands to the device.  Modems
+     * that need to perform custom initialization sequences or other setup should
+     * generally override this method instead of the MMModem interface's enable()
+     * method, unless the customization must happen *after* the generic init
+     * sequence has completed.
+     */
+    void (*do_enable) (MMGenericGsm *self, MMModemFn callback, gpointer user_data);
+} MMGenericGsmClass;
+
+GType mm_generic_gsm_get_type (void);
+
+MMModem *mm_generic_gsm_new (const char *device,
+                             const char *driver,
+                             const char *plugin);
+
+/* Private, for subclasses */
+
+#define MM_GENERIC_GSM_PREV_STATE_TAG "prev-state"
+
+void mm_generic_gsm_set_unsolicited_registration (MMGenericGsm *modem,
+                                                  gboolean enabled);
+
+void mm_generic_gsm_pending_registration_stop    (MMGenericGsm *modem);
+
+void mm_generic_gsm_set_cid (MMGenericGsm *modem,
+                             guint32 cid);
+
+guint32 mm_generic_gsm_get_cid (MMGenericGsm *modem);
+void mm_generic_gsm_set_reg_status (MMGenericGsm *modem,
+                                    MMModemGsmNetworkRegStatus status);
+
+void mm_generic_gsm_check_pin (MMGenericGsm *modem,
+                               MMModemFn callback,
+                               gpointer user_data);
+
+MMSerialPort *mm_generic_gsm_get_port (MMGenericGsm *modem,
+                                       MMPortType ptype);
+
+MMPort *mm_generic_gsm_grab_port (MMGenericGsm *modem,
+                                  const char *subsys,
+                                  const char *name,
+                                  MMPortType ptype,
+                                  GError **error);
+
+/* stay_connected should be TRUE for unsolicited registration updates, otherwise
+ * the registration update will clear connected/connecting/disconnecting state
+ * which we don't want.  stay_connected should be FALSE for other cases like
+ * updating the state after disconnecting, or after a connect error occurs.
+ */
+void mm_generic_gsm_update_enabled_state (MMGenericGsm *modem,
+                                          gboolean stay_connected,
+                                          MMModemStateReason reason);
+
+/* Called to complete the enable operation for custom enable() handling; if an
+ * error is passed in, it copies the error to the callback info.  This function
+ * always schedules the callback info.  It will also update the modem with the
+ * correct state for both failure and success of the enable operation.
+ */
+void mm_generic_gsm_enable_complete (MMGenericGsm *modem,
+                                     GError *error,
+                                     MMCallbackInfo *info);
+
+/* Called to complete the enable operation for custom connect() handling; if an
+ * error is passed in, it copies the error to the callback info.  This function
+ * always schedules the callback info.  It will also update the modem with the
+ * correct state for both failure and success of the connect operation.
+ */
+void mm_generic_gsm_connect_complete (MMGenericGsm *modem,
+                                      GError *error,
+                                      MMCallbackInfo *info);
+
+#endif /* MM_GENERIC_GSM_H */