Add Freescale Nexus decoder implementation

[babeltrace.git] / converter / nexus / FManDebugLogVisitor.h

/*
 * Copyright (C) 2013 Freescale Semiconductor, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef FMANDEBUGLOGVISITOR_H
#define FMANDEBUGLOGVISITOR_H

#include <vector>
#include <string>
#include "NxMessageVisitor.h"

using std::vector;
using std::string;

class FManDebugLog;

class NxDefaultMessage;
class NxDebugStatusMessage;
class NxDeviceIDMessage;
class NxOwnershipTraceMessage;
class NxDataAcquisitionMessage;
class NxErrorMessage;
class NxProgramTraceSync;
class NxDataTraceWrite;
class NxDataTraceRead;
class NxDataTraceWriteSync;
class NxDataTraceReadSync;
class NxWatchpointMessage;
class NxResourceFullMessage;
class NxProgramTraceIndirectBranch;
class NxProgramTraceIndirectBranchSync;
class NxProgramTraceCorrelation;
class NxDAMInCircuitTraceMessage;
class NxCAMInCircuitTraceMessage;
class NxCDMInCircuitTraceMessage;
class NxDPQMInCircuitTraceMessage;
class NxDPFMInCircuitTraceMessage;
class NxCoreInCircuitTraceMessage;
class NxInCircuitTraceMessage;
class NxTimeStampCorrelation;

// Creates a detailed log for each FMan from the multiple
// ICT messages containing the context data.
class FManDebugLogVisitor: public NxMessageVisitor
{
public:

	FManDebugLogVisitor();
	virtual ~FManDebugLogVisitor();

	virtual void visit(NxDefaultMessage *m){useful_visit_ = false;}
	virtual void visit(NxDebugStatusMessage *m){useful_visit_ = false;}
	virtual void visit(NxDeviceIDMessage *m){useful_visit_ = false;}
	virtual void visit(NxOwnershipTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxDataAcquisitionMessage *m){useful_visit_ = false;}
	virtual void visit(NxErrorMessage *m){useful_visit_ = false;}
	virtual void visit(NxProgramTraceSync *m){useful_visit_ = false;}
	virtual void visit(NxDataTraceWrite *m){useful_visit_ = false;}
	virtual void visit(NxDataTraceRead *m){useful_visit_ = false;}
	virtual void visit(NxDataTraceWriteSync *m){useful_visit_ = false;}
	virtual void visit(NxDataTraceReadSync *m){useful_visit_ = false;}
	virtual void visit(NxWatchpointMessage *m){useful_visit_ = false;}
	virtual void visit(NxResourceFullMessage *m){useful_visit_ = false;}
	virtual void visit(NxProgramTraceIndirectBranch *m){useful_visit_ = false;}
	virtual void visit(NxProgramTraceIndirectBranchSync *m){useful_visit_ = false;}
	virtual void visit(NxProgramTraceCorrelation *m){useful_visit_ = false;}
	virtual void visit(NxDAMInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxCAMInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxCDMInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxDPQMInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxCoreInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxInCircuitTraceMessage *m){useful_visit_ = false;}
	virtual void visit(NxTimeStampCorrelation *m){useful_visit_ = false;}

	// implement the specific visit
	virtual void visit(NxDPFMInCircuitTraceMessage *m);

	// output message information as a string
	virtual string asString() const;

private:

	// define the number of concurrent FMAN logs
	static const int MAX_FMAN_LOGS = 2;

	// FMan specific logs
	FManDebugLog* log_[MAX_FMAN_LOGS];

	// true if log is already reported via asString()
	mutable bool already_reported_[MAX_FMAN_LOGS];
};

#endif // FMANDEBUGLOGVISITOR_H