aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/include
diff options
context:
space:
mode:
Diffstat (limited to 'host/lib/include')
-rw-r--r--host/lib/include/uhdlib/rfnoc/mgmt_portal.hpp11
1 files changed, 9 insertions, 2 deletions
diff --git a/host/lib/include/uhdlib/rfnoc/mgmt_portal.hpp b/host/lib/include/uhdlib/rfnoc/mgmt_portal.hpp
index dcb93772b..46ff96b4d 100644
--- a/host/lib/include/uhdlib/rfnoc/mgmt_portal.hpp
+++ b/host/lib/include/uhdlib/rfnoc/mgmt_portal.hpp
@@ -197,10 +197,17 @@ public:
//! Define custom configuration functions for custom transports
//
- // \param xport_type The type of the custom transport
+ // The intention of this is to allow adding custom management operations to
+ // be inserted for specific types of transports. For example, if IPv4
+ // transport adapters were to require additional Ethernet-specific routing
+ // information, this function could add more configuration packets specific
+ // to this purpose.
+ //
+ // \param xport_type The type of the custom transport (e.g. '1' for IPV4,
+ // see rfnoc_xport_types.vh for a list of valid values).
// \param init_hop_cfg_fn The function to call when initializing the custom xport
// \param rtcfg_hop_cfg_fn The function to call when configuring routing for the
- // custom xport
+ // custom xport
//
virtual void register_xport_hop_cfg_fns(uint8_t xport_subtype,
xport_cfg_fn_t init_hop_cfg_fn,