Files
E3-20260112-pitch/e3_176_ref-buding/doc/Doxygen/html/structsdrv__i2s__params.html
2026-01-12 18:46:01 +08:00

290 lines
14 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_i2s_params</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">sdrv_i2s_params</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="sdrv__i2s_8h_source.html">sdrv_i2s.h</a>&gt;</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:add505f56193f4d351955134e9a7d57fa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#add505f56193f4d351955134e9a7d57fa">fmt</a></td></tr>
<tr class="separator:add505f56193f4d351955134e9a7d57fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40692dc0bf5d0c88e85af6b7a63fbc27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__i2s_8h.html#a3ceafb85aa2da0df4df4a27277ea7b17">sdrv_i2s_channel_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#a40692dc0bf5d0c88e85af6b7a63fbc27">channels</a></td></tr>
<tr class="separator:a40692dc0bf5d0c88e85af6b7a63fbc27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae75a630441f2f6ecebeabd0507f3e7d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__i2s_8h.html#adc4d1dd02bcd0552926375f88bcd640d">sdrv_i2s_sample_width_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#ae75a630441f2f6ecebeabd0507f3e7d7">sample_width</a></td></tr>
<tr class="separator:ae75a630441f2f6ecebeabd0507f3e7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a39950ae3c3241267f2ca30f99fc083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__i2s_8h.html#a6239c6b3db1da63ad12051a1e159fc60">sdrv_i2s_sample_rate_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#a1a39950ae3c3241267f2ca30f99fc083">sample_rate</a></td></tr>
<tr class="separator:a1a39950ae3c3241267f2ca30f99fc083"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafa448ca2eb2b62d7c138f7fa8a9e6db"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#aafa448ca2eb2b62d7c138f7fa8a9e6db">period_bytes</a></td></tr>
<tr class="separator:aafa448ca2eb2b62d7c138f7fa8a9e6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3524788d581ffa5760643c66dbe02eb"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#ab3524788d581ffa5760643c66dbe02eb">periods</a></td></tr>
<tr class="separator:ab3524788d581ffa5760643c66dbe02eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a1d78d10e34bc35b8fd0558ae3d5398"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__i2s_8h.html#a3ceafb85aa2da0df4df4a27277ea7b17">sdrv_i2s_channel_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#a3a1d78d10e34bc35b8fd0558ae3d5398">slots</a></td></tr>
<tr class="separator:a3a1d78d10e34bc35b8fd0558ae3d5398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3153a29fd486d88368862a6756e9634"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#ae3153a29fd486d88368862a6756e9634">tx_slot_mask</a></td></tr>
<tr class="separator:ae3153a29fd486d88368862a6756e9634"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4704e018dabacddd1d96477733ad35a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#aa4704e018dabacddd1d96477733ad35a">rx_slot_mask</a></td></tr>
<tr class="separator:aa4704e018dabacddd1d96477733ad35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b2c2c66ea3dc423a3f41283ade39fa6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#a3b2c2c66ea3dc423a3f41283ade39fa6">usedma</a></td></tr>
<tr class="separator:a3b2c2c66ea3dc423a3f41283ade39fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8a94d9adbcb7dd8a61d256f4e718b5a"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__i2s__params.html#aa8a94d9adbcb7dd8a61d256f4e718b5a">dma_buff</a></td></tr>
<tr class="separator:aa8a94d9adbcb7dd8a61d256f4e718b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a40692dc0bf5d0c88e85af6b7a63fbc27" name="a40692dc0bf5d0c88e85af6b7a63fbc27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40692dc0bf5d0c88e85af6b7a63fbc27">&#9670;&nbsp;</a></span>channels</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__i2s_8h.html#a3ceafb85aa2da0df4df4a27277ea7b17">sdrv_i2s_channel_t</a> channels</td>
</tr>
</table>
</div><div class="memdoc">
<p >data channels <br />
</p>
</div>
</div>
<a id="aa8a94d9adbcb7dd8a61d256f4e718b5a" name="aa8a94d9adbcb7dd8a61d256f4e718b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8a94d9adbcb7dd8a61d256f4e718b5a">&#9670;&nbsp;</a></span>dma_buff</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* dma_buff</td>
</tr>
</table>
</div><div class="memdoc">
<p >dma mode need set dma_buf addr, size=period_count*period_size </p>
</div>
</div>
<a id="add505f56193f4d351955134e9a7d57fa" name="add505f56193f4d351955134e9a7d57fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add505f56193f4d351955134e9a7d57fa">&#9670;&nbsp;</a></span>fmt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t fmt</td>
</tr>
</table>
</div><div class="memdoc">
<p >i2s data format </p>
</div>
</div>
<a id="aafa448ca2eb2b62d7c138f7fa8a9e6db" name="aafa448ca2eb2b62d7c138f7fa8a9e6db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafa448ca2eb2b62d7c138f7fa8a9e6db">&#9670;&nbsp;</a></span>period_bytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int period_bytes</td>
</tr>
</table>
</div><div class="memdoc">
<p >dma mode need set, dma generates an interrupt transmission data size </p>
</div>
</div>
<a id="ab3524788d581ffa5760643c66dbe02eb" name="ab3524788d581ffa5760643c66dbe02eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3524788d581ffa5760643c66dbe02eb">&#9670;&nbsp;</a></span>periods</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int periods</td>
</tr>
</table>
</div><div class="memdoc">
<p >dma mode need set, period num </p>
</div>
</div>
<a id="aa4704e018dabacddd1d96477733ad35a" name="aa4704e018dabacddd1d96477733ad35a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4704e018dabacddd1d96477733ad35a">&#9670;&nbsp;</a></span>rx_slot_mask</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int rx_slot_mask</td>
</tr>
</table>
</div><div class="memdoc">
<p >slot mask ,1 :slot enable; 0:slot disable </p>
</div>
</div>
<a id="a1a39950ae3c3241267f2ca30f99fc083" name="a1a39950ae3c3241267f2ca30f99fc083"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a39950ae3c3241267f2ca30f99fc083">&#9670;&nbsp;</a></span>sample_rate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__i2s_8h.html#a6239c6b3db1da63ad12051a1e159fc60">sdrv_i2s_sample_rate_t</a> sample_rate</td>
</tr>
</table>
</div><div class="memdoc">
<p >data sample rate </p>
</div>
</div>
<a id="ae75a630441f2f6ecebeabd0507f3e7d7" name="ae75a630441f2f6ecebeabd0507f3e7d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae75a630441f2f6ecebeabd0507f3e7d7">&#9670;&nbsp;</a></span>sample_width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__i2s_8h.html#adc4d1dd02bcd0552926375f88bcd640d">sdrv_i2s_sample_width_t</a> sample_width</td>
</tr>
</table>
</div><div class="memdoc">
<p >data width </p>
</div>
</div>
<a id="a4a51fec89c4855c3cd6eba971bc5f84e" name="a4a51fec89c4855c3cd6eba971bc5f84e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a51fec89c4855c3cd6eba971bc5f84e">&#9670;&nbsp;</a></span>slot_width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__i2s_8h.html#ad7a6e3fa9046293c6452347de5ba5662">sdrv_i2s_slot_width_t</a> slot_width</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3a1d78d10e34bc35b8fd0558ae3d5398" name="a3a1d78d10e34bc35b8fd0558ae3d5398"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a1d78d10e34bc35b8fd0558ae3d5398">&#9670;&nbsp;</a></span>slots</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__i2s_8h.html#a3ceafb85aa2da0df4df4a27277ea7b17">sdrv_i2s_channel_t</a> slots</td>
</tr>
</table>
</div><div class="memdoc">
<p >slot num </p>
</div>
</div>
<a id="ae3153a29fd486d88368862a6756e9634" name="ae3153a29fd486d88368862a6756e9634"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3153a29fd486d88368862a6756e9634">&#9670;&nbsp;</a></span>tx_slot_mask</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int tx_slot_mask</td>
</tr>
</table>
</div><div class="memdoc">
<p >slot mask ,1 :slot enable; 0:slot disable </p>
</div>
</div>
<a id="a3b2c2c66ea3dc423a3f41283ade39fa6" name="a3b2c2c66ea3dc423a3f41283ade39fa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b2c2c66ea3dc423a3f41283ade39fa6">&#9670;&nbsp;</a></span>usedma</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool usedma</td>
</tr>
</table>
</div><div class="memdoc">
<p >true :dma mode; false:irq mode <br />
</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__i2s_8h_source.html">sdrv_i2s.h</a></li>
</ul>
</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>