sample-pcie-device

Description

A sample PCIe endpoint with a BAR mapped register bank that contains a register that when written sends an MSI-X interrupt after 0.1 seconds. It has 3 PCIe capabilities that are mandatory for an endpoint. While it uses MSI-X for interrupts but MSI could be used also/instead.

Interfaces Implemented

conf_object, log_object, pcie_device

Connects

clkreq (optional): Required interfaces: signal
upstream_target (optional): Required interfaces: pcie_map; Optional interfaces: io_memory, memory_space, pcie_link_control, port_space, ram, rom, transaction, transaction_translator, 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.
state-change: Notifier on potential DML state change

Port Objects

bank.bar_mapped_bank: sample-pcie-device.bar_mapped_bank
bank.msix_data: sample-pcie-device.msix_data
bank.pcie_config: sample-pcie-device.pcie_config
port.HRESET: sample-pcie-device.HRESET
port._upstream_egress: sample-pcie-device._upstream_egress
port._upstream_egress_dead_end: sample-pcie-device._upstream_egress_dead_end
port.phy: sample-pcie-device.phy
port.upstream_ingress: sample-pcie-device.upstream_ingress
upstream_ingress_targets: sample-pcie-device.upstream_ingress_targets

Commands for this class

info – print information about the object
status – print status of the object

Attributes

clkreq: Optional attribute; read/write access; type: o|[os]|n
CLKREQ output signal (active high)
Required interface: signal

Provided By

sample-pcie-device

sample-pcie-device.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.

sample-pcie-device._upstream_egress

Interfaces Implemented

conf_object, log_object, transaction_translator, translation_flush

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_translator

memory-map – print physical memory map
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

sample-pcie-device._upstream_egress_dead_end

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

sample-pcie-device.bar_mapped_bank

Interfaces Implemented

conf_object, log_object, bank_instrumentation_subscribe, instrumentation_order, 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 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

sample-pcie-device.msix_data

Interfaces Implemented

conf_object, log_object, bank_instrumentation_subscribe, instrumentation_order, 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 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

sample-pcie-device.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
pcie-memory-probe – probe an upstream PCIe DMA

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

sample-pcie-device.phy

Interfaces Implemented

conf_object, log_object, pcie_link_readiness, 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

sample-pcie-device.upstream_ingress

Interfaces Implemented

conf_object, log_object, pcie_ingress_handling, transaction_translator, translation_flush

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_translator

memory-map – print physical memory map
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

sample-pcie-device.upstream_ingress_targets

Interfaces Implemented

conf_object, log_object

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.

Port Objects

config: memory-space – Instances of the memory-space class provide linear address spaces into which devices and memory can be mapped.
io: memory-space – Instances of the memory-space class provide linear address spaces into which devices and memory can be mapped.
memory: memory-space – Instances of the memory-space class provide linear address spaces into which devices and memory can be mapped.
message: memory-space – Instances of the memory-space class provide linear address spaces into which devices and memory can be mapped.
port._dead_end: sample-pcie-device.upstream_ingress_targets._dead_end
port.broadcast: sample-pcie-device.upstream_ingress_targets.broadcast

sample-pcie-device.upstream_ingress_targets._dead_end

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

sample-pcie-device.upstream_ingress_targets.broadcast

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