USRP Hardware Driver and USRP Manual Version: 4.1.0.3
UHD and USRP Manual
blockdef.hpp
Go to the documentation of this file.
1//
2// Copyright 2014-2015 Ettus Research LLC
3// Copyright 2018 Ettus Research, a National Instruments Company
4//
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
7
8#pragma once
9
10#include <uhd/config.hpp>
12#include <stdint.h>
13#include <memory>
14#include <set>
15#include <vector>
16
17namespace uhd { namespace rfnoc {
18
21class UHD_API blockdef : public std::enable_shared_from_this<blockdef>
22{
23public:
24 typedef std::shared_ptr<blockdef> sptr;
25
27 //
28 // This is not the same as a uhd::rfnoc::stream_sig_t. This is used
29 // to describe which ports are defined in a block definition, and
30 // to describe what kind of connection is allowed for this port.
31 //
32 // All the keys listed in PORT_ARGS will be available in this class.
33 class port_t : public uhd::dict<std::string, std::string>
34 {
35 public:
38
40
42 bool is_variable(const std::string& key) const;
44 bool is_keyword(const std::string& key) const;
46 // keywords are not resolved.
47 bool is_valid() const;
49 std::string to_string() const;
50 };
51 typedef std::vector<port_t> ports_t;
52
54 class arg_t : public uhd::dict<std::string, std::string>
55 {
56 public:
58 static const device_addr_t ARG_ARGS;
59 static const std::set<std::string> VALID_TYPES;
60
62
64 bool is_valid() const;
66 std::string to_string() const;
67 };
68 typedef std::vector<arg_t> args_t;
69
71
78 static sptr make_from_noc_id(uint64_t noc_id);
79
81 virtual bool is_block() const = 0;
82
84 virtual bool is_component() const = 0;
85
87 virtual std::string get_key() const = 0;
88
90 virtual std::string get_name() const = 0;
91
93 virtual uint64_t noc_id() const = 0;
94
95 virtual ports_t get_input_ports() = 0;
97
99 virtual std::vector<size_t> get_all_port_numbers() = 0;
100
102 //
103 // \throws uhd::runtime_error if args are invalid.
104 virtual args_t get_args() = 0;
105
108
111};
112
113}} /* namespace uhd::rfnoc */
Definition: device_addr.hpp:38
Definition: dict.hpp:22
Describes arguments in a block definition.
Definition: blockdef.hpp:55
bool is_valid() const
Basic validity check of this argument definition.
static const std::set< std::string > VALID_TYPES
Definition: blockdef.hpp:59
static const device_addr_t ARG_ARGS
A list of args an argument can have.
Definition: blockdef.hpp:58
std::string to_string() const
Returns a string with the most important keys.
Describes port options for a block definition.
Definition: blockdef.hpp:34
bool is_variable(const std::string &key) const
Checks if the value at key is a variable (e.g. '$fftlen')
static const device_addr_t PORT_ARGS
A list of args a port can have.
Definition: blockdef.hpp:37
bool is_keyword(const std::string &key) const
Checks if the value at key is a keyword (e.g. 'vlen')
bool is_valid() const
Basic validity check of this port definition. Variables and.
std::string to_string() const
Returns a string with the most important keys.
Definition: blockdef.hpp:22
virtual std::string get_key() const =0
Returns block key (i.e. what is used for the registry)
static sptr make_from_noc_id(uint64_t noc_id)
virtual registers_t get_readback_registers()=0
Returns a list of readback (user) registers by name.
virtual uint64_t noc_id() const =0
Return the one NoC that is valid for this block.
virtual bool is_component() const =0
Returns true if this represents a component.
virtual ports_t get_input_ports()=0
virtual ports_t get_output_ports()=0
virtual std::vector< size_t > get_all_port_numbers()=0
Returns the full list of port numbers used.
std::shared_ptr< blockdef > sptr
Definition: blockdef.hpp:24
virtual args_t get_args()=0
Returns the args for this block. Checks if args are valid.
virtual registers_t get_settings_registers()=0
Returns a list of settings registers by name.
std::vector< arg_t > args_t
Definition: blockdef.hpp:68
virtual std::string get_name() const =0
For blocks, returns the block name. For components, returns it's canonical name.
uhd::dict< std::string, size_t > registers_t
Definition: blockdef.hpp:70
std::vector< port_t > ports_t
Definition: blockdef.hpp:51
virtual bool is_block() const =0
Returns true if this represents a NoC block.
#define UHD_API
Definition: config.h:70
Definition: build_info.hpp:12