USRP Hardware Driver and USRP Manual  Version: 4.1.0.0-264-g3e5e4eb06
UHD and USRP Manual
chdr_types.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2019 Ettus Research, a National Instruments Brand
3 //
4 // SPDX-License-Identifier: GPL-3.0-or-later
5 //
6 
7 #pragma once
8 
10 #include <uhd/types/endianness.hpp>
11 #include <uhd/utils/byteswap.hpp>
12 #include <boost/format.hpp>
13 #include <boost/optional.hpp>
14 #include <deque>
15 #include <list>
16 #include <memory>
17 #include <vector>
18 
19 namespace uhd { namespace rfnoc { namespace chdr {
20 
22  PKT_TYPE_MGMT = 0x0,
23  PKT_TYPE_STRS = 0x1,
24  PKT_TYPE_STRC = 0x2,
25  PKT_TYPE_CTRL = 0x4,
28 };
29 
30 //----------------------------------------------------
31 // CHDR Header
32 //----------------------------------------------------
33 
35 {
36 public: // Functions
37  chdr_header() = default;
38  chdr_header(const chdr_header& rhs) = default;
39  chdr_header(chdr_header&& rhs) = default;
40 
42  chdr_header(uint64_t flat_hdr) : _flat_hdr(flat_hdr) {}
43 
45  inline uint8_t get_vc() const
46  {
47  return get_field<uint8_t>(_flat_hdr, VC_OFFSET, VC_WIDTH);
48  }
49 
51  inline void set_vc(uint8_t vc)
52  {
53  _flat_hdr = set_field(_flat_hdr, vc, VC_OFFSET, VC_WIDTH);
54  }
55 
57  inline bool get_eob() const
58  {
59  return get_field<bool>(_flat_hdr, EOB_OFFSET, EOB_WIDTH);
60  }
61 
63  inline void set_eob(bool eob)
64  {
65  _flat_hdr = set_field(_flat_hdr, eob, EOB_OFFSET, EOB_WIDTH);
66  }
67 
69  inline bool get_eov() const
70  {
71  return get_field<bool>(_flat_hdr, EOV_OFFSET, EOV_WIDTH);
72  }
73 
75  inline void set_eov(bool eov)
76  {
77  _flat_hdr = set_field(_flat_hdr, eov, EOV_OFFSET, EOV_WIDTH);
78  }
79 
81  inline packet_type_t get_pkt_type() const
82  {
83  return get_field<packet_type_t>(_flat_hdr, PKT_TYPE_OFFSET, PKT_TYPE_WIDTH);
84  }
85 
87  inline void set_pkt_type(packet_type_t pkt_type)
88  {
89  _flat_hdr = set_field(_flat_hdr, pkt_type, PKT_TYPE_OFFSET, PKT_TYPE_WIDTH);
90  }
91 
93  inline uint8_t get_num_mdata() const
94  {
95  return get_field<uint8_t>(_flat_hdr, NUM_MDATA_OFFSET, NUM_MDATA_WIDTH);
96  }
97 
99  inline void set_num_mdata(uint8_t num_mdata)
100  {
101  _flat_hdr = set_field(_flat_hdr, num_mdata, NUM_MDATA_OFFSET, NUM_MDATA_WIDTH);
102  }
103 
105  inline uint16_t get_seq_num() const
106  {
107  return get_field<uint16_t>(_flat_hdr, SEQ_NUM_OFFSET, SEQ_NUM_WIDTH);
108  }
109 
111  inline void set_seq_num(uint16_t seq_num)
112  {
113  _flat_hdr = set_field(_flat_hdr, seq_num, SEQ_NUM_OFFSET, SEQ_NUM_WIDTH);
114  }
115 
117  inline uint16_t get_length() const
118  {
119  return get_field<uint16_t>(_flat_hdr, LENGTH_OFFSET, LENGTH_WIDTH);
120  }
121 
123  inline void set_length(uint16_t length)
124  {
125  _flat_hdr = set_field(_flat_hdr, length, LENGTH_OFFSET, LENGTH_WIDTH);
126  }
127 
129  inline uint16_t get_dst_epid() const
130  {
131  return get_field<uint16_t>(_flat_hdr, DST_EPID_OFFSET, DST_EPID_WIDTH);
132  }
133 
135  inline void set_dst_epid(uint16_t dst_epid)
136  {
137  _flat_hdr = set_field(_flat_hdr, dst_epid, DST_EPID_OFFSET, DST_EPID_WIDTH);
138  }
139 
141  inline uint64_t pack() const
142  {
143  return _flat_hdr;
144  }
145 
147  inline operator uint64_t() const
148  {
149  return pack();
150  }
151 
153  inline bool operator==(const chdr_header& rhs) const
154  {
155  return _flat_hdr == rhs._flat_hdr;
156  }
157 
159  inline bool operator!=(const chdr_header& rhs) const
160  {
161  return _flat_hdr != rhs._flat_hdr;
162  }
163 
165  inline const chdr_header& operator=(const chdr_header& rhs)
166  {
167  _flat_hdr = rhs._flat_hdr;
168  return *this;
169  }
170 
172  inline const chdr_header& operator=(const uint64_t& rhs)
173  {
174  _flat_hdr = rhs;
175  return *this;
176  }
177 
179  inline const std::string to_string() const
180  {
181  // The static_casts are because vc and num_mdata are uint8_t -> unsigned char
182  // For some reason, despite the %u meaning unsigned int, boost still formats them
183  // as chars
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")
186  % static_cast<uint16_t>(get_vc()) % (get_eob() ? 'Y' : 'N')
187  % (get_eov() ? 'Y' : 'N') % get_pkt_type()
188  % static_cast<uint16_t>(get_num_mdata()) % get_seq_num() % get_length()
189  % get_dst_epid());
190  }
191 
192 private:
193  // The flattened representation of the header stored in host order
194  uint64_t _flat_hdr = 0;
195 
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;
204 
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;
213 
214  static inline uint64_t mask(const size_t width)
215  {
216  return ((uint64_t(1) << width) - 1);
217  }
218 
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)
222  {
223  return static_cast<field_t>((flat_hdr >> offset) & mask(width));
224  }
225 
226  template <typename field_t>
227  static inline uint64_t set_field(const uint64_t old_val,
228  const field_t field,
229  const size_t offset,
230  const size_t width)
231  {
232  return (old_val & ~(mask(width) << offset))
233  | ((static_cast<uint64_t>(field) & mask(width)) << offset);
234  }
235 };
236 
237 
238 //----------------------------------------------------
239 // CHDR Control Packet Payload
240 //----------------------------------------------------
241 
243  CMD_OKAY = 0x0,
244  CMD_CMDERR = 0x1,
245  CMD_TSERR = 0x2,
246  CMD_WARNING = 0x3,
247 };
248 
250  OP_SLEEP = 0x0,
251  OP_WRITE = 0x1,
252  OP_READ = 0x2,
256  OP_POLL = 0x6,
257  OP_USER1 = 0xA,
258  OP_USER2 = 0xB,
259  OP_USER3 = 0xC,
260  OP_USER4 = 0xD,
261  OP_USER5 = 0xE,
262  OP_USER6 = 0xF,
263 };
264 
266 {
267 public: // Members
269  uint16_t dst_port = 0;
271  uint16_t src_port = 0;
273  uint8_t seq_num = 0;
275  boost::optional<uint64_t> timestamp = boost::none;
277  bool is_ack = false;
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;
290 
291 public: // Functions
292  ctrl_payload() = default;
293  ctrl_payload(const ctrl_payload& rhs) = default;
294  ctrl_payload(ctrl_payload&& rhs) = default;
295 
296  ctrl_payload& operator=(const ctrl_payload& rhs) = default;
297 
299  void populate_header(chdr_header& header) const;
300 
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;
305 
307  template <endianness_t endianness>
308  size_t serialize(uint64_t* buff, size_t max_size_bytes) const
309  {
310  auto conv_byte_order = [](uint64_t x) -> uint64_t {
311  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::htonx<uint64_t>(x)
312  : uhd::htowx<uint64_t>(x);
313  };
314  return serialize(buff, max_size_bytes, conv_byte_order);
315  }
316 
321  void deserialize(const uint64_t* buff,
322  size_t buff_size,
323  const std::function<uint64_t(uint64_t)>& conv_byte_order);
324 
328  template <endianness_t endianness>
329  void deserialize(const uint64_t* buff, size_t buff_size)
330  {
331  auto conv_byte_order = [](uint64_t x) -> uint64_t {
332  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
333  : uhd::wtohx<uint64_t>(x);
334  };
335  deserialize(buff, buff_size, conv_byte_order);
336  }
337 
339  size_t get_length() const;
340 
341  // Return whether or not we have a valid timestamp
342  bool has_timestamp() const
343  {
344  return bool(timestamp);
345  }
346 
348  bool operator==(const ctrl_payload& rhs) const;
349 
351  inline bool operator!=(const ctrl_payload& rhs) const
352  {
353  return !(*this == rhs);
354  }
355 
357  const std::string to_string() const;
358 
359 private:
360  static constexpr size_t DST_PORT_WIDTH = 10;
361  static constexpr size_t SRC_PORT_WIDTH = 10;
362  static constexpr size_t NUM_DATA_WIDTH = 4;
363  static constexpr size_t SEQ_NUM_WIDTH = 6;
364  static constexpr size_t HAS_TIME_WIDTH = 1;
365  static constexpr size_t IS_ACK_WIDTH = 1;
366  static constexpr size_t SRC_EPID_WIDTH = 16;
367  static constexpr size_t ADDRESS_WIDTH = 20;
368  static constexpr size_t BYTE_ENABLE_WIDTH = 4;
369  static constexpr size_t OPCODE_WIDTH = 4;
370  static constexpr size_t STATUS_WIDTH = 2;
371 
372  // Offsets assume 64-bit alignment
373  static constexpr size_t DST_PORT_OFFSET = 0;
374  static constexpr size_t SRC_PORT_OFFSET = 10;
375  static constexpr size_t NUM_DATA_OFFSET = 20;
376  static constexpr size_t SEQ_NUM_OFFSET = 24;
377  static constexpr size_t HAS_TIME_OFFSET = 30;
378  static constexpr size_t IS_ACK_OFFSET = 31;
379  static constexpr size_t SRC_EPID_OFFSET = 32;
380  static constexpr size_t ADDRESS_OFFSET = 0;
381  static constexpr size_t BYTE_ENABLE_OFFSET = 20;
382  static constexpr size_t OPCODE_OFFSET = 24;
383  static constexpr size_t STATUS_OFFSET = 30;
384  static constexpr size_t LO_DATA_OFFSET = 0;
385  static constexpr size_t HI_DATA_OFFSET = 32;
386 };
387 
388 //----------------------------------------------------
389 // CHDR Stream Status Packet Payload
390 //----------------------------------------------------
391 
393  STRS_OKAY = 0x0,
394  STRS_CMDERR = 0x1,
395  STRS_SEQERR = 0x2,
396  STRS_DATAERR = 0x3,
397  STRS_RTERR = 0x4,
398 };
399 
401 {
402 public: // Members
404  uint16_t src_epid = 0;
408  uint64_t capacity_bytes = 0;
410  uint32_t capacity_pkts = 0;
412  uint64_t xfer_count_bytes = 0;
414  uint64_t xfer_count_pkts = 0;
416  uint16_t buff_info = 0;
418  uint64_t status_info = 0;
419 
420 public: // Functions
421  strs_payload() = default;
422  strs_payload(const strs_payload& rhs) = default;
423  strs_payload(strs_payload&& rhs) = default;
424 
425  strs_payload& operator=(const strs_payload& rhs) = default;
426 
428  void populate_header(chdr_header& header) const;
429 
431  size_t serialize(uint64_t* buff,
432  size_t max_size_bytes,
433  const std::function<uint64_t(uint64_t)>& conv_byte_order) const;
434 
436  template <endianness_t endianness>
437  size_t serialize(uint64_t* buff, size_t max_size_bytes) const
438  {
439  auto conv_byte_order = [](uint64_t x) -> uint64_t {
440  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::htonx<uint64_t>(x)
441  : uhd::htowx<uint64_t>(x);
442  };
443  return serialize(buff, max_size_bytes, conv_byte_order);
444  }
445 
450  void deserialize(const uint64_t* buff,
451  size_t buff_size,
452  const std::function<uint64_t(uint64_t)>& conv_byte_order);
453 
457  template <endianness_t endianness>
458  void deserialize(const uint64_t* buff, size_t buff_size)
459  {
460  auto conv_byte_order = [](uint64_t x) -> uint64_t {
461  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
462  : uhd::wtohx<uint64_t>(x);
463  };
464  deserialize(buff, buff_size, conv_byte_order);
465  }
466 
468  size_t get_length() const;
469 
471  bool operator==(const strs_payload& rhs) const;
472 
474  inline bool operator!=(const strs_payload& rhs) const
475  {
476  return !(*this == rhs);
477  }
478 
480  const std::string to_string() const;
481 
482 private:
483  static constexpr size_t SRC_EPID_WIDTH = 16;
484  static constexpr size_t STATUS_WIDTH = 4;
485  static constexpr size_t CAPACITY_BYTES_WIDTH = 40;
486  static constexpr size_t CAPACITY_PKTS_WIDTH = 24;
487  static constexpr size_t XFER_COUNT_PKTS_WIDTH = 40;
488  static constexpr size_t BUFF_INFO_WIDTH = 16;
489  static constexpr size_t STATUS_INFO_WIDTH = 48;
490 
491  // Offsets assume 64-bit alignment
492  static constexpr size_t SRC_EPID_OFFSET = 0;
493  static constexpr size_t STATUS_OFFSET = 16;
494  static constexpr size_t CAPACITY_BYTES_OFFSET = 24;
495  static constexpr size_t CAPACITY_PKTS_OFFSET = 0;
496  static constexpr size_t XFER_COUNT_PKTS_OFFSET = 24;
497  static constexpr size_t BUFF_INFO_OFFSET = 0;
498  static constexpr size_t STATUS_INFO_OFFSET = 16;
499 };
500 
501 //----------------------------------------------------
502 // CHDR Stream Command Packet Payload
503 //----------------------------------------------------
504 
506  STRC_INIT = 0x0,
507  STRC_PING = 0x1,
508  STRC_RESYNC = 0x2,
509 };
510 
512 {
513 public: // Members
515  uint16_t src_epid = 0;
519  uint8_t op_data = 0;
521  uint64_t num_pkts = 0;
523  uint64_t num_bytes = 0;
525  static constexpr size_t MAX_PACKET_SIZE = 128;
526 
527 public: // Functions
528  strc_payload() = default;
529  strc_payload(const strc_payload& rhs) = default;
530  strc_payload(strc_payload&& rhs) = default;
531 
532  strc_payload& operator=(const strc_payload& rhs) = default;
533 
535  void populate_header(chdr_header& header) const;
536 
538  size_t serialize(uint64_t* buff,
539  size_t max_size_bytes,
540  const std::function<uint64_t(uint64_t)>& conv_byte_order) const;
541 
543  template <endianness_t endianness>
544  size_t serialize(uint64_t* buff, size_t max_size_bytes) const
545  {
546  auto conv_byte_order = [](uint64_t x) -> uint64_t {
547  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::htonx<uint64_t>(x)
548  : uhd::htowx<uint64_t>(x);
549  };
550  return serialize(buff, max_size_bytes, conv_byte_order);
551  }
552 
557  void deserialize(const uint64_t* buff,
558  size_t buff_size,
559  const std::function<uint64_t(uint64_t)>& conv_byte_order);
560 
564  template <endianness_t endianness>
565  void deserialize(const uint64_t* buff, size_t buff_size)
566  {
567  auto conv_byte_order = [](uint64_t x) -> uint64_t {
568  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
569  : uhd::wtohx<uint64_t>(x);
570  };
571  deserialize(buff, buff_size, conv_byte_order);
572  }
573 
575  size_t get_length() const;
576 
578  bool operator==(const strc_payload& rhs) const;
579 
581  inline bool operator!=(const strc_payload& rhs) const
582  {
583  return !(*this == rhs);
584  }
585 
587  const std::string to_string() const;
588 
589 private:
590  static constexpr size_t SRC_EPID_WIDTH = 16;
591  static constexpr size_t OP_CODE_WIDTH = 4;
592  static constexpr size_t OP_DATA_WIDTH = 4;
593  static constexpr size_t NUM_PKTS_WIDTH = 40;
594 
595  // Offsets assume 64-bit alignment
596  static constexpr size_t SRC_EPID_OFFSET = 0;
597  static constexpr size_t OP_CODE_OFFSET = 16;
598  static constexpr size_t OP_DATA_OFFSET = 20;
599  static constexpr size_t NUM_PKTS_OFFSET = 24;
600 };
601 
602 //----------------------------------------------------
603 // CHDR Management Packet Payload
604 //----------------------------------------------------
605 
607 // An operation consists of an operation code and some
608 // payload associated with that operation.
610 {
611 public:
612  // Operation code
613  enum op_code_t {
615  MGMT_OP_NOP = 0,
617  MGMT_OP_ADVERTISE = 1,
619  MGMT_OP_SEL_DEST = 2,
621  MGMT_OP_RETURN = 3,
623  MGMT_OP_INFO_REQ = 4,
625  MGMT_OP_INFO_RESP = 5,
627  MGMT_OP_CFG_WR_REQ = 6,
629  MGMT_OP_CFG_RD_REQ = 7,
631  MGMT_OP_CFG_RD_RESP = 8
632  };
633 
635  using payload_t = uint64_t;
636 
639  {
640  const uint16_t dest;
641 
642  sel_dest_payload(uint16_t dest_) : dest(dest_) {}
643  sel_dest_payload(payload_t payload_) : dest(static_cast<uint16_t>(payload_)) {}
644  operator payload_t() const
645  {
646  return static_cast<payload_t>(dest);
647  }
648  };
649 
652  struct cfg_payload
653  {
654  const uint16_t addr;
655  const uint32_t data;
656 
657  cfg_payload(uint16_t addr_, uint32_t data_ = 0) : addr(addr_), data(data_) {}
659  : addr(static_cast<uint16_t>(payload_ >> 0))
660  , data(static_cast<uint32_t>(payload_ >> 16))
661  {
662  }
663  operator payload_t() const
664  {
665  return ((static_cast<payload_t>(data) << 16) | static_cast<payload_t>(addr));
666  }
667  };
668 
671  {
672  const uint16_t device_id;
673  const uint8_t node_type;
674  const uint16_t node_inst;
675  const uint32_t ext_info;
676 
677  node_info_payload(uint16_t device_id_,
678  uint8_t node_type_,
679  uint16_t node_inst_,
680  uint32_t ext_info_)
681  : device_id(device_id_)
682  , node_type(node_type_)
683  , node_inst(node_inst_)
684  , ext_info(ext_info_)
685  {
686  }
688  : device_id(static_cast<uint16_t>(payload_ >> 0))
689  , node_type(static_cast<uint8_t>((payload_ >> 16) & 0xF))
690  , node_inst(static_cast<uint16_t>((payload_ >> 20) & 0x3FF))
691  , ext_info(static_cast<uint32_t>((payload_ >> 30) & 0x3FFFF))
692  {
693  }
694  operator payload_t() const
695  {
696  return ((static_cast<payload_t>(device_id) << 0)
697  | (static_cast<payload_t>(node_type & 0xF) << 16)
698  | (static_cast<payload_t>(node_inst & 0x3FF) << 20)
699  | (static_cast<payload_t>(ext_info & 0x3FFFF) << 30));
700  }
701  };
702 
703  mgmt_op_t(const op_code_t op_code, const payload_t op_payload = 0,
704  const uint8_t ops_pending = 0)
705  : _op_code(op_code), _op_payload(op_payload), _ops_pending(ops_pending)
706  {
707  }
708  mgmt_op_t(const mgmt_op_t& rhs) = default;
709 
711  // Note that ops_pending is not used by UHD, since it can infer this value
712  // from the ops vector in mgmt_hop_t. It is needed only by the CHDR
713  // dissector.
714  inline uint8_t get_ops_pending() const
715  {
716  return _ops_pending;
717  }
718 
720  inline op_code_t get_op_code() const
721  {
722  return _op_code;
723  }
724 
726  inline uint64_t get_op_payload() const
727  {
728  return _op_payload;
729  }
730 
732  inline bool operator==(const mgmt_op_t& rhs) const
733  {
734  return (_op_code == rhs._op_code) && (_op_payload == rhs._op_payload);
735  }
736 
738  const std::string to_string() const;
739 
740 private:
741  op_code_t _op_code;
742  payload_t _op_payload;
743  uint8_t _ops_pending;
744 };
745 
747 // A hop is a collection for management transactions for
748 // a single node.
750 {
751 public:
752  mgmt_hop_t() = default;
753  mgmt_hop_t(const mgmt_hop_t& rhs) = default;
754 
756  // Operations are added to the hop in FIFO order and executed in FIFO order.
757  inline void add_op(const mgmt_op_t& op)
758  {
759  _ops.push_back(op);
760  }
761 
763  inline size_t get_num_ops() const
764  {
765  return _ops.size();
766  }
767 
769  inline const mgmt_op_t& get_op(size_t i) const
770  {
771  return _ops.at(i);
772  }
773 
775  // The RFNoC Specification section 2.2.6 specifies that for chdr widths
776  // greater than 64, all MSBs are 0, so we pad out the hop based on the width
777  size_t serialize(std::vector<uint64_t>& target,
778  const std::function<uint64_t(uint64_t)>& conv_byte_order,
779  const size_t padding_size) const;
780 
782  // The RFNoC Specification section 2.2.6 specifies that for chdr widths
783  // greater than 64, all MSBs are 0, so we remove padding based on the width
784  void deserialize(std::list<uint64_t>& src,
785  const std::function<uint64_t(uint64_t)>& conv_byte_order,
786  const size_t padding_size);
787 
789  inline bool operator==(const mgmt_hop_t& rhs) const
790  {
791  return _ops == rhs._ops;
792  }
793 
795  const std::string to_string() const;
796 
797 private:
798  std::vector<mgmt_op_t> _ops;
799 };
800 
802 // A transaction is a collection of hops, where each hop is a collection
803 // of management transactions.
805 {
806 public:
807  mgmt_payload() = default;
808  mgmt_payload(const mgmt_payload& rhs) = default;
809  mgmt_payload(mgmt_payload&& rhs) = default;
810 
811  mgmt_payload& operator=(const mgmt_payload& rhs) = default;
812 
813  inline void set_header(sep_id_t src_epid, uint16_t protover, chdr_w_t chdr_w)
814  {
815  set_src_epid(src_epid);
816  set_chdr_w(chdr_w);
817  set_proto_ver(protover);
818  }
819 
821  // Hops are added to the hop in FIFO order and executed in FIFO order.
822  inline void add_hop(const mgmt_hop_t& hop)
823  {
824  _hops.push_back(hop);
825  }
826 
828  inline size_t get_num_hops() const
829  {
830  return _hops.size();
831  }
832 
834  inline const mgmt_hop_t& get_hop(size_t i) const
835  {
836  return _hops.at(i);
837  }
838 
841  {
842  auto hop = _hops.front();
843  _hops.pop_front();
844  return hop;
845  }
846 
847  inline size_t get_size_bytes() const
848  {
849  size_t num_lines = 1; /* header */
850  for (const auto& hop : _hops) {
851  num_lines += hop.get_num_ops();
852  }
853  return num_lines * (chdr_w_to_bits(_chdr_w) / 8);
854  }
855 
857  void populate_header(chdr_header& header) const;
858 
860  size_t serialize(uint64_t* buff,
861  size_t max_size_bytes,
862  const std::function<uint64_t(uint64_t)>& conv_byte_order) const;
863 
865  template <endianness_t endianness>
866  size_t serialize(uint64_t* buff, size_t max_size_bytes) const
867  {
868  auto conv_byte_order = [](uint64_t x) -> uint64_t {
869  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::htonx<uint64_t>(x)
870  : uhd::htowx<uint64_t>(x);
871  };
872  return serialize(buff, max_size_bytes, conv_byte_order);
873  }
874 
879  void deserialize(const uint64_t* buff,
880  size_t buff_size,
881  const std::function<uint64_t(uint64_t)>& conv_byte_order);
882 
886  template <endianness_t endianness>
887  void deserialize(const uint64_t* buff, size_t buff_size)
888  {
889  auto conv_byte_order = [](uint64_t x) -> uint64_t {
890  return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
891  : uhd::wtohx<uint64_t>(x);
892  };
893  deserialize(buff, buff_size, conv_byte_order);
894  }
895 
897  size_t get_length() const;
898 
900  const std::string to_string() const;
901 
903  const std::string hops_to_string() const;
904 
906  inline sep_id_t get_src_epid() const
907  {
908  return _src_epid;
909  }
910 
912  inline void set_src_epid(sep_id_t src_epid)
913  {
914  _src_epid = src_epid;
915  }
916 
918  bool operator==(const mgmt_payload& rhs) const;
919 
921  inline chdr_w_t get_chdr_w() const
922  {
923  return _chdr_w;
924  }
925 
927  inline void set_chdr_w(chdr_w_t chdr_w)
928  {
929  _chdr_w = chdr_w;
930  _padding_size = (chdr_w_to_bits(_chdr_w) / 64) - 1;
931  }
932 
934  inline uint16_t get_proto_ver() const
935  {
936  return _protover;
937  }
938 
940  inline void set_proto_ver(uint16_t proto_ver)
941  {
942  _protover = proto_ver;
943  }
944 
945 private:
946  sep_id_t _src_epid = 0;
947  uint16_t _protover = 0;
948  chdr_w_t _chdr_w = CHDR_W_64;
949  size_t _padding_size = 0;
950  std::deque<mgmt_hop_t> _hops;
951 };
952 
954 template <typename payload_t>
956 
957 template <>
959 {
960  return PKT_TYPE_CTRL;
961 }
962 
963 template <>
965 {
966  return PKT_TYPE_MGMT;
967 }
968 
969 template <>
971 {
972  return PKT_TYPE_STRC;
973 }
974 
975 template <>
977 {
978  return PKT_TYPE_STRS;
979 }
980 
981 }}} // namespace uhd::rfnoc::chdr
Definition: chdr_types.hpp:251
Definition: chdr_types.hpp:256
Packet out of sequence (sequence error)
Definition: chdr_types.hpp:396
cfg_payload(uint16_t addr_, uint32_t data_=0)
Definition: chdr_types.hpp:657
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:921
Definition: chdr_types.hpp:400
void set_proto_ver(uint16_t proto_ver)
Set the protocol version for this transaction.
Definition: chdr_types.hpp:940
void deserialize(const uint64_t *buff, size_t buff_size)
Definition: chdr_types.hpp:458
size_t get_num_ops() const
Get the number of management operations in this hop.
Definition: chdr_types.hpp:763
uint16_t sep_id_t
Stream Endpoint ID Type.
Definition: rfnoc_types.hpp:53
cfg_payload(payload_t payload_)
Definition: chdr_types.hpp:658
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:906
void set_num_mdata(uint8_t num_mdata)
Set number of metadata words field (5 bits)
Definition: chdr_types.hpp:99
void set_header(sep_id_t src_epid, uint16_t protover, chdr_w_t chdr_w)
Definition: chdr_types.hpp:813
ctrl_opcode_t
Definition: chdr_types.hpp:249
Definition: chdr_types.hpp:255
bool operator==(const chdr_header &rhs) const
Comparison operator (==)
Definition: chdr_types.hpp:153
Data integrity check failed.
Definition: chdr_types.hpp:397
Stream Command.
Definition: chdr_types.hpp:25
bool operator!=(const strc_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:581
const uint16_t dest
Definition: chdr_types.hpp:640
Control Transaction.
Definition: chdr_types.hpp:26
const uint32_t ext_info
Definition: chdr_types.hpp:675
Data Packet without TimeStamp.
Definition: chdr_types.hpp:27
uint8_t get_num_mdata() const
Get number of metadata words field (5 bits)
Definition: chdr_types.hpp:93
Definition: rfnoc_types.hpp:19
Definition: chdr_types.hpp:262
Initialize stream.
Definition: chdr_types.hpp:507
const uint16_t device_id
Definition: chdr_types.hpp:672
void set_eob(bool eob)
Set the end-of-burst flag (1 bit)
Definition: chdr_types.hpp:63
const std::string to_string() const
Return a string representation of this object.
Definition: chdr_types.hpp:179
sel_dest_payload(payload_t payload_)
Definition: chdr_types.hpp:643
mgmt_hop_t pop_hop()
Pop the first hop of the transaction and return it.
Definition: chdr_types.hpp:840
uint16_t get_dst_epid() const
Get the destination EPID field (16 bits)
Definition: chdr_types.hpp:129
Slave asserted a time stamp error.
Definition: chdr_types.hpp:246
const mgmt_hop_t & get_hop(size_t i) const
Get the n&#39;th hop in the transaction.
Definition: chdr_types.hpp:834
Definition: chdr_types.hpp:258
const uint32_t data
Definition: chdr_types.hpp:655
constexpr packet_type_t payload_to_packet_type< mgmt_payload >()
Definition: chdr_types.hpp:964
void add_hop(const mgmt_hop_t &hop)
Add a management hop to this transaction.
Definition: chdr_types.hpp:822
uint16_t get_seq_num() const
Get the sequence number field (16 bits)
Definition: chdr_types.hpp:105
uint8_t get_vc() const
Get the virtual channel field (6 bits)
Definition: chdr_types.hpp:45
UHD_INLINE size_t width(const soft_reg_field_t field)
Definition: soft_register.hpp:75
strs_status_t
Definition: chdr_types.hpp:392
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:866
A class that represents a single management operation.
Definition: chdr_types.hpp:609
bool operator!=(const ctrl_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:351
uint64_t get_op_payload() const
Get the payload for this transaction.
Definition: chdr_types.hpp:726
void set_pkt_type(packet_type_t pkt_type)
Set the packet type field (3 bits)
Definition: chdr_types.hpp:87
Definition: chdr_types.hpp:243
constexpr packet_type_t payload_to_packet_type< strc_payload >()
Definition: chdr_types.hpp:970
void set_eov(bool eov)
Set the end-of-vector flag (1 bit)
Definition: chdr_types.hpp:75
Definition: build_info.hpp:12
op_code_t
Definition: chdr_types.hpp:613
node_info_payload(payload_t payload_)
Definition: chdr_types.hpp:687
void deserialize(const uint64_t *buff, size_t buff_size)
Definition: chdr_types.hpp:565
uint64_t payload_t
The payload for an operation is 48 bits wide.
Definition: chdr_types.hpp:635
size_t get_size_bytes() const
Definition: chdr_types.hpp:847
Definition: chdr_types.hpp:250
const uint16_t addr
Definition: chdr_types.hpp:654
chdr_header(uint64_t flat_hdr)
Unpack the header from a uint64_t.
Definition: chdr_types.hpp:42
bool operator==(const mgmt_hop_t &rhs) const
Comparison operator (==)
Definition: chdr_types.hpp:789
bool operator!=(const strs_payload &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:474
void set_vc(uint8_t vc)
Set the virtual channel field (6 bits)
Definition: chdr_types.hpp:51
Definition: chdr_types.hpp:511
mgmt_op_t(const op_code_t op_code, const payload_t op_payload=0, const uint8_t ops_pending=0)
Definition: chdr_types.hpp:703
uint64_t pack() const
Pack the header into a uint64_t.
Definition: chdr_types.hpp:141
op_code_t get_op_code() const
Get the op-code for this transaction.
Definition: chdr_types.hpp:720
bool operator==(const mgmt_op_t &rhs) const
Comparison operator (==)
Definition: chdr_types.hpp:732
Trigger a stream status response.
Definition: chdr_types.hpp:508
uint16_t get_proto_ver() const
Return the protocol version for this transaction.
Definition: chdr_types.hpp:934
An interpretation class for the payload for MGMT_OP_SEL_DEST.
Definition: chdr_types.hpp:638
Definition: chdr_types.hpp:34
void add_op(const mgmt_op_t &op)
Add a management operation to this hop.
Definition: chdr_types.hpp:757
size_t get_num_hops() const
Get the number of management hops in this hop.
Definition: chdr_types.hpp:828
Stream status.
Definition: chdr_types.hpp:24
A stream command signalled an error.
Definition: chdr_types.hpp:395
constexpr packet_type_t payload_to_packet_type()
Conversion from payload_t to pkt_type.
void deserialize(const uint64_t *buff, size_t buff_size)
Definition: chdr_types.hpp:887
void set_src_epid(sep_id_t src_epid)
Set the source EPID for this transaction.
Definition: chdr_types.hpp:912
Definition: chdr_types.hpp:265
void set_seq_num(uint16_t seq_num)
Set the sequence number field (16 bits)
Definition: chdr_types.hpp:111
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:544
void set_dst_epid(uint16_t dst_epid)
Set the destination EPID field (16 bits)
Definition: chdr_types.hpp:135
Definition: chdr_types.hpp:652
An interpretation class for the payload for MGMT_OP_INFO_RESP.
Definition: chdr_types.hpp:670
#define UHD_API
Definition: config.h:70
const mgmt_op_t & get_op(size_t i) const
Get the n&#39;th operation in the hop.
Definition: chdr_types.hpp:769
const chdr_header & operator=(const chdr_header &rhs)
Assignment operator (=) from a chdr_header.
Definition: chdr_types.hpp:165
void set_chdr_w(chdr_w_t chdr_w)
Set the CHDR_W for this transaction.
Definition: chdr_types.hpp:927
Definition: chdr_types.hpp:257
A class that represents a complete multi-hop management transaction.
Definition: chdr_types.hpp:804
bool get_eob() const
Get the end-of-burst flag (1 bit)
Definition: chdr_types.hpp:57
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:437
void deserialize(const uint64_t *buff, size_t buff_size)
Definition: chdr_types.hpp:329
No error.
Definition: chdr_types.hpp:394
A class that represents a single management hop.
Definition: chdr_types.hpp:749
void set_length(uint16_t length)
Set the packet length field (16 bits)
Definition: chdr_types.hpp:123
Definition: chdr_types.hpp:261
uint8_t get_ops_pending() const
Get the ops pending for this transaction.
Definition: chdr_types.hpp:714
Definition: chdr_types.hpp:252
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:976
bool operator!=(const chdr_header &rhs) const
Comparison operator (!=)
Definition: chdr_types.hpp:159
Definition: endianness.hpp:30
ctrl_status_t
Definition: chdr_types.hpp:242
bool get_eov() const
Get the end-of-vector flag (1 bit)
Definition: chdr_types.hpp:69
const chdr_header & operator=(const uint64_t &rhs)
Assignment operator (=) from a uint64_t.
Definition: chdr_types.hpp:172
strc_op_code_t
Definition: chdr_types.hpp:505
node_info_payload(uint16_t device_id_, uint8_t node_type_, uint16_t node_inst_, uint32_t ext_info_)
Definition: chdr_types.hpp:677
Definition: chdr_types.hpp:253
constexpr packet_type_t payload_to_packet_type< ctrl_payload >()
Definition: chdr_types.hpp:958
sel_dest_payload(uint16_t dest_)
Definition: chdr_types.hpp:642
Definition: chdr_types.hpp:259
uint16_t get_length() const
Get the packet length field (16 bits)
Definition: chdr_types.hpp:117
bool has_timestamp() const
Definition: chdr_types.hpp:342
Definition: chdr_types.hpp:506
Definition: chdr_types.hpp:254
const uint16_t node_inst
Definition: chdr_types.hpp:674
packet_type_t get_pkt_type() const
Get the packet type field (3 bits)
Definition: chdr_types.hpp:81
const uint8_t node_type
Definition: chdr_types.hpp:673
Definition: chdr_types.hpp:393