fpga load: Atomic updating of multiple components

- The MPM function update_component now accepts multiple components to
  be updated in one RPC call.
- Updated the property tree and image loader to match this change.
- Also added DTS loading to the image loader.

1 files changed, 75 insertions, 44 deletions

diff --git a/host/lib/usrp/mpmd/mpmd_image_loader.cpp b/host/lib/usrp/mpmd/mpmd_image_loader.cpp
index 4c73bc85f..e0b619cba 100644
--- a/host/lib/usrp/mpmd/mpmd_image_loader.cpp
+++ b/host/lib/usrp/mpmd/mpmd_image_loader.cpp
@@ -11,6 +11,7 @@
 #include <uhd/exception.hpp>
 #include <uhd/types/eeprom.hpp>
 #include <uhd/types/component_file.hpp>
+#include <boost/filesystem/convenience.hpp>
 #include <sstream>
 #include <string>
 #include <fstream>
@@ -23,6 +24,54 @@ namespace uhd{ namespace /*anon*/{
     const size_t MD5LEN = 32; // Length of a MD5 hash in chars
 
 /*
+ * Helper function to generate a component_file_t using the input ID and path to file.
+ */
+uhd::usrp::component_file_t generate_component(const std::string& id, const std::string& filepath) {
+    uhd::usrp::component_file_t component_file;
+    // Add an ID to the metadata
+    component_file.metadata["id"] = id;
+    UHD_LOG_TRACE("MPMD IMAGE LOADER",
+                  "Component ID added to the component dictionary: " << id);
+    // Add the filename to the metadata
+    // Remove the path to the filename
+    component_file.metadata["filename"] = boost::filesystem::path(filepath).filename().string();
+    UHD_LOG_TRACE("MPMD IMAGE LOADER",
+                  "Component filename added to the component dictionary: " << filepath);
+    // Add the hash, if a hash file exists
+    const std::string component_hash_filepath = filepath + ".md5";
+    std::ifstream component_hash_ifstream(component_hash_filepath.c_str(), std::ios::binary);
+    std::string component_hash;
+    if (component_hash_ifstream.is_open()) {
+        // TODO: Verify that the hash read is valid, ie only contains 0-9a-f.
+        component_hash.resize(MD5LEN);
+        component_hash_ifstream.read( &component_hash[0], MD5LEN );
+        component_hash_ifstream.close();
+        component_file.metadata["md5"] = component_hash;
+        UHD_LOG_TRACE("MPMD IMAGE LOADER",
+                      "Added component file hash to the component dictionary.");
+    } else {
+        // If there is no hash file, don't worry about it too much
+        UHD_LOG_DEBUG("MPMD IMAGE LOADER", "Could not open component file hash file: "
+                      << component_hash_filepath);
+    }
+
+    // Read the component file image into a structure suitable to sent as a binary string to MPM
+    std::vector<uint8_t> data;
+    std::ifstream component_ifstream(filepath.c_str(), std::ios::binary);
+    if (component_ifstream.is_open()) {
+        data.insert( data.begin(),
+                     std::istreambuf_iterator<char>(component_ifstream),
+                     std::istreambuf_iterator<char>());
+        component_ifstream.close();
+    } else {
+        const std::string err_msg("Component file does not exist: " + filepath);
+        throw uhd::runtime_error(err_msg);
+    }
+    component_file.data = data;
+    return component_file;
+}
+
+/*
  * Function to be registered with uhd_image_loader
  */
 static bool mpmd_image_loader(const image_loader::image_loader_args_t &image_loader_args){
@@ -41,56 +90,36 @@ static bool mpmd_image_loader(const image_loader::image_loader_args_t &image_loa
     uhd::device::sptr usrp = uhd::device::make(dev_addr, uhd::device::USRP);
     uhd::property_tree::sptr tree = usrp->get_tree();
 
-    // Populate the struct that we use to update the FPGA property
-    uhd::usrp::component_file_t component_file;
-    // Add an ID to the metadata
-    component_file.metadata["id"] = "fpga";
-    UHD_LOG_TRACE("MPMD IMAGE LOADER",
-                  "FPGA ID added to the component dictionary");
-    // Add the filename to the metadata
-    // TODO: Current this field is the absolute path on the host. We're letting MPM
-    //       handle cutting off the filename, but it would be better to just pass what we need to.
-    std::string fpga_filepath = image_loader_args.fpga_path;
-    component_file.metadata["filename"] = fpga_filepath;
-    UHD_LOG_TRACE("MPMD IMAGE LOADER",
-                  "FPGA filename added to the component dictionary: " << fpga_filepath);
-    // Add the hash, if a hash file exists
-    std::string fpga_hash_filepath = fpga_filepath + ".md5";
-    std::ifstream fpga_hash_ifstream(fpga_hash_filepath.c_str(), std::ios::binary);
-    std::string fpga_hash;
-    if (fpga_hash_ifstream.is_open()) {
-        // TODO: Verify that the hash read is valid, ie only contains 0-9a-f.
-        fpga_hash.resize(MD5LEN);
-        fpga_hash_ifstream.read( &fpga_hash[0], MD5LEN );
-        fpga_hash_ifstream.close();
-        component_file.metadata["md5"] = fpga_hash;
-        UHD_LOG_TRACE("MPMD IMAGE LOADER", "Added FPGA hash to the component dictionary.");
-    } else {
-        // If there is no hash file, don't worry about it too much
-        UHD_LOG_WARNING("MPMD IMAGE LOADER", "Could not open FPGA hash file: "
-                      << fpga_hash_filepath);
-    }
-
-    // Read the FPGA image into a structure suitable to sent as a binary string to MPM
+    // Generate the component files
     // TODO: We don't have a default image specified because the image will depend on the
     //       device and configuration. We'll probably want to fix this later, but it will
     //       depend on how uhd_images_downloader deposits files.
-    std::vector<uint8_t> data;
-    std::ifstream fpga_ifstream(fpga_filepath.c_str(), std::ios::binary);
-    if (fpga_ifstream.is_open()) {
-        data.insert( data.begin(),
-                     std::istreambuf_iterator<char>(fpga_ifstream),
-                     std::istreambuf_iterator<char>());
-        fpga_ifstream.close();
-    } else {
-        std::string err_msg("FPGA Bitfile does not exist. " + fpga_filepath);
+    uhd::usrp::component_files_t all_component_files;
+    // FPGA component struct
+    const std::string fpga_path = image_loader_args.fpga_path;
+    uhd::usrp::component_file_t comp_fpga = generate_component("fpga", fpga_path);
+    all_component_files.push_back(comp_fpga);
+    // DTS component struct
+    // First, we need to determine the name
+    const std::string base_name = boost::filesystem::change_extension(fpga_path, "").string();
+    if (base_name == fpga_path) {
+        const std::string err_msg("Can't cut extension from FPGA filename... " + fpga_path);
         throw uhd::runtime_error(err_msg);
     }
-    component_file.data = data;
-    UHD_LOG_TRACE("MPMD IMAGE LOADER", "FPGA image read from file.");
+    const std::string dts_path = base_name + ".dts";
+    // Then try to generate it
+    try {
+        uhd::usrp::component_file_t comp_dts = generate_component("dts", dts_path);
+        all_component_files.push_back(comp_dts);
+        UHD_LOG_TRACE("MPMD IMAGE LOADER", "FPGA and DTS images read from file.");
+    } catch (const uhd::runtime_error& ex) {
+        // If we can't find the DTS file, that's fine, continue without it
+        UHD_LOG_WARNING("MPMD IMAGE LOADER", ex.what());
+        UHD_LOG_TRACE("MPMD IMAGE LOADER", "FPGA images read from file.");
+    }
 
     // Call RPC to update the component
-    tree->access<uhd::usrp::component_file_t>("/mboards/0/components/fpga").set(component_file);
+    tree->access<uhd::usrp::component_files_t>("/mboards/0/components/fpga").set(all_component_files);
     UHD_LOG_TRACE("MPMD IMAGE LOADER", "Update component function succeeded.");
 
     return true;
@@ -99,7 +128,9 @@ static bool mpmd_image_loader(const image_loader::image_loader_args_t &image_loa
 
 UHD_STATIC_BLOCK(register_mpm_image_loader){
     // TODO: Update recovery instructions
-    std::string recovery_instructions = "Aborting. Your USRP MPM-enabled device will likely be unusable.";
+    const std::string recovery_instructions = "Aborting. Your USRP MPM-enabled device's update may or may not have\n"
+                                              "completed. The contents of the image files may have been corrupted.\n"
+                                              "Please verify those files as soon as possible.";
 
     //TODO: 'n3xx' doesn't really fit the MPM abstraction, but this is simpler for the time being
     image_loader::register_image_loader("n3xx", mpmd_image_loader, recovery_instructions);