Tweak LIBUSB m4 script to not check for 'usb_debug' symbol on Windows, because the...
[debian/gnuradio] / gr-usrp / src / usrp_base.h
index 83aa699abf3bf162ca231b1bba8af5c7016c7453..7947723fba27dfe65085e01005f5857b408265a3 100644 (file)
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2004,2008 Free Software Foundation, Inc.
+ * Copyright 2004,2008,2009 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -24,8 +24,8 @@
 #include <gr_sync_block.h>
 #include <stdexcept>
 #include <boost/shared_ptr.hpp>
-#include <db_base.h>
-#include <usrp_subdev_spec.h>
+#include <usrp/db_base.h>
+#include <usrp/usrp_subdev_spec.h>
 
 class usrp_basic;
 
@@ -98,7 +98,16 @@ public:
   /*!
    * \brief return frequency of master oscillator on USRP
    */
-  long  fpga_master_clock_freq() const;
+  long fpga_master_clock_freq() const;
+
+  /*!
+   * Tell API that the master oscillator on the USRP is operating at a non-standard 
+   * fixed frequency. This is only needed for custom USRP hardware modified to 
+   * operate at a different frequency from the default factory configuration. This
+   * function must be called prior to any other API function.
+   * \param master_clock USRP2 FPGA master clock frequency in Hz (10..64 MHz)
+   */
+  void set_fpga_master_clock_freq (long master_clock);
 
   void set_verbose (bool on);
 
@@ -143,14 +152,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.