uhd::rfnoc::chdr::mgmt_op_t Class Reference

#include <uhd/rfnoc/chdr_types.hpp>

Detailed Description

A class that represents a single management operation An operation consists of an operation code and some payload associated with that operation.

Classes
struct	cfg_payload
struct	node_info_payload
	An interpretation class for the payload for MGMT_OP_INFO_RESP. More...
struct	sel_dest_payload
	An interpretation class for the payload for MGMT_OP_SEL_DEST. More...

Public Types
enum	op_code_t {   MGMT_OP_NOP = 0 , MGMT_OP_ADVERTISE = 1 , MGMT_OP_SEL_DEST = 2 , MGMT_OP_RETURN = 3 ,   MGMT_OP_INFO_REQ = 4 , MGMT_OP_INFO_RESP = 5 , MGMT_OP_CFG_WR_REQ = 6 , MGMT_OP_CFG_RD_REQ = 7 ,   MGMT_OP_CFG_RD_RESP = 8 }
	Operation code. More...
using	payload_t = uint64_t
	The payload for an operation is 48 bits wide. More...

Public Member Functions
	mgmt_op_t (const op_code_t op_code, const payload_t op_payload=0, const uint8_t ops_pending=0)
	mgmt_op_t (const mgmt_op_t &rhs)=default
mgmt_op_t &	operator= (const mgmt_op_t &rhs)=default
uint8_t	get_ops_pending () const
	Get the ops pending for this transaction. More...
op_code_t	get_op_code () const
	Get the op-code for this transaction. More...
uint64_t	get_op_payload () const
	Get the payload for this transaction. More...
bool	operator== (const mgmt_op_t &rhs) const
	Comparison operator (==) More...
std::string	to_string () const
	Return a string representation of this object. More...

Member Typedef Documentation

payload_t

using uhd::rfnoc::chdr::mgmt_op_t::payload_t = uint64_t

The payload for an operation is 48 bits wide.

Member Enumeration Documentation

op_code_t

enum uhd::rfnoc::chdr::mgmt_op_t::op_code_t

Operation code.

Note that a management packet has 8 bits available for op codes. The values for these enums are used to construct the packets, so these values must match the values in rfnoc_chdr_internal_utils.vh.

Enumerator
MGMT_OP_NOP	Do nothing.
MGMT_OP_ADVERTISE	Advertise this operation to the outside logic.
MGMT_OP_SEL_DEST	Select the next destination for routing.
MGMT_OP_RETURN	Return the management packet back to its source.
MGMT_OP_INFO_REQ	Request information about the current node.
MGMT_OP_INFO_RESP	A response to an information request.
MGMT_OP_CFG_WR_REQ	Perform a configuration write on the node.
MGMT_OP_CFG_RD_REQ	Perform a configuration read on the node.
MGMT_OP_CFG_RD_RESP	A response to a configuration read.

Constructor & Destructor Documentation

mgmt_op_t() [1/2]

uhd::rfnoc::chdr::mgmt_op_t::mgmt_op_t ( const op_code_t  op_code, const payload_t  op_payload = 0, const uint8_t  ops_pending = 0  )

inline

mgmt_op_t() [2/2]

uhd::rfnoc::chdr::mgmt_op_t::mgmt_op_t ( const mgmt_op_t &  rhs )

default

Member Function Documentation

get_op_code()

op_code_t uhd::rfnoc::chdr::mgmt_op_t::get_op_code ( ) const

inline

Get the op-code for this transaction.

get_op_payload()

uint64_t uhd::rfnoc::chdr::mgmt_op_t::get_op_payload ( ) const

inline

Get the payload for this transaction.

get_ops_pending()

uint8_t uhd::rfnoc::chdr::mgmt_op_t::get_ops_pending ( ) const

inline

Get the ops pending for this transaction.

Note that ops_pending is not used by UHD, since it can infer this value from the ops vector in mgmt_hop_t. It is needed only by the CHDR dissector.

operator=()

mgmt_op_t& uhd::rfnoc::chdr::mgmt_op_t::operator= ( const mgmt_op_t &  rhs )

default

operator==()

bool uhd::rfnoc::chdr::mgmt_op_t::operator== ( const mgmt_op_t &  rhs ) const

inline

Comparison operator (==)

to_string()

std::string uhd::rfnoc::chdr::mgmt_op_t::to_string

(

)

const

Return a string representation of this object.

---

The documentation for this class was generated from the following file:

• chdr_types.hpp