usrp_lib.cpp 35.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */

knopp's avatar
knopp committed
22 23
/** usrp_lib.cpp
 *
24
 * \author: HongliangXU : hong-liang-xu@agilent.com
knopp's avatar
knopp committed
25 26 27 28 29 30 31 32
 */

#include <string.h>
#include <pthread.h>
#include <unistd.h>
#include <stdio.h>
#include <uhd/utils/thread_priority.hpp>
#include <uhd/usrp/multi_usrp.hpp>
33
#include <uhd/version.hpp>
knopp's avatar
knopp committed
34 35
#include <boost/lexical_cast.hpp>
#include <boost/algorithm/string.hpp>
Florian Kaltenberger's avatar
Florian Kaltenberger committed
36 37
#include <boost/thread.hpp>
#include <boost/format.hpp>
knopp's avatar
knopp committed
38 39 40 41
#include <iostream>
#include <complex>
#include <fstream>
#include <cmath>
42
#include <time.h>
43
#include "UTIL/LOG/log_extern.h"
knopp's avatar
knopp committed
44
#include "common_lib.h"
laurent's avatar
laurent committed
45 46
#include "assertions.h"

47 48 49
#ifdef __SSE4_1__
#  include <smmintrin.h>
#endif
laurent's avatar
laurent committed
50

51 52 53
#ifdef __AVX2__
#  include <immintrin.h>
#endif
54

55 56 57 58
#ifdef __arm__
#  include <arm_neon.h>
#endif

59 60 61 62
/** @addtogroup _USRP_PHY_RF_INTERFACE_
 * @{
 */

laurent's avatar
laurent committed
63 64
/*! \brief USRP Configuration */
typedef struct {
knopp's avatar
knopp committed
65

laurent's avatar
laurent committed
66 67 68 69 70
    // --------------------------------
    // variables for USRP configuration
    // --------------------------------
    //! USRP device pointer
    uhd::usrp::multi_usrp::sptr usrp;
laurent's avatar
laurent committed
71 72 73 74 75 76 77 78 79 80 81

    //create a send streamer and a receive streamer
    //! USRP TX Stream
    uhd::tx_streamer::sptr tx_stream;
    //! USRP RX Stream
    uhd::rx_streamer::sptr rx_stream;

    //! USRP TX Metadata
    uhd::tx_metadata_t tx_md;
    //! USRP RX Metadata
    uhd::rx_metadata_t rx_md;
knopp's avatar
knopp committed
82

laurent's avatar
laurent committed
83 84
    //! Sampling rate
    double sample_rate;
knopp's avatar
knopp committed
85

laurent's avatar
laurent committed
86 87
    //! TX forward samples. We use usrp_time_offset to get this value
    int tx_forward_nsamps; //166 for 20Mhz
88

laurent's avatar
laurent committed
89 90 91 92 93 94 95 96
    // --------------------------------
    // Debug and output control
    // --------------------------------
    int num_underflows;
    int num_overflows;
    int num_seq_errors;
    int64_t tx_count;
    int64_t rx_count;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
97 98
    int wait_for_first_pps;
    int use_gps;
laurent's avatar
laurent committed
99 100
    //! timestamp of RX packet
    openair0_timestamp rx_timestamp;
knopp's avatar
knopp committed
101

laurent's avatar
laurent committed
102
} usrp_state_t;
knopp's avatar
knopp committed
103

Florian Kaltenberger's avatar
Florian Kaltenberger committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
//void print_notes(void)
//{
    // Helpful notes
  //  std::cout << boost::format("**************************************Helpful Notes on Clock/PPS Selection**************************************\n");
  //  std::cout << boost::format("As you can see, the default 10 MHz Reference and 1 PPS signals are now from the GPSDO.\n");
  //  std::cout << boost::format("If you would like to use the internal reference(TCXO) in other applications, you must configure that explicitly.\n");
  //  std::cout << boost::format("You can no longer select the external SMAs for 10 MHz or 1 PPS signaling.\n");
  //  std::cout << boost::format("****************************************************************************************************************\n");
//}

static int sync_to_gps(openair0_device *device)
{
    uhd::set_thread_priority_safe();

    //std::string args;

    //Set up program options
    //po::options_description desc("Allowed options");
    //desc.add_options()
    //("help", "help message")
    //("args", po::value<std::string>(&args)->default_value(""), "USRP device arguments")
    //;
    //po::variables_map vm;
    //po::store(po::parse_command_line(argc, argv, desc), vm);
    //po::notify(vm);

    //Print the help message
    //if (vm.count("help"))
    //{
      //  std::cout << boost::format("Synchronize USRP to GPS %s") % desc << std::endl;
      // return EXIT_FAILURE;
    //}

    //Create a USRP device
    //std::cout << boost::format("\nCreating the USRP device with: %s...\n") % args;
    //uhd::usrp::multi_usrp::sptr usrp = uhd::usrp::multi_usrp::make(args);
    //std::cout << boost::format("Using Device: %s\n") % usrp->get_pp_string();
 
    usrp_state_t *s = (usrp_state_t*)device->priv;    

    try
    {
        size_t num_mboards = s->usrp->get_num_mboards();
        size_t num_gps_locked = 0;
        for (size_t mboard = 0; mboard < num_mboards; mboard++)
        {
            std::cout << "Synchronizing mboard " << mboard << ": " << s->usrp->get_mboard_name(mboard) << std::endl;

            //Set references to GPSDO
            s->usrp->set_clock_source("gpsdo", mboard);
            s->usrp->set_time_source("gpsdo", mboard);

            //std::cout << std::endl;
            //print_notes();
            //std::cout << std::endl;

            //Check for 10 MHz lock
            std::vector<std::string> sensor_names = s->usrp->get_mboard_sensor_names(mboard);
            if(std::find(sensor_names.begin(), sensor_names.end(), "ref_locked") != sensor_names.end())
            {
                std::cout << "Waiting for reference lock..." << std::flush;
                bool ref_locked = false;
                for (int i = 0; i < 30 and not ref_locked; i++)
                {
                    ref_locked = s->usrp->get_mboard_sensor("ref_locked", mboard).to_bool();
                    if (not ref_locked)
                    {
                        std::cout << "." << std::flush;
                        boost::this_thread::sleep(boost::posix_time::seconds(1));
                    }
                }
                if(ref_locked)
                {
                    std::cout << "LOCKED" << std::endl;
                } else {
                    std::cout << "FAILED" << std::endl;
                    std::cout << "Failed to lock to GPSDO 10 MHz Reference. Exiting." << std::endl;
                    exit(EXIT_FAILURE);
                }
            }
            else
            {
                std::cout << boost::format("ref_locked sensor not present on this board.\n");
            }

            //Wait for GPS lock
            bool gps_locked = s->usrp->get_mboard_sensor("gps_locked", mboard).to_bool();
            if(gps_locked)
            {
                num_gps_locked++;
                std::cout << boost::format("GPS Locked\n");
            }
            else
            {
                std::cerr << "WARNING:  GPS not locked - time will not be accurate until locked" << std::endl;
            }
knopp's avatar
knopp committed
200

Florian Kaltenberger's avatar
Florian Kaltenberger committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
            //Set to GPS time
            uhd::time_spec_t gps_time = uhd::time_spec_t(time_t(s->usrp->get_mboard_sensor("gps_time", mboard).to_int()));
            //s->usrp->set_time_next_pps(gps_time+1.0, mboard);
            s->usrp->set_time_next_pps(uhd::time_spec_t(0.0));

            //Wait for it to apply
            //The wait is 2 seconds because N-Series has a known issue where
            //the time at the last PPS does not properly update at the PPS edge
            //when the time is actually set.
            boost::this_thread::sleep(boost::posix_time::seconds(2));

            //Check times
            gps_time = uhd::time_spec_t(time_t(s->usrp->get_mboard_sensor("gps_time", mboard).to_int()));
            uhd::time_spec_t time_last_pps = s->usrp->get_time_last_pps(mboard);
            std::cout << "USRP time: " << (boost::format("%0.9f") % time_last_pps.get_real_secs()) << std::endl;
            std::cout << "GPSDO time: " << (boost::format("%0.9f") % gps_time.get_real_secs()) << std::endl;
            //if (gps_time.get_real_secs() == time_last_pps.get_real_secs())
            //    std::cout << std::endl << "SUCCESS: USRP time synchronized to GPS time" << std::endl << std::endl;
            //else
            //    std::cerr << std::endl << "ERROR: Failed to synchronize USRP time to GPS time" << std::endl << std::endl;
        }

        if (num_gps_locked == num_mboards and num_mboards > 1)
        {
            //Check to see if all USRP times are aligned
            //First, wait for PPS.
            uhd::time_spec_t time_last_pps = s->usrp->get_time_last_pps();
            while (time_last_pps == s->usrp->get_time_last_pps())
            {
                boost::this_thread::sleep(boost::posix_time::milliseconds(1));
            }

            //Sleep a little to make sure all devices have seen a PPS edge
            boost::this_thread::sleep(boost::posix_time::milliseconds(200));

            //Compare times across all mboards
            bool all_matched = true;
            uhd::time_spec_t mboard0_time = s->usrp->get_time_last_pps(0);
            for (size_t mboard = 1; mboard < num_mboards; mboard++)
            {
                uhd::time_spec_t mboard_time = s->usrp->get_time_last_pps(mboard);
                if (mboard_time != mboard0_time)
                {
                    all_matched = false;
                    std::cerr << (boost::format("ERROR: Times are not aligned: USRP 0=%0.9f, USRP %d=%0.9f")
                                  % mboard0_time.get_real_secs()
                                  % mboard
                                  % mboard_time.get_real_secs()) << std::endl;
                }
            }
            if (all_matched)
            {
                std::cout << "SUCCESS: USRP times aligned" << std::endl << std::endl;
            } else {
                std::cout << "ERROR: USRP times are not aligned" << std::endl << std::endl;
            }
        }
    }
    catch (std::exception& e)
    {
        std::cout << boost::format("\nError: %s") % e.what();
        std::cout << boost::format("This could mean that you have not installed the GPSDO correctly.\n\n");
        std::cout << boost::format("Visit one of these pages if the problem persists:\n");
        std::cout << boost::format(" * N2X0/E1X0: http://files.ettus.com/manual/page_gpsdo.html");
        std::cout << boost::format(" * X3X0: http://files.ettus.com/manual/page_gpsdo_x3x0.html\n\n");
        std::cout << boost::format(" * E3X0: http://files.ettus.com/manual/page_usrp_e3x0.html#e3x0_hw_gps\n\n");
        exit(EXIT_FAILURE);
    }

    return EXIT_SUCCESS;
}
knopp's avatar
knopp committed
272

