Loading...
Searching...
No Matches
uhd::rfnoc::register_iface Class Referenceabstract

`#include <uhd/rfnoc/register_iface.hpp>`

Inheritance diagram for uhd::rfnoc::register_iface:
[legend]

## Public Types

using | sptr = std::shared_ptr<register_iface>
using | async_msg_validator_t
using | async_msg_callback_t

## Public Member Functions

virtual | ~register_iface ()=default
virtual void | poke32 (uint32_t addr, uint32_t data, uhd::time_spec_t time=uhd::time_spec_t::ASAP, bool ack=false)=0
void | poke64 (uint32_t addr, uint64_t data, time_spec_t time=uhd::time_spec_t::ASAP, bool ack=false)
virtual void | multi_poke32 (const std::vector< uint32_t > addrs, const std::vector< uint32_t > data, uhd::time_spec_t time=uhd::time_spec_t::ASAP, bool ack=false)=0
virtual void | block_poke32 (uint32_t first_addr, const std::vector< uint32_t > data, uhd::time_spec_t time=uhd::time_spec_t::ASAP, bool ack=false)=0
virtual uint32_t | peek32 (uint32_t addr, time_spec_t time=uhd::time_spec_t::ASAP)=0
uint64_t | peek64 (uint32_t addr, time_spec_t time=uhd::time_spec_t::ASAP)
virtual std::vector< uint32_t > | block_peek32 (uint32_t first_addr, size_t length, time_spec_t time=uhd::time_spec_t::ASAP)=0
virtual void | poll32 (uint32_t addr, uint32_t data, uint32_t mask, time_spec_t timeout, time_spec_t time=uhd::time_spec_t::ASAP, bool ack=false)=0
virtual void | sleep (time_spec_t duration, bool ack=false)=0
virtual void | register_async_msg_validator (async_msg_validator_t callback_f)=0
virtual void | register_async_msg_handler (async_msg_callback_t callback_f)=0
virtual void | set_policy (const std::string &name, const uhd::device_addr_t &args)=0
virtual uint16_t | get_src_epid () const =0
virtual uint16_t | get_port_num () const =0
virtual void | define_custom_register_space (const uint32_t start_addr, const uint32_t length, std::function< void(uint32_t, uint32_t)> poke_fn, std::function< uint32_t(uint32_t)> peek_fn)=0

## Detailed Description

A software interface to access low-level registers in a NoC block.

This interface supports the following:

- Writing and reading registers
- Hardware timed delays (for time sequencing operations)
- Asynchronous messages (where a block requests a "register write" in software)

This class has no public factory function or constructor.

## Member Typedef Documentation

## async_msg_callback_t

using uhd::rfnoc::register_iface::async_msg_callback_t

Initial value:
std::function<void(
uint32_t addr, const std::vector<uint32_t>& data, boost::optional<uint64_t>)>

Callback function for acting upon an asynchronous message.

When a block in the FPGA sends an asynchronous message to the software, and it has been validated, the async message callback function is called. An async message can be modelled as a simple register write (key-value pair with addr/data) that is initiated by the FPGA.

When this message is called, the async message was previously verified by calling the async message validator callback.

## async_msg_validator_t

using uhd::rfnoc::register_iface::async_msg_validator_t

Initial value:
std::function<bool(uint32_t addr, const std::vector<uint32_t>& data)>

Callback function for validating an asynchronous message.

When a block in the FPGA sends an asynchronous message to the software, the async message validator function is called. An async message can be modelled as a simple register write (key-value pair with addr/data) that is initiated by the FPGA. If this message returns true, the message is considered valid.

## sptr

using uhd::rfnoc::register_iface::sptr = std::shared_ptr<register_iface>

## Constructor & Destructor Documentation

## ~register_iface()

virtual uhd::rfnoc::register_iface::~register_iface | ( |  | ) |

virtual default

## Member Function Documentation

## block_peek32()

