USRP Hardware Driver and USRP Manual  Version: 3.15.0.0-2+b1
UHD and USRP Manual
constants.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2014 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 #ifndef INCLUDED_LIBUHD_RFNOC_CONSTANTS_HPP
9 #define INCLUDED_LIBUHD_RFNOC_CONSTANTS_HPP
10 
11 #include <uhd/version.hpp>
12 #include <uhd/types/dict.hpp>
13 #include <stdint.h>
14 #include <boost/assign/list_of.hpp>
15 #include <string>
16 
17 namespace uhd { namespace rfnoc {
18 
19 // All these configure the XML reader
21  static const std::string XML_DEFAULT_PATH = std::string("share/uhd/")+std::string(UHD_VERSION_ABI_STRING)+std::string("/rfnoc");
23 static const std::string XML_PATH_ENV = "UHD_RFNOC_DIR";
24 
26 static const std::string DEFAULT_BLOCK_NAME = "Block";
27 static const uint64_t DEFAULT_NOC_ID = 0xFFFFFFFFFFFFFFFF;
28 static const size_t NOC_SHELL_COMPAT_MAJOR = 6;
29 static const size_t NOC_SHELL_COMPAT_MINOR = 0;
30 
31 static const size_t MAX_PACKET_SIZE = 8000; // bytes
32 static const size_t DEFAULT_PACKET_SIZE = 1456; // bytes
33 
34 // One line in FPGA is 64 Bits
35 static const size_t BYTES_PER_LINE = 8;
36 
38 static const size_t DEFAULT_FC_XBAR_RESPONSE_FREQ = 8;
40 static const size_t DEFAULT_FC_RX_RESPONSE_FREQ = 64; // ACKs per flow control window
42 static const size_t DEFAULT_FC_TX_RESPONSE_FREQ = 8; // ACKs per flow control window
44 // Why not 100% full? Because we need to have some headroom to account for the inaccuracy
45 // when computing the window size. We compute the flow control window based on the frame
46 // size but the buffer can have overhead due to things like UDP headers, page alignment,
47 // housekeeping info, etc. This number has to be transport agnostic so 20% of headroom is
48 // safe.
49 static const double DEFAULT_FC_RX_SW_BUFF_FULL_FACTOR = 0.80;
50 
51 // Common settings registers.
52 static const uint32_t SR_FLOW_CTRL_BYTES_PER_ACK = 1;
53 static const uint32_t SR_FLOW_CTRL_WINDOW_SIZE = 2;
54 static const uint32_t SR_FLOW_CTRL_EN = 3;
55 static const uint32_t SR_ERROR_POLICY = 4;
56 static const uint32_t SR_BLOCK_SID = 5; // TODO rename to SRC_SID
57 static const uint32_t SR_NEXT_DST_SID = 6;
58 static const uint32_t SR_RESP_IN_DST_SID = 7;
59 static const uint32_t SR_RESP_OUT_DST_SID = 8;
60 static const uint32_t SR_FLOW_CTRL_PKT_LIMIT = 9;
61 
62 static const uint32_t SR_READBACK_ADDR = 124;
63 static const uint32_t SR_READBACK = 127;
64 
65 static const uint32_t SR_CLEAR_RX_FC = 125;
66 static const uint32_t SR_CLEAR_TX_FC = 126;
67 
72  SR_READBACK_REG_FIFOSIZE = 2, // fifo size
77 };
78 
79 // AXI stream configuration bus (output master bus of axi wrapper) registers
80 static const uint32_t AXI_WRAPPER_BASE = 128;
81 static const uint32_t AXIS_CONFIG_BUS =
82  AXI_WRAPPER_BASE + 1; // tdata with tvalid asserted
83 static const uint32_t AXIS_CONFIG_BUS_TLAST =
84  AXI_WRAPPER_BASE + 2; // tdata with tvalid & tlast asserted
85 
86 static const size_t CMD_FIFO_SIZE = 256; // Lines == multiples of 8 bytes
87 static const size_t MAX_CMD_PKT_SIZE = 3; // Lines == multiples of 8 bytes
88 
89 // Named settings registers
90 static const uhd::dict<std::string, uint32_t> DEFAULT_NAMED_SR =
91  boost::assign::map_list_of("AXIS_CONFIG_BUS", AXIS_CONFIG_BUS)(
92  "AXIS_CONFIG_BUS_TLAST", AXIS_CONFIG_BUS_TLAST);
93 
94 // Blocks
95 static const size_t MAX_NUM_BLOCKS = 16;
96 
97 // Block ports
98 static const size_t ANY_PORT = size_t(~0);
99 static const size_t MAX_NUM_PORTS = 16;
100 
101 // Regular expressions
102 static const std::string VALID_BLOCKNAME_REGEX = "[A-Za-z][A-Za-z0-9]*";
103 static const std::string VALID_BLOCKID_REGEX =
104  "(?:(\\d+)(?:/))?([A-Za-z][A-Za-z0-9]*)(?:(?:_)(\\d\\d?))?";
105 
106 }} /* namespace uhd::rfnoc */
107 
108 #endif /* INCLUDED_LIBUHD_RFNOC_CONSTANTS_HPP */
uhd::rfnoc::settingsbus_reg_t
settingsbus_reg_t
Settings register readback.
Definition: constants.hpp:69
uhd::rfnoc::SR_READBACK_REG_FIFOSIZE
Definition: constants.hpp:72
uhd::rfnoc::SR_READBACK_REG_ID
Definition: constants.hpp:70
uhd::rfnoc::SR_READBACK_COMPAT
Definition: constants.hpp:76
uhd::rfnoc::SR_READBACK_REG_BLOCKPORT_SIDS
Definition: constants.hpp:74
uhd::rfnoc::SR_READBACK_REG_USER
Definition: constants.hpp:75
uhd::rfnoc::SR_READBACK_REG_MTU
Definition: constants.hpp:73
uhd::rfnoc::SR_READBACK_REG_GLOBAL_PARAMS
Definition: constants.hpp:71
uhd
Definition: build_info.hpp:13
uhd::dict
Definition: dict.hpp:21
dict.hpp