273 274 275
/*! \brief Called to start the USRP transceiver. Return 0 if OK, < 0 if error
    @param device pointer to the device structure specific to the RF hardware target
*/
laurent's avatar
laurent committed
276
static int trx_usrp_start(openair0_device *device) {
knopp's avatar
knopp committed
277

laurent's avatar
laurent committed
278
    usrp_state_t *s = (usrp_state_t*)device->priv;
knopp's avatar
knopp committed
279

280 281 282 283 284 285 286 287 288 289 290

  // setup GPIO for TDD, GPIO(4) = ATR_RX
  //set data direction register (DDR) to output
    s->usrp->set_gpio_attr("FP0", "DDR", 0x1f, 0x1f);
  
  //set control register to ATR
    s->usrp->set_gpio_attr("FP0", "CTRL", 0x1f,0x1f);
  
  //set ATR register
    s->usrp->set_gpio_attr("FP0", "ATR_RX", 1<<4, 0x1f);

laurent's avatar
laurent committed
291 292
    // init recv and send streaming
    uhd::stream_cmd_t cmd(uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
Florian Kaltenberger's avatar
Florian Kaltenberger committed
293 294 295 296 297
    // should be s->usrp->get_time_next_pps(&cmd.time_spec); 
    //cmd.time_spec = s->usrp->get_time_now() + uhd::time_spec_t(0.05);
    LOG_I(PHY,"Time in secs now: %llu \n", s->usrp->get_time_now().to_ticks(s->sample_rate));
    LOG_I(PHY,"Time in secs last pps: %llu \n", s->usrp->get_time_last_pps().to_ticks(s->sample_rate));
    cmd.time_spec = s->usrp->get_time_last_pps() + uhd::time_spec_t(1.0);    
laurent's avatar
laurent committed
298
    cmd.stream_now = false; // start at constant delay
laurent's avatar
laurent committed
299
    s->rx_stream->issue_stream_cmd(cmd);
knopp's avatar
knopp committed
300

Florian Kaltenberger's avatar
Florian Kaltenberger committed
301 302 303
    if (s->use_gps == 1) s->wait_for_first_pps = 1;
    else s->wait_for_first_pps = 0; 

laurent's avatar
laurent committed
304 305 306 307
    s->tx_md.time_spec = cmd.time_spec + uhd::time_spec_t(1-(double)s->tx_forward_nsamps/s->sample_rate);
    s->tx_md.has_time_spec = true;
    s->tx_md.start_of_burst = true;
    s->tx_md.end_of_burst = false;
knopp's avatar
knopp committed
308

laurent's avatar
laurent committed
309 310 311 312
    s->rx_count = 0;
    s->tx_count = 0;
    s->rx_timestamp = 0;
    return 0;
knopp's avatar
knopp committed
313
}
laurent's avatar
laurent committed
314
/*! \brief Terminate operation of the USRP transceiver -- free all associated resources
315 316
 * \param device the hardware to use
 */
laurent's avatar
laurent committed
317 318
static void trx_usrp_end(openair0_device *device) {
    usrp_state_t *s = (usrp_state_t*)device->priv;
knopp's avatar
knopp committed
319

laurent's avatar
laurent committed
320 321 322 323 324
    s->rx_stream->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);
    //send a mini EOB packet
    s->tx_md.end_of_burst = true;
    s->tx_stream->send("", 0, s->tx_md);
    s->tx_md.end_of_burst = false;
knopp's avatar
knopp committed
325 326

}
327

328 329
/*! \brief Called to send samples to the USRP RF target
      @param device pointer to the device structure specific to the RF hardware target
laurent's avatar
laurent committed
330
      @param timestamp The timestamp at whicch the first sample MUST be sent
331 332 333 334
      @param buff Buffer which holds the samples
      @param nsamps number of samples to be sent
      @param antenna_id index of the antenna if the device has multiple anteannas
      @param flags flags must be set to TRUE if timestamp parameter needs to be applied
laurent's avatar
laurent committed
335 336 337 338
*/
static int trx_usrp_write(openair0_device *device, openair0_timestamp timestamp, void **buff, int nsamps, int cc, int flags) {
    int ret=0;
    usrp_state_t *s = (usrp_state_t*)device->priv;
knopp's avatar
knopp committed
339

laurent's avatar
laurent committed
340 341
    s->tx_md.time_spec = uhd::time_spec_t::from_ticks(timestamp, s->sample_rate);
    s->tx_md.has_time_spec = flags;
knopp's avatar
knopp committed
342

343

laurent's avatar
laurent committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
    if(flags>0)
        s->tx_md.has_time_spec = true;
    else
        s->tx_md.has_time_spec = false;

    if (flags == 2) { // start of burst
        s->tx_md.start_of_burst = true;
        s->tx_md.end_of_burst = false;
    } else if (flags == 3) { // end of burst
        s->tx_md.start_of_burst = false;
        s->tx_md.end_of_burst = true;
    } else if (flags == 4) { // start and end
        s->tx_md.start_of_burst = true;
        s->tx_md.end_of_burst = true;
    } else if (flags==1) { // middle of burst
        s->tx_md.start_of_burst = false;
        s->tx_md.end_of_burst = false;
    }

    if (cc>1) {
        std::vector<void *> buff_ptrs;
laurent's avatar
laurent committed
365 366
        for (int i=0; i<cc; i++)
            buff_ptrs.push_back(buff[i]);
laurent's avatar
laurent committed
367
        ret = (int)s->tx_stream->send(buff_ptrs, nsamps, s->tx_md,1e-3);
laurent's avatar
laurent committed
368
    } else
laurent's avatar
laurent committed
369
        ret = (int)s->tx_stream->send(buff[0], nsamps, s->tx_md,1e-3);
370 371


372

laurent's avatar
laurent committed
373 374
    if (ret != nsamps)
        LOG_E(PHY,"[xmit] tx samples %d != %d\n",ret,nsamps);
375

laurent's avatar
laurent committed
376
    return ret;
knopp's avatar
knopp committed
377 378
}

