uhd/host/docs
Wade Fife d0a97670fa docs: rfnoc: Increase Ctrl SeqNum to 8 bits
This change updates the RFNoC specification to increase the SeqNum
field from 6 bits to 8 bits. This helps reduce control packet response
sequence number aliasing in cases where packets may be dropped or
reordered. To make this change while keeping the implementation
efficient, the control packet fields have been rearranged to place the
most critical information first and to avoid splitting fields across
word boundaries.

Additionally, compared to the previous version of the specification (as
of UHD 4.10), a new ReqSize field has been added. This field represents
the read request size.

The DataLength field that briefly existed in the change history has
been removed. In the new version, NumData represents the number of data
words present in the control packet (the same meaning as in the
original RFNoC specification), while ReqSize indicates the number of
words requested to be read. This means that a large read request can be
issued without including dummy data in the request (e.g., ReqSize = 15
while NumData = 0).

See separate commits for the corresponding FPGA and host code changes.
2026-07-28 14:24:19 +02:00
..
app_notes docs: Fix markdown syntax for app note inclusion in manual. 2026-04-20 10:38:41 +02:00
devices docs: update with gRPC documentation 2026-07-28 14:10:47 +02:00
driver_api docs: restructured the UHD manual on chapter level 2025-10-09 14:44:37 +02:00
driver_usage doc: Adding streaming to general x4xx doc 2026-05-12 09:12:48 +02:00
fpga docs: Moved FPGA manual content to host/docs 2025-10-22 09:25:41 +02:00
getting_started docs: Added subsection on "UHD Example Programs" to "Getting Started" 2025-12-17 16:16:59 +01:00
installation docs: update with gRPC documentation 2026-07-28 14:10:47 +02:00
manpages debian: Remove obsolete files 2026-03-24 11:37:20 +01:00
res docs: Add X420 documentation 2026-04-14 10:42:51 +02:00
rfnoc docs: rfnoc: Increase Ctrl SeqNum to 8 bits 2026-07-28 14:24:19 +02:00
sphinx Move ignore of build folders into top level 2025-07-18 11:19:52 +02:00
01_getting_started.dox docs: Added subsection on "UHD Example Programs" to "Getting Started" 2025-12-17 16:16:59 +01:00
02_devices.dox docs: Add X420 documentation 2026-04-14 10:42:51 +02:00
03_installation.dox docs: restructured the UHD manual on chapter level 2025-10-09 14:44:37 +02:00
04_driver_usage.dox docs: restructured the UHD manual on chapter level 2025-10-09 14:44:37 +02:00
05_driver_api.dox docs: restructured the UHD manual on chapter level 2025-10-09 14:44:37 +02:00
06_fpga.md docs: Moved FPGA manual content to host/docs 2025-10-22 09:25:41 +02:00
07_rfnoc.dox docs: add list of NI-provided NoC blocks. 2026-03-23 09:55:39 +01:00
08_appnotes.dox docs: Add an app note on adding custom clocks 2026-04-19 14:20:36 +02:00
CMakeLists.txt cmake: Enable building man pages without full manual (i.e. doxygen) 2026-03-24 11:37:20 +01:00
Doxyfile.in docs: add list of NI-provided NoC blocks. 2026-03-23 09:55:39 +01:00
DoxygenLayout.xml docs: add list of NI-provided NoC blocks. 2026-03-23 09:55:39 +01:00
Ettus_Logo.png docs: Moved manual to Doxygen 2014-04-09 17:25:09 +02:00
group_defs.dox docs: Improve documentation for properties and -propagation 2021-12-03 11:34:35 -08:00
mainpage.dox docs: Add an app note on adding custom clocks 2026-04-19 14:20:36 +02:00