USRP Hardware Driver and USRP Manual: noc_block_base.hpp Source File

| USRP Hardware Driver and USRP Manual Version: 4.9.0.makepkg-0-g9ec1f582 UHD and USRP Manual |

Loading...
Searching...
No Matches
noc_block_base.hpp
Go to the documentation of this file.
1//
2// Copyright 2019 Ettus Research, a National Instruments Brand
3//
4// SPDX-License-Identifier: GPL-3.0-or-later
5//
6
7#pragma once
8
9#include <uhd/config.hpp>
10#include <uhd/property_tree.hpp>
11#include <uhd/rfnoc/block_id.hpp>
12#include <uhd/rfnoc/defaults.hpp>
13#include <uhd/rfnoc/node.hpp>
14#include <uhd/rfnoc/register_iface_holder.hpp>
15#include <uhd/rfnoc/rfnoc_types.hpp>
16#include <uhd/types/device_addr.hpp>
17
19#define RFNOC_BLOCK_CONSTRUCTOR(CLASS_NAME) \
20 CLASS_NAME##_impl(make_args_ptr make_args) : CLASS_NAME(std::move(make_args))
21
22#define RFNOC_DECLARE_BLOCK(CLASS_NAME) \
23 using sptr = std::shared_ptr<CLASS_NAME>; \
24 CLASS_NAME(make_args_ptr make_args) : noc_block_base(std::move(make_args)) {}
25
26namespace uhd { namespace rfnoc {
27
28class clock_iface;
29class mb_controller;
30
42 class UHD_API noc_block_base : public node_t, public register_iface_holder
43{
44public:
48 using sptr = std::shared_ptr<noc_block_base>;
49
51 struct make_args_t;
52
54 using make_args_ptr = std::unique_ptr<make_args_t>;
55
56 ~noc_block_base() override;
57
58 /**************************************************************************
59 * node_t API calls
60 *************************************************************************/
62 std::string get_unique_id() const override
63 {
64 return get_block_id().to_string();
65 }
66
74 size_t get_num_input_ports() const override
75 {
76 return _num_input_ports;
77 }
78
86 size_t get_num_output_ports() const override
87 {
88 return _num_output_ports;
89 }
90
91 /**************************************************************************
92 * RFNoC-block specific API calls
93 *************************************************************************/
98 noc_id_t get_noc_id() const
99 {
100 return _noc_id;
101 }
102
107 const block_id_t& get_block_id() const
108 {
109 return _block_id;
110 }
111
116 double get_tick_rate() const;
117
134 size_t get_mtu(const res_source_info& edge);
135
149 size_t get_chdr_hdr_len(const bool account_for_ts = true) const;
150
178 size_t get_max_payload_size(
179 const res_source_info& edge, const bool account_for_ts = true);
180
183 uhd::device_addr_t get_block_args() const
184 {
185 return _block_args;
186 }
187
189 uhd::property_tree::sptr& get_tree() const
190 {
191 return _tree;
192 }
193
195 uhd::property_tree::sptr& get_tree()
196 {
197 return _tree;
198 }
199
211 std::shared_ptr<mb_controller> get_mb_controller();
212
213protected:
214 noc_block_base(make_args_ptr make_args);
215
226 void set_num_input_ports(const size_t num_ports);
227
241 void set_num_output_ports(const size_t num_ports);
242
248 void set_tick_rate(const double tick_rate);
249
278 void set_mtu_forwarding_policy(const forwarding_policy_t policy);
279
285 void set_mtu(const res_source_info& edge, const size_t new_mtu);
286
296 property_base_t* get_mtu_prop_ref(const res_source_info& edge);
297
315 virtual void deinit();
316
317private:
318 friend class block_initializer;
319
325 void _set_tick_rate(const double tick_rate);
326
332 void shutdown() override;
333
341 void post_init();
342
343 /**************************************************************************
344 * Attributes
345 **************************************************************************/
347 noc_id_t _noc_id;
348
350 //
351 // The framework will guarantee that no one else has the same block ID
352 block_id_t _block_id;
353
355 size_t _num_input_ports;
356
358 size_t _num_output_ports;
359
361 // for all in- and output edges.
362 std::vector<property_t<double>> _tick_rate_props;
363
365 forwarding_policy_t _mtu_fwd_policy = forwarding_policy_t::ONE_TO_ONE;
366
368 bool _mtu_fwd_policy_set = false;
369
371 // for all in- and output edges.
372 std::vector<property_t<size_t>> _mtu_props;
373
375 std::unordered_map<res_source_info, size_t> _mtu;
376
378 chdr_w_t _chdr_w;
379
381 std::shared_ptr<clock_iface> _ctrlport_clock_iface;
382
384 std::shared_ptr<clock_iface> _tb_clock_iface;
385
387 // block had requested and was granted access
388 std::shared_ptr<mb_controller> _mb_controller;
389
391 const uhd::device_addr_t _block_args;
392
394 //
395 // It is mutable because _tree->access<>(..).get() is not const, but we
396 // need to do just that in some const contexts
397 mutable uhd::property_tree::sptr _tree;
398
399}; // class noc_block_base
400
401}} /* namespace uhd::rfnoc */
402
403#include <uhd/rfnoc/noc_block_make_args.hpp>
block_id.hpp
uhd::device_addr_t
Definition device_addr.hpp:39
uhd::property_tree::sptr
std::shared_ptr< property_tree > sptr
Definition property_tree.hpp:224
uhd::rfnoc::block_id_t
Definition block_id.hpp:40
uhd::rfnoc::noc_block_base::get_block_args
uhd::device_addr_t get_block_args() const
Definition noc_block_base.hpp:183
uhd::rfnoc::noc_block_base::make_args_ptr
std::unique_ptr< make_args_t > make_args_ptr
Opaque pointer to the constructor arguments.
Definition noc_block_base.hpp:54
uhd::rfnoc::noc_block_base::set_mtu_forwarding_policy
void set_mtu_forwarding_policy(const forwarding_policy_t policy)
uhd::rfnoc::noc_block_base::get_num_output_ports
size_t get_num_output_ports() const override
Definition noc_block_base.hpp:86
uhd::rfnoc::noc_block_base::get_mtu
size_t get_mtu(const res_source_info &edge)
uhd::rfnoc::noc_block_base::block_initializer
friend class block_initializer
Definition noc_block_base.hpp:318
uhd::rfnoc::noc_block_base::set_mtu
void set_mtu(const res_source_info &edge, const size_t new_mtu)
uhd::rfnoc::noc_block_base::get_max_payload_size
size_t get_max_payload_size(const res_source_info &edge, const bool account_for_ts=true)
uhd::rfnoc::noc_block_base::get_tick_rate
double get_tick_rate() const
uhd::rfnoc::noc_block_base::set_num_input_ports
void set_num_input_ports(const size_t num_ports)
uhd::rfnoc::noc_block_base::get_num_input_ports
size_t get_num_input_ports() const override
Definition noc_block_base.hpp:74
uhd::rfnoc::noc_block_base::deinit
virtual void deinit()
uhd::rfnoc::noc_block_base::get_unique_id
std::string get_unique_id() const override
Unique ID for an RFNoC block is its block ID.
Definition noc_block_base.hpp:62
uhd::rfnoc::noc_block_base::noc_block_base
noc_block_base(make_args_ptr make_args)
uhd::rfnoc::noc_block_base::get_tree
uhd::property_tree::sptr & get_tree() const
Return a reference to this block's subtree.
Definition noc_block_base.hpp:189
uhd::rfnoc::noc_block_base::get_chdr_hdr_len
size_t get_chdr_hdr_len(const bool account_for_ts=true) const
uhd::rfnoc::noc_block_base::~noc_block_base
~noc_block_base() override
uhd::rfnoc::noc_block_base::get_tree
uhd::property_tree::sptr & get_tree()
Return a reference to this block's subtree (non-const version).
Definition noc_block_base.hpp:195
uhd::rfnoc::noc_block_base::get_noc_id
noc_id_t get_noc_id() const
Definition noc_block_base.hpp:98
uhd::rfnoc::noc_block_base::get_mb_controller
std::shared_ptr< mb_controller > get_mb_controller()
uhd::rfnoc::noc_block_base::sptr
std::shared_ptr< noc_block_base > sptr
Definition noc_block_base.hpp:48
uhd::rfnoc::noc_block_base::get_block_id
const block_id_t & get_block_id() const
Definition noc_block_base.hpp:107
uhd::rfnoc::noc_block_base::get_mtu_prop_ref
property_base_t * get_mtu_prop_ref(const res_source_info &edge)
uhd::rfnoc::noc_block_base::set_tick_rate
void set_tick_rate(const double tick_rate)
uhd::rfnoc::noc_block_base::set_num_output_ports
void set_num_output_ports(const size_t num_ports)
uhd::rfnoc::node_t::node_t
node_t()
uhd::rfnoc::node_t::forwarding_policy_t
forwarding_policy_t
Types of property/action forwarding for those not defined by the block itself.
Definition node.hpp:46
uhd::rfnoc::node_t::forwarding_policy_t::ONE_TO_ONE
@ ONE_TO_ONE
Forward the property/action to the opposite port with the same index.
Definition node.hpp:49
uhd::rfnoc::property_base_t
Definition property.hpp:26
uhd::rfnoc::register_iface_holder::register_iface_holder
register_iface_holder(register_iface::sptr reg)
Definition register_iface_holder.hpp:21
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
defaults.hpp
device_addr.hpp
uhd::rfnoc::noc_id_t
uint32_t noc_id_t
Definition defaults.hpp:52
uhd::rfnoc::chdr_w_t
chdr_w_t
Type that indicates the CHDR Width in bits.
Definition rfnoc_types.hpp:19
uhd
Definition build_info.hpp:12
noc_block_make_args.hpp
node.hpp
property_tree.hpp
register_iface_holder.hpp
rfnoc_types.hpp
uhd::rfnoc::noc_block_base::make_args_t
Definition noc_block_make_args.hpp:25
uhd::rfnoc::res_source_info
Definition res_source_info.hpp:18