Files
ModemManager/libmm-glib/mm-manager.h
Aleksander Morgado c4a584416a core: allow disabling auto-scan and notifying ports one by one via API
This commit enables a new core ModemManager daemon option, so that automatic
detection of available modems is totally disabled: '--no-auto-scan'. Note that
this option also replaces the previously used '--test-no-auto-scan' option,
which was only used during tests.

Along with the new ModemManager option, a new ReportKernelEvent() method in
the API is defined, which allows notifying the daemon of which interfaces it
should be accessing, as well as the main details of each interface. The only
mandatory parameters in the new method are 'action' (add/remove), 'name' (the
name of the interface) and 'subsystem' (the subsystem of the interface).

The mmcli tool has support for using the new api method via several new options:

 * The '--report-kernel-event' option allows specifying device ports one by
   one, and is a direct mapping of the ReportKernelEvent() method:
     $ sudo mmcli --report-kernel-event="action=add,name=wwan0,subsystem=net"
     $ sudo mmcli --report-kernel-event="action=add,name=cdc-wdm0,subsystem=usbmisc"

 * The '--report-kernel-event-auto-scan' option uses udev monitoring to notify
   events automatically to the daemon. This allows to operate in a way
   equivalent to the default daemon operation (with implicit auto-scan).

Worth noting that the ReportKernelEvent() method is only usable when
'--no-auto-scan' is explicitly used in the daemon. An error will be reported if
the method is tried while standard udev monitoring is enabled (implicit if
auto scan isn't explicitly disabled in the daemon).

If mmcli is going to be used only to report 'real time' events, an optional
'--initial-kernel-events=[PATH]' may be given in the ModemManager call to
automatically process a set of port kernel events one by one on boot. The file
may e.g. contain:
  action=add,name=wwan0,subsystem=net
  action=add,name=cdc-wdm0,subsystem=usbmisc
2016-09-29 15:43:05 +02:00

128 lines
5.4 KiB
C

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm -- Access modem status & information from glib applications
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011 - 2012 Aleksander Morgado <aleksander@gnu.org>
* Copyright (C) 2011 - 2012 Google, Inc.
*
* Author: Aleksander Morgado <aleksander@lanedo.com>
*/
#ifndef _MM_MANAGER_H_
#define _MM_MANAGER_H_
#if !defined (__LIBMM_GLIB_H_INSIDE__) && !defined (LIBMM_GLIB_COMPILATION)
#error "Only <libmm-glib.h> can be included directly."
#endif
#include <ModemManager.h>
#include "mm-gdbus-modem.h"
#include "mm-kernel-event-properties.h"
G_BEGIN_DECLS
#define MM_TYPE_MANAGER (mm_manager_get_type ())
#define MM_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_MANAGER, MMManager))
#define MM_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_MANAGER, MMManagerClass))
#define MM_IS_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_MANAGER))
#define MM_IS_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), MM_TYPE_MANAGER))
#define MM_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_MANAGER, MMManagerClass))
typedef struct _MMManager MMManager;
typedef struct _MMManagerClass MMManagerClass;
typedef struct _MMManagerPrivate MMManagerPrivate;
/**
* MMManager:
*
* The #MMManager structure contains private data and should only be accessed
* using the provided API.
*/
struct _MMManager {
/*< private >*/
MmGdbusObjectManagerClient parent;
MMManagerPrivate *priv;
};
struct _MMManagerClass {
/*< private >*/
MmGdbusObjectManagerClientClass parent;
};
GType mm_manager_get_type (void);
void mm_manager_new (
GDBusConnection *connection,
GDBusObjectManagerClientFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
MMManager *mm_manager_new_finish (
GAsyncResult *res,
GError **error);
MMManager *mm_manager_new_sync (
GDBusConnection *connection,
GDBusObjectManagerClientFlags flags,
GCancellable *cancellable,
GError **error);
GDBusProxy *mm_manager_peek_proxy (MMManager *manager);
GDBusProxy *mm_manager_get_proxy (MMManager *manager);
void mm_manager_set_logging (MMManager *manager,
const gchar *level,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_manager_set_logging_finish (MMManager *manager,
GAsyncResult *res,
GError **error);
gboolean mm_manager_set_logging_sync (MMManager *manager,
const gchar *level,
GCancellable *cancellable,
GError **error);
void mm_manager_scan_devices (MMManager *manager,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_manager_scan_devices_finish (MMManager *manager,
GAsyncResult *res,
GError **error);
gboolean mm_manager_scan_devices_sync (MMManager *manager,
GCancellable *cancellable,
GError **error);
void mm_manager_report_kernel_event (MMManager *manager,
MMKernelEventProperties *properties,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_manager_report_kernel_event_finish (MMManager *manager,
GAsyncResult *res,
GError **error);
gboolean mm_manager_report_kernel_event_sync (MMManager *manager,
MMKernelEventProperties *properties,
GCancellable *cancellable,
GError **error);
G_END_DECLS
#endif /* _MM_MANAGER_H_ */