Netprisma: Add new plugin

6 files changed, 282 insertions, 15 deletions

diff --git a/src/plugins/meson.build b/src/plugins/meson.build
index 4f4d253b..3742ced5 100644
--- a/src/plugins/meson.build
+++ b/src/plugins/meson.build
@@ -282,6 +282,37 @@ if plugins_shared['xmm']
   }}
 endif
 
+# common quectel support library
+if plugins_shared['quectel']
+  quectel_inc = include_directories('quectel')
+
+  c_args = '-DMM_MODULE_NAME="shared-quectel"'
+
+  sources = files(
+    'quectel/mm-broadband-modem-quectel.c',
+    'quectel/mm-shared-quectel.c',
+    'quectel/mm-shared.c',
+  )
+
+  if enable_qmi
+    sources += files('quectel/mm-broadband-modem-qmi-quectel.c')
+  endif
+
+  if enable_mbim
+    sources += files(
+      'quectel/mm-broadband-modem-mbim-quectel.c',
+      'quectel/mm-port-mbim-quectel.c'
+    )
+  endif
+
+  plugins += {'shared-quectel': {
+    'plugin': false,
+    'helper': {'sources': files('quectel/mm-modem-helpers-quectel.c'), 'include_directories': plugins_incs, 'c_args': common_c_args},
+    'module': {'sources': sources, 'include_directories': plugins_incs, 'c_args': c_args},
+    'test': {'sources': files('quectel/tests/test-modem-helpers-quectel.c'), 'include_directories': include_directories('quectel'), 'dependencies': libhelpers_dep},
+  }}
+endif
+
 # plugin: altair lte
 if plugins_options['altair-lte']
   common_c_args = '-DMM_MODULE_NAME="altair-lte"'
@@ -795,30 +826,17 @@ if plugins_options['quectel']
   test_udev_rules_dir_c_args = ['-DTESTUDEVRULESDIR_QUECTEL="@0@"'.format(plugins_dir / 'quectel')]
   plugins_test_udev_rules_dir_c_args += test_udev_rules_dir_c_args
 
+  incs = plugins_incs + [quectel_inc]
+
   common_c_args = test_udev_rules_dir_c_args + ['-DMM_MODULE_NAME="quectel"']
 
   sources = files(
-    'quectel/mm-broadband-modem-quectel.c',
     'quectel/mm-plugin-quectel.c',
-    'quectel/mm-shared-quectel.c',
   )
 
-  if enable_qmi
-    sources += files('quectel/mm-broadband-modem-qmi-quectel.c')
-  endif
-
-  if enable_mbim
-    sources += files(
-      'quectel/mm-broadband-modem-mbim-quectel.c',
-      'quectel/mm-port-mbim-quectel.c'
-    )
-  endif
-
   plugins += {'plugin-quectel': {
     'plugin': true,
-    'helper': {'sources': files('quectel/mm-modem-helpers-quectel.c'), 'include_directories': plugins_incs, 'c_args': common_c_args},
     'module': {'sources': sources, 'include_directories': plugins_incs, 'c_args': common_c_args},
-    'test': {'sources': files('quectel/tests/test-modem-helpers-quectel.c'), 'include_directories': include_directories('quectel'), 'dependencies': libhelpers_dep},
   }}
 
   plugins_udev_rules += files('quectel/77-mm-quectel-port-types.rules')
@@ -1067,6 +1085,25 @@ if plugins_options['zte']
   plugins_udev_rules += files('zte/77-mm-zte-port-types.rules')
 endif
 
+# plugin: netprisma
+if plugins_options['netprisma']
+  test_udev_rules_dir_c_args = ['-DTESTUDEVRULESDIR_NETPRISMA="@0@"'.format(plugins_dir / 'netprisma')]
+  plugins_test_udev_rules_dir_c_args += test_udev_rules_dir_c_args
+
+  incs = plugins_incs + [quectel_inc]
+
+  sources = files(
+    'netprisma/mm-plugin-netprisma.c',
+  )
+
+  plugins += {'plugin-netprisma': {
+    'plugin': true,
+    'module': {'sources': sources, 'include_directories': incs, 'c_args': test_udev_rules_dir_c_args + ['-DMM_MODULE_NAME="netprisma"']},
+  }}
+
+  plugins_udev_rules += files('netprisma/77-mm-netprisma-port-types.rules')
+endif
+
 builtin_sources = []
 builtin_plugins = []
 
diff --git a/src/plugins/mm-builtin-plugins.c b/src/plugins/mm-builtin-plugins.c
index eee5cf92..0fd96700 100644
--- a/src/plugins/mm-builtin-plugins.c
+++ b/src/plugins/mm-builtin-plugins.c
@@ -142,6 +142,9 @@ MMPlugin *mm_plugin_create_x22x (void);
 #if defined ENABLE_PLUGIN_ZTE
 MMPlugin *mm_plugin_create_zte (void);
 #endif
