Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 9ecb760a948bc81e38dd7cfd8e85d12f > files > 50

bladerf-doc-2014.11-1.mga5.noarch.rpm

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>libbladeRF: Initialization/deinitialization</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://www.mathjax.org/mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo-padded.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">libbladeRF
   &#160;<span id="projectnumber">1.1.0</span>
   </div>
   <div id="projectbrief">Nuand bladeRF library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Initialization/deinitialization</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga71d5667028394cdb4ec7b5b9110834c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga71d5667028394cdb4ec7b5b9110834c7">BLADERF_SERIAL_LENGTH</a>&#160;&#160;&#160;33</td></tr>
<tr class="separator:ga71d5667028394cdb4ec7b5b9110834c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga3737a52a065ebc838adf4cf426b43fb2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga3737a52a065ebc838adf4cf426b43fb2">bladerf_backend</a> { <br/>
&#160;&#160;<a class="el" href="group___f_n___i_n_i_t.html#gga3737a52a065ebc838adf4cf426b43fb2a1e5ca662f4562769b577dbb85fb336ba">BLADERF_BACKEND_ANY</a>, 
<a class="el" href="group___f_n___i_n_i_t.html#gga3737a52a065ebc838adf4cf426b43fb2a79c8ac0135625e63f2238b0342671214">BLADERF_BACKEND_LINUX</a>, 
<a class="el" href="group___f_n___i_n_i_t.html#gga3737a52a065ebc838adf4cf426b43fb2a2e7d92fcca14217ed07d0d1f33ca4f8d">BLADERF_BACKEND_LIBUSB</a>, 
<a class="el" href="group___f_n___i_n_i_t.html#gga3737a52a065ebc838adf4cf426b43fb2aaabd6f3089e0b400f5372903be5e8f75">BLADERF_BACKEND_CYPRESS</a>, 
<br/>
&#160;&#160;<a class="el" href="group___f_n___i_n_i_t.html#gga3737a52a065ebc838adf4cf426b43fb2ab6439130f274706c0165f17fcdcce2b3">BLADERF_BACKEND_DUMMY</a> = 100
<br/>
 }</td></tr>
<tr class="separator:ga3737a52a065ebc838adf4cf426b43fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a3716d6cf5a1c25da8325fa245e92f9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga9a3716d6cf5a1c25da8325fa245e92f9">bladerf_dev_speed</a> { <b>BLADERF_DEVICE_SPEED_UNKNOWN</b>, 
<b>BLADERF_DEVICE_SPEED_HIGH</b>, 
<b>BLADERF_DEVICE_SPEED_SUPER</b>
 }</td></tr>
<tr class="separator:ga9a3716d6cf5a1c25da8325fa245e92f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga21537e871d943798142176d9a29a5c46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga21537e871d943798142176d9a29a5c46">bladerf_get_device_list</a> (struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> **devices)</td></tr>
<tr class="separator:ga21537e871d943798142176d9a29a5c46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1bf915af51bd39fa6c18e002d8bfc37a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> void <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga1bf915af51bd39fa6c18e002d8bfc37a">bladerf_free_device_list</a> (struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> *devices)</td></tr>
<tr class="separator:ga1bf915af51bd39fa6c18e002d8bfc37a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace4d5607aacba15ccd2d5361d5eb020e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#gace4d5607aacba15ccd2d5361d5eb020e">bladerf_open_with_devinfo</a> (struct bladerf **device, struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> *devinfo)</td></tr>
<tr class="separator:gace4d5607aacba15ccd2d5361d5eb020e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab341ac98615f393da9158ea59cdb6a24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#gab341ac98615f393da9158ea59cdb6a24">bladerf_open</a> (struct bladerf **device, const char *device_identifier)</td></tr>
<tr class="separator:gab341ac98615f393da9158ea59cdb6a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78676b94de9a8aae49d72a9ef2f0e4d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> void <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_n_i_t.html#ga78676b94de9a8aae49d72a9ef2f0e4d9">bladerf_close</a> (struct bladerf *device)</td></tr>
<tr class="separator:ga78676b94de9a8aae49d72a9ef2f0e4d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The functions in this section provide the ability query available devices, initialize them, and deinitialize them. They are not guaranteed to be thread-safe; the caller is responsible for ensuring they are executed atomically. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga71d5667028394cdb4ec7b5b9110834c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define BLADERF_SERIAL_LENGTH&#160;&#160;&#160;33</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Length of device serial number string, including NUL-terminator </p>

