blob: 3f6845ab28d9a4dc1c9614a72d2c301d4b1f82f3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
//
// Copyright 2010-2013 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#pragma once
#include <uhd/transport/usb_device_handle.hpp>
#include <uhd/transport/zero_copy.hpp>
#include <uhd/types/device_addr.hpp>
namespace uhd { namespace transport {
/*!
* A zero copy USB transport provides an efficient way to handle data.
* by avoiding the extra copy when recv() or send() is called on the handle.
* Rather, the zero copy transport gives the caller memory references.
* The caller informs the transport when it is finished with the reference.
*
* On Linux systems, the zero copy transport can use a kernel packet ring.
* If no platform specific solution is available, make returns a boost asio
* implementation that wraps functionality around standard send/recv calls.
*/
class UHD_API usb_zero_copy : public virtual zero_copy_if
{
public:
typedef std::shared_ptr<usb_zero_copy> sptr;
~usb_zero_copy(void) override;
/*!
* Make a new zero copy USB transport:
* This transport is for sending and receiving between the host
* and a pair of USB bulk transfer endpoints.
* The primary usage for this transport is data transactions.
* The underlying implementation may be platform specific.
*
* \param handle a device handle that uniquely identifying the device
* \param recv_interface an integer specifying an IN interface number
* \param recv_endpoint an integer specifying an IN endpoint number
* \param send_interface an integer specifying an OUT interface number
* \param send_endpoint an integer specifying an OUT endpoint number
* \param hints optional parameters to pass to the underlying transport
* \return a new zero copy USB object
*/
static sptr make(usb_device_handle::sptr handle,
const int recv_interface,
const unsigned char recv_endpoint,
const int send_interface,
const unsigned char send_endpoint,
const device_addr_t& hints = device_addr_t());
};
}} // namespace uhd::transport
|
