/usr/share/doc/libftdi-dev/html/index.html is in libftdi-dev 0.20-4build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libftdi: libftdi API documentation</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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libftdi
 <span id="projectnumber">0.20</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">libftdi API documentation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Library to talk to FTDI chips. You find the latest versions of libftdi at <a href="http://www.intra2net.com/en/developer/libftdi/">http://www.intra2net.com/en/developer/libftdi/</a></p>
<p>The library is easy to use. Have a look at this short example: </p><div class="fragment"><div class="line"><span class="comment">/* simple.c</span></div><div class="line"><span class="comment"></span></div><div class="line"><span class="comment"> Simple libftdi usage example</span></div><div class="line"><span class="comment"></span></div><div class="line"><span class="comment"> This program is distributed under the GPL, version 2</span></div><div class="line"><span class="comment">*/</span></div><div class="line"></div><div class="line"><span class="preprocessor">#include <stdio.h></span></div><div class="line"><span class="preprocessor">#include <<a class="code" href="ftdi_8h.html">ftdi.h</a>></span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">void</span>)</div><div class="line">{</div><div class="line"> <span class="keywordtype">int</span> ret;</div><div class="line"> <span class="keyword">struct </span><a class="code" href="structftdi__context.html">ftdi_context</a> ftdic;</div><div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group__libftdi.html#ga21e2ed53cad4fa8242022afe1e12d2ee">ftdi_init</a>(&ftdic) < 0)</div><div class="line"> {</div><div class="line"> fprintf(stderr, <span class="stringliteral">"ftdi_init failed\n"</span>);</div><div class="line"> <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line"> }</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span> ((ret = <a class="code" href="group__libftdi.html#ga95d4689db18fc1fd70011f6504ab8c40">ftdi_usb_open</a>(&ftdic, 0x0403, 0x6001)) < 0)</div><div class="line"> {</div><div class="line"> fprintf(stderr, <span class="stringliteral">"unable to open ftdi device: %d (%s)\n"</span>, ret, <a class="code" href="group__libftdi.html#ga28c84d963760d7396e5a2992e63a9354">ftdi_get_error_string</a>(&ftdic));</div><div class="line"> <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line"> }</div><div class="line"></div><div class="line"> <span class="comment">// Read out FTDIChip-ID of R type chips</span></div><div class="line"> <span class="keywordflow">if</span> (ftdic.type == <a class="code" href="ftdi_8h.html#a026dc3f26fbc7f5ef67c75f0739385cea60949f421ca5df446c9fb4322093bc8a">TYPE_R</a>)</div><div class="line"> {</div><div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> chipid;</div><div class="line"> printf(<span class="stringliteral">"ftdi_read_chipid: %d\n"</span>, <a class="code" href="group__libftdi.html#gab978a76c2cc0dbfbc1fd6350db848300">ftdi_read_chipid</a>(&ftdic, &chipid));</div><div class="line"> printf(<span class="stringliteral">"FTDI chipid: %X\n"</span>, chipid);</div><div class="line"> }</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span> ((ret = <a class="code" href="group__libftdi.html#ga9536eff48c7ae9313b2a97320743ee3b">ftdi_usb_close</a>(&ftdic)) < 0)</div><div class="line"> {</div><div class="line"> fprintf(stderr, <span class="stringliteral">"unable to close ftdi device: %d (%s)\n"</span>, ret, <a class="code" href="group__libftdi.html#ga28c84d963760d7396e5a2992e63a9354">ftdi_get_error_string</a>(&ftdic));</div><div class="line"> <span class="keywordflow">return</span> EXIT_FAILURE;</div><div class="line"> }</div><div class="line"></div><div class="line"> <a class="code" href="group__libftdi.html#ga72838200be98d88737d532f9eee1e7be">ftdi_deinit</a>(&ftdic);</div><div class="line"></div><div class="line"> <span class="keywordflow">return</span> EXIT_SUCCESS;</div><div class="line">}</div></div><!-- fragment --><p>More examples can be found in the "examples" directory. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|