pcie-endpoint-shim-frontend

Description

Device that behaves like a PCIe endpoint towards the Simics PCIe system and captures all downstream accesses to forward them to a Shim device. The Shim converts the transactions to an external non-simics API. The endpoint can be a RCiEP or an EP. Use cases are hybrid systems where an Endpoint runs in a separate environment like an RTL simulator, FPGA prototype or in an external functional simulator.

Interfaces Implemented

conf_object, log_object, pcie_device

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.
state-change: Notifier on potential DML state change

Port Objects

bank.pcie_config: pcie-endpoint-shim-frontend.pcie_config
port.HRESET: pcie-endpoint-shim-frontend.HRESET
port.phy: pcie-endpoint-shim-frontend.phy
port.upstream: pcie-endpoint-shim-frontend.upstream

Attributes

downstream_shim: Required attribute; read/write access; type: o|[os]
Device receiving all downstream PCIe transactions and is responsible for converting them to the emulator API
Required interfaces: pcie_port_control.

Provided By

sample-pcie-shim

pcie-endpoint-shim-frontend.HRESET

Interfaces Implemented

conf_object, log_object, signal

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

pcie-endpoint-shim-frontend.pcie_config

Interfaces Implemented

conf_object, log_object, bank_instrumentation_subscribe, instrumentation_order, pcie_function_info, register_view, register_view_catalog, register_view_read_only, transaction

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

Commands for interface bank_instrumentation_subscribe

bp-break-bank – set device access break
bp-run-until-bank – run until specified device access occurs
bp-trace-bank – enable tracing of device accesses
bp-wait-for-bank – wait for specified device access

Commands for interface instrumentation_order

instrumentation-move – reorder instrumentation connections
instrumentation-order – list instrumentation order for object

Commands for interface pcie_function_info

pcie-dma-read – memory PCIe DMA Read
pcie-dma-write – memory PCIe (DMA) Write

Commands for interface transaction

wait-for-get – issue an inquiry read transaction and wait for it to complete
wait-for-read – issue a read transaction and wait for it to complete
wait-for-set – issue an inquiry write transaction and wait for it to complete
wait-for-write – issue a write transaction and wait for it to complete

Attributes

function_number: Pseudo attribute; read-only access; type: i
PCIe function number of this bank

pcie-endpoint-shim-frontend.phy

Interfaces Implemented

conf_object, log_object, transaction

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

Commands for interface transaction

wait-for-get – issue an inquiry read transaction and wait for it to complete
wait-for-read – issue a read transaction and wait for it to complete
wait-for-set – issue an inquiry write transaction and wait for it to complete
wait-for-write – issue a write transaction and wait for it to complete

pcie-endpoint-shim-frontend.upstream

Interfaces Implemented

conf_object, log_object, translator

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

Commands for interface translator

memory-map – print physical memory map