JtagAnalyzer.cpp

/*
 * jtaglogic
 *
 * Copyright (C) 2013-2014 Fredrik Ahlberg
 *
 * 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 2 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "JtagAnalyzer.h"
#include "JtagAnalyzerSettings.h"
#include <AnalyzerChannelData.h>

#include "JtagPlainAnalyzer.h"
#include "JtagAvrAnalyzer.h"
#include "JtagArmAnalyzer.h"
 
JtagInnerAnalyzer::~JtagInnerAnalyzer()
{
}

JtagAnalyzer::JtagAnalyzer()
:	Analyzer2(),
	mSettings(new JtagAnalyzerSettings()),
	mSimulationInitilized(false),
	mTCK(NULL),
	mTMS(NULL),
	mTDI(NULL),
	mTDO(NULL),
        mTRST(NULL)
{	
	SetAnalyzerSettings(mSettings.get());
}

JtagAnalyzer::~JtagAnalyzer()
{
	KillThread();
}

void JtagAnalyzer::SetupResults()
{
	mResults.reset(new JtagAnalyzerResults(this, mSettings.get()));
	SetAnalyzerResults(mResults.get());

	mResults->AddChannelBubblesWillAppearOn(mSettings->mTMSChannel);
	mResults->AddChannelBubblesWillAppearOn(mSettings->mTDIChannel);
	mResults->AddChannelBubblesWillAppearOn(mSettings->mTDOChannel);
}

void JtagAnalyzer::WorkerThread()
{
	Setup();

	mState = JtagReset;
	mFirstSample = mTCK->GetSampleNumber();
	mDataIn = mDataOut = 0;
	mBits = 0;

	if (mTCK->GetBitState() != 0) {
		mTCK->AdvanceToNextEdge();
	}

	for ( ; ; ) {
		mTCK->AdvanceToNextEdge();
		mCurrentSample = mTCK->GetSampleNumber();

		ProcessStep();

		mTCK->AdvanceToNextEdge();

		CheckIfThreadShouldExit();
	}

	delete mInnerAnalyzer;
}

void JtagAnalyzer::Setup()
{
	mTCK = GetAnalyzerChannelData(mSettings->mTCKChannel);
	mTMS = GetAnalyzerChannelData(mSettings->mTMSChannel);
	mTDI = GetAnalyzerChannelData(mSettings->mTDIChannel);
	mTDO = GetAnalyzerChannelData(mSettings->mTDOChannel);

	if (mSettings->mTRSTChannel != UNDEFINED_CHANNEL) {
		mTRST = GetAnalyzerChannelData(mSettings->mTRSTChannel);
	} else {
		mTRST = NULL;
	}

	switch (mSettings->mInnerProto) {
	case InnerPlain:
		mInnerAnalyzer = new JtagPlainAnalyzer(mSettings.get());
		break;

	case InnerAVR:
		mInnerAnalyzer = new JtagAvrAnalyzer(mSettings.get());
		break;

	case InnerARM:
		mInnerAnalyzer = new JtagArmAnalyzer(mSettings.get());
		break;
	}
}

void JtagAnalyzer::ProcessStep()
{
	mTMS->AdvanceToAbsPosition(mCurrentSample);
	mTDI->AdvanceToAbsPosition(mCurrentSample);
	mTDO->AdvanceToAbsPosition(mCurrentSample);

	mResults->AddMarker(mCurrentSample, AnalyzerResults::UpArrow, mSettings->mTCKChannel);

	// Fetch data
	if (mState == JtagShiftDR || mState == JtagShiftIR) {
		mDataIn = (mDataIn << 1) | (mTDI->GetBitState() ? 1 : 0);
		mDataOut = (mDataOut << 1) | (mTDO->GetBitState() ? 1 : 0);
		mBits++;

		mResults->AddMarker(mCurrentSample, AnalyzerResults::Dot, mSettings->mTDIChannel);
		mResults->AddMarker(mCurrentSample, AnalyzerResults::Dot, mSettings->mTDOChannel);
	}
    
	// Update JTAG state machine
	enum JtagState next_state = mState;
	bool tms = mTMS->GetBitState();

	switch (mState) {
	case JtagReset:
		next_state = tms ? JtagReset : JtagIdle;
		break;

	case JtagIdle:
		next_state = tms ? JtagSelectDR : JtagIdle;
		break;

	case JtagSelectDR:
		next_state = tms ? JtagSelectIR : JtagCaptureDR;
		break;

	case JtagCaptureDR:
		next_state = tms ? JtagExit1DR : JtagShiftDR;
		break;

	case JtagShiftDR:
		next_state = tms ? JtagExit1DR : JtagShiftDR;
		break;

	case JtagExit1DR:
		next_state = tms ? JtagUpdateDR : JtagPauseDR;
		break;

	case JtagPauseDR:
		next_state = tms ? JtagExit2DR : JtagPauseDR;
		break;

	case JtagExit2DR:
		next_state = tms ? JtagUpdateDR : JtagShiftDR;
		break;

	case JtagUpdateDR:
		next_state = tms ? JtagSelectDR : JtagIdle;
		break;

	case JtagSelectIR:
		next_state = tms ? JtagReset : JtagCaptureIR;
		break;

	case JtagCaptureIR:
		next_state = tms ? JtagExit1IR : JtagShiftIR;
		break;

	case JtagShiftIR:
		next_state = tms ? JtagExit1IR : JtagShiftIR;
		break;

	case JtagExit1IR:
		next_state = tms ? JtagUpdateIR : JtagPauseIR;
		break;

	case JtagPauseIR:
		next_state = tms ? JtagExit2IR : JtagPauseIR;
		break;

	case JtagExit2IR:
		next_state = tms ? JtagUpdateIR : JtagShiftIR;
		break;

	case JtagUpdateIR:
		next_state = tms ? JtagSelectDR : JtagIdle;
		break;
	}

	if (next_state != mState) {
		// transition. yay. flush the current transaction.

		mInnerAnalyzer->process(mState, mDataIn, mDataOut, mBits,
				mFirstSample, mTCK->GetSampleNumber(), mResults.get());

		mFirstSample = mTCK->GetSampleNumber();
		mState = next_state;
		mDataIn = mDataOut = 0;
		mBits = 0;
	}
}

// Register contents are shifted LSB first, so this
// helper flips the words for us.
U64 JtagAnalyzer::FlipWord(U64 word, U32 bits)
{
	U64 result = 0;

	for (int idx=0; idx<bits; idx++) {
		if (word & (1ULL << idx)) {
			result |= (1ULL << (bits-idx-1));
		}
	}

	return result;
}

bool JtagAnalyzer::NeedsRerun()
{
	return false;
}

U32 JtagAnalyzer::GenerateSimulationData( U64 minimum_sample_index, U32 device_sample_rate, SimulationChannelDescriptor** simulation_channels )
{
	if (mSimulationInitilized == false) {
		mSimulationDataGenerator.Initialize(GetSimulationSampleRate(), mSettings.get());
		mSimulationInitilized = true;
	}

	return mSimulationDataGenerator.GenerateSimulationData(minimum_sample_index, device_sample_rate, simulation_channels);
}


U32 JtagAnalyzer::GetMinimumSampleRateHz()
{
	return 10000; //we don't have any idea, depends on the JTAG TCK rate, etc.; return the lowest rate.
}

const char* JtagAnalyzer::GetAnalyzerName() const
{
	return "JTAG";
}

const char* GetAnalyzerName()
{
	return "JTAG";
}

Analyzer* CreateAnalyzer()
{
	return new JtagAnalyzer();
}

void DestroyAnalyzer(Analyzer* analyzer)
{
	delete analyzer;
}