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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmbim-glib -- GLib/GIO based library to control MBIM 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) 2013 - 2014 Aleksander Morgado <aleksander@aleksander.es>
*
* This is a private non-installed header
*/
#ifndef _LIBMBIM_GLIB_MBIM_MESSAGE_PRIVATE_H_
#define _LIBMBIM_GLIB_MBIM_MESSAGE_PRIVATE_H_
#if !defined (LIBMBIM_GLIB_COMPILATION)
#error "This is a private header!!"
#endif
#include <glib.h>
#include "mbim-message.h"
G_BEGIN_DECLS
/*****************************************************************************/
/* The MbimMessage */
/* Defined in the same way as GByteArray */
struct _MbimMessage {
guint8 *data;
guint len;
};
/*****************************************************************************/
/* Basic message types */
struct header {
guint32 type;
guint32 length;
guint32 transaction_id;
} __attribute__((packed));
#define MBIM_MESSAGE_GET_MESSAGE_TYPE(self) \
(MbimMessageType) GUINT32_FROM_LE (((struct header *)(self->data))->type)
#define MBIM_MESSAGE_GET_MESSAGE_LENGTH(self) \
GUINT32_FROM_LE (((struct header *)(self->data))->length)
#define MBIM_MESSAGE_GET_TRANSACTION_ID(self) \
GUINT32_FROM_LE (((struct header *)(self->data))->transaction_id)
struct open_message {
guint32 max_control_transfer;
} __attribute__((packed));
struct open_done_message {
guint32 status_code;
} __attribute__((packed));
struct close_done_message {
guint32 status_code;
} __attribute__((packed));
struct error_message {
guint32 error_status_code;
} __attribute__((packed));
struct fragment_header {
guint32 total;
guint32 current;
} __attribute__((packed));
struct fragment_message {
struct fragment_header fragment_header;
guint8 buffer[];
} __attribute__((packed));
struct command_message {
struct fragment_header fragment_header;
guint8 service_id[16];
guint32 command_id;
guint32 command_type;
guint32 buffer_length;
guint8 buffer[];
} __attribute__((packed));
struct command_done_message {
struct fragment_header fragment_header;
guint8 service_id[16];
guint32 command_id;
guint32 status_code;
guint32 buffer_length;
guint8 buffer[];
} __attribute__((packed));
struct indicate_status_message {
struct fragment_header fragment_header;
guint8 service_id[16];
guint32 command_id;
guint32 buffer_length;
guint8 buffer[];
} __attribute__((packed));
struct full_message {
struct header header;
union {
struct open_message open;
struct open_done_message open_done;
/* nothing needed for close_message */
struct close_done_message close_done;
struct error_message error;
struct fragment_message fragment;
struct command_message command;
struct command_done_message command_done;
struct indicate_status_message indicate_status;
} message;
} __attribute__((packed));
/*****************************************************************************/
/* Message creation */
GByteArray *_mbim_message_allocate (MbimMessageType message_type, guint32 transaction_id, guint32 additional_size);
/*****************************************************************************/
/* Fragment interface */
gboolean _mbim_message_is_fragment (const MbimMessage *self);
guint32 _mbim_message_fragment_get_total (const MbimMessage *self);
guint32 _mbim_message_fragment_get_current (const MbimMessage *self);
const guint8 *_mbim_message_fragment_get_payload (const MbimMessage *self,
guint32 *length);
/* Merge fragments into a message... */
MbimMessage *_mbim_message_fragment_collector_init (const MbimMessage *fragment,
GError **error);
gboolean _mbim_message_fragment_collector_add (MbimMessage *self,
const MbimMessage *fragment,
GError **error);
gboolean _mbim_message_fragment_collector_complete (MbimMessage *self);
/* Split message into fragments... */
struct fragment_info {
struct header header;
struct fragment_header fragment_header;
guint32 data_length;
const guint8 *data;
} __attribute__((packed));
struct fragment_info *_mbim_message_split_fragments (const MbimMessage *self,
guint32 max_fragment_size,
guint *n_fragments);
/*****************************************************************************/
/* Struct builder */
typedef struct {
GByteArray *fixed_buffer;
GByteArray *variable_buffer;
GArray *offsets;
} MbimStructBuilder;
MbimStructBuilder *_mbim_struct_builder_new (void);
GByteArray *_mbim_struct_builder_complete (MbimStructBuilder *builder);
void _mbim_struct_builder_append_byte_array (MbimStructBuilder *builder,
gboolean with_offset,
gboolean with_length,
gboolean permit_padding,
const guint8 *buffer,
guint32 buffer_len);
void _mbim_struct_builder_append_uuid (MbimStructBuilder *builder,
const MbimUuid *value);
void _mbim_struct_builder_append_guint32 (MbimStructBuilder *builder,
guint32 value);
void _mbim_struct_builder_append_guint32_array (MbimStructBuilder *builder,
const guint32 *values,
guint32 n_values);
void _mbim_struct_builder_append_guint64 (MbimStructBuilder *builder,
guint64 value);
void _mbim_struct_builder_append_guint64_array (MbimStructBuilder *builder,
const guint64 *values,
guint32 n_values);
void _mbim_struct_builder_append_string (MbimStructBuilder *builder,
const gchar *value);
void _mbim_struct_builder_append_string_array (MbimStructBuilder *builder,
const gchar *const *values,
guint32 n_values);
void _mbim_struct_builder_append_ipv4 (MbimStructBuilder *builder,
const MbimIPv4 *value,
gboolean ref);
void _mbim_struct_builder_append_ipv4_array (MbimStructBuilder *builder,
const MbimIPv4 *values,
guint32 n_values);
void _mbim_struct_builder_append_ipv6 (MbimStructBuilder *builder,
const MbimIPv6 *value,
gboolean ref);
void _mbim_struct_builder_append_ipv6_array (MbimStructBuilder *builder,
const MbimIPv6 *values,
guint32 n_values);
/*****************************************************************************/
/* Message builder */
typedef struct {
MbimMessage *message;
MbimStructBuilder *contents_builder;
} MbimMessageCommandBuilder;
MbimMessageCommandBuilder *_mbim_message_command_builder_new (guint32 transaction_id,
MbimService service,
guint32 cid,
MbimMessageCommandType command_type);
MbimMessage *_mbim_message_command_builder_complete (MbimMessageCommandBuilder *builder);
void _mbim_message_command_builder_append_byte_array (MbimMessageCommandBuilder *builder,
gboolean with_offset,
gboolean with_length,
gboolean permit_padding,
const guint8 *buffer,
guint32 buffer_len);
void _mbim_message_command_builder_append_uuid (MbimMessageCommandBuilder *builder,
const MbimUuid *value);
void _mbim_message_command_builder_append_guint32 (MbimMessageCommandBuilder *builder,
guint32 value);
void _mbim_message_command_builder_append_guint32_array (MbimMessageCommandBuilder *builder,
const guint32 *values,
guint32 n_values);
void _mbim_message_command_builder_append_guint64 (MbimMessageCommandBuilder *builder,
guint64 value);
void _mbim_message_command_builder_append_guint64_array (MbimMessageCommandBuilder *builder,
const guint64 *values,
guint32 n_values);
void _mbim_message_command_builder_append_string (MbimMessageCommandBuilder *builder,
const gchar *value);
void _mbim_message_command_builder_append_string_array (MbimMessageCommandBuilder *builder,
const gchar *const *values,
guint32 n_values);
void _mbim_message_command_builder_append_ipv4 (MbimMessageCommandBuilder *builder,
const MbimIPv4 *value,
gboolean ref);
void _mbim_message_command_builder_append_ipv4_array (MbimMessageCommandBuilder *builder,
const MbimIPv4 *values,
guint32 n_values);
void _mbim_message_command_builder_append_ipv6 (MbimMessageCommandBuilder *builder,
const MbimIPv6 *value,
gboolean ref);
void _mbim_message_command_builder_append_ipv6_array (MbimMessageCommandBuilder *builder,
const MbimIPv6 *values,
guint32 n_values);
/*****************************************************************************/
/* Message parser */
const guint8 *_mbim_message_read_byte_array (const MbimMessage *self,
guint32 struct_start_offset,
guint32 relative_offset,
gboolean has_offset,
gboolean has_length,
guint32 *array_size);
const MbimUuid *_mbim_message_read_uuid (const MbimMessage *self,
guint32 relative_offset);
guint32 _mbim_message_read_guint32 (const MbimMessage *self,
guint32 relative_offset);
guint32 *_mbim_message_read_guint32_array (const MbimMessage *self,
guint32 array_size,
guint32 relative_offset_array_start);
guint64 _mbim_message_read_guint64 (const MbimMessage *self,
guint64 relative_offset);
gchar *_mbim_message_read_string (const MbimMessage *self,
guint32 struct_start_offset,
guint32 relative_offset);
gchar **_mbim_message_read_string_array (const MbimMessage *self,
guint32 array_size,
guint32 struct_start_offset,
guint32 relative_offset_array_start);
const MbimIPv4 *_mbim_message_read_ipv4 (const MbimMessage *self,
guint32 relative_offset,
gboolean ref);
MbimIPv4 *_mbim_message_read_ipv4_array (const MbimMessage *self,
guint32 array_size,
guint32 relative_offset_array_start);
const MbimIPv6 *_mbim_message_read_ipv6 (const MbimMessage *self,
guint32 relative_offset,
gboolean ref);
MbimIPv6 *_mbim_message_read_ipv6_array (const MbimMessage *self,
guint32 array_size,
guint32 relative_offset_array_start);
G_END_DECLS
#endif /* _LIBMBIM_GLIB_MBIM_MESSAGE_PRIVATE_H_ */
|
