-
Notifications
You must be signed in to change notification settings - Fork 84
/
u_short_range.c
1306 lines (1097 loc) · 45.3 KB
/
u_short_range.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 "general" API for short range modules.
*/
#ifdef U_CFG_OVERRIDE
# include "u_cfg_override.h" // For a customer's configuration override
#endif
#include "stdlib.h" // strtol(), atoi()
#include "stddef.h" // NULL, size_t etc.
#include "stdint.h" // int32_t etc.
#include "stdbool.h"
#include "string.h" // memset()
#include "stdio.h"
#include "u_cfg_sw.h"
#include "u_cfg_os_platform_specific.h" // Required by u_at_client.h
#include "u_error_common.h"
#include "u_port.h"
#include "u_port_os.h"
#include "u_port_heap.h"
#include "u_port_debug.h"
#include "u_port_gpio.h"
#include "u_port_uart.h"
#include "u_at_client.h"
#include "u_linked_list.h"
#include "u_geofence.h"
#include "u_geofence_shared.h"
#include "u_short_range_module_type.h"
#include "u_short_range_pbuf.h"
#include "u_short_range.h"
#include "u_short_range_private.h"
#include "u_short_range_edm_stream.h"
// The headers below necessary to work around an Espressif linker problem, see uShortRangeInit()
#include "u_device_private_short_range.h"
#include "u_security_tls.h"
#include "u_security_credential.h"
#include "u_short_range_sec_tls.h" // For uShortRangeSecTlsPrivateLink()
/* ----------------------------------------------------------------
* COMPILE-TIME MACROS
* -------------------------------------------------------------- */
#define U_SHORT_RANGE_BT_ADDRESS_SIZE 14
#ifndef U_SHORT_RANGE_AT_CLIENT_CLOSE_DELAY_MS
/** Delay to allow the AT client to process enqueued asynchronous
* events (URCs) before it is removed.
*/
# define U_SHORT_RANGE_AT_CLIENT_CLOSE_DELAY_MS 1000
#endif
/* ----------------------------------------------------------------
* TYPES
* -------------------------------------------------------------- */
/* ----------------------------------------------------------------
* STATIC VARIABLES
* -------------------------------------------------------------- */
// Macro magic for gStringToModule
#define U_YES true
#define U_NO false
#define U_SHORT_RANGE_MODULE(_TYPE_NAME, _GMM_NAME, _BLE, _BT_CLASSIC, _WIFI) \
{ \
.moduleType = U_SHORT_RANGE_MODULE_TYPE_##_TYPE_NAME, \
.pName = _GMM_NAME, \
.supportsBle = _BLE, \
.supportsBtClassic = _BT_CLASSIC, \
.supportsWifi = _WIFI, \
},
static const uShortRangeModuleInfo_t gModuleInfo[] = {
U_SHORT_RANGE_MODULE_LIST
};
static const size_t gModuleInfoCount = sizeof(gModuleInfo) / sizeof(gModuleInfo[0]);
#undef U_YES
#undef U_NO
#undef U_SHORT_RANGE_MODULE
/* ----------------------------------------------------------------
* STATIC FUNCTIONS
* -------------------------------------------------------------- */
// Find a connHandle, or use -1 for a free spot
static int32_t findFreeConnection(const uShortRangePrivateInstance_t *pInstance, int32_t connHandle)
{
int32_t i;
for (i = 0; i < U_SHORT_RANGE_MAX_CONNECTIONS; i++) {
if (pInstance->connections[i].connHandle == connHandle) {
break;
}
}
if (i == U_SHORT_RANGE_MAX_CONNECTIONS) {
i = -1;
}
return i;
}
// Find a short range instance in the list by AT handle.
// gUShortRangePrivateMutex should be locked before this is called.
//lint -e{818} suppress "could be declared as pointing to const": atHandle is anonymous
static uShortRangePrivateInstance_t *pGetShortRangeInstanceAtHandle(uAtClientHandle_t atHandle)
{
uShortRangePrivateInstance_t *pInstance = gpUShortRangePrivateInstanceList;
while ((pInstance != NULL) && (pInstance->atHandle != atHandle)) {
pInstance = pInstance->pNext;
}
return pInstance;
}
// Add a short range instance to the list.
// gUShortRangePrivateMutex should be locked before this is called.
// Note: doesn't copy it, just adds it.
static void addShortRangeInstance(uShortRangePrivateInstance_t *pInstance)
{
pInstance->pNext = gpUShortRangePrivateInstanceList;
gpUShortRangePrivateInstanceList = pInstance;
}
// Remove a short range instance from the list and free it.
// gUShortRangePrivateMutex should be locked before this is called.
static void removeShortRangeInstance(uShortRangePrivateInstance_t *pInstance)
{
uShortRangePrivateInstance_t *pCurrent;
uShortRangePrivateInstance_t *pPrev = NULL;
pCurrent = gpUShortRangePrivateInstanceList;
while (pCurrent != NULL) {
if (pInstance == pCurrent) {
if (pPrev != NULL) {
pPrev->pNext = pCurrent->pNext;
} else {
gpUShortRangePrivateInstanceList = pCurrent->pNext;
}
pCurrent = NULL;
} else {
pPrev = pCurrent;
pCurrent = pPrev->pNext;
}
}
uPortFree(pInstance);
}
//lint -e{818} suppress "could be declared as pointing to const": it is!
static void restarted(const uAtClientHandle_t atHandle,
void *pParameter)
{
(void)atHandle;
uShortRangePrivateInstance_t *pInstance = (uShortRangePrivateInstance_t *) pParameter;
pInstance->ticksLastRestart = uPortGetTickTimeMs();
uPortLog("U_SHORT_RANGE: module restart detected\n");
}
static int32_t uShortRangeAdd(uShortRangeModuleType_t moduleType,
uAtClientHandle_t atHandle,
int32_t uartHandle,
uDeviceHandle_t *pDevHandle)
{
int32_t handleOrErrorCode;
const uShortRangePrivateModule_t *pModule = NULL;
uShortRangePrivateInstance_t *pInstance;
uDeviceInstance_t *pDevInstance;
if (gUShortRangePrivateMutex == NULL) {
return (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
}
// Check parameters
for (size_t i = 0; i < gUShortRangePrivateModuleListSize; i++) {
if (gUShortRangePrivateModuleList[i].moduleType == moduleType) {
pModule = &gUShortRangePrivateModuleList[i];
break;
}
}
if ((uShortRangeGetModuleInfo(moduleType) == NULL) ||
(atHandle == NULL) || (pModule == NULL)) {
return (int32_t) U_ERROR_COMMON_INVALID_PARAMETER;
}
pDevInstance = pUDeviceCreateInstance(U_DEVICE_TYPE_SHORT_RANGE);
if (pDevInstance == NULL) {
return (int32_t) U_ERROR_COMMON_NO_MEMORY;
}
// Check if there is already an instance for the AT client
pInstance = pGetShortRangeInstanceAtHandle(atHandle);
if (pInstance == NULL) {
// Allocate memory for the instance
pInstance = (uShortRangePrivateInstance_t *) pUPortMalloc(sizeof(uShortRangePrivateInstance_t));
if (pInstance != NULL) {
uAtClientStreamHandle_t stream;
// Fill the values in
memset(pInstance, 0, sizeof(*pInstance));
for (int32_t i = 0; i < U_SHORT_RANGE_MAX_CONNECTIONS; i++) {
pInstance->connections[i].connHandle = -1;
pInstance->connections[i].type = U_SHORT_RANGE_CONNECTION_TYPE_INVALID;
}
pInstance->devHandle = pDevInstance;
pInstance->atHandle = atHandle;
pInstance->mode = U_SHORT_RANGE_MODE_EDM;
pInstance->startTimeMs = 500;
pInstance->urcConHandlerSet = false;
pInstance->sockNextLocalPort = -1;
pInstance->uartHandle = uartHandle;
uAtClientStreamGetExt(atHandle, &stream);
pInstance->streamHandle = stream.handle.int32;
pInstance->streamType = stream.type;
pInstance->pModule = pModule;
pInstance->pNext = NULL;
uAtClientTimeoutSet(atHandle, pInstance->pModule->atTimeoutSeconds * 1000);
uAtClientDelaySet(atHandle, pInstance->pModule->commandDelayMs);
// ...and finally add it to the list
addShortRangeInstance(pInstance);
uAtClientSetUrcHandler(atHandle, "+STARTUP",
restarted, pInstance);
pInstance->ticksLastRestart = 0;
}
}
if (pInstance) {
handleOrErrorCode = (int32_t) U_ERROR_COMMON_SUCCESS;
pDevInstance->pContext = (void *)pInstance;
//lint -e740 Disable Unusual pointer cast
*pDevHandle = (uDeviceHandle_t)pDevInstance;
} else {
handleOrErrorCode = (int32_t) U_ERROR_COMMON_NO_MEMORY;
}
return handleOrErrorCode;
}
static int32_t parseUudpcProtocol(int32_t value, uShortRangeIpProtocol_t *pProtocol)
{
switch (value) {
case 0:
*pProtocol = U_SHORT_RANGE_IP_PROTOCOL_TCP;
break;
case 1:
*pProtocol = U_SHORT_RANGE_IP_PROTOCOL_UDP;
break;
case 6:
*pProtocol = U_SHORT_RANGE_IP_PROTOCOL_MQTT;
break;
default:
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
static int32_t parseUudpcProfile(int32_t value, uShortRangeBtProfile_t *pProfile)
{
switch (value) {
case 1:
*pProfile = U_SHORT_RANGE_BT_PROFILE_SPP;
break;
case 2:
*pProfile = U_SHORT_RANGE_BT_PROFILE_DUN;
break;
case 4:
*pProfile = U_SHORT_RANGE_BT_PROFILE_SPS;
break;
default:
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
static int32_t parseBdAddr(const char *pStr, uint8_t *pDstAddr)
{
// Parse string: "01A0F7101C08p"
// Basic validation
if ((strlen(pStr) != 13) || ((pStr[12] != 'r') && (pStr[12] != 'p'))) {
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
for (int i = 0; i < U_SHORT_RANGE_BT_ADDRESS_LENGTH; i++) {
char buf[3];
//lint -save -e679
memcpy(&buf[0], &pStr[i * 2], 2);
//lint -restore
buf[2] = 0;
pDstAddr[i] = (uint8_t)strtol(buf, NULL, 16);
}
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
static int32_t parseIpv4Addr(char *pStr, uint8_t *pDstIp)
{
// Parse string: "192.168.0.1"
char *end = pStr + strlen(pStr);
for (int i = 0; i < 4; i++) {
if (pStr >= end) {
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
char *tok = strchr(pStr, '.');
if (i < 3) {
if (tok == NULL) {
// Missing a '.'
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
tok[0] = 0;
pDstIp[i] = (uint8_t)atoi(pStr);
pStr = &tok[1];
} else {
pDstIp[i] = (uint8_t)atoi(pStr);
}
}
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
static int32_t parseIpv6Addr(char *pStr, uint8_t *pDstIp)
{
// Parse string: "[2001:0db8:85a3:0000:0000:8a2e:0370:7334]"
// Basic validation
if ((strlen(pStr) != 41) || (pStr[0] != '[') || (pStr[40] != ']')) {
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
char *ptr = &pStr[1];
for (int i = 0; i < 8; i++) {
// Validate separator
if ((i < 7) && (ptr[4] != ':')) {
return (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
}
ptr[4] = 0;
uint32_t value = (uint32_t)strtol(ptr, NULL, 16);
//lint -save -e679
pDstIp[i * 2] = (uint8_t)(value >> 8);
pDstIp[(i * 2) + 1] = (uint8_t)(value & 0xFF);
//lint -restore
ptr += 5;
}
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
static int32_t parseUint16(int32_t value, uint16_t *pDst)
{
if ((value > 0) && (value <= 0xFFFF)) {
*pDst = (uint16_t)value;
return (int32_t)U_ERROR_COMMON_SUCCESS;
}
return (int32_t)U_ERROR_COMMON_UNKNOWN;
}
//+UUDPC:<peer_handle>,<type>,<profile>,<address>,<frame_size>
//lint -esym(818, pParameter) Suppress pParameter could be const, need to
// follow prototype
static void UUDPC_urc(uAtClientHandle_t atHandle,
void *pParameter)
{
uShortRangePrivateInstance_t *pInstance = (uShortRangePrivateInstance_t *) pParameter;
int32_t connHandle;
int32_t type;
connHandle = uAtClientReadInt(atHandle);
type = uAtClientReadInt(atHandle);
int32_t id = findFreeConnection(pInstance, -1);
if (id < 0) {
uPortLog("U_SHORT_RANGE: Out of connection entries\n");
return;
}
pInstance->connections[id].connHandle = connHandle;
// The type will be filled in next section, but default to "invalid"
pInstance->connections[id].type = U_SHORT_RANGE_CONNECTION_TYPE_INVALID;
if (type == U_SHORT_RANGE_UUDPC_TYPE_BT) {
int32_t err = 0;
char address[U_SHORT_RANGE_BT_ADDRESS_SIZE];
pInstance->connections[id].type = U_SHORT_RANGE_CONNECTION_TYPE_BT;
int profile = uAtClientReadInt(atHandle);
(void)uAtClientReadString(atHandle, address, U_SHORT_RANGE_BT_ADDRESS_SIZE, false);
int frameSize = uAtClientReadInt(atHandle);
if (pInstance->pBtConnectionStatusCallback != NULL) {
uShortRangeConnectDataBt_t conData;
err |= parseUint16(frameSize, &conData.framesize);
err |= parseBdAddr(address, conData.address);
err |= parseUudpcProfile(profile, &conData.profile);
if (err == (int32_t)U_ERROR_COMMON_SUCCESS) {
pInstance->pBtConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_CONNECTED,
&conData,
pInstance->pBtConnectionStatusCallbackParameter);
}
}
} else if (type == U_SHORT_RANGE_UUDPC_TYPE_IPv4 ||
type == U_SHORT_RANGE_UUDPC_TYPE_IPv6) {
int32_t err = 0;
char buffer[64];
uShortRangeConnectDataIp_t conData;
uShortRangeIpProtocol_t protocol = U_SHORT_RANGE_IP_PROTOCOL_TCP; // Keep compiler happy
if (type == U_SHORT_RANGE_UUDPC_TYPE_IPv4) {
// Parse remaining IPv4 data:
// <protocol>,<local_ip>,<local_port>,<remote_ip>,<remote_port>
// Example: "0,192.168.0.40,54282,142.250.74.100,80"
conData.type = U_SHORT_RANGE_CONNECTION_IPv4;
// Protocol
int value = uAtClientReadInt(atHandle);
err |= parseUudpcProtocol(value, &protocol);
conData.ipv4.protocol = protocol;
// Local IP
err |= uAtClientReadString(atHandle, buffer, sizeof(buffer), false);
err |= parseIpv4Addr(buffer, conData.ipv4.localAddress);
// Local port
value = uAtClientReadInt(atHandle);
err |= parseUint16(value, &conData.ipv4.localPort);
// Remote IP
err |= uAtClientReadString(atHandle, buffer, sizeof(buffer), false);
err |= parseIpv4Addr(buffer, conData.ipv4.remoteAddress);
// Remote port
value = uAtClientReadInt(atHandle);
err |= parseUint16(value, &conData.ipv4.remotePort);
} else {
// Parse remaining IPv6 data:
// <protocol>,<local_ip>,<local_port>,<remote_ip>,<remote_port>
// Example: "0,[2001:0db8:85a3:0000:0000:8a2e:0370:7334],54282,[2001:0db8:85a3:0000:0000:8a2e:0370:7334],80"
conData.type = U_SHORT_RANGE_CONNECTION_IPv6;
int value = uAtClientReadInt(atHandle);
err |= parseUudpcProtocol(value, &protocol);
conData.ipv6.protocol = protocol;
// Local IP
err |= uAtClientReadString(atHandle, buffer, sizeof(buffer), false);
err |= parseIpv6Addr(buffer, conData.ipv6.localAddress);
// Local port
value = uAtClientReadInt(atHandle);
err |= parseUint16(value, &conData.ipv6.localPort);
// Remote IP
err |= uAtClientReadString(atHandle, buffer, sizeof(buffer), false);
err |= parseIpv6Addr(buffer, conData.ipv6.remoteAddress);
// Remote port
value = uAtClientReadInt(atHandle);
err |= parseUint16(value, &conData.ipv6.remotePort);
}
if (err == (int32_t)U_ERROR_COMMON_SUCCESS) {
// There was an error in the parsing
uPortLog("U_SHORT_RANGE: Unable to parse UUDPC URC\n");
return;
}
if ((protocol == U_SHORT_RANGE_IP_PROTOCOL_TCP) ||
(protocol == U_SHORT_RANGE_IP_PROTOCOL_UDP)) {
pInstance->connections[id].type = U_SHORT_RANGE_CONNECTION_TYPE_IP;
if (pInstance->pIpConnectionStatusCallback != NULL) {
pInstance->pIpConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_CONNECTED, &conData,
pInstance->pIpConnectionStatusCallbackParameter);
}
} else if (protocol == U_SHORT_RANGE_IP_PROTOCOL_MQTT) {
pInstance->connections[id].type = U_SHORT_RANGE_CONNECTION_TYPE_MQTT;
if (pInstance->pMqttConnectionStatusCallback != NULL) {
pInstance->pMqttConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_CONNECTED, &conData,
pInstance->pMqttConnectionStatusCallbackParameter);
}
}
}
}
//lint -esym(818, pParameter) Suppress pParameter could be const, need to
// follow prototype
static void UUDPD_urc(uAtClientHandle_t atHandle,
void *pParameter)
{
uShortRangePrivateInstance_t *pInstance = (uShortRangePrivateInstance_t *) pParameter;
int32_t connHandle;
connHandle = uAtClientReadInt(atHandle);
int32_t id = findFreeConnection(pInstance, connHandle);
if (id != -1) {
switch (pInstance->connections[id].type) {
case U_SHORT_RANGE_CONNECTION_TYPE_BT:
if (pInstance->pBtConnectionStatusCallback != NULL) {
pInstance->pBtConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_DISCONNECTED, NULL,
pInstance->pBtConnectionStatusCallbackParameter);
}
break;
case U_SHORT_RANGE_CONNECTION_TYPE_IP:
if (pInstance->pIpConnectionStatusCallback != NULL) {
pInstance->pIpConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_DISCONNECTED, NULL,
pInstance->pIpConnectionStatusCallbackParameter);
}
break;
case U_SHORT_RANGE_CONNECTION_TYPE_MQTT:
if (pInstance->pMqttConnectionStatusCallback != NULL) {
pInstance->pMqttConnectionStatusCallback(pInstance->devHandle, connHandle,
U_SHORT_RANGE_EVENT_DISCONNECTED, NULL,
pInstance->pMqttConnectionStatusCallbackParameter);
}
break;
default:
break;
}
pInstance->connections[id].connHandle = -1;
pInstance->connections[id].type = U_SHORT_RANGE_CONNECTION_TYPE_INVALID;
}
}
// Wrapper function to execute at commands in edm mode
static int32_t executeAtCommand(const uAtClientHandle_t atHandle, uint8_t retries,
const char *command)
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_UNKNOWN;
for (uint8_t i = 0; i < retries; i++) {
uAtClientDeviceError_t deviceError;
uAtClientLock(atHandle);
uAtClientTimeoutSet(atHandle, 2000);
uAtClientCommandStart(atHandle, command);
uAtClientCommandStopReadResponse(atHandle);
uAtClientDeviceErrorGet(atHandle, &deviceError);
errorCode = uAtClientUnlock(atHandle);
if (errorCode == (int32_t) U_ERROR_COMMON_SUCCESS) {
break;
}
}
return errorCode;
}
// Attempt to enter EDM mode
static int32_t enterEDM(const uShortRangePrivateInstance_t *pInstance)
{
const char atCommandEnterEDM[] = "\r\nATO2\r\n";
int32_t errorCode;
//We assume first we are in at mode, send command blindly to enter EDM mode
uShortRangeEdmStreamAtWrite(pInstance->streamHandle, atCommandEnterEDM, sizeof(atCommandEnterEDM));
// Echo off
errorCode = executeAtCommand(pInstance->atHandle, 4, "ATE0");
return errorCode;
}
static int32_t restartModuleHelper(const uShortRangePrivateInstance_t *pInstance)
{
int32_t errorCode;
errorCode = enterEDM(pInstance);
if (errorCode != (int32_t) U_ERROR_COMMON_SUCCESS) {
return errorCode;
}
// Reboot
errorCode = executeAtCommand(pInstance->atHandle, 1, "AT+CPWROFF");
if (errorCode == (int32_t) U_ERROR_COMMON_SUCCESS) {
// Until we have proper startup detection just block the task a bit since module
// module startup validation can take some time
uPortTaskBlock(3500);
errorCode = enterEDM(pInstance);
}
return errorCode;
}
// Reboot and enter edm
static int32_t restartModuleAndEnterEDM(uDeviceHandle_t devHandle)
{
int32_t errorCode = (int32_t)U_ERROR_COMMON_UNKNOWN;
uShortRangePrivateInstance_t *pInstance;
pInstance = pUShortRangePrivateGetInstance(devHandle);
if (pInstance != NULL) {
errorCode = restartModuleHelper(pInstance);
// Try to restart again
if (errorCode != (int32_t) U_ERROR_COMMON_SUCCESS) {
errorCode = restartModuleHelper(pInstance);
}
}
return errorCode;
}
static int32_t convert(const char *pStr)
{
for (int32_t i = 0; i < (int32_t)gModuleInfoCount; ++i) {
if (!strncmp (pStr, gModuleInfo[i].pName, strlen(gModuleInfo[i].pName))) {
return gModuleInfo[i].moduleType;
}
}
return U_SHORT_RANGE_MODULE_TYPE_INVALID;
}
static uShortRangeModuleType_t getModule(const uAtClientHandle_t atHandle)
{
uShortRangeModuleType_t module = U_SHORT_RANGE_MODULE_TYPE_INVALID;
char buffer[20];
uAtClientLock(atHandle);
uAtClientCommandStart(atHandle, "AT+GMM");
uAtClientCommandStop(atHandle);
uAtClientResponseStart(atHandle, NULL);
int32_t bytesRead = uAtClientReadString(atHandle, buffer,
sizeof(buffer), false);
uAtClientResponseStop(atHandle);
int32_t errorCode = uAtClientUnlock(atHandle);
if (errorCode == (int32_t) U_ERROR_COMMON_SUCCESS &&
bytesRead >= 7) {
module = convert(buffer);
}
return module;
}
// This function is called whenever a connection callback is set or cleared
// The function will check if we need to set or clear the URC connection handlers
static void configureConnectionUrcHandlers(uShortRangePrivateInstance_t *pInstance)
{
bool connectionCallbackSet =
((pInstance->pBtConnectionStatusCallback != NULL) ||
(pInstance->pIpConnectionStatusCallback != NULL) ||
(pInstance->pMqttConnectionStatusCallback != NULL));
if (connectionCallbackSet && !pInstance->urcConHandlerSet) {
uAtClientSetUrcHandler(pInstance->atHandle, "+UUDPC:",
UUDPC_urc, pInstance);
uAtClientSetUrcHandler(pInstance->atHandle, "+UUDPD:",
UUDPD_urc, pInstance);
pInstance->urcConHandlerSet = true;
} else if (!connectionCallbackSet && pInstance->urcConHandlerSet) {
uAtClientRemoveUrcHandler(pInstance->atHandle, "+UUDPC:");
uAtClientRemoveUrcHandler(pInstance->atHandle, "+UUDPD:");
pInstance->urcConHandlerSet = false;
}
}
/* ----------------------------------------------------------------
* PUBLIC FUNCTIONS
* -------------------------------------------------------------- */
int32_t uShortRangeInit()
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_SUCCESS;
// Workaround for Espressif linker missing out files that
// only contain functions which also have weak alternatives
// (see https://www.esp32.com/viewtopic.php?f=13&t=8418&p=35899)
// Basically any file that might end up containing only functions
// that also have WEAK linked counterparts will be lost, so we need
// to add a dummy function in those files and call it from somewhere
// that will always be present in the build, which for Short Range is
// here
uDevicePrivateShortRangeLink();
uShortRangeSecTlsPrivateLink();
if (gUShortRangePrivateMutex == NULL) {
// Create the mutex that protects the linked list
errorCode = uPortMutexCreate(&gUShortRangePrivateMutex);
}
return errorCode;
}
void uShortRangeDeinit()
{
uShortRangePrivateInstance_t *pInstance;
if (gUShortRangePrivateMutex != NULL) {
U_PORT_MUTEX_LOCK(gUShortRangePrivateMutex);
// Remove all short range instances
while (gpUShortRangePrivateInstanceList != NULL) {
pInstance = gpUShortRangePrivateInstanceList;
removeShortRangeInstance(pInstance);
}
// Unlock the mutex so that we can delete it
U_PORT_MUTEX_UNLOCK(gUShortRangePrivateMutex);
uPortMutexDelete(gUShortRangePrivateMutex);
gUShortRangePrivateMutex = NULL;
}
}
int32_t uShortRangeLock()
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
if (gUShortRangePrivateMutex != NULL) {
errorCode = uPortMutexLock(gUShortRangePrivateMutex);
}
return errorCode;
}
int32_t uShortRangeUnlock()
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
if (gUShortRangePrivateMutex != NULL) {
errorCode = uPortMutexUnlock(gUShortRangePrivateMutex);
}
return errorCode;
}
int32_t uShortRangeOpenUart(uShortRangeModuleType_t moduleType,
const uShortRangeUartConfig_t *pUartConfig,
bool restart, uDeviceHandle_t *pDevHandle)
{
int32_t uartHandle = (int32_t)U_ERROR_COMMON_NOT_INITIALISED;
int32_t edmStreamHandle = (int32_t)U_ERROR_COMMON_NOT_INITIALISED;
uAtClientHandle_t atClientHandle = NULL;
uAtClientStreamHandle_t stream;
int32_t handleOrErrorCode = (int32_t)U_ERROR_COMMON_INVALID_PARAMETER;
if (gUShortRangePrivateMutex == NULL) {
return (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
}
// TODO: once we allow multiple edm streams this should be removed
if (gpUShortRangePrivateInstanceList != NULL) {
return (int32_t) U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
if ((moduleType <= U_SHORT_RANGE_MODULE_TYPE_INTERNAL) ||
(pUartConfig == NULL)) {
return handleOrErrorCode;
}
if (pUartConfig->pPrefix != NULL) {
uPortUartPrefix(pUartConfig->pPrefix);
}
handleOrErrorCode = uPortUartOpen(pUartConfig->uartPort,
pUartConfig->baudRate,
NULL,
U_SHORT_RANGE_UART_BUFFER_LENGTH_BYTES,
pUartConfig->pinTx,
pUartConfig->pinRx,
pUartConfig->pinCts,
pUartConfig->pinRts);
if (handleOrErrorCode < (int32_t) U_ERROR_COMMON_SUCCESS) {
return (int32_t) U_SHORT_RANGE_ERROR_INIT_UART;
}
//lint -e(838) Suppress previously assigned value has not been used
uartHandle = handleOrErrorCode;
handleOrErrorCode = uShortRangeEdmStreamInit();
if (handleOrErrorCode != (int32_t) U_ERROR_COMMON_SUCCESS) {
uPortUartClose(uartHandle);
return (int32_t) U_SHORT_RANGE_ERROR_INIT_EDM;
}
handleOrErrorCode = uShortRangeEdmStreamOpen(uartHandle);
if (handleOrErrorCode < (int32_t) U_ERROR_COMMON_SUCCESS) {
uShortRangeEdmStreamDeinit();
uPortUartClose(uartHandle);
return (int32_t) U_SHORT_RANGE_ERROR_INIT_EDM;
}
//lint -e(838) Suppress previously assigned value has not been used
edmStreamHandle = handleOrErrorCode;
stream.handle.int32 = edmStreamHandle;
stream.type = U_AT_CLIENT_STREAM_TYPE_EDM;
//lint -e(838) Suppress previously assigned value has not been used
atClientHandle = uAtClientAddExt(&stream, NULL,
U_SHORT_RANGE_AT_BUFFER_LENGTH_BYTES);
if (atClientHandle == NULL) {
uShortRangeEdmStreamClose(edmStreamHandle);
uShortRangeEdmStreamDeinit();
uPortUartClose(uartHandle);
return (int32_t) U_SHORT_RANGE_ERROR_INIT_ATCLIENT;
}
// Set printing/debugging of AT commands, the user
// can always switch printing off in u_cfg_sw.h.
uAtClientPrintAtSet(atClientHandle, true);
uAtClientDebugSet(atClientHandle, true);
handleOrErrorCode = uShortRangeAdd(moduleType,
atClientHandle,
uartHandle,
pDevHandle);
if (handleOrErrorCode < (int32_t) U_ERROR_COMMON_SUCCESS) {
uAtClientRemove(atClientHandle);
uShortRangeEdmStreamClose(edmStreamHandle);
uShortRangeEdmStreamDeinit();
uPortUartClose(uartHandle);
return (int32_t) U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
uShortRangeEdmStreamSetAtHandle(edmStreamHandle, atClientHandle);
if (moduleType == U_SHORT_RANGE_MODULE_TYPE_ANY) {
moduleType = uShortRangeDetectModule(*pDevHandle);
uShortRangePrivateInstance_t *pInstance;
pInstance = pUShortRangePrivateGetInstance(*pDevHandle);
if (pInstance != NULL) {
pInstance->pModule = &gUShortRangePrivateModuleList[moduleType - 1];
uAtClientTimeoutSet(atClientHandle, pInstance->pModule->atTimeoutSeconds * 1000);
uAtClientDelaySet(atClientHandle, pInstance->pModule->commandDelayMs);
uPortLog("U_SHORT_RANGE: Module %d identified and set sucessfully\n",
pInstance->pModule->moduleType);
} else {
return (int32_t)U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
}
if (restart) {
if (restartModuleAndEnterEDM(*pDevHandle) != (int32_t) U_ERROR_COMMON_SUCCESS) {
uShortRangeClose(*pDevHandle);
return (int32_t)U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
} else {
if (moduleType != uShortRangeDetectModule(*pDevHandle)) {
// Failed - wait a bit and try once more
uPortTaskBlock(100);
if (moduleType != uShortRangeDetectModule(*pDevHandle)) {
uShortRangeClose(*pDevHandle);
return (int32_t)U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
}
}
if (moduleType != getModule(atClientHandle)) {
uShortRangeClose(*pDevHandle);
return (int32_t)U_SHORT_RANGE_ERROR_INIT_INTERNAL;
}
return (int32_t) U_ERROR_COMMON_SUCCESS;
}
void uShortRangeClose(uDeviceHandle_t devHandle)
{
uShortRangePrivateInstance_t *pInstance;
if (gUShortRangePrivateMutex == NULL) {
uPortLog("Failed to close short range, uShortRange is uninitialized\n");
return;
}
pInstance = pUShortRangePrivateGetInstance(devHandle);
if (pInstance != NULL) {
uAtClientIgnoreAsync(pInstance->atHandle);
uShortRangeEdmStreamClose(pInstance->streamHandle);
uShortRangeEdmStreamDeinit();
// URCs may have landed during the process of closing-up
// the AT interface to the module which are still queued
// and being processed by the AT handler; let them
// land before we pull it out from under them
uPortTaskBlock(U_SHORT_RANGE_AT_CLIENT_CLOSE_DELAY_MS);
uAtClientRemoveUrcHandler(pInstance->atHandle, "+STARTUP");
uAtClientRemove(pInstance->atHandle);
// Unlink any geofences and free the fence context
uGeofenceContextFree((uGeofenceContext_t **) &pInstance->pFenceContext);
uPortUartClose(pInstance->uartHandle);
removeShortRangeInstance(pInstance);
uDeviceDestroyInstance(U_DEVICE_INSTANCE(devHandle));
}
}
int32_t uShortRangeSetIpConnectionStatusCallback(uDeviceHandle_t devHandle,
uShortRangeIpConnectionStatusCallback_t pCallback,
void *pCallbackParameter)
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
uShortRangePrivateInstance_t *pInstance;
if (gUShortRangePrivateMutex != NULL) {
pInstance = pUShortRangePrivateGetInstance(devHandle);
errorCode = (int32_t) U_ERROR_COMMON_INVALID_PARAMETER;
if (pInstance != NULL) {
errorCode = (int32_t) U_ERROR_COMMON_SUCCESS;
if (pCallback != NULL) {
pInstance->pIpConnectionStatusCallback = pCallback;
pInstance->pIpConnectionStatusCallbackParameter = pCallbackParameter;
} else {
pInstance->pIpConnectionStatusCallback = NULL;
pInstance->pIpConnectionStatusCallbackParameter = NULL;
}
configureConnectionUrcHandlers(pInstance);
}
}
return errorCode;
}
int32_t uShortRangeSetBtConnectionStatusCallback(uDeviceHandle_t devHandle,
uShortRangeBtConnectionStatusCallback_t pCallback,
void *pCallbackParameter)
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
uShortRangePrivateInstance_t *pInstance;
if (gUShortRangePrivateMutex != NULL) {
pInstance = pUShortRangePrivateGetInstance(devHandle);
errorCode = (int32_t) U_ERROR_COMMON_INVALID_PARAMETER;
if (pInstance != NULL) {
errorCode = (int32_t) U_ERROR_COMMON_SUCCESS;
if (pCallback != NULL) {
pInstance->pBtConnectionStatusCallback = pCallback;
pInstance->pBtConnectionStatusCallbackParameter = pCallbackParameter;
} else {
pInstance->pBtConnectionStatusCallback = NULL;
pInstance->pBtConnectionStatusCallbackParameter = NULL;
}
configureConnectionUrcHandlers(pInstance);
}
}
return errorCode;
}
int32_t uShortRangeSetMqttConnectionStatusCallback(uDeviceHandle_t devHandle,
uShortRangeIpConnectionStatusCallback_t pCallback,
void *pCallbackParameter)
{
int32_t errorCode = (int32_t) U_ERROR_COMMON_NOT_INITIALISED;
uShortRangePrivateInstance_t *pInstance;
if (gUShortRangePrivateMutex != NULL) {
pInstance = pUShortRangePrivateGetInstance(devHandle);
errorCode = (int32_t) U_ERROR_COMMON_INVALID_PARAMETER;
if (pInstance != NULL) {
errorCode = (int32_t) U_ERROR_COMMON_SUCCESS;
if (pCallback != NULL) {
pInstance->pMqttConnectionStatusCallback = pCallback;
pInstance->pMqttConnectionStatusCallbackParameter = pCallbackParameter;
} else {
pInstance->pMqttConnectionStatusCallback = NULL;
pInstance->pMqttConnectionStatusCallbackParameter = NULL;
}
configureConnectionUrcHandlers(pInstance);
}