USRP Hardware Driver and USRP Manual  Version: 004.000.000.HEAD-0-g8773fb2c
UHD and USRP Manual
uhd::rfnoc::block_ctrl Class Reference

This is the default implementation of a block_ctrl_base. More...

#include <uhd/rfnoc/block_ctrl.hpp>

Inheritance diagram for uhd::rfnoc::block_ctrl:
uhd::rfnoc::source_block_ctrl_base uhd::rfnoc::sink_block_ctrl_base uhd::rfnoc::block_ctrl_base uhd::rfnoc::source_node_ctrl uhd::rfnoc::block_ctrl_base uhd::rfnoc::sink_node_ctrl uhd::rfnoc::node_ctrl_base uhd::rfnoc::node_ctrl_base uhd::rfnoc::node_ctrl_base uhd::rfnoc::node_ctrl_base

Additional Inherited Members

- Public Types inherited from uhd::rfnoc::source_block_ctrl_base
typedef boost::shared_ptr< source_block_ctrl_basesptr
 
- Public Types inherited from uhd::rfnoc::block_ctrl_base
typedef boost::shared_ptr< block_ctrl_basesptr
 
typedef boost::function< sptr(const make_args_t &)> make_t
 
- Public Types inherited from uhd::rfnoc::node_ctrl_base
typedef boost::shared_ptr< node_ctrl_basesptr
 
typedef boost::weak_ptr< node_ctrl_basewptr
 
typedef std::map< size_t, wptrnode_map_t
 
typedef std::pair< size_t, wptrnode_map_pair_t
 
- Public Types inherited from uhd::rfnoc::source_node_ctrl
typedef boost::shared_ptr< source_node_ctrlsptr
 
typedef std::map< size_t, boost::weak_ptr< source_node_ctrl > > node_map_t
 
typedef std::pair< size_t, boost::weak_ptr< source_node_ctrl > > node_map_pair_t
 
- Public Types inherited from uhd::rfnoc::sink_block_ctrl_base
typedef boost::shared_ptr< sink_block_ctrl_basesptr
 
- Public Types inherited from uhd::rfnoc::sink_node_ctrl
typedef boost::shared_ptr< sink_node_ctrlsptr
 
typedef std::map< size_t, boost::weak_ptr< sink_node_ctrl > > node_map_t
 
typedef std::pair< size_t, boost::weak_ptr< sink_node_ctrl > > node_map_pair_t
 
- Public Member Functions inherited from uhd::rfnoc::source_block_ctrl_base
virtual void issue_stream_cmd (const uhd::stream_cmd_t &stream_cmd, const size_t chan=0)
 
stream_sig_t get_output_signature (size_t block_port=0) const
 
std::vector< size_t > get_output_ports () const
 
virtual void set_destination (boost::uint32_t next_address, size_t output_block_port=0)
 
virtual void configure_flow_control_out (size_t buf_size_pkts, size_t block_port=0, const uhd::sid_t &sid=uhd::sid_t())
 
- Public Member Functions inherited from uhd::rfnoc::block_ctrl_base
boost::uint32_t get_address (size_t block_port=0)
 
block_id_t get_block_id () const
 
std::string unique_id () const
 
std::vector< size_t > get_ctrl_ports () const
 
void sr_write (const boost::uint32_t reg, const boost::uint32_t data, const size_t port=0)
 
void sr_write (const std::string &reg, const boost::uint32_t data, const size_t port=0)
 
boost::uint64_t sr_read64 (const settingsbus_reg_t reg, const size_t port=0)
 
boost::uint32_t sr_read32 (const settingsbus_reg_t reg, const size_t port=0)
 
boost::uint64_t user_reg_read64 (const boost::uint32_t addr, const size_t port=0)
 
boost::uint64_t user_reg_read64 (const std::string &reg, const size_t port=0)
 
boost::uint32_t user_reg_read32 (const boost::uint32_t addr, const size_t port=0)
 
boost::uint32_t user_reg_read32 (const std::string &reg, const size_t port=0)
 
void set_command_time (const time_spec_t &time_spec, const size_t port=ANY_PORT)
 
time_spec_t get_command_time (const size_t port=0)
 
void set_command_tick_rate (const double tick_rate, const size_t port=ANY_PORT)
 
void clear_command_time (const size_t port)
 
void clear (const size_t port=0)
 
void set_args (const uhd::device_addr_t &args, const size_t port=0)
 
void set_arg (const std::string &key, const std::string &val, const size_t port=0)
 Set a specific block argument. val is converted to the corresponding. More...
 
template<typename T >
void set_arg (const std::string &key, const T &val, const size_t port=0)
 Direct access to set a block argument. More...
 
uhd::device_addr_t get_args (const size_t port=0) const
 Return all block arguments as a device_addr_t. More...
 
std::string get_arg (const std::string &key, const size_t port=0) const
 Return a single block argument in string format. More...
 
template<typename T >
get_arg (const std::string &key, const size_t port=0) const
 Direct access to get a block argument. More...
 
std::string get_arg_type (const std::string &key, const size_t port=0) const
 
