820 lines
46 KiB
HTML
820 lines
46 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: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/sdrv_pdm.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"> 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 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> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">sdrv_pdm.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <types.h></code><br />
|
|
<code>#include "<a class="el" href="sdrv__ckgen_8h_source.html">sdrv_ckgen.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="sdrv__common_8h_source.html">sdrv_common.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="sdrv__dma_8h_source.html">sdrv_dma.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="sdrv__pdm_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__dma__data.html">sdrv_pdm_dma_data</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__dma__buf.html">sdrv_pdm_dma_buf</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__transfer.html">sdrv_pdm_transfer</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__params.html">sdrv_pdm_params</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__stream.html">sdrv_pdm_stream</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm__config.html">sdrv_pdm_config</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__pdm.html">sdrv_pdm</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:ae575738dc6d616b4dba4c0323496ea74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#ae575738dc6d616b4dba4c0323496ea74">sdrv_pdm_init</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm, <a class="el" href="sdrv__pdm_8h.html#a9d5e7a1f6041ed25a6020a429521c62a">sdrv_pdm_config_t</a> *cfg)</td></tr>
|
|
<tr class="separator:ae575738dc6d616b4dba4c0323496ea74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac53bf4c2822e8b2baf50246074dfd8ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#ac53bf4c2822e8b2baf50246074dfd8ea">sdrv_pdm_get_default_params</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm, <a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> *params)</td></tr>
|
|
<tr class="separator:ac53bf4c2822e8b2baf50246074dfd8ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefac841cd453d656130c027bebc909ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#aefac841cd453d656130c027bebc909ca">sdrv_pdm_set_params</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm, <a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> *params)</td></tr>
|
|
<tr class="separator:aefac841cd453d656130c027bebc909ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06fc3ad97dbebf04ebc6b8d283daca81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#a06fc3ad97dbebf04ebc6b8d283daca81">sdrv_pdm_create_transfer</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm, <a class="el" href="sdrv__pdm_8h.html#a15f6a35be4a21b3589392023a9533632">sdrv_pdm_callback</a> callback, void *context)</td></tr>
|
|
<tr class="separator:a06fc3ad97dbebf04ebc6b8d283daca81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a701e5750c55a6722cc0beed68036c5a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#a701e5750c55a6722cc0beed68036c5a6">sdrv_pdm_submit_transfer</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm, <a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a> *transfer)</td></tr>
|
|
<tr class="separator:a701e5750c55a6722cc0beed68036c5a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab061d291368679923d2d6b413bb5135b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#ab061d291368679923d2d6b413bb5135b">sdrv_pdm_start</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm)</td></tr>
|
|
<tr class="separator:ab061d291368679923d2d6b413bb5135b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99481ea849668d306a2f42a0519a2386"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pdm_8h.html#a99481ea849668d306a2f42a0519a2386">sdrv_pdm_stop</a> (<a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> *pdm)</td></tr>
|
|
<tr class="separator:a99481ea849668d306a2f42a0519a2386"><td class="memSeparator" colspan="2"> </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 (c) 2021 Semidrive Semiconductor. All rights reserved. </dd></dl>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a2aff57760c5e516dd2eb2bc9f9ecd6db" name="a2aff57760c5e516dd2eb2bc9f9ecd6db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2aff57760c5e516dd2eb2bc9f9ecd6db">◆ </a></span>SDRV_PDM_CHANNELS_BYTES</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_CHANNELS_BYTES   (<a class="el" href="sdrv__pdm_8h.html#a4570528ca17819f9b000e5eb633f57a8a33503b97cfe0dd4fa0ea247297e21148">SDRV_PDM_SAMPLE_WIDTH_16BITS</a> / 8)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1124ebe14bc5fb3a74d39d1812ee4789" name="a1124ebe14bc5fb3a74d39d1812ee4789"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1124ebe14bc5fb3a74d39d1812ee4789">◆ </a></span>SDRV_PDM_CHANNELS_COUNT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_CHANNELS_COUNT   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a833aed7ea252439d00f9e5f63855fe0f" name="a833aed7ea252439d00f9e5f63855fe0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a833aed7ea252439d00f9e5f63855fe0f">◆ </a></span>SDRV_PDM_DMA_BUF_TOTAL_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_DMA_BUF_TOTAL_SIZE    <a class="el" href="sdrv__pdm_8h.html#a94b3ede7072e8020fddc9030e486d0a2">SDRV_PDM_DMA_PERIOD_SIZE</a> *<a class="el" href="sdrv__pdm_8h.html#a117930644c55609482373c6bb501c4fe">SDRV_PDM_DMA_PERIOD_COUNT</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a117930644c55609482373c6bb501c4fe" name="a117930644c55609482373c6bb501c4fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a117930644c55609482373c6bb501c4fe">◆ </a></span>SDRV_PDM_DMA_PERIOD_COUNT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_DMA_PERIOD_COUNT   2</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f43749c6587bf56874c0b86f6f8c1b5" name="a0f43749c6587bf56874c0b86f6f8c1b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f43749c6587bf56874c0b86f6f8c1b5">◆ </a></span>SDRV_PDM_DMA_PERIOD_FRAME_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_DMA_PERIOD_FRAME_SIZE   1024 * 4</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94b3ede7072e8020fddc9030e486d0a2" name="a94b3ede7072e8020fddc9030e486d0a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94b3ede7072e8020fddc9030e486d0a2">◆ </a></span>SDRV_PDM_DMA_PERIOD_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_DMA_PERIOD_SIZE</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <a class="code hl_define" href="sdrv__pdm_8h.html#a0f43749c6587bf56874c0b86f6f8c1b5">SDRV_PDM_DMA_PERIOD_FRAME_SIZE</a> *<a class="code hl_define" href="sdrv__pdm_8h.html#a1124ebe14bc5fb3a74d39d1812ee4789">SDRV_PDM_CHANNELS_COUNT</a> \</div>
|
|
<div class="line"> *<a class="code hl_define" href="sdrv__pdm_8h.html#a2aff57760c5e516dd2eb2bc9f9ecd6db">SDRV_PDM_CHANNELS_BYTES</a></div>
|
|
<div class="ttc" id="asdrv__pdm_8h_html_a0f43749c6587bf56874c0b86f6f8c1b5"><div class="ttname"><a href="sdrv__pdm_8h.html#a0f43749c6587bf56874c0b86f6f8c1b5">SDRV_PDM_DMA_PERIOD_FRAME_SIZE</a></div><div class="ttdeci">#define SDRV_PDM_DMA_PERIOD_FRAME_SIZE</div><div class="ttdef"><b>Definition:</b> sdrv_pdm.h:23</div></div>
|
|
<div class="ttc" id="asdrv__pdm_8h_html_a1124ebe14bc5fb3a74d39d1812ee4789"><div class="ttname"><a href="sdrv__pdm_8h.html#a1124ebe14bc5fb3a74d39d1812ee4789">SDRV_PDM_CHANNELS_COUNT</a></div><div class="ttdeci">#define SDRV_PDM_CHANNELS_COUNT</div><div class="ttdef"><b>Definition:</b> sdrv_pdm.h:21</div></div>
|
|
<div class="ttc" id="asdrv__pdm_8h_html_a2aff57760c5e516dd2eb2bc9f9ecd6db"><div class="ttname"><a href="sdrv__pdm_8h.html#a2aff57760c5e516dd2eb2bc9f9ecd6db">SDRV_PDM_CHANNELS_BYTES</a></div><div class="ttdeci">#define SDRV_PDM_CHANNELS_BYTES</div><div class="ttdef"><b>Definition:</b> sdrv_pdm.h:22</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa5f55bb70b1dd9b8d9ffbbaec2761dbb" name="aa5f55bb70b1dd9b8d9ffbbaec2761dbb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5f55bb70b1dd9b8d9ffbbaec2761dbb">◆ </a></span>SDRV_PDM_XFER_NUM_TRANSFERS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SDRV_PDM_XFER_NUM_TRANSFERS   (4U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a15f6a35be4a21b3589392023a9533632" name="a15f6a35be4a21b3589392023a9533632"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15f6a35be4a21b3589392023a9533632">◆ </a></span>sdrv_pdm_callback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* sdrv_pdm_callback) (<a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a> *transfer, void *context, <a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> state)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb0fe39d821f65dd49921b26d4966824" name="adb0fe39d821f65dd49921b26d4966824"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb0fe39d821f65dd49921b26d4966824">◆ </a></span>sdrv_pdm_channel_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__pdm_8h.html#a946f3f0d421decf84616f24285f3b902">sdrv_pdm_channel</a> <a class="el" href="sdrv__pdm_8h.html#adb0fe39d821f65dd49921b26d4966824">sdrv_pdm_channel_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm channel </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d5e7a1f6041ed25a6020a429521c62a" name="a9d5e7a1f6041ed25a6020a429521c62a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d5e7a1f6041ed25a6020a429521c62a">◆ </a></span>sdrv_pdm_config_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__config.html">sdrv_pdm_config</a> <a class="el" href="sdrv__pdm_8h.html#a9d5e7a1f6041ed25a6020a429521c62a">sdrv_pdm_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm board config </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5faa830133ab27dab59d6cbae4ede62b" name="a5faa830133ab27dab59d6cbae4ede62b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5faa830133ab27dab59d6cbae4ede62b">◆ </a></span>sdrv_pdm_dma_buf_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__dma__buf.html">sdrv_pdm_dma_buf</a> <a class="el" href="sdrv__pdm_8h.html#a5faa830133ab27dab59d6cbae4ede62b">sdrv_pdm_dma_buf_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm dma buff descriptions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0066ff9fbe7c438acfc86abb99178cf" name="aa0066ff9fbe7c438acfc86abb99178cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0066ff9fbe7c438acfc86abb99178cf">◆ </a></span>sdrv_pdm_dma_data_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__dma__data.html">sdrv_pdm_dma_data</a> <a class="el" href="sdrv__pdm_8h.html#aa0066ff9fbe7c438acfc86abb99178cf">sdrv_pdm_dma_data_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm dma fifo descriptions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab409f805db43e01a91d2a7a912d0b12f" name="ab409f805db43e01a91d2a7a912d0b12f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab409f805db43e01a91d2a7a912d0b12f">◆ </a></span>sdrv_pdm_gain_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__pdm_8h.html#ad69cb6b1ed2c098d9ddab0b18e6e6b33">sdrv_pdm_gain</a> <a class="el" href="sdrv__pdm_8h.html#ab409f805db43e01a91d2a7a912d0b12f">sdrv_pdm_gain_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm gain </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e9708a2d9998d01ee1880428749b507" name="a6e9708a2d9998d01ee1880428749b507"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e9708a2d9998d01ee1880428749b507">◆ </a></span>sdrv_pdm_params_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__params.html">sdrv_pdm_params</a> <a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm config params </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a043a4fcc4c79b34e2125765f73756960" name="a043a4fcc4c79b34e2125765f73756960"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a043a4fcc4c79b34e2125765f73756960">◆ </a></span>sdrv_pdm_sample_rate_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__pdm_8h.html#a82952173ce56c4cb3264b46928b3739e">sdrv_pdm_sample_rate</a> <a class="el" href="sdrv__pdm_8h.html#a043a4fcc4c79b34e2125765f73756960">sdrv_pdm_sample_rate_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm sample rate </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa25e825685d5bc1645b1027baef2a450" name="aa25e825685d5bc1645b1027baef2a450"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa25e825685d5bc1645b1027baef2a450">◆ </a></span>sdrv_pdm_sample_width_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__pdm_8h.html#a4570528ca17819f9b000e5eb633f57a8">sdrv_pdm_sample_width</a> <a class="el" href="sdrv__pdm_8h.html#aa25e825685d5bc1645b1027baef2a450">sdrv_pdm_sample_width_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm sample width </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa675479f3508ead0ecc3c75c8f3a33e" name="afa675479f3508ead0ecc3c75c8f3a33e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa675479f3508ead0ecc3c75c8f3a33e">◆ </a></span>sdrv_pdm_status_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__pdm_8h.html#a59f4837399d219806878704788d55cc1">sdrv_pdm_status</a> <a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm status </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62410c22609c9c674e3cf1db9b85b4d4" name="a62410c22609c9c674e3cf1db9b85b4d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62410c22609c9c674e3cf1db9b85b4d4">◆ </a></span>sdrv_pdm_stream_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__stream.html">sdrv_pdm_stream</a> <a class="el" href="sdrv__pdm_8h.html#a62410c22609c9c674e3cf1db9b85b4d4">sdrv_pdm_stream_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm capture stream descriptions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade38b70bcdf7f1a7e0ba9c01dd9ec366" name="ade38b70bcdf7f1a7e0ba9c01dd9ec366"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade38b70bcdf7f1a7e0ba9c01dd9ec366">◆ </a></span>sdrv_pdm_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm.html">sdrv_pdm</a> <a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm module descriptions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a404b4740f79c2701b9ed6e4189cae26b" name="a404b4740f79c2701b9ed6e4189cae26b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a404b4740f79c2701b9ed6e4189cae26b">◆ </a></span>sdrv_pdm_transfer_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__pdm__transfer.html">sdrv_pdm_transfer</a> <a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm transfer </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a946f3f0d421decf84616f24285f3b902" name="a946f3f0d421decf84616f24285f3b902"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a946f3f0d421decf84616f24285f3b902">◆ </a></span>sdrv_pdm_channel</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__pdm_8h.html#a946f3f0d421decf84616f24285f3b902">sdrv_pdm_channel</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm channel </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a946f3f0d421decf84616f24285f3b902ad3d8595218a5fff7a6f3fb339f79f918" name="a946f3f0d421decf84616f24285f3b902ad3d8595218a5fff7a6f3fb339f79f918"></a>SDRV_PDM_CHANNEL_LEFT </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a946f3f0d421decf84616f24285f3b902abbe40475ff75993bbbdabf52930c598c" name="a946f3f0d421decf84616f24285f3b902abbe40475ff75993bbbdabf52930c598c"></a>SDRV_PDM_CHANNEL_RIGHT </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a946f3f0d421decf84616f24285f3b902a5193784dbe37daed2c06212d6e156d82" name="a946f3f0d421decf84616f24285f3b902a5193784dbe37daed2c06212d6e156d82"></a>SDRV_PDM_CHANNEL_STEREO </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad69cb6b1ed2c098d9ddab0b18e6e6b33">◆ </a></span>sdrv_pdm_gain</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__pdm_8h.html#ad69cb6b1ed2c098d9ddab0b18e6e6b33">sdrv_pdm_gain</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm gain </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a992e2830a9d92ccce39be7a94af473ea" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a992e2830a9d92ccce39be7a94af473ea"></a>SDRV_PDM_GAIN_N6DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a89c0b1a51736500d1ba55c5af312910b" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a89c0b1a51736500d1ba55c5af312910b"></a>SDRV_PDM_GAIN_N12DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a310338f7f4a9b83f281c5235db87efa8" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a310338f7f4a9b83f281c5235db87efa8"></a>SDRV_PDM_GAIN_N18DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a7440459dbc8ed67cdd2fc40664004ced" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a7440459dbc8ed67cdd2fc40664004ced"></a>SDRV_PDM_GAIN_N24DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33ad293b21526b2d662edef71c3b46ca845" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33ad293b21526b2d662edef71c3b46ca845"></a>SDRV_PDM_GAIN_P0DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a99626657f9537d225bf1ffd0aefeadea" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a99626657f9537d225bf1ffd0aefeadea"></a>SDRV_PDM_GAIN_P6DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a1c92fafc74447a75ad0ebb430b749057" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a1c92fafc74447a75ad0ebb430b749057"></a>SDRV_PDM_GAIN_P12DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a505d6f4bdeb73552e57e07e35a0cfce1" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a505d6f4bdeb73552e57e07e35a0cfce1"></a>SDRV_PDM_GAIN_P18DB </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ad69cb6b1ed2c098d9ddab0b18e6e6b33a17cca790b5aad4cd44fca9cdd00fb98c" name="ad69cb6b1ed2c098d9ddab0b18e6e6b33a17cca790b5aad4cd44fca9cdd00fb98c"></a>SDRV_PDM_GAIN_P24DB </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82952173ce56c4cb3264b46928b3739e" name="a82952173ce56c4cb3264b46928b3739e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82952173ce56c4cb3264b46928b3739e">◆ </a></span>sdrv_pdm_sample_rate</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__pdm_8h.html#a82952173ce56c4cb3264b46928b3739e">sdrv_pdm_sample_rate</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm sample rate </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea2d64067e362809ed5040edb3294dc332" name="a82952173ce56c4cb3264b46928b3739ea2d64067e362809ed5040edb3294dc332"></a>SDRV_PDM_SR_5512 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea32c3270a3fd207bd5682808f72a884fa" name="a82952173ce56c4cb3264b46928b3739ea32c3270a3fd207bd5682808f72a884fa"></a>SDRV_PDM_SR_8000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea71aed75c048144d862e3c4055b764d79" name="a82952173ce56c4cb3264b46928b3739ea71aed75c048144d862e3c4055b764d79"></a>SDRV_PDM_SR_11025 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea9e0ff27705d6d9dc36bb58164b05c6ed" name="a82952173ce56c4cb3264b46928b3739ea9e0ff27705d6d9dc36bb58164b05c6ed"></a>SDRV_PDM_SR_16000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea589c78676252a4cb291284dbdc15145a" name="a82952173ce56c4cb3264b46928b3739ea589c78676252a4cb291284dbdc15145a"></a>SDRV_PDM_SR_22050 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739eae44ae5b400f9500ff9ebd58a0b29c4b7" name="a82952173ce56c4cb3264b46928b3739eae44ae5b400f9500ff9ebd58a0b29c4b7"></a>SDRV_PDM_SR_32000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea7904fc90e2aa76ea650ea4cb641ccf44" name="a82952173ce56c4cb3264b46928b3739ea7904fc90e2aa76ea650ea4cb641ccf44"></a>SDRV_PDM_SR_44100 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739eaa9a3274ed9738e757ed37bf70884a417" name="a82952173ce56c4cb3264b46928b3739eaa9a3274ed9738e757ed37bf70884a417"></a>SDRV_PDM_SR_48000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea4f274ddcdd8e554779cf407aaabcc8a6" name="a82952173ce56c4cb3264b46928b3739ea4f274ddcdd8e554779cf407aaabcc8a6"></a>SDRV_PDM_SR_64000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea703f269cdab4730c2be82f29f8a0de30" name="a82952173ce56c4cb3264b46928b3739ea703f269cdab4730c2be82f29f8a0de30"></a>SDRV_PDM_SR_88200 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739eab6064c0f8fa08d010bd495f47c02a118" name="a82952173ce56c4cb3264b46928b3739eab6064c0f8fa08d010bd495f47c02a118"></a>SDRV_PDM_SR_96000 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea24ff9ff2e86fbcc0f2b6d2ed4b3d8dba" name="a82952173ce56c4cb3264b46928b3739ea24ff9ff2e86fbcc0f2b6d2ed4b3d8dba"></a>SDRV_PDM_SR_176400 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a82952173ce56c4cb3264b46928b3739ea0d8e2a073f2749e4bce92e9c1618152c" name="a82952173ce56c4cb3264b46928b3739ea0d8e2a073f2749e4bce92e9c1618152c"></a>SDRV_PDM_SR_192000 </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4570528ca17819f9b000e5eb633f57a8" name="a4570528ca17819f9b000e5eb633f57a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4570528ca17819f9b000e5eb633f57a8">◆ </a></span>sdrv_pdm_sample_width</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__pdm_8h.html#a4570528ca17819f9b000e5eb633f57a8">sdrv_pdm_sample_width</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm sample width </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4570528ca17819f9b000e5eb633f57a8a691ebcd97fa78a1051170605bdc42dff" name="a4570528ca17819f9b000e5eb633f57a8a691ebcd97fa78a1051170605bdc42dff"></a>SDRV_PDM_SAMPLE_WIDTH_8BITS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a4570528ca17819f9b000e5eb633f57a8a33503b97cfe0dd4fa0ea247297e21148" name="a4570528ca17819f9b000e5eb633f57a8a33503b97cfe0dd4fa0ea247297e21148"></a>SDRV_PDM_SAMPLE_WIDTH_16BITS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a4570528ca17819f9b000e5eb633f57a8a48948c3d7dbc512a21701afcbef0fd3f" name="a4570528ca17819f9b000e5eb633f57a8a48948c3d7dbc512a21701afcbef0fd3f"></a>SDRV_PDM_SAMPLE_WIDTH_24BITS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a4570528ca17819f9b000e5eb633f57a8aa3ceccb342f3c79e2daf18cadc39debb" name="a4570528ca17819f9b000e5eb633f57a8aa3ceccb342f3c79e2daf18cadc39debb"></a>SDRV_PDM_SAMPLE_WIDTH_32BITS </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59f4837399d219806878704788d55cc1" name="a59f4837399d219806878704788d55cc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59f4837399d219806878704788d55cc1">◆ </a></span>sdrv_pdm_status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__pdm_8h.html#a59f4837399d219806878704788d55cc1">sdrv_pdm_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pdm status </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a59f4837399d219806878704788d55cc1a9dc3d4868a46e28e4e6d2911e0ef2729" name="a59f4837399d219806878704788d55cc1a9dc3d4868a46e28e4e6d2911e0ef2729"></a>SDRV_PDM_STATUS_SUCCESS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a59f4837399d219806878704788d55cc1a64bf7e50b95ec291bde7a20ed707492b" name="a59f4837399d219806878704788d55cc1a64bf7e50b95ec291bde7a20ed707492b"></a>SDRV_PDM_STATUS_FAIL </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a59f4837399d219806878704788d55cc1a2957851d77b314a188bab3dca3e08785" name="a59f4837399d219806878704788d55cc1a2957851d77b314a188bab3dca3e08785"></a>SDRV_PDM_STATUS_INVALID_PARAMS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a59f4837399d219806878704788d55cc1a90ed6e755ec501b966e2f1108feee78a" name="a59f4837399d219806878704788d55cc1a90ed6e755ec501b966e2f1108feee78a"></a>SDRV_PDM_STATUS_OVERRUN </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a59f4837399d219806878704788d55cc1af9fc8bd23cd143ea46e57ffbbe3d7b1a" name="a59f4837399d219806878704788d55cc1af9fc8bd23cd143ea46e57ffbbe3d7b1a"></a>SDRV_PDM_STATUS_UNDERRUN </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a06fc3ad97dbebf04ebc6b8d283daca81" name="a06fc3ad97dbebf04ebc6b8d283daca81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06fc3ad97dbebf04ebc6b8d283daca81">◆ </a></span>sdrv_pdm_create_transfer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_create_transfer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#a15f6a35be4a21b3589392023a9533632">sdrv_pdm_callback</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_create_transfer </p>
|
|
<p >This function is used to create transfer and attach transfer callback</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>sdrv pdm transfer callback function. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>sdrv pdm transfer callback param. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac53bf4c2822e8b2baf50246074dfd8ea" name="ac53bf4c2822e8b2baf50246074dfd8ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac53bf4c2822e8b2baf50246074dfd8ea">◆ </a></span>sdrv_pdm_get_default_params()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_get_default_params </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> * </td>
|
|
<td class="paramname"><em>params</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_get_default_params </p>
|
|
<p >This function is used to get pdm default params</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">params</td><td>sdrv pdm params </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae575738dc6d616b4dba4c0323496ea74" name="ae575738dc6d616b4dba4c0323496ea74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae575738dc6d616b4dba4c0323496ea74">◆ </a></span>sdrv_pdm_init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#a9d5e7a1f6041ed25a6020a429521c62a">sdrv_pdm_config_t</a> * </td>
|
|
<td class="paramname"><em>cfg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv pdm controller initialization. </p>
|
|
<p >This function is used to initialize pdm module function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>sdrv pdm controller configurations </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefac841cd453d656130c027bebc909ca" name="aefac841cd453d656130c027bebc909ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefac841cd453d656130c027bebc909ca">◆ </a></span>sdrv_pdm_set_params()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_set_params </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#a6e9708a2d9998d01ee1880428749b507">sdrv_pdm_params_t</a> * </td>
|
|
<td class="paramname"><em>params</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_set_params </p>
|
|
<p >This function is used to set pdm params</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>sdrv pdm params </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab061d291368679923d2d6b413bb5135b" name="ab061d291368679923d2d6b413bb5135b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab061d291368679923d2d6b413bb5135b">◆ </a></span>sdrv_pdm_start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_start </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_start </p>
|
|
<p >This function is used to start pdm transfer</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99481ea849668d306a2f42a0519a2386" name="a99481ea849668d306a2f42a0519a2386"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99481ea849668d306a2f42a0519a2386">◆ </a></span>sdrv_pdm_stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_stop </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_stop </p>
|
|
<p >This function is used to stop pdm transfer</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a701e5750c55a6722cc0beed68036c5a6" name="a701e5750c55a6722cc0beed68036c5a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a701e5750c55a6722cc0beed68036c5a6">◆ </a></span>sdrv_pdm_submit_transfer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__pdm_8h.html#afa675479f3508ead0ecc3c75c8f3a33e">sdrv_pdm_status_t</a> sdrv_pdm_submit_transfer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#ade38b70bcdf7f1a7e0ba9c01dd9ec366">sdrv_pdm_t</a> * </td>
|
|
<td class="paramname"><em>pdm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__pdm_8h.html#a404b4740f79c2701b9ed6e4189cae26b">sdrv_pdm_transfer_t</a> * </td>
|
|
<td class="paramname"><em>transfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sdrv_pdm_submit_transfer </p>
|
|
<p >This function is used to submit transfer, which's max num is SDRV_PDM_XFER_NUM_BUFFERS</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pdm</td><td>sdrv pdm controller </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">transfer</td><td>sdrv pdm transfer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>sdrv_pdm_status_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|