Imported Upstream version 3.2.2
[debian/gnuradio] / usrp / host / lib / legacy / fusb_generic.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2003 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef _FUSB_GENERIC_H_
24 #define _FUSB_GENERIC_H_
25
26 #include <fusb.h>
27
28 /*!
29  * \brief generic implementation of fusb_devhandle using only libusb
30  */
31 class fusb_devhandle_generic : public fusb_devhandle
32 {
33 public:
34   // CREATORS
35   fusb_devhandle_generic (usb_dev_handle *udh);
36   virtual ~fusb_devhandle_generic ();
37
38   // MANIPULATORS
39   virtual fusb_ephandle *make_ephandle (int endpoint, bool input_p,
40                                         int block_size = 0, int nblocks = 0);
41 };
42
43
44 /*!
45  * \brief generic implementation of fusb_ephandle using only libusb
46  */
47 class fusb_ephandle_generic : public fusb_ephandle
48 {
49 private:
50   fusb_devhandle_generic        *d_devhandle;
51   
52 public:
53   // CREATORS
54   fusb_ephandle_generic (fusb_devhandle_generic *dh, int endpoint, bool input_p,
55                          int block_size = 0, int nblocks = 0);
56   virtual ~fusb_ephandle_generic ();
57
58   // MANIPULATORS
59
60   virtual bool start ();        //!< begin streaming i/o
61   virtual bool stop ();         //!< stop streaming i/o
62
63   /*!
64    * \returns \p nbytes if write was successfully enqueued, else -1.
65    * Will block if no free buffers available.
66    */
67   virtual int write (const void *buffer, int nbytes);
68
69   /*!
70    * \returns number of bytes read or -1 if error.
71    * number of bytes read will be <= nbytes.
72    * Will block if no input available.
73    */
74   virtual int read (void *buffer, int nbytes);
75
76   /*
77    * block until all outstanding writes have completed
78    */
79   virtual void wait_for_completion () { };
80 };
81
82 #endif /* _FUSB_GENERIC_H_ */
83