RoCEv2Server

For conceptual usage, see:

Implementation

This Python API is implemented directly in PyRogue. It is a thin pyrogue.Device wrapper that owns a Boost.Python-exported rogue.protocols.rocev2.Server (see Server) and adds the surf.ethernet.roce._RoceEngine.RoceEngine child device for the FPGA-side metadata-bus handshake.

The 15 LocalVariable status/configuration fields (FpgaIp, FpgaGid, HostQpn, HostGid, MrAddr, MrRkey, RxFrameCount, RxByteCount, ConnectionState, MaxPayload, RxQueueDepth, HostRqPsn, HostSqPsn, FpgaQpn, FpgaLkey) are auto-rendered by autoclass below from the docstrings in python/pyrogue/protocols/_RoCEv2.py.

class pyrogue.protocols.RoCEv2Server(*, ip, deviceName, ibPort=1, gidIndex=0, maxPayload=9000, rxQueueDepth=256, roceEngineOffset=0, roceMemBase=None, roceEngine=None, pmtu=5, minRnrTimer=31, rnrRetry=7, retryCount=3, pollInterval=1, **kwargs)[source]

RoCEv2 RC receive server — pyrogue Device.

Mirrors the interface of UdpRssiPack so the two can be used interchangeably inside a Root.

Parameters:

ip (str) – FPGA IP address. Used to derive the FPGA GID (IPv4-mapped IPv6).
deviceName (str) – ibverbs device name (e.g. ‘rxe0’ for softRoCE, ‘mlx5_0’ for HW NIC).
ibPort (int, default: 1) – ibverbs port number (default: 1).
gidIndex (int, default: 0) – GID table index for the host NIC’s RoCEv2 IPv4 address.
maxPayload (int, default: 9000) – Maximum bytes per RDMA WRITE (default: 9000).
rxQueueDepth (int, default: 256) – Number of pre-posted receive slots (default: 256).
roceEngineOffset (int, default: 0) – AXI-lite offset of the RoCEv2 engine register block.
roceMemBase (object) – memBase for the RoceEngine child device (the SRP object).
roceEngine (object) – Pass an existing RoceEngine instance to avoid duplicate address mapping. When set, no child RoceEngine device is created.
pmtu (int, default: 5) – Path MTU enum: 1=256 2=512 3=1024 4=2048 5=4096 (default: 5).
minRnrTimer (int, default: 31) – IB-spec RNR NAK timer code embedded in the QP attributes on RTR. 1=0.01ms, 14=1ms, 18=4ms, 22=16ms, 31=491ms (default: 31).
rnrRetry (int, default: 7) – FPGA QP RNR retry count. 7 means “retry indefinitely” (default: 7).
retryCount (int, default: 3) – FPGA QP retry count for non-RNR transport errors (default: 3).
pollInterval (int, default: 1) – Poll interval in seconds for status variables (default: 1).

property stream: Direct access to the C++ stream master — receives every channel the FPGA emits. Use getChannel(n) instead to get a filtered view of a single RDMA-immediate channel id (the per-channel analogue of UdpRssiPack.application(n)).

getChannel(channel)[source]

Return a channel-filtered view (channel id from immediate value bits [7:0]).

The RDMA WRITE-with-Immediate carries the channel id in the low 8 bits of the immediate value (Server.cpp runThread decodes wc.imm_data & 0xFF), so valid channel ids are 0..255. Out-of- range values would previously blow up with OverflowError inside the Filter ctor — validate up front and raise a clear rogue.GeneralError instead.

Parameters:: channel (int)

teardownFpgaQp()[source]

Tear down the FPGA QP via the metadata bus. Called explicitly from Root.stop() before the transport is torn down.

Return type:: None

add(node)

Add a child node to the device.

Return type:: None
Parameters:: node (Any)

addCustomBlock(block)

Add a pre-defined memory block to the device.

Return type:: None
Parameters:: block (Any)

addInterface(*interfaces)

Add stream or memory interfaces to manage.

Parameters:: *interfaces (Any | Iterable[Any]) – One or more interfaces or iterables of interfaces.
Return type:: None

addNode(nodeClass, **kwargs)

Construct and add a node of nodeClass.

Return type:

None

Parameters:

nodeClass (type[Node])
kwargs (Any)

addNodes(nodeClass, number, stride, **kwargs)

Add a series of nodes with indexed names.

Return type:

None

Parameters:

nodeClass (type[Node])
number (int)
stride (int)
kwargs (Any)

addProtocol(*protocols)

Add protocol entities (alias of addInterface).

