runonphone: Implement traceswitch support for coda

The traceswitch application redirects debug messages to the USB
port. This was supported by the TRK backend but not by the CODA
backend.

1. CODA backend now recognises mux channel 2 as valid
2. new TextTraceHandler class to attach to channel 2 and decode
   trace packets / print them to stdout
3. CODA signal handler creates a TextTraceHandler & destroys it
   on shutdown

Reviewed-By: Miikka Heikkinen

5 files changed, 160 insertions, 3 deletions

diff --git a/tools/runonphone/codasignalhandler.cpp b/tools/runonphone/codasignalhandler.cpp
index 0d086b5..7a7284d 100644
--- a/tools/runonphone/codasignalhandler.cpp
+++ b/tools/runonphone/codasignalhandler.cpp
@@ -46,6 +46,7 @@
 #include <QObject>
 #include <QTimer>
 #include "codasignalhandler.h"
+#include "texttracehandler.h"
 
 static const quint64 DEFAULT_CHUNK_SIZE = 40000;
 
@@ -173,6 +174,9 @@ int CodaSignalHandler::run()
         return 1;
     }
 
+    TextTraceHandler *traceHandler = new TextTraceHandler(
+                SymbianUtils::SymbianDeviceManager::instance()->getOstChannel(d->serialPortName, 2), this);
+
     if (d->loglevel > 1) {
         d->codaDevice->setVerbose(1);
     }
@@ -190,6 +194,8 @@ int CodaSignalHandler::run()
     d->eventLoop->exec();
     int result = d->result;
     reportMessage(tr("Done."));
+
+    delete traceHandler;
     disconnect(d->codaDevice.data(), 0, this, 0);
     SymbianUtils::SymbianDeviceManager::instance()->releaseCodaDevice(d->codaDevice);
 
diff --git a/tools/runonphone/runonphone.pro b/tools/runonphone/runonphone.pro
index d006a05..3d6a995 100644
--- a/tools/runonphone/runonphone.pro
+++ b/tools/runonphone/runonphone.pro
@@ -9,13 +9,15 @@ include(symbianutils/symbianutils.pri)
 SOURCES += main.cpp \
     trksignalhandler.cpp \
     ossignalconverter.cpp \
-    codasignalhandler.cpp
+    codasignalhandler.cpp \
+    texttracehandler.cpp
 
 HEADERS += trksignalhandler.h \
     serenum.h \
     ossignalconverter.h \
     ossignalconverter_p.h \
-    codasignalhandler.h
+    codasignalhandler.h \
+    texttracehandler.h
 
 DEFINES += SYMBIANUTILS_INCLUDE_PRI
 
diff --git a/tools/runonphone/symbianutils/codadevice.cpp b/tools/runonphone/symbianutils/codadevice.cpp
index 751f84e..f1f5db5 100644
--- a/tools/runonphone/symbianutils/codadevice.cpp
+++ b/tools/runonphone/symbianutils/codadevice.cpp
@@ -71,6 +71,7 @@ static const int maxSerialMessageLength = 0x10000; // given chunking scheme
 static const char validProtocolIdStart = (char)0x90;
 static const char validProtocolIdEnd = (char)0x95;
 static const char codaProtocolId = (char)0x92;
+static const char textTraceProtocolId = (char)0x02;
 static const unsigned char serialChunkingStart = 0xfe;
 static const unsigned char serialChunkingContinuation = 0x0;
 enum { SerialChunkHeaderSize = 2 };
@@ -495,7 +496,9 @@ QPair<int, int> CodaDevice::findSerialHeader(QByteArray &in)
             // Good packet
             const int length = trk::extractShort(in.constData() + 2);
             return QPair<int, int>(4, length);
-        } else if (in.at(0) == header1 && in.at(1) >= validProtocolIdStart && in.at(1) <= validProtocolIdEnd) {
+        } else if (in.at(0) == header1
+                    && (in.at(1) == textTraceProtocolId
+                        || (in.at(1) >= validProtocolIdStart && in.at(1) <= validProtocolIdEnd))) {
             // We recognise it but it's not a TCF message - emit it for any interested party to handle
             const int length = trk::extractShort(in.constData() + 2);
             if (4 + length <= in.size()) {
diff --git a/tools/runonphone/texttracehandler.cpp b/tools/runonphone/texttracehandler.cpp
new file mode 100644
index 0000000..fff02e9
--- /dev/null
+++ b/tools/runonphone/texttracehandler.cpp
@@ -0,0 +1,89 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QTextStream>
+#include "texttracehandler.h"
+#include "trkutils.h"
+
+class TextTraceHandlerPrivate
+{
+public:
+    TextTraceHandlerPrivate();
+    ~TextTraceHandlerPrivate();
+    QIODevice *device;
+    QTextStream out;
+};
+
+TextTraceHandlerPrivate::TextTraceHandlerPrivate()
+: out(stdout)
+{
+}
+
+TextTraceHandlerPrivate::~TextTraceHandlerPrivate()
+{
+    delete device;
+}
+
+TextTraceHandler::TextTraceHandler(QIODevice *device, QObject *parent)
+: QObject(parent)
+{
+    d = new TextTraceHandlerPrivate;
+    d->device = device;
+    connect(device, SIGNAL(readyRead()), this, SLOT(dataAvailable()));
+}
+
+TextTraceHandler::~TextTraceHandler()
+{
+    delete d;
+}
+
+void TextTraceHandler::dataAvailable()
+{
+    QByteArray result = d->device->readAll();
+    quint64 secs = 0;
+    quint64 ns = 0;
+    if (result.length() >= 8) {
+        quint64 timestamp = trk::extractInt64(result.constData()) & 0x0FFFFFFFFFFFFFFFULL;
+        secs = timestamp / 1000000000;
+        ns = timestamp % 1000000000;
+    }
+    d->out << QString("[%1.%2] %3").arg(secs).arg(ns).arg(QString(result.mid(8))) << endl;
+}
diff --git a/tools/runonphone/texttracehandler.h b/tools/runonphone/texttracehandler.h
new file mode 100644
index 0000000..2b9359c
--- /dev/null
+++ b/tools/runonphone/texttracehandler.h
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QObject>
+#include <QIODevice>
+
+class TextTraceHandlerPrivate;
+class TextTraceHandler : public QObject
+{
+    Q_OBJECT
+public:
+    TextTraceHandler(QIODevice *device, QObject *parent = 0);
+    ~TextTraceHandler();
+
+public slots:
+    void dataAvailable();
+private:
+    TextTraceHandlerPrivate *d;
+};