+#if defined ENABLE_PLUGIN_NETPRISMA
+MMPlugin *mm_plugin_create_netprisma (void);
+#endif
 
 GList *
 mm_builtin_plugins_load (void)
@@ -274,6 +277,9 @@ mm_builtin_plugins_load (void)
 #if defined ENABLE_PLUGIN_ZTE
     PREPEND_PLUGIN (zte);
 #endif
+#if defined ENABLE_PLUGIN_NETPRISMA
+    PREPEND_PLUGIN (netprisma);
+#endif
 #undef PREPEND_PLUGIN
     return builtin_plugins;
 }
diff --git a/src/plugins/netprisma/77-mm-netprisma-port-types.rules b/src/plugins/netprisma/77-mm-netprisma-port-types.rules
new file mode 100644
index 00000000..733e904f
--- /dev/null
+++ b/src/plugins/netprisma/77-mm-netprisma-port-types.rules
@@ -0,0 +1,75 @@
+# do not edit this file, it will be overwritten on update
+ACTION!="add|change|move|bind", GOTO="mm_netprisma_end"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="3731", GOTO="mm_netprisma_usb"
+SUBSYSTEMS=="pci", ATTRS{vendor}=="0x203e", GOTO="mm_netprisma_pci"
+GOTO="mm_netprisma_end"
+
+LABEL="mm_netprisma_usb"
+
+SUBSYSTEMS=="usb", ATTRS{bInterfaceNumber}=="?*", ENV{.MM_USBIFNUM}="$attr{bInterfaceNumber}"
+
+# Netprisma LCUK54-WWD (MBIM)
+#  ttyUSB0 (if #3): QCDM/DIAG port
+#  ttyUSB1 (if #4): GPS data port
+#  ttyUSB2 (if #5): AT port
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0100", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0100", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0100", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0111", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0111", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0111", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0112", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0112", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0112", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0113", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0113", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0113", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0115", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0115", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0115", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0116", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0116", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0116", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+
+# Netprisma LCUK54-WRD (MBIM)
+#  ttyUSB0 (if #3): QCDM/DIAG port
+#  ttyUSB1 (if #4): GPS data port
+#  ttyUSB2 (if #5): AT port
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0101", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0101", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0101", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0106", ENV{.MM_USBIFNUM}=="03", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_QCDM}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0106", ENV{.MM_USBIFNUM}=="04", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_GPS}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0106", ENV{.MM_USBIFNUM}=="05", SUBSYSTEM=="tty", ENV{ID_MM_PORT_TYPE_AT_PRIMARY}="1"
+
+# Netprisma LCUK54-WWD variants with Sahara-Firehose support:
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0100", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0100", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0111", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0111", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0112", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0112", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0113", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0113", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0115", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0115", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0116", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0116", ENV{ID_MM_QUECTEL_SAHARA}="1"
+
+# Netprisma LCUK54-WWD variants with Sahara-Firehose support:
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0101", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0101", ENV{ID_MM_QUECTEL_SAHARA}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0106", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+ATTRS{idVendor}=="3731", ATTRS{idProduct}=="0106", ENV{ID_MM_QUECTEL_SAHARA}="1"
+
+GOTO="mm_netprisma_end"
+
+LABEL="mm_netprisma_pci"
+
+# Netprisma LCUR57-WWD with firehose support
+ATTRS{vendor}=="0x203e", ATTRS{device}=="0x1000", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+
+# Netprisma CFUN69-WWD with firehose support
+ATTRS{vendor}=="0x203e", ATTRS{device}=="0x1001", ENV{ID_MM_QUECTEL_FIREHOSE}="1"
+
+LABEL="mm_netprisma_end"
diff --git a/src/plugins/netprisma/mm-plugin-netprisma.c b/src/plugins/netprisma/mm-plugin-netprisma.c
new file mode 100644
index 00000000..170b407b
--- /dev/null
+++ b/src/plugins/netprisma/mm-plugin-netprisma.c
@@ -0,0 +1,120 @@
+/* -*- 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) 2024 Netprisma Inc.
+ */
+
+#include <stdlib.h>
+#include <gmodule.h>
+
+#define _LIBMM_INSIDE_MM
+#include <libmm-glib.h>
+
+#include "mm-log-object.h"
+#include "mm-plugin-common.h"
+
+/* From the Quectel shared utils */
+#include "mm-broadband-modem-quectel.h"
+#if defined WITH_QMI
+#include "mm-broadband-modem-qmi-quectel.h"
+#endif
+#if defined WITH_MBIM
+#include "mm-broadband-modem-mbim.h"
+#include "mm-broadband-modem-mbim-quectel.h"
+#endif
+
+#define MM_TYPE_PLUGIN_NETPRISMA mm_plugin_netprisma_get_type ()
+MM_DEFINE_PLUGIN (NETPRISMA, netprisma, Netprisma)
+
+/*****************************************************************************/
+
+static MMBaseModem *
+create_modem (MMPlugin     *self,
+              const gchar  *uid,
+              const gchar  *physdev,
+              const gchar **drivers,
+              guint16       vendor,
+              guint16       product,
+              guint16       subsystem_vendor,
+              GList        *probes,
+              GError      **error)
+{
+#if defined WITH_QMI
+    if (mm_port_probe_list_has_qmi_port (probes)) {
+        mm_obj_dbg (self, "QMI-powered Netprisma modem found...");
+        return MM_BASE_MODEM (mm_broadband_modem_qmi_quectel_new (uid,
+                                                                  physdev,
+                                                                  drivers,
+                                                                  mm_plugin_get_name (self),
+                                                                  vendor,
+                                                                  product));
+    }
+#endif
+
+#if defined WITH_MBIM
+    if (mm_port_probe_list_has_mbim_port (probes)) {
+        mm_obj_dbg (self, "MBIM-powered Netprisma modem found...");
+        return MM_BASE_MODEM (mm_broadband_modem_mbim_quectel_new (uid,
+                                                                   physdev,
+                                                                   drivers,
+                                                                   mm_plugin_get_name (self),
+                                                                   vendor,
+                                                                   product));
+    }
+#endif
+
+    mm_obj_dbg (self, "Netprisma modem found...");
+    return MM_BASE_MODEM (mm_broadband_modem_quectel_new (uid,
+                                                          physdev,
+                                                          drivers,
+                                                          mm_plugin_get_name (self),
+                                                          vendor,
+                                                          product));
+}
+
+/*****************************************************************************/
+
+MM_PLUGIN_NAMED_CREATOR_SCOPE MMPlugin *
+mm_plugin_create_netprisma (void)
+{
+    static const gchar *subsystems[] = { "tty", "net", "usbmisc", "wwan", NULL };
+    static const gchar *vendor_strings[] = { "netprisma", NULL };
+    static const guint16 vendor_ids[] = {
+        0x3731, /* usb vid */
+        0x203e, /* pci vid */
+        0 };
+
+    return MM_PLUGIN (
+        g_object_new (MM_TYPE_PLUGIN_NETPRISMA,
+                      MM_PLUGIN_NAME,                   MM_MODULE_NAME,
+                      MM_PLUGIN_ALLOWED_SUBSYSTEMS,     subsystems,
+                      MM_PLUGIN_ALLOWED_VENDOR_IDS,     vendor_ids,
+                      MM_PLUGIN_ALLOWED_VENDOR_STRINGS, vendor_strings,
+                      MM_PLUGIN_ALLOWED_AT,             TRUE,
+                      MM_PLUGIN_ALLOWED_QCDM,           TRUE,
+                      MM_PLUGIN_ALLOWED_QMI,            TRUE,
+                      MM_PLUGIN_ALLOWED_MBIM,           TRUE,
+                      NULL));
+}
+
+static void
+mm_plugin_netprisma_init (MMPluginNetprisma *self)
+{
+}
+
+static void
+mm_plugin_netprisma_class_init (MMPluginNetprismaClass *klass)
+{
+    MMPluginClass *plugin_class = MM_PLUGIN_CLASS (klass);
+
+    plugin_class->create_modem = create_modem;
+}
diff --git a/src/plugins/quectel/mm-shared.c b/src/plugins/quectel/mm-shared.c
new file mode 100755
index 00000000..a1a987f1
--- /dev/null
+++ b/src/plugins/quectel/mm-shared.c
@@ -0,0 +1,18 @@
+/* -*- 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) 2024 Quectel Wireless Solution,Co.,Ltd.
+ */
+
+#include "mm-shared-common.h"
+
+MM_DEFINE_SHARED (quectel)
\ No newline at end of file
diff --git a/src/plugins/tests/test-udev-rules.c b/src/plugins/tests/test-udev-rules.c
index 3f7be0ee..91698f0b 100644
--- a/src/plugins/tests/test-udev-rules.c
+++ b/src/plugins/tests/test-udev-rules.c
@@ -200,6 +200,14 @@ test_rolling (void)
 }
 #endif
 
+#if defined ENABLE_PLUGIN_NETPRISMA
+static void
+test_netprisma (void)
+{
+    common_test (TESTUDEVRULESDIR_NETPRISMA);
+}
+#endif
+
 /************************************************************/
 
 int main (int argc, char **argv)
@@ -264,6 +272,9 @@ int main (int argc, char **argv)
 #if defined ENABLE_PLUGIN_ROLLING
     g_test_add_func ("/MM/test-udev-rules/rolling", test_rolling);
 #endif
+#if defined ENABLE_PLUGIN_NETPRISMA
+    g_test_add_func ("/MM/test-udev-rules/netprisma", test_netprisma);
+#endif
 
     return g_test_run ();
 }