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/link_stream_manager.hpp | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'host/lib/include/uhdlib/rfnoc/link_stream_manager.hpp') diff --git a/host/lib/include/uhdlib/rfnoc/link_stream_manager.hpp b/host/lib/include/uhdlib/rfnoc/link_stream_manager.hpp index 4357a2d58..d4e2aba46 100644 --- a/host/lib/include/uhdlib/rfnoc/link_stream_manager.hpp +++ b/host/lib/include/uhdlib/rfnoc/link_stream_manager.hpp @@ -39,12 +39,25 @@ public: virtual ~link_stream_manager() = 0; /*! \brief Get the software device ID associated with this instance + * + * For every link to a device, we create a unique device ID. For example, + * if there are two USRPs in the graph, each connected with a single + * Ethernet connection, there would be two link managers, and therefore also + * two device IDs on the host side. + * If we access a single USRP using two Ethernet connections, then we still + * have two link stream managers, each with its own unique device ID on the + * host side. + * The device IDs are allocated in the mb_iface associated with this device + * during discovery. * * \return The software device ID associated with this instance */ virtual device_id_t get_self_device_id() const = 0; /*! \brief Get the transport adapter ID associated with this instance + * + * See also uhd::transport::adapter_id_t. For example, when using two + * separate Ethernet ports, there would be two adapter IDs. * * \return The adapter ID associated with this instance */ -- cgit v1.2.3