rtl_flash_handler.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
/*
 * File         rtl_flash_handler.h
 * Revision     $Revision: 40069 $
 * Description  Super class for Radio Test Library to interface flash
 *              actions supported by FPL.
 *
// ##### LICENSE HEADER #####
 *
 */
 //-----------------------------------------------------------------------------


#ifndef RTLFLASHHANDLER_H
#define RTLFLASHHANDLER_H

#include <QtCore>

#include "fpl_common.h"

#define DONT_CHANGE_TEST_STATE false

class RTLDevice;
class FPLEbDevice;
class FPLTargetDevice;
class XbalEb;

typedef enum 
{
    ET_ERASE_ALL,               
    ET_ERASE_ALL_FORCED,        
    ET_ERASE_PAGE_RANGE,        
    ET_ERASE_PAGES_IN_SOURCE,   
} RTL_ERASE_TYPE;

typedef enum 
{
    PT_PROGRAM_PAGES_IN_SOURCE,           
    PT_PROGRAM_EXLUDE_PAGES,              
    PT_PROGRAM_EXLUDE_PAGES_FILLED_WITH,  
} RTL_PROGRAM_TYPE;

//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
typedef struct 
{
    RTL_ERASE_TYPE type;
    QString    parameters;
} EraseInfo_t;

//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
typedef struct {
    RTL_PROGRAM_TYPE type;
    QString      parameters;
} ProgramInfo_t;

typedef enum 
{
    CM3_CPU_REG_R0 = 512,             
    CM3_CPU_REG_R1 = 1 + 512,         
    CM3_CPU_REG_R2 = 2 + 512,         
    CM3_CPU_REG_R3 = 3 + 512,         
    CM3_CPU_REG_R4 = 4 + 512,         
    CM3_CPU_REG_R5 = 5 + 512,         
    CM3_CPU_REG_R6 = 6 + 512,         
    CM3_CPU_REG_R7 = 7 + 512,         
    CM3_CPU_REG_R8 = 8 + 512,         
    CM3_CPU_REG_R9 = 9 + 512,         
    CM3_CPU_REG_R10 = 10 + 512,         
    CM3_CPU_REG_R11 = 11 + 512,         
    CM3_CPU_REG_R12 = 12 + 512,         
    CM3_CPU_REG_R13 = 13 + 512,         
    CM3_CPU_REG_R14 = 14 + 512,         
    CM3_CPU_REG_R15 = 15 + 512,         
    CM3_CPU_REG_R13MSP = 17 + 512,      
} CM3_CPU_REGISTERS;

class RTLFlashHandler
{

public:
    RTLFlashHandler(const QString &devName, const QString &devId, XbalEb *pXbalEb, RTLDevice *pParent = NULL);
    virtual ~RTLFlashHandler(void);

    virtual int         eraseFlash(EraseInfo_t *pEraseInfo = NULL, FPLFile *pFile = NULL);
    virtual int         programFlash(FPLFile *pFplFile, ProgramInfo_t *pProgInfo = NULL);
    virtual int         programFlash(const quint32 &address, const quint32 &length, quint8 *pBuffer);
    virtual FPLFile    *readFile(const QString &fileName, const quint32 &startAddress = 0);
    virtual int         readMemory(const quint32 &address, quint32 *pLength, quint8 *pBuffer);
    virtual int         resetTarget(RESET_MODE mode);
    virtual int         verifyFlash(FPLFile *pFplFile, ProgramInfo_t *pProgInfo = NULL);
    virtual int         writeMemory(const quint32 &address, const quint32 &length, quint8 *pBuffer);
    virtual int         runCpu(bool debugMode);
    virtual int         haltCpu(void);
    virtual int         writeCpuReg(const CM3_CPU_REGISTERS &regNumber, const uint32_t &value);
    virtual int         readCpuReg(const CM3_CPU_REGISTERS &regNumber, uint32_t *pValue);

    static int  deleteFileObject(FPLFile *pFplFile);
    static void initEraseInfo(EraseInfo_t *pEraseInfo);
    static void initProgramInfo(ProgramInfo_t *pProgInfo);

protected:
    QString normDeviceNameForFpl(const QString rfDevName);

private:
    QString         m_deviceId;
    QString         m_deviceName;
    FPLEbDevice     *m_pFplEbDevice;
    FPLTargetDevice *m_pFplTargetDevice;
    RTLDevice       *m_pRTLDevice;

    int createFplTargetDevice(XbalEb *pXbalEb);
    int setTargetInfo(TargetInfo_t *pTargetInfo);
    int setError(const QString &text);
};

#endif