sdr
/
libusrp
mirror of https://gerrit.osmocom.org/libusrp
8
0
Fork 0
Code Releases Activity

Doc fixes. 

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11088 221aa14e-8319-0410-a670-987f0aec2ac5
This commit is contained in:
eb 2009-05-22 21:22:22 +00:00
parent 0ee8968fef
commit 88f53a140b
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
host/lib/legacy/usrp_basic.h
View File

@ -237,14 +237,14 @@ public:
/*!
* \brief Set ADC offset correction
* \param which which ADC[0,3]: 0 = RX_A I, 1 = RX_A Q...
* \param which_adc which ADC[0,3]: 0 = RX_A I, 1 = RX_A Q...
* \param offset 16-bit value to subtract from raw ADC input.
*/
bool set_adc_offset (int which_adc, int offset);
/*!
* \brief Set DAC offset correction
* \param which which DAC[0,3]: 0 = TX_A I, 1 = TX_A Q...
* \param which_dac which DAC[0,3]: 0 = TX_A I, 1 = TX_A Q...
* \param offset 10-bit offset value (ambiguous format: See AD9862 datasheet).
* \param offset_pin 1-bit value. If 0 offset applied to -ve differential pin;
* If 1 offset applied to +ve differential pin.
@ -782,6 +782,8 @@ protected:
* \param fusb_block_size fast usb xfer block size. Must be a multiple of 512.
* Use zero for a reasonable default.
* \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default.
* \param fpga_filename name of the rbf file to load
* \param firmware_filename name of ihx file to load
*/
usrp_basic_rx (int which_board,
int fusb_block_size=0,

15
host/lib/legacy/usrp_standard.h
View File

@ -127,9 +127,15 @@ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common
* \brief invokes constructor, returns shared_ptr or shared_ptr equivalent of 0 if trouble
*
* \param which_board Which USRP board on usb (not particularly useful; use 0)
* \param decim_rate decimation factor
* \param nchan number of channels
* \param mux Rx mux setting, \sa set_mux
* \param mode mode
* \param fusb_block_size fast usb xfer block size. Must be a multiple of 512.
* Use zero for a reasonable default.
* \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default.
* \param fpga_filename Name of rbf file to load
* \param firmware_filename Name of ihx file to load
*/
static usrp_standard_rx_sptr make(int which_board,
unsigned int decim_rate,
@ -255,7 +261,7 @@ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common
* \param chan which DDC channel we're controlling (almost always 0).
* \param db the daughterboard we're controlling.
* \param target_freq the RF frequency we want at DC in the complex baseband.
* \param[out] tune_result details how the hardware was configured.
* \param[out] result details how the hardware was configured.
*
* \returns true iff everything was successful.
*/
@ -329,9 +335,14 @@ class usrp_standard_tx : public usrp_basic_tx, public usrp_standard_common
* \brief invokes constructor, returns shared_ptr or shared_ptr equivalent of 0 if trouble
*
* \param which_board Which USRP board on usb (not particularly useful; use 0)
* \param interp_rate interpolation factor
* \param nchan number of channels
* \param mux Tx mux setting, \sa set_mux
* \param fusb_block_size fast usb xfer block size. Must be a multiple of 512.
* Use zero for a reasonable default.
* \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default.
* \param fpga_filename Name of rbf file to load
* \param firmware_filename Name of ihx file to load
*/
static usrp_standard_tx_sptr make(int which_board,
unsigned int interp_rate,
@ -426,7 +437,7 @@ class usrp_standard_tx : public usrp_basic_tx, public usrp_standard_common
* \param chan which DUC channel we're controlling (usually == which_side).
* \param db the daughterboard we're controlling.
* \param target_freq the RF frequency we want our baseband translated to.
* \param[out] tune_result details how the hardware was configured.
* \param[out] result details how the hardware was configured.
*
* \returns true iff everything was successful.
*/