<!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_linux.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_linux.h</h1><a href="fusb__linux_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_LINUX_H_</span> <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _FUSB_LINUX_H_</span> <a name="l00027"></a>00027 <span class="preprocessor"></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="fusb_8h.html">fusb.h</a>></span> <a name="l00029"></a>00029 <span class="preprocessor">#include <list></span> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">struct </span>usbdevfs_urb; <a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classfusb__ephandle__linux.html" title="linux specific implementation of fusb_ephandle using usbdevice_fs">fusb_ephandle_linux</a>; <a name="l00033"></a>00033 <span class="comment"></span> <a name="l00034"></a>00034 <span class="comment">/*!</span> <a name="l00035"></a>00035 <span class="comment"> * \brief linux specific implementation of fusb_devhandle using usbdevice_fs</span> <a name="l00036"></a>00036 <span class="comment"> */</span> <a name="l00037"></a><a class="code" href="classfusb__devhandle__linux.html">00037</a> <span class="keyword">class </span><a class="code" href="classfusb__devhandle__linux.html" title="linux specific implementation of fusb_devhandle using usbdevice_fs">fusb_devhandle_linux</a> : <span class="keyword">public</span> <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a> { <a name="l00038"></a>00038 <span class="keyword">private</span>: <a name="l00039"></a>00039 std::list<usbdevfs_urb*> d_pending_rqsts; <a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="keywordtype">void</span> pending_add (usbdevfs_urb *urb); <a name="l00042"></a>00042 <span class="keywordtype">bool</span> pending_remove (usbdevfs_urb *urb); <a name="l00043"></a>00043 usbdevfs_urb * pending_get (); <a name="l00044"></a>00044 <a name="l00045"></a>00045 <a name="l00046"></a>00046 <span class="keyword">public</span>: <a name="l00047"></a>00047 <span class="comment">// CREATORS</span> <a name="l00048"></a>00048 <a class="code" href="classfusb__devhandle__linux.html#a7ec9b566290422e0e426c6506f7aabab">fusb_devhandle_linux</a> (<a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *udh); <a name="l00049"></a>00049 <span class="keyword">virtual</span> <a class="code" href="classfusb__devhandle__linux.html#ac9802eeef9d0a420292c8a9baab6c416">~fusb_devhandle_linux</a> (); <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="comment">// MANIPULATORS</span> <a name="l00052"></a>00052 <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__linux.html#ad3af5756670554fff364591ae626e67d" 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="l00053"></a>00053 <span class="keywordtype">int</span> block_size = 0, <span class="keywordtype">int</span> nblocks = 0); <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="comment">// internal use only</span> <a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="classfusb__devhandle__linux.html#ad35214661f5e6fe85a34008e760fa49f">_submit_urb</a> (usbdevfs_urb *urb); <a name="l00057"></a>00057 <span class="keywordtype">bool</span> <a class="code" href="classfusb__devhandle__linux.html#aca4c020c61d55dd5948b487305debe68">_cancel_urb</a> (usbdevfs_urb *urb); <a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="classfusb__devhandle__linux.html#ac2e57831b7cf37e533f1c56a7ecb452f">_cancel_pending_rqsts</a> (<a class="code" href="classfusb__ephandle__linux.html" title="linux specific implementation of fusb_ephandle using usbdevice_fs">fusb_ephandle_linux</a> *eph); <a name="l00059"></a>00059 <span class="keywordtype">bool</span> <a class="code" href="classfusb__devhandle__linux.html#a9825994b3a8346f1a8284de755f1d6e0">_reap</a> (<span class="keywordtype">bool</span> ok_to_block_p); <a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="classfusb__devhandle__linux.html#addd226a9f8221e6742551ea8171b35a6">_wait_for_completion</a> (); <a name="l00061"></a>00061 }; <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="comment">/*!</span> <a name="l00064"></a>00064 <span class="comment"> * \brief linux specific implementation of fusb_ephandle using usbdevice_fs</span> <a name="l00065"></a>00065 <span class="comment"> */</span> <a name="l00066"></a>00066 <a name="l00067"></a><a class="code" href="classfusb__ephandle__linux.html">00067</a> <span class="keyword">class </span><a class="code" href="classfusb__ephandle__linux.html" title="linux specific implementation of fusb_ephandle using usbdevice_fs">fusb_ephandle_linux</a> : <span class="keyword">public</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> { <a name="l00068"></a>00068 <span class="keyword">private</span>: <a name="l00069"></a>00069 <a class="code" href="classfusb__devhandle__linux.html" title="linux specific implementation of fusb_devhandle using usbdevice_fs">fusb_devhandle_linux</a> *d_devhandle; <a name="l00070"></a>00070 std::list<usbdevfs_urb*> d_free_list; <a name="l00071"></a>00071 std::list<usbdevfs_urb*> d_completed_list; <a name="l00072"></a>00072 usbdevfs_urb *d_write_work_in_progress; <a name="l00073"></a>00073 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_write_buffer; <a name="l00074"></a>00074 usbdevfs_urb *d_read_work_in_progress; <a name="l00075"></a>00075 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_read_buffer; <a name="l00076"></a>00076 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_read_buffer_end; <a name="l00077"></a>00077 <a name="l00078"></a>00078 usbdevfs_urb *get_write_work_in_progress (); <a name="l00079"></a>00079 <span class="keywordtype">void</span> reap_complete_writes (); <a name="l00080"></a>00080 <span class="keywordtype">bool</span> reload_read_buffer (); <a name="l00081"></a>00081 <span class="keywordtype">bool</span> submit_urb (usbdevfs_urb *urb); <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="keyword">public</span>: <a name="l00084"></a>00084 <a class="code" href="classfusb__ephandle__linux.html#af7000716d3733e2b4b3ed6510fd7ebcd">fusb_ephandle_linux</a> (<a class="code" href="classfusb__devhandle__linux.html" title="linux specific implementation of fusb_devhandle using usbdevice_fs">fusb_devhandle_linux</a> *dh, <span class="keywordtype">int</span> endpoint, <span class="keywordtype">bool</span> input_p, <a name="l00085"></a>00085 <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="l00086"></a>00086 <span class="keyword">virtual</span> <a class="code" href="classfusb__ephandle__linux.html#a5664954fd3942978fc5edffbf90c0e6b">~fusb_ephandle_linux</a> (); <a name="l00087"></a>00087 <a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle__linux.html#ad3b4fd0fe703bfc41b9450109270c3a8" title="begin streaming i/o">start</a> (); <span class="comment">//!< begin streaming i/o</span> <a name="l00089"></a>00089 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle__linux.html#affb663e8d315ac1cec6ed3a2b899117d" title="stop streaming i/o">stop</a> (); <span class="comment">//!< stop streaming i/o</span> <a name="l00090"></a>00090 <span class="comment"></span><span class="comment"></span> <a name="l00091"></a>00091 <span class="comment"> /*!</span> <a name="l00092"></a>00092 <span class="comment"> * \returns \p nbytes if write was successfully enqueued, else -1.</span> <a name="l00093"></a>00093 <span class="comment"> * Will block if no free buffers available.</span> <a name="l00094"></a>00094 <span class="comment"> */</span> <a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle__linux.html#ab4965dbc78419694a0e944b2c13025a9">write</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes); <a name="l00096"></a>00096 <span class="comment"></span> <a name="l00097"></a>00097 <span class="comment"> /*!</span> <a name="l00098"></a>00098 <span class="comment"> * \returns number of bytes read or -1 if error.</span> <a name="l00099"></a>00099 <span class="comment"> * number of bytes read will be <= nbytes.</span> <a name="l00100"></a>00100 <span class="comment"> * Will block if no input available.</span> <a name="l00101"></a>00101 <span class="comment"> */</span> <a name="l00102"></a>00102 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle__linux.html#af6f9efb9b0e5a84d90127752c5ffbdf4">read</a> (<span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes); <a name="l00103"></a>00103 <a name="l00104"></a>00104 <span class="comment">/*</span> <a name="l00105"></a>00105 <span class="comment"> * block until all outstanding writes have completed</span> <a name="l00106"></a>00106 <span class="comment"> */</span> <a name="l00107"></a>00107 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfusb__ephandle__linux.html#afb983ac99b988c8da1fb1beffcafe2f4">wait_for_completion</a> (); <a name="l00108"></a>00108 <a name="l00109"></a>00109 <span class="comment">// internal use only</span> <a name="l00110"></a>00110 <span class="keywordtype">void</span> <a class="code" href="classfusb__ephandle__linux.html#a57c578355685f5b86d976c2204f38f36">free_list_add</a> (usbdevfs_urb *urb); <a name="l00111"></a>00111 <span class="keywordtype">void</span> <a class="code" href="classfusb__ephandle__linux.html#a5d4f19af3499104c7e146d61afc3cbd5">completed_list_add</a> (usbdevfs_urb *urb); <a name="l00112"></a>00112 usbdevfs_urb *<a class="code" href="classfusb__ephandle__linux.html#aa5e5ca23fe068342cdfa873f824d8451">free_list_get</a> (); <span class="comment">// pop and return head of list or 0</span> <a name="l00113"></a>00113 usbdevfs_urb *<a class="code" href="classfusb__ephandle__linux.html#a0ec691b828f3f76621e986c9544baaff">completed_list_get</a> (); <span class="comment">// pop and return head of list or 0</span> <a name="l00114"></a>00114 }; <a name="l00115"></a>00115 <a name="l00116"></a>00116 <span class="preprocessor">#endif </span><span class="comment">/* _FUSB_LINUX_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>