rockbox/utils/rbutilqt/base/bootloaderinstalls5l.cpp

/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 *
 *   Copyright (C) 2008 by Dominik Riebeling
 *
 * All files in this archive are subject to the GNU General Public License.
 * See the file COPYING in the source tree root for full license agreement.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/

#include <QtCore>
#include "bootloaderinstallbase.h"
#include "bootloaderinstalls5l.h"
#include "Logger.h"
#include "utils.h"
#include "system.h"
#include "rbsettings.h"
#include "playerbuildinfo.h"

#include "../mks5lboot/mks5lboot.h"


BootloaderInstallS5l::BootloaderInstallS5l(QObject *parent)
        : BootloaderInstallBase(parent)
{
}


bool BootloaderInstallS5l::install(void)
{
    LOG_INFO() << "installing bootloader";
    doInstall = true;
    return installStage1();
}


bool BootloaderInstallS5l::uninstall(void)
{
    LOG_INFO() << "uninstalling bootloader";
    doInstall = false;
    return installStage1();
}


bool BootloaderInstallS5l::installStage1(void)
{
    LOG_INFO() << "installStage1";

    mntpoint = RbSettings::value(RbSettings::Mountpoint).toString();

    if (!Utils::mountpoints(Utils::MountpointsSupported).contains(mntpoint)) {
        LOG_ERROR() << "iPod not mounted:" << mntpoint;
        emit logItem(tr("Could not find mounted iPod."), LOGERROR);
        emit done(true);
        return false;
    }

    if (doInstall) {
        // download firmware from server
        emit logItem(tr("Downloading bootloader file..."), LOGINFO);
        connect(this, &BootloaderInstallBase::downloadDone,
                this, &BootloaderInstallS5l::installStageMkdfu);
        downloadBlStart(m_blurl);
    }
    else {
        installStageMkdfu();
    }

    return true;
}


void BootloaderInstallS5l::installStageMkdfu(void)
{
    int dfu_type;
    QString dfu_arg;
    char errstr[200];

    LOG_INFO() << "installStageMkdfu";

    setProgress(0);
    aborted = false;
    connect(this, &BootloaderInstallBase::installAborted,
            this, &BootloaderInstallS5l::abortInstall);
    connect(this, &BootloaderInstallBase::done,
            this, &BootloaderInstallS5l::installDone);

    if (doInstall) {
        dfu_type = DFU_INST;
        m_tempfile.open();
        dfu_arg = m_tempfile.fileName();
        m_tempfile.close();
    }
    else {
        dfu_type = DFU_UNINST;
        dfu_arg = RbSettings::value(RbSettings::Platform).toString();
    }

    // build DFU image
    dfu_buf = mkdfu(dfu_type, dfu_arg.toLocal8Bit().data(),
                                &dfu_size, errstr, sizeof(errstr));
    if (!dfu_buf) {
        LOG_ERROR() << "mkdfu() failed:" << errstr;
        emit logItem(errstr, LOGERROR);
        emit logItem(tr("Could not make DFU image."), LOGERROR);
        emit done(true);
        return;
    }

    LOG_INFO() << "preparing installStageWaitForEject";
    emit logItem(tr("Ejecting iPod..."), LOGINFO);
    setProgress(10);
    scanTimer.invalidate();
    installStageWaitForEject();
}


void BootloaderInstallS5l::installStageWaitForEject(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (!scanTimer.isValid() || (scanTimer.elapsed() > 3000)) {
        scanSuccess = Utils::ejectDevice(mntpoint);
        if (!scanSuccess) {
            scanSuccess = !Utils::mountpoints(
                        Utils::MountpointsSupported).contains(mntpoint);
        }
        scanTimer.start();
    }
    if (!scanSuccess) {
        if (!actionShown) {
            emit logItem(tr("Action required:\n\n"
                            "Please make sure no programs are accessing "
                            "files on the device. If ejecting still fails "
                            "please use your computers eject functionality."),
                            LOGWARNING);
            actionShown = true;
        }
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageWaitForEject);
        return;
    }
    emit logItem(tr("Device successfully ejected."), LOGINFO);

    LOG_INFO() << "preparing installStageWaitForProcs";
    setProgress(40, 18);
    scanTimer.invalidate();
    installStageWaitForProcs();
}


void BootloaderInstallS5l::installStageWaitForProcs(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (!scanTimer.isValid() || (scanTimer.elapsed() > 1000)) {
        scanSuccess = Utils::findRunningProcess(QStringList("iTunes")).isEmpty();
        scanTimer.start();
    }
    if (!scanSuccess) {
        if (!actionShown) {
            emit logItem(tr("Action required:\n\n"
                            "Quit iTunes application."), LOGWARNING);
            actionShown = true;
        }
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageWaitForProcs);
        return;
    }
    if (actionShown) {
        emit logItem(tr("iTunes closed."), LOGINFO);
        if (!updateProgress())
            return; /* aborted */
    }

    QList<int> helperPids = Utils::findRunningProcess(
#if defined(Q_OS_WIN32)
                    QStringList("iTunesHelper"))["iTunesHelper.exe"];
#else
                    QStringList("iTunesHelper"))["iTunesHelper"];
#endif
    suspendedPids = Utils::suspendProcess(helperPids, true);
    if (suspendedPids.size() != helperPids.size()) {
        emit logItem(tr("Could not suspend iTunesHelper. Stop it "
                        "using the Task Manager, and try again."), LOGERROR);
        emit done(true);
        return;
    }

    LOG_INFO() << "preparing installStageWaitForSpindown";
    // for Windows: skip waiting if the HDD was ejected a time ago
    if (progressTimer.elapsed() < progressTimeout)
        emit logItem(tr("Waiting for HDD spin-down..."), LOGINFO);
    installStageWaitForSpindown();
}


void BootloaderInstallS5l::installStageWaitForSpindown(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (progressTimer.elapsed() < progressTimeout) {
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageWaitForSpindown);
        return;
    }

    LOG_INFO() << "preparing installStageWaitForDfu";
    emit logItem(tr("Waiting for DFU mode..."), LOGINFO);
    emit logItem(tr("Action required:\n\n"
                    "Press and hold SELECT+MENU buttons, after "
                    "about 12 seconds a new action will require "
                    "you to release the buttons, DO IT QUICKLY, "
                    "otherwise the process could fail."), LOGWARNING);
    scanTimer.invalidate();
    installStageWaitForDfu();
}


void BootloaderInstallS5l::installStageWaitForDfu(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (!scanTimer.isValid() || (scanTimer.elapsed() > 2000)) {
        scanSuccess = System::listUsbIds().contains(0x05ac1223);
        scanTimer.start();
    }
    if (!scanSuccess) {
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageWaitForDfu);
        return;
    }
    emit logItem(tr("DFU mode detected."), LOGINFO);

    emit logItem(tr("Action required:\n\n"
                    "Release SELECT+MENU buttons and wait..."), LOGWARNING);

    // Once the iPod enters DFU mode, the device will reset again if
    // SELECT+MENU remains pressed for another 8 seconds. To avoid a
    // reset while the NOR is being written, we wait ~10 seconds
    // before sending the DFU image.
    LOG_INFO() << "preparing installStageSendDfu";
    setProgress(60, 10);
    installStageSendDfu();
}


void BootloaderInstallS5l::installStageSendDfu(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (progressTimer.elapsed() < progressTimeout) {
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageSendDfu);
        return;
    }

    if (!System::listUsbIds().contains(0x05ac1223)) {
        LOG_ERROR() << "device not in DFU mode";
        emit logItem(tr("Device is not in DFU mode. It seems that "
                        "the previous required action failed, please "
                        "try again."), LOGERROR);
        emit done(true);
        return;
    }

    emit logItem(tr("Transfering DFU image..."), LOGINFO);
    if (!updateProgress())
        return; /* aborted */

    char errstr[200];
    if (!ipoddfu_send(0x1223, dfu_buf, dfu_size, errstr, sizeof(errstr))) {
        LOG_ERROR() << "ipoddfu_send() failed:" << errstr;
#if defined(Q_OS_WIN32)
        if (strstr(errstr, "DFU device not found"))
        {
            emit logItem(tr("No valid DFU USB driver found.\n\n"
                            "Install iTunes (or the Apple Device Driver) "
                            "and try again."),
                            LOGERROR);
        }
        else
#endif
        {
            emit logItem(errstr, LOGERROR);
            emit logItem(tr("Could not transfer DFU image."), LOGERROR);
        }
        emit done(true);
        return;
    }
    emit logItem(tr("DFU transfer completed."), LOGINFO);

    LOG_INFO() << "preparing installStageWaitForRemount";
    emit logItem(tr("Restarting iPod, waiting for remount..."), LOGINFO);
    setProgress(99, 45);
    scanTimer.invalidate();
    installStageWaitForRemount();
}


