Detailed Description

Generic packetized I/O interface for use with SwitchCore.

Each SwitchPort represents one logical port on the Ethernet switch. This class cannot be used directly; child objects define how the port behavior and how it attaches to the outside world.

Ingress data (i.e., data entering the port on its way to the SwitchCore) is written directly to the SwitchPort object. The SwitchPort automatically handles PluginPort egress events.

Egress data (i.e., data leaving the SwitchCore) and associated plugin events are typically handled by the SwitchPort itself, by providing an io::Writeable to the constructor where processed egress data should be copied. If the child object prefers to take both responsibilities, it may instead provide a null pointer. In the latter case, the child reads directly from m_egress.

Formatting for the ingress and egress streams is as follows:

The child or its upstream processing MUST verify the FCS of each incoming Ethernet frame before calling write_finalize(). (i.e., This function may be performed in software or HDL.)
The ingress data stream MUST NOT include preambles or FCS.
The ingress data SHOULD retain VLAN headers if applicable.
The ingress data SHALL be written to this parent object.
The egress data stream MAY include VLAN headers.
The child SHOULD add, remove, or reformat VLAN tags as needed.
See also
eth::SwitchVlanEgress, port::VlanAdapter for examples.
The child or its downstream processing MUST recalculate and append an FCS to each outgoing frame. (i.e., This function may be performed in software or HDL.)

For a complete example,

See also: port::MailAdapter, port::SlipAdapter.

Definition at line 242 of file eth_switch.h.

#include <eth_switch.h>

Inheritance diagram for satcat5::eth::SwitchPort:

[legend]

Collaboration diagram for satcat5::eth::SwitchPort:

[legend]

Public Member Functions
bool	accept (SATCAT5_PMASK_TYPE dst_mask, satcat5::io::MultiPacket *packet)
	Accept delivery of a given packet?

bool	consistency () const
	Internal consistency check, mainly used for unit testing.

satcat5::io::MultiReaderPriority *	get_egress ()
	Source for data leaving the switch through this port.

satcat5::eth::SwitchCore *	get_switch ()
	Pointer to the parent SwitchCore object.

void	port_enable (bool enable)
	Enable or disable this port, pausing data-flow.

bool	port_enabled () const
	Is this port currently enabled?

void	port_flush ()
	Discard all pending ingress and egress data.

unsigned	port_index () const
	Port number for attachment to the parent SwitchCore. More...

SATCAT5_PMASK_TYPE	port_mask () const
	Bit-mask for all port(s) associated with this interface.

void	set_callback (satcat5::io::EventListener *cb)
	Set egress data callback, mainly used for unit testing.

satcat5::eth::VtagPolicy	vlan_config () const
	Return this port's VLAN configuration.

void	vlan_config (const VtagPolicy &cfg)
	Set this port's VLAN configuration.

void	write_abort () override
	Override write_abort() to allow additional error handling. More...

bool	write_finalize () override
	Override write_finalize() to store metadata. More...

virtual void	data_unlink (satcat5::io::Readable *src)
	Unlink this EventListener from the designated source, because the designated Readable object is being destroyed. More...

void	set_max_packet (unsigned max_bytes)
	Update the maximum allowed packet length. More...

void	set_priority (u16 priority)
	Set priority of the current packet. More...

void	set_timeout (unsigned timeout_msec)
	Update the watchdog timeout. More...

unsigned	get_write_partial () const
	Get current write length.

unsigned	get_write_space () const override
	How many bytes can be written without blocking? More...

void	write_bytes (unsigned nbytes, const void *src) override
	Write 0 or more bytes from a buffer. More...

bool	write_bypass (satcat5::io::MultiReader *dst)
	Deliver data directly to the designated MultiReader. More...

void	write_u8 (u8 data)
	One of many functions for writing integer/floating point values, see details. More...

void	write_str (const char *str)
	Write the contents of a null-terminated string. More...

template<class T >
void	write_obj (const T &obj)
	Templated wrapper for any object with the following method: `void write_to(satcat5::io::Writeable* wr) const;`

void	timer_once (unsigned msec)
	Configure a one-time notification after X milliseconds.

void	timer_every (unsigned msec)
	Configure a repeating notification every X milliseconds.

void	timer_stop ()
	Stop all future notifications.

unsigned	timer_interval () const
	Accessor for recurring timer interval, if one is set.

unsigned	timer_remaining () const
	Accessor for time to next event, if one is set.


void	plugin_add (satcat5::eth::PluginPort *plugin)
	Plugin management. More...

void	plugin_remove (satcat5::eth::PluginPort *plugin)
	Plugin management. More...


void	plugin_ingress (satcat5::eth::PluginPacket &pkt)
	Issue notifications to all attached plugins.

void	plugin_egress (satcat5::eth::PluginPacket &pkt)
	Issue notifications to all attached plugins.

Static Public Member Functions
static unsigned	count_timer ()
	Count all objects of this type, including idle timers.

Protected Member Functions
	SwitchPort (satcat5::eth::SwitchCore sw, satcat5::io::Writeable dst)
	Link this port to the designated switch. More...