379 380 381 382 383 384 385 386 387 388 389
/*! \brief Receive samples from hardware.
 * Read \ref nsamps samples from each channel to buffers. buff[0] is the array for
 * the first channel. *ptimestamp is the time at which the first sample
 * was received.
 * \param device the hardware to use
 * \param[out] ptimestamp the time at which the first sample was received.
 * \param[out] buff An array of pointers to buffers for received samples. The buffers must be large enough to hold the number of samples \ref nsamps.
 * \param nsamps Number of samples. One sample is 2 byte I + 2 byte Q => 4 byte.
 * \param antenna_id Index of antenna for which to receive samples
 * \returns the number of sample read
*/
laurent's avatar
laurent committed
390 391 392 393
static int trx_usrp_read(openair0_device *device, openair0_timestamp *ptimestamp, void **buff, int nsamps, int cc) {
    usrp_state_t *s = (usrp_state_t*)device->priv;
    int samples_received=0,i,j;
    int nsamps2;  // aligned to upper 32 or 16 byte boundary
394 395
#if defined(__x86_64) || defined(__i386__)
#ifdef __AVX2__
laurent's avatar
laurent committed
396 397
    nsamps2 = (nsamps+7)>>3;
    __m256i buff_tmp[2][nsamps2];
398
#else
laurent's avatar
laurent committed
399 400
    nsamps2 = (nsamps+3)>>2;
    __m128i buff_tmp[2][nsamps2];
401 402
#endif
#elif defined(__arm__)
laurent's avatar
laurent committed
403 404
    nsamps2 = (nsamps+3)>>2;
    int16x8_t buff_tmp[2][nsamps2];
405 406
#endif

laurent's avatar
laurent committed
407 408 409 410 411 412 413 414 415 416 417 418
    if (device->type == USRP_B200_DEV) {
        if (cc>1) {
            // receive multiple channels (e.g. RF A and RF B)
            std::vector<void *> buff_ptrs;
            for (int i=0; i<cc; i++) buff_ptrs.push_back(buff_tmp[i]);
            samples_received = s->rx_stream->recv(buff_ptrs, nsamps, s->rx_md);
        } else {
            // receive a single channel (e.g. from connector RF A)
            samples_received=0;
            while (samples_received != nsamps) {
                samples_received += s->rx_stream->recv(buff_tmp[0]+samples_received,
                                                       nsamps-samples_received, s->rx_md);
Florian Kaltenberger's avatar
Florian Kaltenberger committed
419
                if  ((s->wait_for_first_pps == 0) && (s->rx_md.error_code!=uhd::rx_metadata_t::ERROR_CODE_NONE))
laurent's avatar
laurent committed
420
                    break;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
421
	        if ((s->wait_for_first_pps == 1) && (samples_received != nsamps)) { printf("sleep...\n");} //usleep(100); 
laurent's avatar
laurent committed
422
            }
Florian Kaltenberger's avatar
Florian Kaltenberger committed
423
	    if (samples_received == nsamps) s->wait_for_first_pps=0;
laurent's avatar
laurent committed
424 425 426 427
        }
        // bring RX data into 12 LSBs for softmodem RX
        for (int i=0; i<cc; i++) {
            for (int j=0; j<nsamps2; j++) {
428 429
#if defined(__x86_64__) || defined(__i386__)
#ifdef __AVX2__
laurent's avatar
laurent committed
430
                ((__m256i *)buff[i])[j] = _mm256_srai_epi16(buff_tmp[i][j],4);
431
#else
laurent's avatar
laurent committed
432
                ((__m128i *)buff[i])[j] = _mm_srai_epi16(buff_tmp[i][j],4);
433 434
#endif
#elif defined(__arm__)
laurent's avatar
laurent committed
435
                ((int16x8_t*)buff[i])[j] = vshrq_n_s16(buff_tmp[i][j],4);
436
#endif
laurent's avatar
laurent committed
437 438 439 440 441 442 443 444 445 446 447 448 449
            }
        }
    } else if (device->type == USRP_X300_DEV) {
        if (cc>1) {
            // receive multiple channels (e.g. RF A and RF B)
            std::vector<void *> buff_ptrs;

            for (int i=0; i<cc; i++) buff_ptrs.push_back(buff[i]);
            samples_received = s->rx_stream->recv(buff_ptrs, nsamps, s->rx_md);
        } else {
            // receive a single channel (e.g. from connector RF A)
            samples_received = s->rx_stream->recv(buff[0], nsamps, s->rx_md);
        }
450
    }
laurent's avatar
laurent committed
451 452
    if (samples_received < nsamps)
        LOG_E(PHY,"[recv] received %d samples out of %d\n",samples_received,nsamps);
453

laurent's avatar
laurent committed
454
    if ( s->rx_md.error_code != uhd::rx_metadata_t::ERROR_CODE_NONE)
Cedric Roux's avatar
Cedric Roux committed
455
        LOG_E(PHY, "%s\n", s->rx_md.to_pp_string(true).c_str());
456

laurent's avatar
laurent committed
457 458 459 460
    s->rx_count += nsamps;
    s->rx_timestamp = s->rx_md.time_spec.to_ticks(s->sample_rate);
    *ptimestamp = s->rx_timestamp;
    return samples_received;
knopp's avatar
knopp committed
461 462
}

463 464 465 466
/*! \brief Compares two variables within precision
 * \param a first variable
 * \param b second variable
*/
laurent's avatar
laurent committed
467
static bool is_equal(double a, double b) {
laurent's avatar
laurent committed
468
    return std::fabs(a-b) < std::numeric_limits<double>::epsilon();
knopp's avatar
knopp committed
469
}
knopp's avatar
knopp committed
470

471
void *freq_thread(void *arg) {
laurent's avatar
laurent committed
472 473 474 475 476 477

    openair0_device *device=(openair0_device *)arg;
    usrp_state_t *s = (usrp_state_t*)device->priv;

    s->usrp->set_tx_freq(device->openair0_cfg[0].tx_freq[0]);
    s->usrp->set_rx_freq(device->openair0_cfg[0].rx_freq[0]);
478 479
}
/*! \brief Set frequencies (TX/RX). Spawns a thread to handle the frequency change to not block the calling thread
480 481 482
 * \param device the hardware to use
 * \param openair0_cfg RF frontend parameters set by application
 * \param dummy dummy variable not used
laurent's avatar
laurent committed
483
 * \returns 0 in success
484
 */