virtual std::vector< uint32_t > uhd::rfnoc::register_iface::block_peek32 | ( | uint32_t | first_addr,
|  | size_t | length,
|  | time_spec_t | time = uhd::time_spec_t::ASAP )

pure virtual

Read multiple 32-bit consecutive registers implemented in the NoC block.

Parameters

  first_addr | The byte address of the first register to read from (truncated to 20 bits).
  length | The number of 32-bit values to read
  time | The time at which the transaction should be executed.

Returns
  data New value of this register.

Example: If `first_addr` is set to 0, and length is 8, then this function will return a vector of length 8, with the content of registers at addresses 0, 4, 8, 12, 16, 20, 24, and 28 respectively.

Note: There is no guarantee that under the hood, the implementation won't separate the reads.

Exceptions

  op_failed | if the transaction fails
  op_timeout | if no response is received
  op_seqerr | if a sequence error occurs

Implemented in uhd::rfnoc::mock_reg_iface_t.

## block_poke32()

virtual void uhd::rfnoc::register_iface::block_poke32 | ( | uint32_t | first_addr,
|  | const std::vector< uint32_t > | data,
|  | uhd::time_spec_t | time = uhd::time_spec_t::ASAP,
|  | bool | ack = false )

pure virtual

Write multiple consecutive 32-bit registers implemented in the NoC block.

This function will only allow writes to adjacent registers, in increasing order. If addr is set to 0, and the length of data is 8, then this method triggers eight writes, in order, to addresses 0, 4, 8, 12, 16, 20, 24, 28. For arbitrary addresses, cf. multi_poke32().

Note: There is no guarantee that under the hood, the implementation won't separate the writes.

Parameters

  first_addr | The byte addresses of the first register to write
  data | New values of these registers
  time | The time at which the first transaction should be executed.
  ack | Should transaction completion be acknowledged?

Exceptions

  op_failed | if an ACK is requested and the transaction fails
  op_timeout | if an ACK is requested and no response is received
  op_seqerr | if an ACK is requested and a sequence error occurs
  op_timeerr | if an ACK is requested and a time error occurs (late command)

Implemented in uhd::rfnoc::mock_reg_iface_t.

## define_custom_register_space()

virtual void uhd::rfnoc::register_iface::define_custom_register_space | ( | const uint32_t | start_addr,
|  | const uint32_t | length,
|  | std::function< void(uint32_t, uint32_t)> | poke_fn,
|  | std::function< uint32_t(uint32_t)> | peek_fn )

pure virtual

Define a custom register space that overrides peek and poke operations, directing peek and poke operations that fall within the custom space to the provided custom peek and poke functions instead.

Callers should be aware of the NoC block's register space, so that peeks and pokes do not unintentionally override existing functionality.

Parameters

  start_addr | The start address of the custom register space
  length | The length of the custom address space
  poke_fn | The function to call when the custom register space is poked
  peek_fn | The function to call when the custom register space is peeked

Implemented in uhd::rfnoc::mock_reg_iface_t.

## get_port_num()

virtual uint16_t uhd::rfnoc::register_iface::get_port_num | ( |  | ) | const

pure virtual

Get the port number of the software counterpart of this register interface. This information is useful to send async messages to the host.

Returns
  The 10-bit port number

Implemented in uhd::rfnoc::mock_reg_iface_t.

## get_src_epid()

virtual uint16_t uhd::rfnoc::register_iface::get_src_epid | ( |  | ) | const

pure virtual

Get the endpoint ID of the software counterpart of this register interface. This information is useful to send async messages to the host.

Returns
  The 16-bit endpoint ID

Implemented in uhd::rfnoc::mock_reg_iface_t.

## multi_poke32()

virtual void uhd::rfnoc::register_iface::multi_poke32 | ( | const std::vector< uint32_t > | addrs,
|  | const std::vector< uint32_t > | data,
|  | uhd::time_spec_t | time = uhd::time_spec_t::ASAP,
|  | bool | ack = false )

pure virtual

