WizziLab / modem_ref_v5_3_217

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   modem_ref_helper_for_v5_3_217

Embed: (wiki syntax)

« Back to documentation index

D7A API (all except APL)
Data Structures | Typedefs | Enumerations | Enumerator | Variables

D7A API (all except APL)
[D7A 1.x API]

Data Structures

struct  d7a_buf_t
 Generic D7A buffer structure. More...
union  d7a_addressee_ctrl_t
 Bitfield structure of the Addressee control byte. More...
union  d7a_xcl_t
 Bitfield structure of the Addressee Access Class. More...
union  d7a_ch_header_t
 Bitfield structure of the channel identifier. More...
union  d7a_qos_t
 Bitfield structure of the D7ASP Quality of Service control byte. More...
union  d7a_sp_status_t
 Structure of the D7ASP Configuration. More...
struct  d7a_res_t
 NWL Security File structure. More...
union  d7a_req_status_t
 D7A session request status. More...
union  d7a_status_t
 D7A session procedure status upon termination. More...

Typedefs

typedef kal_ctf_t d7a_ctf_t
 Structure of the D7ATP Addressee byte.

Enumerations

enum  d7a_id_t {
  D7A_ID_VOID = 0, D7A_ID_NBID = 0, D7A_ID_NOID = 1, D7A_ID_UID = 2,
  D7A_ID_VID = 3
}
 

Identifier types enumerator.

More...
enum  d7a_nls_t {
  D7A_NLS_NO = 0, D7A_NLS_AES_CTR, D7A_NLS_AES_CBC_MAC_128, D7A_NLS_AES_CBC_MAC_64,
  D7A_NLS_AES_CBC_MAC_32, D7A_NLS_AES_CCM_128, D7A_NLS_AES_CCM_64, D7A_NLS_AES_CCM_32,
  D7A_NLS_QTY
}
 

Enumerator of the NWL security modes.

More...
enum  d7a_resp_t {
  D7A_RESP_NO = 0, D7A_RESP_ALL, D7A_RESP_ANY, D7A_RESP_ALL_ON_DATA,
  D7A_RESP_NO_RPT, D7A_RESP_ANY_ON_DATA, D7A_RESP_PREFERRED, D7A_RESP_PREFERRED_ON_DATA
}
 

Enumerator of the D7ASP Response types.

More...
enum  d7a_retry_t {
  D7A_RETRY_ONESHOT = 0, D7A_RETRY_ONESHOT_RETRY, D7A_RETRY_FIFO_FAST, D7A_RETRY_FIFO_SLOW,
  D7A_RETRY_SINGLE_FAST, D7A_RETRY_SINGLE_SLOW, D7A_RETRY_ONESHOT_STICKY, D7A_RETRY_RFU_7
}
enum  d7a_error_t {
  D7A_ERROR_NO = 0, D7A_ERROR_BUSY = -1, D7A_ERROR_BAD_PARAM = -2, D7A_ERROR_DUTY_CYCLE = -3,
  D7A_ERROR_CCA_TO = -4, D7A_ERROR_NLS_KEY = -5, D7A_ERROR_TX_UDF = -6, D7A_ERROR_RX_OVF = -7,
  D7A_ERROR_RX_CRC = -8, D7A_ERROR_ABORT = -9, D7A_ERROR_NO_ACK = -10, D7A_ERROR_RX_TO = -11,
  D7A_ERROR_NOT_SUPPORTED_BAND = -12, D7A_ERROR_NOT_SUPPORTED_CHANNEL = -13, D7A_ERROR_NOT_SUPPORTED_MODULATION = -14, D7A_ERROR_VOID_CHANNEL_LIST = -15
}
 

Error types enumerator for D7A.

More...

Variables

u8 pof
 Payload start offset (Result length)
u8 shadow_len
 Shadow buffer payload length (snap/restore)
u8 shadow_pof
 Shadow Payload start offset (snap/restore)
u8 data [1]
 Data.
u8   idf: 2
 ID type.
u8   rfu_6: 1
 RFU.
u8   s: 4
 Specifier.
u8   cl: 2
 Channel Class.
u8   band: 3
 Channel Band.
u8   ext: 1
 Extension.
u8   retry: 3
 Retry mode.
u8   rfu: 2
 RFU.
u8   idf: 2
 Identifier type of the received segment.
u8   retry: 1
 Current seqnum was already received.
u8   missed: 1
 There are not received seqnums anterior to the current seqnum.
u32 date
 End reception date.
s16 fei
 frequency offset (frequency error)
u8 len
 Size of the result (depends on origin Addresse ID)
u8 target_rxlev
 Target RXLEV in -dBm.
d7a_sp_res_t sp
 segment metadata
u32   tag: 8
 Tag of the request.
u32   ok: 1
 request flush status
u32   rfu: 7
 RFU.
u32   err: 8
 D7A error.
u32 word
 word access
u32   ok: 1
 Flush status.
u32   rfu: 15
 RFU.
u32   err: 8
 D7A error.
u32 word
 word access

Typedef Documentation

typedef kal_ctf_t d7a_ctf_t

