aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2017-03-24 10:01:59 -0700
committerMartin Braun <martin.braun@ettus.com>2017-03-24 10:01:59 -0700
commite11796b79d33e194eb9e3bdb2e5a78fed8a9da49 (patch)
treead2889e2b3fa822ab181e998c9eac297caa2f5c5 /host/docs
parent52c234d791774d642480a21d1c5328cfe9607696 (diff)
downloaduhd-e11796b79d33e194eb9e3bdb2e5a78fed8a9da49.tar.gz
uhd-e11796b79d33e194eb9e3bdb2e5a78fed8a9da49.tar.bz2
uhd-e11796b79d33e194eb9e3bdb2e5a78fed8a9da49.zip
docs: Further clarification on CHDR
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/vrt_chdr.dox24
1 files changed, 12 insertions, 12 deletions
diff --git a/host/docs/vrt_chdr.dox b/host/docs/vrt_chdr.dox
index a2d36c93e..8675349f9 100644
--- a/host/docs/vrt_chdr.dox
+++ b/host/docs/vrt_chdr.dox
@@ -51,20 +51,20 @@ Bits | Meaning
60 | End-of-burst or error flag
59:48 | 12-bit sequence number
47:32 | Total packet length in Bytes
-31:0 | Stream ID (SID)
-
+31:0 | Stream ID (SID). For the format of SID, see uhd::sid_t.
The packet type is determined mainly by the first two bits, although
-the EOB or error flag are also taken into consideration:
-
-Bit 63 | Bit 62 | Bit 60 | Packet Type
--------|--------|--------|--------------
-0 | 0 | 0 | Data
-0 | 0 | 1 | Data (End-of-burst)
-0 | 1 | 0 | Flow Control
-1 | 0 | 0 | Command Packet
-1 | 1 | 0 | Command Response
-1 | 1 | 1 | Command Response (Error)
+the EOB or error flag are also taken into consideration (the third bit does not
+affect the packet type):
+
+Bit 63 | Bit 62 | Bit 61 | Bit 60 | Packet Type
+-------|--------|--------|--------|--------------
+0 | 0 | x | 0 | Data
+0 | 0 | x | 1 | Data (End-of-burst)
+0 | 1 | x | 0 | Flow Control
+1 | 0 | x | 0 | Command Packet
+1 | 1 | x | 0 | Command Response
+1 | 1 | x | 1 | Command Response (Error)
\section vrt_tools Tools