<!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: darwin_libusb.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('darwin__libusb_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>darwin_libusb.h</h1> </div>
</div>
<div class="contents">
<a href="darwin__libusb_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 2006 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">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * The following code was taken from LIBUSB verion 0.1.10a,</span>
<a name="l00025"></a>00025 <span class="comment"> * and makes the fusb_darwin codes do-able in the current GR</span>
<a name="l00026"></a>00026 <span class="comment"> * programming framework. Parts and pieces were taken from</span>
<a name="l00027"></a>00027 <span class="comment"> * usbi.h, darwin.c, and error.h .</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * LIBUSB version 0.1.10a is covered by the LGPL, version 2;</span>
<a name="l00030"></a>00030 <span class="comment"> * These codes are used with permission from:</span>
<a name="l00031"></a>00031 <span class="comment"> * (c) 2000-2003 Johannes Erdfelt <johannes@erdfelt.com></span>
<a name="l00032"></a>00032 <span class="comment"> * (c) 2002-2005 Nathan Hjelm <hjelmn@users.sourceforge.net></span>
<a name="l00033"></a>00033 <span class="comment"> * All rights reserved.</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef __DARWIN_LIBUSB_H__</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define __DARWIN_LIBUSB_H__</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <IOKit/IOCFBundle.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <IOKit/IOCFPlugIn.h></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <IOKit/usb/IOUSBLib.h></span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <IOKit/IOKitLib.h></span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00045"></a>00045 <span class="keyword">static</span> <span class="keywordtype">char</span> *
<a name="l00046"></a><a class="code" href="darwin__libusb_8h.html#a9aef4fce569bc2edcd2b7c918620decf">00046</a> <a class="code" href="darwin__libusb_8h.html#a9aef4fce569bc2edcd2b7c918620decf">darwin_error_str</a> (<span class="keywordtype">int</span> result)
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keywordflow">switch</span> (result) {
<a name="l00049"></a>00049 <span class="keywordflow">case</span> kIOReturnSuccess:
<a name="l00050"></a>00050 <span class="keywordflow">return</span> <span class="stringliteral">"no error"</span>;
<a name="l00051"></a>00051 <span class="keywordflow">case</span> kIOReturnNotOpen:
<a name="l00052"></a>00052 <span class="keywordflow">return</span> <span class="stringliteral">"device not opened for exclusive access"</span>;
<a name="l00053"></a>00053 <span class="keywordflow">case</span> kIOReturnNoDevice:
<a name="l00054"></a>00054 <span class="keywordflow">return</span> <span class="stringliteral">"no connection to an IOService"</span>;
<a name="l00055"></a>00055 <span class="keywordflow">case</span> kIOUSBNoAsyncPortErr:
<a name="l00056"></a>00056 <span class="keywordflow">return</span> <span class="stringliteral">"no asyc port has been opened for interface"</span>;
<a name="l00057"></a>00057 <span class="keywordflow">case</span> kIOReturnExclusiveAccess:
<a name="l00058"></a>00058 <span class="keywordflow">return</span> <span class="stringliteral">"another process has device opened for exclusive access"</span>;
<a name="l00059"></a>00059 <span class="keywordflow">case</span> kIOUSBPipeStalled:
<a name="l00060"></a>00060 <span class="keywordflow">return</span> <span class="stringliteral">"pipe is stalled"</span>;
<a name="l00061"></a>00061 <span class="keywordflow">case</span> kIOReturnError:
<a name="l00062"></a>00062 <span class="keywordflow">return</span> <span class="stringliteral">"could not establish a connection to Darin kernel"</span>;
<a name="l00063"></a>00063 <span class="keywordflow">case</span> kIOReturnBadArgument:
<a name="l00064"></a>00064 <span class="keywordflow">return</span> <span class="stringliteral">"invalid argument"</span>;
<a name="l00065"></a>00065 <span class="keywordflow">default</span>:
<a name="l00066"></a>00066 <span class="keywordflow">return</span> <span class="stringliteral">"unknown error"</span>;
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">/* not a valid errorno outside darwin.c */</span>
<a name="l00071"></a><a class="code" href="darwin__libusb_8h.html#ad9ce9c713032316c91d3ca8a95e07518">00071</a> <span class="preprocessor">#define LUSBDARWINSTALL (ELAST+1)</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>
<a name="l00073"></a>00073 <span class="keyword">static</span> <span class="keywordtype">int</span>
<a name="l00074"></a><a class="code" href="darwin__libusb_8h.html#a5f142ddfbebbea7e1cbe3db4fc7fe418">00074</a> <a class="code" href="darwin__libusb_8h.html#a5f142ddfbebbea7e1cbe3db4fc7fe418">darwin_to_errno</a> (<span class="keywordtype">int</span> result)
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 <span class="keywordflow">switch</span> (result) {
<a name="l00077"></a>00077 <span class="keywordflow">case</span> kIOReturnSuccess:
<a name="l00078"></a>00078 <span class="keywordflow">return</span> 0;
<a name="l00079"></a>00079 <span class="keywordflow">case</span> kIOReturnNotOpen:
<a name="l00080"></a>00080 <span class="keywordflow">return</span> EBADF;
<a name="l00081"></a>00081 <span class="keywordflow">case</span> kIOReturnNoDevice:
<a name="l00082"></a>00082 <span class="keywordflow">case</span> kIOUSBNoAsyncPortErr:
<a name="l00083"></a>00083 <span class="keywordflow">return</span> ENXIO;
<a name="l00084"></a>00084 <span class="keywordflow">case</span> kIOReturnExclusiveAccess:
<a name="l00085"></a>00085 <span class="keywordflow">return</span> EBUSY;
<a name="l00086"></a>00086 <span class="keywordflow">case</span> kIOUSBPipeStalled:
<a name="l00087"></a>00087 <span class="keywordflow">return</span> <a class="code" href="darwin__libusb_8h.html#ad9ce9c713032316c91d3ca8a95e07518">LUSBDARWINSTALL</a>;
<a name="l00088"></a>00088 <span class="keywordflow">case</span> kIOReturnBadArgument:
<a name="l00089"></a>00089 <span class="keywordflow">return</span> EINVAL;
<a name="l00090"></a>00090 <span class="keywordflow">case</span> kIOReturnError:
<a name="l00091"></a>00091 <span class="keywordflow">default</span>:
<a name="l00092"></a>00092 <span class="keywordflow">return</span> 1;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296f">00096</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00097"></a><a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fafcf45746515fd9b279a99b3bd3987da8">00097</a> <a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fafcf45746515fd9b279a99b3bd3987da8">USB_ERROR_TYPE_NONE</a> = 0,
<a name="l00098"></a><a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fa6edb710e424b2ca4743f88b31e28f111">00098</a> <a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fa6edb710e424b2ca4743f88b31e28f111">USB_ERROR_TYPE_STRING</a>,
<a name="l00099"></a><a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fa3d28c6eb7560fdc1c02430168588b0c0">00099</a> <a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296fa3d28c6eb7560fdc1c02430168588b0c0">USB_ERROR_TYPE_ERRNO</a>,
<a name="l00100"></a>00100 } <a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296f">usb_error_type_t</a>;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">extern</span> <span class="keywordtype">char</span> <a class="code" href="darwin__libusb_8h.html#a5e5ca0e895551ecfc8a311e538e56e38">usb_error_str</a>[1024];
<a name="l00103"></a>00103 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="darwin__libusb_8h.html#a27960afa38d36b296d487a5aa0e0496c">usb_error_errno</a>;
<a name="l00104"></a>00104 <span class="keyword">extern</span> <a class="code" href="darwin__libusb_8h.html#a7ab53b8f90543f083c2dd1ca792c296f">usb_error_type_t</a> <a class="code" href="darwin__libusb_8h.html#aa4ff1dfa6329acc36ccbd7e17cc3da97">usb_error_type</a>;
<a name="l00105"></a>00105
<a name="l00106"></a><a class="code" href="darwin__libusb_8h.html#aee2e1933991308b6c53a58f359fc0337">00106</a> <span class="preprocessor">#define USB_ERROR(r, x) \</span>
<a name="l00107"></a>00107 <span class="preprocessor"> do { \</span>
<a name="l00108"></a>00108 <span class="preprocessor"> usb_error_type = USB_ERROR_TYPE_ERRNO; \</span>
<a name="l00109"></a>00109 <span class="preprocessor"> usb_error_errno = x; \</span>
<a name="l00110"></a>00110 <span class="preprocessor"> return r; \</span>
<a name="l00111"></a>00111 <span class="preprocessor"> } while (0)</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span>
<a name="l00113"></a><a class="code" href="darwin__libusb_8h.html#a91458181f6a0e61a1a81b135ced5aaa7">00113</a> <span class="preprocessor">#define USB_ERROR_STR(r, x, format, args...) \</span>
<a name="l00114"></a>00114 <span class="preprocessor"> do { \</span>
<a name="l00115"></a>00115 <span class="preprocessor"> usb_error_type = USB_ERROR_TYPE_STRING; \</span>
<a name="l00116"></a>00116 <span class="preprocessor"> snprintf(usb_error_str, sizeof(usb_error_str) - 1, format, ## args); \</span>
<a name="l00117"></a>00117 <span class="preprocessor"> if (usb_debug) \</span>
<a name="l00118"></a>00118 <span class="preprocessor"> fprintf(stderr, "USB error: %s\n", usb_error_str); \</span>
<a name="l00119"></a>00119 <span class="preprocessor"> return r; \</span>
<a name="l00120"></a>00120 <span class="preprocessor"> } while (0)</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span>
<a name="l00122"></a><a class="code" href="darwin__libusb_8h.html#afc11ef28456558a98899476aeab1e42b">00122</a> <span class="preprocessor">#define USB_ERROR_STR_ORIG(x, format, args...) \</span>
<a name="l00123"></a>00123 <span class="preprocessor"> do { \</span>
<a name="l00124"></a>00124 <span class="preprocessor"> usb_error_type = USB_ERROR_TYPE_STRING; \</span>
<a name="l00125"></a>00125 <span class="preprocessor"> snprintf(usb_error_str, sizeof(usb_error_str) - 1, format, ## args); \</span>
<a name="l00126"></a>00126 <span class="preprocessor"> if (usb_debug) \</span>
<a name="l00127"></a>00127 <span class="preprocessor"> fprintf(stderr, "USB error: %s\n", usb_error_str); \</span>
<a name="l00128"></a>00128 <span class="preprocessor"> return x; \</span>
<a name="l00129"></a>00129 <span class="preprocessor"> } while (0)</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span>
<a name="l00131"></a><a class="code" href="darwin__libusb_8h.html#a6c7a312a78f69953e39305ab222522ca">00131</a> <span class="preprocessor">#define USB_ERROR_STR_NO_RET(x, format, args...) \</span>
<a name="l00132"></a>00132 <span class="preprocessor"> do { \</span>
<a name="l00133"></a>00133 <span class="preprocessor"> usb_error_type = USB_ERROR_TYPE_STRING; \</span>
<a name="l00134"></a>00134 <span class="preprocessor"> snprintf(usb_error_str, sizeof(usb_error_str) - 1, format, ## args); \</span>
<a name="l00135"></a>00135 <span class="preprocessor"> if (usb_debug) \</span>
<a name="l00136"></a>00136 <span class="preprocessor"> fprintf(stderr, "USB error: %s\n", usb_error_str); \</span>
<a name="l00137"></a>00137 <span class="preprocessor"> } while (0)</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>
<a name="l00139"></a>00139 <span class="comment">/* simple function that figures out what pipeRef is associated with an endpoint */</span>
<a name="l00140"></a><a class="code" href="darwin__libusb_8h.html#a805f2ed6930d982da5ff72217848e26d">00140</a> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="darwin__libusb_8h.html#a805f2ed6930d982da5ff72217848e26d">ep_to_pipeRef</a> (<a class="code" href="structdarwin__dev__handle.html">darwin_dev_handle</a> *device, <span class="keywordtype">int</span> ep)
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142 <a class="code" href="fusb__darwin_8h.html#a33b766964215f52ef3eeae1397a3d244">io_return_t</a> ret;
<a name="l00143"></a>00143 UInt8 numep, direction, number;
<a name="l00144"></a>00144 UInt8 dont_care1, dont_care3;
<a name="l00145"></a>00145 UInt16 dont_care2;
<a name="l00146"></a>00146 <span class="keywordtype">int</span> i;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keywordflow">if</span> (usb_debug > 3)
<a name="l00149"></a>00149 fprintf(stderr, <span class="stringliteral">"Converting ep address to pipeRef.\n"</span>);
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="comment">/* retrieve the total number of endpoints on this interface */</span>
<a name="l00152"></a>00152 ret = (*(device-><a class="code" href="structdarwin__dev__handle.html#a24033b6bf2283cebd863675951365439">interface</a>))->GetNumEndpoints(device-><a class="code" href="structdarwin__dev__handle.html#a24033b6bf2283cebd863675951365439">interface</a>, &numep);
<a name="l00153"></a>00153 <span class="keywordflow">if</span> ( ret ) {
<a name="l00154"></a>00154 <span class="keywordflow">if</span> ( usb_debug > 3 )
<a name="l00155"></a>00155 fprintf ( stderr, <span class="stringliteral">"ep_to_pipeRef: interface is %p\n"</span>, device-><a class="code" href="structdarwin__dev__handle.html#a24033b6bf2283cebd863675951365439">interface</a> );
<a name="l00156"></a>00156 <a class="code" href="darwin__libusb_8h.html#afc11ef28456558a98899476aeab1e42b">USB_ERROR_STR_ORIG</a> ( -ret, <span class="stringliteral">"ep_to_pipeRef: can't get number of endpoints for interface"</span> );
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">/* iterate through the pipeRefs until we find the correct one */</span>
<a name="l00160"></a>00160 <span class="keywordflow">for</span> (i = 1 ; i <= numep ; i++) {
<a name="l00161"></a>00161 ret = (*(device-><a class="code" href="structdarwin__dev__handle.html#a24033b6bf2283cebd863675951365439">interface</a>))->GetPipeProperties(device-><a class="code" href="structdarwin__dev__handle.html#a24033b6bf2283cebd863675951365439">interface</a>, i, &direction, &number,
<a name="l00162"></a>00162 &dont_care1, &dont_care2, &dont_care3);
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keywordflow">if</span> (ret != kIOReturnSuccess) {
<a name="l00165"></a>00165 fprintf (stderr, <span class="stringliteral">"ep_to_pipeRef: an error occurred getting pipe information on pipe %d\n"</span>,
<a name="l00166"></a>00166 i );
<a name="l00167"></a>00167 <a class="code" href="darwin__libusb_8h.html#afc11ef28456558a98899476aeab1e42b">USB_ERROR_STR_ORIG</a> (-<a class="code" href="darwin__libusb_8h.html#a5f142ddfbebbea7e1cbe3db4fc7fe418">darwin_to_errno</a>(ret), <span class="stringliteral">"ep_to_pipeRef(GetPipeProperties): %s"</span>, <a class="code" href="darwin__libusb_8h.html#a9aef4fce569bc2edcd2b7c918620decf">darwin_error_str</a>(ret));
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="keywordflow">if</span> (usb_debug > 3)
<a name="l00171"></a>00171 fprintf (stderr, <span class="stringliteral">"ep_to_pipeRef: Pipe %i: DIR: %i number: %i\n"</span>, i, direction, number);
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="comment">/* calculate the endpoint of the pipe and check it versus the requested endpoint */</span>
<a name="l00174"></a>00174 <span class="keywordflow">if</span> ( ((direction << 7 & USB_ENDPOINT_DIR_MASK) | (number & USB_ENDPOINT_ADDRESS_MASK)) == ep ) {
<a name="l00175"></a>00175 <span class="keywordflow">if</span> (usb_debug > 3)
<a name="l00176"></a>00176 fprintf(stderr, <span class="stringliteral">"ep_to_pipeRef: pipeRef for ep address 0x%02x found: 0x%02x\n"</span>, ep, i);
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keywordflow">return</span> i;
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keywordflow">if</span> (usb_debug > 3)
<a name="l00183"></a>00183 fprintf(stderr, <span class="stringliteral">"ep_to_pipeRef: No pipeRef found with endpoint address 0x%02x.\n"</span>, ep);
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="comment">/* none of the found pipes match the requested endpoint */</span>
<a name="l00186"></a>00186 <span class="keywordflow">return</span> -1;
<a name="l00187"></a>00187 }
<a name="l00188"></a>00188
<a name="l00189"></a>00189 }
<a name="l00190"></a>00190 <span class="preprocessor">#endif </span><span class="comment">/* __DARWIN_LIBUSB_H__ */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="darwin__libusb_8h.html">darwin_libusb.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
3121
