1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/* -*- c++ -*- */
/*
* Copyright 2019 Ettus Research, a National Instruments Brand.
* Copyright 2020 Free Software Foundation, Inc.
*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
#ifndef INCLUDED_GR_UHD_RFNOC_GRAPH_H
#define INCLUDED_GR_UHD_RFNOC_GRAPH_H
#include <gnuradio/uhd/api.h>
#include <uhd/rfnoc/noc_block_base.hpp>
#include <uhd/stream.hpp>
#include <uhd/types/device_addr.hpp>
#include <boost/shared_ptr.hpp>
namespace gr {
namespace uhd {
class rfnoc_block;
/*! GNU Radio-specific wrapper for uhd::rfnoc::rfnoc_graph
*
* This wraps uhd::rfnoc::rfnoc_graph for simpler insertion into GNU Radio flow
* graphs. All API calls match those on said class.
*/
class GR_UHD_API rfnoc_graph
{
public:
using sptr = boost::shared_ptr<rfnoc_graph>;
static sptr make(const ::uhd::device_addr_t& dev_addr);
virtual ~rfnoc_graph() {}
//! Connect two blocks, or a block to a streamer, or a streamer to a block
//
// \param src_block The block ID of the source block (e.g., "0/Radio#0)
// \param src_block_port The port on the source block to connect to
// \param dst_block The block ID of the destination block (e.g., "0/DDC#0)
// \param dst_block_port The port on the destination block to connect to
// \param skip_property_propagation Disable property propagation on this
// connection (see the UHD documentation)
virtual void connect(const std::string& src_block,
const size_t src_block_port,
const std::string& dst_block,
const size_t dst_block_port,
const bool skip_property_propagation = false) = 0;
//! Convenience overload: Defaults to port 0 on both blocks
//
// \param src_block The block ID of the source block (e.g., "0/Radio#0)
// \param dst_block The block ID of the destination block (e.g., "0/DDC#0)
// \param skip_property_propagation Disable property propagation on this
// connection (see the UHD documentation)
virtual void connect(const std::string& src_block,
const std::string& dst_block,
const bool skip_property_propagation = false) = 0;
//! Create an RX streamer
//
// Note: This streamer is not connected to anything after creation.
//
// See also the UHD documentation for uhd::rfnoc::rfnoc_graph::create_rx_streamer().
//
// \param num_ports Number of streaming ports
// \param args Stream args.
virtual ::uhd::rx_streamer::sptr
create_rx_streamer(const size_t num_ports, const ::uhd::stream_args_t& args) = 0;
//! Create a TX streamer
//
// Note: This streamer is not connected to anything after creation.
//
// See also the UHD documentation for uhd::rfnoc::rfnoc_graph::create_tx_streamer().
//
// \param num_ports Number of streaming ports
// \param args Stream args.
virtual ::uhd::tx_streamer::sptr
create_tx_streamer(const size_t num_ports, const ::uhd::stream_args_t& args) = 0;
//! Commit the graph and run initial checks
//
// See ::uhd::rfnoc::rfnoc_graph::commit() for more documentation.
virtual void commit() = 0;
/*! Return a valid block ID string, if it exists, or an empty string, if not
*
* This will check the available blocks on the connected devices and see if
* they match the block name, device ID, and block number.
*/
virtual std::string get_block_id(const std::string& block_name,
const int device_select,
const int block_select) = 0;
//! Set time source on the specified motherboard
//
// Note: This is a convenience call, it directly dereferences the underlying
// motherboard controller.
//
// \param source Time source (e.g., "internal")
// \param mb_index Motherboard index, starting at 0
virtual void set_time_source(const std::string& source, const size_t mb_index) = 0;
//! Set clock source on the specified motherboard
//
// Note: This is a convenience call, it directly dereferences the underlying
// motherboard controller.
//
// \param source Clock source (e.g., "internal")
// \param mb_index Motherboard index, starting at 0
virtual void set_clock_source(const std::string& source, const size_t mb_index) = 0;
//! Return a reference to the block with a given block ID
//
// This allows to retrieve a shared pointer to a block controller with a
// limit. It keeps track of the references given out, and will throw an
// exception if called more than max_ref_count times. This is to help ensure
// that GNU Radio blocks don't share block controllers unintentionally.
//
// \param block_id A valid block ID. Use get_block_id() to make sure it is
// valid.
// \param max_ref_count The maximum number of references that are doled out.
//
// \throws std::runtime_error if more than \p max_ref_count references are
// given out
virtual ::uhd::rfnoc::noc_block_base::sptr
get_block_ref(const std::string& block_id, const size_t max_ref_count) = 0;
};
} // namespace uhd
} // namespace gr
#endif /* INCLUDED_GR_UHD_RFNOC_GRAPH_H */
|
