usrp_lib.cpp 14.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*******************************************************************************
    OpenAirInterface 
    Copyright(c) 1999 - 2014 Eurecom

    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.


    OpenAirInterface is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenAirInterface.The full GNU General Public License is 
    included in this distribution in the file called "COPYING". If not, 
    see <http://www.gnu.org/licenses/>.

   Contact Information
   OpenAirInterface Admin: openair_admin@eurecom.fr
   OpenAirInterface Tech : openair_tech@eurecom.fr
   OpenAirInterface Dev  : openair4g-devel@eurecom.fr
  
ghaddab's avatar
ghaddab committed
26
   Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
27 28

 *******************************************************************************/
knopp's avatar
 
knopp committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

/** usrp_lib.cpp
 *
 * Author: HongliangXU : hong-liang-xu@agilent.com
 */

#include <string.h>
#include <pthread.h>
#include <unistd.h>
#include <stdio.h>
#include <uhd/utils/thread_priority.hpp>
#include <uhd/usrp/multi_usrp.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/algorithm/string.hpp>
#include <iostream>
#include <complex>
#include <fstream>
#include <cmath>
47

knopp's avatar
 
knopp committed
48
#include "common_lib.h"
knopp's avatar
 
knopp committed
49

50

knopp's avatar
 
knopp committed
51 52 53 54 55 56 57 58
typedef struct
{

  // --------------------------------
  // variables for USRP configuration
  // --------------------------------
  uhd::usrp::multi_usrp::sptr usrp;
  //uhd::usrp::multi_usrp::sptr rx_usrp;
59
  
knopp's avatar
 
knopp committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
  //create a send streamer and a receive streamer
  uhd::tx_streamer::sptr tx_stream;
  uhd::rx_streamer::sptr rx_stream;

  uhd::tx_metadata_t tx_md;
  uhd::rx_metadata_t rx_md;

  uhd::time_spec_t tm_spec;
  //setup variables and allocate buffer
  uhd::async_metadata_t async_md;

  double sample_rate;
  // time offset between transmiter timestamp and receiver timestamp;
  double tdiff;
  // use usrp_time_offset to get this value
  int tx_forward_nsamps; //166 for 20Mhz


  // --------------------------------
  // Debug and output control
  // --------------------------------
  int num_underflows;
  int num_overflows;
  int num_seq_errors;

  int64_t tx_count;
  int64_t rx_count;
  openair0_timestamp rx_timestamp;

} usrp_state_t;


static int trx_usrp_start(openair0_device *device)
{
  usrp_state_t *s = (usrp_state_t*)device->priv;

  // init recv and send streaming
  uhd::stream_cmd_t cmd(uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
knopp's avatar
 
knopp committed
98
  cmd.time_spec = s->usrp->get_time_now() + uhd::time_spec_t(0.05);
knopp's avatar
 
knopp committed
99 100 101
  cmd.stream_now = false; // start at constant delay
  s->rx_stream->issue_stream_cmd(cmd);

knopp's avatar
 
knopp committed
102
  s->tx_md.time_spec = cmd.time_spec + uhd::time_spec_t(1-(double)s->tx_forward_nsamps/s->sample_rate);
knopp's avatar
 
knopp committed
103 104 105 106 107 108 109 110
  s->tx_md.has_time_spec = true;
  s->tx_md.start_of_burst = true;
  s->tx_md.end_of_burst = false;


  s->rx_count = 0;
  s->tx_count = 0;
  s->rx_timestamp = 0;
111 112

  return 0;
knopp's avatar
 
knopp committed
113 114 115 116 117 118 119 120
}

static void trx_usrp_end(openair0_device *device)
{
  usrp_state_t *s = (usrp_state_t*)device->priv;

  s->rx_stream->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);

navid's avatar
navid committed
121 122 123 124 125
  //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
126
}
127

128
static int trx_usrp_write(openair0_device *device, openair0_timestamp timestamp, void **buff, int nsamps, int cc, int flags)
knopp's avatar
 