<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00131">131</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3737a52a065ebc838adf4cf426b43fb2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group___f_n___i_n_i_t.html#ga3737a52a065ebc838adf4cf426b43fb2">bladerf_backend</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Backend by which the host communicates with the device </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga3737a52a065ebc838adf4cf426b43fb2a1e5ca662f4562769b577dbb85fb336ba"></a>BLADERF_BACKEND_ANY</em>&#160;</td><td class="fielddoc">
<p>"Don't Care" &ndash; use any available backend </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga3737a52a065ebc838adf4cf426b43fb2a79c8ac0135625e63f2238b0342671214"></a>BLADERF_BACKEND_LINUX</em>&#160;</td><td class="fielddoc">
<p>Linux kernel driver </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga3737a52a065ebc838adf4cf426b43fb2a2e7d92fcca14217ed07d0d1f33ca4f8d"></a>BLADERF_BACKEND_LIBUSB</em>&#160;</td><td class="fielddoc">
<p>libusb </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga3737a52a065ebc838adf4cf426b43fb2aaabd6f3089e0b400f5372903be5e8f75"></a>BLADERF_BACKEND_CYPRESS</em>&#160;</td><td class="fielddoc">
<p>CyAPI </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga3737a52a065ebc838adf4cf426b43fb2ab6439130f274706c0165f17fcdcce2b3"></a>BLADERF_BACKEND_DUMMY</em>&#160;</td><td class="fielddoc">
<p>Dummy used for development purposes </p>
</td></tr>
</table>

<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00111">111</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>

</div>
</div>
<a class="anchor" id="ga9a3716d6cf5a1c25da8325fa245e92f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group___f_n___i_n_i_t.html#ga9a3716d6cf5a1c25da8325fa245e92f9">bladerf_dev_speed</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This enum describes the USB Speed at which the bladeRF is connected. Speeds not listed here are not supported. </p>

