openthread-br  0.3.0-72c0388
Public Attributes | List of all members
otbr::DBus::MacCounters Struct Reference

#include <src/dbus/common/types.hpp>

Public Attributes

uint32_t mTxTotal
 
uint32_t mTxUnicast
 
uint32_t mTxBroadcast
 
uint32_t mTxAckRequested
 
uint32_t mTxAcked
 
uint32_t mTxNoAckRequested
 
uint32_t mTxData
 
uint32_t mTxDataPoll
 
uint32_t mTxBeacon
 
uint32_t mTxBeaconRequest
 
uint32_t mTxOther
 
uint32_t mTxRetry
 
uint32_t mTxDirectMaxRetryExpiry
 
uint32_t mTxIndirectMaxRetryExpiry
 
uint32_t mTxErrCca
 
uint32_t mTxErrAbort
 
uint32_t mTxErrBusyChannel
 
uint32_t mRxTotal
 
uint32_t mRxUnicast
 
uint32_t mRxBroadcast
 
uint32_t mRxData
 
uint32_t mRxDataPoll
 
uint32_t mRxBeacon
 
uint32_t mRxBeaconRequest
 
uint32_t mRxOther
 
uint32_t mRxAddressFiltered
 
uint32_t mRxDestAddrFiltered
 
uint32_t mRxDuplicated
 
uint32_t mRxErrNoFrame
 
uint32_t mRxErrUnknownNeighbor
 
uint32_t mRxErrInvalidSrcAddr
 
uint32_t mRxErrSec
 
uint32_t mRxErrFcs
 
uint32_t mRxErrOther
 

Detailed Description

This structure represents the MAC layer counters.

Member Data Documentation

◆ mRxAddressFiltered

uint32_t otbr::DBus::MacCounters::mRxAddressFiltered

The total number of frames dropped by MAC Filter module, for example received from denylisted node.

◆ mRxBeacon

uint32_t otbr::DBus::MacCounters::mRxBeacon

The total number of MAC Beacon frames received.

◆ mRxBeaconRequest

uint32_t otbr::DBus::MacCounters::mRxBeaconRequest

The total number of MAC Beacon Request frames received.

◆ mRxBroadcast

uint32_t otbr::DBus::MacCounters::mRxBroadcast

The total number of broadcast frames received.

◆ mRxData

uint32_t otbr::DBus::MacCounters::mRxData

The total number of MAC Data frames received.

◆ mRxDataPoll

uint32_t otbr::DBus::MacCounters::mRxDataPoll

The total number of MAC Data Poll frames received.

◆ mRxDestAddrFiltered

uint32_t otbr::DBus::MacCounters::mRxDestAddrFiltered

The total number of frames dropped by destination address check, for example received frame for other node.

◆ mRxDuplicated

uint32_t otbr::DBus::MacCounters::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.

◆ mRxErrFcs

uint32_t otbr::DBus::MacCounters::mRxErrFcs

The total number of frames dropped due to invalid FCS.

◆ mRxErrInvalidSrcAddr

uint32_t otbr::DBus::MacCounters::mRxErrInvalidSrcAddr

The total number of frames dropped due to invalid source address.

◆ mRxErrNoFrame

uint32_t otbr::DBus::MacCounters::mRxErrNoFrame

The total number of frames dropped because of missing or malformed content.

◆ mRxErrOther

uint32_t otbr::DBus::MacCounters::mRxErrOther

The total number of frames dropped due to other error.

◆ mRxErrSec

uint32_t otbr::DBus::MacCounters::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.

◆ mRxErrUnknownNeighbor

uint32_t otbr::DBus::MacCounters::mRxErrUnknownNeighbor

The total number of frames dropped due to unknown neighbor.

◆ mRxOther

uint32_t otbr::DBus::MacCounters::mRxOther

The total number of other types of frames received.

◆ mRxTotal

uint32_t otbr::DBus::MacCounters::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.

◆ mRxUnicast

uint32_t otbr::DBus::MacCounters::mRxUnicast

The total number of unicast frames received.

◆ mTxAcked

uint32_t otbr::DBus::MacCounters::mTxAcked

The total number of unique MAC frame transmission requests that were acked.

◆ mTxAckRequested

uint32_t otbr::DBus::MacCounters::mTxAckRequested

The total number of unique MAC frame transmission requests with requested acknowledgment.

◆ mTxBeacon

uint32_t otbr::DBus::MacCounters::mTxBeacon

The total number of unique MAC Beacon frame transmission requests.

◆ mTxBeaconRequest

uint32_t otbr::DBus::MacCounters::mTxBeaconRequest

The total number of unique MAC Beacon Request frame transmission requests.

◆ mTxBroadcast

uint32_t otbr::DBus::MacCounters::mTxBroadcast

The total number of unique broadcast MAC frame transmission requests.

◆ mTxData

uint32_t otbr::DBus::MacCounters::mTxData

The total number of unique MAC Data frame transmission requests.

◆ mTxDataPoll

uint32_t otbr::DBus::MacCounters::mTxDataPoll

The total number of unique MAC Data Poll frame transmission requests.

◆ mTxDirectMaxRetryExpiry

uint32_t otbr::DBus::MacCounters::mTxDirectMaxRetryExpiry

The total number of unique MAC transmission packets that meet maximal retry limit for direct packets.

◆ mTxErrAbort

uint32_t otbr::DBus::MacCounters::mTxErrAbort

The total number of unique MAC transmission request failures cause by an abort error.

◆ mTxErrBusyChannel

uint32_t otbr::DBus::MacCounters::mTxErrBusyChannel

The total number of unique MAC transmission requests failures caused by a busy channel (a CSMA/CA fail).

◆ mTxErrCca

uint32_t otbr::DBus::MacCounters::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

See also
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

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

◆ mTxIndirectMaxRetryExpiry

uint32_t otbr::DBus::MacCounters::mTxIndirectMaxRetryExpiry

The total number of unique MAC transmission packets that meet maximal retry limit for indirect packets.

◆ mTxNoAckRequested

uint32_t otbr::DBus::MacCounters::mTxNoAckRequested

The total number of unique MAC frame transmission requests without requested acknowledgment.

◆ mTxOther

uint32_t otbr::DBus::MacCounters::mTxOther

The total number of unique other MAC frame transmission requests.

This counter is currently unused.

◆ mTxRetry

uint32_t otbr::DBus::MacCounters::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.

Check the following configuration parameters to control the amount of retransmissions in the system:

See also
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

See also
OT_RADIO_CAPS_TRANSMIT_RETRIES.

◆ mTxTotal

uint32_t otbr::DBus::MacCounters::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 incrementation 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

◆ mTxUnicast

uint32_t otbr::DBus::MacCounters::mTxUnicast

The total number of unique unicast MAC frame transmission requests.


The documentation for this struct was generated from the following file: