Merge ~alfonsosanchezbeato/snappy-hwe-snaps/+git/modem-manager:workaround-lp1685116 into ~snappy-hwe-team/snappy-hwe-snaps/+git/modem-manager:modem-manager/xenial/1.6.2

[Alfonso Sanchez-Beato]

Reset the modem on MBIM NOT_OPENED error for HL7588

Reset the modem for said condition so connection can be recovered
after resuming from S4 (hibernate).

Reset the modem on MBIM NOT_OPENED error for HL7588

Reset the modem for said condition so connection can be recovered
after resuming from S4 (hibernate).

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:c5417ab8dc92f5f6d97595ac9cddeffe24c47652
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1481/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/1180
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1389/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/1667
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/798/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1481/rebuild

review: Approve (continuous-integration)

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:5ee7111e1e145a94631875d3cec81f70f46a16b6
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1488/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/1247
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1396/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/1675
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/861/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1488/rebuild

review: Approve (continuous-integration)

[Simon Fels (morphis)]

LGTM

review: Approve

diff --git a/plugins/dell/mm-plugin-dell.c b/plugins/dell/mm-plugin-dell.c
index 37de392..69aca81 100644
--- a/plugins/dell/mm-plugin-dell.c
+++ b/plugins/dell/mm-plugin-dell.c
@@ -258,6 +258,13 @@ custom_init_step (CustomInitContext *ctx)
 
 #if defined WITH_MBIM
     /* If device has a MBIM port, don't run anything else, as we don't care */
+    /* CANONICAL We need the AT ports for the Sierra HL7588 workarounds. Anyway,
+     * doing this was not a great idea as actually probing or not the ports
+     * depended on a race condition (bug LP: #1685722). Leaving this commented
+     * out to not forget about this and rethink in case we can remove the
+     * workarounds. TODO upstream?
+     */
+#if 0
     if (mm_port_probe_list_has_mbim_port (mm_device_peek_port_probe_list (mm_port_probe_peek_device (ctx->probe)))) {
         mm_dbg ("(Dell) no need to run custom init in (%s): device has MBIM port",
                 mm_port_get_device (MM_PORT (ctx->port)));
@@ -268,6 +275,7 @@ custom_init_step (CustomInitContext *ctx)
         return;
     }
 #endif
