liumin/E3_boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
3159b3723bd3c34c4ce3f33be6f900f3ad606ec9
E3_boot/doc/Doxygen/html/sdrv__mbox_8h.html
liumin 7dc1e89694 增加所有文件
2025-11-07 10:05:24 +08:00

793 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SemiDrive SSDK Appication Program Interface: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/sdrv_mbox.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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">SemiDrive SSDK Appication Program Interface<span id="projectnumber">&#160;PTG3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_ee023d43c33bfccc31aa50a48a76892b.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sdrv_mbox.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;types.h&gt;</code><br />
<code>#include &lt;compiler.h&gt;</code><br />
<code>#include &lt;<a class="el" href="sdrv__common_8h_source.html">sdrv_common.h</a>&gt;</code><br />
</div>
<p><a href="sdrv__mbox_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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__mbox__chan__req.html">sdrv_mbox_chan_req</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__mbox__config.html">sdrv_mbox_config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__mbox__chan.html">sdrv_mbox_chan</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__mbox__dev.html">sdrv_mbox_dev</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a48e2edb701f13ccdb863c5271d56c058"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a48e2edb701f13ccdb863c5271d56c058">sdrv_mbox_rproc_t</a> </td></tr>
<tr class="separator:a48e2edb701f13ccdb863c5271d56c058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e802b267b24d63479f5f09b5916649d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a6e802b267b24d63479f5f09b5916649d">sdrv_mbox_addr_t</a> </td></tr>
<tr class="separator:a6e802b267b24d63479f5f09b5916649d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a21c47cc4e3404d48608964c2c8c69a64"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a21c47cc4e3404d48608964c2c8c69a64">sdrv_mbox_received</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *chan, uint8_t *data, uint32_t len)</td></tr>
<tr class="separator:a21c47cc4e3404d48608964c2c8c69a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaeadc35c1cb0c2e198bff98b91679af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#acaeadc35c1cb0c2e198bff98b91679af">sdrv_mbox_send_nobuf</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *sdrv_chan, uint8_t *data, uint32_t len, uint32_t timeout)</td></tr>
<tr class="separator:acaeadc35c1cb0c2e198bff98b91679af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e789231ed573a7c84e002de70a6746d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a9e789231ed573a7c84e002de70a6746d">sdrv_mbox_send</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *sdrv_chan, uint8_t *data, uint32_t len, uint32_t timeout)</td></tr>
<tr class="separator:a9e789231ed573a7c84e002de70a6746d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a917a9b8cc5831a15ee76b95e1ed1a292"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a917a9b8cc5831a15ee76b95e1ed1a292">sdrv_mbox_alloc_buffer</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *sdrv_chan, uint32_t len)</td></tr>
<tr class="separator:a917a9b8cc5831a15ee76b95e1ed1a292"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8703c7a959b1664b0f616489c6596263"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a8703c7a959b1664b0f616489c6596263">sdrv_mbox_send_nocopy</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *chan, uint8_t *data, uint32_t len, uint32_t timeout)</td></tr>
<tr class="separator:a8703c7a959b1664b0f616489c6596263"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99b4080337d03ff275eb8761ab58d5d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a99b4080337d03ff275eb8761ab58d5d1">sdrv_mbox_request_channel</a> (<a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *dev, <a class="el" href="sdrv__mbox_8h.html#a4e636fa58d50a4714b9cf70284e88b29">sdrv_mbox_chan_req_t</a> *chan_req)</td></tr>
<tr class="separator:a99b4080337d03ff275eb8761ab58d5d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd64b4752bfd054a6188ae7852fe172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a4cd64b4752bfd054a6188ae7852fe172">sdrv_mbox_release_channel</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *chan)</td></tr>
<tr class="separator:a4cd64b4752bfd054a6188ae7852fe172"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49ee26a6399b6854e105233cbd4fff7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a49ee26a6399b6854e105233cbd4fff7f">sdrv_mbox_set_callback</a> (<a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *chan, <a class="el" href="sdrv__mbox_8h.html#a07b7e725aa9d4bdcd29967b695762e0b">sdrv_mbox_rxcallback</a> callback, void *arg)</td></tr>
<tr class="separator:a49ee26a6399b6854e105233cbd4fff7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90d7371818d417bc234fd2b662c85660"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a90d7371818d417bc234fd2b662c85660">sdrv_mbox_mtu</a> (<a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *dev)</td></tr>
<tr class="separator:a90d7371818d417bc234fd2b662c85660"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61dc9d59145e362bed340006c9d5ee1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__mbox_8h.html#a61dc9d59145e362bed340006c9d5ee1b">sdrv_mbox_init</a> (<a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *dev, const <a class="el" href="sdrv__mbox_8h.html#a4db3d7ab9719040d80d86d4370a7b90d">sdrv_mbox_config_t</a> *cfg)</td></tr>
<tr class="separator:a61dc9d59145e362bed340006c9d5ee1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section copyright"><dt>Copyright</dt><dd>copyright description (c) 2022 Semidrive Semiconductor. All rights reserved.</dd></dl>
<h2><a class="anchor" id="autotoc_md6"></a>
Revision History:</h2>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a3937dc62653fd2dbb02133bd20ff8bdd" name="a3937dc62653fd2dbb02133bd20ff8bdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3937dc62653fd2dbb02133bd20ff8bdd">&#9670;&nbsp;</a></span>SDRV_MBOX_ANY_ADDR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_MBOX_ANY_ADDR&#160;&#160;&#160;-1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaf115b6f9a44ab6c202ee164c9935806" name="aaf115b6f9a44ab6c202ee164c9935806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf115b6f9a44ab6c202ee164c9935806">&#9670;&nbsp;</a></span>SDRV_MBOX_CHN_NUM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_MBOX_CHN_NUM&#160;&#160;&#160;8U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3fec681f3a8dae021487378cd0c801d7" name="a3fec681f3a8dae021487378cd0c801d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fec681f3a8dae021487378cd0c801d7">&#9670;&nbsp;</a></span>SDRV_MBOX_NO_WAIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_MBOX_NO_WAIT&#160;&#160;&#160;0U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af3790143ce06d070609a6ca6a4c2ccaa" name="af3790143ce06d070609a6ca6a4c2ccaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3790143ce06d070609a6ca6a4c2ccaa">&#9670;&nbsp;</a></span>SDRV_MBOX_SHORT_BUF_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_MBOX_SHORT_BUF_LEN&#160;&#160;&#160;4U</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="add92acdac61fc455960b986a818345c9" name="add92acdac61fc455960b986a818345c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add92acdac61fc455960b986a818345c9">&#9670;&nbsp;</a></span>SDRV_MBOX_WAIT_FOREVER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_MBOX_WAIT_FOREVER&#160;&#160;&#160;0xffffffffU</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a4e636fa58d50a4714b9cf70284e88b29" name="a4e636fa58d50a4714b9cf70284e88b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e636fa58d50a4714b9cf70284e88b29">&#9670;&nbsp;</a></span>sdrv_mbox_chan_req_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__mbox__chan__req.html">sdrv_mbox_chan_req</a> <a class="el" href="sdrv__mbox_8h.html#a4e636fa58d50a4714b9cf70284e88b29">sdrv_mbox_chan_req_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abd9040e55932cd049c7c1d6f7c1755da" name="abd9040e55932cd049c7c1d6f7c1755da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd9040e55932cd049c7c1d6f7c1755da">&#9670;&nbsp;</a></span>sdrv_mbox_chan_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__mbox__chan.html">sdrv_mbox_chan</a> <a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4db3d7ab9719040d80d86d4370a7b90d" name="a4db3d7ab9719040d80d86d4370a7b90d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4db3d7ab9719040d80d86d4370a7b90d">&#9670;&nbsp;</a></span>sdrv_mbox_config_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__mbox__config.html">sdrv_mbox_config</a> <a class="el" href="sdrv__mbox_8h.html#a4db3d7ab9719040d80d86d4370a7b90d">sdrv_mbox_config_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a07b7e725aa9d4bdcd29967b695762e0b" name="a07b7e725aa9d4bdcd29967b695762e0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07b7e725aa9d4bdcd29967b695762e0b">&#9670;&nbsp;</a></span>sdrv_mbox_rxcallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* sdrv_mbox_rxcallback) (void *arg, uint8_t *data, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1b299279cf3c17be6de57c89880d3e41" name="a1b299279cf3c17be6de57c89880d3e41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b299279cf3c17be6de57c89880d3e41">&#9670;&nbsp;</a></span>sdrv_mbox_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__mbox__dev.html">sdrv_mbox_dev</a> <a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a6e802b267b24d63479f5f09b5916649d" name="a6e802b267b24d63479f5f09b5916649d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e802b267b24d63479f5f09b5916649d">&#9670;&nbsp;</a></span>sdrv_mbox_addr_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__mbox_8h.html#a6e802b267b24d63479f5f09b5916649d">sdrv_mbox_addr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox address id </p>
<p >Mbox address id is used to define different mbox message types, especially for the frequent used messages, such as rpmsg or power-manage. Raw data (MBOX_ADDR_RAW) is usually chosen for the messages without any type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6e802b267b24d63479f5f09b5916649daf766b923aef492afce962e95ebc997ed" name="a6e802b267b24d63479f5f09b5916649daf766b923aef492afce962e95ebc997ed"></a>MBOX_ADDR_INVALID&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6e802b267b24d63479f5f09b5916649dadbe9c8e623eb42d8785ba6f4bce11887" name="a6e802b267b24d63479f5f09b5916649dadbe9c8e623eb42d8785ba6f4bce11887"></a>MBOX_ADDR_RAW&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6e802b267b24d63479f5f09b5916649da4a6a1b414d3349dfce47aa1c46d59335" name="a6e802b267b24d63479f5f09b5916649da4a6a1b414d3349dfce47aa1c46d59335"></a>MBOX_ADDR_IPCC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6e802b267b24d63479f5f09b5916649da621553d512cf7019e3ef92ae85acd49a" name="a6e802b267b24d63479f5f09b5916649da621553d512cf7019e3ef92ae85acd49a"></a>MBOX_ADDR_RPMSG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6e802b267b24d63479f5f09b5916649da8a1a2d1bcecff2d1f7f9811d0a06cee8" name="a6e802b267b24d63479f5f09b5916649da8a1a2d1bcecff2d1f7f9811d0a06cee8"></a>MBOX_ADDR_PM&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a9701c7df9fb7fae60a58e2216dde50ae" name="a9701c7df9fb7fae60a58e2216dde50ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9701c7df9fb7fae60a58e2216dde50ae">&#9670;&nbsp;</a></span>sdrv_mbox_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__mbox_8h.html#a9701c7df9fb7fae60a58e2216dde50ae">sdrv_mbox_error</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>mbox status error code. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9701c7df9fb7fae60a58e2216dde50aea2e56beac17808e8018d320c53248f040" name="a9701c7df9fb7fae60a58e2216dde50aea2e56beac17808e8018d320c53248f040"></a>SDRV_MBOX_STATUS_INVALID_MASTERID&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9701c7df9fb7fae60a58e2216dde50aea9b2c5610fd19dceec89f3f86ee40526d" name="a9701c7df9fb7fae60a58e2216dde50aea9b2c5610fd19dceec89f3f86ee40526d"></a>SDRV_MBOX_STATUS_LENGTH_ERROR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9701c7df9fb7fae60a58e2216dde50aea15c26bd6f3a7e1b4d554c7daeaef96ac" name="a9701c7df9fb7fae60a58e2216dde50aea15c26bd6f3a7e1b4d554c7daeaef96ac"></a>SDRV_MBOX_STATUS_NO_CHANNEL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9701c7df9fb7fae60a58e2216dde50aea6004f6db276b20679f86ccf90114fb0d" name="a9701c7df9fb7fae60a58e2216dde50aea6004f6db276b20679f86ccf90114fb0d"></a>SDRV_MBOX_STATUS_NO_MSG_BUFFER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9701c7df9fb7fae60a58e2216dde50aea30fe540bc37eb7d913a2a09079b7d240" name="a9701c7df9fb7fae60a58e2216dde50aea30fe540bc37eb7d913a2a09079b7d240"></a>SDRV_MBOX_STATUS_TIMEOUT&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="ae0621643e68d24cd55cd8d1b19f940a6" name="ae0621643e68d24cd55cd8d1b19f940a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0621643e68d24cd55cd8d1b19f940a6">&#9670;&nbsp;</a></span>sdrv_mbox_proc_id_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__mbox_8h.html#ae0621643e68d24cd55cd8d1b19f940a6">sdrv_mbox_proc_id_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6ac38a906f89a34c50ce59aab73fafe1d7" name="ae0621643e68d24cd55cd8d1b19f940a6ac38a906f89a34c50ce59aab73fafe1d7"></a>MBOX_PROC_ID_SF&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6a1aee6644419bb48bb45bafc009247e0f" name="ae0621643e68d24cd55cd8d1b19f940a6a1aee6644419bb48bb45bafc009247e0f"></a>MBOX_PROC_ID_SP0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6a8dae83b6636cd1eac4c7c1c3cba43896" name="ae0621643e68d24cd55cd8d1b19f940a6a8dae83b6636cd1eac4c7c1c3cba43896"></a>MBOX_PROC_ID_SP1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6ac94a2f2eb40f4351e1245cad5d730f5b" name="ae0621643e68d24cd55cd8d1b19f940a6ac94a2f2eb40f4351e1245cad5d730f5b"></a>MBOX_PROC_ID_SX0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6a07a91646ac3fe1084f8f5db50737ed1a" name="ae0621643e68d24cd55cd8d1b19f940a6a07a91646ac3fe1084f8f5db50737ed1a"></a>MBOX_PROC_ID_SX1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae0621643e68d24cd55cd8d1b19f940a6afeda3a427bbf945f1b596c6de8bc4ad8" name="ae0621643e68d24cd55cd8d1b19f940a6afeda3a427bbf945f1b596c6de8bc4ad8"></a>MBOX_PROC_ID_NUM&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a48e2edb701f13ccdb863c5271d56c058" name="a48e2edb701f13ccdb863c5271d56c058"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48e2edb701f13ccdb863c5271d56c058">&#9670;&nbsp;</a></span>sdrv_mbox_rproc_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__mbox_8h.html#a48e2edb701f13ccdb863c5271d56c058">sdrv_mbox_rproc_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox remote processor bitmap </p>
<p >Multi remote processors can be combined by the symbol '|', for example, MBOX_RPROC_SF | MBOX_RPROC_SP0. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a48e2edb701f13ccdb863c5271d56c058aaf82b98a5371f3eef680c0d86869dfea" name="a48e2edb701f13ccdb863c5271d56c058aaf82b98a5371f3eef680c0d86869dfea"></a>MBOX_RPROC_SF&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a48e2edb701f13ccdb863c5271d56c058afe66bd33f7652ea4f9d989ac9981a160" name="a48e2edb701f13ccdb863c5271d56c058afe66bd33f7652ea4f9d989ac9981a160"></a>MBOX_RPROC_SP0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a48e2edb701f13ccdb863c5271d56c058ad11fd862131f4791416131a3924e877f" name="a48e2edb701f13ccdb863c5271d56c058ad11fd862131f4791416131a3924e877f"></a>MBOX_RPROC_SP1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a48e2edb701f13ccdb863c5271d56c058a5a32fbcdc233f3be7b52c719bb504a9d" name="a48e2edb701f13ccdb863c5271d56c058a5a32fbcdc233f3be7b52c719bb504a9d"></a>MBOX_RPROC_SX0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a48e2edb701f13ccdb863c5271d56c058a338bca99a1d757cc3aa3f048bf496b2c" name="a48e2edb701f13ccdb863c5271d56c058a338bca99a1d757cc3aa3f048bf496b2c"></a>MBOX_RPROC_SX1&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a917a9b8cc5831a15ee76b95e1ed1a292" name="a917a9b8cc5831a15ee76b95e1ed1a292"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917a9b8cc5831a15ee76b95e1ed1a292">&#9670;&nbsp;</a></span>sdrv_mbox_alloc_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t * sdrv_mbox_alloc_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>sdrv_chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox channel allocate buffer </p>
<p >This function allocates data buffers, and copy mailbox data to the buffers first. And then, another function (sdrv_mbox_send_nocopy) is called to send mailbox data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length, unit: 2 bytes return buffer address </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a61dc9d59145e362bed340006c9d5ee1b" name="a61dc9d59145e362bed340006c9d5ee1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61dc9d59145e362bed340006c9d5ee1b">&#9670;&nbsp;</a></span>sdrv_mbox_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__mbox_8h.html#a4db3d7ab9719040d80d86d4370a7b90d">sdrv_mbox_config_t</a> *&#160;</td>
<td class="paramname"><em>cfg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox init </p>
<p >This function initializes mailbox device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>sdrv mbox device </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>sdrv mbox configuration </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a90d7371818d417bc234fd2b662c85660" name="a90d7371818d417bc234fd2b662c85660"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90d7371818d417bc234fd2b662c85660">&#9670;&nbsp;</a></span>sdrv_mbox_mtu()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t sdrv_mbox_mtu </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox get mtu </p>
<p >This function gets maximum transmission unit.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>sdrv mbox dev </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>mtu </dd></dl>
</div>
</div>
<a id="a21c47cc4e3404d48608964c2c8c69a64" name="a21c47cc4e3404d48608964c2c8c69a64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21c47cc4e3404d48608964c2c8c69a64">&#9670;&nbsp;</a></span>sdrv_mbox_received()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sdrv_mbox_received </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox receive message </p>
<p >This function receives mailbox message data. It should be called before other core send mailbox data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>sdrv mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>msg data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>len </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>receive result </dd></dl>
</div>
</div>
<a id="a4cd64b4752bfd054a6188ae7852fe172" name="a4cd64b4752bfd054a6188ae7852fe172"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cd64b4752bfd054a6188ae7852fe172">&#9670;&nbsp;</a></span>sdrv_mbox_release_channel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_release_channel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>chan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox release channel </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>sdrv mbox chan </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK or error code </dd></dl>
</div>
</div>
<a id="a99b4080337d03ff275eb8761ab58d5d1" name="a99b4080337d03ff275eb8761ab58d5d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b4080337d03ff275eb8761ab58d5d1">&#9670;&nbsp;</a></span>sdrv_mbox_request_channel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> * sdrv_mbox_request_channel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#a1b299279cf3c17be6de57c89880d3e41">sdrv_mbox_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#a4e636fa58d50a4714b9cf70284e88b29">sdrv_mbox_chan_req_t</a> *&#160;</td>
<td class="paramname"><em>chan_req</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox client request channel </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>mbox dev </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">chan_req</td><td>mbox channel request param </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>mbox channel </dd></dl>
</div>
</div>
<a id="a9e789231ed573a7c84e002de70a6746d" name="a9e789231ed573a7c84e002de70a6746d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e789231ed573a7c84e002de70a6746d">&#9670;&nbsp;</a></span>sdrv_mbox_send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>sdrv_chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox channel send data use message buf </p>
<p >This function is used to send mailbox data in standard flow:</p><ol type="1">
<li>allocate data buffers</li>
<li>copy data to the buffers</li>
<li>send data from the buffers</li>
</ol>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>data ptr </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length, unit: 2 bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>wait timeout(millisecond), timeout should not be too small. return send result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acaeadc35c1cb0c2e198bff98b91679af" name="acaeadc35c1cb0c2e198bff98b91679af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaeadc35c1cb0c2e198bff98b91679af">&#9670;&nbsp;</a></span>sdrv_mbox_send_nobuf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_send_nobuf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>sdrv_chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox channel send short data </p>
<p >This function is used to send mailbox data without buffers. The data length is not more than 4 bytes. The mailbox data will be saved in registers and send directly.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>data ptr </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length, unit: 2 bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>wait timeout(millisecond), timeout should not be too small. return send result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8703c7a959b1664b0f616489c6596263" name="a8703c7a959b1664b0f616489c6596263"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8703c7a959b1664b0f616489c6596263">&#9670;&nbsp;</a></span>sdrv_mbox_send_nocopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_send_nocopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox channel send data no copy </p>
<p >This function is used to send mailbox data without repeating to copy data. This function is combined with the function sdrv_mbox_alloc_buffer, sending the data which have been stored in the buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>data ptr </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length, unit: 2 bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>wait timeout(millisecond), timeout should not be too small. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>send result </dd></dl>
</div>
</div>
<a id="a49ee26a6399b6854e105233cbd4fff7f" name="a49ee26a6399b6854e105233cbd4fff7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49ee26a6399b6854e105233cbd4fff7f">&#9670;&nbsp;</a></span>sdrv_mbox_set_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_mbox_set_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#abd9040e55932cd049c7c1d6f7c1755da">sdrv_mbox_chan_t</a> *&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__mbox_8h.html#a07b7e725aa9d4bdcd29967b695762e0b">sdrv_mbox_rxcallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sdrv mbox set callback </p>
<p >This function sets mailbox callback function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chan</td><td>sdrv mbox channel </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>callback function </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>callback argument </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK or error code </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink