sample-pcie-root-complex-ats

Description

Sample Root Complex that implements an ATS/PRS Translation Agent

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.
state-change: Notifier on potential DML state change

Port Objects

bank.regs: sample-pcie-root-complex-ats.regs
downstream_port: pcie-downstream-port – This class manages the downstream address spaces and connected devices for PCIe switches and Root Complexes
port.ats_request: sample-pcie-root-complex-ats.ats_request – handles ATS Translation requests
port.ats_translated: sample-pcie-root-complex-ats.ats_translated – handles ATS Translated requests
port.ats_untranslated: sample-pcie-root-complex-ats.ats_untranslated – handles ATS Untranslated requests
port.message: sample-pcie-root-complex-ats.message – handles PCIe Messages

Commands for interface transaction_translator

memory-map – print physical memory map

Attributes

ENABLE_PASID_CHECK: Optional attribute; read/write access; type: b
When set to true all ATS translated requests are verified that their PASID value has gone through the Page Request Service for that address range.
STU: Optional attribute; read/write access; type: i
Smallest Translation Unit
host_memory: Optional attribute; read/write access; type: o|[os]|n
Connection to Host Memory

Provided By

sample-pcie-ats-device

sample-pcie-root-complex-ats.ats_request

Description

handles ATS Translation requests

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-root-complex-ats.ats_translated

Description

handles ATS Translated requests

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

sample-pcie-root-complex-ats.ats_untranslated

Description

handles ATS Untranslated requests

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

sample-pcie-root-complex-ats.message

Description

handles PCIe Messages

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-root-complex-ats.regs

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