TCommConfigV01 Class Reference

class TCommConfigV01

Comms configuration structure. Class to hold the configuration settings for serial comm port

This class provides the serial port configuration block interface of serial comms (c32). A serial comm client sets up a serial port before use, by providing a configuration block. TCommConfigV01 is initialized with settings for serial port and used to configure the serial port by calling DComm::Configure(TCommConfigV01 &aConfig) or any other serial comm API to configure the serial port.

Member Data Documentation

TDataBits iDataBits

TDataBits iDataBits

Character width in bits. TDataBits

TUint iFifo

TUint iFifo

FIFO status, enabled or disabled. TFifo

TUint iHandshake

TUint iHandshake

Type of Handshaking control. Possible values can be KConfigObeyXXX or KConfigSendXXX or KConfigFailXXX or KConfigFreeXXX

TParity iParity

TParity iParity

Type of parity. TParity

TUint iParityError

TUint iParityError

Type of error to generate on a parity failure. Possible values can be KConfigParityErrorFail or KConfigParityErrorIgnore or KConfigParityErrorReplaceChar

TText8 iParityErrorChar

TText8 iParityErrorChar

Character used to replace the characters received with a parity error. This is used when iParityError is set to KConfigParityErrorReplaceChar

TBps iRate

TBps iRate

Data rate in bits per second. TBps

TSir iSIREnable

TSir iSIREnable

Switch the SIR encoding hardware on and off. TSir

TUint iSIRSettings

TUint iSIRSettings

SIR hardware control setting. Possible value can be one of KConfigSIRXXX

TInt iSpecialRate

TInt iSpecialRate

Special data rate, not listed under TBps. Use this, when iRate is set to EBpsSpecial

TStopBits iStopBits

TStopBits iStopBits

Number of stop bits. TStopBits

TText8 iTerminator

TText8 iTerminator

Array of special characters which can be used as terminators

TInt iTerminatorCount

TInt iTerminatorCount

Count of number of special characters used as terminators (<=KConfigMaxTerminators)

TText8 iXoffChar

TText8 iXoffChar

Character used to signal the transmitter to suspend sending when using XON/XOFF handshaking i.e character used as XOFF - software flow control

TText8 iXonChar

TText8 iXonChar

Character used to signal the transmitter to resume sending when using XON/XOFF handshaking i.e character used as XON - software flow control