Bootloader.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QObject>
 
#ifdef Q_OS_ANDROID
#include "qserialport.h"
#else
#include <QtSerialPort/QSerialPort>
#endif
 
Q_DECLARE_LOGGING_CATEGORY(FirmwareUpgradeLog)
Q_DECLARE_LOGGING_CATEGORY(FirmwareUpgradeVerboseLog)
 
class FirmwareImage;
 
class Bootloader : public QObject
{
    Q_OBJECT
 
public:
    explicit Bootloader(bool sikRadio, QObject *parent = 0);
 
    QString errorString(void) { return _errorString; }
 
    bool open               (const QString portName);
    void close              (void) { _port.close(); }
    bool getBoardInfo       (uint32_t& bootloaderVersion, uint32_t& boardID, uint32_t& flashSize);
    bool initFlashSequence  (void);
    bool erase              (void);
    bool program            (const FirmwareImage* image);
    bool verify             (const FirmwareImage* image);
    bool reboot             (void);
 
    static const int boardIDSiKRadio1000    = 78;       
    static const int boardIDSiKRadio1060    = 80;       
 
    static const int boardIDPX4FMUV2 = 9;        
    static const int boardIDPX4FMUV3 = 255;
 
signals:
    void updateProgress(int curr, int total);
 
private:
    bool    _sync               (void);
    bool    _syncWorker         (void);
    bool    _binProgram         (const FirmwareImage* image);
    bool    _ihxProgram         (const FirmwareImage* image);
    bool    _write              (const uint8_t* data, qint64 maxSize);
    bool    _write              (const uint8_t byte);
    bool    _write              (const char* data);
    bool    _read               (uint8_t* data, qint64 cBytesExpected, int readTimeout = _readTimout);
    bool    _sendCommand        (uint8_t cmd, int responseTimeout = _responseTimeout);
    bool    _getCommandResponse (const int responseTimeout = _responseTimeout);
    bool    _protoGetDevice     (uint8_t param, uint32_t& value);
    bool    _verifyBytes        (const FirmwareImage* image);
    bool    _binVerifyBytes     (const FirmwareImage* image);
    bool    _ihxVerifyBytes     (const FirmwareImage* image);
    bool    _verifyCRC          (void);
    QString _getNextLine        (int timeoutMsecs);
    bool    _get3DRRadioBoardId (uint32_t& boardID);
 
    enum {
        // protocol bytes
        PROTO_INSYNC =          0x12,   
        PROTO_BAD_SILICON_REV = 0x14,   
        PROTO_EOC =             0x20,   
 
        // Reply bytes
        PROTO_OK =              0x10,   
        PROTO_FAILED =          0x11,   
        PROTO_INVALID =         0x13,   
 
        // Command bytes
        PROTO_GET_SYNC =        0x21,   
        PROTO_GET_DEVICE =      0x22,   
        PROTO_CHIP_ERASE =      0x23,   
        PROTO_LOAD_ADDRESS =    0x24,   
        PROTO_PROG_MULTI =      0x27,   
        PROTO_GET_CRC =         0x29,   
        PROTO_BOOT =            0x30,   
 
        // Command bytes - Rev 2 boootloader only
        PROTO_CHIP_VERIFY   =   0x24, 
        PROTO_READ_MULTI    =   0x28, 
 
        INFO_BL_REV         =   1,    
        BL_REV_MIN          =   2,    
        BL_REV_MAX          =   5,    
        INFO_BOARD_ID       =   2,    
        INFO_BOARD_REV      =   3,    
        INFO_FLASH_SIZE     =   4,    
 
        PROG_MULTI_MAX      =   64,     
        READ_MULTI_MAX      =   0x28    
    };
 
    QSerialPort _port;
    bool        _sikRadio           = false;
    bool        _inBootloaderMode   = false;    
    uint32_t    _boardID            = 0;        
    uint32_t    _boardFlashSize     = 0;        
    uint32_t    _bootloaderVersion  = 0;        
    uint32_t    _imageCRC           = 0;        
    QString     _firmwareFilename;              
    QString     _errorString;                   
 
    static const int _eraseTimeout                      = 20000;    
    static const int _rebootTimeout                     = 10000;    
    static const int _verifyTimeout                     = 5000;     
    static const int _readTimout                        = 2000;     
    static const int _responseTimeout                   = 2000;     
    static const int _flashSizeSmall                    = 1032192;  
    static const int _bootloaderVersionV2CorrectFlash   = 5;        
};