rtl_device.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
/*
 * File         rtl_device.h
 * Revision     $Revision$
 * Description  Super class for Radio Test Library of device classes in DAL.
 *
// ##### LICENSE HEADER #####
 *
 */
 //-----------------------------------------------------------------------------


#ifndef RTLDEVICE_H
#define RTLDEVICE_H

#include <QtCore>

#include "rtl_flash_handler.h"

#define DONT_CHANGE_TEST_STATE false

class DALEbDevice;
class DALRfDevice;
class RTLFlashHandler;

typedef void(*_STATUS_FUNC_PTR)(char *pText, bool error);
typedef void(*_PROGRESS_FUNC_PTR)(int percentage);

class RTLDevice
{

public:

    typedef enum
    {
        TM_CONT_TX,
        TM_CONT_RX,
        TM_PACKET_TX,
        TM_PACKET_RX
    } TEST_MODE;

    typedef enum
    {
        TST_OK,
        TST_FAILED,
        TST_PKT_RECEIVED,
        TST_PKT_RX_BUF_OVERFLOW,
        TST_UNKNOWN,
    } TEST_RESULT;

    typedef enum
    {
        STATE_DAL,
        STATE_FPL
    } TEST_STATE;

    typedef struct
    {
        QString deviceId;
        int     fwUpdateReq;
    } DeviceInfo_t;

    typedef struct
    {
        TEST_MODE   testMode;
        QString     qsCategory;
        QString     qsSetting;
        QString     qsTargetName;
    } TestConfig_t;

    typedef struct
    {
        TEST_RESULT result;
        double      value;
        int         rssi;
        double      freqOff;
        QString     qsError;
    } TestResult_t;


    typedef struct
    {
        char* pData;
        int   maxLength;
        int   rssi;
        bool  crcOk;
    } PacketData_t;

    RTLDevice(void);
    virtual ~RTLDevice(void);

