add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__up__pkt__gen__params.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_up_pkt_gen_params 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_up_pkt_gen_params Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_up_pkt_gen_params:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__up__pkt__gen__params__coll__graph.png" border="0" usemap="#xran__up__pkt__gen__params_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__up__pkt__gen__params_coll__map" id="xran__up__pkt__gen__params_coll__map">
75 <area shape="rect" id="node2" href="structdata__section__hdr.html" title="{data_section_hdr\n|+ all_bits\l+ num_prbu\l+ start_prbu\l+ sym_inc\l+ rb\l+ sect_id\l+ fields\l|}" alt="" coords="5,175,127,340"/>
76 <area shape="rect" id="node3" href="structradio__app__common__hdr.html" title="{radio_app_common_hdr\n|+ filter_id\l+ payl_ver\l+ data_direction\l+ frame_id\l+ value\l+ symb_id\l+ slot_id\l+ subframe_id\l+ sf_slot_sym\l|}" alt="" coords="151,160,311,355"/>
77 <area shape="rect" id="node4" href="unioncompression__params.html" title="{compression_params\n||}" alt="" coords="335,219,482,296"/>
78 <area shape="rect" id="node5" href="structcompression__params_1_1u__law.html" title="{u_law\n|+ compShift\l+ compBitWidth\l|}" alt="" coords="199,5,315,97"/>
79 <area shape="rect" id="node6" href="structcompression__params_1_1block__fl__point.html" title="{block_fl_point\n|+ exponent\l+ reserved\l|}" alt="" coords="339,5,441,97"/>
80 <area shape="rect" id="node7" href="structcompression__params_1_1block__scaling.html" title="{block_scaling\n|+ sblockScaler\l|}" alt="" coords="466,13,575,90"/>
81 <area shape="rect" id="node8" href="structdata__section__compression__hdr.html" title="{data_section_compression_hdr\n|+ rsrvd\l|}" alt="" coords="542,219,745,296"/>
82 <area shape="rect" id="node9" href="structcompression__hdr.html" title="{compression_hdr\n|+ ud_iq_width\l+ ud_comp_meth\l|}" alt="" coords="599,5,722,97"/>
83 </map>
84 </div>
85 <table class="memberdecls">
86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
87 Data Fields</h2></td></tr>
88 <tr class="memitem:a26f46f53ef26bc5d5f86e19a15fc356f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">app_params</a></td></tr>
89 <tr class="separator:a26f46f53ef26bc5d5f86e19a15fc356f"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:ae5c4194f5046a89d06534a69775c1cab"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdata__section__hdr.html">data_section_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__params.html#ae5c4194f5046a89d06534a69775c1cab">sec_hdr</a></td></tr>
91 <tr class="separator:ae5c4194f5046a89d06534a69775c1cab"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:abd4dfd90066570bbcb342a260adcc7a6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdata__section__compression__hdr.html">data_section_compression_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__params.html#abd4dfd90066570bbcb342a260adcc7a6">compr_hdr_param</a></td></tr>
93 <tr class="separator:abd4dfd90066570bbcb342a260adcc7a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:afac9efa85d81509009b41172040801ec"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unioncompression__params.html">compression_params</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__params.html#afac9efa85d81509009b41172040801ec">compr_param</a></td></tr>
95 <tr class="separator:afac9efa85d81509009b41172040801ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 </table>
97 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
98 <div class="textblock">
99 <p class="definition">Definition at line <a class="el" href="xran__up__api_8h_source.html#l00045">45</a> of file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
100 </div><h2 class="groupheader">Field Documentation</h2>
101 <a id="a26f46f53ef26bc5d5f86e19a15fc356f"></a>
102 <h2 class="memtitle"><span class="permalink"><a href="#a26f46f53ef26bc5d5f86e19a15fc356f">&#9670;&nbsp;</a></span>app_params</h2>
103
104 <div class="memitem">
105 <div class="memproto">
106       <table class="memname">
107         <tr>
108           <td class="memname">struct <a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a> app_params</td>
109         </tr>
110       </table>
111 </div><div class="memdoc">
112
113 <p class="definition">Definition at line <a class="el" href="xran__up__api_8h_source.html#l00047">47</a> of file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
114
115 </div>
116 </div>
117 <a id="abd4dfd90066570bbcb342a260adcc7a6"></a>
118 <h2 class="memtitle"><span class="permalink"><a href="#abd4dfd90066570bbcb342a260adcc7a6">&#9670;&nbsp;</a></span>compr_hdr_param</h2>
119
120 <div class="memitem">
121 <div class="memproto">
122       <table class="memname">
123         <tr>
124           <td class="memname">struct <a class="el" href="structdata__section__compression__hdr.html">data_section_compression_hdr</a> compr_hdr_param</td>
125         </tr>
126       </table>
127 </div><div class="memdoc">
128
129 <p class="definition">Definition at line <a class="el" href="xran__up__api_8h_source.html#l00049">49</a> of file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
130
131 </div>
132 </div>
133 <a id="afac9efa85d81509009b41172040801ec"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#afac9efa85d81509009b41172040801ec">&#9670;&nbsp;</a></span>compr_param</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname">union <a class="el" href="unioncompression__params.html">compression_params</a> compr_param</td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144
145 <p class="definition">Definition at line <a class="el" href="xran__up__api_8h_source.html#l00050">50</a> of file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
146
147 </div>
148 </div>
149 <a id="ae5c4194f5046a89d06534a69775c1cab"></a>
150 <h2 class="memtitle"><span class="permalink"><a href="#ae5c4194f5046a89d06534a69775c1cab">&#9670;&nbsp;</a></span>sec_hdr</h2>
151
152 <div class="memitem">
153 <div class="memproto">
154       <table class="memname">
155         <tr>
156           <td class="memname">struct <a class="el" href="structdata__section__hdr.html">data_section_hdr</a> sec_hdr</td>
157         </tr>
158       </table>
159 </div><div class="memdoc">
160
161 <p class="definition">Definition at line <a class="el" href="xran__up__api_8h_source.html#l00048">48</a> of file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
162
163 </div>
164 </div>
165 <hr/>The documentation for this struct was generated from the following file:<ul>
166 <li><a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a></li>
167 </ul>
168 </div><!-- contents -->
169 <!-- start footer part -->
170 <hr class="footer"/><address class="footer"><small>
171 Generated by &#160;<a href="http://www.doxygen.org/index.html">
172 <img class="footer" src="doxygen.png" alt="doxygen"/>
173 </a> 1.8.13
174 </small></address>
175 </body>
176 </html>