git.gag.com Git - debian/gnuradio/blob - usrp2/host/lib/control.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008 Free Software Foundation, Inc.
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef INCLUDED_CONTROL_H
  20 #define INCLUDED_CONTROL_H
  21
  22 #include <omnithread.h>
  23 #include <usrp2_eth_packet.h>
  24
  25 namespace usrp2 {
  26   /*!
  27    * OP_CONFIG_RX_V2 command packet
  28    */
  29   struct op_config_rx_v2_cmd
  30   {
  31     u2_eth_packet_t   h;
  32     op_config_rx_v2_t op;
  33     op_generic_t      eop;
  34   };
  35
  36   struct op_start_rx_streaming_cmd
  37   {
  38     u2_eth_packet_t         h;
  39     op_start_rx_streaming_t op;
  40     op_generic_t            eop;
  41   };
  42
  43   struct op_stop_rx_cmd {
  44     u2_eth_packet_t h;
  45     op_generic_t    op;
  46     op_generic_t    eop;
  47   };
  48
  49   struct op_config_tx_v2_cmd
  50   {
  51     u2_eth_packet_t   h;
  52     op_config_tx_v2_t op;
  53     op_generic_t      eop;
  54   };
  55
  56   struct op_config_mimo_cmd
  57   {
  58     u2_eth_packet_t   h;
  59     op_config_mimo_t  op;
  60     op_generic_t      eop;
  61   };
  62
  63   struct op_burn_mac_addr_cmd
  64   {
  65     u2_eth_packet_t    h;
  66     op_burn_mac_addr_t op;
  67     op_generic_t       eop;
  68   };
  69
  70   struct op_dboard_info_cmd {
  71     u2_eth_packet_t h;
  72     op_generic_t    op;
  73     op_generic_t    eop;
  74   };
  75
  76
  77   /*!
  78    * Control mechanism to allow API calls to block waiting for reply packets
  79    */
  80   class pending_reply
  81   {
  82   private:
  83     unsigned int    d_rid;
  84     omni_mutex      d_mutex;
  85     omni_condition  d_cond;
  86     void           *d_buffer;
  87     size_t          d_len;
  88
  89   public:
  90     /*!
  91      * Construct a pending reply from the reply ID, response packet
  92      * buffer, and buffer length.
  93      */
  94     pending_reply(unsigned int rid, void *buffer, size_t len);
  95
  96     /*!
  97      * Destructor. Signals creating thread.
  98      */
  99     ~pending_reply();
 100
 101     /*!
 102      * Block, waiting for reply packet.
 103      * Returns: 1 = ok, reply packet in buffer
 104      *          0 = timeout
 105      */
 106     int wait(double secs);
 107
 108     /*!
 109      * Allows creating thread to resume after copying reply into buffer
 110      */
 111     void signal();
 112
 113     /*!
 114      * Retrieve pending reply ID
 115      */
 116     unsigned int rid() const { return d_rid; }
 117
 118     /*!
 119      * Retrieve destination buffer address
 120      */
 121     void *buffer() const { return d_buffer; }
 122
 123     /*!
 124      * Retrieve destination buffer length
 125      */
 126     size_t len() const { return d_len; }
 127   };
 128
 129 } // namespace usrp2
 130
 131 #endif /* INCLUDED_CONTROL_H */