Debug flow for the DCC decoder driver. More...

#include <DccDebugFlow.hxx>

Inheritance diagram for openlcb::DccDebugDecodeFlow:

Public Member Functions
	DccDebugDecodeFlow (Service service, const char path)

Public Member Functions inherited from dcc::DccDecodeFlow
	DccDecodeFlow (Service s, const char dev)

Public Member Functions inherited from StateFlowBase
void	run () override
	Callback from the executor.

void	notify () override
	Wakeup call arrived.

Service *	service ()
	Return a pointer to the service I am bound to.

Public Member Functions inherited from Executable
void	test_deletion ()

Public Member Functions inherited from QMember
void	init ()
	Initiailize a QMember, in place of a public placement construction.

Private Member Functions
void	dcc_packet_finished (const uint8_t *payload, size_t len) override

void	mm_packet_finished (const uint8_t *payload, size_t len) override

void	debug_data (uint32_t value) override

void	log (uint8_t value)

Private Attributes
uint8_t	dbuffer [1024]

uint16_t	ptr = 0

Additional Inherited Members
Static Public Member Functions inherited from StateFlowBase
template<class T , typename... Args>
static void	invoke_subflow_and_ignore_result (FlowInterface< Buffer< T > > *target_flow, Args &&... args)
	Calls a helper flow to perform some actions.

Protected Types inherited from StateFlowBase
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.

Protected Member Functions inherited from StateFlowBase
	StateFlowBase (Service *service)
	Constructor.

	~StateFlowBase ()
	Destructor.

void	reset_flow (Callback c)
	Resets the flow to the specified state.

bool	is_state (Callback c)

bool	is_terminated ()

void	start_flow (Callback c)
	Resets the flow to the specified state and starts it.

Action	again ()
	Call the current state again via call_immediately.

Action	exit ()
	Terminate current StateFlow activity.

Action	delete_this ()
	Terminates the flow and deletes *this.

Action	set_terminated ()
	Sets the flow to terminated state.

Action	call_immediately (Callback c)
	Imediately call the next state upon return.

Action	wait ()
	Wait for an asynchronous call.

Action	wait_and_call (Callback c)
	Wait for resource to become available before proceeding to next state.

template<class T >
Action	allocate_and_call (FlowInterface< Buffer< T > > target_flow, Callback c, Pool pool=nullptr)
	Allocates a buffer from a pool and proceed to the next state when allocation is successful.

Action	allocate_and_call (Callback c, QAsync *queue)
	Allocates an entry from an asynchronous queue, and transitions to a state once the allocation is complete.

template<class T >
Buffer< T > *	full_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation without resetting the object.

template<class T >
T *	full_allocation_result (TypedQAsync< T > *queue)
	Takes the result of the asynchronous allocation without resetting the object.

template<class T >
void	cast_allocation_result (T **member)
	Takes the result of the asynchronous allocation without resetting the object.

template<class T >
Buffer< T > *	get_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation.

Action	yield_and_call (Callback c)
	Place the current flow to the back of the executor, and transition to a new state after we get the CPU again.

Action	yield ()
	Place the current flow to the back of the executor, and re-try the current state after we get the CPU again.

Action	sleep_and_call (::Timer *timer, long long timeout_nsec, Callback c)
	Suspends execution of this control flow for a specified time.

template<class T , typename... Args>
Action	invoke_subflow_and_wait (FlowInterface< Buffer< T > > *target_flow, Callback c, Args &&... args)
	Calls a helper flow to perform some actions.

Action	read_repeated (StateFlowSelectHelper helper, int fd, void buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read and then invokes the next state.

Action	read_single (StateFlowSelectHelper helper, int fd, void buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size_t bytes, and blocks the caller until at least one byte is read.

Action	read_nonblocking (StateFlowSelectHelper helper, int fd, void buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size bytes, and then invokes the next state, even if only zero bytes are available right now.

Action	read_repeated_with_timeout (StateFlowTimedSelectHelper helper, long long timeout_nsec, int fd, void buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read, or a timeout expires.

Action	internal_try_read ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on reading.

Action	write_repeated (StateFlowSelectHelper helper, int fd, const void buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Writes some data into a file descriptor, repeating the operation as necessary until all bytes are written.

Action	internal_try_write ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on writing.

Protected Member Functions inherited from QMember
	QMember ()
	Constructor.

	~QMember ()
	Destructor.

Protected Attributes inherited from dcc::DccDecodeFlow
DCCPacket	pkt_
	Packet buffer.

DccDecoder	decoder_ {1}
	State machine that does the DCC decoding.

Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue

Detailed Description

Debug flow for the DCC decoder driver.

The flow stores all captured timing information in an inmemory ring buffer, and takes all captured DCC and MM packets and forwards them to the g_packet_debug_flow to be put onto the OpenLCB bus.

Definition at line 79 of file DccDebugFlow.hxx.

Constructor & Destructor Documentation

◆ DccDebugDecodeFlow()

openlcb::DccDebugDecodeFlow::DccDebugDecodeFlow	(	Service *	service,
		const char *	path
	)

inline

Definition at line 81 of file DccDebugFlow.hxx.

Member Function Documentation

◆ dcc_packet_finished()

void openlcb::DccDebugDecodeFlow::dcc_packet_finished	(	const uint8_t *	payload,
		size_t	len
	)

inlineoverrideprivatevirtual

Implements dcc::DccDecodeFlow.

Definition at line 84 of file DccDebugFlow.hxx.

◆ debug_data()

void openlcb::DccDebugDecodeFlow::debug_data ( uint32_t value )

inlineoverrideprivatevirtual

Reimplemented from dcc::DccDecodeFlow.

Definition at line 99 of file DccDebugFlow.hxx.

◆ log()

void openlcb::DccDebugDecodeFlow::log ( uint8_t value )

inlineprivate

Definition at line 105 of file DccDebugFlow.hxx.

◆ mm_packet_finished()

void openlcb::DccDebugDecodeFlow::mm_packet_finished	(	const uint8_t *	payload,
		size_t	len
	)

inlineoverrideprivatevirtual

Implements dcc::DccDecodeFlow.

Definition at line 91 of file DccDebugFlow.hxx.

Member Data Documentation

◆ dbuffer

uint8_t openlcb::DccDebugDecodeFlow::dbuffer[1024]

private

Definition at line 110 of file DccDebugFlow.hxx.

◆ ptr

uint16_t openlcb::DccDebugDecodeFlow::ptr = 0

private

Definition at line 111 of file DccDebugFlow.hxx.

The documentation for this class was generated from the following file:

DccDebugFlow.hxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DccDebugDecodeFlow()

Member Function Documentation

◆ dcc_packet_finished()

◆ debug_data()

◆ log()

◆ mm_packet_finished()

Member Data Documentation

◆ dbuffer

◆ ptr