add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__sectioninfo__db.html
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 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: xran_sectioninfo_db Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 </div><!-- top -->
61 <div class="header">
62   <div class="summary">
63 <a href="#pub-attribs">Data Fields</a>  </div>
64   <div class="headertitle">
65 <div class="title">xran_sectioninfo_db Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68 <div class="dynheader">
69 Collaboration diagram for xran_sectioninfo_db:</div>
70 <div class="dyncontent">
71 <div class="center"><img src="structxran__sectioninfo__db__coll__graph.png" border="0" usemap="#xran__sectioninfo__db_coll__map" alt="Collaboration graph"/></div>
72 <map name="xran__sectioninfo__db_coll__map" id="xran__sectioninfo__db_coll__map">
73 <area shape="rect" id="node2" href="structxran__section__info.html" title="{xran_section_info\n|+ type\l+ startSymId\l+ numSymbol\l+ symInc\l+ id\l+ reMask\l+ startPrbc\l+ numPrbc\l+ rb\l+ compMeth\land 7 more...\l|}" alt="" coords="13,204,137,428"/>
74 <area shape="rect" id="node3" href="structxran__section__desc.html" title="{xran_section_desc\n|+ section_id\l+ iq_buffer_offset\l+ iq_buffer_len\l+ pData\l+ pCtrl\l|}" alt="" coords="9,5,140,141"/>
75 </map>
76 </div>
77 <table class="memberdecls">
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
79 Data Fields</h2></td></tr>
80 <tr class="memitem:af9f19a44a251a4b45c3e949b698b9294"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectioninfo__db.html#af9f19a44a251a4b45c3e949b698b9294">cur_index</a></td></tr>
81 <tr class="separator:af9f19a44a251a4b45c3e949b698b9294"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:acadfaa8ee00984098976838a75457775"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__section__info.html">xran_section_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectioninfo__db.html#acadfaa8ee00984098976838a75457775">list</a> [<a class="el" href="xran__common_8h.html#a3a4bb6898c9295b71ffd7b830048580c">XRAN_MAX_NUM_SECTIONS</a>]</td></tr>
83 <tr class="separator:acadfaa8ee00984098976838a75457775"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 </table>
85 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
86 <div class="textblock"><p>This structure to store the section information of C-Plane in order to generate and parse corresponding U-Plane </p>
87
88 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8c_source.html#l00041">41</a> of file <a class="el" href="xran__cp__api_8c_source.html">xran_cp_api.c</a>.</p>
89 </div><h2 class="groupheader">Field Documentation</h2>
90 <a id="af9f19a44a251a4b45c3e949b698b9294"></a>
91 <h2 class="memtitle"><span class="permalink"><a href="#af9f19a44a251a4b45c3e949b698b9294">&#9670;&nbsp;</a></span>cur_index</h2>
92
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname">uint32_t cur_index</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101 <p>Current index to store for this eAXC </p>
102
103 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8c_source.html#l00042">42</a> of file <a class="el" href="xran__cp__api_8c_source.html">xran_cp_api.c</a>.</p>
104
105 </div>
106 </div>
107 <a id="acadfaa8ee00984098976838a75457775"></a>
108 <h2 class="memtitle"><span class="permalink"><a href="#acadfaa8ee00984098976838a75457775">&#9670;&nbsp;</a></span>list</h2>
109
110 <div class="memitem">
111 <div class="memproto">
112       <table class="memname">
113         <tr>
114           <td class="memname">struct <a class="el" href="structxran__section__info.html">xran_section_info</a> list[<a class="el" href="xran__common_8h.html#a3a4bb6898c9295b71ffd7b830048580c">XRAN_MAX_NUM_SECTIONS</a>]</td>
115         </tr>
116       </table>
117 </div><div class="memdoc">
118 <p>The array of section information </p>
119
120 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8c_source.html#l00043">43</a> of file <a class="el" href="xran__cp__api_8c_source.html">xran_cp_api.c</a>.</p>
121
122 </div>
123 </div>
124 <hr/>The documentation for this struct was generated from the following file:<ul>
125 <li><a class="el" href="xran__cp__api_8c_source.html">xran_cp_api.c</a></li>
126 </ul>
127 </div><!-- contents -->
128 <!-- start footer part -->
129 <hr class="footer"/><address class="footer"><small>
130 Generated by &#160;<a href="http://www.doxygen.org/index.html">
131 <img class="footer" src="doxygen.png" alt="doxygen"/>
132 </a> 1.8.13
133 </small></address>
134 </body>
135 </html>