Added uhd::image_loader class and uhd_image_loader utility

* Single class for loading firmware/FPGA images onto devices instead of multiple utilities
* Loading functions are registered for each device, corresponding to their --args="type=foo" name
* Deprecation warnings added to all product-specific image loading utilities

3 files changed, 76 insertions, 30 deletions

diff --git a/host/lib/usrp/e300/e300_common.cpp b/host/lib/usrp/e300/e300_common.cpp
index db5b37055..29117e21f 100644
--- a/host/lib/usrp/e300/e300_common.cpp
+++ b/host/lib/usrp/e300/e300_common.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Ettus Research LLC
+// Copyright 2014-2015 Ettus Research LLC
 //
 // 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
@@ -14,8 +14,12 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
+#include <uhd/image_loader.hpp>
 #include <uhd/utils/msg.hpp>
+#include <uhd/utils/paths.hpp>
+#include <uhd/utils/static.hpp>
 
+#include "e300_impl.hpp"
 #include "e300_fifo_config.hpp"
 #include "e300_fifo_config.hpp"
 
@@ -23,6 +27,7 @@
 
 #include <boost/filesystem.hpp>
 #include <fstream>
+#include <string>
 
 namespace uhd { namespace usrp { namespace e300 {
 
@@ -54,6 +59,34 @@ void load_fpga_image(const std::string &path)
     UHD_MSG(status) << " done" << std::endl;
 }
 
+static bool e300_image_loader(const image_loader::image_loader_args_t &image_loader_args) {
+    // Make sure this is an E3x0 and we don't want to use anything connected
+    uhd::device_addrs_t devs = e300_find(image_loader_args.args);
+    if(devs.size() == 0 or !image_loader_args.load_fpga) return false;
+
+    std::string fpga_filename, idle_image; // idle_image never used, just needed for function
+    if(image_loader_args.fpga_path == "") {
+        get_e3x0_fpga_images(devs[0], fpga_filename, idle_image);
+    }
+    else {
+        if(not boost::filesystem::exists(image_loader_args.fpga_path)) {
+            throw uhd::runtime_error(str(boost::format("The path \"%s\" does not exist.")
+                                         % image_loader_args.fpga_path));
+        }
+        else fpga_filename = image_loader_args.fpga_path;
+    }
+
+    load_fpga_image(fpga_filename);
+    return true;
+}
+
+UHD_STATIC_BLOCK(register_e300_image_loader) {
+    std::string recovery_instructions = "The default FPGA image will be loaded the next "
+                                        "time UHD uses this device.";
+
+    image_loader::register_image_loader("e3x0", e300_image_loader, recovery_instructions);
+}
+
 }
 
 }}}
diff --git a/host/lib/usrp/e300/e300_impl.cpp b/host/lib/usrp/e300/e300_impl.cpp
index de2357100..5e3f4c575 100644
--- a/host/lib/usrp/e300/e300_impl.cpp
+++ b/host/lib/usrp/e300/e300_impl.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2013-2014 Ettus Research LLC
+// Copyright 2013-2015 Ettus Research LLC
 //
 // 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
@@ -121,7 +121,7 @@ static bool is_loopback(const if_addrs_t &if_addrs)
        return if_addrs.inet == asio::ip::address_v4::loopback().to_string();
 }
 
-static device_addrs_t e300_find(const device_addr_t &multi_dev_hint)
+device_addrs_t e300_find(const device_addr_t &multi_dev_hint)
 {
     // handle multi device discovery
     device_addrs_t hints = separate_device_addr(multi_dev_hint);
@@ -268,6 +268,36 @@ static device::sptr e300_make(const device_addr_t &device_addr)
         return device::sptr(new e300_impl(device_addr));
 }
 
