12 #include <boost/format.hpp> 13 #include <boost/optional.hpp> 19 namespace uhd {
namespace rfnoc {
namespace chdr {
47 return get_field<uint8_t>(_flat_hdr, VC_OFFSET, VC_WIDTH);
53 _flat_hdr = set_field(_flat_hdr, vc, VC_OFFSET, VC_WIDTH);
59 return get_field<bool>(_flat_hdr, EOB_OFFSET, EOB_WIDTH);
65 _flat_hdr = set_field(_flat_hdr, eob, EOB_OFFSET, EOB_WIDTH);
71 return get_field<bool>(_flat_hdr, EOV_OFFSET, EOV_WIDTH);
77 _flat_hdr = set_field(_flat_hdr, eov, EOV_OFFSET, EOV_WIDTH);
83 return get_field<packet_type_t>(_flat_hdr, PKT_TYPE_OFFSET, PKT_TYPE_WIDTH);
89 _flat_hdr = set_field(_flat_hdr, pkt_type, PKT_TYPE_OFFSET, PKT_TYPE_WIDTH);
95 return get_field<uint8_t>(_flat_hdr, NUM_MDATA_OFFSET, NUM_MDATA_WIDTH);
101 _flat_hdr = set_field(_flat_hdr, num_mdata, NUM_MDATA_OFFSET, NUM_MDATA_WIDTH);
107 return get_field<uint16_t>(_flat_hdr, SEQ_NUM_OFFSET, SEQ_NUM_WIDTH);
113 _flat_hdr = set_field(_flat_hdr, seq_num, SEQ_NUM_OFFSET, SEQ_NUM_WIDTH);
119 return get_field<uint16_t>(_flat_hdr, LENGTH_OFFSET, LENGTH_WIDTH);
125 _flat_hdr = set_field(_flat_hdr, length, LENGTH_OFFSET, LENGTH_WIDTH);
131 return get_field<uint16_t>(_flat_hdr, DST_EPID_OFFSET, DST_EPID_WIDTH);
137 _flat_hdr = set_field(_flat_hdr, dst_epid, DST_EPID_OFFSET, DST_EPID_WIDTH);
147 inline operator uint64_t()
const 155 return _flat_hdr == rhs._flat_hdr;
161 return _flat_hdr != rhs._flat_hdr;
167 _flat_hdr = rhs._flat_hdr;
184 return str(boost::format(
"chdr_header{vc:%u, eob:%c, eov:%c, pkt_type:%u, " 185 "num_mdata:%u, seq_num:%u, length:%u, dst_epid:%u}\n")
194 uint64_t _flat_hdr = 0;
196 static constexpr
size_t VC_WIDTH = 6;
197 static constexpr
size_t EOB_WIDTH = 1;
198 static constexpr
size_t EOV_WIDTH = 1;
199 static constexpr
size_t PKT_TYPE_WIDTH = 3;
200 static constexpr
size_t NUM_MDATA_WIDTH = 5;
201 static constexpr
size_t SEQ_NUM_WIDTH = 16;
202 static constexpr
size_t LENGTH_WIDTH = 16;
203 static constexpr
size_t DST_EPID_WIDTH = 16;
205 static constexpr
size_t VC_OFFSET = 58;
206 static constexpr
size_t EOB_OFFSET = 57;
207 static constexpr
size_t EOV_OFFSET = 56;
208 static constexpr
size_t PKT_TYPE_OFFSET = 53;
209 static constexpr
size_t NUM_MDATA_OFFSET = 48;
210 static constexpr
size_t SEQ_NUM_OFFSET = 32;
211 static constexpr
size_t LENGTH_OFFSET = 16;
212 static constexpr
size_t DST_EPID_OFFSET = 0;
214 static inline uint64_t mask(
const size_t width)
216 return ((uint64_t(1) <<
width) - 1);
219 template <
typename field_t>
220 static inline field_t get_field(
221 const uint64_t flat_hdr,
const size_t offset,
const size_t width)
223 return static_cast<field_t
>((flat_hdr >> offset) & mask(
width));
226 template <
typename field_t>
227 static inline uint64_t set_field(
const uint64_t old_val,
232 return (old_val & ~(mask(
width) << offset))
233 | ((
static_cast<uint64_t
>(field) & mask(
width)) << offset);
269 uint16_t dst_port = 0;
271 uint16_t src_port = 0;
275 boost::optional<uint64_t> timestamp = boost::none;
279 uint16_t src_epid = 0;
281 uint32_t address = 0;
283 std::vector<uint32_t> data_vtr = {0};
285 uint8_t byte_enable = 0xF;
302 size_t serialize(uint64_t* buff,
303 size_t max_size_bytes,
304 const std::function<uint64_t(uint64_t)>& conv_byte_order)
const;
307 template <endianness_t endianness>
308 size_t serialize(uint64_t* buff,
size_t max_size_bytes)
const 310 auto conv_byte_order = [](uint64_t x) -> uint64_t {
312 : uhd::htowx<uint64_t>(x);
314 return serialize(buff, max_size_bytes, conv_byte_order);
318 void deserialize(
const uint64_t* buff,
320 const std::function<uint64_t(uint64_t)>& conv_byte_order);
323 template <endianness_t endianness>
326 auto conv_byte_order = [](uint64_t x) -> uint64_t {
328 : uhd::wtohx<uint64_t>(x);
330 deserialize(buff, num_elems, conv_byte_order);
334 size_t get_length()
const;
339 return bool(timestamp);
348 return !(*
this == rhs);
352 const std::string to_string()
const;
355 static constexpr
size_t DST_PORT_WIDTH = 10;
356 static constexpr
size_t SRC_PORT_WIDTH = 10;
357 static constexpr
size_t NUM_DATA_WIDTH = 4;
358 static constexpr
size_t SEQ_NUM_WIDTH = 6;
359 static constexpr
size_t HAS_TIME_WIDTH = 1;
360 static constexpr
size_t IS_ACK_WIDTH = 1;
361 static constexpr
size_t SRC_EPID_WIDTH = 16;
362 static constexpr
size_t ADDRESS_WIDTH = 20;
363 static constexpr
size_t BYTE_ENABLE_WIDTH = 4;
364 static constexpr
size_t OPCODE_WIDTH = 4;
365 static constexpr
size_t STATUS_WIDTH = 2;
368 static constexpr
size_t DST_PORT_OFFSET = 0;
369 static constexpr
size_t SRC_PORT_OFFSET = 10;
370 static constexpr
size_t NUM_DATA_OFFSET = 20;
371 static constexpr
size_t SEQ_NUM_OFFSET = 24;
372 static constexpr
size_t HAS_TIME_OFFSET = 30;
373 static constexpr
size_t IS_ACK_OFFSET = 31;
374 static constexpr
size_t SRC_EPID_OFFSET = 32;
375 static constexpr
size_t ADDRESS_OFFSET = 0;
376 static constexpr
size_t BYTE_ENABLE_OFFSET = 20;
377 static constexpr
size_t OPCODE_OFFSET = 24;
378 static constexpr
size_t STATUS_OFFSET = 30;
379 static constexpr
size_t LO_DATA_OFFSET = 0;
380 static constexpr
size_t HI_DATA_OFFSET = 32;
399 uint16_t src_epid = 0;
403 uint64_t capacity_bytes = 0;
405 uint32_t capacity_pkts = 0;
407 uint64_t xfer_count_bytes = 0;
409 uint64_t xfer_count_pkts = 0;
411 uint16_t buff_info = 0;
413 uint64_t status_info = 0;
426 size_t serialize(uint64_t* buff,
427 size_t max_size_bytes,
428 const std::function<uint64_t(uint64_t)>& conv_byte_order)
const;
431 template <endianness_t endianness>
432 size_t serialize(uint64_t* buff,
size_t max_size_bytes)
const 434 auto conv_byte_order = [](uint64_t x) -> uint64_t {
436 : uhd::htowx<uint64_t>(x);
438 return serialize(buff, max_size_bytes, conv_byte_order);
442 void deserialize(
const uint64_t* buff,
444 const std::function<uint64_t(uint64_t)>& conv_byte_order);
447 template <endianness_t endianness>
450 auto conv_byte_order = [](uint64_t x) -> uint64_t {
452 : uhd::wtohx<uint64_t>(x);
454 deserialize(buff, num_elems, conv_byte_order);
458 size_t get_length()
const;
466 return !(*
this == rhs);
470 const std::string to_string()
const;
473 static constexpr
size_t SRC_EPID_WIDTH = 16;
474 static constexpr
size_t STATUS_WIDTH = 4;
475 static constexpr
size_t CAPACITY_BYTES_WIDTH = 40;
476 static constexpr
size_t CAPACITY_PKTS_WIDTH = 24;
477 static constexpr
size_t XFER_COUNT_PKTS_WIDTH = 40;
478 static constexpr
size_t BUFF_INFO_WIDTH = 16;
479 static constexpr
size_t STATUS_INFO_WIDTH = 48;
482 static constexpr
size_t SRC_EPID_OFFSET = 0;
483 static constexpr
size_t STATUS_OFFSET = 16;
484 static constexpr
size_t CAPACITY_BYTES_OFFSET = 24;
485 static constexpr
size_t CAPACITY_PKTS_OFFSET = 0;
486 static constexpr
size_t XFER_COUNT_PKTS_OFFSET = 24;
487 static constexpr
size_t BUFF_INFO_OFFSET = 0;
488 static constexpr
size_t STATUS_INFO_OFFSET = 16;
505 uint16_t src_epid = 0;
511 uint64_t num_pkts = 0;
513 uint64_t num_bytes = 0;
515 static constexpr
size_t MAX_PACKET_SIZE = 128;
528 size_t serialize(uint64_t* buff,
529 size_t max_size_bytes,
530 const std::function<uint64_t(uint64_t)>& conv_byte_order)
const;
533 template <endianness_t endianness>
534 size_t serialize(uint64_t* buff,
size_t max_size_bytes)
const 536 auto conv_byte_order = [](uint64_t x) -> uint64_t {
538 : uhd::htowx<uint64_t>(x);
540 return serialize(buff, max_size_bytes, conv_byte_order);
544 void deserialize(
const uint64_t* buff,
546 const std::function<uint64_t(uint64_t)>& conv_byte_order);
549 template <endianness_t endianness>
552 auto conv_byte_order = [](uint64_t x) -> uint64_t {
554 : uhd::wtohx<uint64_t>(x);
556 deserialize(buff, num_elems, conv_byte_order);
560 size_t get_length()
const;
568 return !(*
this == rhs);
572 const std::string to_string()
const;
575 static constexpr
size_t SRC_EPID_WIDTH = 16;
576 static constexpr
size_t OP_CODE_WIDTH = 4;
577 static constexpr
size_t OP_DATA_WIDTH = 4;
578 static constexpr
size_t NUM_PKTS_WIDTH = 40;
581 static constexpr
size_t SRC_EPID_OFFSET = 0;
582 static constexpr
size_t OP_CODE_OFFSET = 16;
583 static constexpr
size_t OP_DATA_OFFSET = 20;
584 static constexpr
size_t NUM_PKTS_OFFSET = 24;
602 MGMT_OP_ADVERTISE = 1,
604 MGMT_OP_SEL_DEST = 2,
608 MGMT_OP_INFO_REQ = 4,
610 MGMT_OP_INFO_RESP = 5,
612 MGMT_OP_CFG_WR_REQ = 6,
614 MGMT_OP_CFG_RD_REQ = 7,
616 MGMT_OP_CFG_RD_RESP = 8
642 cfg_payload(uint16_t addr_, uint32_t data_ = 0) : addr(addr_), data(data_) {}
644 : addr(static_cast<uint16_t>(payload_ >> 0))
645 , data(static_cast<uint32_t>(payload_ >> 16))
650 return ((static_cast<payload_t>(data) << 16) | static_cast<payload_t>(addr));
666 : device_id(device_id_)
667 , node_type(node_type_)
668 , node_inst(node_inst_)
669 , ext_info(ext_info_)
673 : device_id(static_cast<uint16_t>(payload_ >> 0))
674 , node_type(static_cast<uint8_t>((payload_ >> 16) & 0xF))
675 , node_inst(static_cast<uint16_t>((payload_ >> 20) & 0x3FF))
676 , ext_info(static_cast<uint32_t>((payload_ >> 30) & 0x3FFFF))
681 return ((static_cast<payload_t>(device_id) << 0)
682 | (static_cast<payload_t>(node_type & 0xF) << 16)
683 | (static_cast<payload_t>(node_inst & 0x3FF) << 20)
684 | (static_cast<payload_t>(ext_info & 0x3FFFF) << 30));
689 : _op_code(op_code), _op_payload(op_payload)
709 return (_op_code == rhs._op_code) && (_op_payload == rhs._op_payload);
713 const std::string to_string()
const;
717 payload_t _op_payload;
751 size_t serialize(std::vector<uint64_t>& target,
752 const std::function<uint64_t(uint64_t)>& conv_byte_order,
753 const size_t padding_size)
const;
758 void deserialize(std::list<uint64_t>& src,
759 const std::function<uint64_t(uint64_t)>& conv_byte_order,
760 const size_t padding_size);
765 return _ops == rhs._ops;
769 const std::string to_string()
const;
772 std::vector<mgmt_op_t> _ops;
789 set_src_epid(src_epid);
791 set_proto_ver(protover);
798 _hops.push_back(hop);
816 auto hop = _hops.front();
823 size_t num_lines = 1;
824 for (
const auto& hop : _hops) {
825 num_lines += hop.get_num_ops();
834 size_t serialize(uint64_t* buff,
835 size_t max_size_bytes,
836 const std::function<uint64_t(uint64_t)>& conv_byte_order)
const;
839 template <endianness_t endianness>
840 size_t serialize(uint64_t* buff,
size_t max_size_bytes)
const 842 auto conv_byte_order = [](uint64_t x) -> uint64_t {
844 : uhd::htowx<uint64_t>(x);
846 return serialize(buff, max_size_bytes, conv_byte_order);
850 void deserialize(
const uint64_t* buff,
852 const std::function<uint64_t(uint64_t)>& conv_byte_order);
855 template <endianness_t endianness>
858 auto conv_byte_order = [](uint64_t x) -> uint64_t {
860 : uhd::wtohx<uint64_t>(x);
862 deserialize(buff, num_elems, conv_byte_order);
866 size_t get_length()
const;
869 const std::string to_string()
const;
872 const std::string hops_to_string()
const;
883 _src_epid = src_epid;
911 _protover = proto_ver;
916 uint16_t _protover = 0;
918 size_t _padding_size = 0;
919 std::deque<mgmt_hop_t> _hops;
923 template <
typename payload_t>
Definition: chdr_types.hpp:251
Definition: chdr_types.hpp:256
Packet out of sequence (sequence error)
Definition: chdr_types.hpp:391
cfg_payload(uint16_t addr_, uint32_t data_=0)
Definition: chdr_types.hpp:642
Transaction successful.
Definition: chdr_types.hpp:244
constexpr size_t chdr_w_to_bits(chdr_w_t chdr_w)
Conversion from chdr_w_t to a number of bits.
Definition: rfnoc_types.hpp:21
chdr_w_t get_chdr_w() const
Return the CHDR_W for this transaction.
Definition: chdr_types.hpp:890
Definition: chdr_types.hpp:395
void deserialize(const uint64_t *buff, size_t num_elems)
Deserialize the payload from a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:448
void set_proto_ver(uint16_t proto_ver)
Set the protocol version for this transaction.
Definition: chdr_types.hpp:909
size_t get_num_ops() const
Get the number of management operations in this hop.
Definition: chdr_types.hpp:737
uint16_t sep_id_t
Stream Endpoint ID Type.
Definition: rfnoc_types.hpp:38
cfg_payload(payload_t payload_)
Definition: chdr_types.hpp:643
packet_type_t
Definition: chdr_types.hpp:21
sep_id_t get_src_epid() const
Return the source EPID for this transaction.
Definition: chdr_types.hpp:875
void set_header(sep_id_t src_epid, uint16_t protover, chdr_w_t chdr_w)
Definition: chdr_types.hpp:787
ctrl_opcode_t
Definition: chdr_types.hpp:249
Definition: chdr_types.hpp:255
Data integrity check failed.
Definition: chdr_types.hpp:392
Stream Command.
Definition: chdr_types.hpp:25
bool operator!=(const strc_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:566
const uint16_t dest
Definition: chdr_types.hpp:625
Control Transaction.
Definition: chdr_types.hpp:26
const uint32_t ext_info
Definition: chdr_types.hpp:660
Data Packet without TimeStamp.
Definition: chdr_types.hpp:27
Definition: rfnoc_types.hpp:19
Definition: chdr_types.hpp:262
Initialize stream.
Definition: chdr_types.hpp:497
const uint16_t device_id
Definition: chdr_types.hpp:657
sel_dest_payload(payload_t payload_)
Definition: chdr_types.hpp:628
mgmt_hop_t pop_hop()
Pop the first hop of the transaction and return it.
Definition: chdr_types.hpp:814
Slave asserted a time stamp error.
Definition: chdr_types.hpp:246
const mgmt_hop_t & get_hop(size_t i) const
Get the n'th hop in the transaction.
Definition: chdr_types.hpp:808
Definition: chdr_types.hpp:258
const uint32_t data
Definition: chdr_types.hpp:640
constexpr packet_type_t payload_to_packet_type< mgmt_payload >()
Definition: chdr_types.hpp:933
void add_hop(const mgmt_hop_t &hop)
Add a management hop to this transaction.
Definition: chdr_types.hpp:796
UHD_INLINE size_t width(const soft_reg_field_t field)
Definition: soft_register.hpp:76
strs_status_t
Definition: chdr_types.hpp:387
size_t serialize(uint64_t *buff, size_t max_size_bytes) const
Serialize the payload to a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:840
A class that represents a single management operation.
Definition: chdr_types.hpp:594
bool operator!=(const ctrl_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:346
uint64_t get_op_payload() const
Get the payload for this transaction.
Definition: chdr_types.hpp:701
Definition: chdr_types.hpp:243
constexpr packet_type_t payload_to_packet_type< strc_payload >()
Definition: chdr_types.hpp:939
Definition: build_info.hpp:12
op_code_t
Definition: chdr_types.hpp:598
node_info_payload(payload_t payload_)
Definition: chdr_types.hpp:672
uint64_t payload_t
The payload for an operation is 48 bits wide.
Definition: chdr_types.hpp:620
size_t get_size_bytes() const
Definition: chdr_types.hpp:821
Definition: chdr_types.hpp:250
const uint16_t addr
Definition: chdr_types.hpp:639
bool operator==(const mgmt_hop_t &rhs) const
Comparison operator (==)
Definition: chdr_types.hpp:763
bool operator!=(const strs_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:464
Definition: chdr_types.hpp:501
op_code_t get_op_code() const
Get the op-code for this transaction.
Definition: chdr_types.hpp:695
bool operator==(const mgmt_op_t &rhs) const
Comparison operator (==)
Definition: chdr_types.hpp:707
Trigger a stream status response.
Definition: chdr_types.hpp:498
uint16_t get_proto_ver() const
Return the protocol version for this transaction.
Definition: chdr_types.hpp:903
An interpretation class for the payload for MGMT_OP_SEL_DEST.
Definition: chdr_types.hpp:623
void add_op(const mgmt_op_t &op)
Add a management operation to this hop.
Definition: chdr_types.hpp:731
size_t get_num_hops() const
Get the number of management hops in this hop.
Definition: chdr_types.hpp:802
Stream status.
Definition: chdr_types.hpp:24
A stream command signalled an error.
Definition: chdr_types.hpp:390
void deserialize(const uint64_t *buff, size_t num_elems)
Deserialize the payload from a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:856
constexpr packet_type_t payload_to_packet_type()
Conversion from payload_t to pkt_type.
void set_src_epid(sep_id_t src_epid)
Set the source EPID for this transaction.
Definition: chdr_types.hpp:881
Definition: chdr_types.hpp:265
size_t serialize(uint64_t *buff, size_t max_size_bytes) const
Serialize the payload to a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:534
Definition: chdr_types.hpp:637
An interpretation class for the payload for MGMT_OP_INFO_RESP.
Definition: chdr_types.hpp:655
#define UHD_API
Definition: config.h:70
const mgmt_op_t & get_op(size_t i) const
Get the n'th operation in the hop.
Definition: chdr_types.hpp:743
void deserialize(const uint64_t *buff, size_t num_elems)
Deserialize the payload from a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:324
void set_chdr_w(chdr_w_t chdr_w)
Set the CHDR_W for this transaction.
Definition: chdr_types.hpp:896
Definition: chdr_types.hpp:257
A class that represents a complete multi-hop management transaction.
Definition: chdr_types.hpp:778
Slave asserted a command error.
Definition: chdr_types.hpp:245
Definition: chdr_types.hpp:260
size_t serialize(uint64_t *buff, size_t max_size_bytes) const
Serialize the payload to a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:308
Management packet.
Definition: chdr_types.hpp:23
Definition: chdr_types.hpp:22
size_t serialize(uint64_t *buff, size_t max_size_bytes) const
Serialize the payload to a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:432
No error.
Definition: chdr_types.hpp:389
A class that represents a single management hop.
Definition: chdr_types.hpp:723
Definition: chdr_types.hpp:261
Definition: chdr_types.hpp:252
UHD_API bool operator==(const time_spec_t &, const time_spec_t &)
Implement equality_comparable interface.
chdr_w_t
Type that indicates the CHDR Width in bits.
Definition: rfnoc_types.hpp:19
constexpr packet_type_t payload_to_packet_type< strs_payload >()
Definition: chdr_types.hpp:945
Definition: endianness.hpp:30
ctrl_status_t
Definition: chdr_types.hpp:242
strc_op_code_t
Definition: chdr_types.hpp:495
node_info_payload(uint16_t device_id_, uint8_t node_type_, uint16_t node_inst_, uint32_t ext_info_)
Definition: chdr_types.hpp:662
Definition: chdr_types.hpp:253
constexpr packet_type_t payload_to_packet_type< ctrl_payload >()
Definition: chdr_types.hpp:927
sel_dest_payload(uint16_t dest_)
Definition: chdr_types.hpp:627
Definition: chdr_types.hpp:259
bool has_timestamp() const
Definition: chdr_types.hpp:337
void deserialize(const uint64_t *buff, size_t num_elems)
Deserialize the payload from a uint64_t buffer (no conversion function)
Definition: chdr_types.hpp:550
Definition: chdr_types.hpp:496
Definition: chdr_types.hpp:254
const uint16_t node_inst
Definition: chdr_types.hpp:659
mgmt_op_t(const op_code_t op_code, const payload_t op_payload=0)
Definition: chdr_types.hpp:688
const uint8_t node_type
Definition: chdr_types.hpp:658
Definition: chdr_types.hpp:388