Merged r9433:9527 from features/gr-usrp2 into trunk. Adds usrp2 and gr-usrp2 top...

[debian/gnuradio] / usrp2 / host / lib / control.h

diff --git a/usrp2/host/lib/control.h b/usrp2/host/lib/control.h
new file mode 100644 (file)
index 0000000..678f12e
--- /dev/null
+++ b/usrp2/host/lib/control.h
@@ -0,0 +1,117 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2008 Free Software Foundation, Inc.
+ *
+ * This program 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 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef INCLUDED_CONTROL_H
+#define INCLUDED_CONTROL_H
+
+#include <omnithread.h>
+#include <usrp2_eth_packet.h>
+
+namespace usrp2 {
+  /*!
+   * OP_CONFIG_RX_V2 command packet
+   */
+  struct op_config_rx_v2_cmd 
+  {
+    u2_eth_packet_t   h;
+    op_config_rx_v2_t op;
+    op_generic_t      eop;
+  };
+
+  struct op_start_rx_streaming_cmd 
+  {
+    u2_eth_packet_t        h;
+    op_start_rx_streaming_t op;
+    op_generic_t           eop;
+  };
+    
+  struct op_stop_rx_cmd {
+    u2_eth_packet_t h;
+    op_generic_t    op;
+    op_generic_t    eop;
+  };
+
+  struct op_config_tx_v2_cmd 
+  {
+    u2_eth_packet_t   h;
+    op_config_tx_v2_t op;
+    op_generic_t      eop;
+  };
+
+  struct op_burn_mac_addr_cmd 
+  {
+    u2_eth_packet_t    h;
+    op_burn_mac_addr_t op;
+    op_generic_t       eop;
+  };
+
+  /*!
+   * Control mechanism to allow API calls to block waiting for reply packets
+   */    
+  class pending_reply
+  {
+  private:
+    unsigned int    d_rid;
+    omni_mutex      d_mutex;
+    omni_condition  d_cond;
+    void           *d_buffer;
+    size_t         d_len;
+
+  public:  
+    /*!
+     * Construct a pending reply from the reply ID, response packet
+     * buffer, and buffer length.
+     */
+    pending_reply(unsigned int rid, void *buffer, size_t len);
+
+    /*!
+     * Destructor. Signals creating thread.
+     */
+    ~pending_reply();
+
+    /*!
+     * Block, waiting for reply packet.
+     * Returns: 1 = ok, reply packet in buffer
+     *          0 = timeout
+     */
+    int wait(double secs);
+
+    /*!
+     * Allows creating thread to resume after copying reply into buffer
+     */
+    void signal();
+
+    /*!
+     * Retrieve pending reply ID
+     */
+    unsigned int rid() const { return d_rid; }
+
+    /*!
+     * Retrieve destination buffer address
+     */
+    void *buffer() const { return d_buffer; }
+
+    /*!
+     * Retrieve destination buffer length
+     */
+    size_t len() const { return d_len; }
+  };
+  
+} // namespace usrp2
+
+#endif /* INCLUDED_CONTROL_H */