CDR8B10BTrigger Class Reference

A hardware 8B/10B pattern trigger. More...

#include <CDR8B10BTrigger.h>

Inheritance diagram for CDR8B10BTrigger:

Collaboration diagram for CDR8B10BTrigger:

Public Types
enum	PatternMode { PATTERN_SEQUENCE , PATTERN_LIST }
	Type of pattern to look for. More...
enum	MatchMode { MATCH_INCLUDE , MATCH_EXCLUDE }
	Trigger on matched or unmatched data. More...
Public Types inherited from CDRTrigger
enum	LeCroyEqualizerMode { LECROY_EQ_NONE , LECROY_EQ_LOW , LECROY_EQ_MEDIUM , LECROY_EQ_HIGH }
	RX equalizer settings for LeCroy SDA 8Zi GTX trigger board. More...
enum	TriggerPosition { POSITION_END , POSITION_START }
	Where to position the reported trigger point, relative to the serial bit pattern. More...
enum	Polarity { POLARITY_NORMAL , POLARITY_INVERTED }
	Polarity inversion for the input. More...
Public Types inherited from Trigger
enum	Condition {   CONDITION_EQUAL , CONDITION_NOT_EQUAL , CONDITION_LESS , CONDITION_LESS_OR_EQUAL ,   CONDITION_GREATER , CONDITION_GREATER_OR_EQUAL , CONDITION_BETWEEN , CONDITION_NOT_BETWEEN ,   CONDITION_ANY }
	Conditions for triggers that perform logical comparisons of values. More...
typedef Trigger *(*	CreateProcType) (Oscilloscope *)
Public Types inherited from FlowGraphNode
enum class	ExecutionCapabilities {   None = 0 , CommandBufferAppend = 1 , CommandBufferTailCall = 2 , VulkanOnly = 4 ,   DynamicShader = 8 }
typedef std::map< std::string, FilterParameter >	ParameterMapType
	Short name for a map of strings to parameters.

Public Member Functions
	CDR8B10BTrigger (Oscilloscope *scope)
	Create a new 8B/10B trigger.
	TRIGGER_INITPROC (CDR8B10BTrigger)
void	SetMatchMode (MatchMode mode)
	Sets whether to trigger on pattern match or pattern not found.
MatchMode	GetMatchMode ()
	Get the match mode.
void	SetPatternMode (PatternMode mode)
	Sets the type of pattern to look for.
PatternMode	GetPatternMode ()
	Gets the type of pattern being searched for.
void	SetSymbolCount (size_t count)
	Sets the length of the serial pattern, or size of the set of symbols to match.
size_t	GetSymbolCount ()
	Gets the length of the serial pattern or size of the symbol set.
std::vector< T8B10BSymbol >	GetPattern ()
	Gets the pattern or list of symbols to match.
void	SetPattern (const std::vector< T8B10BSymbol > &pattern)
	Sets the pattern or list of symbols to match.
Public Member Functions inherited from CDRTrigger
	CDRTrigger (Oscilloscope *scope)
	Creates a new CDR trigger.
virtual bool	ValidateChannel (size_t i, StreamDescriptor stream)
	Check if a stream is allowed to be connected to the given input.
void	SetBitRate (int64_t rate)
	Sets the nominal baud rate the PLL should attempt to lock to.
int64_t	GetBitRate ()
	Returns the nominal CDR PLL data rate.
void	CalculateBitRate ()
	Automatically calculates the bit rate of the incoming signal, if possible.
sigc::signal< void()>	signal_calculateBitRate ()
	Signal emitted every time autobaud is requested.
bool	IsAutomaticBitRateCalculationAvailable ()
	Checks if automatic bit rate calculation is available.
bool	IsCDRLocked ()
	Queries hardware PLL lock status.
TriggerPosition	GetTriggerPosition ()
	Gets the position of the trigger, relative to the serial bit pattern.
void	SetTriggerPosition (TriggerPosition p)
	Sets the position of the trigger, relative to the serial bit pattern.
LeCroyEqualizerMode	GetEqualizerMode ()
	Gets the RX equalizer mode.
void	SetEqualizerMode (LeCroyEqualizerMode mode)
	Sets the RX equalizer mode.
Polarity	GetPolarity ()
	Gets the polarity inversion.