void	data_rcvd (satcat5::io::Readable *src) override
	The data_rcvd() callback is polled whenever data is available. More...

void	timer_event () override
	Timeouts help prevent resource-hogging.

void	write_next (u8 data) override
	Write the next byte to the underlying buffer or device. More...

void	write_overflow () override
	Optional error handling for write overflow. More...

unsigned	write_prep ()
	Open a new packet or allocate additional buffers. More...

satcat5::io::MultiPacket *	prepare_pkt ()
	Prepare packet for delivery and reset internal state.

Protected Attributes
satcat5::eth::SwitchCore *const	m_switch
	Pointer to the associated switch.

satcat5::eth::VtagPolicy	m_vlan_cfg
	Metadata required for VLAN functionality.

satcat5::io::MultiReaderPriority	m_egress
	Egress data source.

satcat5::io::Writeable *const	m_eg_dst
	Egress destination.

bool	m_eg_hdr
	Frame header copied?

satcat5::util::List< satcat5::eth::PluginPort >	m_plugins
	Linked list of attached plugins.

satcat5::io::MultiBuffer *const	m_dst
	Pointer to the destination buffer.

friend	LimitedWrite

friend	WriteableBroadcast

friend	WriteableRedirect


SATCAT5_PMASK_TYPE	m_port_mask
	Define this port's connection to the switch. More...

const unsigned	m_port_index
	Define this port's connection to the switch. More...


satcat5::io::MultiPacket *	m_write_pkt
	Current write state.

satcat5::io::MultiChunk *	m_write_tail
	Current write state.

unsigned	m_write_pos
	Current write state.

unsigned	m_write_len
	Current write state.

unsigned	m_write_maxlen
	Current write state.

unsigned	m_write_timeout
	Current write state.

Private Member Functions
void	query (unsigned elapsed_msec)

Private Attributes
satcat5::eth::SwitchPort *	m_next

unsigned	m_trem

unsigned	m_tnext

Constructor & Destructor Documentation

◆ SwitchPort()

SwitchPort::SwitchPort	(	satcat5::eth::SwitchCore *	sw,
		satcat5::io::Writeable *	dst
	)

explicitprotected

Link this port to the designated switch.

Implement a child object to use this class.

Definition at line 267 of file eth_switch.cc.

Member Function Documentation

◆ data_rcvd()

void SwitchPort::data_rcvd ( satcat5::io::Readable * src )

overrideprotectedvirtual

The data_rcvd() callback is polled whenever data is available.

A pointer is provided to assist handlers with multiple sources. Child objects of io::EventListener MUST override this method.

Implements satcat5::io::EventListener.

Definition at line 368 of file eth_switch.cc.

◆ data_unlink()

virtual void satcat5::io::EventListener::data_unlink ( satcat5::io::Readable * src )

inlinevirtualinherited

Unlink this EventListener from the designated source, because the designated Readable object is being destroyed.

Child objects of io::EventListener MAY override this method if action is required.

Reimplemented in satcat5::io::Override, satcat5::io::MuxUp, satcat5::io::MuxDown, satcat5::io::BufferedPackets, satcat5::io::BufferedStream, satcat5::io::BufferedCopy, satcat5::eth::SwitchLogReader, satcat5::eth::Dispatch, satcat5::ccsds_spp::Dispatch, satcat5::ccsds_aos::Dispatch, satcat5::ccsds_aos::Channel, satcat5::test::MockOffload::Port, and satcat5::freertos::MessageCopy.

Definition at line 54 of file io_readable.h.

◆ get_write_space()

unsigned MultiWriter::get_write_space ( ) const

overridevirtualinherited

How many bytes can be written without blocking?

Child objects of io::Writeable MUST override this method.

Implements satcat5::io::Writeable.

Definition at line 465 of file multi_buffer.cc.

◆ plugin_add()

void SwitchPort::plugin_add ( satcat5::eth::PluginPort * plugin )

Plugin management.

The switch maintains a linked list of regstered PluginCore objects. For each incoming packet, the switch calls query(...) on each registered plugin. These methods are automatically called by the PluginCore constructor and destructor.

Definition at line 295 of file eth_switch.cc.

◆ plugin_remove()

void SwitchPort::plugin_remove ( satcat5::eth::PluginPort * plugin )

Plugin management.

The switch maintains a linked list of regstered PluginCore objects. For each incoming packet, the switch calls query(...) on each registered plugin. These methods are automatically called by the PluginCore constructor and destructor.

Definition at line 297 of file eth_switch.cc.

◆ port_index()

unsigned satcat5::eth::SwitchPort::port_index ( ) const

inline

Port number for attachment to the parent SwitchCore.

Note: Does not apply to multi-port API,

See also: router2::Offload.

Definition at line 292 of file eth_switch.h.

◆ set_max_packet()

void satcat5::io::MultiWriter::set_max_packet ( unsigned max_bytes )

inlineinherited

Update the maximum allowed packet length.

(Longer packets are terminated to avoid resource hogging.)

Definition at line 413 of file multi_buffer.h.

