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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/* -*- c++ -*- */
/*
* Copyright 2003 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
// Fast USB interface
#ifndef _FUSB_H_
#define _FUSB_H_
struct libusb_device_handle;
struct libusb_context;
class fusb_ephandle;
/*!
* \brief abstract usb device handle
*/
class fusb_devhandle {
private:
// NOT IMPLEMENTED
fusb_devhandle (const fusb_devhandle &rhs); // no copy constructor
fusb_devhandle &operator= (const fusb_devhandle &rhs); // no assignment operator
protected:
libusb_device_handle *d_udh;
public:
// CREATORS
fusb_devhandle (libusb_device_handle *udh);
virtual ~fusb_devhandle ();
// MANIPULATORS
/*!
* \brief return an ephandle of the correct subtype
*/
virtual fusb_ephandle *make_ephandle (int endpoint, bool input_p,
int block_size = 0, int nblocks = 0) = 0;
// ACCESSORS
libusb_device_handle *get_libusb_device_handle () const { return d_udh; }
};
/*!
* \brief abstract usb end point handle
*/
class fusb_ephandle {
private:
// NOT IMPLEMENTED
fusb_ephandle (const fusb_ephandle &rhs); // no copy constructor
fusb_ephandle &operator= (const fusb_ephandle &rhs); // no assignment operator
protected:
int d_endpoint;
bool d_input_p;
int d_block_size;
int d_nblocks;
bool d_started;
public:
fusb_ephandle (int endpoint, bool input_p,
int block_size = 0, int nblocks = 0);
virtual ~fusb_ephandle ();
virtual bool start () = 0; //!< begin streaming i/o
virtual bool stop () = 0; //!< stop streaming i/o
/*!
* \returns \p nbytes if write was successfully enqueued, else -1.
* Will block if no free buffers available.
*/
virtual int write (const void *buffer, int nbytes) = 0;
/*!
* \returns number of bytes read or -1 if error.
* number of bytes read will be <= nbytes.
* Will block if no input available.
*/
virtual int read (void *buffer, int nbytes) = 0;
/*
* block until all outstanding writes have completed
*/
virtual void wait_for_completion () = 0;
/*!
* \brief returns current block size.
*/
int block_size () { return d_block_size; };
};
/*!
* \brief factory for creating concrete instances of the appropriate subtype.
*/
class fusb_sysconfig {
public:
/*!
* \brief returns fusb_devhandle or throws if trouble
*/
static fusb_devhandle *make_devhandle (libusb_device_handle *udh,
libusb_context *ctx);
/*!
* \brief Returns max block size in bytes (hard limit).
*/
static int max_block_size ();
/*!
* \brief Returns default block size in bytes.
*/
static int default_block_size ();
/*!
* \brief Returns the default buffer size in bytes.
*/
static int default_buffer_size ();
};
#endif /* _FUSB_H_ */
|
