wu-arch/chipyard
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add note on deprecating TLRegisterRouter

Browse Source
This commit is contained in:
Jerry Zhao
2024-02-01 10:36:23 -08:00
parent 51a67fbd8f
commit 5432359265
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Customization/MMIO-Peripherals.rst
View File

@@ -48,6 +48,16 @@ triggering write to ``y``. Polling can be used for status checks.
:start-after: DOC include start: GCD instance regmap :start-after: DOC include start: GCD instance regmap
:end-before: DOC include end: GCD instance regmap :end-before: DOC include end: GCD instance regmap
.. note::
In older versions of Chipyard and Rocket-Chip, a ``TLRegisterRouter`` abstrat
class was used to abstract away the construction of the ``TLRegisterNode`` and
``LazyModule`` classes necessary to construct MMIO peripherals. This was removed,
in favor of requiring users to explicitly construct the necessary classes.
This matches more closely how standard ``Modules`` and ``LazyModules`` are
constructed, making it clearer how a MMIO peripheral fits into the ``Module``
and ``LazyModule`` design patterns.
Connecting by TileLink Connecting by TileLink
---------------------- ----------------------