git.gag.com Git - debian/gnuradio/blob - usrp/host/lib/inband/usrp_server.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 2, 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 #include <usrp_server.h>
  26 #include <iostream>
  27 #include <usrp_inband_usb_packet.h>
  28 #include <mb_class_registry.h>
  29 #include <vector>
  30
  31 typedef usrp_inband_usb_packet transport_pkt;   // makes conversion to gigabit easy
  32
  33 // FIXME We should machine generate these by a simple preprocessor run over this file
  34 //
  35 // These are all the messages that we expect to receive.
  36 //
  37 // We "intern" these here (make them into symbols) so that our
  38 // comparisions below are effectively pointer comparisons.
  39
  40 static pmt_t s_cmd_allocate_channel = pmt_intern("cmd-allocate-channel");
  41 static pmt_t s_cmd_close = pmt_intern("cmd-close");
  42 static pmt_t s_cmd_deallocate_channel = pmt_intern("cmd-deallocate-channel");
  43 static pmt_t s_cmd_open = pmt_intern("cmd-open");
  44 static pmt_t s_cmd_start_recv_raw_samples = pmt_intern("cmd-start-recv-raw-samples");
  45 static pmt_t s_cmd_stop_recv_raw_samples = pmt_intern("cmd-stop-recv-raw-samples");
  46 static pmt_t s_cmd_to_control_channel = pmt_intern("cmd-to-control-channel");
  47 static pmt_t s_cmd_xmit_raw_frame  = pmt_intern("cmd-xmit-raw-frame");
  48 static pmt_t s_cmd_max_capacity  = pmt_intern("cmd-max-capacity");
  49 static pmt_t s_cmd_ntx_chan  = pmt_intern("cmd-ntx-chan");
  50 static pmt_t s_cmd_nrx_chan  = pmt_intern("cmd-nrx-chan");
  51 static pmt_t s_cmd_current_capacity_allocation  = pmt_intern("cmd-current-capacity-allocation");
  52 static pmt_t s_response_allocate_channel = pmt_intern("response-allocate-channel");
  53 static pmt_t s_response_close = pmt_intern("response-close");
  54 static pmt_t s_response_deallocate_channel = pmt_intern("response-deallocate-channel");
  55 static pmt_t s_response_from_control_channel = pmt_intern("response-from-control-channel");
  56 static pmt_t s_response_open = pmt_intern("response-open");
  57 static pmt_t s_response_recv_raw_samples = pmt_intern("response-recv-raw-samples");
  58 static pmt_t s_response_xmit_raw_frame = pmt_intern("response-xmit-raw-frame");
  59 static pmt_t s_response_max_capacity = pmt_intern("response-max-capacity");
  60 static pmt_t s_response_ntx_chan = pmt_intern("response-ntx-chan");
  61 static pmt_t s_response_nrx_chan = pmt_intern("response-nrx-chan");
  62 static pmt_t s_response_current_capacity_allocation  = pmt_intern("response-current-capacity-allocation");
  63
  64 static std::string
  65 str(long x)
  66 {
  67   std::ostringstream s;
  68   s << x;
  69   return s.str();
  70 }
  71
  72 usrp_server::usrp_server(mb_runtime *rt, const std::string &instance_name, pmt_t user_arg)
  73   : mb_mblock(rt, instance_name, user_arg)
  74 {
  75   // define our ports
  76
  77   // control & status port
  78   d_cs = define_port("cs", "usrp-server-cs", true, mb_port::EXTERNAL);
  79
  80   // ports
  81   //
  82   // (if/when we do replicated ports, these will be replaced by a
  83   //  single replicated port)
  84   for(int port=0; port < N_PORTS; port++) {
  85     d_tx.push_back(define_port("tx"+str(port), "usrp-tx", true, mb_port::EXTERNAL));
  86     d_rx.push_back(define_port("rx"+str(port), "usrp-rx", true, mb_port::EXTERNAL));
  87   }
  88
  89   // FIXME ... initializing to 2 channels on each for now, eventually we should
  90   // query the FPGA to get these values
  91   d_ntx_chan = 2;
  92   d_nrx_chan = 2;
  93
  94   // Initialize capacity on each channel to 0 and to no owner
  95   for(int chan=0; chan < d_ntx_chan; chan++) {
  96     d_chaninfo_tx[chan].assigned_capacity = 0;
  97     d_chaninfo_tx[chan].owner = PMT_NIL;
  98   }
  99   for(int chan=0; chan < d_nrx_chan; chan++) {
 100     d_chaninfo_rx[chan].assigned_capacity = 0;
 101     d_chaninfo_rx[chan].owner = PMT_NIL;
 102   }
 103 }
 104
 105 usrp_server::~usrp_server()
 106 {
 107 }
 108
 109
 110 void
 111 usrp_server::initial_transition()
 112 {
 113   // the initial transition
 114 }
 115
 116 void
 117 usrp_server::handle_message(mb_message_sptr msg)
 118 {
 119   pmt_t event = msg->signal();          // the "name" of the message
 120   pmt_t port_id = msg->port_id();       // which port it came in on
 121   pmt_t data = msg->data();
 122   pmt_t metadata = msg->metadata();
 123   pmt_t invocation_handle;
 124   pmt_t reply_data;
 125   pmt_t status;
 126
 127   if (1){
 128     std::cout << "[USRP_SERVER] event: " << event << std::endl;
 129     std::cout << "[USRP_SERVER] port_id: " << port_id << std::endl;
 130   }
 131
 132   // It would be nice if this were all table driven, and we could
 133   // compute our state transition as f(current_state, port_id, signal)
 134
 135   if (pmt_eq(port_id, d_cs->port_symbol())){    // message came in on our control/status port
 136
 137     if (pmt_eq(event, s_cmd_open)){
 138       // extract args from data
 139       invocation_handle = pmt_nth(0, data);
 140       long which_usrp = pmt_to_long(pmt_nth(1, data));  // integer usrp id, usually 0
 141
 142       // Do the right thing....
 143       // build a reply
 144
 145       // if everything OK
 146       status = PMT_T;
 147       reply_data = pmt_list2(invocation_handle, status);
 148
 149       //  ...and send it
 150       d_cs->send(s_response_open, reply_data);
 151       return;
 152     }
 153     else if (pmt_eq(event, s_cmd_close)){
 154       // ...
 155     }
 156     else if (pmt_eq(event, s_cmd_max_capacity)) {
 157       invocation_handle = pmt_nth(0, data);
 158       reply_data = pmt_list2(invocation_handle, pmt_from_long(max_capacity()));
 159       d_cs->send(s_response_max_capacity, reply_data);
 160       return;
 161     }
 162     else if (pmt_eq(event, s_cmd_ntx_chan)) {
 163       invocation_handle = pmt_nth(0, data);
 164       reply_data = pmt_list2(invocation_handle, pmt_from_long(d_ntx_chan));
 165       d_cs->send(s_response_ntx_chan, reply_data);
 166     }
 167     else if (pmt_eq(event, s_cmd_nrx_chan)) {
 168       invocation_handle = pmt_nth(0, data);
 169       reply_data = pmt_list2(invocation_handle, pmt_from_long(d_nrx_chan));
 170       d_cs->send(s_response_nrx_chan, reply_data);
 171     }
 172     else if (pmt_eq(event, s_cmd_current_capacity_allocation)) {
 173       invocation_handle = pmt_nth(0, data);
 174       reply_data = pmt_list2(invocation_handle, pmt_from_long(current_capacity_allocation()));
 175       d_cs->send(s_response_current_capacity_allocation, reply_data);
 176     }
 177     goto unhandled;
 178   }
 179
 180   if (pmt_eq(event, s_cmd_allocate_channel)){
 181     handle_cmd_allocate_channel(port_id, data);
 182     return;
 183   }
 184
 185   if (pmt_eq(event, s_cmd_deallocate_channel)) {
 186     handle_cmd_deallocate_channel(port_id, data);
 187     return;
 188   }
 189
 190   if (pmt_eq(event, s_cmd_xmit_raw_frame)){
 191     handle_cmd_xmit_raw_frame(data);
 192     return;
 193   }
 194
 195  unhandled:
 196   std::cout << "[USRP_SERVER] unhandled msg: " << msg << std::endl;
 197 }
 198
 199 // Return -1 if it is not an RX port, or an index
 200 int usrp_server::tx_port_index(pmt_t port_id) {
 201
 202   for(int i=0; i < (int) d_tx.size(); i++)
 203     if(pmt_eq(d_tx[i]->port_symbol(), port_id))
 204       return i;
 205
 206   return -1;
 207 }
 208
 209 // Return -1 if it is not an RX port, or an index
 210 int usrp_server::rx_port_index(pmt_t port_id) {
 211
 212   for(int i=0; i < (int) d_rx.size(); i++)
 213     if(pmt_eq(d_rx[i]->port_symbol(), port_id))
 214       return i;
 215
 216   return -1;
 217 }
 218
 219 // Go through all TX and RX channels, sum up the assigned capacity
 220 // and return it
 221 long usrp_server::current_capacity_allocation() {
 222   long capacity = 0;
 223
 224   for(int chan=0; chan < d_ntx_chan; chan++)
 225     capacity += d_chaninfo_tx[chan].assigned_capacity;
 226
 227   for(int chan=0; chan < d_nrx_chan; chan++)
 228     capacity += d_chaninfo_rx[chan].assigned_capacity;
 229
 230   return capacity;
 231 }
 232
 233 void usrp_server::handle_cmd_allocate_channel(pmt_t port_id, pmt_t data) {
 234
 235   pmt_t invocation_handle = pmt_nth(0, data);
 236   long rqstd_capacity = pmt_to_long(pmt_nth(1, data));
 237   long chan, port;
 238   pmt_t reply_data;
 239
 240   // If it's a TX port, allocate on a free channel, else check if it's a RX port
 241   // and allocate.
 242   if((port = tx_port_index(port_id)) != -1) {
 243
 244     // Check capacity exists
 245     if((D_USB_CAPACITY - current_capacity_allocation()) < rqstd_capacity) {
 246       reply_data = pmt_list3(invocation_handle, pmt_from_long(RQSTD_CAPACITY_UNAVAIL), PMT_NIL);  // no capacity available
 247       d_tx[port]->send(s_response_allocate_channel, reply_data);
 248       return;
 249     }
 250
 251     // Find a free channel, assign the capacity and respond
 252     for(chan=0; chan < d_ntx_chan; chan++) {
 253       if(d_chaninfo_tx[chan].owner == PMT_NIL) {
 254         d_chaninfo_tx[chan].owner = port_id;
 255         d_chaninfo_tx[chan].assigned_capacity = rqstd_capacity;
 256         reply_data = pmt_list3(invocation_handle, PMT_T, pmt_from_long(chan));
 257         d_tx[port]->send(s_response_allocate_channel, reply_data);
 258         return;
 259       }
 260     }
 261
 262     std::cout << "[USRP_SERVER] Couldnt find a TX chan\n";
 263
 264     reply_data = pmt_list3(invocation_handle, pmt_from_long(CHANNEL_UNAVAIL), PMT_NIL);  // no free TX chan found
 265     d_tx[port]->send(s_response_allocate_channel, reply_data);
 266     return;
 267   }
 268
 269   // Repeat the same process on the RX side if the port was not determined to be TX
 270   if((port = rx_port_index(port_id)) != -1) {
 271
 272     if((D_USB_CAPACITY - current_capacity_allocation()) < rqstd_capacity) {
 273       reply_data = pmt_list3(invocation_handle, pmt_from_long(RQSTD_CAPACITY_UNAVAIL), PMT_NIL);  // no capacity available
 274       d_rx[port]->send(s_response_allocate_channel, reply_data);
 275       return;
 276     }
 277
 278     for(chan=0; chan < d_nrx_chan; chan++) {
 279       if(d_chaninfo_rx[chan].owner == PMT_NIL) {
 280         d_chaninfo_rx[chan].owner = port_id;
 281         d_chaninfo_rx[chan].assigned_capacity = rqstd_capacity;
 282         reply_data = pmt_list3(invocation_handle, PMT_T, pmt_from_long(chan));
 283         d_rx[port]->send(s_response_allocate_channel, reply_data);
 284         return;
 285       }
 286     }
 287
 288     std::cout << "[USRP_SERVER] Couldnt find a RX chan\n";
 289     reply_data = pmt_list3(invocation_handle, pmt_from_long(CHANNEL_UNAVAIL), PMT_NIL);  // no free RX chan found
 290     d_rx[port]->send(s_response_allocate_channel, reply_data);
 291     return;
 292   }
 293 }
 294
 295 // Check the port type and deallocate assigned capacity based on this, ensuring
 296 // that the owner of the method invocation is the owner of the port and that
 297 // the channel number is valid.
 298 void usrp_server::handle_cmd_deallocate_channel(pmt_t port_id, pmt_t data) {
 299
 300   pmt_t invocation_handle = pmt_nth(0, data);
 301   long channel = pmt_to_long(pmt_nth(1, data));
 302   long port;
 303   pmt_t reply_data;
 304
 305   // Check that the channel number is valid, and that the calling port is the owner
 306   // of the channel, and if so remove the assigned capacity.
 307   if((port = tx_port_index(port_id)) != -1) {
 308
 309     if(channel >= d_ntx_chan) {
 310       reply_data = pmt_list2(invocation_handle, pmt_from_long(CHANNEL_INVALID));   // not a legit channel number
 311       d_tx[port]->send(s_response_deallocate_channel, reply_data);
 312       return;
 313     }
 314
 315     if(d_chaninfo_tx[channel].owner != port_id) {
 316       reply_data = pmt_list2(invocation_handle, pmt_from_long(PERMISSION_DENIED));   // not the owner of the port
 317       d_tx[port]->send(s_response_deallocate_channel, reply_data);
 318       return;
 319     }
 320
 321     d_chaninfo_tx[channel].assigned_capacity = 0;
 322     d_chaninfo_tx[channel].owner = PMT_NIL;
 323
 324     reply_data = pmt_list2(invocation_handle, PMT_T);
 325     d_tx[port]->send(s_response_deallocate_channel, reply_data);
 326     return;
 327   }
 328
 329   // Repeated process on the RX side
 330   if((port = rx_port_index(port_id)) != -1) {
 331
 332     if(channel >= d_nrx_chan) {
 333       reply_data = pmt_list2(invocation_handle, pmt_from_long(CHANNEL_INVALID));   // not a legit channel number
 334       d_rx[port]->send(s_response_deallocate_channel, reply_data);
 335       return;
 336     }
 337
 338     if(d_chaninfo_rx[channel].owner != port_id) {
 339       reply_data = pmt_list2(invocation_handle, pmt_from_long(PERMISSION_DENIED));   // not the owner of the port
 340       d_rx[port]->send(s_response_deallocate_channel, reply_data);
 341       return;
 342     }
 343
 344     d_chaninfo_rx[channel].assigned_capacity = 0;
 345     d_chaninfo_rx[channel].owner = PMT_NIL;
 346
 347     reply_data = pmt_list2(invocation_handle, PMT_T);
 348     d_rx[port]->send(s_response_deallocate_channel, reply_data);
 349     return;
 350   }
 351
 352 }
 353
 354 void usrp_server::handle_cmd_xmit_raw_frame(pmt_t data) {
 355
 356   size_t n_bytes, psize;
 357   long max_payload_len = transport_pkt::max_payload();
 358
 359   pmt_t invocation_handle = pmt_nth(0, data);
 360   long channel = pmt_to_long(pmt_nth(1, data));
 361   const void *samples = pmt_uniform_vector_elements(pmt_nth(2, data), n_bytes);
 362   long timestamp = pmt_to_long(pmt_nth(3, data));
 363
 364   // Determine the number of packets to allocate contiguous memory for bursting over the
 365   // USB and get a pointer to the memory to be used in building the packets
 366   long n_packets = static_cast<long>(std::ceil(n_bytes / (double)max_payload_len));
 367   pmt_t v_packets = pmt_make_u8vector(sizeof(transport_pkt) * n_packets, 0);
 368
 369   transport_pkt *pkts =
 370     (transport_pkt *) pmt_u8vector_writeable_elements(v_packets, psize);
 371
 372   for(int n=0; n < n_packets; n++) {
 373
 374     long payload_len = std::min((long)(n_bytes-(n*max_payload_len)), (long)max_payload_len);
 375
 376     if(n == 0) { // first packet gets start of burst flag and timestamp
 377       pkts[n].set_header(pkts[n].FL_START_OF_BURST, channel, 0, payload_len);
 378       pkts[n].set_timestamp(timestamp);
 379     } else {
 380       pkts[n].set_header(0, channel, 0, payload_len);
 381       pkts[n].set_timestamp(0xffffffff);
 382     }
 383
 384     memcpy(pkts[n].payload(), (uint8_t *)samples+(max_payload_len * n), payload_len);
 385   }
 386
 387   pkts[n_packets-1].set_end_of_burst();   // set the last packet's end of burst
 388
 389   // interface with the USRP to send the USB packet, since the memory is
 390   // contiguous, this should be a serious of memory copies to the bus, each being
 391   // USB_PKT_SIZE * MAX_PACKET_BURST bytes worth of data (given a full burst)
 392 }
 393
 394 REGISTER_MBLOCK_CLASS(usrp_server);