Return type:: None
Parameters:: protocols (Any)

addRemoteVariables(number, stride, pack=False, **kwargs)

Add a repeating block of remote variables.

Parameters:

number (int) – Number of variables to add.
stride (int) – Byte stride between instances.
pack (bool, default: False) –
If True, also add a LinkVariable named <name>_All which combines all entries into one underscore-delimited display string.

The indexed RemoteVariable container remains available at the original name. The packed alias uses each element variable’s getDisp() and setDisp() behavior, so formatting follows the underlying variable type. Values are joined in reverse index order: for a variable array Field[0], Field[1], Field[2], the packed value Field_All reads like Field[2]_Field[1]_Field[0] and writing "1_2_3" updates Field[2] = 1, Field[1] = 2, and Field[0] = 3.

This is intended for orthogonal register fields that are convenient to expose both as individual variables and as one combined value.
**kwargs (Any) – Arguments forwarded to RemoteVariable.

Return type:

None

addToGroup(group)

Add this node to a group and propagate to children.

Parameters:: group (str) – Group name to add.
Return type:: None

property address: Any: Return the device base address.

callRecursive(func, nodeTypes=None, **kwargs)

Call a named method on this node and matching children.

Parameters:

func (str) – Method name to call.
nodeTypes (Iterable[type[Node]] | None, default: None) – Node types to include.
**kwargs (Any) – Arguments forwarded to the method call.

Return type:

None

checkBlocks(*, recurse=True, variable=None, **kwargs)

Deprecated alias for waitBlocks().

Return type:

None

Parameters:

recurse (bool)
variable (Any | None)
kwargs (Any)

classmethod classLogName()

Return the canonical Python logger name for this Node class.

Return type:: str

command(**kwargs)

Decorator to add inline methods as commands.

The decorated function is used as LocalCommand(function=...). The command wrapper supplies keyword arguments root, dev, cmd, and arg; the function may accept any subset.

Return type:: Callable[[Callable[..., Any]], Callable[..., Any]]
Parameters:: kwargs (Any)

property commands: OrderedDict[str, BaseCommand]: Return direct child commands.

commandsByGroup(incGroups=None, excGroups=None)

Return commands filtered by group.

Return type:

OrderedDict[str, BaseCommand]

Parameters:

incGroups (str | list[str] | None)
excGroups (str | list[str] | None)

countReset()

Call countReset on all child devices.

Return type:: None

property description: str: Return the node description.

property deviceList: list[Device]: Return a recursive list of devices.

property devices: OrderedDict[str, Device]: Return direct child devices.

devicesByGroup(incGroups=None, excGroups=None)

Return devices filtered by group.

Return type:

OrderedDict[str, Device]

Parameters:

incGroups (str | list[str] | None)
excGroups (str | list[str] | None)

enableChanged(value)

Hook for reacting to enable state changes.

Return type:: None
Parameters:: value (Any)

property expand: bool: Return the expand state.

filterByGroup(incGroups, excGroups)

Return True if the node passes include/exclude filters.

Parameters:

incGroups (str | list[str] | None) – Group name or group names to include.
excGroups (str | list[str] | None) – Group name or group names to exclude.

Return type:

bool

find(*, recurse=True, typ=None, **kwargs)

Find all child nodes that are a base class of ‘typ’ and whose properties match all of the kwargs. For string properties, accepts regexes.

Parameters:

recurse (bool, default: True) – If True, recurse into child nodes.
typ (type[Node] | None, default: None) – Base class type to match.
**kwargs (Any)

Returns:

List of nodes that match the criteria.

Return type:

list[Node]

property forceCheckEach: bool: Deprecated alias for forceWaitEach.

property forceWaitEach: bool: Force block operations to wait after each transaction.

genDocuments(path, incGroups=None, excGroups=None)

Generate Sphinx documentation pages for this device.

Parameters:

path (str) – Output directory path.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.

Return type:

None

getNodes(typ, excTyp=None, incGroups=None, excGroups=None)

Get a filtered ordered dictionary of nodes. pass a class to typ to receive a certain type of node exc is a class type to exclude, incGroups is an optional group or list of groups that this node must be part of excGroups is an optional group or list of groups that this node must not be part of

Parameters:

typ (type[Node])
excTyp (type[Node] | None, default: None) – Type to exclude.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.

Returns:

Ordered dictionary of nodes.

Return type:

OrderedDict[str, Node]

getYaml(readFirst=False, modes=['RW', 'RO', 'WO'], incGroups=None, excGroups=None, recurse=True)

