337 lines
16 KiB
HTML
337 lines
16 KiB
HTML
<!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: sdrv_pdm_stream</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"> 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&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&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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">sdrv_pdm_stream</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="sdrv__pdm_8h_source.html">sdrv_pdm.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:acf4b97bbe414db252e6800ca8a320183"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#acf4b97bbe414db252e6800ca8a320183">params</a></td></tr>
|
|
<tr class="separator:acf4b97bbe414db252e6800ca8a320183"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a229c91ec2a19d3b92985c49b27befd70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a229c91ec2a19d3b92985c49b27befd70">queue</a> [<a class="el" href="sdrv__pdm_8h.html#aa5f55bb70b1dd9b8d9ffbbaec2761dbb">SDRV_PDM_XFER_NUM_TRANSFERS</a>]</td></tr>
|
|
<tr class="separator:a229c91ec2a19d3b92985c49b27befd70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a03c996f9fcf0e10baeb3e700be0c409a">active</a></td></tr>
|
|
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa004094e7ef589abe14f66ace8945999"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#aa004094e7ef589abe14f66ace8945999">queue_appl</a></td></tr>
|
|
<tr class="separator:aa004094e7ef589abe14f66ace8945999"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1aa5e9aa3fd624d68d9df484f2a28380"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a1aa5e9aa3fd624d68d9df484f2a28380">queue_hw</a></td></tr>
|
|
<tr class="separator:a1aa5e9aa3fd624d68d9df484f2a28380"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1788acec82e2bf3e13a24fa5565e152"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#a15f6a35be4a21b3589392023a9533632">sdrv_pdm_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#aa1788acec82e2bf3e13a24fa5565e152">callback</a></td></tr>
|
|
<tr class="separator:aa1788acec82e2bf3e13a24fa5565e152"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae376f130b17d169ee51be68077a89ed0"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#ae376f130b17d169ee51be68077a89ed0">context</a></td></tr>
|
|
<tr class="separator:ae376f130b17d169ee51be68077a89ed0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a142f56bdf9c7e0546166a44f9979b543"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a142f56bdf9c7e0546166a44f9979b543">pack_mode</a></td></tr>
|
|
<tr class="separator:a142f56bdf9c7e0546166a44f9979b543"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adebecf1bff981bf49d5720d55a09839f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#adebecf1bff981bf49d5720d55a09839f">data_lsb</a></td></tr>
|
|
<tr class="separator:adebecf1bff981bf49d5720d55a09839f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b6b59d1a0cad809e0a8347d8e36a6ba"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a8b6b59d1a0cad809e0a8347d8e36a6ba">threshold</a></td></tr>
|
|
<tr class="separator:a8b6b59d1a0cad809e0a8347d8e36a6ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad537088ae307168050745cdb808d3db3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__dma_8h.html#a8398793befd907d68bc1b103b1ea1080">sdrv_dma_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#ad537088ae307168050745cdb808d3db3">dma_instance</a></td></tr>
|
|
<tr class="separator:ad537088ae307168050745cdb808d3db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34aa835482fb9840731ff85fe8387026"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsdrv__dma__channel__t.html">sdrv_dma_channel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#a34aa835482fb9840731ff85fe8387026">dma_channel</a></td></tr>
|
|
<tr class="separator:a34aa835482fb9840731ff85fe8387026"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad30e75a5c5d769900a9e669132129487"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#aa0066ff9fbe7c438acfc86abb99178cf">sdrv_pdm_dma_data_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html#ad30e75a5c5d769900a9e669132129487">dma_data</a></td></tr>
|
|
<tr class="separator:ad30e75a5c5d769900a9e669132129487"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a03c996f9fcf0e10baeb3e700be0c409a" name="a03c996f9fcf0e10baeb3e700be0c409a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03c996f9fcf0e10baeb3e700be0c409a">◆ </a></span>active</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool active</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >app submit enqueue transfer index </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa1788acec82e2bf3e13a24fa5565e152" name="aa1788acec82e2bf3e13a24fa5565e152"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa1788acec82e2bf3e13a24fa5565e152">◆ </a></span>callback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#a15f6a35be4a21b3589392023a9533632">sdrv_pdm_callback</a> callback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >user callback context </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae376f130b17d169ee51be68077a89ed0" name="ae376f130b17d169ee51be68077a89ed0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae376f130b17d169ee51be68077a89ed0">◆ </a></span>context</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* context</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >data pack or loose mode in fifo </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adebecf1bff981bf49d5720d55a09839f" name="adebecf1bff981bf49d5720d55a09839f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adebecf1bff981bf49d5720d55a09839f">◆ </a></span>data_lsb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool data_lsb</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >pdm request dma transfer when fifo data is <= threshold for capture </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b885325a1df082d56167b38f5a629a4" name="a9b885325a1df082d56167b38f5a629a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b885325a1df082d56167b38f5a629a4">◆ </a></span>dma_abort</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool dma_abort</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23113ad9a7744b3004811e6713e7f838" name="a23113ad9a7744b3004811e6713e7f838"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23113ad9a7744b3004811e6713e7f838">◆ </a></span>dma_buf</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#a5faa830133ab27dab59d6cbae4ede62b">sdrv_pdm_dma_buf_t</a> dma_buf</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a34aa835482fb9840731ff85fe8387026" name="a34aa835482fb9840731ff85fe8387026"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34aa835482fb9840731ff85fe8387026">◆ </a></span>dma_channel</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structsdrv__dma__channel__t.html">sdrv_dma_channel_t</a> dma_channel</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >dma fifo descriptions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad30e75a5c5d769900a9e669132129487" name="ad30e75a5c5d769900a9e669132129487"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad30e75a5c5d769900a9e669132129487">◆ </a></span>dma_data</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#aa0066ff9fbe7c438acfc86abb99178cf">sdrv_pdm_dma_data_t</a> dma_data</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >dma mode must set dma_buf addr, size=period_count*period_size </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad537088ae307168050745cdb808d3db3" name="ad537088ae307168050745cdb808d3db3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad537088ae307168050745cdb808d3db3">◆ </a></span>dma_instance</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__dma_8h.html#a8398793befd907d68bc1b103b1ea1080">sdrv_dma_t</a> dma_instance</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >dma module channel handle <br />
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a142f56bdf9c7e0546166a44f9979b543" name="a142f56bdf9c7e0546166a44f9979b543"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a142f56bdf9c7e0546166a44f9979b543">◆ </a></span>pack_mode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool pack_mode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >data format in fifo </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf4b97bbe414db252e6800ca8a320183" name="acf4b97bbe414db252e6800ca8a320183"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf4b97bbe414db252e6800ca8a320183">◆ </a></span>params</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> params</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >< pdm config params app submit transfer ,max is SDRV_PDM_XFER_NUM_TRANSFERS </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a229c91ec2a19d3b92985c49b27befd70" name="a229c91ec2a19d3b92985c49b27befd70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a229c91ec2a19d3b92985c49b27befd70">◆ </a></span>queue</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a> queue[<a class="el" href="sdrv__pdm_8h.html#aa5f55bb70b1dd9b8d9ffbbaec2761dbb">SDRV_PDM_XFER_NUM_TRANSFERS</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >stream status; true : running false:idle </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa004094e7ef589abe14f66ace8945999" name="aa004094e7ef589abe14f66ace8945999"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa004094e7ef589abe14f66ace8945999">◆ </a></span>queue_appl</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t queue_appl</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >hw dequeue transfer index </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1aa5e9aa3fd624d68d9df484f2a28380" name="a1aa5e9aa3fd624d68d9df484f2a28380"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1aa5e9aa3fd624d68d9df484f2a28380">◆ </a></span>queue_hw</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t queue_hw</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >user callback </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b6b59d1a0cad809e0a8347d8e36a6ba" name="a8b6b59d1a0cad809e0a8347d8e36a6ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b6b59d1a0cad809e0a8347d8e36a6ba">◆ </a></span>threshold</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned threshold</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >dma module instance handle </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/<a class="el" href="sdrv__pdm_8h_source.html">sdrv_pdm.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|