Aleksander Morgado
939be0fbf8
When we don't care about the type of AT port to use, prefer the QMI or MBIM based ones if any available.
637 lines
23 KiB
C
637 lines
23 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 Aleksander Morgado <aleksander@gnu.org>
|
|
* Copyright (C) 2024 Google, Inc.
|
|
*/
|
|
|
|
#include <glib.h>
|
|
#include <glib-object.h>
|
|
|
|
#include <ModemManager.h>
|
|
|
|
#include "mm-base-modem-at.h"
|
|
#include "mm-errors-types.h"
|
|
|
|
/*****************************************************************************/
|
|
/* Port setup/teardown logic, to prepare a port to be able to run an
|
|
* AT command with it. */
|
|
|
|
static void
|
|
teardown_port (MMIfacePortAt *port)
|
|
{
|
|
if (MM_IS_PORT_SERIAL (port))
|
|
mm_port_serial_close (MM_PORT_SERIAL (port));
|
|
}
|
|
|
|
static gboolean
|
|
setup_port (MMIfacePortAt *port,
|
|
GTask *task)
|
|
{
|
|
g_autoptr(GError) error = NULL;
|
|
gboolean init_sequence_enabled = FALSE;
|
|
|
|
/* If no port given, probably the port disappeared */
|
|
if (!port) {
|
|
g_task_return_new_error (task, MM_CORE_ERROR, MM_CORE_ERROR_NOT_FOUND,
|
|
"Cannot run AT command: port not given");
|
|
g_object_unref (task);
|
|
return FALSE;
|
|
}
|
|
|
|
/* Ensure we don't try to use a connected port */
|
|
if (mm_port_get_connected (MM_PORT (port))) {
|
|
g_task_return_new_error (task, MM_CORE_ERROR, MM_CORE_ERROR_CONNECTED,
|
|
"Cannot run AT command: port is connected");
|
|
g_object_unref (task);
|
|
return FALSE;
|
|
}
|
|
|
|
if (MM_IS_PORT_SERIAL (port)) {
|
|
/* Temporarily disable init sequence if we're just sending a
|
|
* command to a just opened port */
|
|
g_object_get (port, MM_PORT_SERIAL_AT_INIT_SEQUENCE_ENABLED, &init_sequence_enabled, NULL);
|
|
g_object_set (port, MM_PORT_SERIAL_AT_INIT_SEQUENCE_ENABLED, FALSE, NULL);
|
|
|
|
/* Ensure we have a port open during the sequence */
|
|
if (!mm_port_serial_open (MM_PORT_SERIAL (port), &error)) {
|
|
g_task_return_new_error (task, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
|
|
"Cannot run AT command: Failed to open serial port: '%s'", error->message);
|
|
g_object_unref (task);
|
|
return FALSE;
|
|
}
|
|
|
|
/* Reset previous init sequence state */
|
|
g_object_set (port, MM_PORT_SERIAL_AT_INIT_SEQUENCE_ENABLED, init_sequence_enabled, NULL);
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
static void
|
|
parent_cancellable_cancelled (GCancellable *parent_cancellable,
|
|
GCancellable *cancellable)
|
|
{
|
|
g_cancellable_cancel (cancellable);
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* AT sequence handling */
|
|
|
|
typedef struct {
|
|
MMIfacePortAt *port;
|
|
gulong cancelled_id;
|
|
GCancellable *parent_cancellable;
|
|
const MMBaseModemAtCommand *current;
|
|
const MMBaseModemAtCommand *sequence;
|
|
gpointer response_processor_context;
|
|
GDestroyNotify response_processor_context_free;
|
|
GVariant *result;
|
|
guint next_command_wait_id;
|
|
} AtSequenceContext;
|
|
|
|
static void at_sequence_parse_response (MMIfacePortAt *port,
|
|
GAsyncResult *res,
|
|
GTask *task);
|
|
|
|
static void
|
|
at_sequence_context_free (AtSequenceContext *ctx)
|
|
{
|
|
teardown_port (ctx->port);
|
|
g_object_unref (ctx->port);
|
|
|
|
if (ctx->response_processor_context &&
|
|
ctx->response_processor_context_free)
|
|
ctx->response_processor_context_free (ctx->response_processor_context);
|
|
|
|
if (ctx->parent_cancellable) {
|
|
g_cancellable_disconnect (ctx->parent_cancellable,
|
|
ctx->cancelled_id);
|
|
g_object_unref (ctx->parent_cancellable);
|
|
}
|
|
|
|
if (ctx->next_command_wait_id > 0) {
|
|
g_source_remove (ctx->next_command_wait_id);
|
|
ctx->next_command_wait_id = 0;
|
|
}
|
|
|
|
if (ctx->result)
|
|
g_variant_unref (ctx->result);
|
|
g_slice_free (AtSequenceContext, ctx);
|
|
}
|
|
|
|
GVariant *
|
|
mm_base_modem_at_sequence_full_finish (MMBaseModem *self,
|
|
GAsyncResult *res,
|
|
gpointer *response_processor_context,
|
|
GError **error)
|
|
{
|
|
GTask *task;
|
|
GVariant *result;
|
|
|
|
task = G_TASK (res);
|
|
result = g_task_propagate_pointer (task, error);
|
|
|
|
if (response_processor_context && !g_task_had_error (task)) {
|
|
AtSequenceContext *ctx;
|
|
|
|
ctx = g_task_get_task_data (task);
|
|
|
|
/* transfer none, no need to free the context ourselves, if
|
|
* we gave a response_processor_context_free callback */
|
|
*response_processor_context = ctx->response_processor_context;
|
|
}
|
|
|
|
/* transfer-none! (so that we can ignore it) */
|
|
return result;
|
|
}
|
|
|
|
static gboolean
|
|
at_sequence_next_command (GTask *task)
|
|
{
|
|
AtSequenceContext *ctx;
|
|
|
|
ctx = g_task_get_task_data (task);
|
|
ctx->next_command_wait_id = 0;
|
|
|
|
/* Schedule the next command in the probing group */
|
|
mm_iface_port_at_command (
|
|
ctx->port,
|
|
ctx->current->command,
|
|
ctx->current->timeout,
|
|
FALSE,
|
|
ctx->current->allow_cached,
|
|
g_task_get_cancellable (task),
|
|
(GAsyncReadyCallback)at_sequence_parse_response,
|
|
task);
|
|
|
|
return G_SOURCE_REMOVE;
|
|
}
|
|
|
|
static void
|
|
at_sequence_parse_response (MMIfacePortAt *port,
|
|
GAsyncResult *res,
|
|
GTask *task)
|
|
{
|
|
MMBaseModemAtResponseProcessorResult processor_result;
|
|
GVariant *result = NULL;
|
|
GError *result_error = NULL;
|
|
AtSequenceContext *ctx;
|
|
g_autofree gchar *response = NULL;
|
|
g_autoptr(GError) command_error = NULL;
|
|
|
|
response = mm_iface_port_at_command_finish (port, res, &command_error);
|
|
|
|
/* Cancelled? */
|
|
if (g_task_return_error_if_cancelled (task)) {
|
|
g_object_unref (task);
|
|
return;
|
|
}
|
|
|
|
ctx = g_task_get_task_data (task);
|
|
if (!ctx->current->response_processor)
|
|
processor_result = MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE;
|
|
else {
|
|
const MMBaseModemAtCommand *next = ctx->current + 1;
|
|
|
|
/* Response processor will tell us if we need to keep on the sequence */
|
|
processor_result = ctx->current->response_processor (g_task_get_source_object (task),
|
|
ctx->response_processor_context,
|
|
ctx->current->command,
|
|
response,
|
|
next->command ? FALSE : TRUE, /* Last command in sequence? */
|
|
command_error,
|
|
&result,
|
|
&result_error);
|
|
switch (processor_result) {
|
|
case MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE:
|
|
g_assert (!result && !result_error);
|
|
break;
|
|
case MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_SUCCESS:
|
|
g_assert (!result_error); /* result is optional */
|
|
break;
|
|
case MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_FAILURE:
|
|
/* On failure, complete with error right away */
|
|
g_assert (!result && result_error); /* result is optional */
|
|
g_task_return_error (task, result_error);
|
|
g_object_unref (task);
|
|
return;
|
|
default:
|
|
g_assert_not_reached ();
|
|
}
|
|
}
|
|
|
|
if (processor_result == MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE) {
|
|
ctx->current++;
|
|
if (ctx->current->command) {
|
|
g_assert (!ctx->next_command_wait_id);
|
|
ctx->next_command_wait_id = g_timeout_add_seconds (ctx->current->wait_seconds, (GSourceFunc) at_sequence_next_command, task);
|
|
return;
|
|
}
|
|
/* On last command, end. */
|
|
}
|
|
|
|
/* If we got a response, set it as result */
|
|
if (result)
|
|
/* transfer-full */
|
|
ctx->result = result;
|
|
|
|
/* transfer-none, the result remains owned by the GTask context */
|
|
g_task_return_pointer (task, ctx->result, NULL);
|
|
g_object_unref (task);
|
|
}
|
|
|
|
void
|
|
mm_base_modem_at_sequence_full (MMBaseModem *self,
|
|
MMIfacePortAt *port,
|
|
const MMBaseModemAtCommand *sequence,
|
|
gpointer response_processor_context,
|
|
GDestroyNotify response_processor_context_free,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data)
|
|
{
|
|
GCancellable *task_cancellable;
|
|
GCancellable *parent_cancellable;
|
|
GCancellable *modem_cancellable;
|
|
GTask *task;
|
|
AtSequenceContext *ctx;
|
|
|
|
modem_cancellable = mm_base_modem_peek_cancellable (self);
|
|
parent_cancellable = cancellable ? modem_cancellable : NULL;
|
|
task_cancellable = cancellable ? cancellable : modem_cancellable;
|
|
|
|
task = g_task_new (self, task_cancellable, callback, user_data);
|
|
|
|
/* Ensure that we have the port ready */
|
|
if (!setup_port (port, task))
|
|
return;
|
|
|
|
/* Setup context */
|
|
ctx = g_slice_new0 (AtSequenceContext);
|
|
ctx->port = g_object_ref (port);
|
|
ctx->current = ctx->sequence = sequence;
|
|
ctx->response_processor_context = response_processor_context;
|
|
ctx->response_processor_context_free = response_processor_context_free;
|
|
|
|
/* Ensure the user-provided cancellable will also get cancelled if the modem
|
|
* wide-one gets cancelled */
|
|
if (parent_cancellable) {
|
|
ctx->parent_cancellable = g_object_ref (parent_cancellable);
|
|
ctx->cancelled_id = g_cancellable_connect (ctx->parent_cancellable,
|
|
G_CALLBACK (parent_cancellable_cancelled),
|
|
task_cancellable,
|
|
NULL);
|
|
}
|
|
|
|
g_task_set_task_data (task, ctx, (GDestroyNotify)at_sequence_context_free);
|
|
|
|
/* Go on with the first one in the sequence */
|
|
mm_iface_port_at_command (
|
|
ctx->port,
|
|
ctx->current->command,
|
|
ctx->current->timeout,
|
|
FALSE,
|
|
ctx->current->allow_cached,
|
|
task_cancellable,
|
|
(GAsyncReadyCallback)at_sequence_parse_response,
|
|
task);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
|
|
void
|
|
mm_base_modem_at_sequence (MMBaseModem *self,
|
|
const MMBaseModemAtCommand *sequence,
|
|
gpointer response_processor_context,
|
|
GDestroyNotify response_processor_context_free,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data)
|
|
{
|
|
MMIfacePortAt *port;
|
|
GError *error = NULL;
|
|
|
|
/* No port given, so we'll try to guess which is best */
|
|
port = mm_base_modem_peek_best_at_port (self, &error);
|
|
if (!port) {
|
|
g_task_report_error (self, callback, user_data, mm_base_modem_at_sequence, error);
|
|
return;
|
|
}
|
|
|
|
mm_base_modem_at_sequence_full (self,
|
|
port,
|
|
sequence,
|
|
response_processor_context,
|
|
response_processor_context_free,
|
|
NULL,
|
|
callback,
|
|
user_data);
|
|
}
|
|
|
|
GVariant *
|
|
mm_base_modem_at_sequence_finish (MMBaseModem *self,
|
|
GAsyncResult *res,
|
|
gpointer *response_processor_context,
|
|
GError **error)
|
|
{
|
|
if (g_async_result_is_tagged (res, mm_base_modem_at_sequence))
|
|
return g_task_propagate_pointer (G_TASK (res), error);
|
|
|
|
return (mm_base_modem_at_sequence_full_finish (
|
|
self,
|
|
res,
|
|
response_processor_context,
|
|
error));
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Response processor helpers */
|
|
|
|
MMBaseModemAtResponseProcessorResult
|
|
mm_base_modem_response_processor_string (MMBaseModem *self,
|
|
gpointer none,
|
|
const gchar *command,
|
|
const gchar *response,
|
|
gboolean last_command,
|
|
const GError *error,
|
|
GVariant **result,
|
|
GError **result_error)
|
|
{
|
|
if (error) {
|
|
*result = NULL;
|
|
*result_error = g_error_copy (error);
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_FAILURE;
|
|
}
|
|
|
|
*result = g_variant_new_string (response);
|
|
*result_error = NULL;
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_SUCCESS;
|
|
}
|
|
|
|
MMBaseModemAtResponseProcessorResult
|
|
mm_base_modem_response_processor_no_result (MMBaseModem *self,
|
|
gpointer none,
|
|
const gchar *command,
|
|
const gchar *response,
|
|
gboolean last_command,
|
|
const GError *error,
|
|
GVariant **result,
|
|
GError **result_error)
|
|
{
|
|
if (error) {
|
|
*result = NULL;
|
|
*result_error = g_error_copy (error);
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_FAILURE;
|
|
}
|
|
|
|
*result = NULL;
|
|
*result_error = NULL;
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_SUCCESS;
|
|
}
|
|
|
|
MMBaseModemAtResponseProcessorResult
|
|
mm_base_modem_response_processor_no_result_continue (MMBaseModem *self,
|
|
gpointer none,
|
|
const gchar *command,
|
|
const gchar *response,
|
|
gboolean last_command,
|
|
const GError *error,
|
|
GVariant **result,
|
|
GError **result_error)
|
|
{
|
|
*result = NULL;
|
|
|
|
if (error) {
|
|
*result_error = g_error_copy (error);
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_FAILURE;
|
|
}
|
|
|
|
*result_error = NULL;
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE;
|
|
}
|
|
|
|
MMBaseModemAtResponseProcessorResult
|
|
mm_base_modem_response_processor_continue_on_error (MMBaseModem *self,
|
|
gpointer none,
|
|
const gchar *command,
|
|
const gchar *response,
|
|
gboolean last_command,
|
|
const GError *error,
|
|
GVariant **result,
|
|
GError **result_error)
|
|
{
|
|
*result = NULL;
|
|
*result_error = NULL;
|
|
|
|
return (error ?
|
|
MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE :
|
|
MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_SUCCESS);
|
|
}
|
|
|
|
MMBaseModemAtResponseProcessorResult
|
|
mm_base_modem_response_processor_string_ignore_at_errors (MMBaseModem *self,
|
|
gpointer none,
|
|
const gchar *command,
|
|
const gchar *response,
|
|
gboolean last_command,
|
|
const GError *error,
|
|
GVariant **result,
|
|
GError **result_error)
|
|
{
|
|
if (error) {
|
|
*result = NULL;
|
|
|
|
/* Ignore AT errors (ie, ERROR or CMx ERROR) */
|
|
if (error->domain != MM_MOBILE_EQUIPMENT_ERROR || last_command) {
|
|
|
|
*result_error = g_error_copy (error);
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_FAILURE;
|
|
}
|
|
|
|
*result_error = NULL;
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_CONTINUE;
|
|
}
|
|
|
|
*result = g_variant_new_string (response);
|
|
return MM_BASE_MODEM_AT_RESPONSE_PROCESSOR_RESULT_SUCCESS;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/* Single AT command handling */
|
|
|
|
typedef struct {
|
|
MMIfacePortAt *port;
|
|
gulong cancelled_id;
|
|
GCancellable *parent_cancellable;
|
|
gchar *response;
|
|
} AtCommandContext;
|
|
|
|
static void
|
|
at_command_context_free (AtCommandContext *ctx)
|
|
{
|
|
teardown_port (ctx->port);
|
|
g_object_unref (ctx->port);
|
|
|
|
if (ctx->parent_cancellable) {
|
|
g_cancellable_disconnect (ctx->parent_cancellable, ctx->cancelled_id);
|
|
g_object_unref (ctx->parent_cancellable);
|
|
}
|
|
|
|
g_free (ctx->response);
|
|
g_slice_free (AtCommandContext, ctx);
|
|
}
|
|
|
|
const gchar *
|
|
mm_base_modem_at_command_full_finish (MMBaseModem *self,
|
|
GAsyncResult *res,
|
|
GError **error)
|
|
{
|
|
return g_task_propagate_pointer (G_TASK (res), error);
|
|
}
|
|
|
|
static void
|
|
at_command_ready (MMIfacePortAt *port,
|
|
GAsyncResult *res,
|
|
GTask *task)
|
|
{
|
|
AtCommandContext *ctx;
|
|
g_autoptr(GError) command_error = NULL;
|
|
|
|
ctx = g_task_get_task_data (task);
|
|
|
|
g_assert (!ctx->response);
|
|
ctx->response = mm_iface_port_at_command_finish (port, res, &command_error);
|
|
|
|
/* Cancelled? */
|
|
if (g_task_return_error_if_cancelled (task)) {
|
|
g_object_unref (task);
|
|
return;
|
|
}
|
|
|
|
/* Error coming from the serial port? */
|
|
if (command_error)
|
|
g_task_return_error (task, g_steal_pointer (&command_error));
|
|
/* Valid string response */
|
|
else if (ctx->response)
|
|
/* transfer-none, the response remains owned by the GTask context */
|
|
g_task_return_pointer (task, ctx->response, NULL);
|
|
else
|
|
g_assert_not_reached ();
|
|
g_object_unref (task);
|
|
}
|
|
|
|
void
|
|
mm_base_modem_at_command_full (MMBaseModem *self,
|
|
MMIfacePortAt *port,
|
|
const gchar *command,
|
|
guint timeout,
|
|
gboolean allow_cached,
|
|
gboolean is_raw,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data)
|
|
{
|
|
GCancellable *task_cancellable;
|
|
GCancellable *parent_cancellable;
|
|
GCancellable *modem_cancellable;
|
|
GTask *task;
|
|
AtCommandContext *ctx;
|
|
|
|
modem_cancellable = mm_base_modem_peek_cancellable (self);
|
|
parent_cancellable = cancellable ? modem_cancellable : NULL;
|
|
task_cancellable = cancellable ? cancellable : modem_cancellable;
|
|
|
|
task = g_task_new (self, task_cancellable, callback, user_data);
|
|
|
|
/* Ensure that we have the port ready */
|
|
if (!setup_port (port, task))
|
|
return;
|
|
|
|
ctx = g_slice_new0 (AtCommandContext);
|
|
ctx->port = g_object_ref (port);
|
|
|
|
/* Ensure the user-provided cancellable will also get cancelled if the modem
|
|
* wide-one gets cancelled */
|
|
if (parent_cancellable) {
|
|
ctx->parent_cancellable = g_object_ref (parent_cancellable);
|
|
ctx->cancelled_id = g_cancellable_connect (ctx->parent_cancellable,
|
|
G_CALLBACK (parent_cancellable_cancelled),
|
|
task_cancellable,
|
|
NULL);
|
|
}
|
|
|
|
g_task_set_task_data (task, ctx, (GDestroyNotify)at_command_context_free);
|
|
|
|
/* Go on with the command */
|
|
mm_iface_port_at_command (
|
|
ctx->port,
|
|
command,
|
|
timeout,
|
|
is_raw,
|
|
allow_cached,
|
|
task_cancellable,
|
|
(GAsyncReadyCallback)at_command_ready,
|
|
task);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
|
|
void
|
|
mm_base_modem_at_command (MMBaseModem *self,
|
|
const gchar *command,
|
|
guint timeout,
|
|
gboolean allow_cached,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data)
|
|
{
|
|
MMIfacePortAt *port;
|
|
GError *error = NULL;
|
|
|
|
/* No port given, so we'll try to guess which is best */
|
|
port = mm_base_modem_peek_best_at_port (self, &error);
|
|
if (!port) {
|
|
g_task_report_error (self, callback, user_data, mm_base_modem_at_command, error);
|
|
return;
|
|
}
|
|
|
|
mm_base_modem_at_command_full (self,
|
|
port,
|
|
command,
|
|
timeout,
|
|
allow_cached,
|
|
FALSE,
|
|
NULL,
|
|
callback,
|
|
user_data);
|
|
}
|
|
|
|
const gchar *
|
|
mm_base_modem_at_command_finish (MMBaseModem *self,
|
|
GAsyncResult *res,
|
|
GError **error)
|
|
{
|
|
if (g_async_result_is_tagged (res, mm_base_modem_at_command))
|
|
return g_task_propagate_pointer (G_TASK (res), error);
|
|
|
|
return mm_base_modem_at_command_full_finish (self, res, error);
|
|
}
|
|
|
|
/******************************************************************************/
|
|
|
|
void
|
|
mm_base_modem_at_command_alloc_clear (MMBaseModemAtCommandAlloc *command)
|
|
{
|
|
g_free (command->command);
|
|
}
|