aboutsummaryrefslogtreecommitdiffstats
path: root/fpga/docs/usrp3/sim/libs_axi.md
diff options
context:
space:
mode:
authorWade Fife <wade.fife@ettus.com>2020-09-08 20:04:56 -0500
committermichael-west <michael.west@ettus.com>2020-09-11 00:44:25 -0700
commit830455fae53e9e63146798ba075460cfa2e6ae3a (patch)
treea62fcf57efc7fa8852ea4f7fc4c5429b37753889 /fpga/docs/usrp3/sim/libs_axi.md
parenta25f9306274583513531fb0537372b8bf03625da (diff)
downloaduhd-830455fae53e9e63146798ba075460cfa2e6ae3a.tar.gz
uhd-830455fae53e9e63146798ba075460cfa2e6ae3a.tar.bz2
uhd-830455fae53e9e63146798ba075460cfa2e6ae3a.zip
fpga: docs: Update user manual for UHD 4.0
Diffstat (limited to 'fpga/docs/usrp3/sim/libs_axi.md')
-rw-r--r--fpga/docs/usrp3/sim/libs_axi.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/fpga/docs/usrp3/sim/libs_axi.md b/fpga/docs/usrp3/sim/libs_axi.md
index a260aabdd..912d889e3 100644
--- a/fpga/docs/usrp3/sim/libs_axi.md
+++ b/fpga/docs/usrp3/sim/libs_axi.md
@@ -1,4 +1,7 @@
-# AXI Interface Libraries
+# Legacy AXI Interface Libraries
+
+This document describes legacy AXI interface libraries used by some
+testbenches. They are included here due to their continued use.
## AXI4 Stream (sim\_axis\_lib.vh)
@@ -61,7 +64,10 @@ receive data on the bus.
// - ramp_start: Start value for the ramp
// - ramp_inc: Increment per clock cycle
-## Compressed VITA [CHDR] (sim\_chdr\_lib.vh)
+## Compressed VITA (sim\_chdr\_lib.vh)
+
+Note: This section describes legacy CHDR in 3.x and earlier. As of UHD 4.0,
+the CHDR protocol and format has changed.
Defines ``cvita_stream_t``, an AXI Stream bus interface that implements the CHDR protocol and
several tasks to send and receive data on the bus.