-
Notifications
You must be signed in to change notification settings - Fork 90
/
u_cell_cfg.c
2445 lines (2177 loc) · 94.7 KB
/
u_cell_cfg.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 2019-2024 u-blox
*
* 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.
*/
/* Only #includes of u_* and the C standard library are allowed here,
* no platform stuff and no OS stuff. Anything required from
* the platform/OS must be brought in through u_port* to maintain
* portability.
*/
/** @file
* @brief Implementation of the cfg API for cellular.
*/
#ifdef U_CFG_OVERRIDE
# include "u_cfg_override.h" // For a customer's configuration override
#endif
#include "stdlib.h" // strol(), atoi(), strol(), strtof()
#include "stddef.h" // NULL, size_t etc.
#include "stdint.h" // int32_t etc.
#include "stdio.h" // snprintf()
#include "stdbool.h"
#include "string.h" // memset()
#include "time.h" // time_t and struct tm
#include "u_cfg_sw.h"
#include "u_error_common.h"
#include "u_port_clib_platform_specific.h" /* gmtime_r(), snprintf(), must be included
before the other port files. */
#include "u_port_debug.h"
#include "u_port_os.h"
#include "u_port_heap.h"
#include "u_timeout.h"
#include "u_at_client.h"
#include "u_cell_module_type.h"
#include "u_cell_file.h"
#include "u_cell.h" // Order is
#include "u_cell_net.h" // important here
#include "u_cell_private.h" // don't change it
#include "u_cell_cfg.h"
/* ----------------------------------------------------------------
* COMPILE-TIME MACROS
* -------------------------------------------------------------- */
/* ----------------------------------------------------------------
* TYPES
* -------------------------------------------------------------- */
/* ----------------------------------------------------------------
* VARIABLES
* -------------------------------------------------------------- */
/** Table to convert uCellNetRat_t to the value used in
* CONFIGURING the module, SARA_U201 form.
*/
static const int8_t gCellRatToModuleRatU201[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
0, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
2, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
-1, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* CONFIGURING the module, SARA-R4/R5 form.
*/
static const int8_t gCellRatToModuleRatR4R5[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
9, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
-1, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
-1, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
7, // U_CELL_NET_RAT_CATM1
8, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* CONFIGURING the module, LARA-R6 form.
*/
static const int8_t gCellRatToModuleRatR6[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
0, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
2, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* CONFIGURING the module, LENA-R8 form.
*/
static const int8_t gCellRatToModuleRatR8[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
0, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
2, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
1, // U_CELL_NET_RAT_GSM_UMTS
4, // U_CELL_NET_RAT_GSM_UMTS_LTE
5, // U_CELL_NET_RAT_GSM_LTE
6 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* CONFIGURING the module, LEXI-R10 form.
*/
static const int8_t gCellRatToModuleRatR10[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
-1, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
-1, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* setting the bandmask, SARA-R4/R5 form.
*/
static const int8_t gCellRatToModuleRatBandMaskR4R5[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
-1, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
-1, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
-1, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
0, // U_CELL_NET_RAT_CATM1
1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* setting the bandmask, LARA-R6 form.
*/
static const int8_t gCellRatToModuleRatBandMaskR6[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
2, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
2, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* setting the bandmask, LENA-R8 form.
*/
static const int8_t gCellRatToModuleRatBandMaskR8[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
0, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
2, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert uCellNetRat_t to the value used in
* setting the bandmask, LEXI-R10 form.
*/
static const int8_t gCellRatToModuleRatBandMaskR10[] = {
-1, // Dummy value for U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED
-1, // U_CELL_NET_RAT_GSM_GPRS_EGPRS: 2G
-1, // U_CELL_NET_RAT_GSM_COMPACT
-1, // U_CELL_NET_RAT_UTRAN: 3G
-1, // U_CELL_NET_RAT_EGPRS
-1, // U_CELL_NET_RAT_HSDPA
-1, // U_CELL_NET_RAT_HSUPA
-1, // U_CELL_NET_RAT_HSDPA_HSUPA
3, // U_CELL_NET_RAT_LTE
-1, // U_CELL_NET_RAT_EC_GSM
-1, // U_CELL_NET_RAT_CATM1
-1, // U_CELL_NET_RAT_NB1
-1, // U_CELL_NET_RAT_GSM_UMTS
-1, // U_CELL_NET_RAT_GSM_UMTS_LTE
-1, // U_CELL_NET_RAT_GSM_LTE
-1 // U_CELL_NET_RAT_UMTS_LTE
};
/** Table to convert the RAT values used in the
* module while reading the bandmask to uCellNetRat_t,
* R4/R5 version.
*/
static const uCellNetRat_t gModuleRatBandMaskToCellRatR4R5[] = {
U_CELL_NET_RAT_CATM1, // 0: Cat-M1
U_CELL_NET_RAT_NB1 // 1: NB1
};
/** Table to convert the RAT values used in the
* module while reading the bandmask to uCellNetRat_t,
* R6 version.
*/
static const uCellNetRat_t gModuleRatBandMaskToCellRatR6[] = {
U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED, // 0: Cat-M1
U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED, // 1: NB1
U_CELL_NET_RAT_GSM_GPRS_EGPRS, // 2: 2G (also applied to UTRAN)
U_CELL_NET_RAT_LTE // 3: LTE
};
/** All the parameters for the greeting callback.
*/
typedef struct {
uDeviceHandle_t cellHandle;
void (*pCallback) (uDeviceHandle_t, void *);
void *pCallbackParameter;
} uCellCfgGreeting_t;
/* ----------------------------------------------------------------
* STATIC FUNCTIONS: RAT CONVERSION
* -------------------------------------------------------------- */
// Convert our RAT to module RAT, usual case.
static int8_t cellRatToModuleRat(uCellModuleType_t moduleType, uCellNetRat_t rat)
{
int8_t moduleRat = -1;
switch (moduleType) {
case U_CELL_MODULE_TYPE_SARA_U201:
moduleRat = gCellRatToModuleRatU201[(int32_t) rat];
break;
case U_CELL_MODULE_TYPE_LARA_R6:
moduleRat = gCellRatToModuleRatR6[(int32_t) rat];
break;
case U_CELL_MODULE_TYPE_LENA_R8:
moduleRat = gCellRatToModuleRatR8[(int32_t) rat];
break;
case U_CELL_MODULE_TYPE_LEXI_R10:
moduleRat = gCellRatToModuleRatR10[(int32_t) rat];
break;
default:
moduleRat = gCellRatToModuleRatR4R5[(int32_t) rat];
break;
}
return moduleRat;
}
// Convert our RAT to module RAT, bandmask case.
static int8_t cellRatToModuleRatBandMask(uCellModuleType_t moduleType, uCellNetRat_t rat)
{
int8_t moduleRat = -1;
switch (moduleType) {
case U_CELL_MODULE_TYPE_LARA_R6:
moduleRat = gCellRatToModuleRatBandMaskR6[(int32_t) rat];
break;
case U_CELL_MODULE_TYPE_LENA_R8:
moduleRat = gCellRatToModuleRatBandMaskR8[(int32_t) rat];
break;
case U_CELL_MODULE_TYPE_LEXI_R10:
moduleRat = gCellRatToModuleRatBandMaskR10[(int32_t) rat];
break;
default:
moduleRat = gCellRatToModuleRatBandMaskR4R5[(int32_t) rat];
break;
}
return moduleRat;
}
// Convert the module RAT for the bandmask case to our RAT.
static uCellNetRat_t moduleRatBandMaskToCellRat(uCellModuleType_t moduleType, int32_t rat)
{
uCellNetRat_t cellRat = U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
// Need to do boundary checking here as the array sizes are different
if (rat >= 0) {
switch (moduleType) {
case U_CELL_MODULE_TYPE_LARA_R6:
if (rat < sizeof(gModuleRatBandMaskToCellRatR6) / sizeof(gModuleRatBandMaskToCellRatR6[0])) {
cellRat = gModuleRatBandMaskToCellRatR6[rat];
}
break;
// Don't need LENA-R8 as the form of the bandmask AT commands are different
default:
if (rat < sizeof(gModuleRatBandMaskToCellRatR4R5) / sizeof(gModuleRatBandMaskToCellRatR4R5[0])) {
cellRat = gModuleRatBandMaskToCellRatR4R5[rat];
}
break;
}
}
return cellRat;
}
/* ----------------------------------------------------------------
* STATIC FUNCTIONS: SARA-U2 RAT SETTING/GETTING BEHAVIOUR
* -------------------------------------------------------------- */
// Set the given COPS if it's not already the given one, returning
// the one it was, if you see what I mean.
static int32_t setCops(uAtClientHandle_t atHandle, int32_t cops)
{
int32_t x;
int32_t errorCodeOrCops;
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+COPS?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+COPS:");
x = uAtClientReadInt(atHandle);
uAtClientResponseStop(atHandle);
errorCodeOrCops = uAtClientUnlock(atHandle);
if (errorCodeOrCops == 0) {
errorCodeOrCops = x;
if (errorCodeOrCops != cops) {
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+COPS=");
uAtClientWriteInt(atHandle, cops);
uAtClientCommandStopReadResponse(atHandle);
x = uAtClientUnlock(atHandle);
if (x < 0) {
errorCodeOrCops = x;
}
}
}
return errorCodeOrCops;
}
// Get the radio access technology that is being used by
// the cellular module at the given rank, SARA-U2 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static uCellNetRat_t getRatSaraU2(uCellPrivateInstance_t *pInstance,
int32_t rank)
{
int32_t errorOrRat = (int32_t) U_CELL_ERROR_AT;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t modes[U_CELL_PRIVATE_MAX_NUM_SIMULTANEOUS_RATS];
int32_t cFunMode;
// For SARA-U2, need to be in AT+CFUN=1 to get the RAT
cFunMode = uCellPrivateCFunOne(pInstance);
// In the SARA-U2 case the first "RAT" represents the operating
// mode and the second the preferred RAT in that operating mode
// if the first was dual mode, so here I call them "modes" rather
// than RATs.
// Assume there are no operating modes
for (size_t x = 0; x < sizeof(modes) / sizeof(modes[0]); x++) {
modes[x] = -1;
}
// Get the operating modes from the module
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+URAT:");
// Read up to N integers representing the modes
for (size_t x = 0; x < pInstance->pModule->maxNumSimultaneousRats; x++) {
modes[x] = uAtClientReadInt(atHandle);
}
uAtClientResponseStop(atHandle);
uAtClientUnlock(atHandle);
// Don't check error here as there may be fewer integers than we
// tried to read
if ((modes[0] == 0) || (modes[0] == 2)) {
errorOrRat = (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
// If the first mode is 0 (2G mode) or 2 (3G mode) then we are in
// single mode operation and that's that.
if (rank == 0) {
// If we were being asked for the RAT at rank 0, this is it
// as there is no other rank
errorOrRat = (int32_t) uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[0]);
}
uPortLog("U_CELL_CFG: RAT is %d (in module terms %d).\n",
errorOrRat, modes[0]);
} else if ((modes[0] == 1) && (modes[1] >= 0)) {
errorOrRat = (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
// If the first mode is 1, dual mode, then there MUST be a second
// number and that indicates the preference
if (rank == 0) {
// If we were being asked for the RAT at rank 0, this is it
errorOrRat = (int32_t) uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[1]);
} else if (rank == 1) {
// If we were being asked for the RAT at rank 1, it is
// the OTHER one, the non-preferred RAT, that we must report
if (modes[1] ==
cellRatToModuleRat(pInstance->pModule->moduleType, U_CELL_NET_RAT_GSM_GPRS_EGPRS)) {
errorOrRat = (int32_t)U_CELL_NET_RAT_UTRAN;
} else if (modes[1] == cellRatToModuleRat(pInstance->pModule->moduleType, U_CELL_NET_RAT_UTRAN)) {
errorOrRat = (int32_t) U_CELL_NET_RAT_GSM_GPRS_EGPRS;
}
}
uPortLog("U_CELL_CFG: RAT is %d (in module terms %d).\n",
errorOrRat, modes[1]);
}
// Put the AT+CFUN back if it was not already 1
if ((cFunMode >= 0) && (cFunMode != 1)) {
uCellPrivateCFunMode(pInstance, cFunMode);
}
return (uCellNetRat_t) errorOrRat;
}
// Get the rank at which the given RAT is being used, SARA-U2 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t getRatRankSaraU2(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCodeOrRank = (int32_t) U_CELL_ERROR_AT;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t modes[U_CELL_PRIVATE_MAX_NUM_SIMULTANEOUS_RATS];
int32_t cFunMode;
// For SARA-U2, need to be in AT+CFUN=1 to get the RAT
cFunMode = uCellPrivateCFunOne(pInstance);
// Not checking error here, what follows will fail if this
// fails anyway
// In the SARA-U2 case the first "RAT" represents the operating
// mode and the second the preferred RAT in that operating mode
// if the first was dual mode, so here I call them "modes" rather
// than RATs.
// Assume there are no operating modes
for (size_t x = 0; x < sizeof(modes) / sizeof(modes[0]); x++) {
modes[x] = -1;
}
// Get the operating modes from the module
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+URAT:");
// Read up to N integers representing the modes
for (size_t x = 0; x < pInstance->pModule->maxNumSimultaneousRats; x++) {
modes[x] = uAtClientReadInt(atHandle);
}
uAtClientResponseStop(atHandle);
uAtClientUnlock(atHandle);
// Don't check error here as there may be fewer integers than we
// tried to read
if ((modes[0] == 0) || (modes[0] == 2)) {
errorCodeOrRank = (int32_t) U_CELL_ERROR_NOT_FOUND;
// If the first mode is 0 (2G mode) or 2 (3G mode) then we are in
// single mode operation and so can check for the indicated
// RAT here
if (rat == uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[0])) {
errorCodeOrRank = 0;
}
} else if ((modes[0] == 1) && (modes[1] >= 0)) {
errorCodeOrRank = (int32_t) U_CELL_ERROR_NOT_FOUND;
// If the first mode is 1, dual mode, then there MUST be a second
// number which indicates the preference
// If the RAT being asked for is 2G or 3G then if it is in this
// second number it is at rank 0, else it must by implication
// be at rank 1
if ((rat == U_CELL_NET_RAT_GSM_GPRS_EGPRS) || (rat == U_CELL_NET_RAT_UTRAN)) {
errorCodeOrRank = 1;
if (rat == uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[1])) {
errorCodeOrRank = 0;
}
}
}
// Put the AT+CFUN mode back if it was not already 1
if ((cFunMode >= 0) && (cFunMode != 1)) {
uCellPrivateCFunMode(pInstance, cFunMode);
}
return errorCodeOrRank;
}
// Set RAT SARA-U2 stylee.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t setRatSaraU2(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCode;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t cFunMode;
int32_t cops;
// For SARA-U2, need to be in AT+CFUN=1 and AT+COPS=2 to set the RAT
cFunMode = uCellPrivateCFunOne(pInstance);
cops = setCops(atHandle, 2);
uPortLog("U_CELL_CFG: setting sole RAT to %d (in module terms %d).\n",
rat, cellRatToModuleRat(pInstance->pModule->moduleType, rat));
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT=");
uAtClientWriteInt(atHandle,
cellRatToModuleRat(pInstance->pModule->moduleType, rat));
uAtClientCommandStopReadResponse(atHandle);
errorCode = uAtClientUnlock(atHandle);
// Put AT+COPS back
if (cops >= 0) {
// Put COPS back
setCops(atHandle, cops);
}
// Put the AT+CFUN mode back if it was not already 1
if ((cFunMode >= 0) && (cFunMode != 1)) {
uCellPrivateCFunMode(pInstance, cFunMode);
}
return errorCode;
}
// Set RAT rank SARA-U2 stylee.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t setRatRankSaraU2(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat, int32_t rank)
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_INVALID_PARAMETER;
bool validOperation = false;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t modes[U_CELL_PRIVATE_MAX_NUM_SIMULTANEOUS_RATS];
int32_t cFunMode;
int32_t cops;
// In the SARA-U2 case the first "RAT" represents the operating
// mode and the second the preferred RAT in that operating mode
// if the first was dual mode, so here I call them "modes" rather
// than RATs.
// Assume there are no operating modes
for (size_t x = 0; x < sizeof(modes) / sizeof(modes[0]); x++) {
modes[x] = -1;
}
// For SARA-U2, need to be in AT+CFUN=1 to get the RAT
cFunMode = uCellPrivateCFunOne(pInstance);
cops = setCops(atHandle, 2);
// Get the existing operating modes
// Not checking error here, what follows will fail if this
// fails anyway
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+URAT:");
// Read up to N integers representing the modes
for (size_t x = 0; x < pInstance->pModule->maxNumSimultaneousRats; x++) {
modes[x] = uAtClientReadInt(atHandle);
}
uAtClientResponseStop(atHandle);
uAtClientUnlock(atHandle);
// Don't check error here as there may be fewer integers than we
// tried to read
if (rat > U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED) {
// If we are setting rather than removing the
// RAT at a given rank...
if ((modes[0] >= 0) && (modes[1] >= 0)) {
// ...and we already have dual mode...
if (rank == 0) {
// ...and we are setting the top rank...
if (rat != uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[1])) {
// ...then if we are setting the RAT to the
// same as the current dual-mode non-preferred
// RAT, switch to single-mode and that RAT.
modes[0] = cellRatToModuleRat(pInstance->pModule->moduleType, rat);
modes[1] = -1;
validOperation = true;
} else {
// ...else leave things as they are.
validOperation = true;
}
} else if (rank == 1) {
// ...and we are setting the second rank...
if (rat == uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[1])) {
// ...and the RAT we are setting is also the first rank,
// then switch to single mode with that RAT.
modes[0] = cellRatToModuleRat(pInstance->pModule->moduleType, rat);
modes[1] = -1;
validOperation = true;
} else {
// ...otherwise if we are setting the second
// rank then we want to set the OPPOSITE of
// the desired RAT in the preferred RAT position.
// In other words, to put 2G in second rank, we
// need to set 3G as our preferred RAT.
if (rat == U_CELL_NET_RAT_GSM_GPRS_EGPRS) {
modes[1] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_UTRAN);
validOperation = true;
} else if (rat == U_CELL_NET_RAT_UTRAN) {
modes[1] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_GSM_GPRS_EGPRS);
validOperation = true;
}
}
}
} else if ((modes[0] >= 0) && (modes[1] < 0)) {
// ...and we are in single mode...
if (rank == 0) {
// ...then if we are setting rank 0 just set it.
modes[0] = cellRatToModuleRat(pInstance->pModule->moduleType, rat);
validOperation = true;
} else if (rank == 1) {
// ...or if we're setting rank 1, then if it
// is different from the existing RAT...
if (rat != uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[0])) {
// ...then switch to dual mode and, as above, set
// the opposite of the desired RAT in the second
// number.
if (rat == U_CELL_NET_RAT_GSM_GPRS_EGPRS) {
modes[0] = 1;
modes[1] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_UTRAN);
validOperation = true;
} else if (rat == U_CELL_NET_RAT_UTRAN) {
modes[0] = 1;
modes[1] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_GSM_GPRS_EGPRS);
validOperation = true;
}
} else {
// ...else leave things as they are.
validOperation = true;
}
}
}
} else {
// If we are removing the RAT at a given rank...
if ((modes[0] >= 0) && (modes[1] >= 0)) {
// ...then we must be in dual mode
// (anything else is invalid or pointless)...
if (rank == 0) {
// If are removing the top-most rank
// then we set the single mode to be
// the opposite of the currently
// preferred RAT.
if (uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[1]) ==
U_CELL_NET_RAT_GSM_GPRS_EGPRS) {
modes[0] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_UTRAN);
modes[1] = -1;
validOperation = true;
} else if (uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType,
modes[1]) == U_CELL_NET_RAT_UTRAN) {
modes[0] = cellRatToModuleRat(pInstance->pModule->moduleType,
U_CELL_NET_RAT_GSM_GPRS_EGPRS);
modes[1] = -1;
validOperation = true;
}
} else if (rank == 1) {
// If are removing the second rank
// then we set the single mode to be
// the currently preferred RAT
modes[0] = modes[1];
modes[1] = -1;
validOperation = true;
}
}
}
if (validOperation) {
// Send the AT command
uPortLog("U_CELL_CFG: setting RATs:\n");
for (size_t x = 0; (x < sizeof(modes) / sizeof(modes[0])); x++) {
if (modes[x] >= 0) {
uPortLog(" rank[%d]: %d (in module terms %d).\n", x,
uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, modes[x]),
modes[x]);
} else {
uPortLog(" rank[%d]: %d (in module terms %d).\n", x,
U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED, -1);
}
}
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT=");
for (size_t x = 0; (x < sizeof(modes) / sizeof(modes[0])); x++) {
if (modes[x] >= 0) {
uAtClientWriteInt(atHandle, modes[x]);
}
}
uAtClientCommandStopReadResponse(atHandle);
errorCode = uAtClientUnlock(atHandle);
} else {
uPortLog("U_CELL_CFG: setting RAT %d (in module terms %d) at rank %d"
" is not a valid thing to do.\n", rat,
cellRatToModuleRat(pInstance->pModule->moduleType, rat), rank);
}
// Put AT+COPS back
if (cops >= 0) {
// Put COPS back
setCops(atHandle, cops);
}
// Put the AT+CFUN mode back if it was not already 1
if ((cFunMode >= 0) && (cFunMode != 1)) {
uCellPrivateCFunMode(pInstance, cFunMode);
}
return errorCode;
}
/* ----------------------------------------------------------------
* STATIC FUNCTIONS: LEXI-R10 RAT SETTING/GETTING BEHAVIOUR
* -------------------------------------------------------------- */
// Get the radio access technology that is being used by
// the cellular module at the given rank, LEXI-R10 style.
static uCellNetRat_t getRatLexiR10(const uCellPrivateInstance_t *pInstance,
int32_t rank)
{
uCellNetRat_t cellRat = U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
if (rank == 0) {
if ((pInstance->pModule->supportedRatsBitmap & (1U << (int32_t) U_CELL_NET_RAT_LTE))) {
cellRat = U_CELL_NET_RAT_LTE;
}
}
return cellRat;
}
// Get the rank at which the given RAT is being used, LEXI-R10 style.
static int32_t getRatRankLexiR10(const uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCodeOrRank = (int32_t) U_CELL_ERROR_AT;
if (pInstance->pModule->supportedRatsBitmap & (1UL << (int32_t) rat)) {
errorCodeOrRank = 0;
}
return errorCodeOrRank;
}
// Set RAT LEXI-R10 stylee.
static int32_t setRatLexiR10(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCode = U_ERROR_COMMON_INVALID_PARAMETER;
if (pInstance->pModule->supportedRatsBitmap & (1UL << (int32_t) rat)) {
errorCode = U_ERROR_COMMON_SUCCESS;
}
return errorCode;
}
// Set RAT rank LEXI-R10 stylee.
static int32_t setRatRankLexiR10(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat, int32_t rank)
{
int32_t errorCode = U_ERROR_COMMON_INVALID_PARAMETER;
if (rank == 0) {
if ((pInstance->pModule->supportedRatsBitmap & (1U << (int32_t) rat))) {
errorCode = U_ERROR_COMMON_SUCCESS;
}
}
return errorCode;
}
/* ----------------------------------------------------------------
* STATIC FUNCTIONS: LEXI, SARA-R4/R5/R6 OR LENA-R8 RAT SETTING/GETTING
* -------------------------------------------------------------- */
// Get the radio access technology that is being used by
// the cellular module at the given rank, SARA or LEXI R4/R5/R6
// or LENA-R8 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static uCellNetRat_t getRatRx(const uCellPrivateInstance_t *pInstance,
int32_t rank)
{
int32_t errorOrRat = (int32_t) U_CELL_ERROR_AT;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t rat;
uCellNetRat_t rats[U_CELL_PRIVATE_MAX_NUM_SIMULTANEOUS_RATS];
// Assume there are no RATs
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
rats[x] = U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
}
// Get the RAT from the module
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+URAT:");
// Read up to N integers representing the RATs
for (size_t x = 0; x < pInstance->pModule->maxNumSimultaneousRats; x++) {
rat = uAtClientReadInt(atHandle);
rats[x] = uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, rat);
}
uAtClientResponseStop(atHandle);
if (uAtClientUnlock(atHandle) == 0) {
errorOrRat = (int32_t) rats[rank];
}
uPortLog("U_CELL_CFG: RATs are:\n");
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
uPortLog(" rank[%d]: %d (in module terms %d).\n",
x, rats[x], cellRatToModuleRat(pInstance->pModule->moduleType, rats[x]));
}
return (uCellNetRat_t) errorOrRat;
}
// Get the rank at which the given RAT is being used, LEXI or SARA R4/R5/R6
// or LENA-R8 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t getRatRankRx(const uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCodeOrRank = (int32_t) U_CELL_ERROR_AT;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t y;
// Get the RATs from the module
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT?");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, "+URAT:");
// Read up to N integers representing the RATs
for (size_t x = 0; (errorCodeOrRank < 0) &&
(x < pInstance->pModule->maxNumSimultaneousRats); x++) {
y = uAtClientReadInt(atHandle);
if (rat == uCellPrivateModuleRatToCellRat(pInstance->pModule->moduleType, y)) {
errorCodeOrRank = (int32_t) x;
}
}
uAtClientResponseStop(atHandle);
uAtClientUnlock(atHandle);
return errorCodeOrRank;
}
// Set RAT, LEXI or SARA-R4/R5/R6 or LENA-R8 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t setRatRx(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat)
{
int32_t errorCode;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t cFunMode = -1;
if (U_CELL_PRIVATE_MODULE_IS_R5(pInstance->pModule->moduleType)) {
// For SARA-R5 the module has to be in state AT+CFUN=0
cFunMode = uCellPrivateCFunGet(pInstance);
if (cFunMode != 0) {
uCellPrivateCFunMode(pInstance, 0);
}
}
// Do the mode change
uPortLog("U_CELL_CFG: setting sole RAT to %d (in module terms %d).\n",
rat, cellRatToModuleRat(pInstance->pModule->moduleType, rat));
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT=");
uAtClientWriteInt(atHandle, cellRatToModuleRat(pInstance->pModule->moduleType, rat));
uAtClientCommandStopReadResponse(atHandle);
errorCode = uAtClientUnlock(atHandle);
// Put the AT+CFUN mode back to what it was if necessary
if (cFunMode > 0) {
uCellPrivateCFunMode(pInstance, cFunMode);
}
return errorCode;
}
// Set RAT, rank LEXI or SARA R4/R5/R6 or LENA-R8 style.
// Note: gUCellPrivateMutex should be locked before this is called.
static int32_t setRatRankRx(uCellPrivateInstance_t *pInstance,
uCellNetRat_t rat, int32_t rank)
{
int32_t errorCode;
uAtClientHandle_t atHandle = pInstance->atHandle;
int32_t rats[U_CELL_PRIVATE_MAX_NUM_SIMULTANEOUS_RATS];
int32_t cFunMode = -1;
// Assume there are no RATs
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
rats[x] = (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
}
// Get the existing RATs
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
rats[x] = (int32_t) getRatRx(pInstance, (int32_t) x);
if (rats[x] == (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED) {
break;
}
}
// Overwrite the one we want to set
rats[rank] = (int32_t) rat;
uPortLog("U_CELL_CFG: setting the RAT at rank %d to"
" %d (in module terms %d).\n",
rank, rat, cellRatToModuleRat(pInstance->pModule->moduleType, rat));
// Remove duplicates
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
for (size_t y = x + 1; y < sizeof(rats) / sizeof(rats[0]); y++) {
if ((rats[x] > (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED) &&
(rats[x] == rats[y])) {
rats[y] = (int32_t) U_CELL_NET_RAT_UNKNOWN_OR_NOT_USED;
}
}
}
if (U_CELL_PRIVATE_MODULE_IS_R5(pInstance->pModule->moduleType)) {
// For SARA-R5 the module has to be in state AT+CFUN=0
cFunMode = uCellPrivateCFunGet(pInstance);
if (cFunMode != 0) {
uCellPrivateCFunMode(pInstance, 0);
}
}
// Send the AT command
uPortLog("U_CELL_CFG: RATs (removing duplicates) become:\n");
for (size_t x = 0; x < sizeof(rats) / sizeof(rats[0]); x++) {
uPortLog(" rank[%d]: %d (in module terms %d).\n",
x, rats[x], cellRatToModuleRat(pInstance->pModule->moduleType,
(uCellNetRat_t) rats[x]));
}
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+URAT=");