modem-helpers-mbim: register MBIM error translations

We register translations for MBIM core, MBIM protocol and MBIM status
errors. These translations are a best-effort, and they are not meant
to be exhaustive.

The original error description is included in the translated GError,
so that the details of the issue are not lost.

4 files changed, 98 insertions, 7 deletions

diff --git a/src/mm-error-helpers.c b/src/mm-error-helpers.c
index daa1e550..d67db84d 100644
--- a/src/mm-error-helpers.c
+++ b/src/mm-error-helpers.c
@@ -29,6 +29,7 @@
 
 #if defined WITH_MBIM
 # include <libmbim-glib.h>
+# include "mm-modem-helpers-mbim.h"
 #endif
 
 /******************************************************************************/
@@ -590,6 +591,10 @@ normalize_mapped_error (const GError *error)
     DomainCodePair *output = NULL;
     const gchar    *input_error_type;
 
+#if defined WITH_MBIM
+    mm_register_mbim_errors ();
+#endif
+
 #if defined WITH_QMI
     if (error->domain == QMI_CORE_ERROR)
         input_error_type = "QMI core";
diff --git a/src/mm-modem-helpers-mbim.c b/src/mm-modem-helpers-mbim.c
index 86fe606a..dbad1d69 100644
--- a/src/mm-modem-helpers-mbim.c
+++ b/src/mm-modem-helpers-mbim.c
@@ -1495,3 +1495,89 @@ mm_error_from_mbim_nw_error (MbimNwError nw_error,
                                 MM_MOBILE_EQUIPMENT_ERROR_UNKNOWN,
                                 "Unknown error");
 }
