Crash_Override
/
ESP32_ChinaDieselHeater_Control
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added extra CRC checking to OTA

This commit is contained in:
Ray Jones 2019-07-09 22:19:21 +10:00
parent 278d40af33
commit 8dd5dc662e
11 changed files with 218 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
AfterburnerCRC.exe Normal file
View File

Binary file not shown.

12
add_CRC.py Normal file
View File

@ -0,0 +1,12 @@
Import("env")
# access to global build environment
print env
# Add CRC from BIN
env.AddPostAction(
"$BUILD_DIR/${PROGNAME}.bin",
env.VerboseAction(" ".join([
"AfterburnerCRC.exe", "$BUILD_DIR/${PROGNAME}.bin"
]), "Creating CRC from $BUILD_DIR/${PROGNAME}.bin, adding to $BUILD_DIR/${PROGNAME}.bin.crc")
)

2
platformio.ini
View File

@ -20,3 +20,5 @@ upload_protocol = espota
upload_flags =
--port=3232
monitor_speed = 115200
extra_scripts = post:add_CRC.py

8
src/Afterburner/src/Libraries/esp32FOTA/src/esp32fota.cpp
View File

@ -12,6 +12,7 @@
#include <HTTPClient.h>
#include <Update.h>
#include "../../ArduinoJson/ArduinoJson.h"
#include "../../../WiFi/BTCota.h"
extern void forceBootInit();
@ -143,6 +144,10 @@ void esp32FOTA::execOTA()
// execOTA();
}
if(!CheckFirmwareCRC(contentLength)) {
Update.abort();
}
if (Update.end())
{
Serial.println("OTA done!");
@ -272,4 +277,5 @@ String esp32FOTA::getDeviceID()
sprintf(deviceid, "%" PRIu64, chipid);
String thisID(deviceid);
return thisID;
}
}

25
src/Afterburner/src/Protocol/Protocol.cpp
View File