knopp committed
129 130 131 132 133 134 135
{
  usrp_state_t *s = (usrp_state_t*)device->priv;
  s->tx_md.time_spec = uhd::time_spec_t::from_ticks(timestamp, s->sample_rate);
  if(flags)
    s->tx_md.has_time_spec = true;
  else
    s->tx_md.has_time_spec = false;
knopp's avatar
knopp committed
136 137 138 139 140 141 142 143

  if (cc>1) {
    std::vector<void *> buff_ptrs;
    for (int i=0;i<cc;i++) buff_ptrs.push_back(buff[i]);
    s->tx_stream->send(buff_ptrs, nsamps, s->tx_md);
  }
  else
    s->tx_stream->send(buff[0], nsamps, s->tx_md);
knopp's avatar
 
knopp committed
144
  s->tx_md.start_of_burst = false;
145 146

  return 0;
knopp's avatar
 
knopp committed
147 148
}

knopp's avatar
 
knopp committed
149
static int trx_usrp_read(openair0_device *device, openair0_timestamp *ptimestamp, void **buff, int nsamps, int cc)
knopp's avatar
 
knopp committed
150 151 152 153
{

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

knopp's avatar
 
knopp committed
154
  int samples_received=0,i;
knopp's avatar
 
knopp committed
155
  
knopp's avatar
knopp committed
156
  if (cc>1) {
gauthier's avatar
gauthier committed
157
    // receive multiple channels (e.g. RF A and RF B)
knopp's avatar
knopp committed
158 159 160
    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);
gauthier's avatar
gauthier committed
161 162
  } else {
    // receive a single channel (e.g. from connector RF A)
knopp's avatar
knopp committed
163
    samples_received = s->rx_stream->recv(buff[0], nsamps, s->rx_md);
gauthier's avatar
gauthier committed
164
  }
knopp's avatar
 
knopp committed
165

knopp's avatar
 
knopp committed
166 167 168 169
  if (samples_received < nsamps) {
    printf("[recv] received %d samples out of %d\n",samples_received,nsamps);
    
  }
knopp's avatar
 
knopp committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
  //handle the error code
  switch(s->rx_md.error_code){
  case uhd::rx_metadata_t::ERROR_CODE_NONE:
    break;
  case uhd::rx_metadata_t::ERROR_CODE_OVERFLOW:
    printf("[recv] USRP RX OVERFLOW!\n");
    s->num_overflows++;
    break;
  case uhd::rx_metadata_t::ERROR_CODE_TIMEOUT:
    printf("[recv] USRP RX TIMEOUT!\n");
    break;
  default:
    printf("[recv] Unexpected error on RX, Error code: 0x%x\n",s->rx_md.error_code);
    break;
  }
knopp's avatar
 
knopp committed
185 186 187 188 189 190
  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
191 192 193 194 195 196 197 198
openair0_timestamp get_usrp_time(openair0_device *device) 
{
 
  usrp_state_t *s = (usrp_state_t*)device->priv;
  
  return s->usrp->get_time_now().to_ticks(s->sample_rate);
} 

knopp's avatar
 
knopp committed
199 200 201 202
static bool is_equal(double a, double b)
{
  return std::fabs(a-b) < std::numeric_limits<double>::epsilon();
}
knopp's avatar
 
knopp committed
203

204
int trx_usrp_set_freq(openair0_device* device, openair0_config_t *openair0_cfg, int dummy) {
knopp's avatar
 
knopp committed
205 206 207 208 209 210 211 212 213 214

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

  s->usrp->set_tx_freq(openair0_cfg[0].tx_freq[0]);
  s->usrp->set_rx_freq(openair0_cfg[0].rx_freq[0]);

  return(0);
  
}

knopp's avatar
 
knopp committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
int openair0_set_rx_frequencies(openair0_device* device, openair0_config_t *openair0_cfg) {

  usrp_state_t *s = (usrp_state_t*)device->priv;
  static int first_call=1;
  static double rf_freq,diff;

  uhd::tune_request_t rx_tune_req(openair0_cfg[0].rx_freq[0]);

  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);
  
}

