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
|
//
// Copyright 2019 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef INCLUDED_LIBUHD_MB_IFACE_HPP
#define INCLUDED_LIBUHD_MB_IFACE_HPP
#include <uhdlib/rfnoc/chdr_ctrl_xport.hpp>
#include <uhdlib/rfnoc/chdr_rx_data_xport.hpp>
#include <uhdlib/rfnoc/chdr_tx_data_xport.hpp>
#include <uhdlib/rfnoc/clock_iface.hpp>
#include <uhdlib/rfnoc/rfnoc_common.hpp>
#include <memory>
namespace uhd { namespace rfnoc {
/*! Motherboard (backchannel) interface
*
* In RFNoC devices, the RFNoC subystem needs a backchannel interface to talk to
* the individual motherboards. Every rfnoc_graph needs one interface per
* attached motherboard.
*
* It's up to the various device implementations (e.g., x300_impl) to implement
* this interface.
*/
class mb_iface
{
public:
using uptr = std::unique_ptr<mb_iface>;
virtual ~mb_iface() = default;
/*! Return the RFNoC protocol version of the firmware running on this motherboard
*/
virtual uint16_t get_proto_ver() = 0;
/*! Return the CHDR width of the firmware running on this motherboard
*/
virtual chdr_w_t get_chdr_w() = 0;
/*! Get the device ID assigned to the motherboard
*
* A freshly reset motherboard should return 0.
*
* \returns the motherboard's device ID
*/
virtual device_id_t get_remote_device_id() = 0;
/*! Get the local (software) device IDs on this motherboard that can actively
* communicate with the sea of RFNoC FPGAs. The number of local devices returned
* should be equal to the number of physical links on the motherboard that are
* actively connected.
*
* \returns The active software device IDs
*/
virtual std::vector<device_id_t> get_local_device_ids() = 0;
/*! Reset the device
*/
virtual void reset_network() = 0;
/*! Return a reference to a clock iface
*/
virtual std::shared_ptr<clock_iface> get_clock_iface(
const std::string& clock_name) = 0;
/*! Create a control transport
*
* This is usually called once per motherboard, since there is only one
* control transport required to talk to all the blocks on the control
* crossbar.
*
* \param local_device_id ID for the host transport adapter to use
* \param local_epid Host streaming endpoint ID
* \return A CHDR control transport
*/
virtual chdr_ctrl_xport::sptr make_ctrl_transport(
device_id_t local_device_id, const sep_id_t& local_epid) = 0;
/*! Create an RX data transport
*
* This is typically called once per streaming channel.
*
* \param addrs Address of the device and host stream endpoints
* \param epids Endpoint IDs of the device and host stream endpoints
* \param pyld_buff_fmt Datatype of SW buffer that holds the data payload
* \param mdata_buff_fmt Datatype of SW buffer that holds the data metadata
* \param xport_args Transport configuration args
* \return A CHDR RX data transport
*/
virtual chdr_rx_data_xport::uptr make_rx_data_transport(const sep_addr_pair_t& addrs,
const sep_id_pair_t& epids,
const sw_buff_t pyld_buff_fmt,
const sw_buff_t mdata_buff_fmt,
const device_addr_t& xport_args) = 0;
/*! Create an TX data transport
*
* This is typically called once per streaming channel.
*
* \param addrs Address of the host and device stream endpoints
* \param epids Endpoint IDs of the host and device stream endpoints
* \param pyld_buff_fmt Datatype of SW buffer that holds the data payload
* \param mdata_buff_fmt Datatype of SW buffer that holds the data metadata
* \param xport_args Transport configuration args
* \return A CHDR TX data transport
*/
virtual chdr_tx_data_xport::uptr make_tx_data_transport(const sep_addr_pair_t& addrs,
const sep_id_pair_t& epids,
const uhd::rfnoc::sw_buff_t pyld_buff_fmt,
const uhd::rfnoc::sw_buff_t mdata_buff_fmt,
const device_addr_t& xport_args) = 0;
};
}} /* namespace uhd::rfnoc */
#endif /* INCLUDED_LIBUHD_MB_IFACE_HPP */
|
