Remove outdated documentation

By now, ibex depends not only on the a clock gating cell, but also on
assert macros and a LFSR; there will be more to come. This removed piece
of documentation was from the early days, when only a clock gating cell
was to be provided (and we didn't ship one).

Today, users need to either use FuseSoC, or run fusesoc on the simple
system and "harvest" the resulting files if they want to copy-paste Ibex
into their build system. That's not ideal, but not something we can very
easily fix -- so let's remove the outdated documentation first to at
least reduce the confusion.
This commit is contained in:
Philipp Wagner 2020-07-03 13:53:14 +01:00 committed by Philipp Wagner
parent b807879aca
commit 6ca325fa70

View file

@ -12,17 +12,3 @@ Ibex comes with two different register file implementations.
Depending on the target technology, either the implementation in ``ibex_register_file_ff.sv`` or the one in ``ibex_register_file_latch.sv`` should be selected.
For more information about the two register file implementations and their trade-offs, check out :ref:`register-file`.
Clock Gating Cell
-----------------
Ibex requires clock gating cells.
This cells are usually specific to the selected target technology and thus not provided as part of the RTL design.
It is assumed that the clock gating cell is wrapped in a module called ``prim_clock_gating`` that has the following ports:
* ``clk_i``: Clock Input
* ``en_i``: Clock Enable Input
* ``test_en_i``: Test Enable Input (activates the clock even though ``en_i`` is not set)
* ``clk_o``: Gated Clock Output
Inside Ibex, clock gating cells are used both in ``ibex_core.sv`` and ``ibex_register_file_latch.sv``.
For more information on the expected behavior of the clock gating cell when using the latch-based register file check out :ref:`register-file`.