srsRAN_4G/lib/include/srslte/radio/radio.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2015 Software Radio Systems Limited
 *
 * \section LICENSE
 *
 * This file is part of the srsUE library.
 *
 * srsUE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsUE 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 Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

#include <string.h>

#include "srslte/srslte.h"
#include "srslte/phy/rf/rf.h"
#include "srslte/common/trace.h"

#ifndef RADIO_H
#define RADIO_H

typedef struct {
  float         tx_corr_dc_gain;
  float         tx_corr_dc_phase;
  float         tx_corr_iq_i;
  float         tx_corr_iq_q; 
  float         rx_corr_dc_gain;
  float         rx_corr_dc_phase;
  float         rx_corr_iq_i;
  float         rx_corr_iq_q; 
}rf_cal_t; 


namespace srslte {
  
/* Interface to the RF frontend. 
  */
  class radio
  {
    public: 
      radio() : tr_local_time(1024*10), tr_usrp_time(1024*10), tr_tx_time(1024*10), tr_is_eob(1024*10) {
        bzero(&rf_device, sizeof(srslte_rf_t));
        bzero(&end_of_burst_time, sizeof(srslte_timestamp_t));
        bzero(zeros, burst_preamble_max_samples*sizeof(cf_t));
        
        sf_len                  = 0;
        burst_preamble_sec      = 0; 
        is_start_of_burst       = false; 
        burst_preamble_samples  = 0; 
        burst_preamble_time_rounded = 0; 
        
        cur_tx_srate            = 0; 
        tx_adv_sec              = 0; 
        tx_adv_nsamples         = 0; 
        tx_adv_auto             = false; 
        tx_adv_negative         = false; 
        tx_freq                 = 0; 
        rx_freq                 = 0; 
        trace_enabled           = false; 
        tti                     = 0; 
        agc_enabled             = false; 
        offset                  = 0; 
        
      };
      
      bool init(char *args = NULL, char *devname = NULL);
      void stop(); 
      bool start_agc(bool tx_gain_same_rx);
      
      void set_burst_preamble(double preamble_us);
      void set_tx_adv(int nsamples);
      void set_tx_adv_neg(bool tx_adv_is_neg); 
      
      void set_manual_calibration(rf_cal_t *calibration);
      
      void get_time(srslte_timestamp_t *now);
      bool tx(void *buffer, uint32_t nof_samples, srslte_timestamp_t tx_time);
      void tx_end();
      bool rx_now(void *buffer, uint32_t nof_samples, srslte_timestamp_t *rxd_time);
      bool rx_at(void *buffer, uint32_t nof_samples, srslte_timestamp_t rx_time);

      void set_tx_gain(float gain);
      void set_rx_gain(float gain);
      void set_tx_rx_gain_offset(float offset); 
      double set_rx_gain_th(float gain);

      void set_freq_offset(double freq);
      void set_tx_freq(double freq);
      void set_rx_freq(double freq);

      double get_tx_freq();
      double get_rx_freq();

      void set_master_clock_rate(double rate);
      void set_tx_srate(double srate);
      void set_rx_srate(double srate);

      float get_tx_gain();
      float get_rx_gain();
      
      float get_max_tx_power();
      float set_tx_power(float power);
      float get_rssi();
      bool  has_rssi();
      
      void start_trace();
      void write_trace(std::string filename);
      void start_rx();
      void stop_rx();
      
      void set_tti(uint32_t tti);
      void tx_offset(int offset);
      void set_tti_len(uint32_t sf_len);
      uint32_t get_tti_len();

      void register_error_handler(srslte_rf_error_handler_t h);
      
    protected:
      
      void save_trace(uint32_t is_eob, srslte_timestamp_t *usrp_time);
      
      srslte_rf_t rf_device; 
      
      
      const static uint32_t burst_preamble_max_samples = 30720000;  // 30.72 MHz is maximum frequency
      double burst_preamble_sec;// Start of burst preamble time (off->on RF transition time)      
      srslte_timestamp_t end_of_burst_time; 
      bool is_start_of_burst; 
      uint32_t burst_preamble_samples; 
      double burst_preamble_time_rounded; // preamble time rounded to sample time
      cf_t zeros[burst_preamble_max_samples]; 
      double cur_tx_srate;

      double   tx_adv_sec; // Transmission time advance to compensate for antenna->timestamp delay
      int      tx_adv_nsamples; // Transmision time advance in number of samples
      
      // Define default values for known radios
      bool tx_adv_auto;
      bool tx_adv_negative; 
      const static double uhd_default_burst_preamble_sec = 600*1e-6;
      const static double uhd_default_tx_adv_samples     = 98;
      const static double uhd_default_tx_adv_offset_sec  = 4*1e-6; 
      
      const static double blade_default_burst_preamble_sec = 0.0;
      const static double blade_default_tx_adv_samples     = 27;
      const static double blade_default_tx_adv_offset_sec  = 1e-6;

      double tx_freq, rx_freq, freq_offset;
      
      trace<uint32_t> tr_local_time;
      trace<uint32_t> tr_usrp_time;
      trace<uint32_t> tr_tx_time;
      trace<uint32_t> tr_is_eob;
      bool trace_enabled;
      uint32_t tti;
      bool agc_enabled;
      int offset;
      uint32_t sf_len;
  }; 
}

#endif