diff options
Diffstat (limited to 'host/include')
| -rw-r--r-- | host/include/uhd/rfnoc/noc_block_base.hpp | 3 | ||||
| -rw-r--r-- | host/include/uhd/rfnoc/node.hpp | 8 | ||||
| -rw-r--r-- | host/include/uhd/rfnoc/replay_block_control.hpp | 19 | ||||
| -rw-r--r-- | host/include/uhd/rfnoc_graph.hpp | 3 |
4 files changed, 32 insertions, 1 deletions
diff --git a/host/include/uhd/rfnoc/noc_block_base.hpp b/host/include/uhd/rfnoc/noc_block_base.hpp index 6b1ac5bcd..21135227b 100644 --- a/host/include/uhd/rfnoc/noc_block_base.hpp +++ b/host/include/uhd/rfnoc/noc_block_base.hpp @@ -272,6 +272,9 @@ protected: * This can be used to make the MTU an input to a property resolver. For * example, blocks that have an spp property, such as the radio, can now * trigger a property resolver based on the MTU. + * + * The reference is guaranteed to remain valid for the lifetime of this + * block. */ property_base_t* get_mtu_prop_ref(const res_source_info& edge); diff --git a/host/include/uhd/rfnoc/node.hpp b/host/include/uhd/rfnoc/node.hpp index 0a49d1609..5478eed07 100644 --- a/host/include/uhd/rfnoc/node.hpp +++ b/host/include/uhd/rfnoc/node.hpp @@ -229,6 +229,8 @@ protected: * either be reset after the constructor is finished, or the next time * properties are resolved. * + * For more information, see \ref props_define. + * * \param prop A reference to the property * \param clean_callback A callback that gets executed whenever this property * is dirty and gets marked clean @@ -265,6 +267,8 @@ protected: * (which is considered advanced usage), then the block needs to serialize * access to this function itself. * + * For more information, see \ref props_resolvers. + * * \param inputs The properties that will cause this resolver to run * \param outputs The properties that this resolver will write to * \param resolver_fn The resolver function @@ -290,6 +294,8 @@ protected: * Typically, this function should only ever be called from within the * constructor. * + * See also \ref props_unknown. + * * \param policy The policy that is applied (see also forwarding_policy_t). * \param prop_id The property ID that this forwarding policy is applied to. * If \p prop_id is not given, it will apply to all properties, @@ -315,6 +321,8 @@ protected: * propagation time: * - Any value in the destination vector represents a non-existent port * + * See also \ref props_unknown. + * * \param map The map describing how properties should be propagated */ void set_prop_forwarding_map(const forwarding_map_t& map); diff --git a/host/include/uhd/rfnoc/replay_block_control.hpp b/host/include/uhd/rfnoc/replay_block_control.hpp index c7624d044..1afd8b4de 100644 --- a/host/include/uhd/rfnoc/replay_block_control.hpp +++ b/host/include/uhd/rfnoc/replay_block_control.hpp @@ -40,6 +40,25 @@ namespace uhd { namespace rfnoc { * achieve the best throughput to the downstream block without exceeding the supported * packet size. The maximum packet size can be explicitly set in terms of bytes or * number of items to allow users to tune the performance to suit their application. + * + * \section rfnoc_block_replay_properties Block Properties + * + * User Properties: + * + * | Key | Description + * |---------------:|--------------------------------------------------------- + * | record_offset | The base address for recordings (data will be written here). Will be set by record(). + * | record_size | Size of the record buffer. Will be set by record(). + * | play_offset | Base address for playback (streaming will start from here). Set by play() or config_play(). + * | play_size | Size of the playback buffer. Set by play() or config_play(). + * | packet_size | Size of outgoing packets (in bytes). Gets set by set_max_items_per_packet(). + * + * Edge properties: + * + * | Key | Description + * |------:|------------------------------------------------------------------- + * | type | Data type. On the input, it set by the upstream block (see get_record_type()). For output, it should be provided by set_play_type(). + * */ class UHD_API replay_block_control : public noc_block_base { diff --git a/host/include/uhd/rfnoc_graph.hpp b/host/include/uhd/rfnoc_graph.hpp index b25d7c207..dc35892b1 100644 --- a/host/include/uhd/rfnoc_graph.hpp +++ b/host/include/uhd/rfnoc_graph.hpp @@ -179,7 +179,8 @@ public: * \param src_port The port of the source block to connect. * \param dst_blk The block ID of the destination block to connect to. * \param dst_port The port of the destination block to connect to. - * \param skip_property_propagation Skip property propagation for this edge + * \param skip_property_propagation Skip property propagation for this edge. + * See also \ref props_graph_resolution_back_edges. * * \throws uhd::routing_error if the source or destination ports are * statically connected to a *different* block |