485
int trx_usrp_set_freq(openair0_device* device, openair0_config_t *openair0_cfg, int dont_block) {
knopp's avatar
knopp committed
486

laurent's avatar
laurent committed
487 488
    usrp_state_t *s = (usrp_state_t*)device->priv;
    pthread_t f_thread;
knopp's avatar
knopp committed
489

laurent's avatar
laurent committed
490
    printf("Setting USRP TX Freq %f, RX Freq %f\n",openair0_cfg[0].tx_freq[0],openair0_cfg[0].rx_freq[0]);
491

laurent's avatar
laurent committed
492 493 494 495 496 497 498
    // spawn a thread to handle the frequency change to not block the calling thread
    if (dont_block == 1)
        pthread_create(&f_thread,NULL,freq_thread,(void*)device);
    else {
        s->usrp->set_tx_freq(device->openair0_cfg[0].tx_freq[0]);
        s->usrp->set_rx_freq(device->openair0_cfg[0].rx_freq[0]);
    }
laurent's avatar
laurent committed
499

laurent's avatar
laurent committed
500
    return(0);
knopp's avatar
knopp committed
501 502 503

}

laurent's avatar
laurent committed
504
/*! \brief Set RX frequencies
505 506
 * \param device the hardware to use
 * \param openair0_cfg RF frontend parameters set by application
laurent's avatar
laurent committed
507
 * \returns 0 in success
508
 */
knopp's avatar
knopp committed
509 510
int openair0_set_rx_frequencies(openair0_device* device, openair0_config_t *openair0_cfg) {

laurent's avatar
laurent committed
511 512 513
    usrp_state_t *s = (usrp_state_t*)device->priv;
    static int first_call=1;
    static double rf_freq,diff;
knopp's avatar
knopp committed
514

laurent's avatar
laurent committed
515
    uhd::tune_request_t rx_tune_req(openair0_cfg[0].rx_freq[0]);
knopp's avatar
knopp committed
516

laurent's avatar
laurent committed
517 518 519 520 521 522
    rx_tune_req.rf_freq_policy = uhd::tune_request_t::POLICY_MANUAL;
    rx_tune_req.rf_freq = openair0_cfg[0].rx_freq[0];
    rf_freq=openair0_cfg[0].rx_freq[0];
    s->usrp->set_rx_freq(rx_tune_req);

    return(0);
knopp's avatar
knopp committed
523 524 525

}

526 527 528
/*! \brief Set Gains (TX/RX)
 * \param device the hardware to use
 * \param openair0_cfg RF frontend parameters set by application
laurent's avatar
laurent committed
529
 * \returns 0 in success
530
 */
laurent's avatar
laurent committed
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
int trx_usrp_set_gains(openair0_device* device,
                       openair0_config_t *openair0_cfg) {

    usrp_state_t *s = (usrp_state_t*)device->priv;

    s->usrp->set_tx_gain(openair0_cfg[0].tx_gain[0]);
    ::uhd::gain_range_t gain_range = s->usrp->get_rx_gain_range(0);
    // limit to maximum gain
    if (openair0_cfg[0].rx_gain[0]-openair0_cfg[0].rx_gain_offset[0] > gain_range.stop()) {
        LOG_E(PHY,"RX Gain 0 too high, reduce by %f dB\n",
              openair0_cfg[0].rx_gain[0]-openair0_cfg[0].rx_gain_offset[0] - gain_range.stop());
        exit(-1);
    }
    s->usrp->set_rx_gain(openair0_cfg[0].rx_gain[0]-openair0_cfg[0].rx_gain_offset[0]);
    LOG_I(PHY,"Setting USRP RX gain to %f (rx_gain %f,gain_range.stop() %f)\n",
          openair0_cfg[0].rx_gain[0]-openair0_cfg[0].rx_gain_offset[0],
          openair0_cfg[0].rx_gain[0],gain_range.stop());
548

laurent's avatar
laurent committed
549
    return(0);
knopp's avatar
knopp committed
550
}
551

552 553 554
/*! \brief Stop USRP
 * \param card refers to the hardware index to use
 */
555
int trx_usrp_stop(openair0_device* device) {
laurent's avatar
laurent committed
556
    return(0);
557
}
558

559
/*! \brief USRPB210 RX calibration table */
560
rx_gain_calib_table_t calib_table_b210[] = {
laurent's avatar
laurent committed
561 562 563 564 565 566 567
    {3500000000.0,44.0},
    {2660000000.0,49.0},
    {2300000000.0,50.0},
    {1880000000.0,53.0},
    {816000000.0,58.0},
    {-1,0}
};
568

569
/*! \brief USRPB210 RX calibration table */
570
rx_gain_calib_table_t calib_table_b210_38[] = {
laurent's avatar
laurent committed
571 572 573 574 575 576 577
    {3500000000.0,44.0},
    {2660000000.0,49.8},
    {2300000000.0,51.0},
    {1880000000.0,53.0},
    {816000000.0,57.0},
    {-1,0}
};
578

579
/*! \brief USRPx310 RX calibration table */
580
rx_gain_calib_table_t calib_table_x310[] = {
laurent's avatar
laurent committed
581 582 583 584 585 586 587 588 589
    {3500000000.0,77.0},
    {2660000000.0,81.0},
    {2300000000.0,81.0},
    {1880000000.0,82.0},
    {816000000.0,85.0},
    {-1,0}
};

/*! \brief Set RX gain offset
590 591
 * \param openair0_cfg RF frontend parameters set by application
 * \param chain_index RF chain to apply settings to
laurent's avatar
laurent committed
592
 * \returns 0 in success
593
 */