+// Common code used by e300_impl and e300_image_loader
+void get_e3x0_fpga_images(const uhd::device_addr_t &device_addr,
+                          std::string &fpga_image,
+                          std::string &idle_image){
+    const boost::uint16_t pid = boost::lexical_cast<boost::uint16_t>(
+            device_addr["product"]);
+
+    //extract the FPGA path for the e300
+    switch(e300_eeprom_manager::get_mb_type(pid)) {
+    case e300_eeprom_manager::USRP_E310_MB:
+        fpga_image = device_addr.cast<std::string>("fpga",
+            find_image_path(E310_FPGA_FILE_NAME));
+        idle_image = find_image_path(E310_FPGA_IDLE_FILE_NAME);
+        break;
+    case e300_eeprom_manager::USRP_E300_MB:
+        fpga_image = device_addr.cast<std::string>("fpga",
+            find_image_path(E300_FPGA_FILE_NAME));
+        idle_image = find_image_path(E300_FPGA_IDLE_FILE_NAME);
+        break;
+    case e300_eeprom_manager::UNKNOWN:
+    default:
+        UHD_MSG(warning) << "Unknown motherboard type, loading e300 image."
+                             << std::endl;
+        fpga_image = device_addr.cast<std::string>("fpga",
+            find_image_path(E300_FPGA_FILE_NAME));
+        idle_image = find_image_path(E300_FPGA_IDLE_FILE_NAME);
+        break;
+    }
+}
+
 /***********************************************************************
  * Structors
  **********************************************************************/
@@ -286,33 +316,10 @@ e300_impl::e300_impl(const uhd::device_addr_t &device_addr)
     if (_xport_path == AXI) {
         _do_not_reload = device_addr.has_key("no_reload_fpga");
         if (not _do_not_reload) {
-            // Load FPGA image if provided via args
-            const boost::uint16_t pid = boost::lexical_cast<boost::uint16_t>(
-                    device_addr["product"]);
-
             std::string fpga_image;
-
-            //extract the FPGA path for the e300
-            switch(e300_eeprom_manager::get_mb_type(pid)) {
-            case e300_eeprom_manager::USRP_E310_MB:
-                fpga_image = device_addr.cast<std::string>("fpga",
-                    find_image_path(E310_FPGA_FILE_NAME));
-                _idle_image = find_image_path(E310_FPGA_IDLE_FILE_NAME);
-                break;
-            case e300_eeprom_manager::USRP_E300_MB:
-                fpga_image = device_addr.cast<std::string>("fpga",
-                    find_image_path(E300_FPGA_FILE_NAME));
-                _idle_image = find_image_path(E300_FPGA_IDLE_FILE_NAME);
-                break;
-            case e300_eeprom_manager::UNKNOWN:
-            default:
-                UHD_MSG(warning) << "Unknown motherboard type, loading e300 image."
-                                     << std::endl;
-                fpga_image = device_addr.cast<std::string>("fpga",
-                    find_image_path(E300_FPGA_FILE_NAME));
-                _idle_image = find_image_path(E300_FPGA_IDLE_FILE_NAME);
-                break;
-            }
+            get_e3x0_fpga_images(device_addr,
+                                 fpga_image,
+                                 _idle_image);
             common::load_fpga_image(fpga_image);
         }
     }
diff --git a/host/lib/usrp/e300/e300_impl.hpp b/host/lib/usrp/e300/e300_impl.hpp
index c530a5d72..3ed133489 100644
--- a/host/lib/usrp/e300/e300_impl.hpp
+++ b/host/lib/usrp/e300/e300_impl.hpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2013-2014 Ettus Research LLC
+// Copyright 2013-2015 Ettus Research LLC
 //
 // 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
@@ -20,6 +20,7 @@
 
 #include <uhd/device.hpp>
 #include <uhd/property_tree.hpp>
+#include <uhd/types/device_addr.hpp>
 #include <uhd/usrp/subdev_spec.hpp>
 #include <uhd/usrp/mboard_eeprom.hpp>
 #include <uhd/usrp/dboard_eeprom.hpp>
@@ -28,6 +29,7 @@
 #include <uhd/types/sensors.hpp>
 #include <boost/weak_ptr.hpp>
 #include <boost/thread/mutex.hpp>
+#include <string>
 #include "e300_fifo_config.hpp"
 #include "radio_ctrl_core_3000.hpp"
 #include "rx_frontend_core_200.hpp"
@@ -98,6 +100,10 @@ static const size_t E300_R1_CTRL_STREAM    = (1 << 2) | E300_RADIO_DEST_PREFIX_C
 static const size_t E300_R1_TX_DATA_STREAM = (1 << 2) | E300_RADIO_DEST_PREFIX_TX;
 static const size_t E300_R1_RX_DATA_STREAM = (1 << 2) | E300_RADIO_DEST_PREFIX_RX;
 
+uhd::device_addrs_t e300_find(const uhd::device_addr_t &multi_dev_hint);
+void get_e3x0_fpga_images(const uhd::device_addr_t &device_args,
+                          std::string &fpga_image,
+                          std::string &idle_image);
 
 /*!
  * USRP-E300 implementation guts: