OpenCores
URL https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk

Subversion Repositories usb_fpga_2_14

[/] [usb_fpga_2_14/] [trunk/] [docs/] [c/] [html/] [index.html] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 ZTEX 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 
<html xmlns="http://www.w3.org/1999/xhtml">
3 
<head>
4 
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 
<meta name="generator" content="Doxygen 1.8.8"/>
7 
<title>ZTEX core API for C: Main Page</title>
8 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9 
<script type="text/javascript" src="jquery.js"></script>
10 
<script type="text/javascript" src="dynsections.js"></script>
11 
<link href="navtree.css" rel="stylesheet" type="text/css"/>
12 
<script type="text/javascript" src="resize.js"></script>
13 
<script type="text/javascript" src="navtree.js"></script>
14 
<script type="text/javascript">
15 
  $(document).ready(initResizable);
16 
  $(window).load(resizeHeight);
17 
</script>
18 
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19 
<script type="text/javascript" src="search/search.js"></script>
20 
<script type="text/javascript">
21 
  $(document).ready(function() { searchBox.OnSelectItem(0); });
22 
</script>
23 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
24 
</head>
25 
<body>
26 
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27 
<div id="titlearea">
28 
<table cellspacing="0" cellpadding="0">
29 
 <tbody>
30 
 <tr style="height: 56px;">
31 
  <td style="padding-left: 0.5em;">
32 
   <div id="projectname">ZTEX core API for C
33 
   </div>
34 
   <div id="projectbrief">Host software API for ZTEX FPGA Boards for C</div>
35 
  </td>
36 
 </tr>
37 
 </tbody>
38 
</table>
39 
</div>
40 
<!-- end header part -->
41 
<!-- Generated by Doxygen 1.8.8 -->
42 
<script type="text/javascript">
43 
var searchBox = new SearchBox("searchBox", "search",false,'Search');
44 
</script>
45 
  <div id="navrow1" class="tabs">
46 
    <ul class="tablist">
47 
      <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
48 
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
49 
      <li><a href="files.html"><span>Files</span></a></li>
50 
      <li>
51 
        <div id="MSearchBox" class="MSearchBoxInactive">
52 
        <span class="left">
53 
          <img id="MSearchSelect" src="search/mag_sel.png"
54 
               onmouseover="return searchBox.OnSearchSelectShow()"
55 
               onmouseout="return searchBox.OnSearchSelectHide()"
56 
               alt=""/>
57 
          <input type="text" id="MSearchField" value="Search" accesskey="S"
58 
               onfocus="searchBox.OnSearchFieldFocus(true)"
59 
               onblur="searchBox.OnSearchFieldFocus(false)"
60 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
61 
          </span><span class="right">
62 
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
63 
          </span>
64 
        </div>
65 
      </li>
66 
    </ul>
67 
  </div>
68 
</div><!-- top -->
69 
<div id="side-nav" class="ui-resizable side-nav-resizable">
70 
  <div id="nav-tree">
71 
    <div id="nav-tree-contents">
72 
      <div id="nav-sync" class="sync"></div>
73 
    </div>
74 
  </div>
75 
  <div id="splitbar" style="-moz-user-select:none;"
76 
       class="ui-resizable-handle">
77 
  </div>
78 
</div>
79 
<script type="text/javascript">
80 
$(document).ready(function(){initNavTree('index.html','');});
81 
</script>
82 
<div id="doc-content">
83 
<!-- window showing the filter options -->
84 
<div id="MSearchSelectWindow"
85 
     onmouseover="return searchBox.OnSearchSelectShow()"
86 
     onmouseout="return searchBox.OnSearchSelectHide()"
87 
     onkeydown="return searchBox.OnSearchSelectKey(event)">
88 
<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></div>
89 
 
90 
<!-- iframe showing the search results (closed by default) -->
91 
<div id="MSearchResultsWindow">
92 
<iframe src="javascript:void(0)" frameborder="0"
93 
        name="MSearchResults" id="MSearchResults">
94 
</iframe>
95 
</div>
96 
 
97 
<div class="header">
98 
  <div class="headertitle">
99 
<div class="title">ZTEX core API for C Documentation</div>  </div>
100 
</div><!--header-->
101 
<div class="contents">
102 
<div class="textblock"><p>The C Core API of the <a href="http://www.ztex.de/firmware-kit/index.e.html">ZTEX SDK</a>.</p>
103 
<p>This API is used for developing host software in C. It is a re-implementation a subset of the <a href="../../java/index.html">JAVA API</a>. </p>
104 
<h2>Features</h2>
105 
<p>The main features are: </p><ul>
106 
<li>
107 
Full support of <a href="http://www.ztex.de/firmware-kit/default.e.html">Default Interface</a> <ul>
108 
<li>
109 
Multiple communication interfaces: high speed, low speed, GPIO's, reset signal </li>
110 
<li>
111 
Compatibility allows board independent host software </li>
112 
</ul>
113 
</li>
114 
<li>
115 
Bitstream upload directly to the FPGA </li>
116 
<li>
117 
Utility functions (gathering information about FPGA Boards, finding devices using filters, ...) </li>
118 
</ul>
119 
<h2>Usage, Examples</h2>
120 
<p>The library consists in the single file pair 'ztex.c' and '<a class="el" href="ztex_8h.html" title="The Core API for C. ">ztex.h</a>'. It has been tested with gcc and should work with no/minor modifications with other compilers. </p>
121 
<p>Its recommended to link the application directly against the object file. </p>
122 
<p>The package contains two examples, '<a class="el" href="ucecho_8c.html" title="ucecho example for C. ">ucecho.c</a>' and '<a class="el" href="memfifo_8c.html" title="memfifo example for C. ">memfifo.c</a>' which demonstrate the usage of the API including the default interface. </p>
123 
<p>Object files and examples can be built using make. Under Windows it has been tested with MSYS/MinGW, see <a href="http://wiki.ztex.de/doku.php?id=en:software:windows_hints#hints">Hints for Windows users</a></p>
124 
<h2>Related Resources</h2>
125 
<p>Additional information can be found at </p><ul>
126 
<li>
127 
<a href="http://www.ztex.de/firmware-kit/index.e.html">ZTEX SDK</a> </li>
128 
<li>
129 
<a href="http://wiki.ztex.de/">ZTEX Wiki</a> </li>
130 
</ul>
131 
</div></div><!-- contents -->
132 
</div><!-- doc-content -->
133 
<!-- start footer part -->
134 
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
135 
  <ul>
136 
    <li class="footer">Generated on Wed Mar 22 2017 19:03:08 for ZTEX core API for C by
137 
    <a href="http://www.doxygen.org/index.html">
138 
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
139 
  </ul>
140 
</div>
141 
</body>
142 
</html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.