Files
ModemManager/src/mm-modem-base.h
T
Dan Williams 4dad94d500 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.
2012-02-28 10:06:04 -06:00

122 lines
4.5 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) 2008 - 2009 Novell, Inc.
* Copyright (C) 2009 Red Hat, Inc.
*/
#ifndef MM_MODEM_BASE_H
#define MM_MODEM_BASE_H
#include <glib.h>
#include <glib-object.h>
#include "mm-port.h"
#include "mm-at-serial-port.h"
#include "mm-qcdm-serial-port.h"
#include "mm-modem.h"
#define MM_TYPE_MODEM_BASE (mm_modem_base_get_type ())
#define MM_MODEM_BASE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_MODEM_BASE, MMModemBase))
#define MM_MODEM_BASE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_MODEM_BASE, MMModemBaseClass))
#define MM_IS_MODEM_BASE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_MODEM_BASE))
#define MM_IS_MODEM_BASE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_MODEM_BASE))
#define MM_MODEM_BASE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_MODEM_BASE, MMModemBaseClass))
typedef struct _MMModemBase MMModemBase;
typedef struct _MMModemBaseClass MMModemBaseClass;
#define MM_MODEM_BASE_MAX_TIMEOUTS "max-timeouts"
struct _MMModemBase {
GObject parent;
};
struct _MMModemBaseClass {
GObjectClass parent;
/* Called after the base class grabs a port so that subclasses can
* set port flags and other properties on the new port.
*/
void (*port_grabbed) (MMModemBase *self,
MMPort *port,
MMAtPortFlags at_pflags,
gpointer user_data);
};
GType mm_modem_base_get_type (void);
MMPort *mm_modem_base_get_port (MMModemBase *self,
const char *subsys,
const char *name);
GSList *mm_modem_base_get_ports (MMModemBase *self);
gboolean mm_modem_base_remove_port (MMModemBase *self,
MMPort *port);
gboolean mm_modem_base_organize_ports (MMModemBase *self,
MMAtSerialPort **out_primary,
MMAtSerialPort **out_secondary,
MMPort **out_data,
MMQcdmSerialPort **out_qcdm,
GError **error);
void mm_modem_base_set_valid (MMModemBase *self,
gboolean valid);
gboolean mm_modem_base_get_valid (MMModemBase *self);
const char *mm_modem_base_get_equipment_identifier (MMModemBase *self);
void mm_modem_base_set_equipment_identifier (MMModemBase *self,
const char *ident);
const char *mm_modem_base_get_unlock_required (MMModemBase *self);
void mm_modem_base_set_unlock_required (MMModemBase *self,
const char *unlock_required);
void mm_modem_base_set_pin_retry_counts (MMModemBase *self,
GArray *pin_retries);
void mm_modem_base_set_network_timezone (MMModemBase *self,
gint *offset,
gint *dst_offset,
gint *leap_seconds);
void mm_modem_base_set_network_timezone_polling (MMModemBase *self,
gboolean should_poll);
const char *mm_modem_base_get_manf (MMModemBase *self);
void mm_modem_base_set_manf (MMModemBase *self, const char *manf);
const char *mm_modem_base_get_model (MMModemBase *self);
void mm_modem_base_set_model (MMModemBase *self, const char *model);
const char *mm_modem_base_get_revision (MMModemBase *self);
void mm_modem_base_set_revision (MMModemBase *self, const char *revision);
void mm_modem_base_get_card_info (MMModemBase *self,
MMAtSerialPort *port,
GError *port_error,
MMModemInfoFn callback,
gpointer user_data);
typedef struct {
const char *name;
guint count;
} PinRetryCount;
#endif /* MM_MODEM_BASE_H */