594
void set_rx_gain_offset(openair0_config_t *openair0_cfg, int chain_index,int bw_gain_adjust) {
595

laurent's avatar
laurent committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
    int i=0;
    // loop through calibration table to find best adjustment factor for RX frequency
    double min_diff = 6e9,diff,gain_adj=0.0;
    if (bw_gain_adjust==1) {
        switch ((int)openair0_cfg[0].sample_rate) {
        case 30720000:
            break;
        case 23040000:
            gain_adj=1.25;
            break;
        case 15360000:
            gain_adj=3.0;
            break;
        case 7680000:
            gain_adj=6.0;
            break;
        case 3840000:
            gain_adj=9.0;
            break;
        case 1920000:
            gain_adj=12.0;
            break;
        default:
            LOG_E(PHY,"unknown sampling rate %d\n",(int)openair0_cfg[0].sample_rate);
            exit(-1);
            break;
        }
623
    }
laurent's avatar
laurent committed
624 625 626 627 628
    while (openair0_cfg->rx_gain_calib_table[i].freq>0) {
        diff = fabs(openair0_cfg->rx_freq[chain_index] - openair0_cfg->rx_gain_calib_table[i].freq);
        LOG_I(PHY,"cal %d: freq %f, offset %f, diff %f\n",
              i,
              openair0_cfg->rx_gain_calib_table[i].freq,
laurent's avatar
laurent committed
629 630 631 632 633 634
              openair0_cfg->rx_gain_calib_table[i].offset,diff);
        if (min_diff > diff) {
            min_diff = diff;
            openair0_cfg->rx_gain_offset[chain_index] = openair0_cfg->rx_gain_calib_table[i].offset+gain_adj;
        }
        i++;
laurent's avatar
laurent committed
635
    }
636 637
}

laurent's avatar
laurent committed
638
/*! \brief print the USRP statistics
639 640 641
* \param device the hardware to use
* \returns  0 on success
*/
642
int trx_usrp_get_stats(openair0_device* device) {
laurent's avatar
laurent committed
643
    return(0);
644
}
645

laurent's avatar
laurent committed
646 647 648 649
/*! \brief Reset the USRP statistics
 * \param device the hardware to use
 * \returns  0 on success
 */
650
int trx_usrp_reset_stats(openair0_device* device) {
laurent's avatar
laurent committed
651
    return(0);
652
}
653

