From 54323592652b2efd9f413c635a548e91b73d4c40 Mon Sep 17 00:00:00 2001 From: Jerry Zhao Date: Thu, 1 Feb 2024 10:36:23 -0800 Subject: [PATCH] Add note on deprecating TLRegisterRouter --- docs/Customization/MMIO-Peripherals.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/Customization/MMIO-Peripherals.rst b/docs/Customization/MMIO-Peripherals.rst index 51540cb4..105d3f70 100644 --- a/docs/Customization/MMIO-Peripherals.rst +++ b/docs/Customization/MMIO-Peripherals.rst @@ -48,6 +48,16 @@ triggering write to ``y``. Polling can be used for status checks. :start-after: DOC include start: 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 ----------------------