diff options
| author | Brent Stapleton <brent.stapleton@ettus.com> | 2018-02-01 14:31:57 -0800 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-02-19 16:58:52 -0800 |
| commit | 6ffe0cc5c8015ce581c9d689c07abb0de294f30e (patch) | |
| tree | ed54e352be60cc6696ddb61d705a79d4d9aeb8bc | |
| parent | e9288a439cb4c8d1a7a413d6e4c654fc5edfdad5 (diff) | |
| download | uhd-6ffe0cc5c8015ce581c9d689c07abb0de294f30e.tar.gz uhd-6ffe0cc5c8015ce581c9d689c07abb0de294f30e.tar.bz2 uhd-6ffe0cc5c8015ce581c9d689c07abb0de294f30e.zip | |
mpmd: components: Add doxygen for update component
Adding doxygen comment for _update_component in mpmd.
| -rw-r--r-- | host/lib/usrp/mpmd/mpmd_prop_tree.cpp | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/host/lib/usrp/mpmd/mpmd_prop_tree.cpp b/host/lib/usrp/mpmd/mpmd_prop_tree.cpp index 33ffde401..64e68c486 100644 --- a/host/lib/usrp/mpmd/mpmd_prop_tree.cpp +++ b/host/lib/usrp/mpmd/mpmd_prop_tree.cpp @@ -20,6 +20,12 @@ namespace { //! Timeout value for the update_component RPC call (ms) constexpr size_t MPMD_UPDATE_COMPONENT_TIMEOUT = 20000; + /*! Update a component using all required files. For example, when updating the FPGA image + * (.bit or .bin), users can provide a new overlay image (DTS) to apply in addition. + * + * \param comps Vector of component files to be updated + * \param mb Reference to the actual device + */ uhd::usrp::component_files_t _update_component( const uhd::usrp::component_files_t& comps, mpmd_mboard_impl *mb |