GNU Radio 3.5.3.2 C++ API
gr_uhd_usrp_source.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2010-2012 Free Software Foundation, Inc.
00003  * 
00004  * This file is part of GNU Radio
00005  * 
00006  * GNU Radio is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 3, or (at your option)
00009  * any later version.
00010  * 
00011  * GNU Radio is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  * 
00016  * You should have received a copy of the GNU General Public License
00017  * along with GNU Radio; see the file COPYING.  If not, write to
00018  * the Free Software Foundation, Inc., 51 Franklin Street,
00019  * Boston, MA 02110-1301, USA.
00020  */
00021 
00022 #ifndef INCLUDED_GR_UHD_USRP_SOURCE_H
00023 #define INCLUDED_GR_UHD_USRP_SOURCE_H
00024 
00025 #include <gr_uhd_api.h>
00026 #include <gr_sync_block.h>
00027 #include <uhd/usrp/multi_usrp.hpp>
00028 
00029 #ifndef INCLUDED_UHD_STREAM_HPP
00030 namespace uhd{
00031     struct GR_UHD_API stream_args_t{
00032         stream_args_t(
00033             const std::string &cpu = "",
00034             const std::string &otw = ""
00035         ){
00036             cpu_format = cpu;
00037             otw_format = otw;
00038         }
00039         std::string cpu_format;
00040         std::string otw_format;
00041         device_addr_t args;
00042         std::vector<size_t> channels;
00043     };
00044 }
00045 #  define INCLUDED_UHD_STREAM_HPP
00046 #else
00047 #  define GR_UHD_USE_STREAM_API
00048 #endif
00049 
00050 class uhd_usrp_source;
00051 
00052 /*!
00053  * \brief Make a new USRP source block.
00054  * \ingroup uhd_blk
00055  *
00056  * The USRP source block receives samples and writes to a stream.
00057  * The source block also provides API calls for receiver settings.
00058  *
00059  * RX Stream tagging:
00060  *
00061  * The following tag keys will be produced by the work function:
00062  *  - pmt::pmt_string_to_symbol("rx_time")
00063  *
00064  * The timstamp tag value is a pmt tuple of the following:
00065  * (uint64 seconds, and double fractional seconds).
00066  * A timestamp tag is produced at start() and after overflows.
00067  *
00068  * See the UHD manual for more detailed documentation:
00069  * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
00070  *
00071  * \param device_addr the address to identify the hardware
00072  * \param io_type the desired output data type
00073  * \param num_channels number of stream from the device
00074  * \return a new USRP source block object
00075  */
00076 GR_UHD_API boost::shared_ptr<uhd_usrp_source> uhd_make_usrp_source(
00077     const uhd::device_addr_t &device_addr,
00078     const uhd::io_type_t &io_type,
00079     size_t num_channels
00080 );
00081 
00082 /*!
00083  * \brief Make a new USRP source block.
00084  *
00085  * The USRP source block receives samples and writes to a stream.
00086  * The source block also provides API calls for receiver settings.
00087  *
00088  * RX Stream tagging:
00089  *
00090  * The following tag keys will be produced by the work function:
00091  *  - pmt::pmt_string_to_symbol("rx_time")
00092  *
00093  * The timstamp tag value is a pmt tuple of the following:
00094  * (uint64 seconds, and double fractional seconds).
00095  * A timestamp tag is produced at start() and after overflows.
00096  *
00097  * See the UHD manual for more detailed documentation:
00098  * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
00099  *
00100  * \param device_addr the address to identify the hardware
00101  * \param stream_args the IO format and channel specification
00102  * \return a new USRP source block object
00103  */
00104 GR_UHD_API boost::shared_ptr<uhd_usrp_source> uhd_make_usrp_source(
00105     const uhd::device_addr_t &device_addr,
00106     const uhd::stream_args_t &stream_args
00107 );
00108 
00109 class GR_UHD_API uhd_usrp_source : virtual public gr_sync_block{
00110 public:
00111 
00112     /*!
00113      * Set the start time for incoming samples.
00114      * To control when samples are received,
00115      * set this value before starting the flow graph.
00116      * The value is cleared after each run.
00117      * When not specified, the start time will be:
00118      *  - Immediately for the one channel case
00119      *  - in the near future for multi-channel
00120      *
00121      * \param time the absolute time for reception to begin
00122      */
00123     virtual void set_start_time(const uhd::time_spec_t &time) = 0;
00124 
00125     /*!
00126      * Returns identifying information about this USRP's configuration.
00127      * Returns motherboard ID, name, and serial.
00128      * Returns daughterboard RX ID, subdev name, and serial.
00129      * \param chan channel index 0 to N-1
00130      * \return RX info
00131      */
00132     virtual uhd::dict<std::string, std::string> get_usrp_info(size_t chan = 0) = 0;
00133 
00134     /*!
00135      * Set the frontend specification.
00136      * \param spec the subdev spec markup string
00137      * \param mboard the motherboard index 0 to M-1
00138      */
00139     virtual void set_subdev_spec(const std::string &spec, size_t mboard = 0) = 0;
00140 
00141     /*!
00142      * Get the RX frontend specification.
00143      * \param mboard the motherboard index 0 to M-1
00144      * \return the frontend specification in use
00145      */
00146     virtual std::string get_subdev_spec(size_t mboard = 0) = 0;
00147 
00148     /*!
00149      * Set the sample rate for the usrp device.
00150      * \param rate a new rate in Sps
00151      */
00152     virtual void set_samp_rate(double rate) = 0;
00153 
00154     /*!
00155      * Get the sample rate for the usrp device.
00156      * This is the actual sample rate and may differ from the rate set.
00157      * \return the actual rate in Sps
00158      */
00159     virtual double get_samp_rate(void) = 0;
00160 
00161     /*!
00162      * Get the possible sample rates for the usrp device.
00163      * \return a range of rates in Sps
00164      */
00165     virtual uhd::meta_range_t get_samp_rates(void) = 0;
00166 
00167     /*!
00168      * Tune the usrp device to the desired center frequency.
00169      * \param tune_request the tune request instructions
00170      * \param chan the channel index 0 to N-1
00171      * \return a tune result with the actual frequencies
00172      */
00173     virtual uhd::tune_result_t set_center_freq(
00174         const uhd::tune_request_t tune_request, size_t chan = 0
00175     ) = 0;
00176 
00177     /*!
00178      * Tune the usrp device to the desired center frequency.
00179      * This is a wrapper around set center freq so that in this case,
00180      * the user can pass a single frequency in the call through swig.
00181      * \param freq the desired frequency in Hz
00182      * \param chan the channel index 0 to N-1
00183      * \return a tune result with the actual frequencies
00184      */
00185     uhd::tune_result_t set_center_freq(double freq, size_t chan = 0){
00186         return set_center_freq(uhd::tune_request_t(freq), chan);
00187     }
00188 
00189     /*!
00190      * Get the center frequency.
00191      * \param chan the channel index 0 to N-1
00192      * \return the frequency in Hz
00193      */
00194     virtual double get_center_freq(size_t chan = 0) = 0;
00195 
00196     /*!
00197      * Get the tunable frequency range.
00198      * \param chan the channel index 0 to N-1
00199      * \return the frequency range in Hz
00200      */
00201     virtual uhd::freq_range_t get_freq_range(size_t chan = 0) = 0;
00202 
00203     /*!
00204      * Set the gain for the dboard.
00205      * \param gain the gain in dB
00206      * \param chan the channel index 0 to N-1
00207      */
00208     virtual void set_gain(double gain, size_t chan = 0) = 0;
00209 
00210     /*!
00211      * Set the named gain on the dboard.
00212      * \param gain the gain in dB
00213      * \param name the name of the gain stage
00214      * \param chan the channel index 0 to N-1
00215      */
00216     virtual void set_gain(double gain, const std::string &name, size_t chan = 0) = 0;
00217 
00218     /*!
00219      * Get the actual dboard gain setting.
00220      * \param chan the channel index 0 to N-1
00221      * \return the actual gain in dB
00222      */
00223     virtual double get_gain(size_t chan = 0) = 0;
00224 
00225     /*!
00226      * Get the actual dboard gain setting of named stage.
00227      * \param name the name of the gain stage
00228      * \param chan the channel index 0 to N-1
00229      * \return the actual gain in dB
00230      */
00231     virtual double get_gain(const std::string &name, size_t chan = 0) = 0;
00232 
00233     /*!
00234      * Get the actual dboard gain setting of named stage.
00235      * \param chan the channel index 0 to N-1
00236      * \return the actual gain in dB
00237      */
00238     virtual std::vector<std::string> get_gain_names(size_t chan = 0) = 0;
00239 
00240     /*!
00241      * Get the settable gain range.
00242      * \param chan the channel index 0 to N-1
00243      * \return the gain range in dB
00244      */
00245     virtual uhd::gain_range_t get_gain_range(size_t chan = 0) = 0;
00246 
00247     /*!
00248      * Get the settable gain range.
00249      * \param name the name of the gain stage
00250      * \param chan the channel index 0 to N-1
00251      * \return the gain range in dB
00252      */
00253     virtual uhd::gain_range_t get_gain_range(const std::string &name, size_t chan = 0) = 0;
00254 
00255     /*!
00256      * Set the antenna to use.
00257      * \param ant the antenna string
00258      * \param chan the channel index 0 to N-1
00259      */
00260     virtual void set_antenna(const std::string &ant, size_t chan = 0) = 0;
00261 
00262     /*!
00263      * Get the antenna in use.
00264      * \param chan the channel index 0 to N-1
00265      * \return the antenna string
00266      */
00267     virtual std::string get_antenna(size_t chan = 0) = 0;
00268 
00269     /*!
00270      * Get a list of possible antennas.
00271      * \param chan the channel index 0 to N-1
00272      * \return a vector of antenna strings
00273      */
00274     virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
00275 
00276     /*!
00277      * Set the bandpass filter on the RF frontend.
00278      * \param bandwidth the filter bandwidth in Hz
00279      * \param chan the channel index 0 to N-1
00280      */
00281     virtual void set_bandwidth(double bandwidth, size_t chan = 0) = 0;
00282 
00283     /*!
00284      * Enable/disable the automatic DC offset correction.
00285      * The automatic correction subtracts out the long-run average.
00286      *
00287      * When disabled, the averaging option operation is halted.
00288      * Once halted, the average value will be held constant
00289      * until the user re-enables the automatic correction
00290      * or overrides the value by manually setting the offset.
00291      *
00292      * \param enb true to enable automatic DC offset correction
00293      * \param chan the channel index 0 to N-1
00294      */
00295     virtual void set_auto_dc_offset(const bool enb, size_t chan = 0) = 0;
00296 
00297     /*!
00298      * Set a constant DC offset value.
00299      * The value is complex to control both I and Q.
00300      * Only set this when automatic correction is disabled.
00301      * \param offset the dc offset (1.0 is full-scale)
00302      * \param chan the channel index 0 to N-1
00303      */
00304     virtual void set_dc_offset(const std::complex<double> &offset, size_t chan = 0) = 0;
00305 
00306     /*!
00307      * Set the RX frontend IQ imbalance correction.
00308      * Use this to adjust the magnitude and phase of I and Q.
00309      *
00310      * \param correction the complex correction value
00311      * \param chan the channel index 0 to N-1
00312      */
00313     virtual void set_iq_balance(const std::complex<double> &correction, size_t chan = 0) = 0;
00314 
00315     /*!
00316      * Get a RF frontend sensor value.
00317      * \param name the name of the sensor
00318      * \param chan the channel index 0 to N-1
00319      * \return a sensor value object
00320      */
00321     virtual uhd::sensor_value_t get_sensor(const std::string &name, size_t chan = 0) = 0;
00322 
00323     /*!
00324      * Get a list of possible RF frontend sensor names.
00325      * \param chan the channel index 0 to N-1
00326      * \return a vector of sensor names
00327      */
00328     virtual std::vector<std::string> get_sensor_names(size_t chan = 0) = 0;
00329 
00330     //! DEPRECATED use get_sensor
00331     uhd::sensor_value_t get_dboard_sensor(const std::string &name, size_t chan = 0){
00332         return this->get_sensor(name, chan);
00333     }
00334 
00335     //! DEPRECATED use get_sensor_names
00336     std::vector<std::string> get_dboard_sensor_names(size_t chan = 0){
00337         return this->get_sensor_names(chan);
00338     }
00339 
00340     /*!
00341      * Get a motherboard sensor value.
00342      * \param name the name of the sensor
00343      * \param mboard the motherboard index 0 to M-1
00344      * \return a sensor value object
00345      */
00346     virtual uhd::sensor_value_t get_mboard_sensor(const std::string &name, size_t mboard = 0) = 0;
00347 
00348     /*!
00349      * Get a list of possible motherboard sensor names.
00350      * \param mboard the motherboard index 0 to M-1
00351      * \return a vector of sensor names
00352      */
00353     virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;
00354 
00355     /*!
00356      * Set the clock configuration.
00357      * DEPRECATED for set_time/clock_source.
00358      * \param clock_config the new configuration
00359      * \param mboard the motherboard index 0 to M-1
00360      */
00361     virtual void set_clock_config(const uhd::clock_config_t &clock_config, size_t mboard = 0) = 0;
00362 
00363      /*!
00364      * Set the time source for the usrp device.
00365      * This sets the method of time synchronization,
00366      * typically a pulse per second or an encoded time.
00367      * Typical options for source: external, MIMO.
00368      * \param source a string representing the time source
00369      * \param mboard which motherboard to set the config
00370      */
00371     virtual void set_time_source(const std::string &source, const size_t mboard = 0) = 0;
00372 
00373     /*!
00374      * Get the currently set time source.
00375      * \param mboard which motherboard to get the config
00376      * \return the string representing the time source
00377      */
00378     virtual std::string get_time_source(const size_t mboard) = 0;
00379 
00380     /*!
00381      * Get a list of possible time sources.
00382      * \param mboard which motherboard to get the list
00383      * \return a vector of strings for possible settings
00384      */
00385     virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;
00386 
00387     /*!
00388      * Set the clock source for the usrp device.
00389      * This sets the source for a 10 Mhz reference clock.
00390      * Typical options for source: internal, external, MIMO.
00391      * \param source a string representing the clock source
00392      * \param mboard which motherboard to set the config
00393      */
00394     virtual void set_clock_source(const std::string &source, const size_t mboard = 0) = 0;
00395 
00396     /*!
00397      * Get the currently set clock source.
00398      * \param mboard which motherboard to get the config
00399      * \return the string representing the clock source
00400      */
00401     virtual std::string get_clock_source(const size_t mboard) = 0;
00402 
00403     /*!
00404      * Get a list of possible clock sources.
00405      * \param mboard which motherboard to get the list
00406      * \return a vector of strings for possible settings
00407      */
00408     virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;
00409 
00410     /*!
00411      * Get the master clock rate.
00412      * \param mboard the motherboard index 0 to M-1
00413      * \return the clock rate in Hz
00414      */
00415     virtual double get_clock_rate(size_t mboard = 0) = 0;
00416 
00417     /*!
00418      * Set the master clock rate.
00419      * \param rate the new rate in Hz
00420      * \param mboard the motherboard index 0 to M-1
00421      */
00422     virtual void set_clock_rate(double rate, size_t mboard = 0) = 0;
00423 
00424     /*!
00425      * Get the current time registers.
00426      * \param mboard the motherboard index 0 to M-1
00427      * \return the current usrp time
00428      */
00429     virtual uhd::time_spec_t get_time_now(size_t mboard = 0) = 0;
00430 
00431     /*!
00432      * Get the time when the last pps pulse occured.
00433      * \param mboard the motherboard index 0 to M-1
00434      * \return the current usrp time
00435      */
00436     virtual uhd::time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
00437 
00438     /*!
00439      * Sets the time registers immediately.
00440      * \param time_spec the new time
00441      * \param mboard the motherboard index 0 to M-1
00442      */
00443     virtual void set_time_now(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
00444 
00445     /*!
00446      * Set the time registers at the next pps.
00447      * \param time_spec the new time
00448      */
00449     virtual void set_time_next_pps(const uhd::time_spec_t &time_spec) = 0;
00450 
00451     /*!
00452      * Sync the time registers with an unknown pps edge.
00453      * \param time_spec the new time
00454      */
00455     virtual void set_time_unknown_pps(const uhd::time_spec_t &time_spec) = 0;
00456 
00457     /*!
00458      * Set the time at which the control commands will take effect.
00459      *
00460      * A timed command will back-pressure all subsequent timed commands,
00461      * assuming that the subsequent commands occur within the time-window.
00462      * If the time spec is late, the command will be activated upon arrival.
00463      *
00464      * \param time_spec the time at which the next command will activate
00465      * \param mboard which motherboard to set the config
00466      */
00467     virtual void set_command_time(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
00468 
00469     /*!
00470      * Clear the command time so future commands are sent ASAP.
00471      *
00472      * \param mboard which motherboard to set the config
00473      */
00474     virtual void clear_command_time(size_t mboard = 0) = 0;
00475 
00476     /*!
00477      * Get access to the underlying uhd dboard iface object.
00478      * \return the dboard_iface object
00479      */
00480     virtual uhd::usrp::dboard_iface::sptr get_dboard_iface(size_t chan = 0) = 0;
00481 
00482     /*!
00483      * Get access to the underlying uhd device object.
00484      * \return the multi usrp device object
00485      */
00486     virtual uhd::usrp::multi_usrp::sptr get_device(void) = 0;
00487 
00488     /*!
00489      * Perform write on the user configuration register bus.  These only exist if
00490      * the user has implemented custom setting registers in the device FPGA.
00491      * \param addr 8-bit register address
00492      * \param data 32-bit register value
00493      * \param mboard which motherboard to set the user register
00494      */
00495     virtual void set_user_register(const uint8_t addr, const uint32_t data, size_t mboard = 0) = 0;
00496 
00497     /*!
00498      * Convenience function for finite data acquisition.
00499      * This is not to be used with the scheduler; rather,
00500      * one can request samples from the USRP in python.
00501      * //TODO assumes fc32
00502      * \param nsamps the number of samples
00503      * \return a vector of complex float samples
00504      */
00505     virtual std::vector<std::complex<float> > finite_acquisition(const size_t nsamps) = 0;
00506 
00507     /*!
00508      * Convenience function for finite data acquisition.
00509      * This is the multi-channel version of finite_acquisition;
00510      * This is not to be used with the scheduler; rather,
00511      * one can request samples from the USRP in python.
00512      * //TODO assumes fc32
00513      * \param nsamps the number of samples per channel
00514      * \return a vector of buffers, where each buffer represents a channel
00515      */
00516     virtual std::vector<std::vector<std::complex<float> > > finite_acquisition_v(const size_t nsamps) = 0;
00517 };
00518 
00519 #endif /* INCLUDED_GR_UHD_USRP_SOURCE_H */