From d5c6a6a5699520e8c84f73c1674cb8f3b6028152 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 12 May 2022 12:48:54 +0200 Subject: rfnoc: Improve comments regarding streaming and mgmt. code This commit *only* touches comments in the code for RFNoC streaming, link management and management portal. --- host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp') diff --git a/host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp b/host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp index 7b2900832..72b06fa46 100644 --- a/host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp +++ b/host/lib/include/uhdlib/rfnoc/rfnoc_common.hpp @@ -9,18 +9,31 @@ #include #include #include +#include namespace uhd { namespace rfnoc { -//---------------------------------------------- -// Types -//---------------------------------------------- +//----------------------------------------------------------------------------- +// Types that are private to UHD +// (there are more in rfnoc_types.hpp that are public) +//----------------------------------------------------------------------------- //! Device ID Type +// Every USRP in the RFNoC graph will have *one* device_id. It is programmed +// into the device during initialization through a non-RFNoC mechanism (e.g., +// via MPM or the ZPU). using device_id_t = uint16_t; //! Stream Endpoint Instance Number Type +// These instance numbers are unique within a device (they are simply counted +// up), but are not unique in a graph (every USRP will have its own set of SEPs). using sep_inst_t = uint16_t; //! Stream Endpoint Physical Address Type +// This combination of device ID and SEP instance is unique in a graph. Note +// that for the most part, we map an sep_addr_t to a sep_id_t. This limits us to +// 2**16 combinations of device IDs and SEP instances, but that is more than +// enough for all practical applications. We use sep_id_t when we need a compact +// 16-bit address (e.g., in a CHDR header). We use a sep_addr_t when we need to +// know which device this endpoint belongs to. using sep_addr_t = std::pair; //! Stream Endpoint Physical Address Type (first = source, second = destination) using sep_addr_pair_t = std::pair; -- cgit v1.2.3