git.gag.com Git - debian/gnuradio/blob - usrp2/host/include/usrp2/usrp2.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008,2009 Free Software Foundation, Inc.
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef INCLUDED_USRP2_H
  20 #define INCLUDED_USRP2_H
  21
  22 #include <boost/shared_ptr.hpp>
  23 #include <boost/utility.hpp>
  24 #include <vector>
  25 #include <complex>
  26 #include <usrp2/rx_sample_handler.h>
  27 #include <usrp2/tune_result.h>
  28 #include <usrp2/mimo_config.h>
  29
  30 /*
  31  * N.B., The interfaces described here are still in flux.
  32  *
  33  * We will keep all the code in the tree up-to-date with regard to changes
  34  * here, but reserve the right to change this on a whim.
  35  */
  36
  37 namespace usrp2 {
  38
  39   /*!
  40    * Structure to hold properties of USRP2 hardware devices.
  41    *
  42    */
  43   struct props
  44   {
  45     std::string addr;
  46     uint16_t hw_rev;
  47     uint8_t fpga_md5sum[16];
  48     uint8_t sw_md5sum[16];
  49   };
  50
  51   typedef std::vector<props> props_vector_t;
  52
  53   /*!
  54    * \brief Search the ethernet for all USRP2s or for a specific USRP2.
  55    *
  56    * \param ifc is the name of the OS ethernet interface (e.g., "eth0")
  57    * \param mac_addr is the MAC address of the desired USRP2, or "" to search for all.
  58    * mac_addr must be either a zero length string, "", or must be of the form
  59    * "01:02:03:04:05:06" or "05:06".
  60    *
  61    * \returns a vector of properties, 1 entry for each matching USRP2 found.
  62    */
  63   props_vector_t find(const std::string &ifc, const std::string &mac_addr="");
  64
  65   class tune_result;
  66
  67   // FIXME: get from firmware include
  68   static const int GPIO_TX_BANK = 0;
  69   static const int GPIO_RX_BANK = 1;
  70
  71   /*!
  72    * \brief standard C++ interface to USRP2
  73    * \ingroup usrp2
  74    */
  75   class usrp2 : boost::noncopyable
  76   {
  77   public:
  78     static const unsigned int MAX_CHAN = 30;
  79
  80     /*!
  81      * Shared pointer to this class
  82      */
  83     typedef boost::shared_ptr<usrp2> sptr;
  84
  85     /*!
  86      * Static function to return an instance of usrp2 as a shared pointer
  87      *
  88      * \param ifc   Network interface name, e.g., "eth0"
  89      * \param addr  Network mac address, e.g., "01:23:45:67:89:ab", "89:ab" or "".
  90      *              If \p addr is HH:HH, it's treated as if it were 00:50:c2:85:HH:HH
  91      *              "" will autoselect a USRP2 if there is only a single one on the local ethernet.
  92      * \param rx_bufsize is the length in bytes of the kernel networking buffer to allocate.
  93      */
  94     static sptr make(const std::string &ifc, const std::string &addr="", size_t rx_bufsize=0);
  95
  96     /*!
  97      * Class destructor
  98      */
  99     ~usrp2();
 100
 101     /*!
 102      * Returns the MAC address associated with this USRP
 103      */
 104     std::string mac_addr();
 105
 106     /*!
 107      * Returns the GbE interface name associated with this USRP
 108      */
 109     std::string interface_name();
 110
 111     /*
 112      * ----------------------------------------------------------------
 113      * Rx configuration and control
 114      * ----------------------------------------------------------------
 115      */
 116
 117     /*!
 118      * Set receiver gain
 119      * \param gain in dB (more or less)
 120      */
 121     bool set_rx_gain(double gain);
 122
 123     //! return minimum Rx gain
 124     double rx_gain_min();
 125
 126     //! return maximum Rx gain
 127     double rx_gain_max();
 128
 129     //! return Rx gain db_per_step
 130     double rx_gain_db_per_step();
 131
 132     /*!
 133      * \brief Set receive daughterboard LO offset frequency
 134      */
 135     bool set_rx_lo_offset(double frequency);
 136
 137     /*!
 138      * Set receiver center frequency
 139      */
 140     bool set_rx_center_freq(double frequency, tune_result *result);
 141
 142     //! return minimum Rx center frequency
 143     double rx_freq_min();
 144
 145     //! return maximum Rx center frequency
 146     double rx_freq_max();
 147
 148     /*!
 149      * Set receiver sample rate decimation
 150      */
 151     bool set_rx_decim(int decimation_factor);
 152
 153     //! Return current decimation factor
 154     int rx_decim();
 155
 156     /*!
 157      * Set receiver IQ magnitude scaling
 158      */
 159     bool set_rx_scale_iq(int scale_i, int scale_q);
 160
 161     /*!
 162      * Set received sample format
 163      *
 164      *    domain: complex or real
 165      *      type: floating, fixed point, or raw
 166      *     depth: bits per sample
 167      *
 168      * Sets format over the wire for samples from USRP2.
 169      */
 170     // bool set_rx_format(...);
 171
 172     /*!
 173      * Start streaming receive mode.  USRP2 will send a continuous stream of
 174      * DSP pipeline samples to host.  Call rx_samples(...) to access.
 175      *
 176      * \param channel          Stream channel number (0-30)
 177      * \param items_per_frame  Number of 32-bit items per frame.
 178      */
 179     bool start_rx_streaming(unsigned int channel=0, unsigned int items_per_frame=0);
 180
 181     /*!
 182      * Stop streaming receive mode.
 183      */
 184     bool stop_rx_streaming(unsigned int channel=0);
 185
 186     /*!
 187      * \brief Receive data from the specified channel
 188      * This method is used to receive all data: streaming or discrete.
 189      */
 190     bool rx_samples(unsigned int channel, rx_sample_handler *handler);
 191
 192     /*!
 193      * Returns number of times receive overruns have occurred
 194      */
 195     unsigned int rx_overruns();
 196
 197     /*!
 198      * Returns total number of missing frames from overruns.
 199      */
 200     unsigned int rx_missing();
 201
 202     /*
 203      * ----------------------------------------------------------------
 204      * Tx configuration and control
 205      * ----------------------------------------------------------------
 206      */
 207
 208     /*!
 209      * Set transmitter gain
 210      */
 211     bool set_tx_gain(double gain);
 212
 213     //! return minimum Tx gain
 214     double tx_gain_min();
 215
 216     //! return maximum Tx gain
 217     double tx_gain_max();
 218
 219     //! return Tx gain db_per_step
 220     double tx_gain_db_per_step();
 221
 222     /*
 223      * \brief Set transmit daughterboard LO offset frequency
 224      */
 225     bool set_tx_lo_offset(double frequency);
 226
 227     /*!
 228      * Set transmitter center frequency
 229      */
 230     bool set_tx_center_freq(double frequency, tune_result *result);
 231
 232     //! return minimum Tx center frequency
 233     double tx_freq_min();
 234
 235     //! return maximum Tx center frequency
 236     double tx_freq_max();
 237
 238     /*!
 239      * Set transmitter sample rate interpolation
 240      */
 241     bool set_tx_interp(int interpolation_factor);
 242
 243     //! Return current interpolation factor
 244     int tx_interp();
 245
 246     /*
 247      * \brief Calculate default scale_iq for given interpolation rate
 248      */
 249     void default_tx_scale_iq(int interpolation_factor, int *scale_i, int *scale_q);
 250
 251     /*!
 252      * Set transmit IQ magnitude scaling
 253      */
 254     bool set_tx_scale_iq(int scale_i, int scale_q);
 255
 256     /*!
 257      * Set transmit sample format
 258      *
 259      *    domain: complex or real
 260      *      type: floating, fixed point, or raw
 261      *     depth: bits per sample
 262      *
 263      * Sets format over the wire for samples to USRP2.
 264      */
 265     // bool set_tx_format(...);
 266
 267     /*!
 268      * \brief transmit complex<float> samples to USRP2
 269      *
 270      * \param channel specifies the channel to send them to
 271      * \param samples are the samples to transmit.  They should be in the range [-1.0, +1.0]
 272      * \param nsamples is the number of samples to transmit
 273      * \param metadata provides the timestamp and flags
 274      *
 275      * The complex<float> samples are converted to the appropriate
 276      * "on the wire" representation, depending on the current USRP2
 277      * configuration.  Typically, this is big-endian 16-bit I & Q.
 278      */
 279     bool tx_32fc(unsigned int channel,
 280                  const std::complex<float> *samples,
 281                  size_t nsamples,
 282                  const tx_metadata *metadata);
 283
 284     /*!
 285      * \brief transmit complex<int16_t> samples to USRP2
 286      *
 287      * \param channel specifies the channel to send them to
 288      * \param samples are the samples to transmit
 289      * \param nsamples is the number of samples to transmit
 290      * \param metadata provides the timestamp and flags
 291      *
 292      * The complex<int16_t> samples are converted to the appropriate
 293      * "on the wire" representation, depending on the current USRP2
 294      * configuration.  Typically, this is big-endian 16-bit I & Q.
 295      */
 296     bool tx_16sc(unsigned int channel,
 297                  const std::complex<int16_t> *samples,
 298                  size_t nsamples,
 299                  const tx_metadata *metadata);
 300
 301     /*!
 302      * \brief transmit raw uint32_t data items to USRP2
 303      *
 304      * The caller is responsible for ensuring that the items are
 305      * formatted appropriately for the USRP2 and its configuration.
 306      * This method is used primarily by the system itself.  Users
 307      * should call tx_32fc or tx_16sc instead.
 308      *
 309      * \param channel specifies the channel to send them to
 310      * \param items are the data items to transmit
 311      * \param nitems is the number of items to transmit
 312      * \param metadata provides the timestamp and flags
 313      */
 314     bool tx_raw(unsigned int channel,
 315                 const uint32_t *items,
 316                 size_t nitems,
 317                 const tx_metadata *metadata);
 318
 319     /*
 320      * ----------------------------------------------------------------
 321      *  miscellaneous methods
 322      * ----------------------------------------------------------------
 323      */
 324
 325     /*!
 326      * \brief MIMO configuration
 327      *
 328      * \param flags from usrp2_mimo_config.h
 329      *
 330      * <pre>
 331      *   one of these:
 332      *
 333      *     MC_WE_DONT_LOCK
 334      *     MC_WE_LOCK_TO_SMA
 335      *     MC_WE_LOCK_TO_MIMO
 336      *
 337      *   and optionally this:
 338      *
 339      *     MC_PROVIDE_CLK_TO_MIMO
 340      * </pre>
 341      */
 342     bool config_mimo(int flags);
 343
 344
 345     //! Get frequency of master oscillator in Hz
 346     bool fpga_master_clock_freq(long *freq);
 347
 348     // Get Sampling rate of A/D converter in Hz
 349     bool adc_rate(long *rate);
 350
 351     // Get Sampling rate of D/A converter in Hz
 352     bool dac_rate(long *rate);
 353
 354     /*!
 355      * \brief Get Tx daughterboard ID
 356      *
 357      * \param[out] dbid returns the daughterboard id.
 358      *
 359      * daughterboard id >= 0 if successful, -1 if no daugherboard installed,
 360      * -2 if invalid EEPROM on daughterboard.
 361      */
 362     bool tx_daughterboard_id(int *dbid);
 363
 364     /*!
 365      * \brief Get Rx daughterboard ID
 366      *
 367      * \param[out] dbid returns the daughterboard id.
 368      *
 369      * daughterboard id >= 0 if successful, -1 if no daugherboard installed,
 370      * -2 if invalid EEPROM on daughterboard.
 371      */
 372     bool rx_daughterboard_id(int *dbid);
 373
 374     /*
 375      * ----------------------------------------------------------------
 376      *  Low level methods
 377      * ----------------------------------------------------------------
 378      */
 379
 380     /*!
 381      * Burn new mac address into EEPROM on USRP2
 382      *
 383      * \param new_addr  Network mac address, e.g., "01:23:45:67:89:ab" or "89:ab".
 384      *                  If \p addr is HH:HH, it's treated as if it were 00:50:c2:85:HH:HH
 385      */
 386     bool burn_mac_addr(const std::string &new_addr);
 387
 388     /*!
 389      * Reset master time to 0 at next PPS edge
 390      */
 391     bool sync_to_pps();
 392
 393     /*!
 394      * Reset master time to 0 at every PPS edge
 395      */
 396     bool sync_every_pps(bool enable);
 397
 398     /*!
 399      * Read memory from Wishbone bus as 32-bit words.  Handles endian swapping if needed.
 400      *
 401      * \param addr      32-bit aligned address.  Only the lower 16-bits are significant.
 402      * \param words     Number of 32-bit words
 403      *
 404      * \returns         Vector of 32-bit read values
 405      *
 406      * WARNING: Attempts to read memory from addresses that do not correspond to RAM or
 407      * memory-mapped peripherals may cause the USRP2 to hang, requiring a power cycle.
 408      *
 409      */
 410     std::vector<uint32_t> peek32(uint32_t addr, uint32_t words);
 411
 412     /*!
 413      * Write memory to Wishbone bus as 32-bit words.  Handles endian swapping if needed.
 414      *
 415      * \param addr      32-bit aligned address.  Only the lower 16-bits are significant
 416      * \param data      Vector of 32-bit values to write.
 417      *
 418      * \returns true iff successful
 419      *
 420      * WARNING: Attempts to read memory from addresses that do not correspond to RAM or
 421      * memory-mapped peripherals may cause the USRP2 to hang, requiring a power cycle.
 422      *
 423      */
 424     bool poke32(uint32_t addr, const std::vector<uint32_t> &data);
 425
 426     /*!
 427      * Set daughterboard GPIO data direction register.
 428      *
 429      * \param bank      GPIO_TX_BANK or GPIO_RX_BANK
 430      * \param value     16-bits, 0=FPGA input, 1=FPGA output
 431      * \param mask      16-bits, 0=ignore, 1=set
 432      *
 433      * \returns true iff successful
 434      *
 435      * WARNING: Improper usage of this function may result in damage to the USRP2
 436      *
 437      */
 438     bool set_gpio_ddr(int bank, uint16_t value, uint16_t mask);
 439
 440     /*!
 441      * Set daughterboard GPIO output selection register.  For those GPIO pins that
 442      * are configured as outputs in the DDR, this settings configures the source
 443      * of the pin value.
 444      *
 445      * \param bank      GPIO_TX_BANK or GPIO_RX_BANK
 446      * \param sels      Exactly 16 character MSB->LSB string. For each position:
 447      *                    '.' = ignore this bit, i.e., leave current value
 448      *                    'a' = Output ATR value
 449      *                    's' = Output host software controlled value
 450      *                    '0' = Output FPGA debug bus 0 value
 451      *                    '1' = Output FPGA debug bus 1 value
 452      *
 453      * \returns true iff successful
 454      *
 455      * WARNING: Improper usage of this function may result in damage to the USRP2
 456      *
 457      */
 458     bool set_gpio_sels(int bank, std::string sels);
 459
 460     /*!
 461      * Set daughterboard GPIO pin values.
 462      *
 463      * \param bank     GPIO_TX_BANK or GPIO_RX_BANK
 464      * \param value    16 bits, 0=low, 1=high
 465      * \param mask     16 bits, 0=ignore, 1=set
 466      *
 467      * \returns true iff successful
 468      *
 469      * WARNING: Improper usage of this function may result in damage to the USRP2
 470      *
 471      */
 472     bool write_gpio(int bank, uint16_t value, uint16_t mask);
 473
 474     /*!
 475      * Read daughterboard GPIO pin values
 476      *
 477      * \param bank     GPIO_TX_BANK or GPIO_RX_BANK
 478      * \param value    pointer to uint16_t to hold read results
 479      *
 480      * \returns true iff successful
 481      *
 482      */
 483     bool read_gpio(int bank, uint16_t *value);
 484
 485     /*!
 486      * Set GPIO streaming mode
 487      *
 488      * Individually enables streaming GPIO pins through LSBs of DSP
 489      * samples.
 490      *
 491      * On receive, io_rx[15] replaces I[0], io_rx[14] replaces Q[0]
 492      * On transmit, I[0] maps to io_tx[15], Q[0] maps to io_tx[14]
 493      * (Transmit streaming is not yet implemented.)
 494      *
 495      * The selected GPIO pins must have been set as inputs or outputs
 496      * and, for transmit, set to software control.
 497      *
 498      * When enabled, the replaced DSP sample LSBs become 0.
 499      *
 500      * \param bank     GPIO_TX_BANK or GPIO_RX_BANK
 501      * \param enable   enable[0] controls I channel LSB
 502      *                 enable[1] controls Q channel LSB
 503      *
 504      * \returns true iff successful
 505      *
 506      * WARNING: Improper usage of this function may result in damage to the USRP2
 507      *
 508      */
 509     bool enable_gpio_streaming(int bank, int enable);
 510
 511 #if 0   // not yet implemented
 512     /*!
 513      * \brief Write EEPROM on motherboard or any daughterboard.
 514      * \param i2c_addr          I2C bus address of EEPROM
 515      * \param eeprom_offset     byte offset in EEPROM to begin writing
 516      * \param buf               the data to write
 517      * \returns true iff sucessful
 518      */
 519     bool write_eeprom (int i2c_addr, int eeprom_offset, const std::string &buf);
 520
 521     /*!
 522      * \brief Read EEPROM on motherboard or any daughterboard.
 523      * \param i2c_addr          I2C bus address of EEPROM
 524      * \param eeprom_offset     byte offset in EEPROM to begin reading
 525      * \param len               number of bytes to read
 526      * \returns the data read if successful, else a zero length string.
 527      */
 528     std::string read_eeprom (int i2c_addr, int eeprom_offset, int len);
 529
 530     /*!
 531      * \brief Write to I2C peripheral
 532      * \param i2c_addr          I2C bus address (7-bits)
 533      * \param buf               the data to write
 534      * \returns true iff successful
 535      * Writes are limited to a maximum of of 64 bytes.
 536      */
 537     bool write_i2c (int i2c_addr, const std::string &buf);
 538
 539     /*!
 540      * \brief Read from I2C peripheral
 541      * \param i2c_addr          I2C bus address (7-bits)
 542      * \param len               number of bytes to read
 543      * \returns the data read if successful, else a zero length string.
 544      * Reads are limited to a maximum of 64 bytes.
 545      */
 546     std::string read_i2c (int i2c_addr, int len);
 547
 548     /*!
 549      * \brief Write data to SPI bus peripheral.
 550      *
 551      * \param optional_header   0,1 or 2 bytes to write before buf.
 552      * \param enables           bitmask of peripherals to write. See usrp_spi_defs.h
 553      * \param format            transaction format.  See usrp_spi_defs.h SPI_FMT_*
 554      * \param buf               the data to write
 555      * \returns true iff successful
 556      * Writes are limited to a maximum of 64 bytes.
 557      *
 558      * If \p format specifies that optional_header bytes are present, they are
 559      * written to the peripheral immediately prior to writing \p buf.
 560      */
 561     bool write_spi (int optional_header, int enables, int format, const std::string &buf);
 562
 563     /*
 564      * \brief Read data from SPI bus peripheral.
 565      *
 566      * \param optional_header   0,1 or 2 bytes to write before buf.
 567      * \param enables           bitmask of peripheral to read. See usrp_spi_defs.h
 568      * \param format            transaction format.  See usrp_spi_defs.h SPI_FMT_*
 569      * \param len               number of bytes to read.  Must be in [0,64].
 570      * \returns the data read if sucessful, else a zero length string.
 571      *
 572      * Reads are limited to a maximum of 64 bytes.
 573      *
 574      * If \p format specifies that optional_header bytes are present, they
 575      * are written to the peripheral first.  Then \p len bytes are read from
 576      * the peripheral and returned.
 577      */
 578     std::string read_spi (int optional_header, int enables, int format, int len);
 579 #endif
 580
 581
 582     class impl;         // implementation details
 583
 584   private:
 585     // Static function to retrieve or create usrp2 instance
 586     static sptr find_existing_or_make_new(const std::string &ifc, props *p, size_t rx_bufsize);
 587
 588     // Only class members can instantiate this class
 589     usrp2(const std::string &ifc, props *p, size_t rx_bufsize);
 590
 591     // All private state is held in opaque pointer
 592     std::auto_ptr<impl> d_impl;
 593   };
 594
 595 };
 596
 597 std::ostream& operator<<(std::ostream &os, const usrp2::props &x);
 598
 599
 600 #endif /* INCLUDED_USRP2_H */