mirror of
https://github.com/Telecominfraproject/OpenNetworkLinux.git
synced 2026-01-09 16:51:30 +00:00
246 lines
13 KiB
HTML
246 lines
13 KiB
HTML
<!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: platformi</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">platformi<div class="ingroups"><a class="el" href="group__onlp-main.html">ONLP</a> » <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:ga120a19f90e53a900ced917788ceae047"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga120a19f90e53a900ced917788ceae047">onlp_platformi_get</a> (void)</td></tr>
|
|
<tr class="memdesc:ga120a19f90e53a900ced917788ceae047"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the the platform implementation. <a href="#ga120a19f90e53a900ced917788ceae047">More...</a><br /></td></tr>
|
|
<tr class="separator:ga120a19f90e53a900ced917788ceae047"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga98a98891eef309fd779a7984c65969f6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga98a98891eef309fd779a7984c65969f6">onlp_platformi_set</a> (const char *platform)</td></tr>
|
|
<tr class="memdesc:ga98a98891eef309fd779a7984c65969f6"><td class="mdescLeft"> </td><td class="mdescRight">Set the platform explicitly if necessary. <a href="#ga98a98891eef309fd779a7984c65969f6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga98a98891eef309fd779a7984c65969f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab512072ac97686d555348ba4c8048575"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#gab512072ac97686d555348ba4c8048575">onlp_platformi_sw_init</a> (void)</td></tr>
|
|
<tr class="memdesc:gab512072ac97686d555348ba4c8048575"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the platform software module. <a href="#gab512072ac97686d555348ba4c8048575">More...</a><br /></td></tr>
|
|
<tr class="separator:gab512072ac97686d555348ba4c8048575"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9e377f21e52b918a6a2bbbb53f515eb9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga9e377f21e52b918a6a2bbbb53f515eb9">onlp_platformi_hw_init</a> (uint32_t flags)</td></tr>
|
|
<tr class="memdesc:ga9e377f21e52b918a6a2bbbb53f515eb9"><td class="mdescLeft"> </td><td class="mdescRight">Platform module hardware initialization. <a href="#ga9e377f21e52b918a6a2bbbb53f515eb9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9e377f21e52b918a6a2bbbb53f515eb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3f044c30a9cdb9b7d6841433c4e8d318"><td class="memItemLeft" align="right" valign="top"><a id="ga3f044c30a9cdb9b7d6841433c4e8d318"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga3f044c30a9cdb9b7d6841433c4e8d318">onlp_platformi_manage_init</a> (void)</td></tr>
|
|
<tr class="memdesc:ga3f044c30a9cdb9b7d6841433c4e8d318"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the platform manager features. <br /></td></tr>
|
|
<tr class="separator:ga3f044c30a9cdb9b7d6841433c4e8d318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7d1db6d7fdcd2b68a340e957e7824913"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga7d1db6d7fdcd2b68a340e957e7824913">onlp_platformi_manage_fans</a> (void)</td></tr>
|
|
<tr class="memdesc:ga7d1db6d7fdcd2b68a340e957e7824913"><td class="mdescLeft"> </td><td class="mdescRight">Perform necessary platform fan management. <a href="#ga7d1db6d7fdcd2b68a340e957e7824913">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7d1db6d7fdcd2b68a340e957e7824913"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga444150b527536aad7fe7fcb2ac1655a6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__platformi.html#ga444150b527536aad7fe7fcb2ac1655a6">onlp_platformi_manage_leds</a> (void)</td></tr>
|
|
<tr class="memdesc:ga444150b527536aad7fe7fcb2ac1655a6"><td class="mdescLeft"> </td><td class="mdescRight">Perform necessary platform LED management. <a href="#ga444150b527536aad7fe7fcb2ac1655a6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga444150b527536aad7fe7fcb2ac1655a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga120a19f90e53a900ced917788ceae047"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga120a19f90e53a900ced917788ceae047">◆ </a></span>onlp_platformi_get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* onlp_platformi_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the name of the the platform implementation. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This will be called prior to any other calls into the platform driver, including the <a class="el" href="group__platformi.html#gab512072ac97686d555348ba4c8048575" title="Initialize the platform software module. ">onlp_platformi_sw_init()</a> function below.</dd></dl>
|
|
<p>The platform implementation name should match the current ONLP platform name.</p>
|
|
<p>IF the platform implementation name equals the current platform name, initialization will continue.</p>
|
|
<p>If the platform implementation name does not match, the following will be attempted:</p>
|
|
<p>onlp_platformi_set(current_platform_name); If this call is successful, initialization will continue. If this call fails, platform initialization will abort().</p>
|
|
<p>The <a class="el" href="group__platformi.html#ga98a98891eef309fd779a7984c65969f6" title="Set the platform explicitly if necessary. ">onlp_platformi_set()</a> function is optional. The <a class="el" href="group__platformi.html#ga120a19f90e53a900ced917788ceae047" title="Return the name of the the platform implementation. ">onlp_platformi_get()</a> is not optional. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9e377f21e52b918a6a2bbbb53f515eb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9e377f21e52b918a6a2bbbb53f515eb9">◆ </a></span>onlp_platformi_hw_init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_platformi_hw_init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>flags</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Platform module hardware initialization. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">flags</td><td>The initialization flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7d1db6d7fdcd2b68a340e957e7824913"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7d1db6d7fdcd2b68a340e957e7824913">◆ </a></span>onlp_platformi_manage_fans()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_platformi_manage_fans </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform necessary platform fan management. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function should automatically adjust the FAN speeds according to the platform conditions. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga444150b527536aad7fe7fcb2ac1655a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga444150b527536aad7fe7fcb2ac1655a6">◆ </a></span>onlp_platformi_manage_leds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_platformi_manage_leds </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform necessary platform LED management. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function should automatically adjust the LED indicators according to the platform conditions. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga98a98891eef309fd779a7984c65969f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga98a98891eef309fd779a7984c65969f6">◆ </a></span>onlp_platformi_set()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_platformi_set </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>platform</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the platform explicitly if necessary. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">platform</td><td>The platform name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab512072ac97686d555348ba4c8048575"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab512072ac97686d555348ba4c8048575">◆ </a></span>onlp_platformi_sw_init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int onlp_platformi_sw_init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize the platform software module. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This should not touch the hardware. </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|