void BootloaderInstallS5l::installStageWaitForRemount(void)
{
    if (!updateProgress())
        return; /* aborted */

    if (!scanTimer.isValid() || (scanTimer.elapsed() > 5000)) {
        scanSuccess = Utils::mountpoints(
                    Utils::MountpointsSupported).contains(mntpoint);
        scanTimer.start();
    }
    if (!scanSuccess) {
        if (!actionShown && (progressTimer.elapsed() > progressTimeout)) {
            emit logItem(tr("Action required:\n\n"
                            "Could not remount the device, try to do it "
                            "manually. If the iPod didn't restart, force "
                            "a reset by pressing SELECT+MENU buttons "
                            "for about 5 seconds. If the problem could "
                            "not be solved then click 'Abort' to cancel."),
                            LOGWARNING);
            actionShown = true;
        }
        QTimer::singleShot(250, this, &BootloaderInstallS5l::installStageWaitForRemount);
        return;
    }
    emit logItem(tr("Device remounted."), LOGINFO);

    if (doInstall)
        emit logItem(tr("Bootloader successfully installed."), LOGOK);
    else
        emit logItem(tr("Bootloader successfully uninstalled."), LOGOK);

    logInstall(doInstall ? LogAdd : LogRemove);
    emit logProgress(1, 1);
    emit done(false);
}


void BootloaderInstallS5l::installDone(bool status)
{
    LOG_INFO() << "installDone, status:" << status;
    if (Utils::suspendProcess(suspendedPids, false).size() != suspendedPids.size())
        emit logItem(tr("Could not resume iTunesHelper."), LOGWARNING);
}


void BootloaderInstallS5l::abortInstall(void)
{
    LOG_INFO() << "abortInstall";
    aborted = true;
    disconnect(this, &BootloaderInstallBase::installAborted,
               this, &BootloaderInstallS5l::abortInstall);
}


bool BootloaderInstallS5l::abortDetected(void)
{
    if (aborted) {
        LOG_ERROR() << "abortDetected";
        if (doInstall)
            emit logItem(tr("Install aborted by user."), LOGERROR);
        else
            emit logItem(tr("Uninstall aborted by user."), LOGERROR);
        emit done(true);
        return true;
    }
    return false;
}


void BootloaderInstallS5l::setProgress(int progress, int secondsTimeout)
{
    progressTimer.start();
    progressTimeout = secondsTimeout * 1000;
    progOrigin = progTarget;
    progTarget = progress;
    actionShown = false;
}


bool BootloaderInstallS5l::updateProgress(void)
{
    if (progressTimeout) {
        progCurrent = qMin(progTarget, progOrigin +
            static_cast<int>(progressTimer.elapsed())
                           * (progTarget - progOrigin) / progressTimeout);
    }
    else {
        progCurrent = progTarget;
    }
    emit logProgress(progCurrent, 100);
    QCoreApplication::sendPostedEvents();
    QCoreApplication::processEvents();
    return !abortDetected();
}


BootloaderInstallBase::BootloaderType BootloaderInstallS5l::installed(void)
{
    bool rbblInstalled;

    QString device = Utils::resolveDevicename(m_blfile);
    if (device.isEmpty()) {
        LOG_INFO() << "installed: BootloaderUnknown";
        return BootloaderUnknown;
    }

    // rely on logfile
    QString logfile = RbSettings::value(RbSettings::Mountpoint).toString()
                + "/.rockbox/rbutil.log";
    QSettings s(logfile, QSettings::IniFormat, this);
    QString section = PlayerBuildInfo::instance()->value(
                PlayerBuildInfo::BootloaderName).toString().section('/', -1);
    rbblInstalled = s.contains("Bootloader/" + section);

    if (rbblInstalled) {
        LOG_INFO() << "installed: BootloaderRockbox";
        return BootloaderRockbox;
    }
    else {
        LOG_INFO() << "installed: BootloaderOther";
        return BootloaderOther;
    }
}


BootloaderInstallBase::Capabilities BootloaderInstallS5l::capabilities(void)
{
    return (Install | Uninstall);
}