@ -27,28 +27,11 @@
#include "../Utility/macros.h"
uint16_t
CProtocol::CalcCRC(int len) const
{
// calculate a CRC-16/MODBUS checksum using the first 22 bytes of the data array
uint16_t wCRCWord = 0xFFFF;
int wLength = len;
const uint8_t* pData = Data;
while (wLength--)
{
uint8_t nTemp = *pData++ ^ wCRCWord;
wCRCWord >>= 8;
wCRCWord ^= wCRCTable[nTemp];
}
return wCRCWord;
}
void
CProtocol::setCRC()
{
setCRC(CalcCRC(22));
CModBusCRC16 CRCengine;
setCRC(CRCengine.process(22, Data));
}
void
@ -73,7 +56,9 @@ CProtocol::getCRC() const
bool
CProtocol::verifyCRC(bool bSilent) const
{
uint16_t CRC = CalcCRC(22); // calculate CRC based on first 22 bytes
CModBusCRC16 CRCengine;
uint16_t CRC = CRCengine.process(22, Data); // calculate CRC based on first 22 bytes of our data buffer
uint16_t FrameCRC = getCRC();
bool bOK = (FrameCRC == CRC);
if(!bOK && !bSilent) {

39
src/Afterburner/src/Protocol/Protocol.h
View File

@ -23,8 +23,10 @@
#define _CPROTOCOL_H_
#include "../Utility/UtilClasses.h"
#include "../Utility/MODBUS-CRC16.h"
class CProtocol {
// CModBusCRC16 _CRCengine;
public:
union {
uint8_t Data[24];
@ -83,40 +85,6 @@ public:
};
static const int CtrlMode = 1;
static const int HeatMode = 2;
const uint16_t wCRCTable[256] = {
0X0000, 0XC0C1, 0XC181, 0X0140, 0XC301, 0X03C0, 0X0280, 0XC241,
0XC601, 0X06C0, 0X0780, 0XC741, 0X0500, 0XC5C1, 0XC481, 0X0440,
0XCC01, 0X0CC0, 0X0D80, 0XCD41, 0X0F00, 0XCFC1, 0XCE81, 0X0E40,
0X0A00, 0XCAC1, 0XCB81, 0X0B40, 0XC901, 0X09C0, 0X0880, 0XC841,
0XD801, 0X18C0, 0X1980, 0XD941, 0X1B00, 0XDBC1, 0XDA81, 0X1A40,
0X1E00, 0XDEC1, 0XDF81, 0X1F40, 0XDD01, 0X1DC0, 0X1C80, 0XDC41,
0X1400, 0XD4C1, 0XD581, 0X1540, 0XD701, 0X17C0, 0X1680, 0XD641,
0XD201, 0X12C0, 0X1380, 0XD341, 0X1100, 0XD1C1, 0XD081, 0X1040,
0XF001, 0X30C0, 0X3180, 0XF141, 0X3300, 0XF3C1, 0XF281, 0X3240,
0X3600, 0XF6C1, 0XF781, 0X3740, 0XF501, 0X35C0, 0X3480, 0XF441,
0X3C00, 0XFCC1, 0XFD81, 0X3D40, 0XFF01, 0X3FC0, 0X3E80, 0XFE41,
0XFA01, 0X3AC0, 0X3B80, 0XFB41, 0X3900, 0XF9C1, 0XF881, 0X3840,
0X2800, 0XE8C1, 0XE981, 0X2940, 0XEB01, 0X2BC0, 0X2A80, 0XEA41,
0XEE01, 0X2EC0, 0X2F80, 0XEF41, 0X2D00, 0XEDC1, 0XEC81, 0X2C40,
0XE401, 0X24C0, 0X2580, 0XE541, 0X2700, 0XE7C1, 0XE681, 0X2640,
0X2200, 0XE2C1, 0XE381, 0X2340, 0XE101, 0X21C0, 0X2080, 0XE041,
0XA001, 0X60C0, 0X6180, 0XA141, 0X6300, 0XA3C1, 0XA281, 0X6240,
0X6600, 0XA6C1, 0XA781, 0X6740, 0XA501, 0X65C0, 0X6480, 0XA441,
0X6C00, 0XACC1, 0XAD81, 0X6D40, 0XAF01, 0X6FC0, 0X6E80, 0XAE41,
0XAA01, 0X6AC0, 0X6B80, 0XAB41, 0X6900, 0XA9C1, 0XA881, 0X6840,
0X7800, 0XB8C1, 0XB981, 0X7940, 0XBB01, 0X7BC0, 0X7A80, 0XBA41,
0XBE01, 0X7EC0, 0X7F80, 0XBF41, 0X7D00, 0XBDC1, 0XBC81, 0X7C40,
0XB401, 0X74C0, 0X7580, 0XB541, 0X7700, 0XB7C1, 0XB681, 0X7640,
0X7200, 0XB2C1, 0XB381, 0X7340, 0XB101, 0X71C0, 0X7080, 0XB041,
0X5000, 0X90C1, 0X9181, 0X5140, 0X9301, 0X53C0, 0X5280, 0X9241,
0X9601, 0X56C0, 0X5780, 0X9741, 0X5500, 0X95C1, 0X9481, 0X5440,
0X9C01, 0X5CC0, 0X5D80, 0X9D41, 0X5F00, 0X9FC1, 0X9E81, 0X5E40,
0X5A00, 0X9AC1, 0X9B81, 0X5B40, 0X9901, 0X59C0, 0X5880, 0X9841,
0X8801, 0X48C0, 0X4980, 0X8941, 0X4B00, 0X8BC1, 0X8A81, 0X4A40,
0X4E00, 0X8EC1, 0X8F81, 0X4F40, 0X8D01, 0X4DC0, 0X4C80, 0X8C41,
0X4400, 0X84C1, 0X8581, 0X4540, 0X8701, 0X47C0, 0X4680, 0X8641,
0X8201, 0X42C0, 0X4380, 0X8341, 0X4100, 0X81C1, 0X8081, 0X4040
};
public:
CProtocol() { Init(0); };
@ -124,11 +92,10 @@ public:
void Init(int Txmode);
// CRC handlers
uint16_t CalcCRC(int len) const; // calculate the CRC upon len bytes
void setCRC(); // calculate and set the CRC in the buffer
void setCRC(uint16_t CRC); // set the CRC in the buffer
uint16_t getCRC() const; // extract CRC value from buffer
bool verifyCRC(bool silent=false) const; // return true for CRC match
bool verifyCRC(bool silent=false) const; // return true for CRC match
void setActiveMode() { Controller.Byte0 = 0x76; }; // this allows heater to save tuning params to EEPROM
void setPassiveMode() { Controller.Byte0 = 0x78; }; // this prevents heater saving tuning params to EEPROM

55
src/Afterburner/src/Utility/MODBUS-CRC16.cpp Normal file
View File

@ -0,0 +1,55 @@
/*
* This file is part of the "bluetoothheater" distribution
* (https://gitlab.com/mrjones.id.au/bluetoothheater)
*
* Copyright (C) 2018 Ray Jones <ray@mrjones.id.au>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
#include "MODBUS-CRC16.h"
CModBusCRC16::CModBusCRC16()
{
_CRC = 0xffff;
}
void
CModBusCRC16::reset()
{
_CRC = 0xffff;
}
uint16_t
CModBusCRC16::process(int len, const uint8_t* pData)
{
// calculate a CRC-16/MODBUS checksum using the bytes of the data array
// carries on from prior developed CRC value, or 0xffff if first pass
while (len--)
{
uint8_t nTemp = *pData++ ^ _CRC;
_CRC >>= 8;
_CRC ^= _CRCTable[nTemp];
}
return _CRC;
}
uint16_t
CModBusCRC16::get() const
{
return _CRC;
}

71
src/Afterburner/src/Utility/MODBUS-CRC16.h Normal file
View File

@ -0,0 +1,71 @@
/*
* This file is part of the "bluetoothheater" distribution
* (https://gitlab.com/mrjones.id.au/bluetoothheater)
*
* Copyright (C) 2018 Ray Jones <ray@mrjones.id.au>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
#ifndef __BTC_MODBUSCRC_H__
#define __BTC_MODBUSCRC_H__
#include <stdint.h>
class CModBusCRC16 {
uint16_t _CRC;
const uint16_t _CRCTable[256] = {
0X0000, 0XC0C1, 0XC181, 0X0140, 0XC301, 0X03C0, 0X0280, 0XC241,
0XC601, 0X06C0, 0X0780, 0XC741, 0X0500, 0XC5C1, 0XC481, 0X0440,
0XCC01, 0X0CC0, 0X0D80, 0XCD41, 0X0F00, 0XCFC1, 0XCE81, 0X0E40,
0X0A00, 0XCAC1, 0XCB81, 0X0B40, 0XC901, 0X09C0, 0X0880, 0XC841,
0XD801, 0X18C0, 0X1980, 0XD941, 0X1B00, 0XDBC1, 0XDA81, 0X1A40,
0X1E00, 0XDEC1, 0XDF81, 0X1F40, 0XDD01, 0X1DC0, 0X1C80, 0XDC41,
0X1400, 0XD4C1, 0XD581, 0X1540, 0XD701, 0X17C0, 0X1680, 0XD641,
0XD201, 0X12C0, 0X1380, 0XD341, 0X1100, 0XD1C1, 0XD081, 0X1040,
0XF001, 0X30C0, 0X3180, 0XF141, 0X3300, 0XF3C1, 0XF281, 0X3240,
0X3600, 0XF6C1, 0XF781, 0X3740, 0XF501, 0X35C0, 0X3480, 0XF441,
0X3C00, 0XFCC1, 0XFD81, 0X3D40, 0XFF01, 0X3FC0, 0X3E80, 0XFE41,
0XFA01, 0X3AC0, 0X3B80, 0XFB41, 0X3900, 0XF9C1, 0XF881, 0X3840,
0X2800, 0XE8C1, 0XE981, 0X2940, 0XEB01, 0X2BC0, 0X2A80, 0XEA41,
0XEE01, 0X2EC0, 0X2F80, 0XEF41, 0X2D00, 0XEDC1, 0XEC81, 0X2C40,
0XE401, 0X24C0, 0X2580, 0XE541, 0X2700, 0XE7C1, 0XE681, 0X2640,
0X2200, 0XE2C1, 0XE381, 0X2340, 0XE101, 0X21C0, 0X2080, 0XE041,
0XA001, 0X60C0, 0X6180, 0XA141, 0X6300, 0XA3C1, 0XA281, 0X6240,
0X6600, 0XA6C1, 0XA781, 0X6740, 0XA501, 0X65C0, 0X6480, 0XA441,
0X6C00, 0XACC1, 0XAD81, 0X6D40, 0XAF01, 0X6FC0, 0X6E80, 0XAE41,
0XAA01, 0X6AC0, 0X6B80, 0XAB41, 0X6900, 0XA9C1, 0XA881, 0X6840,
0X7800, 0XB8C1, 0XB981, 0X7940, 0XBB01, 0X7BC0, 0X7A80, 0XBA41,
0XBE01, 0X7EC0, 0X7F80, 0XBF41, 0X7D00, 0XBDC1, 0XBC81, 0X7C40,
0XB401, 0X74C0, 0X7580, 0XB541, 0X7700, 0XB7C1, 0XB681, 0X7640,
0X7200, 0XB2C1, 0XB381, 0X7340, 0XB101, 0X71C0, 0X7080, 0XB041,
0X5000, 0X90C1, 0X9181, 0X5140, 0X9301, 0X53C0, 0X5280, 0X9241,
0X9601, 0X56C0, 0X5780, 0X9741, 0X5500, 0X95C1, 0X9481, 0X5440,
0X9C01, 0X5CC0, 0X5D80, 0X9D41, 0X5F00, 0X9FC1, 0X9E81, 0X5E40,
0X5A00, 0X9AC1, 0X9B81, 0X5B40, 0X9901, 0X59C0, 0X5880, 0X9841,
0X8801, 0X48C0, 0X4980, 0X8941, 0X4B00, 0X8BC1, 0X8A81, 0X4A40,
0X4E00, 0X8EC1, 0X8F81, 0X4F40, 0X8D01, 0X4DC0, 0X4C80, 0X8C41,
0X4400, 0X84C1, 0X8581, 0X4540, 0X8701, 0X47C0, 0X4680, 0X8641,
0X8201, 0X42C0, 0X4380, 0X8341, 0X4100, 0X81C1, 0X8081, 0X4040
};
public:
CModBusCRC16();
void reset();
uint16_t process(int len, const uint8_t* pData);
uint16_t get() const;
};
#endif

30
src/Afterburner/src/WiFi/BTCWebServer.cpp
View File

@ -25,6 +25,7 @@
#include <Arduino.h>
#include "BTCWifi.h"
#include "BTCWebServer.h"
#include "BTCota.h"
#include "../Utility/DebugPort.h"
#include "../Protocol/TxManage.h"
#include "../Utility/helpers.h"
@ -56,6 +57,8 @@ bool bRxWebData = false; // flags for OLED animation
bool bTxWebData = false;
bool bUpdateAccessed = false; // flag used to ensure web update always starts via /update. direct accesses to /updatenow will FAIL
bool bFormatAccessed = false;
uint16_t fileCRC = 0;
int nUploadSize = 0;
long _SuppliedFileSize = 0;
void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length);
@ -349,13 +352,13 @@ void rootRedirect()
bool sendWebSocketString(const char* Str)
{
CProfile profile;
// CProfile profile;
if(webSocket.connectedClients()) {
unsigned long tCon = profile.elapsed(true);
// unsigned long tCon = profile.elapsed(true);
bTxWebData = true; // OLED tx data animation flag
webSocket.broadcastTXT(Str);
unsigned long tWeb = profile.elapsed(true);
DebugPort.printf("Websend times : %ld,%ld\r\n", tCon, tWeb);
// unsigned long tWeb = profile.elapsed(true);
// DebugPort.printf("Websend times : %ld,%ld\r\n", tCon, tWeb);
return true;
}
return false;
@ -538,6 +541,7 @@ void onErase()
// function called upon completion of file (form) upload
void onUploadCompletion()
{
_SuppliedFileSize = 0;
DebugPort.println("WEB: POST /updatenow completion");
// completion functionality
if(SPIFFSupload) {
@ -596,10 +600,17 @@ void onUploadProgression()
HTTPUpload& upload = server.upload();
if (upload.status == UPLOAD_FILE_START) {
String filename = upload.filename;
// CRC checking
nUploadSize = upload.totalSize;
DebugPort.setDebugOutput(true);
if(filename.endsWith(".bin")) {
DebugPort.printf("Update: %s %d\r\n", filename.c_str(), upload.totalSize);
if (!Update.begin()) { //start with max available size
DebugPort.printf("Update: %s\r\n", filename.c_str());
int sizetouse = -1; //start with max available size
if(_SuppliedFileSize) {
sizetouse = _SuppliedFileSize; // adapt to websocket supplied size
}
if (!Update.begin(sizetouse)) {
Update.printError(DebugPort);
}
}
@ -608,7 +619,6 @@ void onUploadProgression()
DebugPort.printf("handleFileUpload Name: %s\r\n", filename.c_str());
fsUploadFile = SPIFFS.open(filename, "w"); // Open the file for writing in SPIFFS (create if it doesn't exist)
SPIFFSupload = fsUploadFile ? 1 : 2;
//filename = String();
}
}
@ -640,6 +650,7 @@ void onUploadProgression()
// handle end of upload
else if (upload.status == UPLOAD_FILE_END) {
delay(2000);
if(SPIFFSupload) {
if(fsUploadFile) {
fsUploadFile.close(); // Close the file again
@ -647,7 +658,10 @@ void onUploadProgression()
}
}
else {
if (Update.end(true)) { //true to set the size to the current progress
if(!CheckFirmwareCRC(_SuppliedFileSize))
Update.abort();
if (Update.end()) {
DebugPort.printf("Update Success: %u\r\nRebooting...\r\n", upload.totalSize);
} else {
Update.printError(DebugPort);

40
src/Afterburner/src/WiFi/BTCota.cpp
View File

@ -28,6 +28,8 @@
#include <SPIFFS.h>
#include <Update.h>
#include <ArduinoOTA.h>
#include "../Utility/MODBUS-CRC16.h"
#include "esp_ota_ops.h"
esp32FOTA FOTA("afterburner-fota-http", int(getVersion()*1000));
@ -142,4 +144,42 @@ bool isUpdateAvailable(bool test)
void checkFOTA()
{
FOTAtime = millis();
}
const int CRCbufsize = 1024;
uint8_t CRCReadBuff[CRCbufsize];
bool CheckFirmwareCRC(int filesize)
{
const esp_partition_t* pUsePartition = esp_ota_get_next_update_partition(NULL);
if(NULL == pUsePartition) {
DebugPort.println("CheckCRC: FAILED - bad partition?");
return false;
}
int size = (filesize >> 2) << 2; // mod 4
if((filesize - size) != 2) {
// we expect 2 extra bytes where the custom CRC is added
// all normal applications without CRC are multiples of 4
DebugPort.println("CheckCRC: FAILED - bad source file size");
return false;
}
CModBusCRC16 CRCengine;
int processed = 0;
while(processed < size) {
int toRead = size - processed;
if(toRead > CRCbufsize)
toRead = CRCbufsize;
ESP.flashRead(pUsePartition->address + processed, (uint32_t*)CRCReadBuff, toRead);
CRCengine.process(toRead, CRCReadBuff);
processed += toRead;
}
ESP.flashRead(pUsePartition->address + processed, (uint32_t*)CRCReadBuff, 4);
uint32_t fileCRC = CRCReadBuff[0] + (CRCReadBuff[1]<<8);
DebugPort.printf("Upload CRC TEST: calcCRC= %04X, fileCRC = %08X\r\n", CRCengine.get(), fileCRC);
return fileCRC == CRCengine.get();
}

1
src/Afterburner/src/WiFi/BTCota.h
View File

@ -24,5 +24,6 @@
void initOTA();
void DoOTA();
bool CheckFirmwareCRC(int size);
#endif