colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

plugins: simplify custom init commands

Browse Source 
Instead of having two places that custom init stuff got processed
(a hook in the MMPluginBase class itself and a callback too) just
use a callback, and simplify it somewhat so that the plugin tracks
how many tries it cares about and what to do based on the response
or error.
This commit is contained in:
Dan Williams
2011-04-26 19:41:30 -05:00
parent 0b757465ff
commit 0befde3ce9
3 changed files with 74 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/mm-plugin-zte.c
View File

@@ -61,6 +61,22 @@ probe_result (MMPluginBase *base,
mm_plugin_base_supports_task_complete (task, get_level_for_capabilities (capabilities));
}
static gboolean
custom_init_response_cb (MMPluginBaseSupportsTask *task,
GString *response,
GError *error,
guint32 tries,
gboolean *out_fail,
guint32 *out_level,
gpointer user_data)
{
if (error)
return tries <= 4 ? TRUE : FALSE;
/* No error, assume success */
return FALSE;
}
static MMPluginSupportsResult
supports_port (MMPluginBase *base,
MMModem *existing,
@@ -113,7 +129,11 @@ supports_port (MMPluginBase *base,
* 1235f71b20c92cded4abd976ccc5010649aae1a0 and
* f38ad328acfdc6ce29dd1380602c546b064161ae for more details.
*/
mm_plugin_base_supports_task_set_custom_init_command (task, "ATE0+CPMS?", 3, 4, FALSE, NULL, NULL);
mm_plugin_base_supports_task_set_custom_init_command (task,
"ATE0+CPMS?",
3,
custom_init_response_cb,
NULL);
if (mm_plugin_base_probe_port (base, task, 100000, NULL))
return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;

54
src/mm-plugin-base.c
View File

@@ -111,10 +111,8 @@ typedef struct {
GError *probe_error;
char *custom_init;
guint32 custom_init_max_tries;
guint32 custom_init_tries;
guint32 custom_init_delay_seconds;
gboolean custom_init_fail_if_timeout;
MMBaseSupportsTaskCustomInitResultFunc custom_init_callback;
gpointer custom_init_callback_data;
@@ -230,8 +228,6 @@ void
mm_plugin_base_supports_task_set_custom_init_command (MMPluginBaseSupportsTask *task,
const char *cmd,
guint32 delay_seconds,
guint32 max_tries,
gboolean fail_if_timeout,
MMBaseSupportsTaskCustomInitResultFunc callback,
gpointer callback_data)
{
@@ -239,14 +235,13 @@ mm_plugin_base_supports_task_set_custom_init_command (MMPluginBaseSupportsTask *
g_return_if_fail (task != NULL);
g_return_if_fail (MM_IS_PLUGIN_BASE_SUPPORTS_TASK (task));
g_return_if_fail (callback != NULL);
priv = MM_PLUGIN_BASE_SUPPORTS_TASK_GET_PRIVATE (task);
g_free (priv->custom_init);
priv->custom_init = g_strdup (cmd);
priv->custom_init_max_tries = max_tries;
priv->custom_init_delay_seconds = delay_seconds;
priv->custom_init_fail_if_timeout = fail_if_timeout;
priv->custom_init_callback = callback;
priv->custom_init_callback_data = callback_data;
}
@@ -727,6 +722,12 @@ parse_response (MMAtSerialPort *port,
task_priv->probe_id = g_idle_add (handle_probe_response, task);
}
static void
start_generic_probing (MMPluginBaseSupportsTask *task, MMAtSerialPort *port)
{
mm_at_serial_port_queue_command (port, "+GCAP", 3, parse_response, task);
}
static void flash_done (MMSerialPort *port, GError *error, gpointer user_data);
static void
@@ -737,43 +738,35 @@ custom_init_response (MMAtSerialPort *port,
{
MMPluginBaseSupportsTask *task = MM_PLUGIN_BASE_SUPPORTS_TASK (user_data);
MMPluginBaseSupportsTaskPrivate *task_priv = MM_PLUGIN_BASE_SUPPORTS_TASK_GET_PRIVATE (task);
MMPluginBaseClass* klass = MM_PLUGIN_BASE_GET_CLASS (task_priv->plugin);
MMBaseSupportsTaskCustomInitResultFunc callback = task_priv->custom_init_callback;
gboolean retry = FALSE;
gboolean fail = FALSE;
guint32 level = 0;
if (error) {
task_priv->custom_init_tries++;
if (task_priv->custom_init_tries < task_priv->custom_init_max_tries) {
/* Try the custom command again */
flash_done (MM_SERIAL_PORT (port), NULL, user_data);
return;
} else if (task_priv->custom_init_fail_if_timeout) {
/* Fail the probe if the plugin wanted it and the command timed out */
if (g_error_matches (error, MM_SERIAL_ERROR, MM_SERIAL_ERROR_RESPONSE_TIMEOUT)) {
retry = callback (task, response, error, task_priv->custom_init_tries, &fail, &level, task_priv->custom_init_callback_data);
if (fail) {
/* Plugin said to fail the probe */
probe_complete (task);
return;
}
}
} else {
/* custom handle init response */
if (klass->handle_custom_init_response != NULL)
klass->handle_custom_init_response (task, response);
}
/* check for custom init callback */
if (task_priv->custom_init_callback != NULL) {
MMBaseSupportsTaskCustomInitResultFunc callback = task_priv->custom_init_callback;
guint32 level;
level = callback (response, task_priv->custom_init_callback_data);
if (level > 0) {
/* Plugin supports the modem */
task_priv->probed_caps = level;
probe_complete (task);
return;
}
if (retry) {
/* Try the custom command again */
flash_done (MM_SERIAL_PORT (port), NULL, user_data);
return;
}
/* Otherwise proceed to probing */
mm_at_serial_port_queue_command (port, "+GCAP", 3, parse_response, user_data);
/* Otherwise continue with generic probing */
start_generic_probing (task, port);
}
static void
@@ -794,7 +787,7 @@ flash_done (MMSerialPort *port, GError *error, gpointer user_data)
user_data);
} else {
/* Otherwise start normal probing */
custom_init_response (MM_AT_SERIAL_PORT (port), NULL, NULL, user_data);
start_generic_probing (task, MM_AT_SERIAL_PORT (port));
}
}
@@ -1270,7 +1263,6 @@ mm_plugin_base_class_init (MMPluginBaseClass *klass)
g_type_class_add_private (object_class, sizeof (MMPluginBasePrivate));
klass->handle_probe_response = real_handle_probe_response;
klass->handle_custom_init_response = NULL;
/* Virtual methods */
object_class->get_property = get_property;

26
src/mm-plugin-base.h
View File

@@ -56,7 +56,25 @@ typedef struct {
GType mm_plugin_base_supports_task_get_type (void);
typedef guint32 (*MMBaseSupportsTaskCustomInitResultFunc) (GString* response,
/*
* response: the response string from the modem, if no error occurred
* error: the error returned by the modem or serial stack, if any
* tries: number of times the custom init command has been sent to the modem
* out_fail: on return, TRUE means fail the probe and close the port
* out_level: if the custom init command has determined that the modem is
* supported, return the support level here, and probing will cease
*
* Function should return TRUE if the custom init command should be retried,
* FALSE if it should not. If FALSE is returned, generic probing will continue
* if out_fail == FALSE and out_level == 0, otherwise if out_fail == FALSE
* probing will stop, or if out_level > 0 the port will be claimed.
*/
typedef gboolean (*MMBaseSupportsTaskCustomInitResultFunc) (MMPluginBaseSupportsTask *task,
GString *response,
GError *error,
guint32 tries,
gboolean *out_fail,
guint32 *out_level,
gpointer user_data);
MMPlugin *mm_plugin_base_supports_task_get_plugin (MMPluginBaseSupportsTask *task);
@@ -75,8 +93,6 @@ void mm_plugin_base_supports_task_complete (MMPluginBaseSupportsTask *task,
void mm_plugin_base_supports_task_set_custom_init_command (MMPluginBaseSupportsTask *task,
const char *cmd,
guint32 delay_seconds,
guint32 max_tries,
gboolean fail_if_timeout,
MMBaseSupportsTaskCustomInitResultFunc callback,
gpointer callback_data);
@@ -113,15 +129,13 @@ struct _MMPluginBaseClass {
void (*cancel_task) (MMPluginBase *plugin,
MMPluginBaseSupportsTask *task);
/* Lets plugins read the probe response before the generic plugin processes it */
void (*handle_probe_response) (MMPluginBase *plugin,
MMPluginBaseSupportsTask *task,
const char *command,
const char *response,
const GError *error);
void (*handle_custom_init_response) (MMPluginBaseSupportsTask *task,
GString *response);
/* Signals */
void (*probe_result) (MMPluginBase *self,
MMPluginBaseSupportsTask *task,