Structure of the D7ATP Addressee byte.

DLL compressed time format

Definition at line 235 of file d7a_1x.h.

Enumeration Type Documentation

enum d7a_error_t

Error types enumerator for D7A.

Enumerator:
D7A_ERROR_NO 

No error.

D7A_ERROR_BUSY 

Resource busy.

D7A_ERROR_BAD_PARAM 

Bad parameter.

D7A_ERROR_DUTY_CYCLE 

Duty cycle limit overflow.

D7A_ERROR_CCA_TO 

CCA timeout.

D7A_ERROR_NLS_KEY 

Security frame counter overflow.

D7A_ERROR_TX_UDF 

TX stream underflow.

D7A_ERROR_RX_OVF 

RX stream overflow.

D7A_ERROR_RX_CRC 

RX checksum.

D7A_ERROR_ABORT 

Abort.

D7A_ERROR_NO_ACK 

No ACK received.

D7A_ERROR_RX_TO 

RX timeout.

D7A_ERROR_NOT_SUPPORTED_BAND 

Not supported band.

D7A_ERROR_NOT_SUPPORTED_CHANNEL 

Not supported channel.

D7A_ERROR_NOT_SUPPORTED_MODULATION 

Not supported modulation.

D7A_ERROR_VOID_CHANNEL_LIST 

No channels in list.

Definition at line 470 of file d7a_1x.h.

enum d7a_id_t

Identifier types enumerator.

Enumerator:
D7A_ID_VOID 

skipped Unicast identifier

D7A_ID_NBID 

Void identifier (broadcast) with indication of number of reached devices.

D7A_ID_NOID 

Void identifier (broadcast)

D7A_ID_UID 

Unique Identifier.

D7A_ID_VID 

Virtual identifier.

Definition at line 77 of file d7a_1x.h.

enum d7a_nls_t

Enumerator of the NWL security modes.

Enumerator:
D7A_NLS_NO 

No security enabled.

D7A_NLS_AES_CTR 

Encryption only, Counter Mode.

D7A_NLS_AES_CBC_MAC_128 

No encryption, Authentication, Cipher-block chaining with 128 bit MAC.

D7A_NLS_AES_CBC_MAC_64 

No encryption, Authentication, Cipher-block chaining with 64 bit MAC.

D7A_NLS_AES_CBC_MAC_32 

No encryption, Authentication, Cipher-block chaining with 32 bit MAC.

D7A_NLS_AES_CCM_128 

Authentication with CBC-MAC-128 and Encryption with Counter Mode.

D7A_NLS_AES_CCM_64 

Authentication with CBC-MAC-128 and Encryption with Counter Mode.

D7A_NLS_AES_CCM_32 

Authentication with CBC-MAC-128 and Encryption with Counter Mode.

D7A_NLS_QTY 

QTY.

Definition at line 98 of file d7a_1x.h.

enum d7a_resp_t

Enumerator of the D7ASP Response types.

Enumerator:
D7A_RESP_NO 

No response requested.

D7A_RESP_ALL 

Get all responses in response period.

D7A_RESP_ANY 

Get at least one ACK per request during response period.

D7A_RESP_ALL_ON_DATA 

Same as D7A_RESP_ALL, but responders respond only if upper layer payload is available It is suitable for cases when the smart addressing (queries) is used.

D7A_RESP_NO_RPT 

No response requested, repeat the number of times defined in the SEL configuration file.

D7A_RESP_ANY_ON_DATA 

Same as D7A_RESP_ANY, but responders respond only if upper layer payload is available It is suitable for cases when the smart addressing (queries) is used.

D7A_RESP_PREFERRED 

Get at least one acknowledgement per request during response period.

Stick to a single responder when possible

D7A_RESP_PREFERRED_ON_DATA 

Same as D7A_RESP_PREFERRED, but responders respond only if upper layer payload is available It is suitable for cases when the smart addressing (queries) is used.

Definition at line 273 of file d7a_1x.h.

enum d7a_retry_t
Enumerator:
D7A_RETRY_ONESHOT 

Single request, try once (context cleaned upon completion) Suitable for low QoS or QoS managed by the application.

D7A_RETRY_ONESHOT_RETRY 

Single request, retry 3 times (context cleaned upon completion) Suitable for higher QoS or QoS managed by the application.

D7A_RETRY_FIFO_FAST 

FIFO mode with fast retry pattern (context kept on completion) Suitable for periodic frequent chart-type ActP notifications (< ~10s between messages)

D7A_RETRY_FIFO_SLOW 

FIFO mode with slow retry pattern (context kept on completion) Suitable for periodic unfrequent chart-type ActP notifications (> ~10s between messages)

D7A_RETRY_SINGLE_FAST 

Single ("last-is-best") mode with fast retry pattern (context kept on completion) Suitable for periodic frequent state-type ActP notifications (< ~10s between messages)

D7A_RETRY_SINGLE_SLOW 

Single ("last-is-best") mode with slow retry pattern (context kept on completion) Suitable for periodic unfrequent state-type ActP notifications (> ~10s between messages)

D7A_RETRY_ONESHOT_STICKY 

