scottk/OpenNetworkLinux
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/OpenNetworkLinux.git synced 2025-12-25 17:27:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5bbd6c146cc3f4e9a92384cb1a5f03365950e669
OpenNetworkLinux/onlp/doxygen/html/group__modulei.html
Jeffrey Townsend 3c6d56fd43 Testing
2019-05-29 16:38:03 +00:00

220 lines
11 KiB
HTML
Raw Blame History

<!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>ONLP: modulei</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">ONLP
</div>
<div id="projectbrief">Open Network Linux Platform APIs</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">modulei<div class="ingroups"><a class="el" href="group__onlp-main.html">ONLP</a> &raquo; <a class="el" href="group__onlp-platform.html">Platform Implementation Interfaces</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga965774c575282a7653b80433ae59307a"><td class="memItemLeft" align="right" valign="top"><a id="ga965774c575282a7653b80433ae59307a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__modulei.html#ga965774c575282a7653b80433ae59307a">onlp_modulei_sw_init</a> (void)</td></tr>
<tr class="memdesc:ga965774c575282a7653b80433ae59307a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Software initialization of the Module module. <br /></td></tr>
<tr class="separator:ga965774c575282a7653b80433ae59307a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4339962c26c2ac7d03b1a13f71073553"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__modulei.html#ga4339962c26c2ac7d03b1a13f71073553">onlp_modulei_hw_init</a> (uint32_t flags)</td></tr>
<tr class="memdesc:ga4339962c26c2ac7d03b1a13f71073553"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware initialization of the Module module. <a href="#ga4339962c26c2ac7d03b1a13f71073553">More...</a><br /></td></tr>
<tr class="separator:ga4339962c26c2ac7d03b1a13f71073553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0629d528fb9d62e9453674f274d767cc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__modulei.html#ga0629d528fb9d62e9453674f274d767cc">onlp_modulei_sw_denit</a> (void)</td></tr>
<tr class="memdesc:ga0629d528fb9d62e9453674f274d767cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitialize the module software module. <a href="#ga0629d528fb9d62e9453674f274d767cc">More...</a><br /></td></tr>
<tr class="separator:ga0629d528fb9d62e9453674f274d767cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad84e8c03045948d17e36b1c1ed445851"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__modulei.html#gad84e8c03045948d17e36b1c1ed445851">onlp_modulei_hdr_get</a> (<a class="el" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a> id, <a class="el" href="group__oid.html#ga6496740949b7893b4122857837e26b37">onlp_oid_hdr_t</a> *rv)</td></tr>
<tr class="memdesc:gad84e8c03045948d17e36b1c1ed445851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the module's oid header. <a href="#gad84e8c03045948d17e36b1c1ed445851">More...</a><br /></td></tr>
<tr class="separator:gad84e8c03045948d17e36b1c1ed445851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dcdcd462f191c8ff92d6dbfee956a81"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__modulei.html#ga9dcdcd462f191c8ff92d6dbfee956a81">onlp_modulei_info_get</a> (<a class="el" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a> id, <a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *rv)</td></tr>
<tr class="memdesc:ga9dcdcd462f191c8ff92d6dbfee956a81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the information for the given module OID. <a href="#ga9dcdcd462f191c8ff92d6dbfee956a81">More...</a><br /></td></tr>
<tr class="separator:ga9dcdcd462f191c8ff92d6dbfee956a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad84e8c03045948d17e36b1c1ed445851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad84e8c03045948d17e36b1c1ed445851">&#9670;&nbsp;</a></span>onlp_modulei_hdr_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_modulei_hdr_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oid.html#ga6496740949b7893b4122857837e26b37">onlp_oid_hdr_t</a> *&#160;</td>
<td class="paramname"><em>rv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the module's oid header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">id</td><td>The module oid. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rv</td><td>Receives the header. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4339962c26c2ac7d03b1a13f71073553"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4339962c26c2ac7d03b1a13f71073553">&#9670;&nbsp;</a></span>onlp_modulei_hw_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_modulei_hw_init </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hardware initialization of the Module module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>The hardware initialization flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9dcdcd462f191c8ff92d6dbfee956a81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9dcdcd462f191c8ff92d6dbfee956a81">&#9670;&nbsp;</a></span>onlp_modulei_info_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_modulei_info_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a> *&#160;</td>
<td class="paramname"><em>rv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the information for the given module OID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">id</td><td>The Module OID </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rv</td><td>Receives the module information. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0629d528fb9d62e9453674f274d767cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0629d528fb9d62e9453674f274d767cc">&#9670;&nbsp;</a></span>onlp_modulei_sw_denit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_modulei_sw_denit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialize the module software module. </p>
<dl class="section note"><dt>Note</dt><dd>The primary purpose of this API is to properly deallocate any resources used by the module in order faciliate detection of real resouce leaks. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 29 2019 16:19:08 for ONLP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink