diff options
author | Josh Blum | 2011-09-28 22:16:41 -0700 |
---|---|---|
committer | Josh Blum | 2011-09-28 22:16:41 -0700 |
commit | 3f7db0afa99caeecb18428d7514dadd380d88d56 (patch) | |
tree | b513683057e96d03ff8138100d6059d80e7b3265 /gr-uhd/include/gr_uhd_usrp_source.h | |
parent | 60fd23a703bb16065717159bdd5ec9edf03d7302 (diff) | |
parent | 9e73c4e8372bc581d686d5e82a808894d41523ec (diff) | |
download | gnuradio-3f7db0afa99caeecb18428d7514dadd380d88d56.tar.gz gnuradio-3f7db0afa99caeecb18428d7514dadd380d88d56.tar.bz2 gnuradio-3f7db0afa99caeecb18428d7514dadd380d88d56.zip |
Merge branch 'next' into digital
Conflicts:
gnuradio-core/src/lib/filter/gr_pfb_clock_sync_ccf.h
gnuradio-core/src/lib/general/general.i
gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.cc
gnuradio-core/src/lib/general/gr_pll_freqdet_cf.cc
gnuradio-core/src/lib/general/gr_pll_refout_cc.cc
gnuradio-core/src/python/gnuradio/gr/qa_pll_carriertracking.py
gnuradio-core/src/python/gnuradio/gr/qa_pll_freqdet.py
gnuradio-core/src/python/gnuradio/gr/qa_pll_refout.py
Diffstat (limited to 'gr-uhd/include/gr_uhd_usrp_source.h')
-rw-r--r-- | gr-uhd/include/gr_uhd_usrp_source.h | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/gr-uhd/include/gr_uhd_usrp_source.h b/gr-uhd/include/gr_uhd_usrp_source.h index 6e51a1423..f8ac9361e 100644 --- a/gr-uhd/include/gr_uhd_usrp_source.h +++ b/gr-uhd/include/gr_uhd_usrp_source.h @@ -28,6 +28,29 @@ class uhd_usrp_source; +/*! + * \brief Make a new USRP source block. + * + * The USRP source block receives samples and writes to a stream. + * The source block also provides API calls for receiver settings. + * + * RX Stream tagging: + * + * The following tag keys will be produced by the work function: + * - pmt::pmt_string_to_symbol("rx_time") + * + * The timstamp tag value is a pmt tuple of the following: + * (uint64 seconds, and double fractional seconds). + * A timestamp tag is produced at start() and after overflows. + * + * See the UHD manual for more detailed documentation: + * http://code.ettus.com/redmine/ettus/projects/uhd/wiki + * + * \param device_addr the address to identify the hardware + * \param io_type the desired output data type + * \param num_channels number of stream from the device + * \return a new USRP source block object + */ GR_UHD_API boost::shared_ptr<uhd_usrp_source> uhd_make_usrp_source( const uhd::device_addr_t &device_addr, const uhd::io_type_t &io_type, |