uhd/host/lib/image_loader.cpp
Nicholas Corgan 0595900ecc 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
2015-07-15 09:32:18 -07:00

87 lines
3.2 KiB
C++

//
// 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
// 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/>.
//
#include <iostream>
#include <map>
#include <utility>
#include <boost/filesystem.hpp>
#include <boost/foreach.hpp>
#include <boost/format.hpp>
#include <uhd/exception.hpp>
#include <uhd/image_loader.hpp>
#include <uhd/utils/log.hpp>
#include <uhd/utils/msg.hpp>
#include <uhd/utils/static.hpp>
namespace fs = boost::filesystem;
typedef std::map<std::string, uhd::image_loader::loader_fcn_t> loader_fcn_map_t;
typedef std::map<std::string, std::string> string_map_t;
// Nice typedefs for iterating over std::map
typedef std::pair<std::string, uhd::image_loader::loader_fcn_t> loader_fcn_pair_t;
typedef std::pair<std::string, std::string> string_pair_t;
UHD_SINGLETON_FCN(loader_fcn_map_t, get_image_loaders);
UHD_SINGLETON_FCN(string_map_t, get_recovery_strings);
/*
* Registration
*/
void uhd::image_loader::register_image_loader(const std::string &device_type,
const loader_fcn_t &loader_fcn,
const std::string &recovery_instructions){
UHD_LOGV(always) << "Registering image loader and recovery instructions for "
<< device_type << std::endl;
get_image_loaders().insert(loader_fcn_pair_t(device_type, loader_fcn));
get_recovery_strings().insert(string_pair_t(device_type, recovery_instructions));
}
/*
* Actual loading
*/
bool uhd::image_loader::load(const uhd::image_loader::image_loader_args_t &image_loader_args){
// If "type=foo" given in args, see if we have an image loader for that
if(image_loader_args.args.has_key("type")){
std::string type = image_loader_args.args.get("type");
if(get_image_loaders().find(type) == get_image_loaders().end()){
throw uhd::runtime_error(str(boost::format("There is no image loader registered for given type \"%s\".")
% type));
}
else return get_image_loaders().at(type)(image_loader_args);
}
else{
BOOST_FOREACH(const loader_fcn_pair_t &loader_fcn_pair, get_image_loaders()){
if(loader_fcn_pair.second(image_loader_args)) return true;
}
return false;
}
}
/*
* Get recovery instructions for particular device
*/
std::string uhd::image_loader::get_recovery_instructions(const std::string &device_type){
if(get_recovery_strings().count(device_type) == 0){
return "A firmware or FPGA loading process was interrupted by the user. This can leave your device in a non-working state.";
}
else return get_recovery_strings().at(device_type);
}