From 9dc0abb4854e6b626961aff7ff67771140350eee Mon Sep 17 00:00:00 2001
From: Howard Mao <zhehao.mao@gmail.com>
Date: Wed, 25 Sep 2019 16:41:32 -0700
Subject: [PATCH] explain how to add IceNet and TestChipIP hardware to design

---
 docs/Generators/IceNet.rst     | 11 +++++++++++
 docs/Generators/TestChipIP.rst | 12 ++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/docs/Generators/IceNet.rst b/docs/Generators/IceNet.rst
index 2b3ac596..4dca3daa 100644
--- a/docs/Generators/IceNet.rst
+++ b/docs/Generators/IceNet.rst
@@ -71,3 +71,14 @@ The default Linux configuration provided by `firesim-software <https://github.co
 contains an IceNet driver. If launch a FireSim image that has IceNIC on it,
 the driver will automatically detect the device, and you will be able to use
 the full Linux networking stack in userspace.
+
+Configuration
+-------------
+
+To add IceNIC to your design, add ``HasPeripheryIceNIC`` to your lazy module
+and ``HasPeripheryIceNICModuleImp`` to the module implementation.
+
+Then add the ``WithIceNIC`` config mixin to your configuration. This mixin
+takes two arguments. The ``inBufFlits`` argument is the number of 64-bit flits
+that the input packet buffer can hold and the ``usePauser`` argument determines
+whether or not the NIC will have a pause handler.
diff --git a/docs/Generators/TestChipIP.rst b/docs/Generators/TestChipIP.rst
index cf4dc64b..7d490c5f 100644
--- a/docs/Generators/TestChipIP.rst
+++ b/docs/Generators/TestChipIP.rst
@@ -22,6 +22,11 @@ The block device controller provides a generic interface for secondary storage.
 This device is primarily used in FireSim to interface with a block device
 software simulation model. The default Linux configuration in `firesim-software <https://github.com/firesim/firesim-software>`_
 
+To add a block device to your design, add ``HasPeripheryBlockDevice`` to your
+lazy module and ``HasPeripheryBlockDeviceModuleImp`` to the implementation.
+Then add the ``WithBlockDevice`` config mixin to your configuration.
+
+
 TileLink SERDES
 ---------------
 
@@ -38,6 +43,10 @@ and tunnels B and D on its outbound link. Finally, ``TLSerdesser`` exposes
 both client and manager interface to the chip and can tunnel all channels in
 both directions.
 
+For an example of how to use the SERDES classes, take a look at the
+``SerdesTest`` unit test in `the Test Chip IP unit test suite
+<https://github.com/ucb-bar/testchipip/blob/master/src/main/scala/Unittests.scala>`_.
+
 TileLink Switcher
 -----------------
 
@@ -49,3 +58,6 @@ from the client node will be directed to one of the manager nodes.
 The select signal must be set before any TileLink messages are sent and be
 kept stable throughout the remainder of operation. It is not safe to change
 the select signal once TileLink messages have begun sending.
+
+For an example of how to use the switcher, take a look at the ``SwitcherTest``
+unit test in the `Test Chip IP unit tests <https://github.com/ucb-bar/testchipip/blob/master/src/main/scala/Unittests.scala>`_.