Represents the MAC layer counters.
Public Attributes#
The total number of unique MAC frame transmission requests.
The total number of unique unicast MAC frame transmission requests.
The total number of unique broadcast MAC frame transmission requests.
The total number of unique MAC frame transmission requests with requested acknowledgment.
The total number of unique MAC frame transmission requests that were acked.
The total number of unique MAC frame transmission requests without requested acknowledgment.
The total number of unique MAC Data frame transmission requests.
The total number of unique MAC Data Poll frame transmission requests.
The total number of unique MAC Beacon frame transmission requests.
The total number of unique MAC Beacon Request frame transmission requests.
The total number of unique other MAC frame transmission requests.
The total number of MAC retransmission attempts.
The total number of unique MAC transmission packets that meet maximal retry limit for direct packets.
The total number of unique MAC transmission packets that meet maximal retry limit for indirect packets.
The total number of CCA failures.
The total number of unique MAC transmission request failures cause by an abort error.
The total number of unique MAC transmission requests failures caused by a busy channel (a CSMA/CA fail).
The total number of received frames.
The total number of unicast frames received.
The total number of broadcast frames received.
The total number of MAC Data frames received.
The total number of MAC Data Poll frames received.
The total number of MAC Beacon frames received.
The total number of MAC Beacon Request frames received.
The total number of other types of frames received.
The total number of frames dropped by MAC Filter module, for example received from denylisted node.
The total number of frames dropped by destination address check, for example received frame for other node.
The total number of frames dropped due to duplication, that is when the frame has been already received.
The total number of frames dropped because of missing or malformed content.
The total number of frames dropped due to unknown neighbor.
The total number of frames dropped due to invalid source address.
The total number of frames dropped due to security error.
The total number of frames dropped due to invalid FCS.
The total number of frames dropped due to other error.
Public Attribute Documentation#
mTxTotal#
uint32_t otMacCounters::mTxTotal
The total number of unique MAC frame transmission requests.
Note that this counter is incremented for each MAC transmission request only by one, regardless of the amount of CCA failures, CSMA-CA attempts, or retransmissions.
This increment rule applies to the following counters:
mTxUnicastmTxBroadcastmTxAckRequestedmTxNoAckRequestedmTxDatamTxDataPollmTxBeaconmTxBeaconRequestmTxOthermTxErrAbortmTxErrBusyChannel
The following equations are valid:
mTxTotal=mTxUnicast+mTxBroadcastmTxTotal=mTxAckRequested+mTxNoAckRequestedmTxTotal=mTxData+mTxDataPoll+mTxBeacon+mTxBeaconRequest+mTxOther
119 of file include/openthread/link.hmTxUnicast#
uint32_t otMacCounters::mTxUnicast
The total number of unique unicast MAC frame transmission requests.
125 of file include/openthread/link.hmTxBroadcast#
uint32_t otMacCounters::mTxBroadcast
The total number of unique broadcast MAC frame transmission requests.
131 of file include/openthread/link.hmTxAckRequested#
uint32_t otMacCounters::mTxAckRequested
The total number of unique MAC frame transmission requests with requested acknowledgment.
137 of file include/openthread/link.hmTxAcked#
uint32_t otMacCounters::mTxAcked
The total number of unique MAC frame transmission requests that were acked.
143 of file include/openthread/link.hmTxNoAckRequested#
uint32_t otMacCounters::mTxNoAckRequested
The total number of unique MAC frame transmission requests without requested acknowledgment.
149 of file include/openthread/link.hmTxData#
uint32_t otMacCounters::mTxData
The total number of unique MAC Data frame transmission requests.
155 of file include/openthread/link.hmTxDataPoll#
uint32_t otMacCounters::mTxDataPoll
The total number of unique MAC Data Poll frame transmission requests.
161 of file include/openthread/link.hmTxBeacon#
uint32_t otMacCounters::mTxBeacon
The total number of unique MAC Beacon frame transmission requests.
167 of file include/openthread/link.hmTxBeaconRequest#
uint32_t otMacCounters::mTxBeaconRequest
The total number of unique MAC Beacon Request frame transmission requests.
173 of file include/openthread/link.hmTxOther#
uint32_t otMacCounters::mTxOther
The total number of unique other MAC frame transmission requests.
This counter is currently used for counting out-of-band frames.
181 of file include/openthread/link.hmTxRetry#
uint32_t otMacCounters::mTxRetry
The total number of MAC retransmission attempts.
Note that this counter is incremented by one for each retransmission attempt that may be triggered by lack of acknowledgement, CSMA/CA failure, or other type of transmission error. The mTxRetry counter is incremented both for unicast and broadcast MAC frames.
Modify the following configuration parameters to control the amount of retransmissions in the system:
OPENTHREAD_CONFIG_MAC_DEFAULT_MAX_FRAME_RETRIES_DIRECT
OPENTHREAD_CONFIG_MAC_DEFAULT_MAX_FRAME_RETRIES_INDIRECT
OPENTHREAD_CONFIG_MAC_TX_NUM_BCAST
OPENTHREAD_CONFIG_MAC_MAX_CSMA_BACKOFFS_DIRECT
OPENTHREAD_CONFIG_MAC_MAX_CSMA_BACKOFFS_INDIRECT
Currently, this counter is invalid if the platform's radio driver capability includes OT_RADIO_CAPS_TRANSMIT_RETRIES.
202 of file include/openthread/link.hmTxDirectMaxRetryExpiry#
uint32_t otMacCounters::mTxDirectMaxRetryExpiry
The total number of unique MAC transmission packets that meet maximal retry limit for direct packets.
208 of file include/openthread/link.hmTxIndirectMaxRetryExpiry#
uint32_t otMacCounters::mTxIndirectMaxRetryExpiry
The total number of unique MAC transmission packets that meet maximal retry limit for indirect packets.
214 of file include/openthread/link.hmTxErrCca#
uint32_t otMacCounters::mTxErrCca
The total number of CCA failures.
The meaning of this counter can be different and it depends on the platform's radio driver capabilities.
If OT_RADIO_CAPS_CSMA_BACKOFF is enabled, this counter represents the total number of full CSMA/CA failed attempts and it is incremented by one also for each retransmission (in case of a CSMA/CA fail).
If OT_RADIO_CAPS_TRANSMIT_RETRIES is enabled, this counter represents the total number of full CSMA/CA failed attempts and it is incremented by one for each individual data frame request (regardless of the amount of retransmissions).
229 of file include/openthread/link.hmTxErrAbort#
uint32_t otMacCounters::mTxErrAbort
The total number of unique MAC transmission request failures cause by an abort error.
235 of file include/openthread/link.hmTxErrBusyChannel#
uint32_t otMacCounters::mTxErrBusyChannel
The total number of unique MAC transmission requests failures caused by a busy channel (a CSMA/CA fail).
241 of file include/openthread/link.hmRxTotal#
uint32_t otMacCounters::mRxTotal
The total number of received frames.
This counter counts all frames reported by the platform's radio driver, including frames that were dropped, for example because of an FCS error.
250 of file include/openthread/link.hmRxUnicast#
uint32_t otMacCounters::mRxUnicast
The total number of unicast frames received.
256 of file include/openthread/link.hmRxBroadcast#
uint32_t otMacCounters::mRxBroadcast
The total number of broadcast frames received.
262 of file include/openthread/link.hmRxData#
uint32_t otMacCounters::mRxData
The total number of MAC Data frames received.
268 of file include/openthread/link.hmRxDataPoll#
uint32_t otMacCounters::mRxDataPoll
The total number of MAC Data Poll frames received.
274 of file include/openthread/link.hmRxBeacon#
uint32_t otMacCounters::mRxBeacon
The total number of MAC Beacon frames received.
280 of file include/openthread/link.hmRxBeaconRequest#
uint32_t otMacCounters::mRxBeaconRequest
The total number of MAC Beacon Request frames received.
286 of file include/openthread/link.hmRxOther#
uint32_t otMacCounters::mRxOther
The total number of other types of frames received.
292 of file include/openthread/link.hmRxAddressFiltered#
uint32_t otMacCounters::mRxAddressFiltered
The total number of frames dropped by MAC Filter module, for example received from denylisted node.
298 of file include/openthread/link.hmRxDestAddrFiltered#
uint32_t otMacCounters::mRxDestAddrFiltered
The total number of frames dropped by destination address check, for example received frame for other node.
304 of file include/openthread/link.hmRxDuplicated#
uint32_t otMacCounters::mRxDuplicated
The total number of frames dropped due to duplication, that is when the frame has been already received.
This counter may be incremented, for example when ACK frame generated by the receiver hasn't reached transmitter node which performed retransmission.
313 of file include/openthread/link.hmRxErrNoFrame#
uint32_t otMacCounters::mRxErrNoFrame
The total number of frames dropped because of missing or malformed content.
319 of file include/openthread/link.hmRxErrUnknownNeighbor#
uint32_t otMacCounters::mRxErrUnknownNeighbor
The total number of frames dropped due to unknown neighbor.
325 of file include/openthread/link.hmRxErrInvalidSrcAddr#
uint32_t otMacCounters::mRxErrInvalidSrcAddr
The total number of frames dropped due to invalid source address.
331 of file include/openthread/link.hmRxErrSec#
uint32_t otMacCounters::mRxErrSec
The total number of frames dropped due to security error.
This counter may be incremented, for example when lower than expected Frame Counter is used to encrypt the frame.
340 of file include/openthread/link.hmRxErrFcs#
uint32_t otMacCounters::mRxErrFcs
The total number of frames dropped due to invalid FCS.
346 of file include/openthread/link.hmRxErrOther#
uint32_t otMacCounters::mRxErrOther
The total number of frames dropped due to other error.
352 of file include/openthread/link.h