TsChannelBase Class Reference

#include <tunerstudio_io.h>

Inheritance diagram for TsChannelBase:

Collaboration diagram for TsChannelBase:

Public Member Functions
	TsChannelBase (const char *name)
virtual void	write (const uint8_t *buffer, size_t size, bool isEndOfPacket=false)=0
virtual size_t	readTimeout (uint8_t *buffer, size_t size, int timeout)=0
virtual void	flush ()
virtual bool	isConfigured () const
virtual bool	isReady () const
virtual void	stop ()
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)

Data Fields
int	bytesIn = 0
int	bytesOut = 0
char	scratchBuffer [scratchBuffer_SIZE+30]
page1_s	page1
const char *	name
bool	in_sync = false

Private Member Functions
bool	isBigPacket (size_t size)
void	writeCrcPacketLarge (uint8_t responseCode, const uint8_t *buf, size_t size)

Detailed Description

Definition at line 30 of file tunerstudio_io.h.

Constructor & Destructor Documentation

TsChannelBase()

TsChannelBase::TsChannelBase

(

const char *

name

)

Definition at line 91 of file tunerstudio_io.cpp.

                                               {
    this->name = p_name;
}

Member Function Documentation

assertPacketSize()

void TsChannelBase::assertPacketSize	(	size_t	size,
		bool	allowLongPackets
	)

Definition at line 95 of file tunerstudio_io.cpp.

                                                                       {
    if (isBigPacket(size) && !allowLongPackets) {
        criticalError("[USE PROPER CONSOLE VERSION ] disallowed long packet of size %d", size);
    }
}

Referenced by TunerStudio::cmdOutputChannels(), and writeCrcPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

copyAndWriteSmallCrcPacket()

void TsChannelBase::copyAndWriteSmallCrcPacket	(	uint8_t	responseCode,
		const uint8_t *	buf,
		size_t	size
	)

Definition at line 26 of file tunerstudio_io.cpp.

                                                                                                    {
    // don't transmit too large a buffer
    criticalAssertVoid(!isBigPacket(size), "copyAndWriteSmallCrcPacket tried to transmit too large a packet")
 
    // If transmitting data, copy it in to place in the scratch buffer
    // We want to prevent the data changing itself (higher priority threads could write
    // tsOutputChannels) during the CRC computation.  Instead compute the CRC on our
    // local buffer that nobody else will write.
    if (size) {
        memcpy(scratchBuffer + TS_PACKET_HEADER_SIZE, buf, size);
    }
 
    crcAndWriteBuffer(responseCode, size);
}

Referenced by writeCrcPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

crcAndWriteBuffer()

void TsChannelBase::crcAndWriteBuffer	(	const uint8_t	responseCode,
		const size_t	size
	)

Definition at line 41 of file tunerstudio_io.cpp.

                                                                       {
    criticalAssertVoid(!isBigPacket(size), "crcAndWriteBuffer tried to transmit too large a packet")
 
    // Index 0/1 = packet size (big endian)
    *(uint16_t*)scratchBuffer = SWAP_UINT16(size + 1);
    // Index 2 = response code
    scratchBuffer[2] = responseCode;
 
    // CRC is computed on the responseCode and payload but not length
    uint32_t crc = crc32(&scratchBuffer[2], size + 1); // command part of CRC
 
    // Place the CRC at the end
    crc = SWAP_UINT32(crc);
    memcpy(scratchBuffer + size + TS_PACKET_HEADER_SIZE, &crc, sizeof(crc));
 
    // Write to the underlying stream
    write(reinterpret_cast<uint8_t*>(scratchBuffer), size + 7, true);
    flush();
}

Referenced by TunerStudio::cmdOutputChannels(), and copyAndWriteSmallCrcPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

flush()

virtual void TsChannelBase::flush ( )

inlinevirtual

Definition at line 38 of file tunerstudio_io.h.

{ }

Referenced by crcAndWriteBuffer(), TunerStudio::handlePlainCommand(), TunerStudio::handleScatteredReadCommand(), handleTestCommand(), sendResponse(), and writeCrcPacketLarge().

Here is the caller graph for this function:

isBigPacket()

bool TsChannelBase::isBigPacket ( size_t  size )

private

Definition at line 22 of file tunerstudio_io.cpp.

                                           {
    return ((TS_PACKET_HEADER_SIZE + size + TS_PACKET_TAIL_SIZE) > sizeof(scratchBuffer));
}

Referenced by assertPacketSize(), copyAndWriteSmallCrcPacket(), crcAndWriteBuffer(), and writeCrcPacket().

Here is the caller graph for this function:

isConfigured()

virtual bool TsChannelBase::isConfigured ( ) const

inlinevirtual

Definition at line 39 of file tunerstudio_io.h.

{ return true; }

isReady()

virtual bool TsChannelBase::isReady ( ) const

inlinevirtual

Definition at line 40 of file tunerstudio_io.h.

{ return true; }

Referenced by tsProcessOne().

Here is the caller graph for this function:

read()

size_t TsChannelBase::read	(	uint8_t *	buffer,
		size_t	size
	)

Definition at line 17 of file tunerstudio_io.cpp.

                                                       {
    return readTimeout(buffer, size, SR5_READ_TIMEOUT);
}

Here is the call graph for this function:

readTimeout()

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

pure virtual

Implemented in SerialTsChannel, UartTsChannel, and UartDmaTsChannel.

Referenced by bluetoothSoftwareDisconnectNotify(), btReadLine(), read(), and tsProcessOne().

Here is the caller graph for this function:

sendResponse()

void TsChannelBase::sendResponse	(	ts_response_format_e	mode,
		const uint8_t *	buffer,
		int	size,
		bool	allowLongPackets = false
	)

