Aleksander Morgado
3acdf7b9b8
Configuring unsolicited events involves: * Setup unsolicited events. This handles the setup of the unsolicited message handlers in the AT ports, including the setup of the callback to get called when the unsolicited messages are received. * Enable unsolicited events. This tells the modem to actually send the unsolicited messages. * Disable unsolicited events. This tells the modem to stop sending unsolicited messages. * Cleanup unsolicited events. This removes the unsolicited message handlers in the AT ports.
259 lines
14 KiB
C
259 lines
14 KiB
C
/* -*- 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) 2011 Google, Inc.
|
|
*/
|
|
|
|
#ifndef MM_IFACE_MODEM_3GPP_H
|
|
#define MM_IFACE_MODEM_3GPP_H
|
|
|
|
#include <glib-object.h>
|
|
#include <gio/gio.h>
|
|
|
|
#include <libmm-common.h>
|
|
|
|
#include "mm-at-serial-port.h"
|
|
|
|
#define MM_TYPE_IFACE_MODEM_3GPP (mm_iface_modem_3gpp_get_type ())
|
|
#define MM_IFACE_MODEM_3GPP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_IFACE_MODEM_3GPP, MMIfaceModem3gpp))
|
|
#define MM_IS_IFACE_MODEM_3GPP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_IFACE_MODEM_3GPP))
|
|
#define MM_IFACE_MODEM_3GPP_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), MM_TYPE_IFACE_MODEM_3GPP, MMIfaceModem3gpp))
|
|
|
|
#define MM_IFACE_MODEM_3GPP_DBUS_SKELETON "iface-modem-3gpp-dbus-skeleton"
|
|
#define MM_IFACE_MODEM_3GPP_REGISTRATION_STATE "iface-modem-3gpp-registration-state"
|
|
#define MM_IFACE_MODEM_3GPP_PS_NETWORK_SUPPORTED "iface-modem-3gpp-ps-network-supported"
|
|
#define MM_IFACE_MODEM_3GPP_CS_NETWORK_SUPPORTED "iface-modem-3gpp-cs-network-supported"
|
|
|
|
typedef struct _MMIfaceModem3gpp MMIfaceModem3gpp;
|
|
|
|
struct _MMIfaceModem3gpp {
|
|
GTypeInterface g_iface;
|
|
|
|
/* Loading of the IMEI property */
|
|
void (*load_imei) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gchar * (*load_imei_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Asynchronous setup of indicators */
|
|
void (*setup_indicators) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*setup_indicators_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Asynchronous setting up unsolicited events */
|
|
void (*setup_unsolicited_events) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*setup_unsolicited_events_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Asynchronous enabling of unsolicited events */
|
|
void (*enable_unsolicited_events) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*enable_unsolicited_events_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Asynchronous cleaning up of unsolicited events */
|
|
void (*cleanup_unsolicited_events) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*cleanup_unsolicited_events_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Asynchronous disabling of unsolicited events */
|
|
void (*disable_unsolicited_events) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*disable_unsolicited_events_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Setup unsolicited registration messages */
|
|
void (* setup_unsolicited_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*setup_unsolicited_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Cleanup unsolicited registration messages */
|
|
void (* cleanup_unsolicited_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*cleanup_unsolicited_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Setup CS Registration */
|
|
void (* setup_cs_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*setup_cs_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Cleanup CS Registration */
|
|
void (* cleanup_cs_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*cleanup_cs_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Setup PS Registration */
|
|
void (* setup_ps_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*setup_ps_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Cleanup PS Registration */
|
|
void (* cleanup_ps_registration) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*cleanup_ps_registration_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Run CS registration state check.
|
|
* Note that no registration state is returned, implementations should call
|
|
* mm_iface_modem_3gpp_update_registration_state(). */
|
|
void (* run_cs_registration_check) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*run_cs_registration_check_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Run PS registration state check.
|
|
* Note that no registration state is returned, implementations should call
|
|
* mm_iface_modem_3gpp_update_registration_state(). */
|
|
void (* run_ps_registration_check) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*run_ps_registration_check_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Try to register in the network */
|
|
void (* register_in_network) (MMIfaceModem3gpp *self,
|
|
const gchar *operator_id,
|
|
guint max_registration_time,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (*register_in_network_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Loading of the Operator Code property */
|
|
void (*load_operator_code) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gchar * (*load_operator_code_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Loading of the Operator Name property */
|
|
void (*load_operator_name) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gchar * (*load_operator_name_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Scan current networks, expect a GList of MMModem3gppNetworkInfo */
|
|
void (* scan_networks) (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GList * (*scan_networks_finish) (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
};
|
|
|
|
GType mm_iface_modem_3gpp_get_type (void);
|
|
|
|
/* Initialize Modem 3GPP interface (async) */
|
|
void mm_iface_modem_3gpp_initialize (MMIfaceModem3gpp *self,
|
|
MMAtSerialPort *port,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean mm_iface_modem_3gpp_initialize_finish (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Enable Modem interface (async) */
|
|
void mm_iface_modem_3gpp_enable (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean mm_iface_modem_3gpp_enable_finish (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Disable Modem interface (async) */
|
|
void mm_iface_modem_3gpp_disable (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean mm_iface_modem_3gpp_disable_finish (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Shutdown Modem 3GPP interface */
|
|
void mm_iface_modem_3gpp_shutdown (MMIfaceModem3gpp *self);
|
|
|
|
/* Objects implementing this interface can report new registration states.
|
|
* This may happen when handling unsolicited registration messages, or when
|
|
* the interface asks to run registration state checks. */
|
|
void mm_iface_modem_3gpp_update_cs_registration_state (MMIfaceModem3gpp *self,
|
|
MMModem3gppRegistrationState state,
|
|
MMModemAccessTechnology access_tech,
|
|
gulong location_area_code,
|
|
gulong cell_id);
|
|
void mm_iface_modem_3gpp_update_ps_registration_state (MMIfaceModem3gpp *self,
|
|
MMModem3gppRegistrationState state,
|
|
MMModemAccessTechnology access_tech,
|
|
gulong location_area_code,
|
|
gulong cell_id);
|
|
|
|
/* Run all registration checks */
|
|
void mm_iface_modem_3gpp_run_all_registration_checks (MMIfaceModem3gpp *self,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean mm_iface_modem_3gpp_run_all_registration_checks_finish (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
|
|
/* Allow registering in the network */
|
|
gboolean mm_iface_modem_3gpp_register_in_network_finish (MMIfaceModem3gpp *self,
|
|
GAsyncResult *res,
|
|
GError **error);
|
|
void mm_iface_modem_3gpp_register_in_network (MMIfaceModem3gpp *self,
|
|
const gchar *operator_id,
|
|
guint max_registration_time,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
|
|
/* Bind properties for simple GetStatus() */
|
|
void mm_iface_modem_3gpp_bind_simple_status (MMIfaceModem3gpp *self,
|
|
MMCommonSimpleProperties *status);
|
|
|
|
#endif /* MM_IFACE_MODEM_3GPP_H */
|