+
+/*****************************************************************************/
+
+void
+mm_register_mbim_errors (void)
+{
+    static gsize mbim_errors_registered = 0;
+
+    if (!g_once_init_enter (&mbim_errors_registered))
+        return;
+
+    /* MBIM core errors */
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,             MM_CORE_ERROR, MM_CORE_ERROR_FAILED);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_WRONG_STATE,        MM_CORE_ERROR, MM_CORE_ERROR_WRONG_STATE);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_TIMEOUT,            MM_CORE_ERROR, MM_CORE_ERROR_TIMEOUT);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_INVALID_ARGS,       MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_INVALID_MESSAGE,    MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_UNSUPPORTED,        MM_CORE_ERROR, MM_CORE_ERROR_UNSUPPORTED);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_ABORTED,            MM_CORE_ERROR, MM_CORE_ERROR_ABORTED);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_UNKNOWN_STATE,      MM_CORE_ERROR, MM_CORE_ERROR_WRONG_STATE);
+    mm_register_error_mapping (MBIM_CORE_ERROR, MBIM_CORE_ERROR_INCOMPLETE_MESSAGE, MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+
+    /* MBIM protocol errors */
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_INVALID,                  MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_TIMEOUT_FRAGMENT,         MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_FRAGMENT_OUT_OF_SEQUENCE, MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_LENGTH_MISMATCH,          MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_DUPLICATED_TID,           MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_NOT_OPENED,               MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_UNKNOWN,                  MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_CANCEL,                   MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+    mm_register_error_mapping (MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_MAX_TRANSFER,             MM_CORE_ERROR, MM_CORE_ERROR_PROTOCOL);
+
+    /* MBIM status errors */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_BUSY,                             MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_PHONE_FAILURE);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_FAILURE,                          MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_PHONE_FAILURE);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SIM_NOT_INSERTED,                 MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_SIM_NOT_INSERTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_BAD_SIM,                          MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_SIM_WRONG);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_PIN_REQUIRED,                     MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_SIM_PIN);
+    /* MBIM_STATUS_ERROR_PIN_DISABLED */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_NOT_REGISTERED,                   MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_NETWORK);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_PROVIDERS_NOT_FOUND,              MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_NETWORK);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_NO_DEVICE_SUPPORT,                MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_SUPPORTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_PROVIDER_NOT_VISIBLE,             MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_NETWORK);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_DATA_CLASS_NOT_AVAILABLE,         MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_INVALID_MOBILE_CLASS);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_PACKET_SERVICE_DETACHED,          MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_CONNECTION);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_MAX_ACTIVATED_CONTEXTS,           MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_CONNECTION);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_NOT_INITIALIZED,                  MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_CONNECTION);
+    /* MBIM_STATUS_ERROR_VOICE_CALL_IN_PROGRESS */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_CONTEXT_NOT_ACTIVATED,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_BEARER_ACTIVATED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SERVICE_NOT_ACTIVATED,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NO_BEARER_ACTIVATED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_INVALID_ACCESS_STRING,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_MISSING_OR_UNKNOWN_APN);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_INVALID_USER_NAME_PWD,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_INCORRECT_PASSWORD);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_RADIO_POWER_OFF,                  MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_ALLOWED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_INVALID_PARAMETERS,               MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_INVALID_MANDATORY_INFORMATION);
+    /* MBIM_STATUS_ERROR_READ_FAILURE */
+    /* MBIM_STATUS_ERROR_WRITE_FAILURE */
+    /* MBIM_STATUS_ERROR_NO_PHONEBOOK */
+    /* MBIM_STATUS_ERROR_PARAMETER_TOO_LONG */
+    /* MBIM_STATUS_ERROR_STK_BUSY */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_OPERATION_NOT_ALLOWED,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_ALLOWED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_MEMORY_FAILURE,                   MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_MEMORY_FAILURE);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_INVALID_MEMORY_INDEX,             MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_INVALID_INDEX);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_MEMORY_FULL,                      MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_MEMORY_FULL);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_FILTER_NOT_SUPPORTED,             MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_SUPPORTED);
+    /* MBIM_STATUS_ERROR_DSS_INSTANCE_LIMIT */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_INVALID_DEVICE_SERVICE_OPERATION, MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_SUPPORTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_AUTH_INCORRECT_AUTN,              MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_USER_AUTHENTICATION_FAILED);
+    /* MBIM_STATUS_ERROR_AUTH_SYNC_FAILURE */
+    /* MBIM_STATUS_ERROR_AUTH_AMF_NOT_SET */
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_CONTEXT_NOT_SUPPORTED,            MM_MOBILE_EQUIPMENT_ERROR, MM_MOBILE_EQUIPMENT_ERROR_NOT_SUPPORTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SMS_UNKNOWN_SMSC_ADDRESS,         MM_MESSAGE_ERROR,          MM_MESSAGE_ERROR_SMSC_ADDRESS_UNKNOWN);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SMS_NETWORK_TIMEOUT,              MM_MESSAGE_ERROR,          MM_MESSAGE_ERROR_NETWORK_TIMEOUT);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SMS_LANG_NOT_SUPPORTED,           MM_MESSAGE_ERROR,          MM_MESSAGE_ERROR_NOT_SUPPORTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SMS_ENCODING_NOT_SUPPORTED,       MM_MESSAGE_ERROR,          MM_MESSAGE_ERROR_NOT_SUPPORTED);
+    mm_register_error_mapping (MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_SMS_FORMAT_NOT_SUPPORTED,         MM_MESSAGE_ERROR,          MM_MESSAGE_ERROR_NOT_SUPPORTED);
+    /* MBIM_STATUS_ERROR_INVALID_SIGNATURE */
+    /* MBIM_STATUS_ERROR_INVALID_IMEI */
+    /* MBIM_STATUS_ERROR_INVALID_TIMESTAMP */
+    /* MBIM_STATUS_ERROR_NETWORK_LIST_TOO_LARGE */
+    /* MBIM_STATUS_ERROR_SIGNATURE_ALGORITHM_NOT_SUPPORTED */
+    /* MBIM_STATUS_ERROR_FEATURE_NOT_SUPPORTED */
+    /* MBIM_STATUS_ERROR_DECODE_OR_PARSING_ERROR */
+
+    g_once_init_leave (&mbim_errors_registered, 1);
+}
diff --git a/src/mm-modem-helpers-mbim.h b/src/mm-modem-helpers-mbim.h
index 2c1611e0..059dd25c 100644
--- a/src/mm-modem-helpers-mbim.h
+++ b/src/mm-modem-helpers-mbim.h
@@ -182,8 +182,8 @@ gdouble mm_nrarfcn_to_frequency (guint32  nrarfcn,
 /*****************************************************************************/
 /* MM error translations */
 
+void    mm_register_mbim_errors     (void);
 GError *mm_error_from_mbim_nw_error (MbimNwError nw_error,
                                      gpointer    log_object);
 
-
 #endif  /* MM_MODEM_HELPERS_MBIM_H */
diff --git a/src/tests/test-error-helpers.c b/src/tests/test-error-helpers.c
index 68e6daf3..7ca4a41a 100644
--- a/src/tests/test-error-helpers.c
+++ b/src/tests/test-error-helpers.c
@@ -200,14 +200,14 @@ test_error_helpers_normalize (void)
 #endif
 
 #if defined WITH_MBIM
-    normalize_and_assert_mm_error (TRUE, MBIM_CORE_ERROR, MBIM_CORE_ERROR_ABORTED, "Known MBIM core error");
-    normalize_and_assert_mm_error (TRUE, MBIM_CORE_ERROR, 123456,                  "Unknown MBIM core error");
+    normalize_and_assert_mm_error (FALSE, MBIM_CORE_ERROR, MBIM_CORE_ERROR_ABORTED, "Known MBIM core error");
+    normalize_and_assert_mm_error (TRUE,  MBIM_CORE_ERROR, 123456,                  "Unknown MBIM core error");
 
-    normalize_and_assert_mm_error (TRUE, MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_CANCEL, "Known MBIM protocol error");
-    normalize_and_assert_mm_error (TRUE, MBIM_PROTOCOL_ERROR, 123456,                     "Unknown MBIM protocol error");
+    normalize_and_assert_mm_error (FALSE, MBIM_PROTOCOL_ERROR, MBIM_PROTOCOL_ERROR_CANCEL, "Known MBIM protocol error");
+    normalize_and_assert_mm_error (TRUE,  MBIM_PROTOCOL_ERROR, 123456,                     "Unknown MBIM protocol error");
 
-    normalize_and_assert_mm_error (TRUE, MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_BUSY, "Known MBIM status error");
-    normalize_and_assert_mm_error (TRUE, MBIM_STATUS_ERROR, 123456,                 "Unknown MBIM status error");
+    normalize_and_assert_mm_error (FALSE, MBIM_STATUS_ERROR, MBIM_STATUS_ERROR_BUSY, "Known MBIM status error");
+    normalize_and_assert_mm_error (TRUE,  MBIM_STATUS_ERROR, 123456,                 "Unknown MBIM status error");
 #endif
 }