+#endif
 
     if (ctx->gmi_retries > 0) {
         ctx->gmi_retries--;
diff --git a/src/mm-broadband-modem-mbim.c b/src/mm-broadband-modem-mbim.c
index d68d7cb..49d0643 100644
--- a/src/mm-broadband-modem-mbim.c
+++ b/src/mm-broadband-modem-mbim.c
@@ -20,6 +20,10 @@
 #include <string.h>
 #include <unistd.h>
 #include <ctype.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <errno.h>
 
 #include "mm-modem-helpers-mbim.h"
 #include "mm-broadband-modem-mbim.h"
@@ -75,6 +79,10 @@ struct _MMBroadbandModemMbimPrivate {
     ProcessNotificationFlag setup_flags;
     ProcessNotificationFlag enable_flags;
 
+    /* Process function errors */
+    guint function_error_id;
+    guint already_reset;
+
     /* 3GPP registration helpers */
     gchar *current_operator_id;
     gchar *current_operator_name;
@@ -2261,6 +2269,76 @@ device_notification_cb (MbimDevice *device,
     }
 }
 
+#define VID_SIERRA_HL7588 0x413C
+#define PID_SIERRA_HL7588 0x81C8
+
+static unsigned
+get_uint_property (GObject *obj, const gchar *property_name)
+{
+    GValue value = G_VALUE_INIT;
+
+    g_value_init (&value, G_TYPE_UINT);
+    g_object_get_property (obj, property_name, &value);
+    return g_value_get_uint (&value);
+}
+
+static void
+function_error_cb (MbimDevice *device,
+                   GError *function_error,
+                   MMBroadbandModemMbim *self)
+{
+    /* If a NOT_OPENED error is received for the Sierra HL7588, chances are that
+     * we are just out of hibernate and the modem is in a bad state. To recover,
+     * we send a reset command to the modem. At this point MM serial ports
+     * could be closed due to hangups being received, so we resort to open
+     * directly the port and sending the raw command. The reset makes the
+     * current MM instance disappear and a new one is created, in a good state.
+     */
+    if (g_error_matches (function_error,
+                         MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_NOT_OPENED)
+        && VID_SIERRA_HL7588 == get_uint_property (G_OBJECT (self),
+                                                   MM_BASE_MODEM_VENDOR_ID)
+        && PID_SIERRA_HL7588 == get_uint_property (G_OBJECT (self),
+                                                   MM_BASE_MODEM_PRODUCT_ID)) {
+        int fd;
+        ssize_t written;
+        const char reset_cmd[] = "AT+CFUN=16\r";
+        MMPortSerialAt *at_port;
+        char port_name[128];
+
+        /* Sending reset only once, as the command resets the HW and forces the
+         * creation of a new modem object.
+         */
+        if (self->priv->already_reset)
+            return;
+
+        mm_dbg ("NOT_OPENED received for Sierra HL7588");
+
+        at_port = mm_base_modem_peek_best_at_port (MM_BASE_MODEM (self), NULL);
+        if (at_port)
+            snprintf (port_name, sizeof port_name, "/dev/%s",
+                      mm_port_get_device (MM_PORT (at_port)));
+        else
+            strcpy (port_name, "/dev/ttyACM0");
+
+        fd = open (port_name, O_RDWR);
+        if (fd == -1) {
+            mm_dbg ("Error cannot open port: %s (%d)",  strerror (errno), errno);
+            return;
+        }
+        written = write (fd, reset_cmd, sizeof reset_cmd - 1);
+        if (written == -1) {
+            mm_dbg ("Error cannot write: %s (%d)", strerror (errno), errno);
+            close (fd);
+            return;
+        }
+        mm_dbg ("Written %s (%zd) on %s", reset_cmd, written, port_name);
+
+        close (fd);
+        self->priv->already_reset = TRUE;
+    }
+}
+
 static gboolean
 common_setup_cleanup_unsolicited_events_finish (MMBroadbandModemMbim *self,
                                                 GAsyncResult *res,
@@ -2295,13 +2373,20 @@ common_setup_cleanup_unsolicited_events (MMBroadbandModemMbim *self,
             self->priv->setup_flags & PROCESS_NOTIFICATION_FLAG_PACKET_SERVICE ? "yes" : "no");
 
     if (setup) {
-        /* Don't re-enable it if already there */
+        /* Don't re-enable signals if already there */
         if (!self->priv->notification_id)
             self->priv->notification_id =
                 g_signal_connect (device,
                                   MBIM_DEVICE_SIGNAL_INDICATE_STATUS,
                                   G_CALLBACK (device_notification_cb),
                                   self);
+
+        if (!self->priv->function_error_id)
+            self->priv->function_error_id =
+                g_signal_connect (device,
+                                  MBIM_DEVICE_SIGNAL_ERROR,
+                                  G_CALLBACK (function_error_cb),
+                                  self);
     } else {
         /* Don't remove the signal if there are still listeners interested */
         if (self->priv->setup_flags == PROCESS_NOTIFICATION_FLAG_NONE &&
@@ -2310,6 +2395,12 @@ common_setup_cleanup_unsolicited_events (MMBroadbandModemMbim *self,
             g_signal_handler_disconnect (device, self->priv->notification_id);
             self->priv->notification_id = 0;
         }
+
+        if (self->priv->function_error_id &&
+            g_signal_handler_is_connected (device, self->priv->function_error_id)) {
+            g_signal_handler_disconnect (device, self->priv->function_error_id);
+            self->priv->function_error_id = 0;
+        }
     }
 
     g_simple_async_result_complete_in_idle (result);