diff options
author | Ashish Chaudhari <ashish@ettus.com> | 2019-05-20 17:14:20 -0700 |
---|---|---|
committer | Martin Braun <martin.braun@ettus.com> | 2019-11-26 11:49:15 -0800 |
commit | 0b698810a163e3986939341fee5014fc6ad7e7f9 (patch) | |
tree | 22e2c122542928e29a2a0a8f6d383ad12e65b6a8 /host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp | |
parent | ad4004f1f78d5b64dae50b6e456d0206e824978f (diff) | |
download | uhd-0b698810a163e3986939341fee5014fc6ad7e7f9.tar.gz uhd-0b698810a163e3986939341fee5014fc6ad7e7f9.tar.bz2 uhd-0b698810a163e3986939341fee5014fc6ad7e7f9.zip |
rfnoc: Added impl for reg_iface and ctrl_endpoint
- Added new register_iface class that translates high-level
peek/poke calls into CHDR control payloads
- Added new chdr_ctrl_endpoint class that emulates a control
stream endpoint in SW. It can create and handle multiple
register interfaces
Diffstat (limited to 'host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp')
-rw-r--r-- | host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp b/host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp new file mode 100644 index 000000000..d135f284c --- /dev/null +++ b/host/lib/include/uhdlib/rfnoc/ctrlport_endpoint.hpp @@ -0,0 +1,61 @@ +// +// Copyright 2019 Ettus Research, a National Instruments Brand +// +// SPDX-License-Identifier: GPL-3.0-or-later +// + +#ifndef INCLUDED_LIBUHD_RFNOC_CTRLPORT_ENDPOINT_HPP +#define INCLUDED_LIBUHD_RFNOC_CTRLPORT_ENDPOINT_HPP + +#include <uhd/rfnoc/register_iface.hpp> +#include <uhdlib/rfnoc/chdr/chdr_types.hpp> +#include <memory> + +namespace uhd { namespace rfnoc { + +/*! A software interface that represents a ControlPort endpoint + * + * This interface supports the following: + * - All capabilities of register_iface + * - A function to handle received packets + * - A static factory class to create these endpoints + */ +class ctrlport_endpoint : public register_iface +{ +public: + using sptr = std::shared_ptr<ctrlport_endpoint>; + + //! The function to call when sending a packet to a remote device + using send_fn_t = std::function<void(const chdr::ctrl_payload&, double)>; + + virtual ~ctrlport_endpoint() = 0; + + //! Handles an incoming control packet (request and response) + // + // \param rx_ctrl The control payload of the received packet + // + virtual void handle_recv(const chdr::ctrl_payload& rx_ctrl) = 0; + + //! Creates a new register interface (ctrl_portendpoint) + // + // \param handle_send The function to call to send a control packet + // \param my_epid The endpoint ID of the SW control stream endpoint + // \param port The port number on the control crossbar + // \param buff_capacity The buffer capacity of the downstream buff in 32-bit words + // \param max_outstanding_async_msgs Max outstanding async messages allowed + // \param ctrl_clk_freq Frequency of the clock driving the ctrlport logic + // \param timebase_freq Frequency of the timebase (for timed commands) + // + static sptr make(const send_fn_t& handle_send, + sep_id_t my_epid, + uint16_t local_port, + size_t buff_capacity, + size_t max_outstanding_async_msgs, + double ctrl_clk_freq, + double timebase_freq); + +}; // class ctrlport_endpoint + +}} /* namespace uhd::rfnoc */ + +#endif /* INCLUDED_LIBUHD_RFNOC_CTRLPORT_ENDPOINT_HPP */ |