void	SetPolarity (Polarity mode)
	Gets the polarity inversion.
Public Member Functions inherited from Trigger
	Trigger (Oscilloscope *scope)
	Initialize a new trigger.
virtual void	Refresh (vk::raii::CommandBuffer &cmdBuf, std::shared_ptr< QueueHandle > queue) override
float	GetLevel ()
	Get the trigger level.
float	GetUpperLevel ()
void	SetLevel (float level)
	Sets the trigger level.
void	SetUpperLevel (float level)
Oscilloscope *	GetScope ()
	Gets the scope this trigger is attached to.
virtual std::string	GetTriggerDisplayName ()=0
virtual YAML::Node	SerializeConfiguration (IDTable &table) override
	Serializes this trigger's configuration to a YAML string.
Public Member Functions inherited from FlowGraphNode
void	DetachInputs ()
	Disconnects all inputs from the node without releasing them.
size_t	GetInputCount ()
	Get the number of input ports.
std::string	GetInputName (size_t i)
void	SetInput (size_t i, StreamDescriptor stream, bool force=false)
	Connects a stream to the input of this node.
void	SetInput (const std::string &name, StreamDescriptor stream, bool force=false)
bool	HasInput (StreamDescriptor desc)
	Checks if the given stream is connected to at least one of our inputs.
StreamDescriptor	GetInput (size_t i)
	Gets the descriptor for one of our inputs.
std::shared_ptr< InputConstraint >	GetInputConstraints (size_t i)
	Get the constraints on one of our inputs.
FilterParameter &	GetParameter (std::string s)
bool	HasParameter (std::string s)
	Checks if we have a parameter with a given name.
ParameterMapType::iterator	GetParamBegin ()
	Returns an iterator to the beginning of our parameter map.
ParameterMapType::iterator	GetParamEnd ()
	Returns an iterator to the end of our parameter map.
size_t	GetParamCount ()
	Returns the number of parameter we have.
virtual void	LoadParameters (const YAML::Node &node, IDTable &table)
	Load configuration from a save file.
virtual void	LoadInputs (const YAML::Node &node, IDTable &table)
bool	IsDownstreamOf (std::set< FlowGraphNode * > nodes)
	Determines if this node is downstream of any of the specified other nodes.
virtual uint32_t	GetExecutionCapabilitiesMask ()
	Returns a bitmask of ExecutionCapabilities fields.
bool	HasMessages () const
	Checks if this graph has any messages.
const std::vector< FlowGraphNodeMessage > &	GetMessages () const
	Walking through any messages.
const FlowGraphNodeMessage *	GetMostSevereMessage () const
void	AddSink (size_t stream, FlowGraphNode *node)
void	RemoveSink (size_t stream, FlowGraphNode *node)
const std::set< FlowGraphNode * > &	GetSinks (size_t stream)
sigc::signal< void()>	signal_parametersChanged ()
sigc::signal< void()>	signal_inputsChanged ()

Static Public Member Functions
static std::string	GetTriggerName ()
Static Public Member Functions inherited from Trigger
static void	DoAddTriggerClass (std::string name, CreateProcType proc)
	Register a new trigger class for dynamic creation.
static void	EnumTriggers (std::vector< std::string > &names)
	Gets a list of all registered trigger types.
static Trigger *	CreateTrigger (std::string name, Oscilloscope *scope)
	Creates a new trigger for an oscilloscope.

Protected Member Functions
void	OnLengthChanged ()
	Handles a change to the pattern length by creating/destroying symbol fields.
void	OnModeChanged ()
	Handles a change to the match mode by changing the max allowed pattern length.
Protected Member Functions inherited from FlowGraphNode
virtual void	OnInputChanged (size_t i)
	Called when a new input is connected to the node.
WaveformBase *	GetInputWaveform (size_t i)
	Gets the waveform attached to the specified input.
SparseAnalogWaveform *	GetSparseAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.
UniformAnalogWaveform *	GetUniformAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.
SparseDigitalWaveform *	GetSparseDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.
UniformDigitalWaveform *	GetUniformDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.
virtual void	CreateInput (const std::string &name)
	Gets the digital bus waveform attached to the specified input.
template<class T , class... Args>
void	CreateInput (const std::string &name, Args &&... args)
std::string	GetInputDisplayName (size_t i)
	Gets the display name for one of our inputs.