- Public Member Functions inherited from uhd::rfnoc::node_ctrl_base
virtual void clear ()
 
node_map_t list_downstream_nodes ()
 
node_map_t list_upstream_nodes ()
 
void set_downstream_port (const size_t this_port, const size_t remote_port)
 
size_t get_downstream_port (const size_t this_port)
 
void set_upstream_port (const size_t this_port, const size_t remote_port)
 
size_t get_upstream_port (const size_t this_port)
 
template<typename T >
UHD_INLINE std::vector< boost::shared_ptr< T > > find_downstream_node ()
 
template<typename T >
UHD_INLINE std::vector< boost::shared_ptr< T > > find_upstream_node ()
 
template<typename T , typename value_type >
UHD_INLINE value_type find_downstream_unique_property (boost::function< value_type(boost::shared_ptr< T > node, size_t port)> get_property, value_type null_value, const std::set< boost::shared_ptr< T > > &exclude_nodes=std::set< boost::shared_ptr< T > >())
 
template<typename T , typename value_type >
UHD_INLINE value_type find_upstream_unique_property (boost::function< value_type(boost::shared_ptr< T > node, size_t port)> get_property, value_type null_value, const std::set< boost::shared_ptr< T > > &exclude_nodes=std::set< boost::shared_ptr< T > >())
 
- Public Member Functions inherited from uhd::rfnoc::source_node_ctrl
size_t connect_downstream (node_ctrl_base::sptr downstream_node, size_t port=ANY_PORT, const uhd::device_addr_t &args=uhd::device_addr_t())
 
virtual void set_rx_streamer (bool active, const size_t port)
 
- Public Member Functions inherited from uhd::rfnoc::sink_block_ctrl_base
stream_sig_t get_input_signature (size_t block_port=0) const
 
std::vector< size_t > get_input_ports () const
 
size_t get_fifo_size (size_t block_port=0) const
 
virtual void configure_flow_control_in (size_t cycles, size_t packets, size_t block_port=0)
 
virtual void set_error_policy (const std::string &policy)
 
- Public Member Functions inherited from uhd::rfnoc::sink_node_ctrl
size_t connect_upstream (node_ctrl_base::sptr upstream_node, size_t port=ANY_PORT, const uhd::device_addr_t &args=uhd::device_addr_t())
 
virtual void set_tx_streamer (bool active, const size_t port)
 
- Static Public Member Functions inherited from uhd::rfnoc::block_ctrl_base
static void register_block (const make_t &make, const std::string &name)
 
static sptr make (const make_args_t &make_args, boost::uint64_t noc_id=~0)
 Create a block controller class given a NoC-ID or a block name. More...
 
- Protected Member Functions inherited from uhd::rfnoc::source_block_ctrl_base
virtual size_t _request_output_port (const size_t suggested_port, const uhd::device_addr_t &args) const
 
- Protected Member Functions inherited from uhd::rfnoc::block_ctrl_base
 block_ctrl_base (void)
 
virtual ~block_ctrl_base ()
 
 block_ctrl_base (const make_args_t &make_args)
 
stream_sig_t _resolve_port_def (const blockdef::port_t &port_def) const
 
uhd::fs_path get_arg_path (const std::string &key, size_t port=0) const
 Return the property tree path to a block argument key on port. More...
 
wb_iface::sptr get_ctrl_iface (const size_t block_port)
 Get a control interface object for block port block_port. More...
 
virtual void _clear (const size_t port=0)
 Override this function if your block does something else. More...
 
- Protected Member Functions inherited from uhd::rfnoc::node_ctrl_base
 node_ctrl_base (void)
 
virtual ~node_ctrl_base ()
 
- Protected Member Functions inherited from uhd::rfnoc::sink_block_ctrl_base
virtual size_t _request_input_port (const size_t suggested_port, const uhd::device_addr_t &args) const
 
- Protected Attributes inherited from uhd::rfnoc::block_ctrl_base
uhd::property_tree::sptr _tree
 Property sub-tree. More...
 
uhd::fs_path _root_path
 Root node of this block's properties. More...
 
bool _transport_is_big_endian
 Endianness of underlying transport (for data transport) More...
 
blockdef::sptr _block_def
 Block definition (stores info about the block such as ports) More...
 
- Protected Attributes inherited from uhd::rfnoc::node_ctrl_base
uhd::device_addr_t _args
 Stores default arguments. More...
 
node_map_t _upstream_nodes
 List of upstream nodes. More...
 
node_map_t _downstream_nodes
 List of downstream nodes. More...
 
- Protected Attributes inherited from uhd::rfnoc::source_node_ctrl
std::map< size_t, bool > _rx_streamer_active
 
- Protected Attributes inherited from uhd::rfnoc::sink_node_ctrl
std::map< size_t, bool > _tx_streamer_active
 

Detailed Description

This is the default implementation of a block_ctrl_base.

For most blocks, this will be a sufficient implementation. All registers can be set by sr_write(). The default behaviour of functions is documented in uhd::rfnoc::block_ctrl_base.


The documentation for this class was generated from the following file: