01238c8b7a
* [docs] rename config mixins -> fragments [ci skip] * [docs] cleanup naming | link similar sections [ci skip] * [boom] bump for mixin rename [ci skip] * [docs] cleanup capitalization [ci skip] * [docs] consistent config fragment naming [ci skip] * [boom] bump boom for documentation changes [ci skip] * [docs] update source comments [ci skip] * [docs] fix last config fragment name [ci skip] Co-Authored-By: alonamid <alonamid@eecs.berkeley.edu> Co-authored-by: alonamid <alonamid@eecs.berkeley.edu>
26 lines
1.5 KiB
ReStructuredText
26 lines
1.5 KiB
ReStructuredText
IOBinders
|
|
=========
|
|
|
|
In Chipyard we use a special ``Parameters`` key, ``IOBinders`` to determine what modules to bind to the IOs of a ``Top`` in the ``TestHarness``.
|
|
|
|
.. literalinclude:: ../../generators/chipyard/src/main/scala/IOBinders.scala
|
|
:language: scala
|
|
:start-after: DOC include start: IOBinders
|
|
:end-before: DOC include end: IOBinders
|
|
|
|
|
|
This special key solves the problem of duplicating test-harnesses for each different ``Top`` type.
|
|
|
|
You could just as well create a custom harness module that attaches IOs explicitly. Instead, the IOBinders key provides a map from Scala traits to attachment behaviors.
|
|
|
|
For example, the ``WithSimAXIMemTiedOff`` IOBinder specifies that any ``Top`` which matches ``CanHaveMasterAXI4MemPortModuleImp`` will have a ``SimAXIMem`` connected.
|
|
|
|
.. literalinclude:: ../../generators/chipyard/src/main/scala/IOBinders.scala
|
|
:language: scala
|
|
:start-after: DOC include start: WithSimAXIMem
|
|
:end-before: DOC include end: WithSimAXIMem
|
|
|
|
These classes are all ``Config`` objects, which can be mixed into the configs to specify IO connection behaviors.
|
|
|
|
There are two macros for generating these ``Config``s. ``OverrideIOBinder`` overrides any existing behaviors set for a particular IO in the ``Config`` object. This macro is frequently used because typically top-level IOs drive or are driven by only one source, so a composition of ``IOBinders`` does not make sense. The ``ComposeIOBinder`` macro provides the functionality of not overriding existing behaviors.
|