scottk/OpenNetworkLinux
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/OpenNetworkLinux.git synced 2026-01-09 00:31:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a1b3b3ff18f9b67ceb83f4de68535c4cd7ddc4ca
OpenNetworkLinux/onlp/doxygen/html/group__platform.html
Jeffrey Townsend 3c6d56fd43 Testing
2019-05-29 16:38:03 +00:00

238 lines
13 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: Platform Initialization and Management</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">Platform Initialization and Management<div class="ingroups"><a class="el" href="group__onlp-main.html">ONLP</a> &raquo; <a class="el" href="group__onlp-appication.html">ONLP Application Interfaces</a> &raquo; <a class="el" href="group__system-interfaces.html">General System 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:gab9348712282242c2b232930e1f27804e"><td class="memItemLeft" align="right" valign="top"><a id="gab9348712282242c2b232930e1f27804e"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#gab9348712282242c2b232930e1f27804e">onlp_platform_name_get</a> (void)</td></tr>
<tr class="memdesc:gab9348712282242c2b232930e1f27804e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current ONL platform name. <br /></td></tr>
<tr class="separator:gab9348712282242c2b232930e1f27804e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb130dc1086c4fc528280915e2400933"><td class="memItemLeft" align="right" valign="top"><a id="gafb130dc1086c4fc528280915e2400933"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#gafb130dc1086c4fc528280915e2400933">onlp_platform_sw_init</a> (const char *platform)</td></tr>
<tr class="memdesc:gafb130dc1086c4fc528280915e2400933"><td class="mdescLeft">&#160;</td><td class="mdescRight">Platform software init. <br /></td></tr>
<tr class="separator:gafb130dc1086c4fc528280915e2400933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39e51ad20f6c6119bce7e24ff67f5967"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga39e51ad20f6c6119bce7e24ff67f5967">onlp_platform_hw_init</a> (uint32_t flags)</td></tr>
<tr class="memdesc:ga39e51ad20f6c6119bce7e24ff67f5967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Platform Hardware init. <a href="#ga39e51ad20f6c6119bce7e24ff67f5967">More...</a><br /></td></tr>
<tr class="separator:ga39e51ad20f6c6119bce7e24ff67f5967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0751b3edb27df40cb8567ebff99e16de"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga0751b3edb27df40cb8567ebff99e16de">onlp_platform_sw_denit</a> (void)</td></tr>
<tr class="memdesc:ga0751b3edb27df40cb8567ebff99e16de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitialize the chassis software module. <a href="#ga0751b3edb27df40cb8567ebff99e16de">More...</a><br /></td></tr>
<tr class="separator:ga0751b3edb27df40cb8567ebff99e16de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43cc01e64cba0f44e049fc86441da19b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga43cc01e64cba0f44e049fc86441da19b">onlp_platform_manager_start</a> (int block)</td></tr>
<tr class="memdesc:ga43cc01e64cba0f44e049fc86441da19b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the platform management thread. <a href="#ga43cc01e64cba0f44e049fc86441da19b">More...</a><br /></td></tr>
<tr class="separator:ga43cc01e64cba0f44e049fc86441da19b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39843476251f7f078c2ca1676fbd56a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga39843476251f7f078c2ca1676fbd56a1">onlp_platform_manager_stop</a> (int block)</td></tr>
<tr class="memdesc:ga39843476251f7f078c2ca1676fbd56a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the platform management thread. <a href="#ga39843476251f7f078c2ca1676fbd56a1">More...</a><br /></td></tr>
<tr class="separator:ga39843476251f7f078c2ca1676fbd56a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e72ec3c911e93f6f08e34a1064190fc"><td class="memItemLeft" align="right" valign="top"><a id="ga7e72ec3c911e93f6f08e34a1064190fc"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga7e72ec3c911e93f6f08e34a1064190fc">onlp_platform_manager_join</a> (void)</td></tr>
<tr class="memdesc:ga7e72ec3c911e93f6f08e34a1064190fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join the platform management thread. <br /></td></tr>
<tr class="separator:ga7e72ec3c911e93f6f08e34a1064190fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b164a8b195926d42106c791d9f4b3b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga5b164a8b195926d42106c791d9f4b3b7">onlp_platform_manager_manage</a> (void)</td></tr>
<tr class="memdesc:ga5b164a8b195926d42106c791d9f4b3b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform any pending platform management activities. <a href="#ga5b164a8b195926d42106c791d9f4b3b7">More...</a><br /></td></tr>
<tr class="separator:ga5b164a8b195926d42106c791d9f4b3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bdc0d49f4151a53538199f1983bc626"><td class="memItemLeft" align="right" valign="top"><a id="ga2bdc0d49f4151a53538199f1983bc626"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#ga2bdc0d49f4151a53538199f1983bc626">onlp_platform_manager_daemon</a> (const char *name, const char *logfile, const char *pidfile, char **argv)</td></tr>
<tr class="memdesc:ga2bdc0d49f4151a53538199f1983bc626"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run in platform manager dameon mode. <br /></td></tr>
<tr class="separator:ga2bdc0d49f4151a53538199f1983bc626"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadad2d8488cbcf82766d8f00d564a6c7e"><td class="memItemLeft" align="right" valign="top"><a id="gadad2d8488cbcf82766d8f00d564a6c7e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__platform.html#gadad2d8488cbcf82766d8f00d564a6c7e">onlp_platform_debug</a> (aim_pvs_t *pvs, int argc, char **argv)</td></tr>
<tr class="memdesc:gadad2d8488cbcf82766d8f00d564a6c7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the platform debug hook. <br /></td></tr>
<tr class="separator:gadad2d8488cbcf82766d8f00d564a6c7e"><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="ga39e51ad20f6c6119bce7e24ff67f5967"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga39e51ad20f6c6119bce7e24ff67f5967">&#9670;&nbsp;</a></span>onlp_platform_hw_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_platform_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>Platform Hardware init. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>The init flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5b164a8b195926d42106c791d9f4b3b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b164a8b195926d42106c791d9f4b3b7">&#9670;&nbsp;</a></span>onlp_platform_manager_manage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void onlp_platform_manager_manage </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform any pending platform management activities. </p>
<dl class="section note"><dt>Note</dt><dd>A call to this function will perform any pending platform management activities. It is not intended to block for an extended period of time. </dd></dl>
</div>
</div>
<a id="ga43cc01e64cba0f44e049fc86441da19b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga43cc01e64cba0f44e049fc86441da19b">&#9670;&nbsp;</a></span>onlp_platform_manager_start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_platform_manager_start </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>block</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the platform management thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block</td><td>Whether the call should block on completion. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga39843476251f7f078c2ca1676fbd56a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga39843476251f7f078c2ca1676fbd56a1">&#9670;&nbsp;</a></span>onlp_platform_manager_stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_platform_manager_stop </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>block</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop the platform management thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block</td><td>Block on termination. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0751b3edb27df40cb8567ebff99e16de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0751b3edb27df40cb8567ebff99e16de">&#9670;&nbsp;</a></span>onlp_platform_sw_denit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int onlp_platform_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 chassis 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