| USRP Hardware Driver and Device Manual Version: 4.10.0.0 UHD and USRP Manual |

Loading...
Searching...
No Matches
actions.hpp
Go to the documentation of this file.
1//
2// Copyright 2019 Ettus Research, a National Instruments Brand
3//
4// SPDX-License-Identifier: GPL-3.0-or-later
5//
6
7#pragma once
8
9#include <uhd/config.hpp>
10#include <uhd/types/device_addr.hpp>
11#include <uhd/types/metadata.hpp>
12#include <uhd/types/ranges.hpp>
13#include <uhd/types/stream_cmd.hpp>
14#include <uhd/types/time_spec.hpp>
15#include <uhd/types/tune_request.hpp>
16#include <uhd/types/tune_result.hpp>
17#include <boost/optional.hpp>
18#include <cstddef>
19#include <cstdint>
20#include <memory>
21#include <optional>
22#include <string>
23#include <vector>
24
25 namespace uhd { namespace rfnoc {
26
34 struct UHD_API action_info
35{
36 public:
37 virtual ~action_info() {}
38
39 using sptr = std::shared_ptr<action_info>;
41 const size_t id;
43 std::string key;
45 // (de-)serialize it.
46 std::vector<uint8_t> payload;
48 uhd::device_addr_t args;
49
51 static sptr make(const std::string& key = "",
52 const uhd::device_addr_t& args = uhd::device_addr_t(""));
53
54 protected:
55 action_info(
56 const std::string& key, const uhd::device_addr_t& args = uhd::device_addr_t(""));
57};
58
59 struct UHD_API stream_cmd_action_info : public action_info
60{
61 public:
62 using sptr = std::shared_ptr<stream_cmd_action_info>;
63
64 uhd::stream_cmd_t stream_cmd;
65
67 static sptr make(const uhd::stream_cmd_t::stream_mode_t stream_mode);
68
69 private:
70 stream_cmd_action_info(const uhd::stream_cmd_t::stream_mode_t stream_mode);
71};
72
73 struct UHD_API rx_event_action_info : public action_info
74{
75 public:
76 using sptr = std::shared_ptr<rx_event_action_info>;
77
79 uhd::rx_metadata_t::error_code_t error_code;
80
82 static sptr make(uhd::rx_metadata_t::error_code_t error_code);
83
84 protected:
85 rx_event_action_info(uhd::rx_metadata_t::error_code_t error_code);
86};
87
88 struct UHD_API tx_event_action_info : public action_info
89{
90 public:
91 using sptr = std::shared_ptr<tx_event_action_info>;
92
94 uhd::async_metadata_t::event_code_t event_code;
95
97 bool has_tsf;
98
100 uint64_t tsf;
101
103 static sptr make(uhd::async_metadata_t::event_code_t event_code,
104 const std::optional<uint64_t>& tsf);
105
107 //
108 // Required to avoid ambiguity between boost and std versions when using
109 // timestamp directly.
110 static sptr make(uhd::async_metadata_t::event_code_t event_code, uint64_t tsf);
111
113 [[deprecated("Prefer std::optional over boost::optional.")]] static sptr make(
114 uhd::async_metadata_t::event_code_t event_code,
115 const boost::optional<uint64_t>& tsf);
116
117 protected:
118 tx_event_action_info(uhd::async_metadata_t::event_code_t event_code,
119 const std::optional<uint64_t>& tsf);
120};
121
123 struct UHD_API tune_request_action_info : public action_info
124{
125 public:
126 using sptr = std::shared_ptr<tune_request_action_info>;
127
128 uhd::tune_request_t tune_request;
129 uhd::time_spec_t time_spec;
130 uhd::tune_result_t tune_result;
131 uhd::freq_range_t dsp_range;
132 uhd::freq_range_t rf_range;
133 uhd::freq_range_t overall_freq_range;
135 static sptr make(const uhd::tune_request_t tune_request);
136
137 private:
138 tune_request_action_info(const uhd::tune_request_t tune_request);
139};
140
141}} /* namespace uhd::rfnoc */
uhd::device_addr_t
Definition device_addr.hpp:39
uhd::time_spec_t
Definition time_spec.hpp:31
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
device_addr.hpp
metadata.hpp
uhd::rfnoc
Definition actions.hpp:25
uhd
Definition build_info.hpp:12
uhd::freq_range_t
meta_range_t freq_range_t
Definition ranges.hpp:171
ranges.hpp
stream_cmd.hpp
uhd::async_metadata_t::event_code_t
event_code_t
Definition metadata.hpp:216
uhd::rfnoc::action_info::payload
std::vector< uint8_t > payload
An arbitrary payload. It is up to consumers and producers to.
Definition actions.hpp:46
uhd::rfnoc::action_info::key
std::string key
A string identifier for this action.
Definition actions.hpp:43
uhd::rfnoc::action_info::~action_info
virtual ~action_info()
Definition actions.hpp:37
uhd::rfnoc::action_info::id
const size_t id
A unique counter for this action.
Definition actions.hpp:41
uhd::rfnoc::action_info::action_info
action_info(const std::string &key, const uhd::device_addr_t &args=uhd::device_addr_t(""))
uhd::rfnoc::action_info::sptr
std::shared_ptr< action_info > sptr
Definition actions.hpp:39
uhd::rfnoc::action_info::make
static sptr make(const std::string &key="", const uhd::device_addr_t &args=uhd::device_addr_t(""))
Factory function.
uhd::rfnoc::action_info::args
uhd::device_addr_t args
A dictionary of key-value pairs. May be used as desired.
Definition actions.hpp:48
uhd::rfnoc::rx_event_action_info::sptr
std::shared_ptr< rx_event_action_info > sptr
Definition actions.hpp:76
uhd::rfnoc::rx_event_action_info::make
static sptr make(uhd::rx_metadata_t::error_code_t error_code)
Factory function.
uhd::rfnoc::rx_event_action_info::rx_event_action_info
rx_event_action_info(uhd::rx_metadata_t::error_code_t error_code)
uhd::rfnoc::rx_event_action_info::error_code
uhd::rx_metadata_t::error_code_t error_code
The error code that describes the event.
Definition actions.hpp:79
uhd::rfnoc::stream_cmd_action_info::sptr
std::shared_ptr< stream_cmd_action_info > sptr
Definition actions.hpp:62
uhd::rfnoc::stream_cmd_action_info::make
static sptr make(const uhd::stream_cmd_t::stream_mode_t stream_mode)
Factory function.
uhd::rfnoc::stream_cmd_action_info::stream_cmd
uhd::stream_cmd_t stream_cmd
Definition actions.hpp:64
uhd::rfnoc::tune_request_action_info::make
static sptr make(const uhd::tune_request_t tune_request)
Factory function.
uhd::rfnoc::tune_request_action_info::overall_freq_range
uhd::freq_range_t overall_freq_range
Definition actions.hpp:133
uhd::rfnoc::tune_request_action_info::tune_request
uhd::tune_request_t tune_request
Definition actions.hpp:128
uhd::rfnoc::tune_request_action_info::time_spec
uhd::time_spec_t time_spec
Definition actions.hpp:129
uhd::rfnoc::tune_request_action_info::sptr
std::shared_ptr< tune_request_action_info > sptr
Definition actions.hpp:126
uhd::rfnoc::tune_request_action_info::rf_range
uhd::freq_range_t rf_range
Definition actions.hpp:132
uhd::rfnoc::tune_request_action_info::tune_result
uhd::tune_result_t tune_result
Definition actions.hpp:130
uhd::rfnoc::tune_request_action_info::dsp_range
uhd::freq_range_t dsp_range
Definition actions.hpp:131
uhd::rfnoc::tx_event_action_info::tx_event_action_info
tx_event_action_info(uhd::async_metadata_t::event_code_t event_code, const std::optional< uint64_t > &tsf)
uhd::rfnoc::tx_event_action_info::tsf
uint64_t tsf
When the async event occurred.
Definition actions.hpp:100
uhd::rfnoc::tx_event_action_info::make
static sptr make(uhd::async_metadata_t::event_code_t event_code, const boost::optional< uint64_t > &tsf)
Factory function (legacy, to support boost::optional).
uhd::rfnoc::tx_event_action_info::make
static sptr make(uhd::async_metadata_t::event_code_t event_code, const std::optional< uint64_t > &tsf)
Factory function.
uhd::rfnoc::tx_event_action_info::has_tsf
bool has_tsf
Has time specification?
Definition actions.hpp:97
uhd::rfnoc::tx_event_action_info::sptr
std::shared_ptr< tx_event_action_info > sptr
Definition actions.hpp:91
uhd::rfnoc::tx_event_action_info::event_code
uhd::async_metadata_t::event_code_t event_code
The event code that describes the event.
Definition actions.hpp:94
uhd::rfnoc::tx_event_action_info::make
static sptr make(uhd::async_metadata_t::event_code_t event_code, uint64_t tsf)
Factory function.
uhd::rx_metadata_t::error_code_t
error_code_t
Definition metadata.hpp:113
uhd::stream_cmd_t
Definition stream_cmd.hpp:42
uhd::stream_cmd_t::stream_mode_t
stream_mode_t
Definition stream_cmd.hpp:43
uhd::tune_request_t
Definition tune_request.hpp:25
uhd::tune_result_t
Definition tune_result.hpp:19
time_spec.hpp
tune_request.hpp
tune_result.hpp