Definition at line 121 of file tunerstudio_io.cpp.

                                                                                                                     {
    if (mode == TS_CRC) {
        writeCrcPacket(TS_RESPONSE_OK, buffer, size, allowLongPackets);
    } else {
        if (size > 0) {
            write(buffer, size, true);
            flush();
        }
    }
}

Referenced by TunerStudio::handleCrc32Check(), TunerStudio::handleCrcCommand(), handleGetConfigErorr(), handleGetVersion(), TunerStudio::handlePageReadCommand(), TunerStudio::handleQueryCommand(), and sendOkResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

stop()

virtual void TsChannelBase::stop ( )

inlinevirtual

Reimplemented in SerialTsChannel, and UartTsChannel.

Definition at line 41 of file tunerstudio_io.h.

{ }

Referenced by findBaudIndex(), and runCommands().

Here is the caller graph for this function:

write()

virtual void TsChannelBase::write ( const uint8_t *  buffer, size_t  size, bool  isEndOfPacket = false  )

pure virtual

Implemented in SerialTsChannel, and UartTsChannel.

Referenced by btWrite(), crcAndWriteBuffer(), TunerStudio::handlePlainCommand(), TunerStudio::handleScatteredReadCommand(), handleTestCommand(), sendResponse(), writeCrcPacketLarge(), and writePacketHeader().

Here is the caller graph for this function:

writeCrcPacket()

void TsChannelBase::writeCrcPacket ( uint8_t  responseCode, const uint8_t *  buf, size_t  size, bool  allowLongPackets = false  )

virtual

Adds size to the beginning of a packet and a crc32 at the end. Then send the packet.

Definition at line 104 of file tunerstudio_io.cpp.

                                                                                                               {
    // don't transmit a null buffer...
    if (!buf) {
        size = 0;
    }
 
    assertPacketSize(size, allowLongPackets);
 
    if (isBigPacket(size)) {
        // for larger packets we do not use a buffer for CRC calculation meaning data is now allowed to modify while pending
        writeCrcPacketLarge(responseCode, buf, size);
    } else {
        // for small packets we use a buffer for CRC calculation
        copyAndWriteSmallCrcPacket(responseCode, buf, size);
    }
}

Referenced by handleGetText(), and sendResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

writeCrcPacketLarge()

void TsChannelBase::writeCrcPacketLarge ( uint8_t  responseCode, const uint8_t *  buf, size_t  size  )

private

Definition at line 72 of file tunerstudio_io.cpp.

                                                                                                         {
    uint8_t crcBuffer[4];
 
    // Command part of CRC
    uint32_t crc = writePacketHeader(responseCode, size);
    // Data part of CRC
    crc = crc32inc((void*)buf, crc, size);
    *(uint32_t*)crcBuffer = SWAP_UINT32(crc);
 
    // If data, write that
    if (size) {
        write(buf, size, /*isEndOfPacket*/false);
    }
 
    // Lastly the CRC footer
    write(crcBuffer, sizeof(crcBuffer), /*isEndOfPacket*/true);
    flush();
}

Referenced by writeCrcPacket(), and writeCrcResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

writeCrcResponse()

void TsChannelBase::writeCrcResponse ( uint8_t  responseCode )

inline

Definition at line 76 of file tunerstudio_io.h.

                                                {
        writeCrcPacketLarge(responseCode, nullptr, 0);
    }

Referenced by handleBurnCommand(), TunerStudio::handleExecuteCommand(), and sendErrorCode().

Here is the call graph for this function:

Here is the caller graph for this function:

writePacketHeader()

uint32_t TsChannelBase::writePacketHeader	(	const uint8_t	responseCode,
		const size_t	size
	)

Definition at line 61 of file tunerstudio_io.cpp.

                                                                                       {
    uint8_t headerBuffer[3];
    *(uint16_t*)headerBuffer = SWAP_UINT16(size + 1);
    *(uint8_t*)(headerBuffer + 2) = responseCode;
    // Write header
    write(headerBuffer, sizeof(headerBuffer), /*isEndOfPacket*/false);
 
     // Command part of CRC
    return crc32((void*)(headerBuffer + 2), 1);
}

Referenced by TunerStudio::handleScatteredReadCommand(), and writeCrcPacketLarge().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

bytesIn

int TsChannelBase::bytesIn = 0

Definition at line 46 of file tunerstudio_io.h.

Referenced by SerialTsChannel::readTimeout(), UartTsChannel::readTimeout(), and UartDmaTsChannel::readTimeout().

bytesOut

int TsChannelBase::bytesOut = 0

Definition at line 47 of file tunerstudio_io.h.

Referenced by SerialTsChannel::write(), and UartTsChannel::write().

in_sync

bool TsChannelBase::in_sync = false

Definition at line 90 of file tunerstudio_io.h.

Referenced by tsProcessOne().

name

const char* TsChannelBase::name

Definition at line 68 of file tunerstudio_io.h.

Referenced by TsChannelBase(), tsProcessOne(), and tunerStudioDebug().

page1

page1_s TsChannelBase::page1

Definition at line 66 of file tunerstudio_io.h.

Referenced by getWorkingPageAddr(), and TunerStudio::handleScatteredReadCommand().

scratchBuffer

char TsChannelBase::scratchBuffer[scratchBuffer_SIZE+30]

See 'blockingFactor' in rusefi.ini

Definition at line 64 of file tunerstudio_io.h.

Referenced by TunerStudio::cmdOutputChannels(), copyAndWriteSmallCrcPacket(), crcAndWriteBuffer(), TunerStudio::handlePageReadCommand(), isBigPacket(), and tsProcessOne().

---

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

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