-
Notifications
You must be signed in to change notification settings - Fork 57
/
cellular_types.h
835 lines (770 loc) · 34.8 KB
/
cellular_types.h
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
/*
* FreeRTOS-Cellular-Interface v1.4.0
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*/
/**
* @file cellular_types.h
*/
#ifndef __CELLULAR_TYPES_H__
#define __CELLULAR_TYPES_H__
/* *INDENT-OFF* */
#ifdef __cplusplus
extern "C" {
#endif
/* *INDENT-ON* */
/* Includes for standard bool and int. */
#include <stdbool.h>
#include <stdint.h>
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Invalid signal value.
*/
#define CELLULAR_INVALID_SIGNAL_VALUE ( -32768 )
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Invalid signal bar value.
*/
#define CELLULAR_INVALID_SIGNAL_BAR_VALUE ( 0xFFU )
/**
* @ingroup cellular_datatypes_handles
* @brief Opaque Cellular context structure.
*/
struct CellularContext;
/**
* @ingroup cellular_datatypes_handles
* @brief Opaque Cellular context structure type.
*/
typedef struct CellularContext CellularContext_t;
/**
* @ingroup cellular_datatypes_handles
* @brief Opaque Cellular handle.
*/
typedef struct CellularContext * CellularHandle_t;
struct CellularSocketContext;
/**
* @ingroup cellular_datatypes_handles
* @brief Opaque socket handle.
*/
typedef struct CellularSocketContext * CellularSocketHandle_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Status code returns from APIs.
*/
typedef enum CellularError
{
CELLULAR_SUCCESS = 0, /**< The operation was successful. */
CELLULAR_INVALID_HANDLE, /**< Invalid handle. */
CELLULAR_MODEM_NOT_READY, /**< The modem is not ready yet. */
CELLULAR_LIBRARY_NOT_OPEN, /**< The cellular library is not open yet. */
CELLULAR_LIBRARY_ALREADY_OPEN, /**< The cellular library is already open. */
CELLULAR_BAD_PARAMETER, /**< One or more of the input parameters is not valid. */
CELLULAR_NO_MEMORY, /**< Memory allocation failure. */
CELLULAR_TIMEOUT, /**< The operation timed out. */
CELLULAR_SOCKET_CLOSED, /**< The supplied socket is already closed. */
CELLULAR_SOCKET_NOT_CONNECTED, /**< The supplied socket is not connected. */
CELLULAR_INTERNAL_FAILURE, /**< The Cellular library internal failure. */
CELLULAR_RESOURCE_CREATION_FAIL, /**< Resource creation for Cellular library failed. */
CELLULAR_UNSUPPORTED, /**< The operation is not supported. */
CELLULAR_NOT_ALLOWED, /**< The operation is not allowed. */
CELLULAR_UNKNOWN /**< Any other error other than the above mentioned ones. */
} CellularError_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Enums representing Radio Access Technologies (RATs). Reference 3GPP TS 27.007 PLMN selection +COPS.
*/
typedef enum CellularRat
{
CELLULAR_RAT_GSM = 0, /**< The GSM RATs network. */
CELLULAR_RAT_WCDMA = 2, /**< The WCDMA RATs network. */
CELLULAR_RAT_EDGE = 3, /**< The EDGE RATs network. */
CELLULAR_RAT_HSDPA = 4, /**< The HSDPA RATs network. */
CELLULAR_RAT_HSUPA = 5, /**< The HSUPA RATs network. */
CELLULAR_RAT_HSDPAHSUPA = 6, /**< The HSDPAHSUPA RATs network. */
CELLULAR_RAT_LTE = 7, /**< The LTE RATs network. */
CELLULAR_RAT_CATM1 = 8, /**< The CAT M1 RATs network. */
CELLULAR_RAT_NBIOT = 9, /**< The NBIOT RATs network. */
CELLULAR_RAT_MAX, /**< The max supported number for RATs network. */
CELLULAR_RAT_INVALID = 0xFF /**< Any other error other than the above mentioned ones. */
} CellularRat_t;
/**
* @ingroup cellular_datatypes_enums
* @brief SIM card state codes.
*/
typedef enum CellularSimCardState
{
CELLULAR_SIM_CARD_REMOVED = 0, /**< The state stands for cellular sim card removed. */
CELLULAR_SIM_CARD_INSERTED, /**< The state stands for cellular sim card inserted. */
CELLULAR_SIM_CARD_STATUS_MAX, /**< The number of supported sim card status. */
CELLULAR_SIM_CARD_UNKNOWN /**< The state stands for unknown cellular sim card. */
} CellularSimCardState_t;
/**
* @ingroup cellular_datatypes_enums
* @brief SIM card lock state codes. Reference 3GPP TS 27.007 Enter PIN +CPIN.
*/
typedef enum CellularSimCardLockState
{
CELLULAR_SIM_CARD_READY = 0, /**< The cellular sim card in a lock state of ready. */
CELLULAR_SIM_CARD_PIN, /**< The cellular sim card in a lock state of pin(personal identification number). */
CELLULAR_SIM_CARD_PUK, /**< The cellular sim card in a lock state of puk(personal unlocking key). */
CELLULAR_SIM_CARD_PIN2, /**< The cellular sim card in a lock state of pin2. */
CELLULAR_SIM_CARD_PUK2, /**< The cellular sim card in a lock state of puk2. */
CELLULAR_SIM_CARD_PH_NET_PIN, /**< The cellular sim card in a lock state of ph-net pin. */
CELLULAR_SIM_CARD_PH_NET_PUK, /**< The cellular sim card in a lock state of ph-net puk. */
CELLULAR_SIM_CARD_PH_NETSUB_PIN, /**< The cellular sim card in a lock state of ph-netsub pin. */
CELLULAR_SIM_CARD_PH_NETSUB_PUK, /**< The cellular sim card in a lock state of ph-netsub puk. */
CELLULAR_SIM_CARD_SP_PIN, /**< The cellular sim card in a lock state of ph-sp pin. */
CELLULAR_SIM_CARD_SP_PUK, /**< The cellular sim card in a lock state of ph-sp puk. */
CELLULAR_SIM_CARD_CORP_PIN, /**< The cellular sim card in a lock state of ph-corp pin. */
CELLULAR_SIM_CARD_CORP_PUK, /**< The cellular sim card in a lock state of ph-sp puk. */
CELLULAR_SIM_CARD_IMSI_PIN, /**< The cellular sim card in a lock state of imsi pin. */
CELLULAR_SIM_CARD_IMSI_PUK, /**< The cellular sim card in a lock state of imsi puk. */
CELLULAR_SIM_CARD_INVALID, /**< The cellular sim card in a lock state of invalid. */
CELLULAR_SIM_CARD_LOCK_UNKNOWN /**< The cellular sim card in a lock state of unknown. */
} CellularSimCardLockState_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents network registration mode. Reference 3GPP TS 27.007 PLMN selection +COPS.
*/
typedef enum CellularNetworkRegistrationMode
{
REGISTRATION_MODE_AUTO = 0, /**< Auto network registration mode. */
REGISTRATION_MODE_MANUAL = 1, /**< Manual network registration mode. */
REGISTRATION_MODE_DEREGISTER = 2, /**< Deregister network registration mode. */
REGISTRATION_MODE_MANUAL_THEN_AUTO = 4, /**< Manual then auto network registration mode. */
REGISTRATION_MODE_MAX, /**< The number of supported registration mode. */
REGISTRATION_MODE_UNKNOWN /**< Unknown network registration mode. */
} CellularNetworkRegistrationMode_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents network registration status. Reference 3GPP TS 27.007 network registration status.
*/
typedef enum CellularNetworkRegistrationStatus
{
REGISTRATION_STATUS_NO_REGISTERED_SEARCHING = 0, /**< No registered searching network registration status. */
REGISTRATION_STATUS_REGISTERED_HOME = 1, /**< Registered home network registration status. */
REGISTRATION_STATUS_NOT_REGISTERED_SEARCHING = 2, /**< Not registered searching network registration status. */
REGISTRATION_STATUS_REGISTRATION_DENIED = 3, /**< Registration denied network registration status. */
REGISTRATION_STATUS_UNKNOWN = 4, /**< Unknown network registration status. */
REGISTRATION_STATUS_ROAMING_REGISTERED = 5, /**< Roaming registered network registration status. */
REGISTRATION_STATUS_HOME_SMS_ONLY_REGISTERED = 6, /**< Home SMS only registered network registration status. */
REGISTRATION_STATUS_SMS_ONLY_ROAMING_REGISTERED = 7, /**< SMS only roaming registered network registration status. */
REGISTRATION_STATUS_ATTACHED_EMERG_SERVICES_ONLY = 8, /**< Attached emergency service only network registration status. */
REGISTRATION_STATUS_MAX /**< The max supported number for registration status. */
} CellularNetworkRegistrationStatus_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents operator name format.
*/
typedef enum CellularOperatorNameFormat
{
OPERATOR_NAME_FORMAT_LONG = 0, /**< Long operator name format. */
OPERATOR_NAME_FORMAT_SHORT = 1, /**< Short operator name format. */
OPERATOR_NAME_FORMAT_NUMERIC = 2, /**< Numeric operator name format. */
OPERATOR_NAME_FORMAT_NOT_PRESENT = 9, /**< Not present operator name format. */
OPERATOR_NAME_FORMAT_MAX /**< The max supported number for operator name format. */
} CellularOperatorNameFormat_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents URC events.
*/
typedef enum CellularUrcEvent
{
CELLULAR_URC_EVENT_NETWORK_CS_REGISTRATION, /**< Network CS registration URC event. */
CELLULAR_URC_EVENT_NETWORK_PS_REGISTRATION, /**< Network PS registration URC event. */
CELLULAR_URC_EVENT_PDN_ACTIVATED, /**< PDN activated registration URC event. */
CELLULAR_URC_EVENT_PDN_DEACTIVATED, /**< PDN deactivated registration URC event. */
CELLULAR_URC_EVENT_SIGNAL_CHANGED, /**< Signal changed registration URC event. */
CELLULAR_URC_SOCKET_OPENED, /**< Socket opened registration URC event. */
CELLULAR_URC_SOCKET_OPEN_FAILED, /**< Socket open failed registration URC event. */
CELLULAR_URC_EVENT_OTHER /**< Any URC event other than above. */
} CellularUrcEvent_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents Modem events.
*/
typedef enum CellularModemEvent
{
CELLULAR_MODEM_EVENT_BOOTUP_OR_REBOOT, /**< Bootup or reboot modem event. */
CELLULAR_MODEM_EVENT_POWERED_DOWN, /**< Power down modem event. */
CELLULAR_MODEM_EVENT_PSM_ENTER /**< PSM enter modem event. */
} CellularModemEvent_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents PDN context type.
*/
typedef enum CellularPdnContextType
{
CELLULAR_PDN_CONTEXT_IPV4 = 1, /**< IPV4 PDN CONTEXT. */
CELLULAR_PDN_CONTEXT_IPV6 = 2, /**< IPV6 PDN CONTEXT. */
CELLULAR_PDN_CONTEXT_IPV4V6 = 3, /**< IPV4V6 PDN CONTEXT. */
CELLULAR_PDN_CONTEXT_TYPE_MAX /**< The max number of supported PDN CONTEXT. */
} CellularPdnContextType_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents PDN authentication type.
*/
typedef enum CellularPdnAuthType
{
CELLULAR_PDN_AUTH_NONE = 0, /**< No authentication. */
CELLULAR_PDN_AUTH_PAP, /**< Password Authentication Protocol (PAP). */
CELLULAR_PDN_AUTH_CHAP, /**< Challenge Handshake Authentication Protocol (CHAP). */
CELLULAR_PDN_AUTH_PAP_OR_CHAP /**< PAP or CHAP. */
} CellularPdnAuthType_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents socket domain.
*/
typedef enum CellularSocketDomain
{
CELLULAR_SOCKET_DOMAIN_AF_INET, /**< IPv4 Internet Protocols. */
CELLULAR_SOCKET_DOMAIN_AF_INET6 /**< IPv6 Internet Protocols. */
} CellularSocketDomain_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents socket type.
*/
typedef enum CellularSocketType
{
CELLULAR_SOCKET_TYPE_DGRAM, /**< Datagram. */
CELLULAR_SOCKET_TYPE_STREAM /**< Byte-stream. */
} CellularSocketType_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents socket protocol.
*/
typedef enum CellularSocketProtocol
{
CELLULAR_SOCKET_PROTOCOL_UDP,
CELLULAR_SOCKET_PROTOCOL_TCP
} CellularSocketProtocol_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents data access modes.
*/
typedef enum CellularSocketAccessMode
{
CELLULAR_ACCESSMODE_BUFFER = 0, /* Data access buffer mode. */
CELLULAR_ACCESSMODE_DIRECT_PUSH, /* Data access direct push mode. */
CELLULAR_ACCESSMODE_TRANSPARENT, /* Data access transparent mode. */
CELLULAR_ACCESSMODE_NOT_SET /* Data access not set. */
} CellularSocketAccessMode_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents IP address.
*/
typedef enum CellularIPAddressType
{
CELLULAR_IP_ADDRESS_V4, /**< IP V4 IP address. */
CELLULAR_IP_ADDRESS_V6 /**< IP V6 IP address. */
} CellularIPAddressType_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents socket option level.
*/
typedef enum CellularSocketOptionLevel
{
CELLULAR_SOCKET_OPTION_LEVEL_IP, /**< IP layer options. */
CELLULAR_SOCKET_OPTION_LEVEL_TRANSPORT /**< Transport (TCP/UDP) layer options. */
} CellularSocketOptionLevel_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Socket option names.
*/
typedef enum CellularSocketOption
{
CELLULAR_SOCKET_OPTION_MAX_IP_PACKET_SIZE, /**< Set Max IP packet size. */
CELLULAR_SOCKET_OPTION_SEND_TIMEOUT, /**< Set send timeout (in milliseconds). */
CELLULAR_SOCKET_OPTION_RECV_TIMEOUT, /**< Set receive timeout (in milliseconds). */
CELLULAR_SOCKET_OPTION_PDN_CONTEXT_ID, /**< Set PDN Context ID to use for the socket. */
CELLULAR_SOCKET_OPTION_SET_LOCAL_PORT /**< Set local port. */
} CellularSocketOption_t;
/**
* @ingroup cellular_datatypes_enums
* @brief packet Status Names.
*/
typedef enum CellularPktStatus
{
CELLULAR_PKT_STATUS_OK = 0, /* The operation was successful. */
CELLULAR_PKT_STATUS_TIMED_OUT, /* The operation timed out. */
CELLULAR_PKT_STATUS_FAILURE, /* There was some internal failure. */
CELLULAR_PKT_STATUS_BAD_REQUEST, /* Request was not valid. */
CELLULAR_PKT_STATUS_BAD_RESPONSE, /* The response received was not valid. */
CELLULAR_PKT_STATUS_SIZE_MISMATCH, /* There is a size mismatch between the params. */
CELLULAR_PKT_STATUS_BAD_PARAM, /* One or more params is not valid. */
CELLULAR_PKT_STATUS_SEND_ERROR, /* Modem returned a send error. */
CELLULAR_PKT_STATUS_INVALID_HANDLE, /* Invalid context. */
CELLULAR_PKT_STATUS_CREATION_FAIL, /* Resource creation fail. */
CELLULAR_PKT_STATUS_PREFIX_MISMATCH, /* Invalid prefix from Modem resp. */
CELLULAR_PKT_STATUS_INVALID_DATA, /* Invalid data from Modem resp. */
CELLULAR_PKT_STATUS_PENDING_DATA, /* Pending data from Modem resp. */
CELLULAR_PKT_STATUS_PENDING_BUFFER /* Pending data from Modem resp. */
} CellularPktStatus_t;
/**
* @ingroup cellular_datatypes_enums
* @brief Represents AT Command type.
*/
typedef enum CellularATCommandType
{
CELLULAR_AT_NO_RESULT, /**< no response expected, only OK, ERROR etc. */
CELLULAR_AT_WO_PREFIX, /**< string response without a prefix. */
CELLULAR_AT_WITH_PREFIX, /**< string response with a prefix. */
CELLULAR_AT_MULTI_WITH_PREFIX, /**< multiple line response all start with a prefix. */
CELLULAR_AT_MULTI_WO_PREFIX, /**< multiple line response with or without a prefix. */
CELLULAR_AT_MULTI_DATA_WO_PREFIX, /**< multiple line data response with or without a prefix. */
CELLULAR_AT_WO_PREFIX_NO_RESULT_CODE, /**< string response without a prefix and no result code is expected. */
CELLULAR_AT_WITH_PREFIX_NO_RESULT_CODE, /**< string response with a prefix and no result code is expected. */
CELLULAR_AT_NO_COMMAND /**< no command is waiting response. */
} CellularATCommandType_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief SIM Card status.
*/
typedef struct CellularSimCardStatus
{
CellularSimCardState_t simCardState; /**< Cellular sim card state. */
CellularSimCardLockState_t simCardLockState; /**< Cellular sim card lock state. */
} CellularSimCardStatus_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Public Land Mobile Network (PLMN) information.
*/
typedef struct CellularPlmnInfo
{
char mcc[ CELLULAR_MCC_MAX_SIZE + 1 ]; /**< Mobile Country Code (MCC). */
char mnc[ CELLULAR_MNC_MAX_SIZE + 1 ]; /**< Mobile Network Code (MNC). */
} CellularPlmnInfo_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief SIM Card information.
*/
typedef struct CellularSimCardInfo
{
char iccid[ CELLULAR_ICCID_MAX_SIZE + 1 ]; /**< Integrated Circuit Card Identifier aka SIM Card Number. */
char imsi[ CELLULAR_IMSI_MAX_SIZE + 1 ]; /**< International Mobile Subscriber Identity. */
CellularPlmnInfo_t plmn; /**< Public Land Mobile Network (PLMN) information. */
} CellularSimCardInfo_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Modem information.
*/
typedef struct CellularModemInfo
{
char hardwareVersion[ CELLULAR_HW_VERSION_MAX_SIZE + 1 ]; /**< Hardware version number. */
char firmwareVersion[ CELLULAR_FW_VERSION_MAX_SIZE + 1 ]; /**< Firmware version number. */
char serialNumber[ CELLULAR_SERIAL_NUM_MAX_SIZE + 1 ]; /**< Module serial number. */
char imei[ CELLULAR_IMEI_MAX_SIZE + 1 ]; /**< International Mobile Equipment Identity (IMEI). */
char manufactureId[ CELLULAR_MANUFACTURE_ID_MAX_SIZE + 1 ]; /**< Manufacture Identity. */
char modelId[ CELLULAR_MODEL_ID_MAX_SIZE + 1 ]; /**< Model Identity. */
} CellularModemInfo_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents time.
*/
typedef struct CellularTime
{
uint8_t month; /**< 1..12 (Jan = 1 .. Dec = 12). */
uint8_t day; /**< Day of the month 1..31. */
uint8_t hour; /**< Hour of the day 0..23. */
uint8_t minute; /**< Minute of the hour 0..59. */
uint8_t second; /**< Second of the minute 0..59. */
uint16_t year; /**< Year (like 2019). */
int32_t timeZone; /**< Timezone represented in 15 minute increments (UTC+1 will be 4 because 1 hour = 60 minutes = 4 * 15 minutes). */
uint8_t dst; /**< Daylight savings ( 0 = No adjustment for daylight savings
* 1 = +1 hour for daylight savings
* 2 = +2 hours for daylight savings ). */
} CellularTime_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents signal information.
*/
typedef struct CellularSignalInfo
{
int16_t rssi; /**< Received Signal Strength Indicator (RSSI) in dBm.*/
int16_t rsrp; /**< LTE Reference Signal Received Power (RSRP) in dBm. */
int16_t rsrq; /**< LTE Reference Signal Received Quality (RSRQ) in dB. */
int16_t sinr; /**< LTE Signal to Interference-Noise Ratio in dB. */
int16_t ber; /**< Bit Error Rate (BER) in 0.01%. */
uint8_t bars; /**< A number between 0 to 5 (both inclusive) indicating signal strength. */
} CellularSignalInfo_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents network service status.
*/
typedef struct CellularServiceStatus
{
CellularRat_t rat; /**< Radio Access Technology (RAT). */
CellularNetworkRegistrationMode_t networkRegistrationMode; /**< Network registration mode (auto/manual etc.) currently selected. */
CellularNetworkRegistrationStatus_t csRegistrationStatus; /**< CS (Circuit Switched) registration status (registered/searching/roaming etc.). */
CellularNetworkRegistrationStatus_t psRegistrationStatus; /**< PS (Packet Switched) registration status (registered/searching/roaming etc.). */
CellularPlmnInfo_t plmnInfo; /**< Registered MCC and MNC information. */
CellularOperatorNameFormat_t operatorNameFormat; /**< Format of registered network operator name. */
char operatorName[ CELLULAR_NETWORK_NAME_MAX_SIZE + 1 ]; /**< Registered network operator name. */
uint8_t csRejectionType; /**< CS Reject Type. 0 - 3GPP specific Reject Cause. 1 - Manufacture specific. */
uint8_t csRejectionCause; /**< Reason why the CS (Circuit Switched) registration attempt was rejected. */
uint8_t psRejectionType; /**< PS Reject Type. 0 - 3GPP specific Reject Cause. 1 - Manufacture specific. */
uint8_t psRejectionCause; /**< Reason why the PS (Packet Switched) registration attempt was rejected. */
} CellularServiceStatus_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents A singly-lined list of intermediate AT responses.
*/
typedef struct CellularATCommandLine
{
struct CellularATCommandLine * pNext; /**< The CellularATCommandLine structure pointer points to the next element of the linked list. */
char * pLine; /**< The content of the at command. */
} CellularATCommandLine_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents AT Command response.
*/
typedef struct CellularATCommandResponse
{
bool status; /**< true: modem returns Success, false: Error. */
CellularATCommandLine_t * pItm; /**< Any intermediate responses. */
} CellularATCommandResponse_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents PSM settings.
*/
typedef struct CellularPsmSettings
{
/*
* 0 = PSM Disable
* 1 = PSM Enable.
*/
uint8_t mode; /**< PSM mode value (as shown above). */
/*
* Bits 5 to 1 represent the binary coded timer value
* Bits 6 to 8 define the timer value unit as follows:
* Bits
* 8 7 6
* 0 0 0 value is incremented in multiples of 10 minutes
* 0 0 1 value is incremented in multiples of 1 hour
* 0 1 0 value is incremented in multiples of 10 hours
* 0 1 1 value is incremented in multiples of 2 seconds
* 1 0 0 value is incremented in multiples of 30 seconds
* 1 0 1 value is incremented in multiples of 1 minute
*
* e.g. "00001010" equals to 100 minutes.
* first uint8_t is used for PSM set, whole uint32_t is used for PSM get.
*/
uint32_t periodicTauValue; /**< TAU (T3412) value encoded as per spec (as shown above). */
/*
* Bits 5 to 1 represent the binary coded timer value
* Bits 6 to 8 define the timer value unit as follows:
* Bits
* 8 7 6
* 0 0 0 value is incremented in multiples of 10 minutes
* 0 0 1 value is incremented in multiples of 1 hour
* 0 1 0 value is incremented in multiples of 10 hours
* 0 1 1 value is incremented in multiples of 2 seconds
* 1 0 0 value is incremented in multiples of 30 seconds
* 1 0 1 value is incremented in multiples of 1 minute
*
* e.g. "00001010" equals to 100 minutes.
* first uint8_t is used for PSM set, whole uint32_t is used for PSM get.
*/
uint32_t periodicRauValue; /**< RAU (T3312) value encoded as per Spec (as shown above). */
/*
* Bits 5 to 1 represent the binary coded timer value
* Bits 6 to 8 define the timer value unit as follows:
* Bits
* 8 7 6
* 0 0 0 value is incremented in multiples of 10 minutes
* 0 0 1 value is incremented in multiples of 1 hour
* 0 1 0 value is incremented in multiples of 10 hours
* 0 1 1 value is incremented in multiples of 2 seconds
* 1 0 0 value is incremented in multiples of 30 seconds
* 1 0 1 value is incremented in multiples of 1 minute
*
* e.g. "00001010" equals to 100 minutes.
* first uint8_t is used for PSM set, whole uint32_t is used for PSM get.
*/
uint32_t gprsReadyTimer; /**< GPRS Ready timer (T3314) value encoded as per Spec. */
/*
* Bits 5 to 1 represent the binary coded timer value.
* Bits 6 to 8 define the timer value unit as follows:
* Bits
* 8 7 6
* 0 0 0 value is incremented in multiples of 2 seconds
* 0 0 1 value is incremented in multiples of 1 minute
* 0 1 0 value is incremented in multiples of decihours
* 1 1 1 value indicates that the timer is deactivated.
*
* "00001111" equals to 30 seconds.
* first uint8_t is used for PSM set, whole uint32_t is used for PSM get.
*/
uint32_t activeTimeValue; /**< Active Time (T3324) value encoded as per spec (as shown above). */
} CellularPsmSettings_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents e-I-DRX settings.
*/
typedef struct CellularEidrxSettings
{
/*
* 0 Disable the use of e-I-DRX
* 1 Enable the use of e-I-DRX
* 2 Enable the use of e-I-DRX and enable the unsolicited result code
* 3 Disable the use of e-I-DRX and discard all parameters for e-I-DRX or,
* if available, reset to the manufacturer specific default values.
*/
uint8_t mode; /**< e-I-DRX mode (as shown above). */
/*
* 2 GSM
* 3 UTRAN
* 4 LTE Cat M1
* 5 LTE Cat NB1
*/
uint8_t rat; /**< Radio Access Technology (as shown above). */
/*
* String type. Half a byte in a 4 bit format.
* bit
* 4 3 2 1 E-UTRAN e-I-DRX cycle length duration
* 0 0 0 0 5.12 seconds
* 0 0 0 1 10.24 seconds
* 0 0 1 0 20.48 seconds
* 0 0 1 1 40.96 seconds
* 0 1 0 0 61.44 seconds
* 0 1 0 1 81.92 seconds
* 0 1 1 0 102.4 seconds
* 0 1 1 1 122.88 seconds
* 1 0 0 0 143.36 seconds
* 1 0 0 1 163.84 seconds
* 1 0 1 0 327.68 seconds
* 1 0 1 1 655,36 seconds
* 1 1 0 0 1310.72 seconds
* 1 1 0 1 2621.44 seconds
* 1 1 1 0 5242.88 seconds
* 1 1 1 1 10485.76 seconds
*/
uint8_t requestedEdrxValue; /**< Requested eDRX value encoded as per spec (as shown above). */
uint8_t nwProvidedEdrxValue; /**< Network provided eDRX value encoded as per spec (as shown above). Only applicable in URC. */
/*
* LTE Cat M1 mode
* bit
* 4 3 2 1 Paging Time Window length
* 0 0 0 0 1.28 seconds
* 0 0 0 1 2.56 seconds
* 0 0 1 0 3.84 seconds
* 0 0 1 1 5.12 seconds
* 0 1 0 0 6.4 seconds
* 0 1 0 1 7.68 seconds
* 0 1 1 0 8.96 seconds
* 0 1 1 1 10.24 seconds
* 1 0 0 0 11.52 seconds
* 1 0 0 1 12.8 seconds
* 1 0 1 0 14.08 seconds
* 1 0 1 1 15.36 seconds
* 1 1 0 0 16.64 seconds
* 1 1 0 1 17.92 seconds
* 1 1 1 0 19.20 seconds
* 1 1 1 1 20.48 seconds
*
* LTE Cat NB1 mode
* bit
* 4 3 2 1 Paging Time Window length
* 0 0 0 0 2.56 seconds
* 0 0 0 1 5.12 seconds
* 0 0 1 0 7.68 seconds
* 0 0 1 1 10.24 seconds
* 0 1 0 0 12.8 seconds
* 0 1 0 1 15.36 seconds
* 0 1 1 0 17.92 seconds
* 0 1 1 1 20.48 seconds
* 1 0 0 0 23.04 seconds
* 1 0 0 1 25.6 seconds
* 1 0 1 0 28.16 seconds
* 1 0 1 1 30.72 seconds
* 1 1 0 0 33.28 seconds
* 1 1 0 1 35.84 seconds
* 1 1 1 0 38.4 seconds
* 1 1 1 1 40.96 seconds
*/
uint8_t pagingTimeWindow; /**< Paging time window encoded as per spec (as shown above). Only applicable in URC. */
} CellularEidrxSettings_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Cellular Represents e-I-DRX settings Lists.
*/
typedef struct CellularEidrxSettingsList
{
CellularEidrxSettings_t eidrxList[ CELLULAR_EDRX_LIST_MAX_SIZE ]; /**< Cellular e-I-DRX settings list. */
uint8_t count; /**< Cellular e-I-DRX settings list number. */
} CellularEidrxSettingsList_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents IP Address.
*/
typedef struct CellularIPAddress
{
CellularIPAddressType_t ipAddressType; /**< Type of IP address (IPv4/IPv6). */
char ipAddress[ CELLULAR_IP_ADDRESS_MAX_SIZE + 1 ]; /**< IP Address. NULL terminated. */
} CellularIPAddress_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents a PDN config.
*/
typedef struct CellularPdnConfig
{
CellularPdnContextType_t pdnContextType; /**< PDN Context type. */
CellularPdnAuthType_t pdnAuthType; /**< PDN Authentication type. */
char apnName[ CELLULAR_APN_MAX_SIZE + 1 ]; /**< APN name. */
char username[ CELLULAR_PDN_USERNAME_MAX_SIZE + 1 ]; /**< Username. */
char password[ CELLULAR_PDN_PASSWORD_MAX_SIZE + 1 ]; /**< Password. */
} CellularPdnConfig_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents status of a PDN context.
*/
typedef struct CellularPdnStatus
{
uint8_t contextId; /**< 1-16 are valid values. */
uint8_t state; /**< 0 = Deactivated, 1 = Activated. */
CellularPdnContextType_t pdnContextType; /**< PDN Context type. */
CellularIPAddress_t ipAddress; /**< Local IP address after the context is activated. */
} CellularPdnStatus_t;
/**
* @ingroup cellular_datatypes_paramstructs
* @brief Represents socket address.
*/
typedef struct CellularSocketAddress
{
CellularIPAddress_t ipAddress; /**< IP address. */
uint16_t port; /**< Port number. */
} CellularSocketAddress_t;
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about the response of an AT command sent
* using Cellular_ATCommandRaw API.
*
* @param[in] cellularHandle The opaque cellular context pointer created by Cellular_Init.
* @param[in] pAtResp The response received for the AT command.
* @param[in] pData is pATCommandPayload pointer in Cellular_ATCommandRaw parameters.
* @param[in] dataLen is the string length of pATCommandPayload in in Cellular_ATCommandRaw parameters.
*
* @return CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error
* code indicating the cause of the error.
*/
typedef CellularPktStatus_t ( * CellularATCommandResponseReceivedCallback_t ) ( CellularHandle_t cellularHandle,
const CellularATCommandResponse_t * pAtResp,
void * pData,
uint16_t dataLen );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about a Network Registration URC event.
*
* @param[in] urcEvent URC Event that happened.
* @param[in] pServiceStatus The status of the network service.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_RegisterUrcNetworkRegistrationEventCallback function.
*/
typedef void ( * CellularUrcNetworkRegistrationCallback_t )( CellularUrcEvent_t urcEvent,
const CellularServiceStatus_t * pServiceStatus,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about PDN URC events.
*
* @param[in] urcEvent URC Event that happened.
* @param[in] contextId Context ID of the PDN context
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_RegisterUrcPdnEventCallback function.
*/
typedef void ( * CellularUrcPdnEventCallback_t )( CellularUrcEvent_t urcEvent,
uint8_t contextId,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about signal strength changed URC event.
*
* @param[in] urcEvent URC Event that happened.
* @param[in] pSignalInfo The new signal information.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_RegisterUrcSignalStrengthChangedCallback function.
*/
typedef void ( * CellularUrcSignalStrengthChangedCallback_t )( CellularUrcEvent_t urcEvent,
const CellularSignalInfo_t * pSignalInfo,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Generic callback used to inform all other URC events.
*
* @param[in] pRawData Raw data received in the URC event.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_RegisterUrcGenericCallback function.
*/
typedef void ( * CellularUrcGenericCallback_t )( const char * pRawData,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about modem events.
*
* @param[in] modemEvent The modem event.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_RegisterModemEventCallback function.
*/
typedef void ( * CellularModemEventCallback_t )( CellularModemEvent_t modemEvent,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform about the status of socket open.
*
* @param[in] urcEvent URC Event that happened.
* @param[in] socketHandle Socket handle for which data is ready.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_SocketRegisterSocketOpenCallback function.
*/
typedef void ( * CellularSocketOpenCallback_t )( CellularUrcEvent_t urcEvent,
CellularSocketHandle_t socketHandle,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform that data is ready for reading on a socket.
*
* @param[in] socketHandle Socket handle for which data is ready.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_SocketRegisterDataReadyCallback function.
*/
typedef void ( * CellularSocketDataReadyCallback_t )( CellularSocketHandle_t socketHandle,
void * pCallbackContext );
/**
* @ingroup cellular_datatypes_functionpointers
* @brief Callback used to inform that remote end closed the connection for a
* connected socket.
*
* @param[in] socketHandle Socket handle for which remote end closed the
* connection.
* @param[in] pCallbackContext pCallbackContext parameter in
* Cellular_SocketRegisterClosedCallback function.
*/
typedef void ( * CellularSocketClosedCallback_t )( CellularSocketHandle_t socketHandle,
void * pCallbackContext );
/* *INDENT-OFF* */
#ifdef __cplusplus
}
#endif
/* *INDENT-ON* */
#endif /* __CELLULAR_TYPES_H__ */