    virtual int         addDynamicOverride(const QString &devId, const QString &type, const QString &value, const QString &id) = 0;
    virtual int         removeDynamicOverride(const QString &devId, const QString &id) = 0;
    virtual void        appendError(const QString &error);
    virtual void        clearAllErrors(void);
    virtual int         connect(const QString rfDevName, const QString &devId);
    virtual int         deleteFileObject(FPLFile *pFplFile);
    virtual int         disconnect(const QString &devId);
    virtual int         doLinkTest(const QString &txId, const QString &rxId, TestResult_t *pTestResult) = 0;
    virtual QStringList enumerateEbs(bool enableXdsDev = false);
    virtual QString     getRfDevNameFromDevId(const QString devId);
    virtual int         eraseFlash(const QString &devName, const QString &devId, EraseInfo_t *pEraseInfo = NULL, FPLFile *pFile = NULL) = 0;
    virtual int         executeCmd(const QString &devId, const QString &cmdName);
    virtual int         getAverageRssi(void) { return m_averageRssi; };
    virtual QString     getLastError(void);
    virtual QString     getRfState(const QString &devId);
    virtual int         getRssi(const QString &devId, QString *pRssiInDbm, QString *pRssiRaw);
    virtual int         initPacketTx(const QString rfDevName, const QString &devId);
    virtual bool        isConnected(const QString &devId) { return m_mapConDevices.contains(devId); };
    virtual int         isPacketReceived(const QString rfDevName, const QString &devId);
    virtual int         programFlash(const QString &devName, const QString &devId, FPLFile *pFplFile, ProgramInfo_t *pProgInfo = NULL) = 0;
    virtual int         programFlash(const QString &devName, const QString &devId,
                                     const quint32 &address, const quint32 &length, quint8 *pBuffer) = 0;
    virtual int         readCmdSettingsFromFile(const QString &devId, TestConfig_t &testConfig) = 0;
    virtual FPLFile    *readFile(const QString &devName, const QString &devId, const QString &fileName, const quint32 &startAddress = 0);
    virtual int         readFrequencyOffset(const QString &devId, TestResult_t *pTestResult) { pTestResult->qsError = QString("Function not supported. devId = %1").arg(devId); return 0; }
    virtual int         readFrequencyOffsetCW(const QString &devId, TestResult_t *pTestResult) { pTestResult->qsError = QString("Function not supported. devId = %1").arg(devId); return 0; };
    virtual int         readPacket(const QString rfDevName, const QString &devId, PacketData_t *pPacketData);
    virtual int         readMcuReg(const QString &devId, const quint32 &address, quint32 *pValue) = 0;
    virtual int         readMemory(const QString &devName, const QString &devId,
                                   const quint32 &address, quint32 *pLength, quint8 *pBuffer) = 0;
    virtual int         readRfReg(const QString &devId, const quint32 &address, quint32 *pValue) = 0;
    virtual int         resetTarget(const QString rfDevName, const QString &devId, RESET_MODE mode);
    virtual int         sendPacket(const QString rfDevName, const QString &devId);
    virtual int         setParameter(const QString &devId, const QString &parName, const QString &parValue);
    virtual void        setPacketData(char *pPayload, int len);
    virtual int         setPacketInterval(const QString &devId, const int &interval);
    virtual void        setNbrOfPackets(int n) { m_nbrOfPackets = n; }
    virtual int         setIdle(const QString rfDevName, const QString &devId);
    virtual int         startContTx(const QString rfDevName, const QString &devId, TestResult_t *pTestResult);
    virtual int         startContRx(const QString rfDevName, const QString &devId, TestResult_t *pTestResult);
    virtual int         startPacketRx(const QString rfDevName, const QString &devId);
    virtual int         verifyFlash(const QString &devName, const QString &devId, FPLFile *pFplFile, ProgramInfo_t *pProgInfo = NULL) = 0;
    virtual int         writeMcuReg(const QString &devId, const quint32 &address, const quint32 &value) = 0;
    virtual int         writeMemory(const QString &devName, const QString &devId,
                                    const quint32 &address, const quint32 &length, quint8 *pBuffer) = 0;
    virtual int         writeRfReg(const QString &devId, const quint32 &address, const quint32 &value) = 0;
    virtual int         runCpu(const QString &devName, const QString &devId, bool debugMode) = 0;
    virtual int         haltCpu(const QString &devName, const QString &devId) = 0;
    virtual int         writeCpuReg(const QString &devName, const QString &devId,
                                    const CM3_CPU_REGISTERS &regNumber, const uint32_t &value) = 0;
    virtual int         readCpuReg(const QString &devName, const QString &devId,
                                   const CM3_CPU_REGISTERS &regNumber, uint32_t *pValue) = 0;
    virtual int         setCapArrayDelta(const QString &devId, const qint16 &value) = 0;

    static void initEraseInfo(EraseInfo_t *pEraseInfo) { RTLFlashHandler::initEraseInfo(pEraseInfo); };
    static void initProgramInfo(ProgramInfo_t *pProgInfo) { RTLFlashHandler::initProgramInfo(pProgInfo); };
    static void setCallBackProgressFunction(_PROGRESS_FUNC_PTR pPf) { sm_pProgressFunction = pPf; }

protected:
    int        m_averageRssi;
    QByteArray m_packetData;
    int        m_nbrOfPackets;
    QList<DeviceInfo_t> m_ebList;
    QMap<QString, DALEbDevice *> m_mapConDevices;
    QMultiMap<char, int> m_mapFreqOffset;
    static _PROGRESS_FUNC_PTR   sm_pProgressFunction;
    QMap<QString, RTLFlashHandler *> m_mapFlashHandlers;

    QString normDeviceName(const QString &rfDevName);
    virtual int initDALApi(const QString &devId) = 0;
    RTLFlashHandler *getFlashHandler(const QString &devName, const QString &devId);
    bool fwUpdateRequired(const QString &devId);

private:
    QString m_qsEmpty;
    QStringList m_lstOfErrors;
    //A map between device id and device RF name. This is useful for tests that connect with device RF name.
    QMap<QString, QString> m_devIdToRfName;
};

#endif