path: root/usrp/host/apps-inband/test_usrp_inband_tx.cc

/* -*- c++ -*- */
/*
 * Copyright 2007,2008 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio 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, or (at your option)
 * any later version.
 * 
 * GNU Radio 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <mblock/mblock.h>
#include <mblock/runtime.h>
#include <mblock/protocol_class.h>
#include <mblock/exception.h>
#include <mblock/msg_queue.h>
#include <mblock/message.h>
#include <mblock/msg_accepter.h>
#include <mblock/class_registry.h>
#include <pmt.h>
#include <stdio.h>
#include <string.h>
#include <iostream>

#include <ui_nco.h>
#include <symbols_usrp_server_cs.h>
#include <symbols_usrp_channel.h>
#include <symbols_usrp_low_level_cs.h>
#include <symbols_usrp_tx.h>

static bool verbose = true;

class test_usrp_tx : public mb_mblock
{
  mb_port_sptr 	d_tx;
  mb_port_sptr 	d_cs;
  pmt_t		d_tx_chan;	// returned tx channel handle

  enum state_t {
    INIT,
    OPENING_USRP,
    ALLOCATING_CHANNEL,
    TRANSMITTING,
    CLOSING_CHANNEL,
    CLOSING_USRP,
  };

  state_t	d_state;
  long		d_nsamples_to_send;
  long		d_nsamples_xmitted;
  long		d_nframes_xmitted;
  long		d_samples_per_frame;
  bool		d_done_sending;

  // for generating sine wave output
  ui_nco<float,float>	d_nco;
  double	        d_amplitude;

 public:
  test_usrp_tx(mb_runtime *runtime, const std::string &instance_name, pmt_t user_arg);
  ~test_usrp_tx();
  void initial_transition();
  void handle_message(mb_message_sptr msg);

 protected:
  void open_usrp();
  void close_usrp();
  void allocate_channel();
  void send_packets();
  void enter_transmitting();
  void build_and_send_next_frame();
  void handle_xmit_response(pmt_t invocation_handle);
  void enter_closing_channel();
};

test_usrp_tx::test_usrp_tx(mb_runtime *runtime, const std::string &instance_name, pmt_t user_arg)
  : mb_mblock(runtime, instance_name, user_arg),
    d_state(INIT), d_nsamples_to_send((long) 80e6),
    d_nsamples_xmitted(0),
    d_nframes_xmitted(0),
    d_samples_per_frame((long)(126 * 4)),	// full packet
    d_done_sending(false),
    d_amplitude(16384)
{ 
  // std::cout << "[TEST_USRP_TX] Initializing...\n";
  
  d_tx = define_port("tx0", "usrp-tx", false, mb_port::INTERNAL);
  d_cs = define_port("cs", "usrp-server-cs", false, mb_port::INTERNAL);
  
  //bool fake_usrp_p = true;
  bool fake_usrp_p = false;

  // Test the TX side

  pmt_t usrp_dict = pmt_make_dict();

  if(fake_usrp_p) {
    pmt_dict_set(usrp_dict, 
                 pmt_intern("fake-usrp"),
		             PMT_T);
  }
  
  // Specify the RBF to use
  pmt_dict_set(usrp_dict,
               pmt_intern("rbf"),
               pmt_intern("inband_1rxhb_1tx.rbf"));

  // Set TX and RX interpolations
  pmt_dict_set(usrp_dict,
               pmt_intern("interp-tx"),
               pmt_from_long(64));

  pmt_dict_set(usrp_dict,
               pmt_intern("rf-freq"),
               pmt_from_long(10e6));

  define_component("server", "usrp_server", usrp_dict);

  connect("self", "tx0", "server", "tx0");
  connect("self", "cs", "server", "cs");

  // initialize NCO
  double freq = 100e3;
  int interp = 32;			    // 32 -> 4MS/s
  double sample_rate = 128e6 / interp;	
  d_nco.set_freq(2*M_PI * freq/sample_rate);

  // FIXME need to somehow set the interp rate in the USRP.
  // for now, we'll have the low-level code hardwire it.
}

test_usrp_tx::~test_usrp_tx()
{
}

void
test_usrp_tx::initial_transition()
{
  open_usrp();
}

void
test_usrp_tx::handle_message(mb_message_sptr msg)
{
  pmt_t	event = msg->signal();
  pmt_t data = msg->data();

  pmt_t handle = PMT_F;
  pmt_t status = PMT_F;
  std::string error_msg;
  
  //std::cout << msg << std::endl;

  switch(d_state){
  case OPENING_USRP:
    if (pmt_eq(event, s_response_open)){
      status = pmt_nth(1, data);
      if (pmt_eq(status, PMT_T)){
        allocate_channel();
        return;
      }
      else {
        error_msg = "failed to open usrp:";
        goto bail;
      }
    }
    goto unhandled;
    
  case ALLOCATING_CHANNEL:
    if (pmt_eq(event, s_response_allocate_channel)){
      status = pmt_nth(1, data);
      d_tx_chan = pmt_nth(2, data);

      if (pmt_eq(status, PMT_T)){
        enter_transmitting();
        return;
      }
      else {
        error_msg = "failed to allocate channel:";
        goto bail;
      }
    }
    goto unhandled;

  case TRANSMITTING:
    if (pmt_eq(event, s_response_xmit_raw_frame)){
      handle = pmt_nth(0, data);
      status = pmt_nth(1, data);

      if (pmt_eq(status, PMT_T)){
        handle_xmit_response(handle);
        return;
      }
      else {
        error_msg = "bad response-xmit-raw-frame:";
        goto bail;
      }
    }
    goto unhandled;

  case CLOSING_CHANNEL:
    if (pmt_eq(event, s_response_deallocate_channel)){
      status = pmt_nth(1, data);

      if (pmt_eq(status, PMT_T)){
        close_usrp();
        return;
      }
      else {
        error_msg = "failed to deallocate channel:";
        goto bail;
      }
    }
    goto unhandled;

  case CLOSING_USRP:
    if (pmt_eq(event, s_response_close)){
      status = pmt_nth(1, data);

      if (pmt_eq(status, PMT_T)){
        shutdown_all(PMT_T);
        return;
      }
      else {
        error_msg = "failed to close USRP:";
        goto bail;
      }
    }
    goto unhandled;

  default:
    goto unhandled;
  }
  return;

 bail:
  std::cerr << error_msg << data
	    << "status = " << status << std::endl;
  shutdown_all(PMT_F);
  return;

 unhandled:
  std::cout << "test_usrp_inband_tx: unhandled msg: " << msg
	    << "in state "<< d_state << std::endl;
}


void
test_usrp_tx::open_usrp()
{
  pmt_t which_usrp = pmt_from_long(0);

  d_cs->send(s_cmd_open, pmt_list2(PMT_NIL, which_usrp));
  d_state = OPENING_USRP;
  
  if(verbose)
    std::cout << "[TEST_USRP_INBAND_TX] Opening the USRP\n";
}

void
test_usrp_tx::close_usrp()
{
  d_cs->send(s_cmd_close, pmt_list1(PMT_NIL));
  d_state = CLOSING_USRP;
  
  if(verbose)
    std::cout << "[TEST_USRP_INBAND_TX] Closing the USRP\n";
}

void
test_usrp_tx::allocate_channel()
{
  long capacity = (long) 16e6;
  d_tx->send(s_cmd_allocate_channel, pmt_list2(PMT_T, pmt_from_long(capacity)));
  d_state = ALLOCATING_CHANNEL;
  
  if(verbose)
    std::cout << "[TEST_USRP_INBAND_TX] Requesting TX channel allocation\n";
}

void
test_usrp_tx::enter_transmitting()
{
  d_state = TRANSMITTING;
  d_nsamples_xmitted = 0;
  
  if(verbose)
    std::cout << "[TEST_USRP_INBAND_TX] Transmitting...\n";
  
  build_and_send_next_frame();	// fire off 4 to start pipeline
  build_and_send_next_frame();
  build_and_send_next_frame();
  build_and_send_next_frame();
}

void
test_usrp_tx::build_and_send_next_frame()
{
  // allocate the uniform vector for the samples
  // FIXME perhaps hold on to this between calls

#if 1
  long nsamples_this_frame =
    std::min(d_nsamples_to_send - d_nsamples_xmitted,
	     d_samples_per_frame);
#else
  long nsamples_this_frame = d_samples_per_frame;
#endif

  if (nsamples_this_frame == 0){
    d_done_sending = true;
    return;
  }
    

  size_t nshorts = 2 * nsamples_this_frame;	// 16-bit I & Q
  pmt_t uvec = pmt_make_s16vector(nshorts, 0);
  size_t ignore;
  int16_t *samples = pmt_s16vector_writable_elements(uvec, ignore);

  // fill in the complex sinusoid

  for (int i = 0; i < nsamples_this_frame; i++){

    if (1){
      gr_complex s;
      d_nco.sincos(&s, 1, d_amplitude);
      // write 16-bit i & q
      samples[2*i] =   (int16_t) s.real();
      samples[2*i+1] = (int16_t) s.imag();
    }
    else {
      gr_complex s(d_amplitude, d_amplitude);

      // write 16-bit i & q
      samples[2*i] =   (int16_t) s.real();
      samples[2*i+1] = (int16_t) s.imag();
    }
  }

  pmt_t tx_properties = pmt_make_dict();

  pmt_t timestamp = pmt_from_long(0xffffffff);	// NOW
  d_tx->send(s_cmd_xmit_raw_frame,
	     pmt_list5(pmt_from_long(d_nframes_xmitted),  // invocation-handle
		       d_tx_chan,			  // channel
		       uvec,				  // the samples
		       timestamp,
           tx_properties));

  d_nsamples_xmitted += nsamples_this_frame;
  d_nframes_xmitted++;

  if(verbose && 0)
    std::cout << "[TEST_USRP_INBAND_TX] Transmitted frame\n";
}


void
test_usrp_tx::handle_xmit_response(pmt_t handle)
{
  if (d_done_sending &&
      pmt_to_long(handle) == (d_nframes_xmitted - 1)){
    // We're done sending and have received all responses
    enter_closing_channel();
  }

  build_and_send_next_frame();
}

void
test_usrp_tx::enter_closing_channel()
{
  d_state = CLOSING_CHANNEL;
  
  d_tx->send(s_cmd_deallocate_channel, pmt_list2(PMT_NIL, d_tx_chan));
  
  if(verbose)
    std::cout << "[TEST_USRP_INBAND_tX] Deallocating TX channel\n";
}

REGISTER_MBLOCK_CLASS(test_usrp_tx);


// ----------------------------------------------------------------

int
main (int argc, char **argv)
{
  // handle any command line args here

  mb_runtime_sptr rt = mb_make_runtime();
  pmt_t result = PMT_NIL;

  rt->run("top", "test_usrp_tx", PMT_F, &result);
}