Welcome to Switchboard’s documentation!

This page is meant to serve as a reference manual for the various python classes and functions contained in the switchboard package. To get started, reference some of the examples included in the repository.

Contents:

• switchboard package
  • PySbPacket
    • PySbPacket.data
    • PySbPacket.destination
    • PySbPacket.flags
  • PySbRx
    • PySbRx.init()
    • PySbRx.recv()
  • PySbRxPcie
    • PySbRxPcie.init()
  • PySbTx
    • PySbTx.init()
    • PySbTx.send()
  • PySbTxPcie
    • PySbTxPcie.init()
  • PyUmi
    • PyUmi.atomic()
    • PyUmi.init()
    • PyUmi.read()
    • PyUmi.recv()
    • PyUmi.send()
    • PyUmi.write()
  • PyUmiPacket
    • PyUmiPacket.cmd
    • PyUmiPacket.data
    • PyUmiPacket.dstaddr
    • PyUmiPacket.merge()
    • PyUmiPacket.srcaddr
  • UmiAtomic
    • UmiAtomic.UMI_REQ_ATOMICADD
    • UmiAtomic.UMI_REQ_ATOMICAND
    • UmiAtomic.UMI_REQ_ATOMICMAX
    • UmiAtomic.UMI_REQ_ATOMICMAXU
    • UmiAtomic.UMI_REQ_ATOMICMIN
    • UmiAtomic.UMI_REQ_ATOMICMINU
    • UmiAtomic.UMI_REQ_ATOMICOR
    • UmiAtomic.UMI_REQ_ATOMICSWAP
    • UmiAtomic.UMI_REQ_ATOMICXOR
    • UmiAtomic.name
    • UmiAtomic.value
  • UmiCmd
    • UmiCmd.UMI_INVALID
    • UmiCmd.UMI_REQ_ATOMIC
    • UmiCmd.UMI_REQ_ERROR
    • UmiCmd.UMI_REQ_FUTURE0
    • UmiCmd.UMI_REQ_LINK
    • UmiCmd.UMI_REQ_POSTED
    • UmiCmd.UMI_REQ_RDMA
    • UmiCmd.UMI_REQ_READ
    • UmiCmd.UMI_REQ_USER0
    • UmiCmd.UMI_REQ_WRITE
    • UmiCmd.UMI_RESP_FUTURE0
    • UmiCmd.UMI_RESP_FUTURE1
    • UmiCmd.UMI_RESP_LINK
    • UmiCmd.UMI_RESP_READ
    • UmiCmd.UMI_RESP_USER0
    • UmiCmd.UMI_RESP_USER1
    • UmiCmd.UMI_RESP_WRITE
    • UmiCmd.name
    • UmiCmd.value
  • delete_queue()
  • delete_queues()
  • umi_atype()
  • umi_eof()
  • umi_eom()
  • umi_ex()
  • umi_len()
  • umi_opcode()
  • umi_opcode_to_str()
  • umi_pack()
  • umi_prot()
  • umi_qos()
  • umi_size()
  • Submodules
    • switchboard.umi module
    • switchboard.util module
    • switchboard.verilator module
    • switchboard.icarus module
    • switchboard.sbdut module
    • switchboard.loopback module
    • switchboard.bitvector module
    • switchboard.uart_xactor module
    • switchboard.sbtcp module

Indices and tables

• Index

• Module Index

• Search Page