Write multiple 32-bit registers implemented in the NoC block.

This method should be called when multiple writes need to happen that are at non-consecutive addresses. For consecutive writes, cf. block_poke32().

Parameters

  addrs | The byte addresses of the registers to write to (each truncated to 20 bits).
  data | New values of these registers. The lengths of data and addr must match.
  time | The time at which the first transaction should be executed.
  ack | Should transaction completion be acknowledged?

Exceptions

  uhd::value_error | if lengths of data and addr don't match
  op_failed | if an ACK is requested and the transaction fails
  op_timeout | if an ACK is requested and no response is received
  op_seqerr | if an ACK is requested and a sequence error occurs
  op_timeerr | if an ACK is requested and a time error occurs (late command)

Implemented in uhd::rfnoc::mock_reg_iface_t.

## peek32()

virtual uint32_t uhd::rfnoc::register_iface::peek32 | ( | uint32_t | addr,
|  | time_spec_t | time = uhd::time_spec_t::ASAP )

pure virtual

Read a 32-bit register implemented in the NoC block.

Parameters

  addr | The byte address of the register to read from (truncated to 20 bits).
  time | The time at which the transaction should be executed.

Exceptions

  op_failed | if the transaction fails
  op_timeout | if no response is received
  op_seqerr | if a sequence error occurs

Implemented in uhd::rfnoc::mock_reg_iface_t.

## peek64()

uint64_t uhd::rfnoc::register_iface::peek64 | ( | uint32_t | addr,
|  | time_spec_t | time = uhd::time_spec_t::ASAP )

inline

Read two consecutive 32-bit registers implemented in the NoC block and return them as one 64-bit value.

Note: This is a convenience call, because all register peeks are 32-bits. This will concatenate two peeks in a block peek, and then return the combined result of the two peeks.

Parameters

  addr | The byte address of the lower 32-bit register to read from (truncated to 20 bits).
  time | The time at which the transaction should be executed.

Exceptions

  op_failed | if the transaction fails
  op_timeout | if no response is received
  op_seqerr | if a sequence error occurs

## poke32()

virtual void uhd::rfnoc::register_iface::poke32 | ( | uint32_t | addr,
|  | uint32_t | data,
|  | uhd::time_spec_t | time = uhd::time_spec_t::ASAP,
|  | bool | ack = false )

pure virtual

Write a 32-bit register implemented in the NoC block.

Parameters

  addr | The byte address of the register to write to (truncated to 20 bits).
  data | New value of this register.
  time | The time at which the transaction should be executed.
  ack | Should transaction completion be acknowledged?

Exceptions

  op_failed | if an ACK is requested and the transaction fails
  op_timeout | if an ACK is requested and no response is received
  op_seqerr | if an ACK is requested and a sequence error occurs
  op_timeerr | if an ACK is requested and a time error occurs (late command)

Implemented in uhd::rfnoc::mock_reg_iface_t.

## poke64()

void uhd::rfnoc::register_iface::poke64 | ( | uint32_t | addr,
|  | uint64_t | data,
|  | time_spec_t | time = uhd::time_spec_t::ASAP,
|  | bool | ack = false )

inline

Write two consecutive 32-bit registers implemented in the NoC block from one 64-bit value.

Note: This is a convenience call, because all register pokes are 32-bits. This will concatenate two pokes in a block poke, and then return the combined result of the two pokes.

Parameters

  addr | The byte address of the lower 32-bit register to read from (truncated to 20 bits).
  data | New value of the register(s).
  time | The time at which the transaction should be executed.
  ack | Should transaction completion be acknowledged?

Exceptions

  op_failed | if the transaction fails
  op_timeout | if no response is received
  op_seqerr | if a sequence error occurs

## poll32()

virtual void uhd::rfnoc::register_iface::poll32 | ( | uint32_t | addr,
|  | uint32_t | data,
|  | uint32_t | mask,
|  | time_spec_t | timeout,
|  | time_spec_t | time = uhd::time_spec_t::ASAP,
|  | bool | ack = false )

