aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--host/docs/vrt_chdr.dox24
-rw-r--r--host/include/uhd/types/sid.hpp8
2 files changed, 19 insertions, 13 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
diff --git a/host/include/uhd/types/sid.hpp b/host/include/uhd/types/sid.hpp
index 5ea8e8f41..5c31f2d5a 100644
--- a/host/include/uhd/types/sid.hpp
+++ b/host/include/uhd/types/sid.hpp
@@ -40,7 +40,13 @@ namespace uhd {
* is required, we use the combination of the 8-bit address and the 8-bit
* endpoint.
*
- * \section sid_str_repr String Representation
+ * <pre>
+ * +-------------+--------------+-------------+--------------+
+ * | SRC address | SRC endpoint | DST address | DST endpoint |
+ * +-------------+--------------+-------------+--------------+
+ * </pre>
+ *
+ * \section sid_str_repr String Representation (pretty printing)
*
* The string representation of a SID is of the form
*