<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00124">124</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga78676b94de9a8aae49d72a9ef2f0e4d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> void <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_close </td>
          <td>(</td>
          <td class="paramtype">struct bladerf *&#160;</td>
          <td class="paramname"><em>device</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Close device</p>
<dl class="section note"><dt>Note</dt><dd>Failing to close a device will result in memory leaks.</dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>device is deallocated and may no longer be used.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">device</td><td>Device handle previously obtained by <a class="el" href="group___f_n___i_n_i_t.html#gab341ac98615f393da9158ea59cdb6a24">bladerf_open()</a>. This function does nothing if device is NULL. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga1bf915af51bd39fa6c18e002d8bfc37a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> void <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_free_device_list </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> *&#160;</td>
          <td class="paramname"><em>devices</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Free device list returned by <a class="el" href="group___f_n___i_n_i_t.html#ga21537e871d943798142176d9a29a5c46">bladerf_get_device_list()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">devices</td><td>List of available devices </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga21537e871d943798142176d9a29a5c46"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_get_device_list </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> **&#160;</td>
          <td class="paramname"><em>devices</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Obtain a list of bladeRF devices attached to the system</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">devices</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of items in returned device list, or value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>

</div>
</div>
<a class="anchor" id="gab341ac98615f393da9158ea59cdb6a24"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_open </td>
          <td>(</td>
          <td class="paramtype">struct bladerf **&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>device_identifier</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Open specified device using a device identifier string. See <a class="el" href="group___f_n___i_n_i_t.html#gace4d5607aacba15ccd2d5361d5eb020e">bladerf_open_with_devinfo()</a> if a device identifier string is not readily available.</p>
<p>The general form of the device identifier string is; </p>
<div class="fragment"><div class="line">&lt;backend&gt;:[device=&lt;bus&gt;:&lt;addr&gt;] [instance=&lt;n&gt;] [serial=&lt;serial&gt;]</div>
</div><!-- fragment --><p>An empty ("") or NULL device identifier will result in the first encountered device being opened (using the first discovered backend)</p>
<p>The 'backend' describes the mechanism used to communicate with the device, and may be one of the following:</p>
<ul>
<li>*: Any available backend</li>
<li>libusb: libusb (See libusb changelog notes for required version, given your OS and controller)</li>
<li>cypress: Cypress CyUSB/CyAPI backend (Windows only)</li>
</ul>
<p>If no arguments are provided after the backend, the first encountered device on the specified backend will be opened. Note that a backend is required, if any arguments are to be provided.</p>
<p>Next, any provided arguments are provide as used to find the desired device. Be sure not to over constrain the search. Generally, only one of the above is required &ndash; providing all of these may over constrain the search for the desired device (e.g., if a serial number matches, but not on the specified bus and address.)</p>
<ul>
<li>device=&lt;bus&gt;:&lt;addr&gt;<ul>
<li>Specifies USB bus and address. Decimal or hex prefixed by '0x' is permitted.</li>
</ul>
</li>
<li>instance=&lt;n&gt;<ul>
<li>Nth instance encountered, 0-indexed</li>
</ul>
</li>
<li>serial=&lt;serial&gt;<ul>
<li>Device's serial number.</li>
</ul>
</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">device</td><td>Update with device handle on success </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">device_identifier</td><td>Device identifier, formatted as described above</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>

</div>
</div>
<a class="anchor" id="gace4d5607aacba15ccd2d5361d5eb020e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_open_with_devinfo </td>
          <td>(</td>
          <td class="paramtype">struct bladerf **&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> *&#160;</td>
          <td class="paramname"><em>devinfo</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Opens device specified by provided <a class="el" href="structbladerf__devinfo.html">bladerf_devinfo</a> structure</p>
<p>This function is generally preferred over <a class="el" href="group___f_n___i_n_i_t.html#gab341ac98615f393da9158ea59cdb6a24">bladerf_open()</a> when a device identifier string is not already provided.</p>
<p>The most common uses of this function are to:</p>
<ul>
<li>Open a device based upon the results of <a class="el" href="group___f_n___i_n_i_t.html#ga21537e871d943798142176d9a29a5c46">bladerf_get_device_list()</a></li>
<li>Open a specific device based upon its serial number</li>
</ul>
<p>Below is an example of how to use this function to open a device with a specific serial number:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>bladerf * open_bladerf_from_serial(<span class="keyword">const</span> <span class="keywordtype">char</span> *serial)</div>
<div class="line">{</div>
<div class="line">    <span class="keywordtype">int</span> status;</div>
<div class="line">    <span class="keyword">struct </span>bladerf *dev;</div>
<div class="line">    <span class="keyword">struct </span><a class="code" href="structbladerf__devinfo.html">bladerf_devinfo</a> info;</div>
<div class="line"></div>
<div class="line">    <span class="comment">/* Initialize all fields to &quot;don&#39;t care&quot; wildcard values.</span></div>
<div class="line"><span class="comment">     *</span></div>
<div class="line"><span class="comment">     * Immediately passing this to bladerf_open_with_devinfo() would cause</span></div>
<div class="line"><span class="comment">     * libbladeRF to open any device on any available backend. */</span></div>
<div class="line">    <a class="code" href="group___f_n___d_e_v_i_n_f_o.html#ga3a046eac7a17ac794d50fbb2e086a136">bladerf_init_devinfo</a>(&amp;info);</div>
<div class="line"></div>
<div class="line">    <span class="comment">/* Specify the desired device&#39;s serial number, while leaving all other</span></div>
<div class="line"><span class="comment">     * fields in the info structure wildcard values */</span></div>
<div class="line">    strncpy(info.serial, serial, <a class="code" href="group___f_n___i_n_i_t.html#ga71d5667028394cdb4ec7b5b9110834c7">BLADERF_SERIAL_LENGTH</a> - 1);</div>
<div class="line">    info.serial[<a class="code" href="group___f_n___i_n_i_t.html#ga71d5667028394cdb4ec7b5b9110834c7">BLADERF_SERIAL_LENGTH</a> - 1] = <span class="charliteral">&#39;\0&#39;</span>;</div>
<div class="line"></div>
<div class="line">    status = <a class="code" href="group___f_n___i_n_i_t.html#gace4d5607aacba15ccd2d5361d5eb020e">bladerf_open_with_devinfo</a>(&amp;dev, &amp;info);</div>
<div class="line">    <span class="keywordflow">if</span> (status == <a class="code" href="group___r_e_t_c_o_d_e_s.html#gacce8c48adc27cfae9bf5958e7417ed8e">BLADERF_ERR_NODEV</a>) {</div>
<div class="line">        printf(<span class="stringliteral">&quot;No devices available with serial=%s\n&quot;</span>, serial);</div>
<div class="line">        <span class="keywordflow">return</span> NULL;</div>
<div class="line">    } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (status != 0) {</div>
<div class="line">        fprintf(stderr, <span class="stringliteral">&quot;Failed to open device with serial=%s (%s)\n&quot;</span>,</div>
<div class="line">                serial, <a class="code" href="group___f_n___m_i_s_c.html#ga689e0c91e6abb8b5575a929453e4dbcc">bladerf_strerror</a>(status));</div>
<div class="line">        <span class="keywordflow">return</span> NULL;</div>
<div class="line">    } <span class="keywordflow">else</span> {</div>
<div class="line">        <span class="keywordflow">return</span> dev;</div>
<div class="line">    }</div>
<div class="line">}</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">device</td><td>Update with device handle on success </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">devinfo</td><td>Device specification. If NULL, any available device will be opened.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Dec 23 2014 13:02:14 for libbladeRF by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>