diff options
| author | sugandhagupta <sugandha.gupta@ettus.com> | 2017-06-29 15:10:27 -0700 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2017-06-29 15:17:06 -0700 |
| commit | c77bd0c46a598d5e69b179d76a3df6091e982129 (patch) | |
| tree | eecd1e6d4d1908f34880654a8750dbe78db1f57f /host/lib/usrp/common | |
| parent | c33928d2bbdd27688c3475e77fc461e7d16eba5a (diff) | |
| download | uhd-c77bd0c46a598d5e69b179d76a3df6091e982129.tar.gz uhd-c77bd0c46a598d5e69b179d76a3df6091e982129.tar.bz2 uhd-c77bd0c46a598d5e69b179d76a3df6091e982129.zip | |
docs: Fixed doxygen warnings
Diffstat (limited to 'host/lib/usrp/common')
| -rw-r--r-- | host/lib/usrp/common/fx2_ctrl.hpp | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/host/lib/usrp/common/fx2_ctrl.hpp b/host/lib/usrp/common/fx2_ctrl.hpp index 40f91b9b6..48cbe4124 100644 --- a/host/lib/usrp/common/fx2_ctrl.hpp +++ b/host/lib/usrp/common/fx2_ctrl.hpp @@ -60,7 +60,7 @@ public: virtual void usrp_fx2_reset(void) = 0; /*! - * Load firmware in Intel HEX Format onto device + * Load firmware in Intel HEX Format onto device * \param filename name of firmware file * \param force reload firmware if already loaded */ @@ -68,24 +68,25 @@ public: bool force = false) = 0; /*! - * Load fpga file onto usrp - * \param filename name of fpga image + * Load fpga file onto usrp + * \param filename name of fpga image */ virtual void usrp_load_fpga(std::string filename) = 0; /*! * Load USB descriptor file in Intel HEX format into EEPROM - * \param filename name of EEPROM image + * \param filestring name of EEPROM image */ virtual void usrp_load_eeprom(std::string filestring) = 0; - + /*! - * Submit an IN transfer - * \param request device specific request + * Submit an IN transfer + * \param request device specific request * \param value device specific field * \param index device specific field * \param buff buffer to place data - * \return number of bytes read or error + * \param length length of buffer + * \return number of bytes read or error */ virtual int usrp_control_read(uint8_t request, uint16_t value, @@ -94,12 +95,13 @@ public: uint16_t length) = 0; /*! - * Submit an OUT transfer - * \param request device specific request + * Submit an OUT transfer + * \param request device specific request * \param value device specific field * \param index device specific field - * \param buff buffer of data to be sent - * \return number of bytes written or error + * \param buff buffer of data to be sent + * \param length length of buffer + * \return number of bytes written or error */ virtual int usrp_control_write(uint8_t request, uint16_t value, @@ -110,25 +112,25 @@ public: /*! * Perform an I2C write * \param i2c_addr I2C device address - * \param buf data to be written + * \param buf data to be written * \param len length of data in bytes - * \return number of bytes written or error + * \return number of bytes written or error */ virtual int usrp_i2c_write(uint16_t i2c_addr, - unsigned char *buf, + unsigned char *buf, uint16_t len) = 0; /*! * Perform an I2C read * \param i2c_addr I2C device address - * \param buf data to be read + * \param buf data to be read * \param len length of data in bytes - * \return number of bytes read or error + * \return number of bytes read or error */ virtual int usrp_i2c_read(uint16_t i2c_addr, - unsigned char *buf, + unsigned char *buf, uint16_t len) = 0; //! enable/disable the rx path |