Single request, retry 8 times or more (context cleaned upon completion) Suitable for rare ActP notifications with higher priority (revision, etc).

Suitable for application requests where the QoS is managed by the stack or the completion is not expected synchronously (could be very long)

D7A_RETRY_RFU_7 

Reserved for future use.

Definition at line 303 of file d7a_1x.h.

Variable Documentation

u8 band [inherited]

Channel Band.

Definition at line 258 of file d7a_1x.h.

u8 band [inherited]

Channel Band.

Definition at line 258 of file d7a_1x.h.

u8 cl [inherited]

Channel Class.

Definition at line 256 of file d7a_1x.h.

u8 cl [inherited]

Channel Class.

Definition at line 256 of file d7a_1x.h.

u8 data[1] [inherited]

Data.

Definition at line 39 of file d7a_1x.h.

u32 date [inherited]

End reception date.

Definition at line 453 of file d7a_1x.h.

u32 err [inherited]

D7A error.

Definition at line 524 of file d7a_1x.h.

u32 err [inherited]

D7A error.

Definition at line 524 of file d7a_1x.h.

u32 err [inherited]

D7A error.

Definition at line 548 of file d7a_1x.h.

u32 err [inherited]

D7A error.

Definition at line 548 of file d7a_1x.h.

u8 ext [inherited]

Extension.

Definition at line 260 of file d7a_1x.h.

u8 ext [inherited]

Extension.

Definition at line 260 of file d7a_1x.h.

s16 fei [inherited]

frequency offset (frequency error)

Definition at line 455 of file d7a_1x.h.

u8 idf [inherited]

Identifier type of the received segment.

Definition at line 385 of file d7a_1x.h.

u8 idf [inherited]

ID type.

Definition at line 193 of file d7a_1x.h.

u8 idf [inherited]

Identifier type of the received segment.

Definition at line 385 of file d7a_1x.h.

u8 idf [inherited]

ID type.

Definition at line 193 of file d7a_1x.h.

u8 len [inherited]

Size of the result (depends on origin Addresse ID)

Definition at line 457 of file d7a_1x.h.

u8 missed [inherited]

There are not received seqnums anterior to the current seqnum.

Definition at line 389 of file d7a_1x.h.

u8 missed [inherited]

There are not received seqnums anterior to the current seqnum.

Definition at line 389 of file d7a_1x.h.

u32 ok [inherited]

request flush status

Definition at line 520 of file d7a_1x.h.

u32 ok [inherited]

request flush status

Definition at line 520 of file d7a_1x.h.

u32 ok [inherited]

Flush status.

Definition at line 544 of file d7a_1x.h.

u32 ok [inherited]

Flush status.

Definition at line 544 of file d7a_1x.h.

u8 pof [inherited]

Payload start offset (Result length)

Definition at line 33 of file d7a_1x.h.

u8 retry [inherited]

Retry mode.

Definition at line 345 of file d7a_1x.h.

u8 retry [inherited]

Retry mode.

Definition at line 345 of file d7a_1x.h.

u8 retry [inherited]

Current seqnum was already received.

Definition at line 387 of file d7a_1x.h.

u8 retry [inherited]

Current seqnum was already received.

Definition at line 387 of file d7a_1x.h.

u32 rfu [inherited]

RFU.

Definition at line 522 of file d7a_1x.h.

u32 rfu [inherited]

RFU.

Definition at line 546 of file d7a_1x.h.

u32 rfu [inherited]

RFU.

Definition at line 522 of file d7a_1x.h.

u32 rfu [inherited]

RFU.

Definition at line 546 of file d7a_1x.h.

u8 rfu [inherited]

RFU.

Definition at line 347 of file d7a_1x.h.

u8 rfu [inherited]

RFU.

Definition at line 347 of file d7a_1x.h.

u8 rfu_6 [inherited]

RFU.

Definition at line 195 of file d7a_1x.h.

u8 rfu_6 [inherited]

RFU.

Definition at line 195 of file d7a_1x.h.

u8 s [inherited]

Specifier.

Definition at line 216 of file d7a_1x.h.

u8 s [inherited]

Specifier.

Definition at line 216 of file d7a_1x.h.

u8 shadow_len [inherited]

Shadow buffer payload length (snap/restore)

Definition at line 35 of file d7a_1x.h.

u8 shadow_pof [inherited]

Shadow Payload start offset (snap/restore)

Definition at line 37 of file d7a_1x.h.

d7a_sp_res_t sp [inherited]

segment metadata

Definition at line 461 of file d7a_1x.h.

u32 tag [inherited]

Tag of the request.

Definition at line 518 of file d7a_1x.h.

u32 tag [inherited]

Tag of the request.

Definition at line 518 of file d7a_1x.h.

u8 target_rxlev [inherited]

Target RXLEV in -dBm.

Definition at line 459 of file d7a_1x.h.

u32 word [inherited]

word access

Definition at line 552 of file d7a_1x.h.

u32 word [inherited]

word access

Definition at line 528 of file d7a_1x.h.

Generated on Wed Jul 20 2022 12:33:07 by  doxygen 1.7.2