GNU Radio 3.6.2 C++ API
gr_uhd_usrp_source.h
Go to the documentation of this file.
1 /*
2  * Copyright 2010-2012 Free Software Foundation, Inc.
3  *
4  * This file is part of GNU Radio
5  *
6  * GNU Radio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3, or (at your option)
9  * any later version.
10  *
11  * GNU Radio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with GNU Radio; see the file COPYING. If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street,
19  * Boston, MA 02110-1301, USA.
20  */
21 
22 #ifndef INCLUDED_GR_UHD_USRP_SOURCE_H
23 #define INCLUDED_GR_UHD_USRP_SOURCE_H
24 
25 #include <gr_uhd_api.h>
26 #include <gr_sync_block.h>
27 #include <uhd/usrp/multi_usrp.hpp>
28 
29 #ifndef INCLUDED_UHD_STREAM_HPP
30 namespace uhd{
31  struct GR_UHD_API stream_args_t{
33  const std::string &cpu = "",
34  const std::string &otw = ""
35  ){
36  cpu_format = cpu;
37  otw_format = otw;
38  }
39  std::string cpu_format;
40  std::string otw_format;
41  device_addr_t args;
42  std::vector<size_t> channels;
43  };
44 }
45 # define INCLUDED_UHD_STREAM_HPP
46 #else
47 # define GR_UHD_USE_STREAM_API
48 #endif
49 
50 class uhd_usrp_source;
51 
52 /*!
53  * \brief Make a new USRP source block.
54  * \ingroup uhd_blk
55  *
56  * The USRP source block receives samples and writes to a stream.
57  * The source block also provides API calls for receiver settings.
58  *
59  * RX Stream tagging:
60  *
61  * The following tag keys will be produced by the work function:
62  * - pmt::pmt_string_to_symbol("rx_time")
63  * - pmt::pmt_string_to_symbol("rx_rate")
64  * - pmt::pmt_string_to_symbol("rx_freq")
65  *
66  * The timstamp tag value is a pmt tuple of the following:
67  * (uint64 seconds, and double fractional seconds).
68  * A timestamp tag is produced at start() and after overflows.
69  *
70  * The sample rate and center frequency tags are doubles,
71  * representing the sample rate in Sps and frequency in Hz.
72  * These tags are produced upon the user changing parameters.
73  *
74  * See the UHD manual for more detailed documentation:
75  * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
76  *
77  * \param device_addr the address to identify the hardware
78  * \param io_type the desired output data type
79  * \param num_channels number of stream from the device
80  * \return a new USRP source block object
81  */
83  const uhd::device_addr_t &device_addr,
84  const uhd::io_type_t &io_type,
85  size_t num_channels
86 );
87 
88 /*!
89  * \brief Make a new USRP source block.
90  *
91  * The USRP source block receives samples and writes to a stream.
92  * The source block also provides API calls for receiver settings.
93  *
94  * RX Stream tagging:
95  *
96  * The following tag keys will be produced by the work function:
97  * - pmt::pmt_string_to_symbol("rx_time")
98  *
99  * The timstamp tag value is a pmt tuple of the following:
100  * (uint64 seconds, and double fractional seconds).
101  * A timestamp tag is produced at start() and after overflows.
102  *
103  * See the UHD manual for more detailed documentation:
104  * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
105  *
106  * \param device_addr the address to identify the hardware
107  * \param stream_args the IO format and channel specification
108  * \return a new USRP source block object
109  */
111  const uhd::device_addr_t &device_addr,
112  const uhd::stream_args_t &stream_args
113 );
114 
115 class GR_UHD_API uhd_usrp_source : virtual public gr_sync_block{
116 public:
117 
118  /*!
119  * Set the start time for incoming samples.
120  * To control when samples are received,
121  * set this value before starting the flow graph.
122  * The value is cleared after each run.
123  * When not specified, the start time will be:
124  * - Immediately for the one channel case
125  * - in the near future for multi-channel
126  *
127  * \param time the absolute time for reception to begin
128  */
129  virtual void set_start_time(const uhd::time_spec_t &time) = 0;
130 
131  /*!
132  * Returns identifying information about this USRP's configuration.
133  * Returns motherboard ID, name, and serial.
134  * Returns daughterboard RX ID, subdev name and spec, serial, and antenna.
135  * \param chan channel index 0 to N-1
136  * \return RX info
137  */
138  virtual uhd::dict<std::string, std::string> get_usrp_info(size_t chan = 0) = 0;
139 
140  /*!
141  * Set the frontend specification.
142  * \param spec the subdev spec markup string
143  * \param mboard the motherboard index 0 to M-1
144  */
145  virtual void set_subdev_spec(const std::string &spec, size_t mboard = 0) = 0;
146 
147  /*!
148  * Get the RX frontend specification.
149  * \param mboard the motherboard index 0 to M-1
150  * \return the frontend specification in use
151  */
152  virtual std::string get_subdev_spec(size_t mboard = 0) = 0;
153 
154  /*!
155  * Set the sample rate for the usrp device.
156  * \param rate a new rate in Sps
157  */
158  virtual void set_samp_rate(double rate) = 0;
159 
160  /*!
161  * Get the sample rate for the usrp device.
162  * This is the actual sample rate and may differ from the rate set.
163  * \return the actual rate in Sps
164  */
165  virtual double get_samp_rate(void) = 0;
166 
167  /*!
168  * Get the possible sample rates for the usrp device.
169  * \return a range of rates in Sps
170  */
171  virtual uhd::meta_range_t get_samp_rates(void) = 0;
172 
173  /*!
174  * Tune the usrp device to the desired center frequency.
175  * \param tune_request the tune request instructions
176  * \param chan the channel index 0 to N-1
177  * \return a tune result with the actual frequencies
178  */
179  virtual uhd::tune_result_t set_center_freq(
180  const uhd::tune_request_t tune_request, size_t chan = 0
181  ) = 0;
182 
183  /*!
184  * Tune the usrp device to the desired center frequency.
185  * This is a wrapper around set center freq so that in this case,
186  * the user can pass a single frequency in the call through swig.
187  * \param freq the desired frequency in Hz
188  * \param chan the channel index 0 to N-1
189  * \return a tune result with the actual frequencies
190  */
191  uhd::tune_result_t set_center_freq(double freq, size_t chan = 0){
192  return set_center_freq(uhd::tune_request_t(freq), chan);
193  }
194 
195  /*!
196  * Get the center frequency.
197  * \param chan the channel index 0 to N-1
198  * \return the frequency in Hz
199  */
200  virtual double get_center_freq(size_t chan = 0) = 0;
201 
202  /*!
203  * Get the tunable frequency range.
204  * \param chan the channel index 0 to N-1
205  * \return the frequency range in Hz
206  */
207  virtual uhd::freq_range_t get_freq_range(size_t chan = 0) = 0;
208 
209  /*!
210  * Set the gain for the dboard.
211  * \param gain the gain in dB
212  * \param chan the channel index 0 to N-1
213  */
214  virtual void set_gain(double gain, size_t chan = 0) = 0;
215 
216  /*!
217  * Set the named gain on the dboard.
218  * \param gain the gain in dB
219  * \param name the name of the gain stage
220  * \param chan the channel index 0 to N-1
221  */
222  virtual void set_gain(double gain, const std::string &name, size_t chan = 0) = 0;
223 
224  /*!
225  * Get the actual dboard gain setting.
226  * \param chan the channel index 0 to N-1
227  * \return the actual gain in dB
228  */
229  virtual double get_gain(size_t chan = 0) = 0;
230 
231  /*!
232  * Get the actual dboard gain setting of named stage.
233  * \param name the name of the gain stage
234  * \param chan the channel index 0 to N-1
235  * \return the actual gain in dB
236  */
237  virtual double get_gain(const std::string &name, size_t chan = 0) = 0;
238 
239  /*!
240  * Get the actual dboard gain setting of named stage.
241  * \param chan the channel index 0 to N-1
242  * \return the actual gain in dB
243  */
244  virtual std::vector<std::string> get_gain_names(size_t chan = 0) = 0;
245 
246  /*!
247  * Get the settable gain range.
248  * \param chan the channel index 0 to N-1
249  * \return the gain range in dB
250  */
251  virtual uhd::gain_range_t get_gain_range(size_t chan = 0) = 0;
252 
253  /*!
254  * Get the settable gain range.
255  * \param name the name of the gain stage
256  * \param chan the channel index 0 to N-1
257  * \return the gain range in dB
258  */
259  virtual uhd::gain_range_t get_gain_range(const std::string &name, size_t chan = 0) = 0;
260 
261  /*!
262  * Set the antenna to use.
263  * \param ant the antenna string
264  * \param chan the channel index 0 to N-1
265  */
266  virtual void set_antenna(const std::string &ant, size_t chan = 0) = 0;
267 
268  /*!
269  * Get the antenna in use.
270  * \param chan the channel index 0 to N-1
271  * \return the antenna string
272  */
273  virtual std::string get_antenna(size_t chan = 0) = 0;
274 
275  /*!
276  * Get a list of possible antennas.
277  * \param chan the channel index 0 to N-1
278  * \return a vector of antenna strings
279  */
280  virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
281 
282  /*!
283  * Set the bandpass filter on the RF frontend.
284  * \param bandwidth the filter bandwidth in Hz
285  * \param chan the channel index 0 to N-1
286  */
287  virtual void set_bandwidth(double bandwidth, size_t chan = 0) = 0;
288 
289  /*!
290  * Enable/disable the automatic DC offset correction.
291  * The automatic correction subtracts out the long-run average.
292  *
293  * When disabled, the averaging option operation is halted.
294  * Once halted, the average value will be held constant
295  * until the user re-enables the automatic correction
296  * or overrides the value by manually setting the offset.
297  *
298  * \param enb true to enable automatic DC offset correction
299  * \param chan the channel index 0 to N-1
300  */
301  virtual void set_auto_dc_offset(const bool enb, size_t chan = 0) = 0;
302 
303  /*!
304  * Set a constant DC offset value.
305  * The value is complex to control both I and Q.
306  * Only set this when automatic correction is disabled.
307  * \param offset the dc offset (1.0 is full-scale)
308  * \param chan the channel index 0 to N-1
309  */
310  virtual void set_dc_offset(const std::complex<double> &offset, size_t chan = 0) = 0;
311 
312  /*!
313  * Set the RX frontend IQ imbalance correction.
314  * Use this to adjust the magnitude and phase of I and Q.
315  *
316  * \param correction the complex correction value
317  * \param chan the channel index 0 to N-1
318  */
319  virtual void set_iq_balance(const std::complex<double> &correction, size_t chan = 0) = 0;
320 
321  /*!
322  * Get a RF frontend sensor value.
323  * \param name the name of the sensor
324  * \param chan the channel index 0 to N-1
325  * \return a sensor value object
326  */
327  virtual uhd::sensor_value_t get_sensor(const std::string &name, size_t chan = 0) = 0;
328 
329  /*!
330  * Get a list of possible RF frontend sensor names.
331  * \param chan the channel index 0 to N-1
332  * \return a vector of sensor names
333  */
334  virtual std::vector<std::string> get_sensor_names(size_t chan = 0) = 0;
335 
336  //! DEPRECATED use get_sensor
337  uhd::sensor_value_t get_dboard_sensor(const std::string &name, size_t chan = 0){
338  return this->get_sensor(name, chan);
339  }
340 
341  //! DEPRECATED use get_sensor_names
342  std::vector<std::string> get_dboard_sensor_names(size_t chan = 0){
343  return this->get_sensor_names(chan);
344  }
345 
346  /*!
347  * Get a motherboard sensor value.
348  * \param name the name of the sensor
349  * \param mboard the motherboard index 0 to M-1
350  * \return a sensor value object
351  */
352  virtual uhd::sensor_value_t get_mboard_sensor(const std::string &name, size_t mboard = 0) = 0;
353 
354  /*!
355  * Get a list of possible motherboard sensor names.
356  * \param mboard the motherboard index 0 to M-1
357  * \return a vector of sensor names
358  */
359  virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;
360 
361  /*!
362  * Set the clock configuration.
363  * DEPRECATED for set_time/clock_source.
364  * \param clock_config the new configuration
365  * \param mboard the motherboard index 0 to M-1
366  */
367  virtual void set_clock_config(const uhd::clock_config_t &clock_config, size_t mboard = 0) = 0;
368 
369  /*!
370  * Set the time source for the usrp device.
371  * This sets the method of time synchronization,
372  * typically a pulse per second or an encoded time.
373  * Typical options for source: external, MIMO.
374  * \param source a string representing the time source
375  * \param mboard which motherboard to set the config
376  */
377  virtual void set_time_source(const std::string &source, const size_t mboard = 0) = 0;
378 
379  /*!
380  * Get the currently set time source.
381  * \param mboard which motherboard to get the config
382  * \return the string representing the time source
383  */
384  virtual std::string get_time_source(const size_t mboard) = 0;
385 
386  /*!
387  * Get a list of possible time sources.
388  * \param mboard which motherboard to get the list
389  * \return a vector of strings for possible settings
390  */
391  virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;
392 
393  /*!
394  * Set the clock source for the usrp device.
395  * This sets the source for a 10 Mhz reference clock.
396  * Typical options for source: internal, external, MIMO.
397  * \param source a string representing the clock source
398  * \param mboard which motherboard to set the config
399  */
400  virtual void set_clock_source(const std::string &source, const size_t mboard = 0) = 0;
401 
402  /*!
403  * Get the currently set clock source.
404  * \param mboard which motherboard to get the config
405  * \return the string representing the clock source
406  */
407  virtual std::string get_clock_source(const size_t mboard) = 0;
408 
409  /*!
410  * Get a list of possible clock sources.
411  * \param mboard which motherboard to get the list
412  * \return a vector of strings for possible settings
413  */
414  virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;
415 
416  /*!
417  * Get the master clock rate.
418  * \param mboard the motherboard index 0 to M-1
419  * \return the clock rate in Hz
420  */
421  virtual double get_clock_rate(size_t mboard = 0) = 0;
422 
423  /*!
424  * Set the master clock rate.
425  * \param rate the new rate in Hz
426  * \param mboard the motherboard index 0 to M-1
427  */
428  virtual void set_clock_rate(double rate, size_t mboard = 0) = 0;
429 
430  /*!
431  * Get the current time registers.
432  * \param mboard the motherboard index 0 to M-1
433  * \return the current usrp time
434  */
435  virtual uhd::time_spec_t get_time_now(size_t mboard = 0) = 0;
436 
437  /*!
438  * Get the time when the last pps pulse occured.
439  * \param mboard the motherboard index 0 to M-1
440  * \return the current usrp time
441  */
442  virtual uhd::time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
443 
444  /*!
445  * Sets the time registers immediately.
446  * \param time_spec the new time
447  * \param mboard the motherboard index 0 to M-1
448  */
449  virtual void set_time_now(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
450 
451  /*!
452  * Set the time registers at the next pps.
453  * \param time_spec the new time
454  */
455  virtual void set_time_next_pps(const uhd::time_spec_t &time_spec) = 0;
456 
457  /*!
458  * Sync the time registers with an unknown pps edge.
459  * \param time_spec the new time
460  */
461  virtual void set_time_unknown_pps(const uhd::time_spec_t &time_spec) = 0;
462 
463  /*!
464  * Set the time at which the control commands will take effect.
465  *
466  * A timed command will back-pressure all subsequent timed commands,
467  * assuming that the subsequent commands occur within the time-window.
468  * If the time spec is late, the command will be activated upon arrival.
469  *
470  * \param time_spec the time at which the next command will activate
471  * \param mboard which motherboard to set the config
472  */
473  virtual void set_command_time(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
474 
475  /*!
476  * Clear the command time so future commands are sent ASAP.
477  *
478  * \param mboard which motherboard to set the config
479  */
480  virtual void clear_command_time(size_t mboard = 0) = 0;
481 
482  /*!
483  * Get access to the underlying uhd dboard iface object.
484  * \return the dboard_iface object
485  */
486  virtual uhd::usrp::dboard_iface::sptr get_dboard_iface(size_t chan = 0) = 0;
487 
488  /*!
489  * Get access to the underlying uhd device object.
490  * \return the multi usrp device object
491  */
492  virtual uhd::usrp::multi_usrp::sptr get_device(void) = 0;
493 
494  /*!
495  * Perform write on the user configuration register bus. These only exist if
496  * the user has implemented custom setting registers in the device FPGA.
497  * \param addr 8-bit register address
498  * \param data 32-bit register value
499  * \param mboard which motherboard to set the user register
500  */
501  virtual void set_user_register(const uint8_t addr, const uint32_t data, size_t mboard = 0) = 0;
502 
503  /*!
504  * Convenience function for finite data acquisition.
505  * This is not to be used with the scheduler; rather,
506  * one can request samples from the USRP in python.
507  * //TODO assumes fc32
508  * \param nsamps the number of samples
509  * \return a vector of complex float samples
510  */
511  virtual std::vector<std::complex<float> > finite_acquisition(const size_t nsamps) = 0;
512 
513  /*!
514  * Convenience function for finite data acquisition.
515  * This is the multi-channel version of finite_acquisition;
516  * This is not to be used with the scheduler; rather,
517  * one can request samples from the USRP in python.
518  * //TODO assumes fc32
519  * \param nsamps the number of samples per channel
520  * \return a vector of buffers, where each buffer represents a channel
521  */
522  virtual std::vector<std::vector<std::complex<float> > > finite_acquisition_v(const size_t nsamps) = 0;
523 };
524 
525 #endif /* INCLUDED_GR_UHD_USRP_SOURCE_H */