/** ****************************************************************************** * * @file devicewidget.cpp * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010. * @addtogroup GCSPlugins GCS Plugins * @{ * @addtogroup Uploader Serial and USB Uploader Plugin * @{ * @brief The USB and Serial protocol uploader plugin *****************************************************************************/ /* * 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, write to the Free Software Foundation, Inc., * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "devicewidget.h" deviceWidget::deviceWidget(QWidget *parent) : QWidget(parent) { myDevice = new Ui_deviceWidget(); myDevice->setupUi(this); devicePic = NULL; // Initialize pointer to null // Initialization of the Device icon display myDevice->verticalGroupBox_loaded->setVisible(false); myDevice->groupCustom->setVisible(false); myDevice->youdont->setVisible(false); myDevice->gVDevice->setScene(new QGraphicsScene(this)); connect(myDevice->retrieveButton, SIGNAL(clicked()), this, SLOT(downloadFirmware())); connect(myDevice->updateButton, SIGNAL(clicked()), this, SLOT(uploadFirmware())); connect(myDevice->pbLoad, SIGNAL(clicked()), this, SLOT(loadFirmware())); connect(myDevice->youdont, SIGNAL(stateChanged(int)), this, SLOT(confirmCB(int))); QPixmap pix = QPixmap(QString(":uploader/images/view-refresh.svg")); myDevice->statusIcon->setPixmap(pix); myDevice->lblCertified->setText(""); } void deviceWidget::showEvent(QShowEvent *event) { Q_UNUSED(event) // Thit fitInView method should only be called now, once the // widget is shown, otherwise it cannot compute its values and // the result is usually a ahrsbargraph that is way too small. if (devicePic) { myDevice->gVDevice->fitInView(devicePic,Qt::KeepAspectRatio); } } void deviceWidget::resizeEvent(QResizeEvent* event) { Q_UNUSED(event); if (devicePic) myDevice->gVDevice->fitInView(devicePic, Qt::KeepAspectRatio); } void deviceWidget::setDeviceID(int devID){ deviceID = devID; } void deviceWidget::setDfu(DFUObject *dfu) { m_dfu = dfu; } QString deviceWidget::idToBoardName(int id) { switch (id | 0x0011) { case 0x0111://MB return QString("Board name: OpenPilot MainBoard"); break; case 0x0311://PipX return QString("Board name: PipXtreame"); break; case 0x0411://Coptercontrol return QString("Board name: CopterControl"); break; case 0x0211://INS return QString("Board name: OpenPilot INS"); break; default: return QString(""); break; } } /** Fills the various fields for the device */ void deviceWidget::populate() { int id = m_dfu->devices[deviceID].ID; myDevice->lbldevID->setText(QString("Device ID: ") + QString::number(id, 16)); // DeviceID tells us what sort of HW we have detected: // display a nice icon: myDevice->gVDevice->scene()->clear(); myDevice->lblDevName->setText(deviceDescriptorStruct::idToBoardName(id)); myDevice->lblHWRev->setText(QString(tr("HW Revision: "))+QString::number(id & 0x0011, 16)); devicePic = new QGraphicsSvgItem(); devicePic->setSharedRenderer(new QSvgRenderer()); switch (id) { case 0x0101: devicePic->renderer()->load(QString(":/uploader/images/deviceID-0101.svg")); break; case 0x0301: devicePic->renderer()->load(QString(":/uploader/images/deviceID-0301.svg")); break; case 0x0401: devicePic->renderer()->load(QString(":/uploader/images/deviceID-0401.svg")); break; case 0x0201: devicePic->renderer()->load(QString(":/uploader/images/deviceID-0201.svg")); break; default: break; } devicePic->setElementId("device"); myDevice->gVDevice->scene()->addItem(devicePic); myDevice->gVDevice->setSceneRect(devicePic->boundingRect()); myDevice->gVDevice->fitInView(devicePic,Qt::KeepAspectRatio); bool r = m_dfu->devices[deviceID].Readable; bool w = m_dfu->devices[deviceID].Writable; myDevice->lblAccess->setText(QString("Flash access: ") + QString(r ? "R" : "-") + QString(w ? "W" : "-")); myDevice->lblMaxCode->setText(QString("Max code size: ") +QString::number(m_dfu->devices[deviceID].SizeOfCode)); myDevice->lblCRC->setText(QString("Firmware CRC: ") + QString::number(m_dfu->devices[deviceID].FW_CRC)); myDevice->lblBLVer->setText(QString("BL version: ") + QString::number(m_dfu->devices[deviceID].BL_Version)); int size=((OP_DFU::device)m_dfu->devices[deviceID]).SizeOfDesc; m_dfu->enterDFU(deviceID); QByteArray desc = m_dfu->DownloadDescriptionAsBA(size); if (! populateBoardStructuredDescription(desc)) { //TODO // desc was not a structured description QString str = m_dfu->DownloadDescription(size); myDevice->lblDescription->setText(QString("Firmware custom description: ")+str.left(str.indexOf(QChar(255)))); QPixmap pix = QPixmap(QString(":uploader/images/warning.svg")); myDevice->lblCertified->setPixmap(pix); myDevice->lblCertified->setToolTip(tr("Custom Firmware Build")); myDevice->lblBuildDate->setText("Warning: development firmware"); myDevice->lblGitTag->setText(""); myDevice->lblBrdName->setText(""); } status("Ready...", STATUSICON_INFO); } /** Freezes the contents of the widget so that a user cannot try to modify the contents */ void deviceWidget::freeze() { myDevice->description->setEnabled(false); myDevice->updateButton->setEnabled(false); myDevice->retrieveButton->setEnabled(false); } /** Populates the widget field with the description in case it is structured properly */ bool deviceWidget::populateBoardStructuredDescription(QByteArray desc) { if(UploaderGadgetWidget::descriptionToStructure(desc,&onBoardDescrition)) { myDevice->lblGitTag->setText("Git commit tag: "+onBoardDescrition.gitTag); myDevice->lblBuildDate->setText(QString("Firmware date: ") + onBoardDescrition.buildDate); if(onBoardDescrition.description.startsWith("release",Qt::CaseInsensitive)) { myDevice->lblDescription->setText(QString("Firmware tag: ")+onBoardDescrition.description); QPixmap pix = QPixmap(QString(":uploader/images/application-certificate.svg")); myDevice->lblCertified->setPixmap(pix); myDevice->lblCertified->setToolTip(tr("Official Firmware Build")); } else { myDevice->lblDescription->setText(QString("Firmware tag: ")+onBoardDescrition.description+QString(" (beta or custom build)")); QPixmap pix = QPixmap(QString(":uploader/images/warning.svg")); myDevice->lblCertified->setPixmap(pix); myDevice->lblCertified->setToolTip(tr("Custom Firmware Build")); } myDevice->lblBrdName->setText(idToBoardName(onBoardDescrition.boardType<<8)); return true; } return false; } bool deviceWidget::populateLoadedStructuredDescription(QByteArray desc) { if(UploaderGadgetWidget::descriptionToStructure(desc,&LoadedDescrition)) { myDevice->lblGitTagL->setText("Git commit tag: "+LoadedDescrition.gitTag); myDevice->lblBuildDateL->setText(QString("Firmware date: ") + LoadedDescrition.buildDate); if(LoadedDescrition.description.startsWith("release",Qt::CaseInsensitive)) { myDevice->lblDescritpionL->setText(QString("Firmware tag: ")+LoadedDescrition.description); myDevice->description->setText(LoadedDescrition.description); QPixmap pix = QPixmap(QString(":uploader/images/application-certificate.svg")); myDevice->lblCertifiedL->setPixmap(pix); myDevice->lblCertifiedL->setToolTip(tr("Official Firmware Build")); } else { myDevice->lblDescritpionL->setText(QString("Firmware tag: ")+LoadedDescrition.description+QString(" (beta or custom build)")); myDevice->description->setText(LoadedDescrition.description); QPixmap pix = QPixmap(QString(":uploader/images/warning.svg")); myDevice->lblCertifiedL->setPixmap(pix); myDevice->lblCertifiedL->setToolTip(tr("Custom Firmware Build")); } myDevice->lblBrdNameL->setText(deviceDescriptorStruct::idToBoardName(LoadedDescrition.boardType<<8)); return true; } return false; } /** Updates status message for messages coming from DFU */ void deviceWidget::dfuStatus(QString str) { status(str, STATUSICON_RUNNING); } void deviceWidget::confirmCB(int value) { if(value==Qt::Checked) { myDevice->updateButton->setEnabled(true); } else myDevice->updateButton->setEnabled(false); } /** Updates status message */ void deviceWidget::status(QString str, StatusIcon ic) { QPixmap px; myDevice->statusLabel->setText(str); switch (ic) { case STATUSICON_RUNNING: px.load(QString(":/uploader/images/system-run.svg")); break; case STATUSICON_OK: px.load(QString(":/uploader/images/dialog-apply.svg")); break; case STATUSICON_FAIL: px.load(QString(":/uploader/images/process-stop.svg")); break; default: px.load(QString(":/uploader/images/gtk-info.svg")); } myDevice->statusIcon->setPixmap(px); } void deviceWidget::loadFirmware() { myDevice->verticalGroupBox_loaded->setVisible(false); myDevice->groupCustom->setVisible(false); filename = setOpenFileName(); if (filename.isEmpty()) { status("Empty filename", STATUSICON_FAIL); return; } QFile file(filename); if (!file.open(QIODevice::ReadOnly)) { status("Can't open file", STATUSICON_FAIL); return; } loadedFW = file.readAll(); myDevice->youdont->setVisible(false); myDevice->youdont->setChecked(false); QByteArray desc = loadedFW.right(100); QPixmap px; myDevice->lblCRCL->setText(QString("FW CRC: ") + QString::number(DFUObject::CRCFromQBArray(loadedFW,m_dfu->devices[deviceID].SizeOfCode))); myDevice->lblFirmwareSizeL->setText(QString("Firmware size: ")+QVariant(loadedFW.length()).toString()+ QString(" bytes")); if (populateLoadedStructuredDescription(desc)) { myDevice->youdont->setChecked(true); myDevice->verticalGroupBox_loaded->setVisible(true); myDevice->groupCustom->setVisible(false); if(myDevice->lblCRC->text()==myDevice->lblCRCL->text()) { myDevice->statusLabel->setText(tr("The loaded firmware maches the firmware on the board. You shouldn't upload it")); px.load(QString(":/uploader/images/warning.svg")); } else if(myDevice->lblDevName->text()!=myDevice->lblBrdNameL->text()) { myDevice->statusLabel->setText(tr("The loaded firmware is not suited for the HW connected. You shouldn't upload it")); px.load(QString(":/uploader/images/warning.svg")); } else if(QDateTime::fromString(onBoardDescrition.buildDate)>QDateTime::fromString(LoadedDescrition.buildDate)) { myDevice->statusLabel->setText(tr("The loaded firmware is older then the firmware on the board. You shouldn't upload it")); px.load(QString(":/uploader/images/warning.svg")); } else if(!LoadedDescrition.description.startsWith("release",Qt::CaseInsensitive)) { myDevice->statusLabel->setText(tr("The loaded firmware is not an oficial OpenPilot release. You should upload it only if you know what you are doing")); px.load(QString(":/uploader/images/warning.svg")); } else { myDevice->statusLabel->setText(tr("Everything seems OK. You should upload the loaded firmware by pressing 'upload'")); px.load(QString(":/uploader/images/gtk-info.svg")); } } else { myDevice->statusLabel->setText(tr("The loaded firmware was not packaged with a compatible format. You shouldn't' upload it, if you know what you are doing and still want to upload it confirm it by checking the checkbox bellow")); px.load(QString(":/uploader/images/warning.svg")); myDevice->youdont->setChecked(false); myDevice->youdont->setVisible(true); myDevice->verticalGroupBox_loaded->setVisible(false); myDevice->groupCustom->setVisible(true); } myDevice->statusIcon->setPixmap(px); //myDevice->updateButton->setEnabled(true); } /** Sends a firmware to the device */ void deviceWidget::uploadFirmware() { if (!m_dfu->devices[deviceID].Writable) { status("Device not writable!", STATUSICON_FAIL); return; } bool verify = false; /* TODO: does not work properly on current Bootloader! if (m_dfu->devices[deviceID].Readable) verify = true; */ QByteArray desc = loadedFW.right(100); if (desc.startsWith("OpFw")) { descriptionArray = desc; // Now do sanity checking: // - Check whether board type matches firmware: int board = m_dfu->devices[deviceID].ID; int firmwareBoard = ((desc.at(12)&0xff)<<8) + (desc.at(13)&0xff); if (firmwareBoard != board) { status("Error: firmware does not match board", STATUSICON_FAIL); return; } // Check the firmware embedded in the file: QByteArray firmwareHash = desc.mid(40,20); QByteArray fileHash = QCryptographicHash::hash(loadedFW.left(loadedFW.length()-100), QCryptographicHash::Sha1); if (firmwareHash != fileHash) { status("Error: firmware file corrupt", STATUSICON_FAIL); return; } } else { // The firmware is not packaged, just upload the text in the description field // if it is there. descriptionArray.clear(); } status("Starting firmware upload", STATUSICON_RUNNING); // We don't know which device was used previously, so we // are cautious and reenter DFU for this deviceID: if(!m_dfu->enterDFU(deviceID)) { status("Error:Could not enter DFU mode", STATUSICON_FAIL); return; } OP_DFU::Status ret=m_dfu->StatusRequest(); qDebug() << m_dfu->StatusToString(ret); m_dfu->AbortOperation(); // Necessary, otherwise I get random failures. connect(m_dfu, SIGNAL(progressUpdated(int)), this, SLOT(setProgress(int))); connect(m_dfu, SIGNAL(operationProgress(QString)), this, SLOT(dfuStatus(QString))); connect(m_dfu, SIGNAL(uploadFinished(OP_DFU::Status)), this, SLOT(uploadFinished(OP_DFU::Status))); bool retstatus = m_dfu->UploadFirmware(filename.toAscii(),verify, deviceID); if(!retstatus ) { status("Could not start upload", STATUSICON_FAIL); return; } status("Uploading, please wait...", STATUSICON_RUNNING); } /** Retrieves the firmware from the device */ void deviceWidget::downloadFirmware() { if (!m_dfu->devices[deviceID].Readable) { myDevice->statusLabel->setText(QString("Device not readable!")); return; } myDevice->retrieveButton->setEnabled(false); filename = setSaveFileName(); if (filename.isEmpty()) { status("Empty filename", STATUSICON_FAIL); return; } status("Downloading firmware from device", STATUSICON_RUNNING); connect(m_dfu, SIGNAL(progressUpdated(int)), this, SLOT(setProgress(int))); connect(m_dfu, SIGNAL(downloadFinished()), this, SLOT(downloadFinished())); downloadedFirmware.clear(); // Empty the byte array bool ret = m_dfu->DownloadFirmware(&downloadedFirmware,deviceID); if(!ret) { status("Could not start download!", STATUSICON_FAIL); return; } status("Download started, please wait", STATUSICON_RUNNING); } /** Callback for the firmware download result */ void deviceWidget::downloadFinished() { disconnect(m_dfu, SIGNAL(downloadFinished()), this, SLOT(downloadFinished())); disconnect(m_dfu, SIGNAL(progressUpdated(int)), this, SLOT(setProgress(int))); status("Download successful", STATUSICON_OK); // Now save the result (use the utility function from OP_DFU) m_dfu->SaveByteArrayToFile(filename, downloadedFirmware); myDevice->retrieveButton->setEnabled(true); } /** Callback for the firmware upload result */ void deviceWidget::uploadFinished(OP_DFU::Status retstatus) { disconnect(m_dfu, SIGNAL(uploadFinished(OP_DFU::Status)), this, SLOT(uploadFinished(OP_DFU::Status))); disconnect(m_dfu, SIGNAL(progressUpdated(int)), this, SLOT(setProgress(int))); disconnect(m_dfu, SIGNAL(operationProgress(QString)), this, SLOT(dfuStatus(QString))); if(retstatus != OP_DFU::Last_operation_Success) { status(QString("Upload failed with code: ") + m_dfu->StatusToString(retstatus).toLatin1().data(), STATUSICON_FAIL); return; } else if (!descriptionArray.isEmpty()) { // We have a structured array to save status(QString("Updating description"), STATUSICON_RUNNING); repaint(); // Make sure the text above shows right away retstatus = m_dfu->UploadDescription(descriptionArray); if( retstatus != OP_DFU::Last_operation_Success) { status(QString("Upload failed with code: ") + m_dfu->StatusToString(retstatus).toLatin1().data(), STATUSICON_FAIL); return; } } else if (!myDevice->description->text().isEmpty()) { // Fallback: we save the description field: status(QString("Updating description"), STATUSICON_RUNNING); repaint(); // Make sure the text above shows right away retstatus = m_dfu->UploadDescription(myDevice->description->text()); if( retstatus != OP_DFU::Last_operation_Success) { status(QString("Upload failed with code: ") + m_dfu->StatusToString(retstatus).toLatin1().data(), STATUSICON_FAIL); return; } } populate(); status("Upload successful", STATUSICON_OK); } /** Slot to update the progress bar */ void deviceWidget::setProgress(int percent) { myDevice->progressBar->setValue(percent); } /** Opens an open file dialog. */ QString deviceWidget::setOpenFileName() { QFileDialog::Options options; QString selectedFilter; QString fileName = QFileDialog::getOpenFileName(this, tr("Select firmware file"), "", tr("Firmware Files (*.bin *.opfw)"), &selectedFilter, options); return fileName; } QString deviceWidget::setSaveFileName() { QFileDialog::Options options; QString selectedFilter; QString fileName = QFileDialog::getSaveFileName(this, tr("Select firmware file"), "", tr("Firmware Files (*.bin)"), &selectedFilter, options); return fileName; }