rusefi-1/firmware/console/binary/tunerstudio_io.h

80 lines
2.0 KiB
C++

/**
* @file tunerstudio_io.h
* @file TS protocol commands and methods are here
*
* @date Mar 8, 2015
* @author Andrey Belomutskiy, (c) 2012-2020
*/
#pragma once
#include "global.h"
#if EFI_USB_SERIAL
#include "usbconsole.h"
#endif // EFI_USB_SERIAL
#if EFI_PROD_CODE
#include "pin_repository.h"
#endif
typedef enum {
TS_PLAIN = 0,
TS_CRC = 1
} ts_response_format_e;
class TsChannelBase {
public:
// Virtual functions - implement these for your underlying transport
virtual void write(const uint8_t* buffer, size_t size) = 0;
virtual size_t readTimeout(uint8_t* buffer, size_t size, int timeout) = 0;
virtual void flush() = 0;
virtual bool isReady() = 0;
// Base functions that use the above virtual implementation
size_t read(uint8_t* buffer, size_t size);
void writeCrcPacket(uint8_t responseCode, const uint8_t* buf, size_t size);
void sendResponse(ts_response_format_e mode, const uint8_t * buffer, int size);
/**
* See 'blockingFactor' in rusefi.ini
*/
char scratchBuffer[BLOCKING_FACTOR + 30];
bool wasReady = false;
private:
void writeCrcPacketSmall(uint8_t responseCode, const uint8_t* buf, size_t size);
void writeCrcPacketLarge(uint8_t responseCode, const uint8_t* buf, size_t size);
};
struct ts_channel_s : public TsChannelBase {
void write(const uint8_t* buffer, size_t size) override;
size_t readTimeout(uint8_t* buffer, size_t size, int timeout) override;
void flush() override;
bool isReady() override;
#if !EFI_UNIT_TEST
BaseChannel * channel = nullptr;
#endif
#if TS_UART_DMA_MODE || PRIMARY_UART_DMA_MODE || TS_UART_MODE
UARTDriver *uartp = nullptr;
#endif // TS_UART_DMA_MODE
};
#define CRC_VALUE_SIZE 4
// todo: double-check this
#define CRC_WRAPPING_SIZE (CRC_VALUE_SIZE + 3)
void startTsPort(ts_channel_s *tsChannel);
bool stopTsPort(ts_channel_s *tsChannel);
// that's 1 second
#define BINARY_IO_TIMEOUT TIME_MS2I(1000)
// that's 1 second
#define SR5_READ_TIMEOUT TIME_MS2I(1000)
void sendOkResponse(TsChannelBase *tsChannel, ts_response_format_e mode);