aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/types/component_file.hpp35
1 files changed, 35 insertions, 0 deletions
diff --git a/host/include/uhd/types/component_file.hpp b/host/include/uhd/types/component_file.hpp
new file mode 100644
index 000000000..e0761fecb
--- /dev/null
+++ b/host/include/uhd/types/component_file.hpp
@@ -0,0 +1,35 @@
+//
+// Copyright 2017 Ettus Research, a National Instruments Company
+//
+// SPDX-License-Identifier: GPL-3.0
+//
+
+#ifndef INCLUDED_UHD_USRP_COMPONENT_FILE_HPP
+#define INCLUDED_UHD_USRP_COMPONENT_FILE_HPP
+
+#include <uhd/types/dict.hpp>
+#include <string>
+#include <vector>
+
+namespace uhd{ namespace usrp{
+
+ /*! Defines a file that can be sent using update_component
+ *
+ * \param metadata dictionary of strings that define the metadata
+ * associated with the file.
+ *
+ * Keys must include "id" and "filename", and may include an "md5" hash,
+ * as well as other, device- or component-specific keys.
+ *
+ * \param data the binary data file
+ *
+ * Can be the contents of the FPGA image file, for example.
+ */
+ struct component_file_t {
+ uhd::dict<std::string, std::string> metadata;
+ std::vector<uint8_t> data;
+ };
+
+}} // namespace uhd::usrp
+
+#endif /* INCLUDED_UHD_USRP_COMPONENT_FILE_HPP */