mirror of
https://github.com/Telecominfraproject/OpenNetworkLinux.git
synced 2025-12-26 17:57:01 +00:00
94 lines
17 KiB
HTML
94 lines
17 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: module/inc/onlp/module.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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">module.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="module_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> <span class="comment">/************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * <bsn.cl fy=2014 v=onl></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright 2014, 2015 Big Switch Networks, Inc.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <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> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <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> <span class="comment"> * language governing permissions and limitations under the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * </bsn.cl></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ********************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef __ONLP_MODULE_H__</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define __ONLP_MODULE_H__</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="onlp__config_8h.html">onlp/onlp_config.h</a>></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <onlp/onlp.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <onlplib/onie.h></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <onlplib/pi.h></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <<a class="code" href="oids_8h.html">onlp/oids.h</a>></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structonlp__module__info__s.html"> 41</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structonlp__module__info__s.html">onlp_module_info_s</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structonlp__module__info__s.html#a1a8564319f3c601832364aa33bfa9ad0"> 43</a></span>  <a class="code" href="structonlp__oid__hdr__s.html">onlp_oid_hdr_t</a> <a class="code" href="structonlp__module__info__s.html#a1a8564319f3c601832364aa33bfa9ad0">hdr</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">/* Module objects have no dedicated fields. */</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <a class="code" href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gaf0fffd240af6133de708bd5826d6b53b">onlp_module_sw_init</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#ga4eb92a50197927c4073ad9834f63313f">onlp_module_hw_init</a>(uint32_t flags);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gafcf71feb9c8da89f6c5d1d474aa08c86">onlp_module_sw_denit</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gac1703816dc97c5bc733eaefd64274405">onlp_module_hdr_get</a>(<a class="code" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, <a class="code" href="structonlp__oid__hdr__s.html">onlp_oid_hdr_t</a>* <a class="code" href="structonlp__module__info__s.html#a1a8564319f3c601832364aa33bfa9ad0">hdr</a>);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gadca3359f4cf0aa19c79e5b64f8f32eba">onlp_module_info_get</a>(<a class="code" href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a> oid, <a class="code" href="structonlp__module__info__s.html">onlp_module_info_t</a>* info);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gaa6c560b25a4d38d5ad373e266c671f54">onlp_module_info_to_user_json</a>(<a class="code" href="structonlp__module__info__s.html">onlp_module_info_t</a>* info, cJSON** rv, uint32_t flags);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#ga17d1a205aa97e17304f55f44b29a458d">onlp_module_info_to_json</a>(<a class="code" href="structonlp__module__info__s.html">onlp_module_info_t</a>* info, cJSON** rv, uint32_t flags);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> <a class="code" href="group__oid-module.html#gae20051e9ae1b103aefadb85a32331aa2">onlp_module_info_from_json</a>(cJSON* cj, <a class="code" href="structonlp__module__info__s.html">onlp_module_info_t</a>* info);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif </span><span class="comment">/* __ONLP_MODULE_H_ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/* @} */</span></div><div class="ttc" id="onlp__config_8h_html"><div class="ttname"><a href="onlp__config_8h.html">onlp_config.h</a></div><div class="ttdoc">onlp Configuration Header </div></div>
|
|
<div class="ttc" id="group__oid-module_html_gae20051e9ae1b103aefadb85a32331aa2"><div class="ttname"><a href="group__oid-module.html#gae20051e9ae1b103aefadb85a32331aa2">onlp_module_info_from_json</a></div><div class="ttdeci">int onlp_module_info_from_json(cJSON *cj, onlp_module_info_t *info)</div><div class="ttdoc">Convert a JSON object to a module info structure. </div></div>
|
|
<div class="ttc" id="group__oid-module_html_ga17d1a205aa97e17304f55f44b29a458d"><div class="ttname"><a href="group__oid-module.html#ga17d1a205aa97e17304f55f44b29a458d">onlp_module_info_to_json</a></div><div class="ttdeci">int onlp_module_info_to_json(onlp_module_info_t *info, cJSON **rv, uint32_t flags)</div><div class="ttdoc">Convert a module info structure to JSON. </div></div>
|
|
<div class="ttc" id="group__oid-module_html_gaf0fffd240af6133de708bd5826d6b53b"><div class="ttname"><a href="group__oid-module.html#gaf0fffd240af6133de708bd5826d6b53b">onlp_module_sw_init</a></div><div class="ttdeci">int onlp_module_sw_init(void)</div><div class="ttdoc">Initialize the module software module. </div></div>
|
|
<div class="ttc" id="oids_8h_html"><div class="ttname"><a href="oids_8h.html">oids.h</a></div><div class="ttdoc">Object Identifiers. </div></div>
|
|
<div class="ttc" id="group__oid_html_gae6a6c9be0f593051fa446ce33afcf98f"><div class="ttname"><a href="group__oid.html#gae6a6c9be0f593051fa446ce33afcf98f">onlp_oid_t</a></div><div class="ttdeci">uint32_t onlp_oid_t</div><div class="ttdef"><b>Definition:</b> oids.h:52</div></div>
|
|
<div class="ttc" id="group__oid-module_html_gaa6c560b25a4d38d5ad373e266c671f54"><div class="ttname"><a href="group__oid-module.html#gaa6c560b25a4d38d5ad373e266c671f54">onlp_module_info_to_user_json</a></div><div class="ttdeci">int onlp_module_info_to_user_json(onlp_module_info_t *info, cJSON **rv, uint32_t flags)</div><div class="ttdoc">Convert a module info structure to user JSON. </div></div>
|
|
<div class="ttc" id="group__oid-module_html_ga4eb92a50197927c4073ad9834f63313f"><div class="ttname"><a href="group__oid-module.html#ga4eb92a50197927c4073ad9834f63313f">onlp_module_hw_init</a></div><div class="ttdeci">int onlp_module_hw_init(uint32_t flags)</div><div class="ttdoc">Initialize the module. </div></div>
|
|
<div class="ttc" id="structonlp__module__info__s_html_a1a8564319f3c601832364aa33bfa9ad0"><div class="ttname"><a href="structonlp__module__info__s.html#a1a8564319f3c601832364aa33bfa9ad0">onlp_module_info_s::hdr</a></div><div class="ttdeci">onlp_oid_hdr_t hdr</div><div class="ttdef"><b>Definition:</b> module.h:43</div></div>
|
|
<div class="ttc" id="group__oid-module_html_gac1703816dc97c5bc733eaefd64274405"><div class="ttname"><a href="group__oid-module.html#gac1703816dc97c5bc733eaefd64274405">onlp_module_hdr_get</a></div><div class="ttdeci">int onlp_module_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t *hdr)</div><div class="ttdoc">Get the module header structure. </div></div>
|
|
<div class="ttc" id="structonlp__module__info__s_html"><div class="ttname"><a href="structonlp__module__info__s.html">onlp_module_info_s</a></div><div class="ttdoc">Module OID Information Structure. </div><div class="ttdef"><b>Definition:</b> module.h:41</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 class="ttc" id="group__oid-module_html_ga246953cdb6be7b83bac70f0b1d7c297a"><div class="ttname"><a href="group__oid-module.html#ga246953cdb6be7b83bac70f0b1d7c297a">onlp_module_info_t</a></div><div class="ttdeci">struct onlp_module_info_s onlp_module_info_t</div><div class="ttdoc">Module OID Information Structure. </div></div>
|
|
<div class="ttc" id="group__oid-module_html_gafcf71feb9c8da89f6c5d1d474aa08c86"><div class="ttname"><a href="group__oid-module.html#gafcf71feb9c8da89f6c5d1d474aa08c86">onlp_module_sw_denit</a></div><div class="ttdeci">int onlp_module_sw_denit(void)</div><div class="ttdoc">Deinitialize the module software module. </div></div>
|
|
<div class="ttc" id="group__oid-module_html_gadca3359f4cf0aa19c79e5b64f8f32eba"><div class="ttname"><a href="group__oid-module.html#gadca3359f4cf0aa19c79e5b64f8f32eba">onlp_module_info_get</a></div><div class="ttdeci">int onlp_module_info_get(onlp_oid_t oid, onlp_module_info_t *info)</div><div class="ttdoc">Get the module info structure. </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|