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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
//
// Copyright 2013 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#include <uhd/transport/nirio/niusrprio_session.h>
#include <uhd/transport/nirio/nirio_fifo.h>
#include <uhd/transport/nirio/status.h>
#include <boost/format.hpp>
#include <boost/algorithm/string.hpp>
#include <stdio.h>
#include <fstream>
//@TODO: Move the register defs required by the class to a common location
#include "../../usrp/x300/x300_regs.hpp"
namespace uhd { namespace niusrprio {
niusrprio_session::niusrprio_session(const std::string& resource_name, const std::string& rpc_port_name) :
_resource_name(resource_name),
_session_open(false),
_resource_manager(),
_rpc_client("localhost", rpc_port_name)
{
_riok_proxy = create_kernel_proxy(resource_name,rpc_port_name);
_resource_manager.set_proxy(_riok_proxy);
}
niusrprio_session::~niusrprio_session()
{
close();
}
nirio_status niusrprio_session::enumerate(const std::string& rpc_port_name, device_info_vtr& device_info_vtr)
{
usrprio_rpc::usrprio_rpc_client temp_rpc_client("localhost", rpc_port_name);
nirio_status status = temp_rpc_client.get_ctor_status();
nirio_status_chain(temp_rpc_client.niusrprio_enumerate(device_info_vtr), status);
return status;
}
nirio_status niusrprio_session::open(
nifpga_lvbitx::sptr lvbitx,
bool force_download)
{
boost::unique_lock<boost::recursive_mutex> lock(_session_mutex);
_lvbitx = lvbitx;
nirio_status status = NiRio_Status_Success;
std::string bitfile_path(_lvbitx->get_bitfile_path());
std::string signature(_lvbitx->get_signature());
//Make sure that the RPC client connected to the server properly
nirio_status_chain(_rpc_client.get_ctor_status(), status);
//Get a handle to the kernel driver
nirio_status_chain(_rpc_client.niusrprio_get_interface_path(_resource_name, _interface_path), status);
nirio_status_chain(_riok_proxy->open(_interface_path), status);
if (nirio_status_not_fatal(status)) {
//Bitfile build for a particular LVFPGA interface will have the same signature
//because the API of the bitfile does not change. Two files with the same signature
//can however have different bitstreams because of non-LVFPGA code differences.
//That is why we need another identifier to qualify the signature. The BIN
//checksum is a good candidate.
std::string lvbitx_checksum(_lvbitx->get_bitstream_checksum());
uint16_t download_fpga = (force_download || (_read_bitstream_checksum() != lvbitx_checksum)) ? 1 : 0;
nirio_status_chain(_ensure_fpga_ready(), status);
nirio_status_chain(_rpc_client.niusrprio_open_session(
_resource_name, bitfile_path, signature, download_fpga), status);
_session_open = nirio_status_not_fatal(status);
if (nirio_status_not_fatal(status)) {
nirio_register_info_vtr reg_vtr;
nirio_fifo_info_vtr fifo_vtr;
_lvbitx->init_register_info(reg_vtr);
_lvbitx->init_fifo_info(fifo_vtr);
_resource_manager.initialize(reg_vtr, fifo_vtr);
nirio_status_chain(_verify_signature(), status);
nirio_status_chain(_write_bitstream_checksum(lvbitx_checksum), status);
}
}
return status;
}
void niusrprio_session::close(bool skip_reset)
{
boost::unique_lock<boost::recursive_mutex> lock(_session_mutex);
if (_session_open) {
nirio_status status = NiRio_Status_Success;
if (!skip_reset) reset();
nirio_status_chain(_rpc_client.niusrprio_close_session(_resource_name), status);
_session_open = false;
}
}
nirio_status niusrprio_session::reset()
{
boost::unique_lock<boost::recursive_mutex> lock(_session_mutex);
return _rpc_client.niusrprio_reset_device(_resource_name);
}
nirio_status niusrprio_session::download_bitstream_to_flash(const std::string& bitstream_path)
{
boost::unique_lock<boost::recursive_mutex> lock(_session_mutex);
return _rpc_client.niusrprio_download_fpga_to_flash(_resource_name, bitstream_path);
}
niriok_proxy::sptr niusrprio_session::create_kernel_proxy(
const std::string& resource_name,
const std::string& rpc_port_name)
{
usrprio_rpc::usrprio_rpc_client temp_rpc_client("localhost", rpc_port_name);
nirio_status status = temp_rpc_client.get_ctor_status();
std::string interface_path;
nirio_status_chain(temp_rpc_client.niusrprio_get_interface_path(resource_name, interface_path), status);
niriok_proxy::sptr proxy = niriok_proxy::make_and_open(interface_path);
return proxy;
}
nirio_status niusrprio_session::_verify_signature()
{
//Validate the signature using the kernel proxy
nirio_status status = NiRio_Status_Success;
uint32_t sig_offset = 0;
nirio_status_chain(_riok_proxy->get_attribute(RIO_FPGA_DEFAULT_SIGNATURE_OFFSET, sig_offset), status);
niriok_scoped_addr_space(_riok_proxy, FPGA, status);
std::string signature;
for (uint32_t i = 0; i < 8; i++) {
uint32_t quarter_sig;
nirio_status_chain(_riok_proxy->peek(sig_offset, quarter_sig), status);
signature += boost::str(boost::format("%08x") % quarter_sig);
}
std::string expected_signature(_lvbitx->get_signature());
boost::to_upper(signature);
boost::to_upper(expected_signature);
if (signature.find(expected_signature) == std::string::npos) {
nirio_status_chain(NiRio_Status_SignatureMismatch, status);
}
return status;
}
std::string niusrprio_session::_read_bitstream_checksum()
{
nirio_status status = NiRio_Status_Success;
niriok_scoped_addr_space(_riok_proxy, BUS_INTERFACE, status);
std::string usr_signature;
for (uint32_t i = 0; i < FPGA_USR_SIG_REG_SIZE; i+=4) {
uint32_t quarter_sig;
nirio_status_chain(_riok_proxy->peek(FPGA_USR_SIG_REG_BASE + i, quarter_sig), status);
usr_signature += boost::str(boost::format("%08x") % quarter_sig);
}
boost::to_upper(usr_signature);
return usr_signature;
}
nirio_status niusrprio_session::_write_bitstream_checksum(const std::string& checksum)
{
nirio_status status = NiRio_Status_Success;
niriok_scoped_addr_space(_riok_proxy, BUS_INTERFACE, status);
for (uint32_t i = 0; i < FPGA_USR_SIG_REG_SIZE; i+=4) {
uint32_t quarter_sig;
try {
std::stringstream ss;
ss << std::hex << checksum.substr(i*2,8);
ss >> quarter_sig;
} catch (std::exception&) {
quarter_sig = 0;
}
nirio_status_chain(_riok_proxy->poke(FPGA_USR_SIG_REG_BASE + i, quarter_sig), status);
}
return status;
}
nirio_status niusrprio_session::_ensure_fpga_ready()
{
nirio_status status = NiRio_Status_Success;
niriok_scoped_addr_space(_riok_proxy, BUS_INTERFACE, status);
//Verify that the Ettus FPGA loaded in the device. This may not be true if the
//user is switching to UHD after using LabVIEW FPGA. In that case skip this check.
uint32_t pcie_fpga_signature = 0;
nirio_status_chain(_riok_proxy->peek(FPGA_PCIE_SIG_REG, pcie_fpga_signature), status);
//@TODO: Remove X300 specific constants for future products
if (pcie_fpga_signature != FPGA_X3xx_SIG_VALUE) {
return status;
}
uint32_t reg_data = 0xffffffff;
nirio_status_chain(_riok_proxy->peek(FPGA_STATUS_REG, reg_data), status);
if (nirio_status_not_fatal(status) && (reg_data & FPGA_STATUS_DMA_ACTIVE_MASK))
{
//In case this session was re-initialized *immediately* after the previous
//there is a small chance that the server is still finishing up cleaning up
//the DMA FIFOs. We currently don't have any feedback from the driver regarding
//this state so just wait.
boost::this_thread::sleep(boost::posix_time::milliseconds(FPGA_READY_TIMEOUT_IN_MS));
//Disable all FIFOs in the FPGA
for (size_t i = 0; i < _lvbitx->get_input_fifo_count(); i++) {
_riok_proxy->poke(PCIE_RX_DMA_REG(DMA_CTRL_STATUS_REG, i), DMA_CTRL_DISABLED);
}
for (size_t i = 0; i < _lvbitx->get_output_fifo_count(); i++) {
_riok_proxy->poke(PCIE_TX_DMA_REG(DMA_CTRL_STATUS_REG, i), DMA_CTRL_DISABLED);
}
//Disable all FIFOs in the kernel driver
_riok_proxy->stop_all_fifos();
boost::posix_time::ptime start_time = boost::posix_time::microsec_clock::local_time();
boost::posix_time::time_duration elapsed;
do {
boost::this_thread::sleep(boost::posix_time::milliseconds(10)); //Avoid flooding the bus
elapsed = boost::posix_time::microsec_clock::local_time() - start_time;
nirio_status_chain(_riok_proxy->peek(FPGA_STATUS_REG, reg_data), status);
} while (
nirio_status_not_fatal(status) &&
(reg_data & FPGA_STATUS_DMA_ACTIVE_MASK) &&
elapsed.total_milliseconds() < FPGA_READY_TIMEOUT_IN_MS);
nirio_status_chain(_riok_proxy->peek(FPGA_STATUS_REG, reg_data), status);
if (nirio_status_not_fatal(status) && (reg_data & FPGA_STATUS_DMA_ACTIVE_MASK)) {
return NiRio_Status_FifoReserved;
}
}
return status;
}
}}
|
