[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / _mm_service_mgr_8h.html
diff --git a/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/_mm_service_mgr_8h.html b/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/_mm_service_mgr_8h.html
+++ /dev/null
@@ -1,293 +0,0 @@
-<!-- HTML header for doxygen 1.8.9.1-->
-<!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.9.1"/>
-<title>IPC API: ti/ipc/mm/MmServiceMgr.h File Reference</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>
-<script type="text/javascript">
- $(document).ready(function() { init_search(); });
-</script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<table width="100%">
-<tr>
- <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
- <td bgcolor="red"><img src="titagline.gif" /></td>
-</tr>
-</table>
-<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 style="padding-left: 0.5em;">
- <div id="projectname">IPC API
-  <span id="projectnumber">3.43.00.00_eng</span>
- </div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.9.1 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </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_46079174fecd82ead33d8fa28082a6fc.html">ti</a></li><li class="navelem"><a class="el" href="dir_d15d182bf14778c656928067305f92ce.html">ipc</a></li><li class="navelem"><a class="el" href="dir_56fd8ac1e7e4a8b4fba40e09a040211b.html">mm</a></li> </ul>
-</div>
-</div><!-- top -->
-<div class="header">
- <div class="summary">
-<a href="#define-members">Macros</a> |
-<a href="#typedef-members">Typedefs</a> |
-<a href="#func-members">Functions</a> </div>
- <div class="headertitle">
-<div class="title">MmServiceMgr.h File Reference</div> </div>
-</div><!--header-->
-<div class="contents">
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Multi-Media Service Manager. </p>
-<dl class="section note"><dt>Note</dt><dd>MmServiceMgr is currently only available for SYS/BIOS, when providing services for an MmRpc client on Linux or QNX. </dd></dl>
-</div><div class="textblock"><code>#include <<a class="el" href="_rcm_server_8h_source.html">ti/grcm/RcmServer.h</a>></code><br />
-<code>#include <<a class="el" href="_mm_type_8h_source.html">ti/ipc/mm/MmType.h</a>></code><br />
-<code>#include <ti/srvmgr/omaprpc/OmapRpc.h></code><br />
-</div><div class="textblock"><div class="dynheader">
-Include dependency graph for MmServiceMgr.h:</div>
-<div class="dyncontent">
-<div class="center"><img src="_mm_service_mgr_8h__incl.png" border="0" usemap="#ti_2ipc_2mm_2_mm_service_mgr_8h" alt=""/></div>
-<map name="ti_2ipc_2mm_2_mm_service_mgr_8h" id="ti_2ipc_2mm_2_mm_service_mgr_8h">
-<area shape="rect" id="node3" href="_rcm_server_8h.html" title="Remote Command Message Server Module. An RcmServer processes inbound messages received from an RcmCli..." alt="" coords="47,160,189,189"/><area shape="rect" id="node16" href="_mm_type_8h.html" title="Specific types to support the MmRpc and MmServiceMgr modules. " alt="" coords="102,83,243,112"/><area shape="rect" id="node9" href="_rcm_types_8h.html" title="Remote Command Message Types. " alt="" coords="225,237,366,267"/><area shape="rect" id="node13" href="_rcm_client_8h.html" title="Remote Command Message Client Module. An RcmClient is used for sending messages to an RcmServer for p..." alt="" coords="235,315,374,344"/></map>
-</div>
-</div>
-<p><a href="_mm_service_mgr_8h_source.html">Go to the source code of this file.</a></p>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
-Macros</h2></td></tr>
-<tr class="memitem:a10480a06df5b40b8f2b757c81e5dbc3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#a10480a06df5b40b8f2b757c81e5dbc3e">MmServiceMgr_S_SUCCESS</a>   (0)</td></tr>
-<tr class="memdesc:a10480a06df5b40b8f2b757c81e5dbc3e"><td class="mdescLeft"> </td><td class="mdescRight">Operation is successful. <a href="#a10480a06df5b40b8f2b757c81e5dbc3e">More...</a><br /></td></tr>
-<tr class="separator:a10480a06df5b40b8f2b757c81e5dbc3e"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a69c9544e7814e0048cf3436920afe78c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#a69c9544e7814e0048cf3436920afe78c">MmServiceMgr_E_FAIL</a>   (-1)</td></tr>
-<tr class="memdesc:a69c9544e7814e0048cf3436920afe78c"><td class="mdescLeft"> </td><td class="mdescRight">Operation failed. <a href="#a69c9544e7814e0048cf3436920afe78c">More...</a><br /></td></tr>
-<tr class="separator:a69c9544e7814e0048cf3436920afe78c"><td class="memSeparator" colspan="2"> </td></tr>
-</table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
-Typedefs</h2></td></tr>
-<tr class="memitem:afdfe34d5c7939aaa8e16ed6f11a071cf"><td class="memItemLeft" align="right" valign="top">typedef Void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#afdfe34d5c7939aaa8e16ed6f11a071cf">MmServiceMgr_DelFxn</a>) (Void)</td></tr>
-<tr class="separator:afdfe34d5c7939aaa8e16ed6f11a071cf"><td class="memSeparator" colspan="2"> </td></tr>
-</table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
-Functions</h2></td></tr>
-<tr class="memitem:a39e593b72aec2632f5a27281b7166add"><td class="memItemLeft" align="right" valign="top">Int </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#a39e593b72aec2632f5a27281b7166add">MmServiceMgr_init</a> (Void)</td></tr>
-<tr class="memdesc:a39e593b72aec2632f5a27281b7166add"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the MmServiceMgr module. <a href="#a39e593b72aec2632f5a27281b7166add">More...</a><br /></td></tr>
-<tr class="separator:a39e593b72aec2632f5a27281b7166add"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a445e530940a71c7afc7b644aa91196b5"><td class="memItemLeft" align="right" valign="top">Void </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#a445e530940a71c7afc7b644aa91196b5">MmServiceMgr_exit</a> (Void)</td></tr>
-<tr class="memdesc:a445e530940a71c7afc7b644aa91196b5"><td class="mdescLeft"> </td><td class="mdescRight">Finalize the MmServiceMgr module. <a href="#a445e530940a71c7afc7b644aa91196b5">More...</a><br /></td></tr>
-<tr class="separator:a445e530940a71c7afc7b644aa91196b5"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a2c283e7fcb26295b774115bc8024253a"><td class="memItemLeft" align="right" valign="top">Int </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#a2c283e7fcb26295b774115bc8024253a">MmServiceMgr_register</a> (const String name, <a class="el" href="struct_rcm_server___params.html">RcmServer_Params</a> *params, <a class="el" href="struct_mm_type___fxn_sig_tab.html">MmType_FxnSigTab</a> *fxnSigTab, <a class="el" href="_mm_service_mgr_8h.html#afdfe34d5c7939aaa8e16ed6f11a071cf">MmServiceMgr_DelFxn</a> delFxn)</td></tr>
-<tr class="memdesc:a2c283e7fcb26295b774115bc8024253a"><td class="mdescLeft"> </td><td class="mdescRight">Register a new service. <a href="#a2c283e7fcb26295b774115bc8024253a">More...</a><br /></td></tr>
-<tr class="separator:a2c283e7fcb26295b774115bc8024253a"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:af42777d075e1def65d22167a2cd31bad"><td class="memItemLeft" align="right" valign="top">UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="_mm_service_mgr_8h.html#af42777d075e1def65d22167a2cd31bad">MmServiceMgr_getId</a> ()</td></tr>
-<tr class="memdesc:af42777d075e1def65d22167a2cd31bad"><td class="mdescLeft"> </td><td class="mdescRight">Get the ID of the current service instance This function can only be called in the context of skeleton functions or service deletion function registered for a service. <a href="#af42777d075e1def65d22167a2cd31bad">More...</a><br /></td></tr>
-<tr class="separator:af42777d075e1def65d22167a2cd31bad"><td class="memSeparator" colspan="2"> </td></tr>
-</table>
-<h2 class="groupheader">Macro Definition Documentation</h2>
-<a class="anchor" id="a10480a06df5b40b8f2b757c81e5dbc3e"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define MmServiceMgr_S_SUCCESS   (0)</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Operation is successful. </p>
-
-</div>
-</div>
-<a class="anchor" id="a69c9544e7814e0048cf3436920afe78c"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define MmServiceMgr_E_FAIL   (-1)</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Operation failed. </p>
-
-</div>
-</div>
-<h2 class="groupheader">Typedef Documentation</h2>
-<a class="anchor" id="afdfe34d5c7939aaa8e16ed6f11a071cf"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef Void(* MmServiceMgr_DelFxn) (Void)</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-</div>
-</div>
-<h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="a39e593b72aec2632f5a27281b7166add"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Int MmServiceMgr_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 MmServiceMgr module. </p>
-
-</div>
-</div>
-<a class="anchor" id="a445e530940a71c7afc7b644aa91196b5"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Void MmServiceMgr_exit </td>
- <td>(</td>
- <td class="paramtype">Void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Finalize the MmServiceMgr module. </p>
-
-</div>
-</div>
-<a class="anchor" id="a2c283e7fcb26295b774115bc8024253a"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Int MmServiceMgr_register </td>
- <td>(</td>
- <td class="paramtype">const String </td>
- <td class="paramname"><em>name</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_rcm_server___params.html">RcmServer_Params</a> * </td>
- <td class="paramname"><em>params</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_mm_type___fxn_sig_tab.html">MmType_FxnSigTab</a> * </td>
- <td class="paramname"><em>fxnSigTab</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_mm_service_mgr_8h.html#afdfe34d5c7939aaa8e16ed6f11a071cf">MmServiceMgr_DelFxn</a> </td>
- <td class="paramname"><em>delFxn</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Register a new service. </p>
-
-</div>
-</div>
-<a class="anchor" id="af42777d075e1def65d22167a2cd31bad"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UInt32 MmServiceMgr_getId </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Get the ID of the current service instance This function can only be called in the context of skeleton functions or service deletion function registered for a service. </p>
-
-</div>
-</div>
-</div><!-- contents -->
-<!-- HTML footer for doxygen 1.8.9.1-->
-<!-- start footer part -->
-<hr class="footer"/><small>
-Copyright 2016, Texas Instruments Incorporated
-</small>
-</body>
-</html>