UartTsChannel Class Reference

#include <tunerstudio_io.h>

Inheritance diagram for UartTsChannel:

Collaboration diagram for UartTsChannel:

Public Member Functions
	UartTsChannel (UARTDriver &driver)
void	start (uint32_t baud) override
void	stop () override
void	write (const uint8_t *buffer, size_t size, bool isEndOfPacket) override
size_t	readTimeout (uint8_t *buffer, size_t size, int timeout) override
Public Member Functions inherited from SerialTsChannelBase
	SerialTsChannelBase (const char *p_name)
Public Member Functions inherited from TsChannelBase
	TsChannelBase (const char *name)
virtual void	flush ()
virtual bool	isConfigured () const
virtual bool	isReady () const
size_t	read (uint8_t *buffer, size_t size)
virtual void	writeCrcPacket (uint8_t responseCode, const uint8_t *buf, size_t size, bool allowLongPackets=false)
void	sendResponse (ts_response_format_e mode, const uint8_t *buffer, int size, bool allowLongPackets=false)
void	assertPacketSize (size_t size, bool allowLongPackets)
uint32_t	writePacketHeader (const uint8_t responseCode, const size_t size)
void	crcAndWriteBuffer (const uint8_t responseCode, const size_t size)
void	copyAndWriteSmallCrcPacket (uint8_t responseCode, const uint8_t *buf, size_t size)
void	writeCrcResponse (uint8_t responseCode)

Protected Attributes
UARTDriver *const	m_driver
UARTConfig	m_config

Additional Inherited Members
Data Fields inherited from TsChannelBase
int	bytesIn = 0
int	bytesOut = 0
char	scratchBuffer [scratchBuffer_SIZE+30]
page1_s	page1
const char *	name
bool	in_sync = false

Detailed Description

Definition at line 124 of file tunerstudio_io.h.

Constructor & Destructor Documentation

UartTsChannel()

UartTsChannel::UartTsChannel ( UARTDriver &  driver )

inline

Definition at line 126 of file tunerstudio_io.h.

: SerialTsChannelBase("UART"), m_driver(&driver) { }

Member Function Documentation

readTimeout()

size_t UartTsChannel::readTimeout ( uint8_t *  buffer, size_t  size, int  timeout  )

overridevirtual

Implements TsChannelBase.

Definition at line 73 of file tunerstudio_io_serial.cpp.

                                                                           {
    // nasty in/out parameter approach:
    // in entry: number of data frames to receive
    // on exit the number of frames actually received
    uartReceiveTimeout(m_driver, &size, buffer, timeout);
    bytesIn += size;
    return size;
}

start()

void UartTsChannel::start ( uint32_t  baud )

overridevirtual

Implements SerialTsChannelBase.

Definition at line 41 of file tunerstudio_io_serial.cpp.

                                       {
    m_config = { 
        .txend1_cb      = NULL,
        .txend2_cb      = NULL,
        .rxend_cb       = NULL,
        .rxchar_cb      = NULL,
        .rxerr_cb       = NULL,
        .timeout_cb     = NULL,
#if defined(STM32F7XX)
        .timeout        = 0,
#endif
        .speed          = baud,
        .cr1            = 0,
        .cr2            = USART_CR2_STOP1_BITS | USART_CR2_LINEN,
        .cr3            = 0,
#if defined(STM32F4XX) || defined(CPU_MKE16F512VLH16)
        .rxhalf_cb      = NULL
#endif
    };
 
    uartStart(m_driver, &m_config);
}

stop()

void UartTsChannel::stop ( )

overridevirtual

Reimplemented from TsChannelBase.

Definition at line 64 of file tunerstudio_io_serial.cpp.

                         {
    uartStop(m_driver);
}

write()

void UartTsChannel::write ( const uint8_t *  buffer, size_t  size, bool  isEndOfPacket  )

overridevirtual

Implements TsChannelBase.

Definition at line 68 of file tunerstudio_io_serial.cpp.

                                                                  {
    size_t transferred = uartSendTimeout(m_driver, &size, buffer, BINARY_IO_TIMEOUT);
    bytesOut += transferred;
}

Field Documentation

m_config

UARTConfig UartTsChannel::m_config

protected

Definition at line 136 of file tunerstudio_io.h.

Referenced by start(), and UartDmaTsChannel::start().

m_driver

UARTDriver* const UartTsChannel::m_driver

protected

Definition at line 135 of file tunerstudio_io.h.

Referenced by UartDmaTsChannel::copyDataFromDMA(), readTimeout(), start(), UartDmaTsChannel::start(), stop(), and write().

---

The documentation for this class was generated from the following files:

• console/binary/tunerstudio_io.h
• console/binary/tunerstudio_io_serial.cpp