Tx event ctrlr (tx_event_ctrlr)

tx_event_ctrlr is an asset in the ocpi.assets.util_comps component library. Implementations include tx_event_ctrlr RCC Worker (tx_event_ctrlr.rcc). Tested platforms include Rocky9.

Design

TX Event Ctrlr is a small RCC worker that generates transmitter-enable control events on an output port using the tx_event-prot protocol.

A block diagram representation of the implementation is given in Figure 173:

Figure 173: tx_event_ctrlr block diagram.

Interface

<!-- This is the spec file (OCS) for: tx_event_ctrlr
     Add component spec attributes, like "protocol".
     Add property elements for spec properties.
     Add port elements for i/o ports -->
<ComponentSpec>
  <Port Name="out" Producer="true" Protocol="tx_event-prot"/>

  <!-- When writing a value to the txen property that is different from its
       current value, there will be some finite delay before that write action's
       correspond ZLM is sent to the output port. Because the value read from
       the txen property is indicative of the *current* state (i.e. the *last*
       ZLM sent), the readback value of txen may differ from the value
       previously written until some amount of time has passed. If multiple
       property writes somehow occur before their corresponding ZLMs can be
       sent, they are queued for processing. The following table
       gives an example.

      Action                          | Time
      ++++++++++++++++++++++++++++++++|+++++++++++
      write txen=false                | 0    sec
      txOff ZLM sent                  | 0.1  sec
      readback value of txen is false | 1    sec
      write txen=true                 | 2    sec
      readback value of txen is false | 2.1  sec
      txOn ZLM sent                   | 2.1  sec
      readback value of txen is true  | 2.2  sec
      readback value of txen is true  | 2.4  sec
      readback value of txen is true  | 2.6  sec
      readback value of txen is true  | 2.8  sec

  -->
  <Property Name="txen" Type="Bool"
                        Writable="true"
                        Volatile="true"
                        Default="true"
                        Description="TX enable."/>
</ComponentSpec>

Properties

• txen: TX enable.

  • Type: bool

  • Access:

    • Parameter: False

    • Writable: True

    • Initial: False

    • Volatile: True

  • Default value: true

Ports

Inputs:

None.

Outputs:

• out

  • Protocol: tx_event-prot

  • Optional: False

Implementations

• tx_event_ctrlr (RCC)

Dependencies

The dependencies to other elements in OpenCPI are:

• None.

Limitations

Limitations of tx_event_ctrlr are:

• None.

Testing