232
int trx_usrp_set_gains(openair0_device* device, 
233
		       openair0_config_t *openair0_cfg) {
knopp's avatar
 
knopp committed
234 235 236 237

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

  s->usrp->set_tx_gain(openair0_cfg[0].tx_gain[0]);
238 239 240 241 242 243 244 245 246 247 248
  ::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()) {
    
    printf("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]);
  printf("Setting USRP RX gain to %f\n", openair0_cfg[0].rx_gain[0]-openair0_cfg[0].rx_gain_offset[0]);

knopp's avatar
 
knopp committed
249 250
  return(0);
}
251

252
int trx_usrp_stop(int card) {
253 254
  return(0);
}
255

256

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
rx_gain_calib_table_t calib_table[] = {
  {3500000000.0,46.0},
  {2660000000.0,53.0},
  {2300000000.0,54.0},
  {1880000000.0,55.0},
  {816000000.0,62.0},
  {-1,0}};

void set_rx_gain_offset(openair0_config_t *openair0_cfg, int chain_index) {

  int i=0;
  // loop through calibration table to find best adjustment factor for RX frequency
  double min_diff = 6e9,diff;
 
  while (calib_table[i].freq>0) {
    diff = fabs(openair0_cfg->rx_freq[chain_index] - calib_table[i].freq);
    printf("cal %d: freq %f, offset %f, diff %f\n",
	   i,calib_table[i].freq,calib_table[i].offset,diff);
    if (min_diff > diff) {
      min_diff = diff;
      openair0_cfg->rx_gain_offset[chain_index] = calib_table[i].offset;
    }
    i++;
  }
  
}

284 285

int trx_usrp_get_stats(openair0_device* device) {
286

287 288 289
  return(0);

}
290
int trx_usrp_reset_stats(openair0_device* device) {
291 292 293 294

  return(0);

}
295

296

knopp's avatar
 
knopp committed
297 298
int openair0_device_init(openair0_device* device, openair0_config_t *openair0_cfg)
{
knopp's avatar
knopp committed
299
  uhd::set_thread_priority_safe(1.0);
knopp's avatar
 
knopp committed
300 301 302 303
  usrp_state_t *s = (usrp_state_t*)malloc(sizeof(usrp_state_t));
  memset(s, 0, sizeof(usrp_state_t));

  // Initialize USRP device
knopp's avatar
 
knopp committed
304

knopp's avatar
 
knopp committed
305
  std::string args = "type=b200";
knopp's avatar
knopp committed
306 307


knopp's avatar
 
knopp committed
308
  uhd::device_addrs_t device_adds = uhd::device::find(args);
knopp's avatar
 
knopp committed
309 310
  size_t i;

311 312
  printf("Checking for USRPs\n");
  
knopp's avatar
 
knopp committed
313 314
  if(device_adds.size() == 0)
  {
315 316 317 318 319 320 321 322
    double usrp_master_clock = 184.32e6;

    std::string args = "type=x300";
    
    // 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);
    
    uhd::device_addrs_t device_adds = uhd::device::find(args);
knopp's avatar
 
knopp committed
323

324 325 326 327 328
    if(device_adds.size() == 0)
    {
      std::cerr<<"No USRP Device Found. " << std::endl;
      free(s);
      return -1;
knopp's avatar
knopp committed
329

330
    }
knopp's avatar
knopp committed
331

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    printf("Found USRP X300\n");
    s->usrp = uhd::usrp::multi_usrp::make(args);
    //  s->usrp->set_rx_subdev_spec(rx_subdev);
    //  s->usrp->set_tx_subdev_spec(tx_subdev);

    // lock mboard clocks
    s->usrp->set_clock_source("internal");
    
    // 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);
  } else {
    printf("Found USRP B200");
    s->usrp = uhd::usrp::multi_usrp::make(args);

    //  s->usrp->set_rx_subdev_spec(rx_subdev);
    //  s->usrp->set_tx_subdev_spec(tx_subdev);

350 351 352
// do not explicitly set the clock to "internal", because this will disable the gpsdo
//    // lock mboard clocks
//    s->usrp->set_clock_source("internal");
353 354 355
    // set master clock rate and sample rate for tx & rx for streaming
    s->usrp->set_master_clock_rate(30.72e6);
  }
knopp's avatar
knopp committed
356 357


knopp's avatar
 
knopp committed
358

knopp's avatar
 
knopp committed
359
  for(i=0;i<s->usrp->get_rx_num_channels();i++) {
knopp's avatar
 
knopp committed
360
    if (i<openair0_cfg[0].rx_num_channels) {
knopp's avatar
knopp committed
361
      s->usrp->set_rx_rate(openair0_cfg[0].sample_rate,i);
kortke's avatar
kortke committed
362
      s->usrp->set_rx_bandwidth(openair0_cfg[0].rx_bw,i);
knopp's avatar
 
knopp committed
363
      printf("Setting rx freq/gain on channel %lu/%lu\n",i,s->usrp->get_rx_num_channels());
knopp's avatar
knopp committed
364
      s->usrp->set_rx_freq(openair0_cfg[0].rx_freq[i],i);
365 366 367 368 369 370 371 372 373 374 375 376 377
      set_rx_gain_offset(&openair0_cfg[0],i);

      ::uhd::gain_range_t gain_range = s->usrp->get_rx_gain_range(i);
      // limit to maximum gain
      if (openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i] > gain_range.stop()) {
	
        printf("RX Gain %lu too high, lower by %f dB\n",i,openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i] - gain_range.stop());
	exit(-1);
      }
      s->usrp->set_rx_gain(openair0_cfg[0].rx_gain[i]-openair0_cfg[0].rx_gain_offset[i],i);
      printf("RX Gain %lu %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());
knopp's avatar
 
knopp committed
378 379
    }
  }
knopp's avatar
 
knopp committed
380
  for(i=0;i<s->usrp->get_tx_num_channels();i++) {
knopp's avatar
 
knopp committed
381
    if (i<openair0_cfg[0].tx_num_channels) {
knopp's avatar
knopp committed
382 383
      s->usrp->set_tx_rate(openair0_cfg[0].sample_rate,i);
      s->usrp->set_tx_bandwidth(openair0_cfg[0].tx_bw,i);
knopp's avatar
 
knopp committed
384
      printf("Setting tx freq/gain on channel %lu/%lu\n",i,s->usrp->get_tx_num_channels());
knopp's avatar
knopp committed
385 386
      s->usrp->set_tx_freq(openair0_cfg[0].tx_freq[i],i);
      s->usrp->set_tx_gain(openair0_cfg[0].tx_gain[i],i);
knopp's avatar
 
knopp committed
387 388
    }
  }
knopp's avatar
knopp committed
389 390


knopp's avatar
 
knopp committed
391 392
  // display USRP settings
  std::cout << boost::format("Actual master clock: %fMHz...") % (s->usrp->get_master_clock_rate()/1e6) << std::endl;
knopp's avatar
 
knopp committed
393 394

  // create tx & rx streamer
knopp's avatar
 
knopp committed
395
  uhd::stream_args_t stream_args_rx("sc16", "sc16");
knopp's avatar
 
knopp committed
396
  //stream_args_rx.args["spp"] = str(boost::format("%d") % 2048);//(openair0_cfg[0].rx_num_channels*openair0_cfg[0].samples_per_packet));
knopp's avatar
 
knopp committed
397
  for (i = 0; i<openair0_cfg[0].rx_num_channels; i++)
knopp's avatar
 
knopp committed
398 399 400 401 402 403 404
    stream_args_rx.channels.push_back(i);
  s->rx_stream = s->usrp->get_rx_stream(stream_args_rx);
  std::cout << boost::format("rx_max_num_samps %u") % (s->rx_stream->get_max_num_samps()) << std::endl;
  //openair0_cfg[0].samples_per_packet = s->rx_stream->get_max_num_samps();

  uhd::stream_args_t stream_args_tx("sc16", "sc16");
  //stream_args_tx.args["spp"] = str(boost::format("%d") % 2048);//(openair0_cfg[0].tx_num_channels*openair0_cfg[0].samples_per_packet));
knopp's avatar
 
knopp committed
405
  for (i = 0; i<openair0_cfg[0].tx_num_channels; i++)
knopp's avatar
 
knopp committed
406 407
      stream_args_tx.channels.push_back(i);
  s->tx_stream = s->usrp->get_tx_stream(stream_args_tx);
knopp's avatar
 
knopp committed
408 409
  std::cout << boost::format("tx_max_num_samps %u") % (s->tx_stream->get_max_num_samps()) << std::endl;

knopp's avatar
 
knopp committed
410 411 412

  s->usrp->set_time_now(uhd::time_spec_t(0.0));

knopp's avatar
 
knopp committed
413 414 415


  
416

knopp's avatar
knopp committed
417 418
  for (i=0;i<openair0_cfg[0].rx_num_channels;i++) {
    if (i<openair0_cfg[0].rx_num_channels) {
knopp's avatar
 
knopp committed
419
      printf("RX Channel %lu\n",i);
knopp's avatar
knopp committed
420 421 422 423 424 425 426 427 428 429 430
      std::cout << boost::format("Actual RX sample rate: %fMSps...") % (s->usrp->get_rx_rate(i)/1e6) << std::endl;
      std::cout << boost::format("Actual RX frequency: %fGHz...") % (s->usrp->get_rx_freq(i)/1e9) << std::endl;
      std::cout << boost::format("Actual RX gain: %f...") % (s->usrp->get_rx_gain(i)) << std::endl;
      std::cout << boost::format("Actual RX bandwidth: %fM...") % (s->usrp->get_rx_bandwidth(i)/1e6) << std::endl;
      std::cout << boost::format("Actual RX antenna: %s...") % (s->usrp->get_rx_antenna(i)) << std::endl;
    }
  }

  for (i=0;i<openair0_cfg[0].tx_num_channels;i++) {

    if (i<openair0_cfg[0].tx_num_channels) { 
knopp's avatar
 
knopp committed
431
      printf("TX Channel %lu\n",i);
knopp's avatar
knopp committed
432 433 434 435 436 437 438 439
      std::cout << std::endl<<boost::format("Actual TX sample rate: %fMSps...") % (s->usrp->get_tx_rate(i)/1e6) << std::endl;
      std::cout << boost::format("Actual TX frequency: %fGHz...") % (s->usrp->get_tx_freq(i)/1e9) << std::endl;
      std::cout << boost::format("Actual TX gain: %f...") % (s->usrp->get_tx_gain(i)) << std::endl;
      std::cout << boost::format("Actual TX bandwidth: %fM...") % (s->usrp->get_tx_bandwidth(i)/1e6) << std::endl;
      std::cout << boost::format("Actual TX antenna: %s...") % (s->usrp->get_tx_antenna(i)) << std::endl;
    }
  }

knopp's avatar
 
knopp committed
440
  std::cout << boost::format("Device timestamp: %f...") % (s->usrp->get_time_now().get_real_secs()) << std::endl;
knopp's avatar
 
knopp committed
441 442 443 444

  device->priv = s;
  device->trx_start_func = trx_usrp_start;
  device->trx_write_func = trx_usrp_write;
445 446 447 448 449 450 451
  device->trx_read_func  = trx_usrp_read;
  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;
452
  
knopp's avatar
knopp committed
453
  s->sample_rate = openair0_cfg[0].sample_rate;
knopp's avatar
 
knopp committed
454 455 456 457 458 459 460 461 462 463 464
  // 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;

  return 0;
}