pure virtual

Poll a 32-bit register until its value for all bits in mask match data&mask

This will insert a command into the command queue to wait until a register is of a certain value. This can be used, e.g., to poll for a lock pin before executing the next command. It is related to sleep(), except it has a condition to wait on, rather than an unconditional stall duration. The timeout is hardware-timed. If the register does not attain the requested value within the requested duration, ${something bad happens}.

Example: Assume readback register 16 is a status register, and bit 0 indicates a lock is in place (i.e., we want it to be 1) and bit 1 is an error flag (i.e., we want it to be 0). The previous command can modify the state of the block, so we give it 1ms to settle. In that case, the call would be thus:

// iface is a register_iface::sptr:
iface->poll32(16, 0x1, 0x3, 1e-3);

Parameters

  addr | The byte address of the register to read from (truncated to 20 bits).
  data | The values that the register must have
  mask | The bitmask that is applied before checking the readback value
  timeout | The max duration that the register is allowed to take before reaching its new state.
  time | When the poll should be executed
  ack | Should transaction completion be acknowledged? This is typically only necessary if the software needs a condition to be fulfilled before continueing, or during debugging.

Exceptions

  op_failed | if an ACK is requested and the transaction fails
  op_timeout | if an ACK is requested and no response is received
  op_seqerr | if an ACK is requested and a sequence error occurs
  op_timeerr | if an ACK is requested and a time error occurs (late command)

Implemented in uhd::rfnoc::mock_reg_iface_t.

## register_async_msg_handler()

virtual void uhd::rfnoc::register_iface::register_async_msg_handler | ( | async_msg_callback_t | callback_f | ) |

pure virtual

Register a callback function for when an async message is received

Only one callback function can be registered. When calling this multiple times, only the last callback will be accepted.

Parameters

  callback_f | The function to call when an asynchronous message is received.

Implemented in uhd::rfnoc::mock_reg_iface_t.

## register_async_msg_validator()

virtual void uhd::rfnoc::register_iface::register_async_msg_validator | ( | async_msg_validator_t | callback_f | ) |

pure virtual

Register a callback function to validate a received async message

The purpose of this callback is to provide a method to the framework to make sure a received async message is valid. If this callback is provided, the framework will first pass the message to the validator for validation. If the validator returns true, the async message is ACK'd with a ctrl_status_t::CMD_OKAY response, and then the async message is executed. If the validator returns false, then the async message is ACK'd with a ctrl_status_t::CMD_CMDERR, and the async message handler is not excecuted.

This callback may not communicate with the device, it can only look at the data and make a valid/not valid decision.

Only one callback function can be registered. When calling this multiple times, only the last callback will be accepted.

Parameters

  callback_f | The function to call when an asynchronous message is received.

Implemented in uhd::rfnoc::mock_reg_iface_t.

## set_policy()

virtual void uhd::rfnoc::register_iface::set_policy | ( | const std::string & | name,
|  | const uhd::device_addr_t & | args )

pure virtual

Set a policy that governs the operational parameters of this register bus. Policies can be used to make tradeoffs between performance, resilience, latency, etc.

Parameters

  name | The name of the policy to apply
  args | Additional arguments to pass to the policy governor

Implemented in uhd::rfnoc::mock_reg_iface_t.

## sleep()

virtual void uhd::rfnoc::register_iface::sleep | ( | time_spec_t | duration,
|  | bool | ack = false )

pure virtual

Send a command to halt (block) the control bus for a specified time. This is a hardware-timed sleep.

Parameters

  duration | The amount of time to sleep.
  ack | Should transaction completion be acknowledged?

Exceptions

  op_failed | if an ACK is requested and the transaction fails
  op_timeout | if an ACK is requested and no response is received
  op_seqerr | if an ACK is requested and a sequence error occurs

Implemented in uhd::rfnoc::mock_reg_iface_t.

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

- register_iface.hpp