diff options
author | Martin Braun <martin.braun@ettus.com> | 2022-05-12 12:48:54 +0200 |
---|---|---|
committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2022-06-10 13:24:04 -0500 |
commit | d5c6a6a5699520e8c84f73c1674cb8f3b6028152 (patch) | |
tree | 34359ecb04f4cf8f10ad53ddb7393d7959d19964 /host/lib/rfnoc/graph_stream_manager.cpp | |
parent | 64e3139cb299cf5e7a59d5ab18a173b24b06ff3a (diff) | |
download | uhd-d5c6a6a5699520e8c84f73c1674cb8f3b6028152.tar.gz uhd-d5c6a6a5699520e8c84f73c1674cb8f3b6028152.tar.bz2 uhd-d5c6a6a5699520e8c84f73c1674cb8f3b6028152.zip |
rfnoc: Improve comments regarding streaming and mgmt. code
This commit *only* touches comments in the code for RFNoC streaming,
link management and management portal.
Diffstat (limited to 'host/lib/rfnoc/graph_stream_manager.cpp')
-rw-r--r-- | host/lib/rfnoc/graph_stream_manager.cpp | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/host/lib/rfnoc/graph_stream_manager.cpp b/host/lib/rfnoc/graph_stream_manager.cpp index fdf294006..fbabae36a 100644 --- a/host/lib/rfnoc/graph_stream_manager.cpp +++ b/host/lib/rfnoc/graph_stream_manager.cpp @@ -239,6 +239,17 @@ public: } private: + //! Return the local device ID over which we can reach a destination + // + // \param dst_addr The destination address (device/instance pair) for which + // we are finding a local device ID + // \param adapter If provided (i.e., if not NULL_ADAPTER_ID) then only this + // adapter index is used to find local device IDs. If it is + // not given (i.e. if equal to NULL_ADAPTER_ID), then this + // function will use heuristics to choose an adapter. + // \param link_type The type of link for which we're finding a local device + // ID. When \p adapter is NULL_ADAPTER_ID, then we use this + // in our heuristics for choosing an adapter. device_id_t _check_dst_and_find_src(sep_addr_t dst_addr, uhd::transport::adapter_id_t adapter, uhd::transport::link_type_t link_type) const |