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

Update documentation source pointers

Browse Source
This commit is contained in:
Jerry Zhao
2023-02-11 12:48:40 -08:00
parent 7a8bbd0747
commit 0190da20f0
6 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Customization/DMA-Devices.rst
View File

@@ -31,7 +31,7 @@ Once we've created our top-level module including the DMA widget, we can create
:start-after: DOC include start: WithInitZero :start-after: DOC include start: WithInitZero
:end-before: DOC include end: WithInitZero :end-before: DOC include end: WithInitZero
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: InitZeroRocketConfig :start-after: DOC include start: InitZeroRocketConfig
:end-before: DOC include end: InitZeroRocketConfig :end-before: DOC include end: InitZeroRocketConfig

4
docs/Customization/Dsptools-Blocks.rst
View File

@@ -91,14 +91,14 @@ Once again following the path of the previous MMIO example, we now want to mix o
:start-after: DOC include start: DigitalTop :start-after: DOC include start: DigitalTop
:end-before: DOC include end: DigitalTop :end-before: DOC include end: DigitalTop
Finally, we create the configuration class in ``generators/chipyard/src/main/scala/config/RocketConfigs.scala`` that uses the ``WithFIR`` mixin defined in ``generators/chipyard/src/main/scala/example/dsptools/GenericFIR.scala``. Finally, we create the configuration class in ``generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala`` that uses the ``WithFIR`` mixin defined in ``generators/chipyard/src/main/scala/example/dsptools/GenericFIR.scala``.
.. literalinclude:: ../../generators/chipyard/src/main/scala/example/dsptools/GenericFIR.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/example/dsptools/GenericFIR.scala
:language: scala :language: scala
:start-after: DOC include start: WithStreamingFIR :start-after: DOC include start: WithStreamingFIR
:end-before: DOC include end: WithStreamingFIR :end-before: DOC include end: WithStreamingFIR
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: StreamingFIRRocketConfig :start-after: DOC include start: StreamingFIRRocketConfig
:end-before: DOC include end: StreamingFIRRocketConfig :end-before: DOC include end: StreamingFIRRocketConfig

2
docs/Customization/Incorporating-Verilog-Blocks.rst
View File

@@ -116,7 +116,7 @@ Defining a Chip with a BlackBox
Since we've parameterized the GCD instantiation to choose between the Since we've parameterized the GCD instantiation to choose between the
Chisel and the Verilog module, creating a config is easy. Chisel and the Verilog module, creating a config is easy.
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: GCDAXI4BlackBoxRocketConfig :start-after: DOC include start: GCDAXI4BlackBoxRocketConfig
:end-before: DOC include end: GCDAXI4BlackBoxRocketConfig :end-before: DOC include end: GCDAXI4BlackBoxRocketConfig

2
docs/Customization/Keys-Traits-Configs.rst
View File

@@ -68,7 +68,7 @@ For example, the ``WithGCD`` config fragment is parameterized by the type of GCD
We can use this config fragment when composing our configs. We can use this config fragment when composing our configs.
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: GCDTLRocketConfig :start-after: DOC include start: GCDTLRocketConfig
:end-before: DOC include end: GCDTLRocketConfig :end-before: DOC include end: GCDTLRocketConfig

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

@@ -105,14 +105,14 @@ The ``DigitalTopModule`` class is the actual RTL that gets synthesized.
And finally, we create a configuration class in ``generators/chipyard/src/main/scala/config/RocketConfigs.scala`` that uses the ``WithGCD`` config fragment defined earlier. And finally, we create a configuration class in ``generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala`` that uses the ``WithGCD`` config fragment defined earlier.
.. literalinclude:: ../../generators/chipyard/src/main/scala/example/GCD.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/example/GCD.scala
:language: scala :language: scala
:start-after: DOC include start: GCD config fragment :start-after: DOC include start: GCD config fragment
:end-before: DOC include end: GCD config fragment :end-before: DOC include end: GCD config fragment
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: GCDTLRocketConfig :start-after: DOC include start: GCDTLRocketConfig
:end-before: DOC include end: GCDTLRocketConfig :end-before: DOC include end: GCDTLRocketConfig

2
docs/Generators/fft.rst
View File

@@ -7,7 +7,7 @@ Configuration
-------------------------- --------------------------
The following configuration creates an 8-point FFT: The following configuration creates an 8-point FFT:
.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala .. literalinclude:: ../../generators/chipyard/src/main/scala/config/MMIOAcceleratorConfigs.scala
:language: scala :language: scala
:start-after: DOC include start: FFTRocketConfig :start-after: DOC include start: FFTRocketConfig
:end-before: DOC include end: FFTRocketConfig :end-before: DOC include end: FFTRocketConfig