fome-fw/firmware/development/perf_trace.h

#pragma once

#include <cstdint>

// Defines different events we want to trace.  These can be an interval (begin -> end), or an
// instant.  Instants can be global, or specific to one thread.  You probably don't want to use
// each element in PE more than once, as they should each indicate that a specific thing began,
// ended, or occured.
enum class PE : uint8_t {
	ISR,
	Idle,
	ContextSwitch,
	OutputPinSetValue,
	DecodeTriggerEvent,
	EnginePeriodicFastCallback,
	EnginePeriodicSlowCallback,
	EngineStatePeriodicFastCallback,
	HandleShaftSignal,
	EventQueueInsertTask,
	EventQueueExecuteAll,
	SingleTimerExecutorDoExecute,
	SingleTimerExecutorScheduleTimerCallback,
	PeriodicControllerPeriodicTask,
	PeriodicTimerControllerPeriodicTask,
	AdcCallbackFast,
	AdcCallbackSlow,
	AdcConversionSlow,
	AdcConversionFast,
	AdcSubscriptionUpdateSubscribers,
};

void perfEventBegin(PE event, uint8_t data);
void perfEventEnd(PE event, uint8_t data);
void perfEventInstantThread(PE event, uint8_t data);
void perfEventInstantGlobal(PE event, uint8_t data);

inline void perfEventBegin(PE event) {
	perfEventBegin(event, 0);
}

inline void perfEventEnd(PE event) {
	perfEventEnd(event, 0);
}

inline void perfEventInstantThread(PE event) {
	perfEventInstantThread(event, 0);
}

inline void perfEventInstantGlobal(PE event) {
	perfEventInstantGlobal(event, 0);
}


class ScopePerf
{
public:
	ScopePerf(PE event) : ScopePerf(event, 0) {}

	ScopePerf(PE event, uint8_t data) : m_event(event)
	{
		perfEventBegin(event, data);
	}

	~ScopePerf()
	{
		perfEventEnd(m_event, 0);
	}

private:
	const PE m_event;
};