1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libqmi-glib -- GLib/GIO based library to control QMI devices
*
* 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) 2012-2017 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef _LIBQMI_GLIB_QMI_DEVICE_H_
#define _LIBQMI_GLIB_QMI_DEVICE_H_
#if !defined (__LIBQMI_GLIB_H_INSIDE__) && !defined (LIBQMI_GLIB_COMPILATION)
#error "Only <libqmi-glib.h> can be included directly."
#endif
#include <glib-object.h>
#include <gio/gio.h>
#include "qmi-enums.h"
#include "qmi-message.h"
#include "qmi-message-context.h"
#include "qmi-client.h"
G_BEGIN_DECLS
#define QMI_TYPE_DEVICE (qmi_device_get_type ())
#define QMI_DEVICE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), QMI_TYPE_DEVICE, QmiDevice))
#define QMI_DEVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), QMI_TYPE_DEVICE, QmiDeviceClass))
#define QMI_IS_DEVICE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), QMI_TYPE_DEVICE))
#define QMI_IS_DEVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), QMI_TYPE_DEVICE))
#define QMI_DEVICE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), QMI_TYPE_DEVICE, QmiDeviceClass))
typedef struct _QmiDevice QmiDevice;
typedef struct _QmiDeviceClass QmiDeviceClass;
typedef struct _QmiDevicePrivate QmiDevicePrivate;
#define QMI_DEVICE_FILE "device-file"
#define QMI_DEVICE_NO_FILE_CHECK "device-no-file-check"
#define QMI_DEVICE_PROXY_PATH "device-proxy-path"
#define QMI_DEVICE_WWAN_IFACE "device-wwan-iface"
#define QMI_DEVICE_SIGNAL_INDICATION "indication"
/**
* QmiDevice:
*
* The #QmiDevice structure contains private data and should only be accessed
* using the provided API.
*/
struct _QmiDevice {
/*< private >*/
GObject parent;
QmiDevicePrivate *priv;
};
struct _QmiDeviceClass {
/*< private >*/
GObjectClass parent;
};
GType qmi_device_get_type (void);
void qmi_device_new (GFile *file,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
QmiDevice *qmi_device_new_finish (GAsyncResult *res,
GError **error);
GFile *qmi_device_get_file (QmiDevice *self);
GFile *qmi_device_peek_file (QmiDevice *self);
const gchar *qmi_device_get_path (QmiDevice *self);
const gchar *qmi_device_get_path_display (QmiDevice *self);
const gchar *qmi_device_get_wwan_iface (QmiDevice *self);
gboolean qmi_device_is_open (QmiDevice *self);
/**
* QmiDeviceOpenFlags:
* @QMI_DEVICE_OPEN_FLAGS_NONE: No flags.
* @QMI_DEVICE_OPEN_FLAGS_VERSION_INFO: Run version info check when opening.
* @QMI_DEVICE_OPEN_FLAGS_SYNC: Synchronize with endpoint once the device is open. Will release any previously allocated client ID.
* @QMI_DEVICE_OPEN_FLAGS_NET_802_3: set network port to "802.3" mode; mutually exclusive with @QMI_DEVICE_OPEN_FLAGS_NET_RAW_IP
* @QMI_DEVICE_OPEN_FLAGS_NET_RAW_IP: set network port to "raw IP" mode; mutally exclusive with @QMI_DEVICE_OPEN_FLAGS_NET_802_3
* @QMI_DEVICE_OPEN_FLAGS_NET_QOS_HEADER: set network port to transmit/receive QoS headers; mutually exclusive with @QMI_DEVICE_OPEN_FLAGS_NET_NO_QOS_HEADER
* @QMI_DEVICE_OPEN_FLAGS_NET_NO_QOS_HEADER: set network port to not transmit/receive QoS headers; mutually exclusive with @QMI_DEVICE_OPEN_FLAGS_NET_QOS_HEADER
* @QMI_DEVICE_OPEN_FLAGS_PROXY: Try to open the port through the 'qmi-proxy'.
* @QMI_DEVICE_OPEN_FLAGS_MBIM: open an MBIM port with QMUX tunneling service.
* @QMI_DEVICE_OPEN_FLAGS_AUTO: open a port either in QMI or MBIM mode, depending on device driver.
*
* Flags to specify which actions to be performed when the device is open.
*/
typedef enum {
QMI_DEVICE_OPEN_FLAGS_NONE = 0,
QMI_DEVICE_OPEN_FLAGS_VERSION_INFO = 1 << 0,
QMI_DEVICE_OPEN_FLAGS_SYNC = 1 << 1,
QMI_DEVICE_OPEN_FLAGS_NET_802_3 = 1 << 2,
QMI_DEVICE_OPEN_FLAGS_NET_RAW_IP = 1 << 3,
QMI_DEVICE_OPEN_FLAGS_NET_QOS_HEADER = 1 << 4,
QMI_DEVICE_OPEN_FLAGS_NET_NO_QOS_HEADER = 1 << 5,
QMI_DEVICE_OPEN_FLAGS_PROXY = 1 << 6,
QMI_DEVICE_OPEN_FLAGS_MBIM = 1 << 7,
QMI_DEVICE_OPEN_FLAGS_AUTO = 1 << 8,
} QmiDeviceOpenFlags;
void qmi_device_open (QmiDevice *self,
QmiDeviceOpenFlags flags,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean qmi_device_open_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
G_DEPRECATED
gboolean qmi_device_close (QmiDevice *self,
GError **error);
void qmi_device_close_async (QmiDevice *self,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean qmi_device_close_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
void qmi_device_allocate_client (QmiDevice *self,
QmiService service,
guint8 cid,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
QmiClient *qmi_device_allocate_client_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
/**
* QmiDeviceReleaseClientFlags:
* @QMI_DEVICE_RELEASE_CLIENT_FLAGS_NONE: No flags.
* @QMI_DEVICE_RELEASE_CLIENT_FLAGS_RELEASE_CID: Release the CID when releasing the client.
*
* Flags to specify which actions to be performed when releasing the client.
*/
typedef enum {
QMI_DEVICE_RELEASE_CLIENT_FLAGS_NONE = 0,
QMI_DEVICE_RELEASE_CLIENT_FLAGS_RELEASE_CID = 1 << 0
} QmiDeviceReleaseClientFlags;
void qmi_device_release_client (QmiDevice *self,
QmiClient *client,
QmiDeviceReleaseClientFlags flags,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean qmi_device_release_client_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
void qmi_device_set_instance_id (QmiDevice *self,
guint8 instance_id,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean qmi_device_set_instance_id_finish (QmiDevice *self,
GAsyncResult *res,
guint16 *link_id,
GError **error);
G_DEPRECATED
void qmi_device_command (QmiDevice *self,
QmiMessage *message,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
G_DEPRECATED
QmiMessage *qmi_device_command_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
void qmi_device_command_full (QmiDevice *self,
QmiMessage *message,
QmiMessageContext *message_context,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
QmiMessage *qmi_device_command_full_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
/**
* QmiDeviceServiceVersionInfo:
* @service: a #QmiService.
* @major_version: major version of the service.
* @minor_version: minor version of the service.
*
* Version information for a service.
*/
typedef struct {
QmiService service;
guint16 major_version;
guint16 minor_version;
} QmiDeviceServiceVersionInfo;
void qmi_device_get_service_version_info (QmiDevice *self,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GArray *qmi_device_get_service_version_info_finish (QmiDevice *self,
GAsyncResult *res,
GError **error);
/**
* QmiDeviceExpectedDataFormat:
* @QMI_DEVICE_EXPECTED_DATA_FORMAT_UNKNOWN: Unknown.
* @QMI_DEVICE_EXPECTED_DATA_FORMAT_802_3: 802.3.
* @QMI_DEVICE_EXPECTED_DATA_FORMAT_RAW_IP: Raw IP.
*
* Data format expected by the kernel.
*/
typedef enum {
QMI_DEVICE_EXPECTED_DATA_FORMAT_UNKNOWN,
QMI_DEVICE_EXPECTED_DATA_FORMAT_802_3,
QMI_DEVICE_EXPECTED_DATA_FORMAT_RAW_IP,
} QmiDeviceExpectedDataFormat;
QmiDeviceExpectedDataFormat qmi_device_get_expected_data_format (QmiDevice *self,
GError **error);
gboolean qmi_device_set_expected_data_format (QmiDevice *self,
QmiDeviceExpectedDataFormat format,
GError **error);
G_END_DECLS
#endif /* _LIBQMI_GLIB_QMI_DEVICE_H_ */
|
