diff options
| -rw-r--r-- | host/include/uhd/rfnoc/block_ctrl_base.hpp | 9 | ||||
| -rw-r--r-- | host/include/uhd/rfnoc/radio_ctrl.hpp | 5 | ||||
| -rw-r--r-- | host/include/uhd/rfnoc/source_block_ctrl_base.hpp | 3 |
3 files changed, 15 insertions, 2 deletions
diff --git a/host/include/uhd/rfnoc/block_ctrl_base.hpp b/host/include/uhd/rfnoc/block_ctrl_base.hpp index 0212fc62c..fa3ceadc5 100644 --- a/host/include/uhd/rfnoc/block_ctrl_base.hpp +++ b/host/include/uhd/rfnoc/block_ctrl_base.hpp @@ -186,6 +186,7 @@ public: * * \param reg The settings register to write to. * \param data New value of this register. + * \param port Port on which to write * \throw uhd::key_error if \p reg is not a valid register name * */ @@ -194,6 +195,7 @@ public: /*! Allows reading one register on the settings bus (64-Bit version). * * \param reg The settings register to be read. + * \param port Port on which to read * * Returns the readback value. */ @@ -202,6 +204,7 @@ public: /*! Allows reading one register on the settings bus (32-Bit version). * * \param reg The settings register to be read. + * \param port Port on which to read * * Returns the readback value. */ @@ -214,6 +217,7 @@ public: * with sr_read64(). * * \param addr The user register address. + * \param port Port on which to read * \returns the readback value. */ boost::uint64_t user_reg_read64(const boost::uint32_t addr, const size_t port = 0); @@ -225,6 +229,7 @@ public: * defined in the block definition file. * * \param addr The user register address. + * \param port Port on which to read * \returns the readback value. * \throws uhd::key_error if \p reg is not a valid register name */ @@ -237,6 +242,7 @@ public: * with sr_read32(). * * \param addr The user register address. + * \param port Port on which to read * \returns the readback value. */ boost::uint32_t user_reg_read32(const boost::uint32_t addr, const size_t port = 0); @@ -270,6 +276,7 @@ public: /*! Sets a tick rate for the command timebase. * * \param the tick rate in Hz + * \port port Port */ void set_command_tick_rate(const double tick_rate, const size_t port = ANY_PORT); @@ -358,7 +365,7 @@ protected: **********************************************************************/ stream_sig_t _resolve_port_def(const blockdef::port_t &port_def) const; - //! Return the property tree path to a block argument \key on \p port + //! Return the property tree path to a block argument \p key on \p port uhd::fs_path get_arg_path(const std::string &key, size_t port = 0) const { return _root_path / "args" / port / key; }; diff --git a/host/include/uhd/rfnoc/radio_ctrl.hpp b/host/include/uhd/rfnoc/radio_ctrl.hpp index c29cc9b5a..1d7842051 100644 --- a/host/include/uhd/rfnoc/radio_ctrl.hpp +++ b/host/include/uhd/rfnoc/radio_ctrl.hpp @@ -91,11 +91,14 @@ public: */ virtual double get_tx_frequency(const size_t chan) /* const */ = 0; - /*! Tune the TX LO for channel \p. + /*! Tune the TX LO for channel \p chan. * * This function will attempt to tune as close as possible, and return a * coerced value of the actual tuning result. * + * \param freq Frequency in Hz + * \param chan Channel to tune + * * \return The actual LO frequency. */ virtual double set_tx_frequency(const double freq, size_t chan) = 0; diff --git a/host/include/uhd/rfnoc/source_block_ctrl_base.hpp b/host/include/uhd/rfnoc/source_block_ctrl_base.hpp index b3e908f72..02882307c 100644 --- a/host/include/uhd/rfnoc/source_block_ctrl_base.hpp +++ b/host/include/uhd/rfnoc/source_block_ctrl_base.hpp @@ -87,6 +87,9 @@ public: **********************************************************************/ /*! Configures data flowing from port \p output_block_port to go to \p next_address * + * \param next_address Address of the downstream block + * \param output_block_port Port for which this is valid + * * In the default implementation, this will write the value in \p next_address * to register SR_NEXT_DST of this blocks settings bus. The value will also * have bit 16 set to 1, since some blocks require this to respect this value. |