<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.2.2 C++ API: fusb.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <h1>fusb.h</h1><a href="fusb_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright 2003 Free Software Foundation, Inc.</span> <a name="l00004"></a>00004 <span class="comment"> * </span> <a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span> <a name="l00006"></a>00006 <span class="comment"> * </span> <a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span> <a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span> <a name="l00010"></a>00010 <span class="comment"> * any later version.</span> <a name="l00011"></a>00011 <span class="comment"> * </span> <a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"> * </span> <a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span> <a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span> <a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span> <a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span> <a name="l00021"></a>00021 <span class="comment"> */</span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="comment">// Fast USB interface</span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#ifndef _FUSB_H_</span> <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _FUSB_H_</span> <a name="l00027"></a>00027 <span class="preprocessor"></span> <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="keyword">struct </span><a class="code" href="structusb__dev__handle.html">usb_dev_handle</a>; <a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a>; <a name="l00031"></a>00031 <span class="comment"></span> <a name="l00032"></a>00032 <span class="comment">/*!</span> <a name="l00033"></a>00033 <span class="comment"> * \brief abstract usb device handle</span> <a name="l00034"></a>00034 <span class="comment"> */</span> <a name="l00035"></a><a class="code" href="classfusb__devhandle.html">00035</a> <span class="keyword">class </span><a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> { <a name="l00036"></a>00036 <span class="keyword">private</span>: <a name="l00037"></a>00037 <span class="comment">// NOT IMPLEMENTED</span> <a name="l00038"></a>00038 <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> (<span class="keyword">const</span> <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> &rhs); <span class="comment">// no copy constructor</span> <a name="l00039"></a>00039 <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> &operator= (<span class="keyword">const</span> <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> &rhs); <span class="comment">// no assignment operator</span> <a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="keyword">protected</span>: <a name="l00042"></a><a class="code" href="classfusb__devhandle.html#a2a884643edeb54d0a83852a76c913d34">00042</a> <a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *<a class="code" href="classfusb__devhandle.html#a2a884643edeb54d0a83852a76c913d34">d_udh</a>; <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="keyword">public</span>: <a name="l00045"></a>00045 <span class="comment">// CREATORS</span> <a name="l00046"></a>00046 <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> (<a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *udh); <a name="l00047"></a>00047 <span class="keyword">virtual</span> <a class="code" href="classfusb__devhandle.html#a38ff6460ad51e8443d3f2b797867c1b3">~fusb_devhandle</a> (); <a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="comment">// MANIPULATORS</span> <a name="l00050"></a>00050 <span class="comment"></span> <a name="l00051"></a>00051 <span class="comment"> /*!</span> <a name="l00052"></a>00052 <span class="comment"> * \brief return an ephandle of the correct subtype</span> <a name="l00053"></a>00053 <span class="comment"> */</span> <a name="l00054"></a>00054 <span class="keyword">virtual</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> *<a class="code" href="classfusb__devhandle.html#a9783b6b0082f783dc7638ff557998ff2" title="return an ephandle of the correct subtype">make_ephandle</a> (<span class="keywordtype">int</span> endpoint, <span class="keywordtype">bool</span> input_p, <a name="l00055"></a>00055 <span class="keywordtype">int</span> block_size = 0, <span class="keywordtype">int</span> nblocks = 0) = 0; <a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="comment">// ACCESSORS</span> <a name="l00058"></a><a class="code" href="classfusb__devhandle.html#a1efb2b5a5c155cb1cb7843cf9144d6f3">00058</a> <a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *<a class="code" href="classfusb__devhandle.html#a1efb2b5a5c155cb1cb7843cf9144d6f3">get_usb_dev_handle</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classfusb__devhandle.html#a2a884643edeb54d0a83852a76c913d34">d_udh</a>; } <a name="l00059"></a>00059 }; <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="comment"></span> <a name="l00062"></a>00062 <span class="comment">/*!</span> <a name="l00063"></a>00063 <span class="comment"> * \brief abstract usb end point handle</span> <a name="l00064"></a>00064 <span class="comment"> */</span> <a name="l00065"></a><a class="code" href="classfusb__ephandle.html">00065</a> <span class="keyword">class </span><a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> { <a name="l00066"></a>00066 <span class="keyword">private</span>: <a name="l00067"></a>00067 <span class="comment">// NOT IMPLEMENTED</span> <a name="l00068"></a>00068 <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> (<span class="keyword">const</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> &rhs); <span class="comment">// no copy constructor</span> <a name="l00069"></a>00069 <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> &operator= (<span class="keyword">const</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> &rhs); <span class="comment">// no assignment operator</span> <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="keyword">protected</span>: <a name="l00072"></a><a class="code" href="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">00072</a> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a136e1ab7ba9e180a78ea5085739dd018">d_endpoint</a>; <a name="l00073"></a><a class="code" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">00073</a> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle.html#a123fcada49a57077500fab084e537643">d_input_p</a>; <a name="l00074"></a><a class="code" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">00074</a> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">d_block_size</a>; <a name="l00075"></a><a class="code" href="classfusb__ephandle.html#a3d38bb3ad76925c044fe8e14ecb408e7">00075</a> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a3d38bb3ad76925c044fe8e14ecb408e7">d_nblocks</a>; <a name="l00076"></a><a class="code" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">00076</a> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle.html#ad6506c0efdf8eea1dcd8df8d65ecc609">d_started</a>; <a name="l00077"></a>00077 <a name="l00078"></a>00078 <span class="keyword">public</span>: <a name="l00079"></a>00079 <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> (<span class="keywordtype">int</span> endpoint, <span class="keywordtype">bool</span> input_p, <a name="l00080"></a>00080 <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c" title="returns current block size.">block_size</a> = 0, <span class="keywordtype">int</span> nblocks = 0); <a name="l00081"></a>00081 <span class="keyword">virtual</span> <a class="code" href="classfusb__ephandle.html#abda7e264c5e0bef062d3d356fb91e371">~fusb_ephandle</a> (); <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle.html#aac0498804e009ab78c47f2265f34a054" title="begin streaming i/o">start</a> () = 0; <span class="comment">//!< begin streaming i/o</span> <a name="l00084"></a>00084 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle.html#a3cfe2cbb78870a6ce0ec8f696ebe45ab" title="stop streaming i/o">stop</a> () = 0; <span class="comment">//!< stop streaming i/o</span> <a name="l00085"></a>00085 <span class="comment"></span><span class="comment"></span> <a name="l00086"></a>00086 <span class="comment"> /*!</span> <a name="l00087"></a>00087 <span class="comment"> * \returns \p nbytes if write was successfully enqueued, else -1.</span> <a name="l00088"></a>00088 <span class="comment"> * Will block if no free buffers available.</span> <a name="l00089"></a>00089 <span class="comment"> */</span> <a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#ab2a965c0f5fea6632bc08ea59c8c8fe1">write</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes) = 0; <a name="l00091"></a>00091 <span class="comment"></span> <a name="l00092"></a>00092 <span class="comment"> /*!</span> <a name="l00093"></a>00093 <span class="comment"> * \returns number of bytes read or -1 if error.</span> <a name="l00094"></a>00094 <span class="comment"> * number of bytes read will be <= nbytes.</span> <a name="l00095"></a>00095 <span class="comment"> * Will block if no input available.</span> <a name="l00096"></a>00096 <span class="comment"> */</span> <a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a835533e974fb159174c44f2ec0d5668d">read</a> (<span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes) = 0; <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="comment">/*</span> <a name="l00100"></a>00100 <span class="comment"> * block until all outstanding writes have completed</span> <a name="l00101"></a>00101 <span class="comment"> */</span> <a name="l00102"></a>00102 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfusb__ephandle.html#a1e1a2c7173a14aea99686fad7c0e061c">wait_for_completion</a> () = 0; <a name="l00103"></a>00103 <span class="comment"></span> <a name="l00104"></a>00104 <span class="comment"> /*!</span> <a name="l00105"></a>00105 <span class="comment"> * \brief returns current block size.</span> <a name="l00106"></a>00106 <span class="comment"> */</span> <a name="l00107"></a><a class="code" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c">00107</a> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c" title="returns current block size.">block_size</a> () { <span class="keywordflow">return</span> <a class="code" href="classfusb__ephandle.html#aa8b4afe1f6aaa45491d9ae0dfdad3c0b">d_block_size</a>; }; <a name="l00108"></a>00108 }; <a name="l00109"></a>00109 <a name="l00110"></a>00110 <span class="comment"></span> <a name="l00111"></a>00111 <span class="comment">/*!</span> <a name="l00112"></a>00112 <span class="comment"> * \brief factory for creating concrete instances of the appropriate subtype.</span> <a name="l00113"></a>00113 <span class="comment"> */</span> <a name="l00114"></a><a class="code" href="classfusb__sysconfig.html">00114</a> <span class="keyword">class </span><a class="code" href="classfusb__sysconfig.html" title="factory for creating concrete instances of the appropriate subtype.">fusb_sysconfig</a> { <a name="l00115"></a>00115 <span class="keyword">public</span>:<span class="comment"></span> <a name="l00116"></a>00116 <span class="comment"> /*!</span> <a name="l00117"></a>00117 <span class="comment"> * \brief returns fusb_devhandle or throws if trouble</span> <a name="l00118"></a>00118 <span class="comment"> */</span> <a name="l00119"></a>00119 <span class="keyword">static</span> <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> *<a class="code" href="classfusb__sysconfig.html#aa3a8167c5be4efef754899199b5f28bc" title="returns fusb_devhandle or throws if trouble">make_devhandle</a> (<a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *udh); <a name="l00120"></a>00120 <span class="comment"></span> <a name="l00121"></a>00121 <span class="comment"> /*!</span> <a name="l00122"></a>00122 <span class="comment"> * \brief Returns max block size in bytes (hard limit).</span> <a name="l00123"></a>00123 <span class="comment"> */</span> <a name="l00124"></a>00124 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__sysconfig.html#adced03bf847322237e9de5a7d3c9002c" title="Returns max block size in bytes (hard limit).">max_block_size</a> (); <a name="l00125"></a>00125 <span class="comment"></span> <a name="l00126"></a>00126 <span class="comment"> /*!</span> <a name="l00127"></a>00127 <span class="comment"> * \brief Returns default block size in bytes.</span> <a name="l00128"></a>00128 <span class="comment"> */</span> <a name="l00129"></a>00129 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__sysconfig.html#aa50e1bc9010bdcdd467437a55b29acfd" title="Returns default block size in bytes.">default_block_size</a> (); <a name="l00130"></a>00130 <span class="comment"></span> <a name="l00131"></a>00131 <span class="comment"> /*!</span> <a name="l00132"></a>00132 <span class="comment"> * \brief Returns the default buffer size in bytes.</span> <a name="l00133"></a>00133 <span class="comment"> */</span> <a name="l00134"></a>00134 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__sysconfig.html#a75ae14812778b32fa5ad2cf76257ef25" title="Returns the default buffer size in bytes.">default_buffer_size</a> (); <a name="l00135"></a>00135 <a name="l00136"></a>00136 }; <a name="l00137"></a>00137 <a name="l00138"></a>00138 <span class="preprocessor">#endif </span><span class="comment">/* _FUSB_H_ */</span> </pre></div></div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>