-
Notifications
You must be signed in to change notification settings - Fork 2
/
ATCmdParser.c
376 lines (324 loc) · 11.4 KB
/
ATCmdParser.c
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/**
******************************************************************************
* @file ATCmdParser.c
******************************************************************************
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************
*/
#include "ATCmdParser.h"
/******************************************************************************
* Constants
******************************************************************************/
#ifdef LF
#undef LF
#define LF 10
#else
#define LF 10
#endif
#ifdef CR
#undef CR
#define CR 13
#else
#define CR 13
#endif
/******************************************************************************
* Variable Definitions
******************************************************************************/
/******************************************************************************
* Function Definitions
******************************************************************************/
static inline void debug_if(int condition, const char* format, ...)
{
if (condition) {
va_list args;
va_start(args, format);
vprintf(format, args);
va_end(args);
}
}
bool ATCmdParser_vrecv(ATParser *at, const char* response, va_list args)
{
char _in_prev = 0;
bool _aborted;
restart:
_aborted = false;
// Iterate through each line in the expected response
while (response[0]) {
// Since response is const, we need to copy it into our buffer to
// add the line's null terminator and clobber value-matches with asterisks.
//
// We just use the beginning of the buffer to avoid unnecessary allocations.
int i = 0;
int offset = 0;
bool whole_line_wanted = false;
while (response[i]) {
if (response[i] == '%' && response[i + 1] != '%' && response[i + 1] != '*') {
at->_buffer[offset++] = '%';
at->_buffer[offset++] = '*';
i++;
} else {
at->_buffer[offset++] = response[i++];
// Find linebreaks, taking care not to be fooled if they're in a %[^\n] conversion specification
if (response[i - 1] == '\n' && !(i >= 3 && response[i - 3] == '[' && response[i - 2] == '^')) {
whole_line_wanted = true;
break;
}
}
}
// Scanf has very poor support for catching errors
// fortunately, we can abuse the %n specifier to determine
// if the entire string was matched.
at->_buffer[offset++] = '%';
at->_buffer[offset++] = 'n';
at->_buffer[offset++] = 0;
debug_if(at->_dbg_on, "AT? %s\n", at->_buffer);
// To workaround scanf's lack of error reporting, we actually
// make two passes. One checks the validity with the modified
// format string that only stores the matched characters (%n).
// The other reads in the actual matched values.
//
// We keep trying the match until we succeed or some other error
// derails us.
int j = 0, dummy = 0;
int dummy_pos[20];
while (true) {
// Receive next character
int c = at->ops->get(at->character_timeout);
if (c < 0) {
debug_if(at->_dbg_on, "AT(Timeout)\n");
return false;
}
/* Possible not existed string may cause %n function failed:
example: "cmd:%*s\r\n%n" not match "cmd:\r\n", %n will not
give a valid value, so we give some dummy chars */
if ((char)c == '\n' && _in_prev == ':') {
dummy_pos[dummy++] = j;
at->_buffer[offset + j++] = 'x';
}
_in_prev = c;
at->_buffer[offset + j++] = c;
at->_buffer[offset + j] = 0;
struct oob* oob = at->_oobs;
// Check for oob data
for (; oob; oob = (struct oob*)oob->next) {
if ((unsigned)j == oob->len && memcmp(oob->prefix, at->_buffer + offset, oob->len) == 0) {
debug_if(at->_dbg_on, "AT! %s\n", oob->prefix);
if(oob->cb)
oob->cb(at);
if (_aborted) {
debug_if(at->_dbg_on, "AT(Aborted)\n");
return false;
}
// oob may have corrupted non-reentrant buffer,
// so we need to set it up again
goto restart;
}
}
// Check for match
int count = -1;
if (whole_line_wanted && (char)c != '\n') {
// Don't attempt scanning until we get delimiter if they included it in format
// This allows recv("Foo: %s\n") to work, and not match with just the first character of a string
// (scanf does not itself match whitespace in its format string, so \n is not significant to it)
} else {
char *dp = at->_buffer + offset;
sscanf(dp, at->_buffer, &count);
debug_if(at->_dbg_on, "need chars:%d,actual chars:%d\r\n", j, count);
}
// We only succeed if all characters in the response are matched
if (count == j) {
/* Remove dummy chars*/
for (int k = 0; k < dummy; k++, j--) {
dummy_pos[k] -= k;
memcpy(at->_buffer + offset + dummy_pos[k], at->_buffer + offset + dummy_pos[k] + 1, j - dummy_pos[k] - 1);
debug_if(at->_dbg_on, "AT> %s\n", at->_buffer + offset);
}
debug_if(at->_dbg_on, "AT= %s\n", at->_buffer + offset);
// Reuse the front end of the buffer
memcpy(at->_buffer, response, i);
at->_buffer[i] = 0;
// Store the found results
vsscanf(at->_buffer + offset, at->_buffer, args);
// Jump to next line and continue parsing
response += i;
break;
}
// Clear the buffer when we hit a newline or ran out of space
// running out of space usually means we ran into binary data
if ((char)c == '\n' || j + 1 >= AT_BUFFER_SIZE - offset) {
debug_if(at->_dbg_on, "AT< %s", at->_buffer + offset);
j = 0;
dummy = 0;
}
}
}
return true;
}
// Command parsing with line handling
bool ATCmdParser_vsend(ATParser *at, const char* command, va_list args)
{
while (ATCmdParser_process_oob(at))
;
// Create and send command
if (vsprintf(at->_buffer, command, args) < 0) {
return false;
}
for (int i = 0; at->_buffer[i]; i++) {
if (at->ops->put(at->_buffer[i]) < 0) {
return false;
}
}
// Finish with newline
for (size_t i = 0; at->_output_delimiter[i]; i++) {
if (at->ops->put(at->_output_delimiter[i]) < 0) {
return false;
}
}
debug_if(at->_dbg_on, "AT> %s\n", at->_buffer);
return true;
}
bool ATCmdParser_recv(ATParser *at, const char* response, ...)
{
va_list args;
va_start(args, response);
bool res = ATCmdParser_vrecv(at, response, args);
va_end(args);
return res;
}
bool ATCmdParser_send(ATParser *at, const char* command, ...)
{
va_list args;
va_start(args, command);
bool res = ATCmdParser_vsend(at, command, args);
va_end(args);
return res;
}
// read/write handling with timeouts
int ATCmdParser_write(ATParser *at, const char* data, int size)
{
int i = 0;
for (; i < size; i++) {
if (at->ops->put(data[i]) < 0) {
return -1;
}
//mx_delay(1);
}
return i;
}
int ATCmdParser_read(ATParser *at, char* data, int size)
{
int i = 0;
for (; i < size; i++) {
int c = at->ops->get(at->character_timeout);
if (c < 0) {
return -1;
}
data[i] = c;
}
return i;
}
void ATCmdParser_debug(ATParser *at, bool on)
{
at->_dbg_on = on;
}
void ATCmdParser_add_oob(ATParser *at, const char* prefix, oob_callback cb)
{
struct oob* oob = malloc(sizeof(struct oob));
oob->len = strlen(prefix);
oob->prefix = prefix;
oob->cb = cb;
oob->next = at->_oobs;
at->_oobs = oob;
}
bool ATCmdParser_process_oob(ATParser *at)
{
if (!at->ops->readable()) {
return false;
}
int i = 0;
while (true) {
// Receive next character
int c = at->ops->get(at->character_timeout);
if (c < 0) {
return false;
}
at->_buffer[i++] = c;
at->_buffer[i] = 0;
// Check for oob data
struct oob* oob = at->_oobs;
while (oob) {
if (i == (int)oob->len && memcmp(oob->prefix, at->_buffer, oob->len) == 0) {
debug_if(at->_dbg_on, "AT! %s\r\n", oob->prefix);
if(oob->cb)
oob->cb(at);
return true;
}
oob = oob->next;
}
// Clear the buffer when we hit a newline or ran out of space
// running out of space usually means we ran into binary data
if (i + 1 >= AT_BUFFER_SIZE || strcmp(&at->_buffer[i - at->_input_delim_size], at->_input_delimiter) == 0) {
debug_if(at->_dbg_on, "AT< %s, %d\r\n", at->_buffer, i);
if(at->unprocessed_data)
at->unprocessed_data(at->_buffer,i);
i = 0;
}
}
}
int ATCmdParser_analyse_args(ATParser *at, char args[], char* arg_list[], int list_size)
{
char _in_prev = 0;
int arg_num = 1;
size_t len = strlen(args);
arg_list[0] = args;
for (int i = 0; i <= len; i++) {
debug_if(at->_dbg_on, "check %c, %d\r\n", args[i], len);
if (args[i] == ',') {
debug_if(at->_dbg_on, "find ,\r\n");
if (_in_prev == '\\') {
args[i - i] = ',';
memcpy(&args[i], &args[i + 1], len - (i + 1));
} else {
args[i] = 0;
arg_list[arg_num++] = &args[i + 1];
if (arg_num > list_size)
break;
}
}
_in_prev = args[i];
}
return arg_num;
}
void ATCmdParser_set_timeout(ATParser *at, int timeout)
{
at->character_timeout = timeout;
}
void ATCmdParser_set_unprocessed_cb(ATParser *at, void (*cb)(const char *,int ))
{
at->unprocessed_data = cb;
}
ATParser *ATCmdParser_init(serial_ops *hal, const char* output_delimiter, const char* input_delimiter, int timeout, bool debug)
{
ATParser *at = calloc(1, sizeof(ATParser));
at->_dbg_on = debug;
at->_output_delimiter = output_delimiter;
at->_output_delim_size = strlen(output_delimiter);
at->_input_delimiter = input_delimiter;
at->_input_delim_size = strlen(input_delimiter);
at->ops = hal;
at->ops->init(timeout);
return at;
}