core: rework port grabbing and organization

Make port roles more flexible.  We have modems that do PPP
on interfaces other than the primary interface, and that
wasn't possible with the old code.  So clean up all that
logic and move the port organization code into the core
so we can reduce code in the plugins.

In the new world order, the plugins say whether the port
is a QCDM port, an AT port, or ignored.  If it's an AT
port the plugins get to tag it as primary, secondary, or
PPP, or any combination of the 3.  This allows for modems
where PPP should really be done on the secondary port
(Huawei E220, Sierra devices) so that the primary port
stays open for command and status.

Modem subclasses no longer get asked to handle port grabbing
themselves.  Instead, that's now done by the generic classes
(MMGenericCdma and MMGenericGsm) and the plugins are notified
when a port is grabbed so they can add unsolicited response
handlers for it.  After all ports are grabbed by the generic
classes, they get "organized", which assigns various ports
to the roles of PRIMARY, SECONDARY, DATA, and QCDM based
on specific rules and hints that the plugin provided (which
are expressed as MMAtPortFlags).  The plugins then have
a chance to perform fixups on the primary port if they choose.

The plugin code is responsible for determining the port
hints (ie MMAtPortFlags) at probe time, instead of having
a combination of the plugin and the modem class do the
job.  This simplifies things greatly for the plugins at
the expense of more complicated logic in the core.

1 files changed, 19 insertions, 8 deletions

diff --git a/src/mm-generic-cdma.h b/src/mm-generic-cdma.h
index 350c58ed..ba7b76f8 100644
--- a/src/mm-generic-cdma.h
+++ b/src/mm-generic-cdma.h
@@ -43,6 +43,23 @@ typedef struct {
 typedef struct {
     MMModemBaseClass parent;
 
+    /* Called to allow subclasses to update port flags, attach unsolicited
+     * result code handlers, change port attributes, etc.  This is called
+     * after the generic class has installed it's own handlers; if the
+     * generic class' behavior is not desired, subclasses can override the
+     * port_grabbed() method of MMModemBase.
+     */
+    void (*port_grabbed) (MMGenericCdma *self,
+                          MMPort *port,
+                          MMAtPortFlags at_pflags,
+                          gpointer user_data);
+
+    /* Called after all ports have been organized to allow subclasses to
+     * make changes to ports after we've assigned primary, secondary, and data
+     * designations.
+     */
+    void (*ports_organized) (MMGenericCdma *self, MMAtSerialPort *primary);
+
     /* Subclasses should implement this function if they can more accurately
      * determine the registration state and/or roaming status than the base
      * class can (by using manufacturer custom AT commands or whatever).
@@ -94,14 +111,8 @@ MMModem *mm_generic_cdma_new (const char *device,
 
 /* Private, for subclasses */
 
-MMPort * mm_generic_cdma_grab_port (MMGenericCdma *self,
-                                    const char *subsys,
-                                    const char *name,
-                                    MMPortType suggested_type,
-                                    gpointer user_data,
-                                    GError **error);
-
-MMAtSerialPort *mm_generic_cdma_get_at_port (MMGenericCdma *modem, MMPortType ptype);
+/* Returns the first port (if any) which has the given flag */
+MMAtSerialPort *mm_generic_cdma_get_at_port (MMGenericCdma *modem, MMAtPortFlags flag);
 
 MMAtSerialPort *mm_generic_cdma_get_best_at_port (MMGenericCdma *modem,
                                                   GError **error);