Internal Implementation Details

The following are mostly internal implementation details, but end up in the user-facing API.

class torii_ila._bits.bits(value=0, length: int | None = None)

An immutable bit sequence, like bytes but for bits.

This bit sequence is ordered from LSB to MSB; this is the direction in which it is converted to and from iterators, and to and from bytes. Note, however, that it is converted to and from strings (which should be only used where a human-readable form is required) from MSB to LSB; this matches the way integer literals are written, as well as values in datasheets and other documentation.

class torii_ila._stream.StreamInterface(data_width: int = 8, valid_width: int = 1) → None

A very simple record implementing a unidirectional stream interface.

Parameters:

data_width (int) – Stream width in bits. (default: 8)

Attributes:

  • ready (Signal, recv) – Indicates that the receiver will accept the data at the next active clock edge.

  • first (Signal, send) – Indicates that the data is the first of the current packet.

  • last (Signal, send) – Indicates that the data is the last of the current packet.

  • payload (Signal(data_width), send) – The data to be transmitted.

  • valid (Signal(valid_width), send) – Indicates data is part of this transfer.