doc: regenerate
[xenomai-head.git] / doc / generated / html / api / descriptor_8h_source.html
blob7dbed7c1062b054439f48daae707167539933737
1 <!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 <title>Xenomai API: include/analogy/descriptor.h Source File</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="jquery.js"></script>
9 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16 <link href="search/search.css" rel="stylesheet" type="text/css"/>
17 <script type="text/javascript" src="search/search.js"></script>
18 <script type="text/javascript">
19 $(document).ready(function() {
20 if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
21 });
22 </script>
23 <link rel="search" href="search-opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="Xenomai API"/>
24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
25 </head>
26 <body>
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30 <tbody>
31 <tr style="height: 56px;">
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">Xenomai API
34 &#160;<span id="projectnumber">2.6.3</span>
35 </div>
36 </td>
37 </tr>
38 </tbody>
39 </table>
40 </div>
41 <!-- end header part -->
42 <!-- Generated by Doxygen 1.8.1.2 -->
43 <script type="text/javascript">
44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
45 </script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
50 <li><a href="modules.html"><span>Modules</span></a></li>
51 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
52 <li class="current"><a href="files.html"><span>Files</span></a></li>
53 <li><a href="examples.html"><span>Examples</span></a></li>
54 <li>
55 <div id="MSearchBox" class="MSearchBoxInactive">
56 <div class="left">
57 <form id="FSearchBox" action="search.php" method="get">
58 <img id="MSearchSelect" src="search/mag.png" alt=""/>
59 <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
60 onfocus="searchBox.OnSearchFieldFocus(true)"
61 onblur="searchBox.OnSearchFieldFocus(false)"/>
62 </form>
63 </div><div class="right"></div>
64 </div>
65 </li>
66 </ul>
67 </div>
68 <div id="navrow2" class="tabs2">
69 <ul class="tablist">
70 <li><a href="files.html"><span>File&#160;List</span></a></li>
71 <li><a href="globals.html"><span>Globals</span></a></li>
72 </ul>
73 </div>
74 </div><!-- top -->
75 <div id="side-nav" class="ui-resizable side-nav-resizable">
76 <div id="nav-tree">
77 <div id="nav-tree-contents">
78 <div id="nav-sync" class="sync"></div>
79 </div>
80 </div>
81 <div id="splitbar" style="-moz-user-select:none;"
82 class="ui-resizable-handle">
83 </div>
84 </div>
85 <script type="text/javascript">
86 $(document).ready(function(){initNavTree('descriptor_8h_source.html','');});
87 </script>
88 <div id="doc-content">
89 <div class="header">
90 <div class="headertitle">
91 <div class="title">descriptor.h</div> </div>
92 </div><!--header-->
93 <div class="contents">
94 <a href="descriptor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
95 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef __ANALOGY_LIB_CORE__</span></div>
96 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __ANALOGY_LIB_CORE__</span></div>
97 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"></span></div>
98 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="subdevice_8h.html" title="Analogy for Linux, subdevice related features.">analogy/subdevice.h</a>&gt;</span></div>
99 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="device_8h.html" title="Analogy for Linux, device related features.">analogy/device.h</a>&gt;</span></div>
100 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
101 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">/* --- Descriptor precompilation constants --- */</span></div>
102 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
103 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">/* Constant used internally */</span></div>
104 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#define MAGIC_BSC_DESC 0x1234abcd</span></div>
105 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MAGIC_CPLX_DESC 0xabcd1234</span></div>
106 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor"></span></div>
107 <div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="group__descriptor__sys.html#ga9bac966c050032d5f29c3205b80ebe74"> 49</a></span>&#160;<span class="preprocessor">#define A4L_BSC_DESC 0x0</span></div>
108 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor"></span></div>
109 <div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="group__descriptor__sys.html#gaefe74d60fa5f6c85021c66993d2cf306"> 55</a></span>&#160;<span class="preprocessor">#define A4L_CPLX_DESC 0x1</span></div>
110 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor"></span></div>
111 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment">/* --- Descriptor structure --- */</span></div>
112 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
113 <div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="structa4l__descriptor.html"> 66</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structa4l__descriptor.html" title="Structure containing device-information useful to users.">a4l_descriptor</a> {</div>
114 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">char</span> <a class="code" href="structa4l__descriptor.html#affd78a7d8d938720fcfc60912e384045" title="Board name.">board_name</a>[A4L_NAMELEN];</div>
115 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#a5fd4ac44e93207aad96db25ddca7543c" title="Subdevices count.">nb_subd</a>;</div>
116 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#afb81c9f016241cd70319ee5e2dd302ed" title="Input subdevice index.">idx_read_subd</a>;</div>
117 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#ab9b06f5025a7e1f1028d2477eeff818e" title="Output subdevice index.">idx_write_subd</a>;</div>
118 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#ab8714b06548347351e52f1125dd45c20" title="File descriptor.">fd</a>;</div>
119 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#a8304d50fb6c9d8a82a4cdfd5155b81c3" title="Opaque field.">magic</a>;</div>
120 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">int</span> <a class="code" href="structa4l__descriptor.html#a52185721d04c3c0cb9247b8163ca89ec" title="Data buffer size.">sbsize</a>;</div>
121 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">void</span> *<a class="code" href="structa4l__descriptor.html#a2ac7f86c9ec51b44c37ef155fef155c1" title="Data buffer pointer.">sbdata</a>;</div>
122 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;};</div>
123 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structa4l__descriptor.html" title="Structure containing device-information useful to users.">a4l_descriptor</a> <a class="code" href="structa4l__descriptor.html" title="Structure containing device-information useful to users.">a4l_desc_t</a>;</div>
124 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
125 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ANALOGY_LIB_CORE__ */</span><span class="preprocessor"></span></div>
126 </div><!-- fragment --></div><!-- contents -->
127 </div><!-- doc-content -->
128 <!-- start footer part -->
129 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
130 <ul>
131 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7aef7afbbd023211de7ae0a01bd6ade1.html">analogy</a></li><li class="navelem"><a class="el" href="descriptor_8h.html">descriptor.h</a></li>
132 <li class="footer">Generated on Fri Oct 4 2013 22:39:06 for Xenomai API by
133 <a href="http://www.doxygen.org/index.html">
134 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
135 </ul>
136 </div>
137 </body>
138 </html>