GNU Radio 3.6.5.1 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  * *Advanced use only:*
133  * Issue a stream command to all channels in this source block.
134  *
135  * This method is intended to override the default "always on" behavior.
136  * After starting the flow graph, the user should call stop() on this block,
137  * then issue any desired arbitrary stream_cmd_t structs to the device.
138  * The USRP will be able to enqueue several stream commands in the FPGA.
139  *
140  * \param cmd the stream command to issue to all source channels
141  */
142  virtual void issue_stream_cmd(const uhd::stream_cmd_t &cmd) = 0;
143 
144  /*!
145  * Returns identifying information about this USRP's configuration.
146  * Returns motherboard ID, name, and serial.
147  * Returns daughterboard RX ID, subdev name and spec, serial, and antenna.
148  * \param chan channel index 0 to N-1
149  * \return RX info
150  */
151  virtual uhd::dict<std::string, std::string> get_usrp_info(size_t chan = 0) = 0;
152 
153  /*!
154  * Set the frontend specification.
155  * \param spec the subdev spec markup string
156  * \param mboard the motherboard index 0 to M-1
157  */
158  virtual void set_subdev_spec(const std::string &spec, size_t mboard = 0) = 0;
159 
160  /*!
161  * Get the RX frontend specification.
162  * \param mboard the motherboard index 0 to M-1
163  * \return the frontend specification in use
164  */
165  virtual std::string get_subdev_spec(size_t mboard = 0) = 0;
166 
167  /*!
168  * Set the sample rate for the usrp device.
169  * \param rate a new rate in Sps
170  */
171  virtual void set_samp_rate(double rate) = 0;
172 
173  /*!
174  * Get the sample rate for the usrp device.
175  * This is the actual sample rate and may differ from the rate set.
176  * \return the actual rate in Sps
177  */
178  virtual double get_samp_rate(void) = 0;
179 
180  /*!
181  * Get the possible sample rates for the usrp device.
182  * \return a range of rates in Sps
183  */
184  virtual uhd::meta_range_t get_samp_rates(void) = 0;
185 
186  /*!
187  * Tune the usrp device to the desired center frequency.
188  * \param tune_request the tune request instructions
189  * \param chan the channel index 0 to N-1
190  * \return a tune result with the actual frequencies
191  */
192  virtual uhd::tune_result_t set_center_freq(
193  const uhd::tune_request_t tune_request, size_t chan = 0
194  ) = 0;
195 
196  /*!
197  * Tune the usrp device to the desired center frequency.
198  * This is a wrapper around set center freq so that in this case,
199  * the user can pass a single frequency in the call through swig.
200  * \param freq the desired frequency in Hz
201  * \param chan the channel index 0 to N-1
202  * \return a tune result with the actual frequencies
203  */
204  uhd::tune_result_t set_center_freq(double freq, size_t chan = 0){
205  return set_center_freq(uhd::tune_request_t(freq), chan);
206  }
207 
208  /*!
209  * Get the center frequency.
210  * \param chan the channel index 0 to N-1
211  * \return the frequency in Hz
212  */
213  virtual double get_center_freq(size_t chan = 0) = 0;
214 
215  /*!
216  * Get the tunable frequency range.
217  * \param chan the channel index 0 to N-1
218  * \return the frequency range in Hz
219  */
220  virtual uhd::freq_range_t get_freq_range(size_t chan = 0) = 0;
221 
222  /*!
223  * Set the gain for the dboard.
224  * \param gain the gain in dB
225  * \param chan the channel index 0 to N-1
226  */
227  virtual void set_gain(double gain, size_t chan = 0) = 0;
228 
229  /*!
230  * Set the named gain on the dboard.
231  * \param gain the gain in dB
232  * \param name the name of the gain stage
233  * \param chan the channel index 0 to N-1
234  */
235  virtual void set_gain(double gain, const std::string &name, size_t chan = 0) = 0;
236 
237  /*!
238  * Get the actual dboard gain setting.
239  * \param chan the channel index 0 to N-1
240  * \return the actual gain in dB
241  */
242  virtual double get_gain(size_t chan = 0) = 0;
243 
244  /*!
245  * Get the actual dboard gain setting of named stage.
246  * \param name the name of the gain stage
247  * \param chan the channel index 0 to N-1
248  * \return the actual gain in dB
249  */
250  virtual double get_gain(const std::string &name, size_t chan = 0) = 0;
251 
252  /*!
253  * Get the actual dboard gain setting of named stage.
254  * \param chan the channel index 0 to N-1
255  * \return the actual gain in dB
256  */
257  virtual std::vector<std::string> get_gain_names(size_t chan = 0) = 0;
258 
259  /*!
260  * Get the settable gain range.
261  * \param chan the channel index 0 to N-1
262  * \return the gain range in dB
263  */
264  virtual uhd::gain_range_t get_gain_range(size_t chan = 0) = 0;
265 
266  /*!
267  * Get the settable gain range.
268  * \param name the name of the gain stage
269  * \param chan the channel index 0 to N-1
270  * \return the gain range in dB
271  */
272  virtual uhd::gain_range_t get_gain_range(const std::string &name, size_t chan = 0) = 0;
273 
274  /*!
275  * Set the antenna to use.
276  * \param ant the antenna string
277  * \param chan the channel index 0 to N-1
278  */
279  virtual void set_antenna(const std::string &ant, size_t chan = 0) = 0;
280 
281  /*!
282  * Get the antenna in use.
283  * \param chan the channel index 0 to N-1
284  * \return the antenna string
285  */
286  virtual std::string get_antenna(size_t chan = 0) = 0;
287 
288  /*!
289  * Get a list of possible antennas.
290  * \param chan the channel index 0 to N-1
291  * \return a vector of antenna strings
292  */
293  virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
294 
295  /*!
296  * Set the bandpass filter on the RF frontend.
297  * \param bandwidth the filter bandwidth in Hz
298  * \param chan the channel index 0 to N-1
299  */
300  virtual void set_bandwidth(double bandwidth, size_t chan = 0) = 0;
301 
302  /*!
303  * Get the bandpass filter setting on the RF frontend.
304  * \param chan the channel index 0 to N-1
305  * \return bandwidth of the filter in Hz
306  */
307  virtual double get_bandwidth(size_t chan = 0) = 0;
308 
309  /*!
310  * Get the bandpass filter range of the RF frontend.
311  * \param chan the channel index 0 to N-1
312  * \return the range of the filter bandwidth in Hz
313  */
314  virtual uhd::freq_range_t get_bandwidth_range(size_t chan = 0) = 0;
315 
316  /*!
317  * Enable/disable the automatic DC offset correction.
318  * The automatic correction subtracts out the long-run average.
319  *
320  * When disabled, the averaging option operation is halted.
321  * Once halted, the average value will be held constant
322  * until the user re-enables the automatic correction
323  * or overrides the value by manually setting the offset.
324  *
325  * \param enb true to enable automatic DC offset correction
326  * \param chan the channel index 0 to N-1
327  */
328  virtual void set_auto_dc_offset(const bool enb, size_t chan = 0) = 0;
329 
330  /*!
331  * Set a constant DC offset value.
332  * The value is complex to control both I and Q.
333  * Only set this when automatic correction is disabled.
334  * \param offset the dc offset (1.0 is full-scale)
335  * \param chan the channel index 0 to N-1
336  */
337  virtual void set_dc_offset(const std::complex<double> &offset, size_t chan = 0) = 0;
338 
339  /*!
340  * Set the RX frontend IQ imbalance correction.
341  * Use this to adjust the magnitude and phase of I and Q.
342  *
343  * \param correction the complex correction value
344  * \param chan the channel index 0 to N-1
345  */
346  virtual void set_iq_balance(const std::complex<double> &correction, size_t chan = 0) = 0;
347 
348  /*!
349  * Get a RF frontend sensor value.
350  * \param name the name of the sensor
351  * \param chan the channel index 0 to N-1
352  * \return a sensor value object
353  */
354  virtual uhd::sensor_value_t get_sensor(const std::string &name, size_t chan = 0) = 0;
355 
356  /*!
357  * Get a list of possible RF frontend sensor names.
358  * \param chan the channel index 0 to N-1
359  * \return a vector of sensor names
360  */
361  virtual std::vector<std::string> get_sensor_names(size_t chan = 0) = 0;
362 
363  //! DEPRECATED use get_sensor
364  uhd::sensor_value_t get_dboard_sensor(const std::string &name, size_t chan = 0){
365  return this->get_sensor(name, chan);
366  }
367 
368  //! DEPRECATED use get_sensor_names
369  std::vector<std::string> get_dboard_sensor_names(size_t chan = 0){
370  return this->get_sensor_names(chan);
371  }
372 
373  /*!
374  * Get a motherboard sensor value.
375  * \param name the name of the sensor
376  * \param mboard the motherboard index 0 to M-1
377  * \return a sensor value object
378  */
379  virtual uhd::sensor_value_t get_mboard_sensor(const std::string &name, size_t mboard = 0) = 0;
380 
381  /*!
382  * Get a list of possible motherboard sensor names.
383  * \param mboard the motherboard index 0 to M-1
384  * \return a vector of sensor names
385  */
386  virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;
387 
388  /*!
389  * Set the clock configuration.
390  * DEPRECATED for set_time/clock_source.
391  * \param clock_config the new configuration
392  * \param mboard the motherboard index 0 to M-1
393  */
394  virtual void set_clock_config(const uhd::clock_config_t &clock_config, size_t mboard = 0) = 0;
395 
396  /*!
397  * Set the time source for the usrp device.
398  * This sets the method of time synchronization,
399  * typically a pulse per second or an encoded time.
400  * Typical options for source: external, MIMO.
401  * \param source a string representing the time source
402  * \param mboard which motherboard to set the config
403  */
404  virtual void set_time_source(const std::string &source, const size_t mboard = 0) = 0;
405 
406  /*!
407  * Get the currently set time source.
408  * \param mboard which motherboard to get the config
409  * \return the string representing the time source
410  */
411  virtual std::string get_time_source(const size_t mboard) = 0;
412 
413  /*!
414  * Get a list of possible time sources.
415  * \param mboard which motherboard to get the list
416  * \return a vector of strings for possible settings
417  */
418  virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;
419 
420  /*!
421  * Set the clock source for the usrp device.
422  * This sets the source for a 10 Mhz reference clock.
423  * Typical options for source: internal, external, MIMO.
424  * \param source a string representing the clock source
425  * \param mboard which motherboard to set the config
426  */
427  virtual void set_clock_source(const std::string &source, const size_t mboard = 0) = 0;
428 
429  /*!
430  * Get the currently set clock source.
431  * \param mboard which motherboard to get the config
432  * \return the string representing the clock source
433  */
434  virtual std::string get_clock_source(const size_t mboard) = 0;
435 
436  /*!
437  * Get a list of possible clock sources.
438  * \param mboard which motherboard to get the list
439  * \return a vector of strings for possible settings
440  */
441  virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;
442 
443  /*!
444  * Get the master clock rate.
445  * \param mboard the motherboard index 0 to M-1
446  * \return the clock rate in Hz
447  */
448  virtual double get_clock_rate(size_t mboard = 0) = 0;
449 
450  /*!
451  * Set the master clock rate.
452  * \param rate the new rate in Hz
453  * \param mboard the motherboard index 0 to M-1
454  */
455  virtual void set_clock_rate(double rate, size_t mboard = 0) = 0;
456 
457  /*!
458  * Get the current time registers.
459  * \param mboard the motherboard index 0 to M-1
460  * \return the current usrp time
461  */
462  virtual uhd::time_spec_t get_time_now(size_t mboard = 0) = 0;
463 
464  /*!
465  * Get the time when the last pps pulse occured.
466  * \param mboard the motherboard index 0 to M-1
467  * \return the current usrp time
468  */
469  virtual uhd::time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
470 
471  /*!
472  * Sets the time registers immediately.
473  * \param time_spec the new time
474  * \param mboard the motherboard index 0 to M-1
475  */
476  virtual void set_time_now(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
477 
478  /*!
479  * Set the time registers at the next pps.
480  * \param time_spec the new time
481  */
482  virtual void set_time_next_pps(const uhd::time_spec_t &time_spec) = 0;
483 
484  /*!
485  * Sync the time registers with an unknown pps edge.
486  * \param time_spec the new time
487  */
488  virtual void set_time_unknown_pps(const uhd::time_spec_t &time_spec) = 0;
489 
490  /*!
491  * Set the time at which the control commands will take effect.
492  *
493  * A timed command will back-pressure all subsequent timed commands,
494  * assuming that the subsequent commands occur within the time-window.
495  * If the time spec is late, the command will be activated upon arrival.
496  *
497  * \param time_spec the time at which the next command will activate
498  * \param mboard which motherboard to set the config
499  */
500  virtual void set_command_time(const uhd::time_spec_t &time_spec, size_t mboard = 0) = 0;
501 
502  /*!
503  * Clear the command time so future commands are sent ASAP.
504  *
505  * \param mboard which motherboard to set the config
506  */
507  virtual void clear_command_time(size_t mboard = 0) = 0;
508 
509  /*!
510  * Get access to the underlying uhd dboard iface object.
511  * \return the dboard_iface object
512  */
513  virtual uhd::usrp::dboard_iface::sptr get_dboard_iface(size_t chan = 0) = 0;
514 
515  /*!
516  * Get access to the underlying uhd device object.
517  * \return the multi usrp device object
518  */
519  virtual uhd::usrp::multi_usrp::sptr get_device(void) = 0;
520 
521  /*!
522  * Perform write on the user configuration register bus. These only exist if
523  * the user has implemented custom setting registers in the device FPGA.
524  * \param addr 8-bit register address
525  * \param data 32-bit register value
526  * \param mboard which motherboard to set the user register
527  */
528  virtual void set_user_register(const uint8_t addr, const uint32_t data, size_t mboard = 0) = 0;
529 
530  /*!
531  * Convenience function for finite data acquisition.
532  * This is not to be used with the scheduler; rather,
533  * one can request samples from the USRP in python.
534  * //TODO assumes fc32
535  * \param nsamps the number of samples
536  * \return a vector of complex float samples
537  */
538  virtual std::vector<std::complex<float> > finite_acquisition(const size_t nsamps) = 0;
539 
540  /*!
541  * Convenience function for finite data acquisition.
542  * This is the multi-channel version of finite_acquisition;
543  * This is not to be used with the scheduler; rather,
544  * one can request samples from the USRP in python.
545  * //TODO assumes fc32
546  * \param nsamps the number of samples per channel
547  * \return a vector of buffers, where each buffer represents a channel
548  */
549  virtual std::vector<std::vector<std::complex<float> > > finite_acquisition_v(const size_t nsamps) = 0;
550 };
551 
552 #endif /* INCLUDED_GR_UHD_USRP_SOURCE_H */