NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | ATTRIBUTES | SEE ALSO
#include <ddi/uart/uartStat.h>
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
DDI
UartStat is a structure definition used by the MNGT DDI to enable a client of an UART driver which exports the management DDI, to retrieve on demand raw I/O statistics since the driver last started.
When using the mngt DDI, the client must check first the class of the driver it is connected to, and then allocate enough memory space to hold the appropriate class-specific stat structure.
The UartStat structure is defined as follow :
typedef struct UartStatRx { /* * Mandatory statistics */ uint32_f bytes; /* bytes received */ uint32_f breaks; /* breaks received */ uint32_f errors; /* receive errors */ /* * Optional statistics. * If not implemented, counter values are always zero. */ uint32_f parityErr; /* parity errors */ uint32_f framingErr; /* Framing errors */ uint32_f FifoOvErr; /* FIFO overrun errors */ uint32_f dropped; /* Out of receive buffer */ } UartStatRx; typedef struct UartStatTx { uint32_f bytes; /* bytes sent */ uint32_f breaks; /* breaks sent */ } UartStatTx; typedef struct UartStat { UartStatRx rx; /* receive statistics */ UartStatTx tx; /* transmit statistics */ } UartStat;
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | ATTRIBUTES | SEE ALSO