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

89 lines
14 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: module/inc/onlp/platformi/psui.h Source File</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a7b0466279106ea0b8f86f609f621680.html">module</a></li><li class="navelem"><a class="el" href="dir_9b91cb305f6dfd5edb8153d5019adc55.html">inc</a></li><li class="navelem"><a class="el" href="dir_72adef417dcbc5bf8193445c31305165.html">onlp</a></li><li class="navelem"><a class="el" href="dir_ad96458042bbdd0196ba054c40055169.html">platformi</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">psui.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="psui_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * &lt;bsn.cl fy=2014 v=onl&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright 2014, 2015 Big Switch Networks, Inc.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Licensed under the Eclipse Public License, Version 1.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.eclipse.org/legal/epl-v10.html</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * either express or implied. See the License for the specific</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * language governing permissions and limitations under the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * &lt;/bsn.cl&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> ********************************************************/</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#ifndef __ONLP_PSUI_H__</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define __ONLP_PSUI_H__</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="psu_8h.html">onlp/psu.h</a>&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#gaf67bedb47907fd5c8548784b92813c79">onlp_psui_sw_init</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#ga48757edc28f58f1602c4cc7ca2e9ef9c">onlp_psui_hw_init</a>(uint32_t flags);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#ga69f99c6a90fbb5d1c03349b47970fa98">onlp_psui_sw_denit</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#ga9c3c4dfab92db6ae33b29b6a6bf2aa55">onlp_psui_id_validate</a>(<a class="code" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a> <span class="keywordtype">id</span>);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#gabfc93ced2b1436db99357b22c9c1ef61">onlp_psui_hdr_get</a>(<a class="code" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a> <span class="keywordtype">id</span>, <a class="code" href="structonlp__oid__hdr__s.html">onlp_oid_hdr_t</a>* rv);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__psui.html#gaf5fbee43118662c54cb80de997c68361">onlp_psui_info_get</a>(<a class="code" href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a> <span class="keywordtype">id</span>, <a class="code" href="structonlp__psu__info__t.html">onlp_psu_info_t</a>* rv);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="group__psui.html#gaba33f5e3da076bc11c4b0a107ea5bfd6"> 76</a></span>&#160;<span class="preprocessor">#define ONLP_CHASSIS_PSU_INFO_ENTRY_INIT(_id, _desc) \</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor"> { \</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor"> { \</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor"> .id = _id, \</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor"> .description = _desc, \</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor"> .poid = ONLP_OID_CHASSIS, \</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor"> }, \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor"> }</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ONLP_PSUI_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment">/* @} */</span></div><div class="ttc" id="group__psui_html_gaf67bedb47907fd5c8548784b92813c79"><div class="ttname"><a href="group__psui.html#gaf67bedb47907fd5c8548784b92813c79">onlp_psui_sw_init</a></div><div class="ttdeci">int onlp_psui_sw_init(void)</div><div class="ttdoc">Software initialization of the PSU module. </div></div>
<div class="ttc" id="group__psui_html_gabfc93ced2b1436db99357b22c9c1ef61"><div class="ttname"><a href="group__psui.html#gabfc93ced2b1436db99357b22c9c1ef61">onlp_psui_hdr_get</a></div><div class="ttdeci">int onlp_psui_hdr_get(onlp_oid_id_t id, onlp_oid_hdr_t *rv)</div><div class="ttdoc">Get the PSU&amp;#39;s oid header. </div></div>
<div class="ttc" id="group__psui_html_ga48757edc28f58f1602c4cc7ca2e9ef9c"><div class="ttname"><a href="group__psui.html#ga48757edc28f58f1602c4cc7ca2e9ef9c">onlp_psui_hw_init</a></div><div class="ttdeci">int onlp_psui_hw_init(uint32_t flags)</div><div class="ttdoc">Hardware initialization of the PSU module. </div></div>
<div class="ttc" id="group__psui_html_ga69f99c6a90fbb5d1c03349b47970fa98"><div class="ttname"><a href="group__psui.html#ga69f99c6a90fbb5d1c03349b47970fa98">onlp_psui_sw_denit</a></div><div class="ttdeci">int onlp_psui_sw_denit(void)</div><div class="ttdoc">Deinitialize the psu software module. </div></div>
<div class="ttc" id="group__psui_html_ga9c3c4dfab92db6ae33b29b6a6bf2aa55"><div class="ttname"><a href="group__psui.html#ga9c3c4dfab92db6ae33b29b6a6bf2aa55">onlp_psui_id_validate</a></div><div class="ttdeci">int onlp_psui_id_validate(onlp_oid_id_t id)</div><div class="ttdoc">Validate a PSU OID. </div></div>
<div class="ttc" id="group__oid_html_gafeead7b8b6e6434d56d2ee5a66c02f71"><div class="ttname"><a href="group__oid.html#gafeead7b8b6e6434d56d2ee5a66c02f71">onlp_oid_id_t</a></div><div class="ttdeci">uint32_t onlp_oid_id_t</div><div class="ttdef"><b>Definition:</b> oids.h:55</div></div>
<div class="ttc" id="psu_8h_html"><div class="ttname"><a href="psu_8h.html">psu.h</a></div><div class="ttdoc">Power Supply Management. </div></div>
<div class="ttc" id="group__psui_html_gaf5fbee43118662c54cb80de997c68361"><div class="ttname"><a href="group__psui.html#gaf5fbee43118662c54cb80de997c68361">onlp_psui_info_get</a></div><div class="ttdeci">int onlp_psui_info_get(onlp_oid_id_t id, onlp_psu_info_t *rv)</div><div class="ttdoc">Get the information structure for the given PSU. </div></div>
<div class="ttc" id="structonlp__psu__info__t_html"><div class="ttname"><a href="structonlp__psu__info__t.html">onlp_psu_info_t</a></div><div class="ttdef"><b>Definition:</b> psu.h:61</div></div>
<div class="ttc" id="structonlp__oid__hdr__s_html"><div class="ttname"><a href="structonlp__oid__hdr__s.html">onlp_oid_hdr_s</a></div><div class="ttdef"><b>Definition:</b> oids.h:296</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 29 2019 16:19:07 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