654
extern "C" {
laurent's avatar
laurent committed
655 656 657 658 659
    /*! \brief Initialize Openair USRP target. It returns 0 if OK
    * \param device the hardware to use
         * \param openair0_cfg RF frontend parameters set by application
         */
    int device_init(openair0_device* device, openair0_config_t *openair0_cfg) {
660
        uhd::set_thread_priority_safe(1.0);
laurent's avatar
laurent committed
661
        usrp_state_t *s = (usrp_state_t*)calloc(sizeof(usrp_state_t),1);
Florian Kaltenberger's avatar
Florian Kaltenberger committed
662 663
        
        s->use_gps =1;
laurent's avatar
laurent committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
        // Initialize USRP device
        device->openair0_cfg = openair0_cfg;

        std::string args = "type=b200";
        uhd::device_addrs_t device_adds = uhd::device::find(args);

        int vers=0,subvers=0,subsubvers=0;
        int bw_gain_adjust=0;

        sscanf(uhd::get_version_string().c_str(),"%d.%d.%d",&vers,&subvers,&subsubvers);
        LOG_I(PHY,"Checking for USRPs : UHD %s (%d.%d.%d)\n",
              uhd::get_version_string().c_str(),vers,subvers,subsubvers);

        if(device_adds.size() == 0)  {
            double usrp_master_clock = 184.32e6;
            std::string args = "type=x300";
680

laurent's avatar
laurent committed
681 682 683
            // workaround for an api problem, master clock has to be set with the constructor not via set_master_clock_rate
            args += boost::str(boost::format(",master_clock_rate=%f") % usrp_master_clock);

knopp's avatar
knopp committed
684
//    args += ",num_send_frames=256,num_recv_frames=256, send_frame_size=4096, recv_frame_size=4096";
laurent's avatar
laurent committed
685

Thomas Laurent's avatar
Thomas Laurent committed
686 687
            //    args += ",num_send_frames=256,num_recv_frames=256, send_frame_size=4096, recv_frame_size=4096";
            uhd::device_addrs_t device_adds = uhd::device::find(args);
688

Thomas Laurent's avatar
Thomas Laurent committed
689 690 691 692 693 694 695 696
            if(device_adds.size() == 0) {
                std::cerr<<"No USRP Device Found. " << std::endl;
                free(s);
                return -1;
            }
            LOG_I(PHY,"Found USRP X300\n");
            s->usrp = uhd::usrp::multi_usrp::make(args);
            // lock mboard clocks
laurent's avatar
laurent committed
697 698 699 700
            if (openair0_cfg[0].clock_source == internal)
                s->usrp->set_clock_source("internal");
            else
                s->usrp->set_clock_source("external");
701

Thomas Laurent's avatar
Thomas Laurent committed
702 703
            //Setting device type to USRP X300/X310
            device->type=USRP_X300_DEV;
704

Thomas Laurent's avatar
Thomas Laurent committed
705 706 707 708 709 710 711 712
            // this is not working yet, master clock has to be set via constructor
            // set master clock rate and sample rate for tx & rx for streaming
            //s->usrp->set_master_clock_rate(usrp_master_clock);

            openair0_cfg[0].rx_gain_calib_table = calib_table_x310;

            switch ((int)openair0_cfg[0].sample_rate) {
            case 30720000:
laurent's avatar
laurent committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
                // from usrp_time_offset
                //openair0_cfg[0].samples_per_packet    = 2048;
                openair0_cfg[0].tx_sample_advance     = 15;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            case 15360000:
                //openair0_cfg[0].samples_per_packet    = 2048;
                openair0_cfg[0].tx_sample_advance     = 45;
                openair0_cfg[0].tx_bw                 = 10e6;
                openair0_cfg[0].rx_bw                 = 10e6;
                break;
            case 7680000:
                //openair0_cfg[0].samples_per_packet    = 2048;
                openair0_cfg[0].tx_sample_advance     = 50;
                openair0_cfg[0].tx_bw                 = 5e6;
                openair0_cfg[0].rx_bw                 = 5e6;
                break;
            case 1920000:
                //openair0_cfg[0].samples_per_packet    = 2048;
                openair0_cfg[0].tx_sample_advance     = 50;
                openair0_cfg[0].tx_bw                 = 1.25e6;
                openair0_cfg[0].rx_bw                 = 1.25e6;
Thomas Laurent's avatar
Thomas Laurent committed
736 737 738 739 740 741
                break;
            default:
                LOG_E(PHY,"Error: unknown sampling rate %f\n",openair0_cfg[0].sample_rate);
                exit(-1);
                break;
            }
742

Thomas Laurent's avatar
Thomas Laurent committed
743 744 745 746
        } else {
            LOG_I(PHY,"Found USRP B200\n");
            args += ",num_send_frames=256,num_recv_frames=256, send_frame_size=15360, recv_frame_size=15360" ;
            s->usrp = uhd::usrp::multi_usrp::make(args);
747

laurent's avatar
laurent committed
748 749 750 751 752 753 754 755 756
            //  s->usrp->set_rx_subdev_spec(rx_subdev);
            //  s->usrp->set_tx_subdev_spec(tx_subdev);

            // do not explicitly set the clock to "internal", because this will disable the gpsdo
            //    // lock mboard clocks
            //    s->usrp->set_clock_source("internal");
            // set master clock rate and sample rate for tx & rx for streaming

            // lock mboard clocks
Florian Kaltenberger's avatar
Florian Kaltenberger committed
757 758 759 760
            if (openair0_cfg[0].clock_source == internal){
                //s->usrp->set_clock_source("internal");
            }
            else{
laurent's avatar
laurent committed
761
                s->usrp->set_clock_source("external");
Florian Kaltenberger's avatar
Florian Kaltenberger committed
762 763
		s->usrp->set_time_source("external");
            }	
764

Thomas Laurent's avatar
Thomas Laurent committed
765 766 767 768 769 770 771 772
            device->type = USRP_B200_DEV;
            if ((vers == 3) && (subvers == 9) && (subsubvers>=2)) {
                openair0_cfg[0].rx_gain_calib_table = calib_table_b210;
                bw_gain_adjust=0;
            } else {
                openair0_cfg[0].rx_gain_calib_table = calib_table_b210_38;
                bw_gain_adjust=1;
            }
773

laurent's avatar
laurent committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
            switch ((int)openair0_cfg[0].sample_rate) {
            case 30720000:
                s->usrp->set_master_clock_rate(30.72e6);
                //openair0_cfg[0].samples_per_packet    = 1024;
                openair0_cfg[0].tx_sample_advance     = 115;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            case 23040000:
                s->usrp->set_master_clock_rate(23.04e6); //to be checked
                //openair0_cfg[0].samples_per_packet    = 1024;
                openair0_cfg[0].tx_sample_advance     = 113;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            case 15360000:
                s->usrp->set_master_clock_rate(30.72e06);
                //openair0_cfg[0].samples_per_packet    = 1024;
                openair0_cfg[0].tx_sample_advance     = 103;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            case 7680000:
                s->usrp->set_master_clock_rate(30.72e6);
                //openair0_cfg[0].samples_per_packet    = 1024;
                openair0_cfg[0].tx_sample_advance     = 80;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            case 1920000:
                s->usrp->set_master_clock_rate(30.72e6);
                //openair0_cfg[0].samples_per_packet    = 1024;
                openair0_cfg[0].tx_sample_advance     = 40;
                openair0_cfg[0].tx_bw                 = 20e6;
                openair0_cfg[0].rx_bw                 = 20e6;
                break;
            default:
laurent's avatar
laurent committed
811 812 813 814 815
                LOG_E(PHY,"Error: unknown sampling rate %f\n",openair0_cfg[0].sample_rate);
                exit(-1);
                break;
            }
        }
Thomas Laurent's avatar
Thomas Laurent committed
816

laurent's avatar
laurent committed
817 818 819
        /* device specific */
        //openair0_cfg[0].txlaunch_wait = 1;//manage when TX processing is triggered
        //openair0_cfg[0].txlaunch_wait_slotcount = 1; //manage when TX processing is triggered
laurent's avatar
laurent committed
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
        openair0_cfg[0].iq_txshift = 4;//shift
        openair0_cfg[0].iq_rxrescale = 15;//rescale iqs

        for(int i=0; i<s->usrp->get_rx_num_channels(); i++) {
            if (i<openair0_cfg[0].rx_num_channels) {
                s->usrp->set_rx_rate(openair0_cfg[0].sample_rate,i);
                s->usrp->set_rx_freq(openair0_cfg[0].rx_freq[i],i);
                set_rx_gain_offset(&openair0_cfg[0],i,bw_gain_adjust);

                ::uhd::gain_range_t gain_range = s->usrp->get_rx_gain_range(i);
                // limit to maximum gain
                AssertFatal( openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i] <= gain_range.stop(),
                             "RX Gain too high, lower by %f dB\n",
                             openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i] - gain_range.stop());
                s->usrp->set_rx_gain(openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i],i);
                LOG_I(PHY,"RX Gain %d %f (%f) => %f (max %f)\n",i,
                      openair0_cfg[0].rx_gain[i],openair0_cfg[0].rx_gain_offset[i],
                      openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i],gain_range.stop());
            }
        }
        for(int i=0; i<s->usrp->get_tx_num_channels(); i++) {
            if (i<openair0_cfg[0].tx_num_channels) {
                s->usrp->set_tx_rate(openair0_cfg[0].sample_rate,i);
                s->usrp->set_tx_freq(openair0_cfg[0].tx_freq[i],i);
                s->usrp->set_tx_gain(openair0_cfg[0].tx_gain[i],i);
            }
        }

        //s->usrp->set_clock_source("external");
        //s->usrp->set_time_source("external");

        // display USRP settings
        LOG_I(PHY,"Actual master clock: %fMHz...\n",s->usrp->get_master_clock_rate()/1e6);