◆ set_priority()

void MultiWriter::set_priority ( u16 priority )

inherited

Set priority of the current packet.

Call this method after writing data, but before calling write_finalize or write_bypass. Priority affects readout order for recipient(s) using the MultiReaderPriority class.

Definition at line 461 of file multi_buffer.cc.

◆ set_timeout()

void satcat5::io::MultiWriter::set_timeout ( unsigned timeout_msec )

inlineinherited

Update the watchdog timeout.

The watchdog is reset each time a byte is written; if a partial packet is not finalized or aborted within the time limit, then it is dicarded.

Definition at line 425 of file multi_buffer.h.

◆ write_abort()

void SwitchPort::write_abort ( )

overridevirtual

Override write_abort() to allow additional error handling.

For example, logging of dropped packets.

See also: eth_sw_log.h.

Reimplemented from satcat5::io::Writeable.

Definition at line 329 of file eth_switch.cc.

◆ write_bypass()

bool MultiWriter::write_bypass ( satcat5::io::MultiReader * dst )

inherited

Deliver data directly to the designated MultiReader.

The write_finalize method delivers the current packet to the MultiBuffer, which then decides which port(s) should receive that packet.

See also: MultiBuffer::deliver

This alternative method delivers the packet directly to the designated MultiReader, bypassing MultiBuffer delivery logic.

Definition at line 521 of file multi_buffer.cc.

◆ write_bytes()

void MultiWriter::write_bytes	(	unsigned	nbytes,
		const void *	src
	)

overridevirtualinherited

Write 0 or more bytes from a buffer.

Child objects of io::Writeable MAY override write_bytes as needed for performance.

Reimplemented from satcat5::io::Writeable.

Definition at line 474 of file multi_buffer.cc.

◆ write_finalize()

bool SwitchPort::write_finalize ( )

overridevirtual

Override write_finalize() to store metadata.

Children with multiple logical ports MUST override this method to indicate the correct specific source port index.

Reimplemented from satcat5::io::Writeable.

Definition at line 335 of file eth_switch.cc.

◆ write_next()

void MultiWriter::write_next ( u8 data )

overrideprotectedvirtualinherited

Write the next byte to the underlying buffer or device.

Child objects of io::Writeable MUST override this method.

Implements satcat5::io::Writeable.

Definition at line 531 of file multi_buffer.cc.

◆ write_overflow()

void MultiWriter::write_overflow ( )

overrideprotectedvirtualinherited

Optional error handling for write overflow.

Child objects of io::Writeable MAY override this method for error handling.

Reimplemented from satcat5::io::Writeable.

Definition at line 547 of file multi_buffer.cc.

◆ write_prep()

unsigned MultiWriter::write_prep ( )

protectedinherited

Open a new packet or allocate additional buffers.

Returns: The number of bytes that can be written.

Definition at line 558 of file multi_buffer.cc.

◆ write_str()

void Writeable::write_str ( const char * str )

inherited

Write the contents of a null-terminated string.

Note: Null-termination is not copied to the output.

Definition at line 180 of file io_writeable.cc.

◆ write_u8()

void Writeable::write_u8 ( u8 data )

inherited

One of many functions for writing integer/floating point values, see details.

Several functions are provided for reading and writing scalar types to/from io::Readable and io::Writeable instances. Since there are many of these that are frequently inherited, they are hidden from documentation. These functions follow a shared template:

read_ or write_ prefix.
u for unsigned, s for signed, f for floating-point.
Data-type width in bits.
- Available widths for ints: 8/16/24/32/48/64.
- Available widths for floats: 32/64.
l suffix if little-endian, no suffix if big-endian.

Example: write_s48l is "Write 48 bits (6 bytes) to this io::Writeable as a signed value in little-endian order".

Definition at line 20 of file io_writeable.cc.

Member Data Documentation

◆ m_port_index

const unsigned satcat5::eth::SwitchPort::m_port_index

protected

Define this port's connection to the switch.

Note: Usually m_port_mask contains a single '1' bit, but some port objects represent several logical ports. The "m_port_index" SHOULD NOT be used in such cases.

Definition at line 340 of file eth_switch.h.

◆ m_port_mask

SATCAT5_PMASK_TYPE satcat5::eth::SwitchPort::m_port_mask

protected

Define this port's connection to the switch.

Note: Usually m_port_mask contains a single '1' bit, but some port objects represent several logical ports. The "m_port_index" SHOULD NOT be used in such cases.

Definition at line 339 of file eth_switch.h.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ SwitchPort()

Member Function Documentation

◆ data_rcvd()

◆ data_unlink()

◆ get_write_space()

◆ plugin_add()

◆ plugin_remove()

◆ port_index()

◆ set_max_packet()

◆ set_priority()

◆ set_timeout()

◆ write_abort()

◆ write_bypass()

◆ write_bytes()

◆ write_finalize()

◆ write_next()

◆ write_overflow()

◆ write_prep()

◆ write_str()

◆ write_u8()

Member Data Documentation

◆ m_port_index

◆ m_port_mask