otMacCounters Struct Reference

This structure represents the MAC layer counters.

#include < include/openthread/link.h >

Public Attributes

uint32_t mTxTotal
The total number of unique MAC frame transmission requests.
uint32_t mTxUnicast
The total number of unique unicast MAC frame transmission requests.
uint32_t mTxBroadcast
The total number of unique broadcast MAC frame transmission requests.
uint32_t mTxAckRequested
The total number of unique MAC frame transmission requests with requested acknowledgment.
uint32_t mTxAcked
The total number of unique MAC frame transmission requests that were acked.
uint32_t mTxNoAckRequested
The total number of unique MAC frame transmission requests without requested acknowledgment.
uint32_t mTxData
The total number of unique MAC Data frame transmission requests.
uint32_t mTxDataPoll
The total number of unique MAC Data Poll frame transmission requests.
uint32_t mTxBeacon
The total number of unique MAC Beacon frame transmission requests.
uint32_t mTxBeaconRequest
The total number of unique MAC Beacon Request frame transmission requests.
uint32_t mTxOther
The total number of unique other MAC frame transmission requests.
uint32_t mTxRetry
The total number of MAC retransmission attempts.
uint32_t mTxDirectMaxRetryExpiry
The total number of unique MAC transmission packets that meet maximal retry limit for direct packets.
uint32_t mTxIndirectMaxRetryExpiry
The total number of unique MAC transmission packets that meet maximal retry limit for indirect packets.
uint32_t mTxErrCca
The total number of CCA failures.
uint32_t mTxErrAbort
The total number of unique MAC transmission request failures cause by an abort error.
uint32_t mTxErrBusyChannel
The total number of unique MAC transmission requests failures caused by a busy channel (a CSMA/CA fail).
uint32_t mRxTotal
The total number of received frames.
uint32_t mRxUnicast
The total number of unicast frames received.
uint32_t mRxBroadcast
The total number of broadcast frames received.
uint32_t mRxData
The total number of MAC Data frames received.
uint32_t mRxDataPoll
The total number of MAC Data Poll frames received.
uint32_t mRxBeacon
The total number of MAC Beacon frames received.
uint32_t mRxBeaconRequest
The total number of MAC Beacon Request frames received.
uint32_t mRxOther
The total number of other types of frames received.
uint32_t mRxAddressFiltered
The total number of frames dropped by MAC Filter module, for example received from denylisted node.
uint32_t mRxDestAddrFiltered
The total number of frames dropped by destination address check, for example received frame for other node.
uint32_t mRxDuplicated
The total number of frames dropped due to duplication, that is when the frame has been already received.
uint32_t mRxErrNoFrame
The total number of frames dropped because of missing or malformed content.
uint32_t mRxErrUnknownNeighbor
The total number of frames dropped due to unknown neighbor.
uint32_t mRxErrInvalidSrcAddr
The total number of frames dropped due to invalid source address.
uint32_t mRxErrSec
The total number of frames dropped due to security error.
uint32_t mRxErrFcs
The total number of frames dropped due to invalid FCS.
uint32_t mRxErrOther
The total number of frames dropped due to other error.

This structure represents the MAC layer counters.

Member Data Documentation

mRxDuplicated

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.

mRxErrSec

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.

mRxTotal

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.

mTxErrCca

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).

mTxOther

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.

mTxRetry

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 .

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:

  • mTxUnicast
  • mTxBroadcast
  • mTxAckRequested
  • mTxNoAckRequested
  • mTxData
  • mTxDataPoll
  • mTxBeacon
  • mTxBeaconRequest
  • mTxOther
  • mTxErrAbort
  • mTxErrBusyChannel

The following equations are valid:

  • mTxTotal = mTxUnicast + mTxBroadcast
  • mTxTotal = mTxAckRequested + mTxNoAckRequested
  • mTxTotal = mTxData + mTxDataPoll + mTxBeacon + mTxBeaconRequest + mTxOther

The documentation for this struct was generated from the following file:
  • include/openthread/ link.h