forked from zephyrproject-rtos/zephyr
/
gsm_ppp.c
1891 lines (1571 loc) · 48.1 KB
/
gsm_ppp.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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2020 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT zephyr_gsm_ppp
#include <logging/log.h>
LOG_MODULE_REGISTER(modem_gsm, CONFIG_MODEM_LOG_LEVEL);
#include <stdlib.h>
#include <kernel.h>
#include <device.h>
#include <sys/ring_buffer.h>
#include <sys/util.h>
#include <net/ppp.h>
#include <drivers/modem/gsm_ppp.h>
#include <drivers/uart.h>
#include "gsm_ppp.h"
#include "modem_context.h"
#include "modem_iface_uart.h"
#include "modem_cmd_handler.h"
#include "drivers/modem/quectel.h"
#if IS_ENABLED(CONFIG_GSM_MUX)
#include <drivers/console/uart_mux.h>
#include "../console/gsm_mux.h"
#endif
#include <stdio.h>
#include <time.h>
#define GSM_UART_NODE DT_INST_BUS(0)
#define GSM_CMD_READ_BUF 128
#define GSM_CMD_AT_TIMEOUT K_SECONDS(2)
#define GSM_CMD_SETUP_TIMEOUT K_SECONDS(6)
#define GSM_RX_STACK_SIZE CONFIG_MODEM_GSM_RX_STACK_SIZE
#define GSM_WORKQ_STACK_SIZE 768
#define GSM_RECV_MAX_BUF 30
#define GSM_RECV_BUF_SIZE 128
#define GSM_ATTACH_RETRY_DELAY_MSEC 1000
#define GSM_RSSI_RETRY_DELAY_MSEC 2000
#define GSM_RSSI_RETRIES 10
#define GSM_RSSI_INVALID -1000
#if IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI)
#define GSM_RSSI_MAXVAL 0
#else
#define GSM_RSSI_MAXVAL -51
#endif
/* The ? can be a + or - */
static const char TIME_STRING_FORMAT[] = "\"yy/MM/dd,hh:mm:ss?zz\"";
#define TIME_STRING_DIGIT_STRLEN 2
#define TIME_STRING_SEPARATOR_STRLEN 1
#define TIME_STRING_PLUS_MINUS_INDEX (6 * 3)
#define TIME_STRING_FIRST_SEPARATOR_INDEX 0
#define TIME_STRING_FIRST_DIGIT_INDEX 1
#define TIME_STRING_TO_TM_STRUCT_YEAR_OFFSET (2000 - 1900)
/* Time structure min, max */
#define TM_YEAR_RANGE 0, 99
#define TM_MONTH_RANGE_PLUS_1 1, 12
#define TM_DAY_RANGE 1, 31
#define TM_HOUR_RANGE 0, 23
#define TM_MIN_RANGE 0, 59
#define TM_SEC_RANGE 0, 60 /* leap second */
#define QUARTER_HOUR_RANGE 0, 96
#define SECONDS_PER_QUARTER_HOUR (15 * 60)
#define SIZE_OF_NUL 1
static struct gsm_modem {
struct modem_context context;
struct modem_cmd_handler_data cmd_handler_data;
uint8_t cmd_match_buf[GSM_CMD_READ_BUF];
struct k_sem sem_response;
struct modem_iface_uart_data gsm_data;
struct k_work_delayable gsm_configure_work;
char gsm_rx_rb_buf[PPP_MRU * 3];
uint8_t *ppp_recv_buf;
size_t ppp_recv_buf_len;
enum gsm_ppp_state {
GSM_PPP_START,
GSM_PPP_PWR_SRC_OFF,
GSM_PPP_PWR_SRC_ON,
GSM_PPP_WAIT_AT,
GSM_PPP_AT_RDY,
GSM_PPP_MUX_ENABLED,
GSM_PPP_STATE_INIT,
GSM_PPP_STATE_CONTROL_CHANNEL = GSM_PPP_STATE_INIT,
GSM_PPP_STATE_PPP_CHANNEL,
GSM_PPP_STATE_AT_CHANNEL,
GSM_PPP_STATE_DONE,
GSM_PPP_SETUP = GSM_PPP_STATE_DONE,
GSM_PPP_ATTACHING,
GSM_PPP_ATTACHED,
GSM_PPP_SETUP_DONE,
GSM_PPP_STOP,
GSM_PPP_STATE_ERROR,
} state;
gsm_modem_gnss_cb gnss_on_cb;
const struct device *ppp_dev;
const struct device *at_dev;
const struct device *control_dev;
bool local_time_valid : 1;
int32_t local_time_offset;
struct tm local_time;
struct net_if *iface;
int rssi_retries;
int attach_retries;
struct k_thread rx_thread;
struct k_work_q workq;
struct k_work_delayable rssi_work_handle;
struct k_sem gnss_ready_sem;
struct k_work_delayable gnss_configure_work;
bool gnss_enabled;
enum ppp_gnss_state {
PPP_GNSS_OFF,
PPP_GNSS_STARTING,
PPP_GNSS_CFG_OUTPORT,
PPP_GNSS_CFG_CONSTELLATION,
PPP_GNSS_CFG_NMEA,
PPP_GNSS_CFG_SUPLVER,
PPP_GNSS_CFG_PLANE,
PPP_GNSS_CFG_SUPLURL,
PPP_GNSS_CFG_TOKEN,
PPP_GNSS_CFG_LATORDER,
PPP_GNSS_CFG_TURN_ON,
PPP_GNSS_READY,
} gnss_state;
struct qlbs_coordinates gnss_coordinates;
} gsm;
NET_BUF_POOL_DEFINE(gsm_recv_pool, GSM_RECV_MAX_BUF, GSM_RECV_BUF_SIZE,
0, NULL);
K_KERNEL_STACK_DEFINE(gsm_rx_stack, GSM_RX_STACK_SIZE);
K_KERNEL_STACK_DEFINE(gsm_workq_stack, GSM_WORKQ_STACK_SIZE);
static inline int gsm_work_reschedule(struct k_work_delayable *dwork, k_timeout_t delay)
{
return k_work_reschedule_for_queue(&gsm.workq, dwork, delay);
}
#if IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI)
/* helper macro to keep readability */
#define ATOI(s_, value_, desc_) modem_atoi(s_, value_, desc_, __func__)
/**
* @brief Convert string to long integer, but handle errors
*
* @param s: string with representation of integer number
* @param err_value: on error return this value instead
* @param desc: name the string being converted
* @param func: function where this is called (typically __func__)
*
* @retval return integer conversion on success, or err_value on error
*/
static int modem_atoi(const char *s, const int err_value,
const char *desc, const char *func)
{
int ret;
char *endptr;
ret = (int)strtol(s, &endptr, 10);
if (!endptr || *endptr != '\0') {
LOG_ERR("bad %s '%s' in %s", log_strdup(s),
log_strdup(desc), log_strdup(func));
return err_value;
}
return ret;
}
#endif /* IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI) */
static void gsm_rx(struct gsm_modem *gsm)
{
LOG_DBG("starting");
while (true) {
(void)k_sem_take(&gsm->gsm_data.rx_sem, K_FOREVER);
/* The handler will listen AT channel */
gsm->context.cmd_handler.process(&gsm->context.cmd_handler,
&gsm->context.iface);
}
}
MODEM_CMD_DEFINE(gsm_cmd_ok)
{
modem_cmd_handler_set_error(data, 0);
LOG_DBG("ok");
k_sem_give(&gsm.sem_response);
return 0;
}
MODEM_CMD_DEFINE(gsm_cmd_error)
{
modem_cmd_handler_set_error(data, -EINVAL);
LOG_DBG("error");
k_sem_give(&gsm.sem_response);
return 0;
}
/* Handler: Modem initialization ready. */
MODEM_CMD_DEFINE(on_cmd_unsol_rdy)
{
LOG_WRN("Modem %s", "AT RDY");
return 0;
}
static const struct modem_cmd response_cmds[] = {
MODEM_CMD("OK", gsm_cmd_ok, 0U, ""),
MODEM_CMD("ERROR", gsm_cmd_error, 0U, ""),
MODEM_CMD("CONNECT", gsm_cmd_ok, 0U, ""),
};
static const struct modem_cmd unsol_cmds[] = {
MODEM_CMD("RDY", on_cmd_unsol_rdy, 0U, ""),
};
static int unquoted_atoi(const char *s, int base)
{
if (*s == '"') {
s++;
}
return strtol(s, NULL, base);
}
/*
* Handler: +COPS: <mode>[0],<format>[1],<oper>[2]
*/
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_cops)
{
if (argc >= 1) {
#if defined(CONFIG_MODEM_CELL_INFO)
if (argc >= 3) {
gsm.context.data_operator = unquoted_atoi(argv[2], 10);
LOG_INF("operator: %u",
gsm.context.data_operator);
}
#endif
if (unquoted_atoi(argv[0], 10) == 0) {
gsm.context.is_automatic_oper = true;
} else {
gsm.context.is_automatic_oper = false;
}
}
return 0;
}
#if IS_ENABLED(CONFIG_MODEM_GSM_INFO)
#define MDM_MANUFACTURER_LENGTH 10
#define MDM_MODEL_LENGTH 16
#define MDM_REVISION_LENGTH 64
#define MDM_IMEI_LENGTH 16
#define MDM_IMSI_LENGTH 16
#define MDM_ICCID_LENGTH 32
struct modem_info {
char mdm_manufacturer[MDM_MANUFACTURER_LENGTH];
char mdm_model[MDM_MODEL_LENGTH];
char mdm_revision[MDM_REVISION_LENGTH];
char mdm_imei[MDM_IMEI_LENGTH];
#if IS_ENABLED(CONFIG_MODEM_SIM_NUMBERS)
char mdm_imsi[MDM_IMSI_LENGTH];
char mdm_iccid[MDM_ICCID_LENGTH];
#endif
};
static struct modem_info minfo;
/*
* Provide modem info if modem shell is enabled. This can be shown with
* "modem list" shell command.
*/
/* Handler: <manufacturer> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_manufacturer)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_manufacturer,
sizeof(minfo.mdm_manufacturer) - 1,
data->rx_buf, 0, len);
minfo.mdm_manufacturer[out_len] = '\0';
LOG_INF("Manufacturer: %s", log_strdup(minfo.mdm_manufacturer));
return 0;
}
/* Handler: <model> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_model)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_model,
sizeof(minfo.mdm_model) - 1,
data->rx_buf, 0, len);
minfo.mdm_model[out_len] = '\0';
LOG_INF("Model: %s", log_strdup(minfo.mdm_model));
return 0;
}
/* Handler: <rev> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_revision)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_revision,
sizeof(minfo.mdm_revision) - 1,
data->rx_buf, 0, len);
minfo.mdm_revision[out_len] = '\0';
LOG_INF("Revision: %s", log_strdup(minfo.mdm_revision));
return 0;
}
/* Handler: <IMEI> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_imei)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_imei, sizeof(minfo.mdm_imei) - 1,
data->rx_buf, 0, len);
minfo.mdm_imei[out_len] = '\0';
LOG_INF("IMEI: %s", log_strdup(minfo.mdm_imei));
return 0;
}
#if IS_ENABLED(CONFIG_MODEM_SIM_NUMBERS)
/* Handler: <IMSI> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_imsi)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_imsi, sizeof(minfo.mdm_imsi) - 1,
data->rx_buf, 0, len);
minfo.mdm_imsi[out_len] = '\0';
LOG_INF("IMSI: %s", log_strdup(minfo.mdm_imsi));
return 0;
}
/* Handler: <ICCID> */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_iccid)
{
size_t out_len;
out_len = net_buf_linearize(minfo.mdm_iccid, sizeof(minfo.mdm_iccid) - 1,
data->rx_buf, 0, len);
minfo.mdm_iccid[out_len] = '\0';
if (minfo.mdm_iccid[0] == '+') {
/* Seen on U-blox SARA: "+CCID: nnnnnnnnnnnnnnnnnnnn".
* Skip over the +CCID bit, which other modems omit.
*/
char *p = strchr(minfo.mdm_iccid, ' ');
if (p) {
size_t len = strlen(p+1);
memmove(minfo.mdm_iccid, p+1, len+1);
}
}
LOG_INF("ICCID: %s", log_strdup(minfo.mdm_iccid));
return 0;
}
#endif /* CONFIG_MODEM_SIM_NUMBERS */
#if IS_ENABLED(CONFIG_MODEM_CELL_INFO)
/*
* Handler: +CEREG: <n>[0],<stat>[1],<tac>[2],<ci>[3],<AcT>[4]
*/
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_cereg)
{
if (argc >= 4) {
gsm.context.data_lac = unquoted_atoi(argv[2], 16);
gsm.context.data_cellid = unquoted_atoi(argv[3], 16);
LOG_INF("lac: %u, cellid: %u",
gsm.context.data_lac,
gsm.context.data_cellid);
}
return 0;
}
static const struct setup_cmd query_cellinfo_cmds[] = {
SETUP_CMD_NOHANDLE("AT+CEREG=2"),
SETUP_CMD("AT+CEREG?", "", on_cmd_atcmdinfo_cereg, 5U, ","),
SETUP_CMD_NOHANDLE("AT+COPS=3,2"),
SETUP_CMD("AT+COPS?", "", on_cmd_atcmdinfo_cops, 3U, ","),
};
static int gsm_query_cellinfo(struct gsm_modem *gsm)
{
int ret;
ret = modem_cmd_handler_setup_cmds_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
query_cellinfo_cmds,
ARRAY_SIZE(query_cellinfo_cmds),
&gsm->sem_response,
GSM_CMD_SETUP_TIMEOUT);
if (ret < 0) {
LOG_WRN("modem query for cell info returned %d", ret);
}
return ret;
}
#endif /* CONFIG_MODEM_CELL_INFO */
#endif /* CONFIG_MODEM_GSM_INFO */
#if IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI)
/*
* Handler: +CESQ: <rxlev>[0],<ber>[1],<rscp>[2],<ecn0>[3],<rsrq>[4],<rsrp>[5]
*/
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_rssi_cesq)
{
int rsrp, rscp, rxlev;
rsrp = ATOI(argv[5], 0, "rsrp");
rscp = ATOI(argv[2], 0, "rscp");
rxlev = ATOI(argv[0], 0, "rxlev");
if (rsrp >= 0 && rsrp <= 97) {
gsm.context.data_rssi = -140 + (rsrp - 1);
LOG_INF("RSRP: %d", gsm.context.data_rssi);
} else if (rscp >= 0 && rscp <= 96) {
gsm.context.data_rssi = -120 + (rscp - 1);
LOG_INF("RSCP: %d", gsm.context.data_rssi);
} else if (rxlev >= 0 && rxlev <= 63) {
gsm.context.data_rssi = -110 + (rxlev - 1);
LOG_INF("RSSI: %d", gsm.context.data_rssi);
} else {
gsm.context.data_rssi = GSM_RSSI_INVALID;
LOG_INF("RSRP/RSCP/RSSI not known");
}
return 0;
}
#else
/* Handler: +CSQ: <signal_power>[0],<qual>[1] */
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_rssi_csq)
{
/* Expected response is "+CSQ: <signal_power>,<qual>" */
if (argc) {
int rssi = atoi(argv[0]);
if (rssi >= 0 && rssi <= 31) {
rssi = -113 + (rssi * 2);
} else {
rssi = GSM_RSSI_INVALID;
}
gsm.context.data_rssi = rssi;
LOG_INF("RSSI: %d", rssi);
}
k_sem_give(&gsm.sem_response);
return 0;
}
#endif /* CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI */
/* Handler: +QLBS: <?>[0],<lat>[1],<lon>[2] */
MODEM_CMD_DEFINE(on_cmd_gnss_qlbs)
{
int lat, lon;
gsm.gnss_coordinates.error = atoi(argv[0]);
gsm.gnss_coordinates.latitude = strtod(argv[1], NULL);
gsm.gnss_coordinates.longitude = strtod(argv[2], NULL);
lat = gsm.gnss_coordinates.latitude * 1000000;
lon = gsm.gnss_coordinates.longitude * 1000000;
LOG_WRN("[%d] %d.%d, %d.%d", gsm.gnss_coordinates.error, lat / 1000000, lat % 1000000,
lon / 1000000, lon % 1000000);
return 0;
}
#if IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI)
static const struct modem_cmd read_rssi_cmd =
MODEM_CMD("+CESQ:", on_cmd_atcmdinfo_rssi_cesq, 6U, ",");
#else
static const struct modem_cmd read_rssi_cmd =
MODEM_CMD("+CSQ:", on_cmd_atcmdinfo_rssi_csq, 2U, ",");
#endif /* CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI */
static const struct setup_cmd setup_cmds[] = {
/* no echo */
SETUP_CMD_NOHANDLE("ATE0"),
/* hang up */
SETUP_CMD_NOHANDLE("ATH"),
/* extender errors in numeric form */
SETUP_CMD_NOHANDLE("AT+CMEE=1"),
#if IS_ENABLED(CONFIG_MODEM_GSM_INFO)
/* query modem info */
SETUP_CMD("AT+CGMI", "", on_cmd_atcmdinfo_manufacturer, 0U, ""),
SETUP_CMD("AT+CGMM", "", on_cmd_atcmdinfo_model, 0U, ""),
SETUP_CMD("AT+CGMR", "", on_cmd_atcmdinfo_revision, 0U, ""),
# if IS_ENABLED(CONFIG_MODEM_SIM_NUMBERS)
SETUP_CMD("AT+CIMI", "", on_cmd_atcmdinfo_imsi, 0U, ""),
SETUP_CMD("AT+CCID", "", on_cmd_atcmdinfo_iccid, 0U, ""),
# endif
SETUP_CMD("AT+CGSN", "", on_cmd_atcmdinfo_imei, 0U, ""),
#endif /* CONFIG_MODEM_GSM_INFO */
/* disable unsolicited network registration codes */
SETUP_CMD_NOHANDLE("AT+CREG=0"),
/* disable xtradata */
SETUP_CMD_NOHANDLE("AT+QGPSXTRA=0"),
/* create PDP context */
SETUP_CMD_NOHANDLE("AT+CGDCONT=1,\"IP\",\"" CONFIG_MODEM_GSM_APN "\""),
};
static bool valid_time_string(const char *time_string)
{
size_t offset, i;
/* Ensure that all the expected delimiters are present */
offset = TIME_STRING_DIGIT_STRLEN + TIME_STRING_SEPARATOR_STRLEN;
i = TIME_STRING_FIRST_SEPARATOR_INDEX;
for (; i < TIME_STRING_PLUS_MINUS_INDEX; i += offset) {
if (time_string[i] != TIME_STRING_FORMAT[i]) {
return false;
}
}
/* The last character is the offset from UTC and can be either
* positive or negative. The last " is also handled here.
*/
if ((time_string[i] == '+' || time_string[i] == '-') && (time_string[i + offset] == '"')) {
return true;
}
return false;
}
static int get_next_time_string_digit(int *failure_cnt, char **pp, int min, int max)
{
char digits[TIME_STRING_DIGIT_STRLEN + SIZE_OF_NUL];
int result;
memset(digits, 0, sizeof(digits));
memcpy(digits, *pp, TIME_STRING_DIGIT_STRLEN);
*pp += TIME_STRING_DIGIT_STRLEN + TIME_STRING_SEPARATOR_STRLEN;
result = strtol(digits, NULL, 10);
if (result > max) {
*failure_cnt += 1;
return max;
} else if (result < min) {
*failure_cnt += 1;
return min;
} else {
return result;
}
}
static bool convert_time_string_to_struct(struct tm *tm, int32_t *offset, char *time_string)
{
int fc = 0;
char *ptr = time_string;
if (!valid_time_string(ptr)) {
LOG_INF("Invalid timestring");
return false;
}
ptr = &ptr[TIME_STRING_FIRST_DIGIT_INDEX];
tm->tm_year = TIME_STRING_TO_TM_STRUCT_YEAR_OFFSET +
get_next_time_string_digit(&fc, &ptr, TM_YEAR_RANGE);
tm->tm_mon = get_next_time_string_digit(&fc, &ptr, TM_MONTH_RANGE_PLUS_1) - 1;
tm->tm_mday = get_next_time_string_digit(&fc, &ptr, TM_DAY_RANGE);
tm->tm_hour = get_next_time_string_digit(&fc, &ptr, TM_HOUR_RANGE);
tm->tm_min = get_next_time_string_digit(&fc, &ptr, TM_MIN_RANGE);
tm->tm_sec = get_next_time_string_digit(&fc, &ptr, TM_SEC_RANGE);
tm->tm_isdst = 0;
*offset = (int32_t)get_next_time_string_digit(&fc, &ptr, QUARTER_HOUR_RANGE) *
SECONDS_PER_QUARTER_HOUR;
if (time_string[TIME_STRING_PLUS_MINUS_INDEX] == '-') {
*offset *= -1;
}
return (fc == 0);
}
MODEM_CMD_DEFINE(on_cmd_rtc_query)
{
size_t str_len = sizeof(TIME_STRING_FORMAT) - 1;
char rtc_string[sizeof(TIME_STRING_FORMAT)];
memset(rtc_string, 0, sizeof(rtc_string));
gsm.local_time_valid = false;
if (len != str_len) {
LOG_WRN("Unexpected length for RTC string %d (expected:%d)",
len, str_len);
} else {
net_buf_linearize(rtc_string, str_len, data->rx_buf, 0, str_len);
LOG_INF("RTC string: '%s'", log_strdup(rtc_string));
gsm.local_time_valid = convert_time_string_to_struct(
&gsm.local_time, &gsm.local_time_offset, rtc_string);
}
return true;
}
int32_t gsm_ppp_get_local_time(const struct device *dev, struct tm *tm, int32_t *offset)
{
int ret;
struct modem_cmd cmd = MODEM_CMD("+CCLK: ", on_cmd_rtc_query, 0U, "");
struct gsm_modem *gsm = dev->data;
gsm->local_time_valid = false;
ret = modem_cmd_send(&gsm->context.iface, &gsm->context.cmd_handler, &cmd, 1U, "AT+CCLK?",
&gsm->sem_response, GSM_CMD_AT_TIMEOUT);
if (gsm->local_time_valid) {
memcpy(tm, &gsm->local_time, sizeof(struct tm));
memcpy(offset, &gsm->local_time_offset, sizeof(*offset));
} else {
ret = -EIO;
}
return ret;
}
int gsm_ppp_get_qlbs(const struct device *dev, struct qlbs_coordinates *coordinates,
k_timeout_t timeout)
{
int ret;
struct modem_cmd cmd = MODEM_CMD("+QLBS: ", on_cmd_gnss_qlbs, 3U, ",");
struct gsm_modem *gsm = dev->data;
if (!IS_ENABLED(CONFIG_MODEM_GSM_QUECTELL_GNSS_QLOC)) {
return -EACCES;
}
if (gsm->gnss_state != PPP_GNSS_READY)
{
LOG_WRN("GNSS not ready");
return -EIO;
}
if (gsm->state != GSM_PPP_ATTACHED && gsm->state != GSM_PPP_SETUP_DONE)
{
LOG_WRN("Not attached");
return -EIO;
}
ret = modem_cmd_send(&gsm->context.iface, &gsm->context.cmd_handler, &cmd, 1U, "AT+QLBS",
&gsm->sem_response, timeout);
if (!ret)
{
(void)memcpy(coordinates, &gsm->gnss_coordinates, sizeof(struct qlbs_coordinates));
}
return ret;
}
MODEM_CMD_DEFINE(on_cmd_atcmdinfo_attached)
{
int error = -EAGAIN;
/* Expected response is "+CGATT: 0|1" so simply look for '1' */
if (argc && atoi(argv[0]) == 1) {
error = 0;
LOG_INF("Attached to packet service!");
}
modem_cmd_handler_set_error(data, error);
// k_sem_give(&gsm.sem_response);
return 0;
}
static const struct modem_cmd read_cops_cmd =
MODEM_CMD_ARGS_MAX("+COPS:", on_cmd_atcmdinfo_cops, 1U, 4U, ",");
static const struct modem_cmd check_attached_cmd =
MODEM_CMD("+CGATT:", on_cmd_atcmdinfo_attached, 1U, ",");
static const struct setup_cmd connect_cmds[] = {
/* connect to network */
SETUP_CMD_NOHANDLE("ATD*99#"),
};
static int gsm_setup_mccmno(struct gsm_modem *gsm)
{
int ret = 0;
if (CONFIG_MODEM_GSM_MANUAL_MCCMNO[0]) {
/* use manual MCC/MNO entry */
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
NULL, 0,
"AT+COPS=1,2,\""
CONFIG_MODEM_GSM_MANUAL_MCCMNO
"\"",
&gsm->sem_response,
GSM_CMD_AT_TIMEOUT);
} else {
/* First AT+COPS? is sent to check if automatic selection for operator
* is already enabled, if yes we do not send the command AT+COPS= 0,0.
*/
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
&read_cops_cmd,
1, "AT+COPS?",
&gsm->sem_response,
GSM_CMD_SETUP_TIMEOUT);
if (ret < 0) {
return ret;
}
if (!gsm->context.is_automatic_oper) {
/* register operator automatically */
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
NULL, 0, "AT+COPS=0,0",
&gsm->sem_response,
GSM_CMD_AT_TIMEOUT);
}
}
if (ret < 0) {
LOG_ERR("AT+COPS ret:%d", ret);
}
return ret;
}
static struct net_if *ppp_net_if(void)
{
return net_if_get_first_by_type(&NET_L2_GET_NAME(PPP));
}
static void set_ppp_carrier_on(struct gsm_modem *gsm)
{
static const struct ppp_api *api;
const struct device *ppp_dev = device_get_binding(CONFIG_NET_PPP_DRV_NAME);
struct net_if *iface = gsm->iface;
int ret;
if (!ppp_dev) {
LOG_ERR("Cannot find PPP %s!", CONFIG_NET_PPP_DRV_NAME);
return;
}
if (!api) {
api = (const struct ppp_api *)ppp_dev->api;
/* For the first call, we want to call ppp_start()... */
ret = api->start(ppp_dev);
if (ret) {
LOG_ERR("ppp start returned %d", ret);
}
} else {
/* ...but subsequent calls should be to ppp_enable() */
ret = net_if_l2(iface)->enable(iface, true);
if (ret) {
LOG_ERR("ppp l2 enable returned %d", ret);
}
}
}
static void rssi_handler(struct k_work *work)
{
struct k_work_delayable *dwork = k_work_delayable_from_work(work);
struct gsm_modem *gsm = CONTAINER_OF(dwork, struct gsm_modem, rssi_work_handle);
int ret;
#if IS_ENABLED(CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI)
ret = modem_cmd_send_nolock(&gsm->context.iface, &gsm->context.cmd_handler,
&read_rssi_cmd, 1, "AT+CESQ", &gsm->sem_response, GSM_CMD_SETUP_TIMEOUT);
#else
ret = modem_cmd_send_nolock(&gsm->context.iface, &gsm->context.cmd_handler,
&read_rssi_cmd, 1, "AT+CSQ", &gsm->sem_response, GSM_CMD_SETUP_TIMEOUT);
#endif /* CONFIG_MODEM_GSM_ENABLE_CESQ_RSSI */
if (ret < 0) {
LOG_DBG("No answer to RSSI readout, %s", "ignoring...");
}
#if IS_ENABLED(CONFIG_GSM_MUX)
#if IS_ENABLED(CONFIG_MODEM_CELL_INFO)
(void) gsm_query_cellinfo(gsm);
#endif
gsm_work_reschedule(&gsm->rssi_work_handle, K_SECONDS(CONFIG_MODEM_GSM_RSSI_POLLING_PERIOD));
#endif /* CONFIG_GSM_MUX */
}
static void gsm_finalize_connection(struct k_work *work)
{
int ret = 0;
struct k_work_delayable *dwork = k_work_delayable_from_work(work);
struct gsm_modem *gsm = CONTAINER_OF(dwork, struct gsm_modem,
gsm_configure_work);
/* If already attached, jump right to RSSI readout */
if (gsm->state == GSM_PPP_ATTACHED) {
goto attached;
}
/* If attach check failed, we should not redo every setup step */
if (gsm->state == GSM_PPP_ATTACHING) {
goto attaching;
}
gsm->state = GSM_PPP_SETUP;
#if IS_ENABLED(CONFIG_GSM_MUX)
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
&response_cmds[0],
ARRAY_SIZE(response_cmds),
"AT", &gsm->sem_response,
GSM_CMD_AT_TIMEOUT);
if (ret < 0) {
LOG_ERR("AT returned %d, %s",
ret, "retrying...");
(void)gsm_work_reschedule(&gsm->gsm_configure_work,
K_SECONDS(1));
return;
}
#endif
#if IS_ENABLED(CONFIG_MODEM_GSM_FACTORY_RESET_AT_BOOT)
(void)modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
&response_cmds[0],
ARRAY_SIZE(response_cmds),
"AT&F", &gsm->sem_response,
GSM_CMD_AT_TIMEOUT);
k_sleep(K_SECONDS(1));
#endif
ret = gsm_setup_mccmno(gsm);
if (ret < 0) {
LOG_ERR("gsm_setup_mccmno returned %d, %s",
ret, "retrying...");
(void)gsm_work_reschedule(&gsm->gsm_configure_work,
K_SECONDS(1));
return;
}
ret = modem_cmd_handler_setup_cmds_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
setup_cmds,
ARRAY_SIZE(setup_cmds),
&gsm->sem_response,
GSM_CMD_SETUP_TIMEOUT);
if (ret < 0) {
LOG_DBG("setup_cmds returned %d, %s",
ret, "retrying...");
(void)gsm_work_reschedule(&gsm->gsm_configure_work, K_SECONDS(1));
return;
}
attaching:
gsm->state = GSM_PPP_ATTACHING;
/* Don't initialize PPP until we're attached to packet service */
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
&check_attached_cmd, 1,
"AT+CGATT?",
&gsm->sem_response,
GSM_CMD_SETUP_TIMEOUT);
if (ret < 0) {
/*
* attach_retries not set -> trigger N attach retries
* attach_retries set -> decrement and retry
* attach_retries set, becomes 0 -> trigger full retry
*/
if (!gsm->attach_retries) {
gsm->attach_retries = CONFIG_MODEM_GSM_ATTACH_TIMEOUT *
MSEC_PER_SEC / GSM_ATTACH_RETRY_DELAY_MSEC;
} else {
gsm->attach_retries--;
}
LOG_DBG("Not attached, %s", "retrying...");
(void)gsm_work_reschedule(&gsm->gsm_configure_work,
K_MSEC(GSM_ATTACH_RETRY_DELAY_MSEC));
return;
}
/* Attached, clear retry counter */
gsm->state = GSM_PPP_ATTACHED;
gsm->attach_retries = 0;
LOG_DBG("modem attach returned %d, %s", ret, "read RSSI");
gsm->rssi_retries = GSM_RSSI_RETRIES;
attached:
#if !IS_ENABLED(CONFIG_GSM_MUX)
/* Read connection quality (RSSI) before PPP carrier is ON */
rssi_handler(&gsm->rssi_work_handler.work);
if (!(gsm->context.data_rssi && gsm->context.data_rssi != GSM_RSSI_INVALID &&
gsm->context.data_rssi < GSM_RSSI_MAXVAL)) {
LOG_DBG("Not valid RSSI, %s", "retrying...");
if (gsm->rssi_retries-- > 0) {
(void)gsm_work_reschedule(&gsm->gsm_configure_work,
K_MSEC(GSM_RSSI_RETRY_DELAY_MSEC));
return;
}
}
#if IS_ENABLED(CONFIG_MODEM_CELL_INFO)
(void) gsm_query_cellinfo(gsm);
#endif
#endif /* !IS_ENABLED(CONFIG_GSM_MUX) */
LOG_DBG("modem setup returned %d, %s", ret, "enable PPP");
ret = modem_cmd_handler_setup_cmds_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
connect_cmds,
ARRAY_SIZE(connect_cmds),
&gsm->sem_response,
GSM_CMD_SETUP_TIMEOUT);
if (ret < 0) {
LOG_DBG("modem setup returned %d, %s",
ret, "retrying...");
(void)gsm_work_reschedule(&gsm->gsm_configure_work, K_SECONDS(1));
return;
}
gsm->state = GSM_PPP_SETUP_DONE;
set_ppp_carrier_on(gsm);
#if IS_ENABLED(CONFIG_GSM_MUX)
/* Re-use the original iface for AT channel */
ret = modem_iface_uart_init_dev(&gsm->context.iface,
gsm->at_dev);
if (ret < 0) {
LOG_DBG("iface %suart error %d", "AT ", ret);
} else {
/* Do a test and try to send AT command to modem */
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,
&response_cmds[0],
ARRAY_SIZE(response_cmds),
"AT", &gsm->sem_response,
GSM_CMD_AT_TIMEOUT);
if (ret < 0) {
LOG_WRN("modem setup returned %d, %s",
ret, "AT cmds failed");
} else {
LOG_INF("AT channel %d connected to %s",
DLCI_AT, gsm->at_dev->name);
}
}
modem_cmd_handler_tx_unlock(&gsm->context.cmd_handler);
k_work_schedule(&gsm->rssi_work_handle, K_SECONDS(CONFIG_MODEM_GSM_RSSI_POLLING_PERIOD));
#endif /* CONFIG_GSM_MUX */
}
#if IS_ENABLED(CONFIG_GSM_MUX)
static int mux_enable(struct gsm_modem *gsm)
{
int ret = 0;
/* Turn on muxing */
#if IS_ENABLED(CONFIG_MODEM_GSM_SIMCOM)
ret = modem_cmd_send_nolock(&gsm->context.iface,
&gsm->context.cmd_handler,