FirmwareUpgradeController.h 9.85 KB
Newer Older
1 2 3 4
/*=====================================================================
 
 QGroundControl Open Source Ground Control Station
 
5
 (c) 2009, 2015 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL 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.
 
 QGROUNDCONTROL 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 QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/

/// @file
///     @author Don Gagne <don@thegagnes.com>

27 28
#ifndef FirmwareUpgradeController_H
#define FirmwareUpgradeController_H
29

30
#include "PX4FirmwareUpgradeThread.h"
31 32
#include "LinkManager.h"
#include "FirmwareImage.h"
33 34

#include <QObject>
35 36 37 38
#include <QUrl>
#include <QTimer>
#include <QNetworkAccessManager>
#include <QNetworkReply>
39 40
#include <QPixmap>
#include <QQuickItem>
41

42 43
#include "qextserialport.h"

44 45
#include <stdint.h>

46 47
/// Supported firmware types. If you modify these you will need to update the qml file as well.

48 49
// Firmware Upgrade MVC Controller for FirmwareUpgrade.qml.
class FirmwareUpgradeController : public QObject
50 51
{
    Q_OBJECT
52
    
53
public:
54 55 56 57
        typedef enum {
            AutoPilotStackPX4,
            AutoPilotStackAPM,
            PX4Flow,
58
            ThreeDRRadio
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
        } AutoPilotStackType_t;

        typedef enum {
            StableFirmware,
            BetaFirmware,
            DeveloperFirmware,
            CustomFirmware
        } FirmwareType_t;

        typedef enum {
            QuadFirmware,
            X8Firmware,
            HexaFirmware,
            OctoFirmware,
            YFirmware,
            Y6Firmware,
            HeliFirmware,
            PlaneFirmware,
            RoverFirmware,
78
            DefaultVehicleFirmware
79 80 81 82 83 84 85 86 87 88 89 90 91 92
        } FirmwareVehicleType_t;

        Q_ENUMS(AutoPilotStackType_t)
        Q_ENUMS(FirmwareType_t)
        Q_ENUMS(FirmwareVehicleType_t)

    class FirmwareIdentifier
    {
    public:
        FirmwareIdentifier(AutoPilotStackType_t stack = AutoPilotStackPX4,
                           FirmwareType_t firmware = StableFirmware,
                           FirmwareVehicleType_t vehicle = DefaultVehicleFirmware)
            : autopilotStackType(stack), firmwareType(firmware), firmwareVehicleType(vehicle) {}

93
        bool operator==(const FirmwareIdentifier& firmwareId) const
94
        {
95 96 97
            return (firmwareId.autopilotStackType == autopilotStackType &&
                    firmwareId.firmwareType == firmwareType &&
                    firmwareId.firmwareVehicleType == firmwareVehicleType);
98 99 100 101 102 103 104 105
        }

        // members
        AutoPilotStackType_t    autopilotStackType;
        FirmwareType_t          firmwareType;
        FirmwareVehicleType_t   firmwareVehicleType;
    };

106
    FirmwareUpgradeController(void);
Don Gagne's avatar
Don Gagne committed
107 108
    ~FirmwareUpgradeController();

109 110 111 112 113 114
    Q_PROPERTY(QString          boardPort                   READ boardPort                                              NOTIFY boardFound)
    Q_PROPERTY(QString          boardDescription            READ boardDescription                                       NOTIFY boardFound)
    Q_PROPERTY(QString          boardType                   MEMBER _foundBoardTypeName                                  NOTIFY boardFound)
    Q_PROPERTY(FirmwareType_t   selectedFirmwareType        READ selectedFirmwareType   WRITE setSelectedFirmwareType   NOTIFY selectedFirmwareTypeChanged)
    Q_PROPERTY(QStringList      apmAvailableVersions        READ apmAvailableVersions                                   NOTIFY apmAvailableVersionsChanged)

115 116 117
    /// TextArea for log output
    Q_PROPERTY(QQuickItem* statusLog READ statusLog WRITE setStatusLog)
    
118 119
    /// Progress bar for you know what
    Q_PROPERTY(QQuickItem* progressBar READ progressBar WRITE setProgressBar)
120 121 122

    /// Starts searching for boards on the background thread
    Q_INVOKABLE void startBoardSearch(void);
123
    
124 125
    /// Cancels whatever state the upgrade worker thread is in
    Q_INVOKABLE void cancel(void);
126
    
127
    /// Called when the firmware type has been selected by the user to continue the flash process.
128 129 130
    Q_INVOKABLE void flash(AutoPilotStackType_t stackType,
                           FirmwareType_t firmwareType = StableFirmware,
                           FirmwareVehicleType_t vehicleType = DefaultVehicleFirmware );
131 132

    Q_INVOKABLE FirmwareVehicleType_t vehicleTypeFromVersionIndex(int index);
133
    
134 135 136
    // overload, not exposed to qml side
    void flash(const FirmwareIdentifier& firmwareId);

137
    // Property accessors
138
    
139 140 141
    QQuickItem* progressBar(void) { return _progressBar; }
    void setProgressBar(QQuickItem* progressBar) { _progressBar = progressBar; }
    
142 143 144
    QQuickItem* statusLog(void) { return _statusLog; }
    void setStatusLog(QQuickItem* statusLog) { _statusLog = statusLog; }
    
145 146
    QString boardPort(void) { return _foundBoardInfo.portName(); }
    QString boardDescription(void) { return _foundBoardInfo.description(); }
147 148 149

    FirmwareType_t selectedFirmwareType(void) { return _selectedFirmwareType; }
    void setSelectedFirmwareType(FirmwareType_t firmwareType);
150
    QString firmwareTypeAsString(FirmwareType_t type) const;
151 152

    QStringList apmAvailableVersions(void);
153

154
signals:
155 156 157 158 159 160
    void boardFound(void);
    void noBoardFound(void);
    void boardGone(void);
    void flashComplete(void);
    void flashCancelled(void);
    void error(void);
161 162
    void selectedFirmwareTypeChanged(FirmwareType_t firmwareType);
    void apmAvailableVersionsChanged(void);
163
    
164 165 166 167
private slots:
    void _downloadProgress(qint64 curr, qint64 total);
    void _downloadFinished(void);
    void _downloadError(QNetworkReply::NetworkError code);
168
    void _foundBoard(bool firstAttempt, const QSerialPortInfo& portInfo, int boardType);
169 170
    void _noBoardFound(void);
    void _boardGone();
171
    void _foundBootloader(int bootloaderVersion, int boardID, int flashSize);
172 173
    void _error(const QString& errorString);
    void _status(const QString& statusString);
174
    void _bootloaderSyncFailed(void);
175
    void _flashComplete(void);
176
    void _updateProgress(int curr, int total);
177 178
    void _eraseStarted(void);
    void _eraseComplete(void);
179
    void _eraseProgressTick(void);
180
    void _apmVersionDownloadFinished(QString remoteFile, QString localFile);
181 182

private:
183
    void _getFirmwareFile(FirmwareIdentifier firmwareId);
Pritam Ghanghas's avatar
Pritam Ghanghas committed
184
    void _initFirmwareHash();
185
    void _downloadFirmware(void);
186 187
    void _appendStatusLog(const QString& text, bool critical = false);
    void _errorCancel(const QString& msg);
188 189 190 191
    void _loadAPMVersions(QGCSerialPortInfo::BoardType_t boardType);
    QHash<FirmwareIdentifier, QString>* _firmwareHashForBoardId(int boardId);
    QHash<FirmwareIdentifier, QString>* _firmwareHashForBoardType(QGCSerialPortInfo::BoardType_t boardType);

192 193 194
    QString _portName;
    QString _portDescription;

Pritam Ghanghas's avatar
Pritam Ghanghas committed
195
    // firmware hashes
Lorenz Meier's avatar
Lorenz Meier committed
196
    QHash<FirmwareIdentifier, QString> _rgPX4FMUV4Firmware;
Pritam Ghanghas's avatar
Pritam Ghanghas committed
197 198 199 200 201 202
    QHash<FirmwareIdentifier, QString> _rgPX4FMUV2Firmware;
    QHash<FirmwareIdentifier, QString> _rgAeroCoreFirmware;
    QHash<FirmwareIdentifier, QString> _rgPX4FMUV1Firmware;
    QHash<FirmwareIdentifier, QString> _rgPX4FLowFirmware;
    QHash<FirmwareIdentifier, QString> _rg3DRRadioFirmware;

203 204 205
    QMap<FirmwareType_t, QMap<FirmwareVehicleType_t, QString> > _apmVersionMap;
    QList<FirmwareVehicleType_t>                                _apmVehicleTypeFromCurrentVersionList;

206 207 208 209 210 211
    /// Information which comes back from the bootloader
    bool        _bootloaderFound;           ///< true: we have received the foundBootloader signals
    uint32_t    _bootloaderVersion;         ///< Bootloader version
    uint32_t    _bootloaderBoardID;         ///< Board ID
    uint32_t    _bootloaderBoardFlashSize;  ///< Flash size in bytes of board
    
212 213
    bool                 _startFlashWhenBootloaderFound;
    FirmwareIdentifier   _startFlashWhenBootloaderFoundFirmwareIdentity;
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

    QPixmap _boardIcon;             ///< Icon used to display image of board
    
    QString _firmwareFilename;      ///< Image which we are going to flash to the board
    
    QNetworkAccessManager*  _downloadManager;       ///< Used for firmware file downloading across the internet
    QNetworkReply*          _downloadNetworkReply;  ///< Used for firmware file downloading across the internet
    
    /// @brief Thread controller which is used to run bootloader commands on seperate thread
    PX4FirmwareUpgradeThreadController* _threadController;
    
    static const int    _eraseTickMsec = 500;       ///< Progress bar update tick time for erase
    static const int    _eraseTotalMsec = 15000;    ///< Estimated amount of time erase takes
    int                 _eraseTickCount;            ///< Number of ticks for erase progress update
    QTimer              _eraseTimer;                ///< Timer used to update progress bar for erase

    static const int    _findBoardTimeoutMsec = 30000;      ///< Amount of time for user to plug in USB
    static const int    _findBootloaderTimeoutMsec = 5000;  ///< Amount time to look for bootloader
    
233
    QQuickItem*     _statusLog;         ///< Status log TextArea Qml control
234
    QQuickItem*     _progressBar;
235 236
    
    bool _searchingForBoard;    ///< true: searching for board, false: search for bootloader
237
    
238 239 240 241 242 243
    QSerialPortInfo                 _foundBoardInfo;
    QGCSerialPortInfo::BoardType_t  _foundBoardType;
    QString                         _foundBoardTypeName;

    FirmwareType_t                  _selectedFirmwareType;

244
    FirmwareImage*  _image;
245 246
};

247
// global hashing function
248
uint qHash(const FirmwareUpgradeController::FirmwareIdentifier& firmwareId);
249

250
#endif