git.gag.com Git - debian/gnuradio/blob - usrp/host/apps-inband/test_usrp_inband_rx.cc

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <mb_mblock.h>
  27 #include <mb_runtime.h>
  28 #include <mb_protocol_class.h>
  29 #include <mb_exception.h>
  30 #include <mb_msg_queue.h>
  31 #include <mb_message.h>
  32 #include <mb_msg_accepter.h>
  33 #include <mb_class_registry.h>
  34 #include <pmt.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <iostream>
  38 #include <fstream>
  39
  40 // Include the symbols needed for communication with USRP server
  41 #include <symbols_usrp_server_cs.h>
  42 #include <symbols_usrp_channel.h>
  43 #include <symbols_usrp_low_level_cs.h>
  44 #include <symbols_usrp_rx.h>
  45
  46 static bool verbose = true;
  47
  48 class test_usrp_rx : public mb_mblock
  49 {
  50   mb_port_sptr  d_rx;
  51   mb_port_sptr  d_cs;
  52   pmt_t         d_rx_chan;      // returned tx channel handle
  53
  54   enum state_t {
  55     INIT,
  56     OPENING_USRP,
  57     ALLOCATING_CHANNEL,
  58     RECEIVING,
  59     CLOSING_CHANNEL,
  60     CLOSING_USRP,
  61   };
  62
  63   state_t       d_state;
  64
  65   std::ofstream d_ofile;
  66
  67   long d_samples_recvd;
  68   long d_samples_to_recv;
  69
  70  public:
  71   test_usrp_rx(mb_runtime *runtime, const std::string &instance_name, pmt_t user_arg);
  72   ~test_usrp_rx();
  73   void initial_transition();
  74   void handle_message(mb_message_sptr msg);
  75
  76  protected:
  77   void open_usrp();
  78   void close_usrp();
  79   void allocate_channel();
  80   void send_packets();
  81   void enter_receiving();
  82   void build_and_send_next_frame();
  83   void handle_response_recv_raw_samples(pmt_t invocation_handle);
  84   void enter_closing_channel();
  85 };
  86
  87 test_usrp_rx::test_usrp_rx(mb_runtime *runtime, const std::string &instance_name, pmt_t user_arg)
  88   : mb_mblock(runtime, instance_name, user_arg),
  89     d_samples_recvd(0),
  90     d_samples_to_recv(20e6)
  91 {
  92   d_rx = define_port("rx0", "usrp-rx", false, mb_port::INTERNAL);
  93   d_cs = define_port("cs", "usrp-server-cs", false, mb_port::INTERNAL);
  94
  95   // Pass a dictionary to usrp_server which specifies which interface to use, the stub or USRP
  96   pmt_t usrp_dict = pmt_make_dict();
  97
  98   // To test the application without a USRP
  99   bool fake_usrp_p = false;
 100   if(fake_usrp_p) {
 101     pmt_dict_set(usrp_dict,
 102                  pmt_intern("fake-usrp"),
 103                              PMT_T);
 104   }
 105
 106   // Specify the RBF to use
 107   pmt_dict_set(usrp_dict,
 108                pmt_intern("rbf"),
 109                pmt_intern("inband_1rxhb_1tx.rbf"));
 110
 111   pmt_dict_set(usrp_dict,
 112                pmt_intern("decim-rx"),
 113                pmt_from_long(64));
 114
 115   define_component("server", "usrp_server", usrp_dict);
 116
 117   connect("self", "rx0", "server", "rx0");
 118   connect("self", "cs", "server", "cs");
 119
 120 }
 121
 122 test_usrp_rx::~test_usrp_rx()
 123 {
 124 }
 125
 126 void
 127 test_usrp_rx::initial_transition()
 128 {
 129   open_usrp();
 130 }
 131
 132 void
 133 test_usrp_rx::handle_message(mb_message_sptr msg)
 134 {
 135   pmt_t event = msg->signal();
 136   pmt_t data = msg->data();
 137
 138   pmt_t handle = PMT_F;
 139   pmt_t status = PMT_F;
 140   std::string error_msg;
 141
 142   switch(d_state){
 143
 144     //----------------------------- OPENING_USRP ----------------------------//
 145     // We only expect a response from opening the USRP which should be succesful
 146     // or failed.
 147     case OPENING_USRP:
 148       if (pmt_eq(event, s_response_open)){
 149         status = pmt_nth(1, data);
 150         if (pmt_eq(status, PMT_T)){
 151           allocate_channel();
 152           return;
 153         }
 154         else {
 155           error_msg = "failed to open usrp:";
 156           goto bail;
 157         }
 158       }
 159       goto unhandled;
 160
 161     //----------------------- ALLOCATING CHANNELS --------------------//
 162     // Allocate an RX channel to perform the overrun test.
 163     case ALLOCATING_CHANNEL:
 164       if (pmt_eq(event, s_response_allocate_channel)){
 165         status = pmt_nth(1, data);
 166         d_rx_chan = pmt_nth(2, data);
 167
 168         if (pmt_eq(status, PMT_T)){
 169           enter_receiving();
 170           return;
 171         }
 172         else {
 173           error_msg = "failed to allocate channel:";
 174           goto bail;
 175         }
 176       }
 177       goto unhandled;
 178
 179     //--------------------------- RECEIVING ------------------------------//
 180     // In the receiving state, we receive samples until the specified amount
 181     // while counting the number of overruns.
 182     case RECEIVING:
 183       if (pmt_eq(event, s_response_recv_raw_samples)){
 184         status = pmt_nth(1, data);
 185
 186         if (pmt_eq(status, PMT_T)){
 187           handle_response_recv_raw_samples(data);
 188           return;
 189         }
 190         else {
 191           error_msg = "bad response-xmit-raw-frame:";
 192           goto bail;
 193         }
 194       }
 195       goto unhandled;
 196
 197     //------------------------- CLOSING CHANNEL ----------------------------//
 198     // Check deallocation response for the RX channel
 199     case CLOSING_CHANNEL:
 200       if (pmt_eq(event, s_response_deallocate_channel)){
 201         status = pmt_nth(1, data);
 202
 203         if (pmt_eq(status, PMT_T)){
 204           close_usrp();
 205           return;
 206         }
 207         else {
 208           error_msg = "failed to deallocate channel:";
 209           goto bail;
 210         }
 211       }
 212
 213       // Alternately, we ignore all response recv samples while waiting for the
 214       // channel to actually close
 215       if (pmt_eq(event, s_response_recv_raw_samples))
 216         return;
 217
 218       goto unhandled;
 219
 220     //--------------------------- CLOSING USRP ------------------------------//
 221     // Once we have received a successful USRP close response, we shutdown all
 222     // mblocks and exit.
 223     case CLOSING_USRP:
 224       if (pmt_eq(event, s_response_close)){
 225         status = pmt_nth(1, data);
 226
 227         if (pmt_eq(status, PMT_T)){
 228           fflush(stdout);
 229           shutdown_all(PMT_T);
 230           return;
 231         }
 232         else {
 233           error_msg = "failed to close USRP:";
 234           goto bail;
 235         }
 236       }
 237       goto unhandled;
 238
 239     default:
 240       goto unhandled;
 241   }
 242   return;
 243
 244  // An error occured, print it, and shutdown all m-blocks
 245  bail:
 246   std::cerr << error_msg << data
 247             << "status = " << status << std::endl;
 248   shutdown_all(PMT_F);
 249   return;
 250
 251  // Received an unhandled message for a specific state
 252  unhandled:
 253   if(verbose && !pmt_eq(event, pmt_intern("%shutdown")))
 254     std::cout << "test_usrp_inband_tx: unhandled msg: " << msg
 255               << "in state "<< d_state << std::endl;
 256 }
 257
 258
 259 void
 260 test_usrp_rx::open_usrp()
 261 {
 262   pmt_t which_usrp = pmt_from_long(0);
 263
 264   d_cs->send(s_cmd_open, pmt_list2(PMT_NIL, which_usrp));
 265   d_state = OPENING_USRP;
 266
 267   if(verbose)
 268     std::cout << "[TEST_USRP_INBAND_RX] Opening the USRP\n";
 269 }
 270
 271 void
 272 test_usrp_rx::close_usrp()
 273 {
 274
 275   d_cs->send(s_cmd_close, pmt_list1(PMT_NIL));
 276   d_state = CLOSING_USRP;
 277
 278   if(verbose)
 279     std::cout << "[TEST_USRP_INBAND_RX] Closing the USRP\n";
 280 }
 281
 282 void
 283 test_usrp_rx::allocate_channel()
 284 {
 285   long capacity = (long) 16e6;
 286   d_rx->send(s_cmd_allocate_channel, pmt_list2(PMT_T, pmt_from_long(capacity)));
 287   d_state = ALLOCATING_CHANNEL;
 288
 289   if(verbose)
 290     std::cout << "[TEST_USRP_INBAND_RX] Requesting RX channel allocation\n";
 291 }
 292
 293 void
 294 test_usrp_rx::enter_receiving()
 295 {
 296   d_state = RECEIVING;
 297
 298   d_rx->send(s_cmd_start_recv_raw_samples,
 299              pmt_list2(PMT_F,
 300                        d_rx_chan));
 301
 302   if(verbose)
 303     std::cout << "[TEST_USRP_INBAND_RX] Receiving...\n";
 304 }
 305
 306 void
 307 test_usrp_rx::handle_response_recv_raw_samples(pmt_t data)
 308 {
 309   pmt_t invocation_handle = pmt_nth(0, data);
 310   pmt_t status = pmt_nth(1, data);
 311   pmt_t v_samples = pmt_nth(2, data);
 312   pmt_t timestamp = pmt_nth(3, data);
 313   pmt_t channel = pmt_nth(4, data);
 314   pmt_t properties = pmt_nth(5, data);
 315
 316   d_samples_recvd += pmt_length(v_samples) / 4;
 317
 318   // Check for overrun
 319   if(!pmt_is_dict(properties)) {
 320     std::cout << "[TEST_USRP_INBAND_RX] Recv samples dictionary is improper\n";
 321     return;
 322   }
 323
 324   // Check if the number samples we have received meets the test
 325   if(d_samples_recvd >= d_samples_to_recv) {
 326     d_rx->send(s_cmd_stop_recv_raw_samples, pmt_list2(PMT_NIL, d_rx_chan));
 327     enter_closing_channel();
 328     return;
 329   }
 330
 331 }
 332
 333 void
 334 test_usrp_rx::enter_closing_channel()
 335 {
 336   d_state = CLOSING_CHANNEL;
 337
 338   d_rx->send(s_cmd_deallocate_channel, pmt_list2(PMT_NIL, d_rx_chan));
 339
 340   if(verbose)
 341     std::cout << "[TEST_USRP_INBAND_RX] Deallocating RX channel\n";
 342 }
 343
 344 REGISTER_MBLOCK_CLASS(test_usrp_rx);
 345
 346
 347 // ----------------------------------------------------------------
 348
 349 int
 350 main (int argc, char **argv)
 351 {
 352   mb_runtime_sptr rt = mb_make_runtime();
 353   pmt_t result = PMT_NIL;
 354
 355   rt->run("top", "test_usrp_rx", PMT_F, &result);
 356
 357 }