From 2d75aee7e0192d9be74271c5d0e7d8bd1bfb4b3e Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Thu, 2 Jan 2020 15:37:45 +0800 Subject: [PATCH] soc_core: ctrl: document registers This adds a small amount of documentation to the three registers present inside the `CTRL` module. Signed-off-by: Sean Cross --- litex/soc/integration/soc_core.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/litex/soc/integration/soc_core.py b/litex/soc/integration/soc_core.py index 22e71487..6260f9a5 100644 --- a/litex/soc/integration/soc_core.py +++ b/litex/soc/integration/soc_core.py @@ -41,9 +41,15 @@ __all__ = [ class SoCController(Module, AutoCSR): def __init__(self): - self._reset = CSR() - self._scratch = CSRStorage(32, reset=0x12345678) - self._bus_errors = CSRStatus(32) + self._reset = CSRStorage(1, description=""" + Write a ``1`` to this register to trigger a system reset.""") + self._scratch = CSRStorage(32, reset=0x12345678, description=""" + This register is not used by LiteX, and is available + for use as scratch space. For example, you can use + this register to ensure the Wishbone bus is working.""") + self._bus_errors = CSRStatus(32, description=""" + A running total of the number of bus errors, such + as Wishbone timeouts.""") # # # -- 2.30.2