Return current values as YAML text.

Parameters:

readFirst (bool, default: False) – If True, perform a full hardware read before exporting.
modes (list[str], default: ['RW', 'RO', 'WO']) – Variable modes to include. Allowed values are 'RW', 'WO', and 'RO'.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.
recurse (bool, default: True) – If True, recurse into child devices.

Returns:

YAML-formatted representation of the node subtree.

Return type:

str

property groups: list[str]: Return the node groups.

property guiGroup: str | None: Return the GUI group label.

hardReset()

Call hardReset on all child devices.

Return type:: None

property hidden: bool: Return True if the node is hidden.

hideVariables(hidden, variables=None)

Hide a list of variables or variable names.

Parameters:

hidden (bool) – True to hide variables, False to show them.
variables (Iterable[Any] | None, default: None) – Iterable of variable names or variables.

Return type:

None

inGroup(group)

Return True if the node is in the provided group or groups.

Parameters:: group (str) – Group name or list of groups to test.
Return type:: bool

initialize()

Call initialize on all child devices.

Return type:: None

property isCommand: bool: Return True if this node is a command.

property isDevice: bool: Return True if this node is a device.

property isVariable: bool: Return True if this node is a variable (excluding commands).

isinstance(typ)

Return True if this node is an instance of typ.

Return type:: bool
Parameters:: typ (type[Node])

linkVariableGet(**kwargs)

Decorator to add inline linkedGet functions.

The decorated function is used as LinkVariable(linkedGet=...). The linked-get wrapper supplies keyword arguments dev, var, read, index, and check; the function may accept any subset.

Return type:: Callable[[Callable[..., Any]], Callable[..., Any]]
Parameters:: kwargs (Any)

loadYaml(name, writeEach, modes, incGroups=None, excGroups=None)

Load YAML configuration from files or directories.

Parameters:

name (str | list[str]) – Input file, directory, zip-path, or list of those entries.
writeEach (bool) – Write each variable as it is applied.
modes (list[str]) – Variable modes to include. Allowed values are 'RW', 'WO', and 'RO'.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.

Returns:

Returns True when load completes.

Return type:

bool

logName()

Return the canonical logger name for this Node instance.

Return type:: str

makeRecursive(func, nodeTypes=None)

Create a recursive wrapper for a named method.

Parameters:

func (str) – Method name to call.
nodeTypes (Iterable[type[Node]] | None, default: None) – Node types to include.

Return type:

Callable[..., None]

manage(*interfaces)

Manage additional interfaces for start/stop.

Return type:: None
Parameters:: interfaces (Any)

property name: str: Return the node name.

node(name)

Return a direct child node by name.

Parameters:: name (str) – Child node name.
Return type:: Node

property nodeCount: int: Return the total node count.

property nodeList: list[Node]: Return a recursive list of nodes.

nodeMatch(name)

Match a node name, including array-style accessors.

Parameters:: name (str) – Node name or array accessor string.
Returns:: Matching nodes.
Return type:: list[Node]

property nodes: OrderedDict[str, Node]: Return an ordered dictionary of direct child nodes.

property offset: Any: Return the device offset.

property parent: Node: Return the parent node.

property path: str: Return the full node path.

printYaml(readFirst=False, modes=['RW', 'RO', 'WO'], incGroups=None, excGroups=None, recurse=False)

Print the YAML representation to stdout.

Parameters:

readFirst (bool, default: False) – If True, perform a full hardware read before exporting.
modes (list[str], default: ['RW', 'RO', 'WO']) – Variable modes to include. Allowed values are 'RW', 'WO', and 'RO'.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.
recurse (bool, default: False) – If True, recurse into child devices.

Return type:

None

readAndCheckBlocks(recurse=True, variable=None, checkEach=None, *, waitEach=None)

Deprecated alias for readAndWaitBlocks().

Return type:

None

Parameters:

recurse (bool)
variable (Any | None)
checkEach (bool | None)
waitEach (bool | None)

readAndWaitBlocks(recurse=True, variable=None, waitEach=None, *, checkEach=None)

Read blocks and wait for read transactions to complete.

Parameters:

recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to read.
waitEach (bool | None, default: None) – Wait for each block transaction before starting the next one.
checkEach (bool | None, default: None) – Deprecated alias for waitEach.

Return type:

None

readBlocks(*, recurse=True, variable=None, waitEach=None, checkEach=None, index=-1, **kwargs)

Read blocks in the background.

Parameters:

recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to read.
waitEach (bool | None, default: None) – Wait for each block transaction before starting the next one.
checkEach (bool | None, default: None) – Deprecated alias for waitEach.
index (int, default: -1) – Optional index for array variables.
**kwargs (Any) – Additional arguments passed through to the transaction.

Return type:

None

removeFromGroup(group)

Remove this node from a group.

Parameters:: group (str) – Group name to remove.
Return type:: None

property root: Root: Return the root node.

property running: bool: Return True if the device is running.

saveYaml(name, readFirst, modes=['RW', 'RO', 'WO'], incGroups=None, excGroups=None, autoPrefix='', autoCompress=False)

Save YAML configuration or status to a file.

Parameters:

name (str | None) – Destination file path. If empty, a timestamped name is generated.
readFirst (bool) – Read values from hardware before exporting.
modes (list[str], default: ['RW', 'RO', 'WO']) – Variable modes to include. Allowed values are 'RW', 'WO', and 'RO'.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.
autoPrefix (str, default: '') – Prefix for auto-generated filenames.
autoCompress (bool, default: False) – Generate a .zip file when auto-generating names. Default False

Returns:

Returns True when export completes.

Return type:

bool

classmethod setClassLogLevel(level, *, includePython=True, includeRogue=True)

Set the logging level for this Node class logger family.

Return type:

str

Parameters:

level (int | str)
includePython (bool)
includeRogue (bool)

setLogLevel(level, *, includePython=True, includeRogue=True)

Set the logging level for this Node instance logger.

Return type:

str

Parameters:

level (int | str)
includePython (bool)
includeRogue (bool)

setName((Slave)arg1, (str)arg2) → None :

C++ signature :: void setName(rogue::interfaces::memory::Slave {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

setPollInterval(interval, variables=None)

Set the poll interval for a group of variables.

Parameters:

interval (float) – Polling interval in seconds.
variables (Iterable[Any] | None, default: None) – Iterable of variable names or variables. If None, all variables with nonzero poll interval are updated.

Return type:

None

setYaml(yml, writeEach, modes, incGroups=None, excGroups=None)

Set variable values from YAML text.

Parameters:

yml (str) – YAML text containing values to apply.
writeEach (bool) – Write each variable as it is applied.
modes (list[str]) – Variable modes to include. Allowed values are 'RW', 'WO', and 'RO'.
incGroups (str | list[str] | None, default: None) – Group name or group names to include.
excGroups (str | list[str] | None, default: None) – Group name or group names to exclude.

Return type:

None

property variableList: list[BaseVariable]: Return a recursive list of variables and commands.

property variables: OrderedDict[str, BaseVariable]: Return direct child variables (excluding commands).

variablesByGroup(incGroups=None, excGroups=None)

Return variables filtered by group.

Return type:

OrderedDict[str, BaseVariable]

Parameters:

incGroups (str | list[str] | None)
excGroups (str | list[str] | None)

verifyBlocks(*, recurse=True, variable=None, waitEach=None, checkEach=None, **kwargs)

Verify blocks in the background.

Parameters:

recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to verify.
waitEach (bool | None, default: None) – Wait for each block transaction before starting the next one.
checkEach (bool | None, default: None) – Deprecated alias for waitEach.
**kwargs (Any) – Additional arguments passed through to the transaction.

Return type:

None

waitBlocks(*, recurse=True, variable=None, **kwargs)

Wait for block transactions and notify variable listeners.

Parameters:

recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to wait on.
**kwargs (Any) – Additional arguments passed through to the transaction.

Return type:

None

writeAndVerifyBlocks(force=False, recurse=True, variable=None, checkEach=None, *, waitEach=None)

Write, verify, and wait for block transactions to complete.

Parameters:

force (bool, default: False) – Force the write even if values are unchanged.
recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to write/verify.
waitEach (bool | None, default: None) – Wait for each block transaction before starting the next one.
checkEach (bool | None, default: None) – Deprecated alias for waitEach.

Return type:

None

writeBlocks(*, force=False, recurse=True, variable=None, waitEach=None, checkEach=None, index=-1, **kwargs)

Write all blocks held by this device.

Parameters:

force (bool, default: False) – Force the write even if values are unchanged.
recurse (bool, default: True) – If True, recurse into child devices.
variable (Any | None, default: None) – Optional variable to write.
waitEach (bool | None, default: None) – Wait for each block transaction before starting the next one.
checkEach (bool | None, default: None) – Deprecated alias for waitEach.
index (int, default: -1) – Optional index for array variables.
**kwargs (Any) – Additional arguments passed through to the transaction.

Return type:

None