laurent's avatar
laurent committed
853
        sleep(1);
laurent's avatar
laurent committed
854 855 856 857

        // create tx & rx streamer
        uhd::stream_args_t stream_args_rx("sc16", "sc16");
        int samples=openair0_cfg[0].sample_rate;
858 859 860 861 862
	int max=s->usrp->get_rx_stream(stream_args_rx)->get_max_num_samps();
        samples/=10000;
	LOG_I(PHY,"RF board max packet size %u, size for 100µs jitter %d \n", max, samples);
	if ( samples < max )
	  stream_args_rx.args["spp"] = str(boost::format("%d") % samples );
Cedric Roux's avatar
Cedric Roux committed
863
	LOG_I(PHY,"rx_max_num_samps %zu\n",
864 865
	      s->usrp->get_rx_stream(stream_args_rx)->get_max_num_samps());

laurent's avatar
laurent committed
866 867 868
        for (int i = 0; i<openair0_cfg[0].rx_num_channels; i++)
            stream_args_rx.channels.push_back(i);
        s->rx_stream = s->usrp->get_rx_stream(stream_args_rx);
869
	
laurent's avatar
laurent committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
        uhd::stream_args_t stream_args_tx("sc16", "sc16");
        for (int i = 0; i<openair0_cfg[0].tx_num_channels; i++)
            stream_args_tx.channels.push_back(i);
        s->tx_stream = s->usrp->get_tx_stream(stream_args_tx);

        /* Setting TX/RX BW after streamers are created due to USRP calibration issue */
        for(int i=0; i<s->usrp->get_tx_num_channels() && i<openair0_cfg[0].tx_num_channels; i++)
            s->usrp->set_tx_bandwidth(openair0_cfg[0].tx_bw,i);

        for(int i=0; i<s->usrp->get_rx_num_channels() && i<openair0_cfg[0].rx_num_channels; i++)
            s->usrp->set_rx_bandwidth(openair0_cfg[0].rx_bw,i);

        for (int i=0; i<openair0_cfg[0].rx_num_channels; i++) {
            LOG_I(PHY,"RX Channel %d\n",i);
            LOG_I(PHY,"  Actual RX sample rate: %fMSps...\n",s->usrp->get_rx_rate(i)/1e6);
            LOG_I(PHY,"  Actual RX frequency: %fGHz...\n", s->usrp->get_rx_freq(i)/1e9);
            LOG_I(PHY,"  Actual RX gain: %f...\n", s->usrp->get_rx_gain(i));
            LOG_I(PHY,"  Actual RX bandwidth: %fM...\n", s->usrp->get_rx_bandwidth(i)/1e6);
            LOG_I(PHY,"  Actual RX antenna: %s...\n", s->usrp->get_rx_antenna(i).c_str());
        }

        for (int i=0; i<openair0_cfg[0].tx_num_channels; i++) {
            LOG_I(PHY,"TX Channel %d\n",i);
            LOG_I(PHY,"  Actual TX sample rate: %fMSps...\n", s->usrp->get_tx_rate(i)/1e6);
            LOG_I(PHY,"  Actual TX frequency: %fGHz...\n", s->usrp->get_tx_freq(i)/1e9);
            LOG_I(PHY,"  Actual TX gain: %f...\n", s->usrp->get_tx_gain(i));
            LOG_I(PHY,"  Actual TX bandwidth: %fM...\n", s->usrp->get_tx_bandwidth(i)/1e6);
            LOG_I(PHY,"  Actual TX antenna: %s...\n", s->usrp->get_tx_antenna(i).c_str());
        }

        LOG_I(PHY,"Device timestamp: %f...\n", s->usrp->get_time_now().get_real_secs());

        device->priv = s;
        device->trx_start_func = trx_usrp_start;
        device->trx_write_func = trx_usrp_write;
        device->trx_read_func  = trx_usrp_read;
laurent's avatar
laurent committed
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
        device->trx_get_stats_func = trx_usrp_get_stats;
        device->trx_reset_stats_func = trx_usrp_reset_stats;
        device->trx_end_func   = trx_usrp_end;
        device->trx_stop_func  = trx_usrp_stop;
        device->trx_set_freq_func = trx_usrp_set_freq;
        device->trx_set_gains_func   = trx_usrp_set_gains;
        device->openair0_cfg = openair0_cfg;

        s->sample_rate = openair0_cfg[0].sample_rate;
        // TODO:
        // init tx_forward_nsamps based usrp_time_offset ex
        if(is_equal(s->sample_rate, (double)30.72e6))
            s->tx_forward_nsamps  = 176;
        if(is_equal(s->sample_rate, (double)15.36e6))
            s->tx_forward_nsamps = 90;
        if(is_equal(s->sample_rate, (double)7.68e6))
            s->tx_forward_nsamps = 50;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
923 924 925 926 927 928 929 930

        if (s->use_gps == 1) {
	   if (sync_to_gps(device)) {
		 LOG_I(PHY,"USRP fails to sync with GPS...\n");
            exit(0);   
           } 
        }
 
laurent's avatar
laurent committed
931 932
        return 0;
    }
knopp's avatar
knopp committed
933
}
934
/*@}*/