void	ClearMessages ()
	Remove any messages left over from the last graph refresh.
void	AddMessage (const FlowGraphNodeMessage &msg)
	Attach a new message to the node.
void	AddMessage (Severity severity, const std::string &title, const std::string &message)
	Attach a new message to the node.
void	AddErrorMessage (const std::string &err)
	Add a new error message.
void	AddErrorMessage (const std::string &title, const std::string &err)
	Add a new error message with a title.

Protected Attributes
std::string	m_patternModeName
	Name of the "pattern mode" parameter.
std::string	m_patternName
	Name of the "pattern" parameter.
std::string	m_patternLengthName
	Name of the "pattern length" parameter.
std::string	m_matchModeName
	Name of the "mode" parameter.
Protected Attributes inherited from CDRTrigger
FilterParameter &	m_bitRate
FilterParameter &	m_position
FilterParameter &	m_lecroyEq
FilterParameter &	m_polarity
sigc::signal< void()>	m_calculateBitRateSignal
	Signal requesting an auto-baud calculation.
Protected Attributes inherited from Trigger
Oscilloscope *	m_scope
	The scope this trigger is part of.
FilterParameter &	m_level
	"Trigger level" parameter
FilterParameter &	m_triggerLevel
FilterParameter &	m_upperLevel
Protected Attributes inherited from FlowGraphNode
std::vector< std::shared_ptr< InputDescriptor > >	m_inputs
	Input ports.
std::vector< std::set< FlowGraphNode * > >	m_sinks
	The nodes (if any) that each of our streams drives.
ParameterMapType	m_parameters
sigc::signal< void()>	m_parametersChangedSignal
	Signal emitted when the set of parameters changes.
sigc::signal< void()>	m_inputsChangedSignal
	Signal emitted when the set of inputs changes.
std::vector< FlowGraphNodeMessage >	m_messages

Additional Inherited Members
Protected Types inherited from Trigger
typedef std::map< std::string, CreateProcType >	CreateMapType
	Helper typedef for m_createprocs.
Static Protected Attributes inherited from Trigger
static CreateMapType	m_createprocs
	Map of trigger type names to factory methods.

Detailed Description

A hardware 8B/10B pattern trigger.

Member Enumeration Documentation

MatchMode

enum CDR8B10BTrigger::MatchMode

Trigger on matched or unmatched data.

Enumerator
MATCH_INCLUDE	Trigger on a match.
MATCH_EXCLUDE	Trigger if no match found.

PatternMode

enum CDR8B10BTrigger::PatternMode

Type of pattern to look for.

Enumerator
PATTERN_SEQUENCE	Match a sequence of consecutive symbols.
PATTERN_LIST	Match any of several symbols in a list.

Constructor & Destructor Documentation

CDR8B10BTrigger()

CDR8B10BTrigger::CDR8B10BTrigger

(

Oscilloscope *

scope

)

Create a new 8B/10B trigger.

Parameters

scope

The scope to create the trigger for

Member Function Documentation

OnModeChanged()

void CDR8B10BTrigger::OnModeChanged ( )

protected

Handles a change to the match mode by changing the max allowed pattern length.

Currently only implemented for Teledyne LeCroy SDA 8Zi GTX trigger board

SetMatchMode()

void CDR8B10BTrigger::SetMatchMode ( MatchMode  mode )

inline

Sets whether to trigger on pattern match or pattern not found.

Parameters

mode	Match mode

SetPattern()

void CDR8B10BTrigger::SetPattern ( const std::vector< T8B10BSymbol > &  pattern )

inline

Sets the pattern or list of symbols to match.

Parameters

pattern

Vector of 8B/10B symbols to use as the pattern

SetPatternMode()

void CDR8B10BTrigger::SetPatternMode ( PatternMode  mode )

inline

Sets the type of pattern to look for.

Parameters

mode	Pattern mode

SetSymbolCount()

void CDR8B10BTrigger::SetSymbolCount ( size_t  count )

inline

Sets the length of the serial pattern, or size of the set of symbols to match.

Parameters

count

Length of the pattern

---

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

• lib/scopehal/CDR8B10BTrigger.h
• lib/scopehal/CDR8B10BTrigger.cpp