Files
2016-08-09 18:02:18 +02:00

349 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Kinetis SDK v.2.0 API Reference Manual: DMA Manager</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Kinetis SDK v.2.0 API Reference Manual
&#160;<span id="projectnumber">Rev. 0</span>
</div>
<div id="projectbrief">NXP Semiconductors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>API&#160;Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__dmamgr.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></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 class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">DMA Manager</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<p>DMA Manager provides a series of functions to manage the DMAMUX channels.</p>
<h1><a class="anchor" id="DMAMGRFunGrps"></a>
Function groups</h1>
<h2><a class="anchor" id="DMAMGRInit"></a>
DMAMGR Initialization and De-initialization</h2>
<p>This function group initializes and deinitializes the DMA Manager.</p>
<h2><a class="anchor" id="DMAMGROper"></a>
DMAMGR Operation</h2>
<p>This function group requests/releases the DMAMUX channel and configures the channel request source.</p>
<h1><a class="anchor" id="DMATypicalUseCase"></a>
Typical use case</h1>
<h2><a class="anchor" id="DMAMGRStaticOper"></a>
DMAMGR static channel allocate</h2>
<div class="fragment"><div class="line">DMAMUX_Type *dmamux_base;</div>
<div class="line">uint8_t channel;</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Initialize DMAMGR */</span></div>
<div class="line"><a class="code" href="group__dmamgr.html#ga0c4deb53f1857a9abfed9d35ad2013f4">DMAMGR_Init</a>();</div>
<div class="line"><span class="comment">/* Request a DMAMUX channel by static allocate mechanism */</span></div>
<div class="line">dmamux_base = DMAMUX0;</div>
<div class="line">channel = 0;</div>
<div class="line"><a class="code" href="group__dmamgr.html#ga459bfef3fee6f8a70345c3f43aaefc7a">DMAMGR_RequestChannel</a>(kDmaRequestMux0AlwaysOn63, &amp;dmamux_base, &amp;channel, kDMAMGR_STATIC_ALLOCATE);</div>
</div><!-- fragment --><h2><a class="anchor" id="DMAMGRDynamicOper"></a>
DMAMGR dynamic channel allocate</h2>
<div class="fragment"><div class="line">DMAMUX_Type *dmamux_base;</div>
<div class="line">uint8_t channel;</div>
<div class="line"></div>
<div class="line"><span class="comment">/* Initialize DMAMGR */</span></div>
<div class="line"><a class="code" href="group__dmamgr.html#ga0c4deb53f1857a9abfed9d35ad2013f4">DMAMGR_Init</a>();</div>
<div class="line"><span class="comment">/* Request a DMAMUX channel by static allocate mechanism */</span></div>
<div class="line">dmamux_base = DMAMUX0;</div>
<div class="line">channel = 0;</div>
<div class="line"><a class="code" href="group__dmamgr.html#ga459bfef3fee6f8a70345c3f43aaefc7a">DMAMGR_RequestChannel</a>(kDmaRequestMux0AlwaysOn63, &amp;dmamux_base, &amp;channel, kDMAMGR_DYNAMIC_ALLOCATE);</div>
</div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga390892af660b787eb16998f5170870d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga390892af660b787eb16998f5170870d6">DMAMGR_DYNAMIC_ALLOCATE</a>&#160;&#160;&#160;0xFFU</td></tr>
<tr class="memdesc:ga390892af660b787eb16998f5170870d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dynamic channel allocate mechanism. <a href="#ga390892af660b787eb16998f5170870d6">More...</a><br/></td></tr>
<tr class="separator:ga390892af660b787eb16998f5170870d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga7d34995d8cecdd16c6959a909ae4aab0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga7d34995d8cecdd16c6959a909ae4aab0">_dma_manager_status</a> { <br/>
&#160;&#160;<a class="el" href="group__dmamgr.html#gga7d34995d8cecdd16c6959a909ae4aab0a00c5d9b573b538fb7c609f9002994d10">kStatus_DMAMGR_ChannelOccupied</a> = MAKE_STATUS(kStatusGroup_DMAMGR, 0),
<br/>
&#160;&#160;<a class="el" href="group__dmamgr.html#gga7d34995d8cecdd16c6959a909ae4aab0a4c9904a84af833e605db372c035ab677">kStatus_DMAMGR_ChannelNotUsed</a> = MAKE_STATUS(kStatusGroup_DMAMGR, 1),
<br/>
&#160;&#160;<a class="el" href="group__dmamgr.html#gga7d34995d8cecdd16c6959a909ae4aab0a91dcc0b4f5c4fcb00d3ebb8394c54279">kStatus_DMAMGR_NoFreeChannel</a> = MAKE_STATUS(kStatusGroup_DMAMGR, 2),
<br/>
&#160;&#160;<a class="el" href="group__dmamgr.html#gga7d34995d8cecdd16c6959a909ae4aab0a4d55f7ec29d2103b766b88991a5c1b76">kStatus_DMAMGR_ChannelNotMatchSource</a> = MAKE_STATUS(kStatusGroup_DMAMGR, 3)
<br/>
}</td></tr>
<tr class="memdesc:ga7d34995d8cecdd16c6959a909ae4aab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">DMA manager status. <a href="group__dmamgr.html#ga7d34995d8cecdd16c6959a909ae4aab0">More...</a><br/></td></tr>
<tr class="separator:ga7d34995d8cecdd16c6959a909ae4aab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
DMAMGR Initialize and De-initialize</h2></td></tr>
<tr class="memitem:ga0c4deb53f1857a9abfed9d35ad2013f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga0c4deb53f1857a9abfed9d35ad2013f4">DMAMGR_Init</a> (void)</td></tr>
<tr class="memdesc:ga0c4deb53f1857a9abfed9d35ad2013f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the DAM manager. <a href="#ga0c4deb53f1857a9abfed9d35ad2013f4">More...</a><br/></td></tr>
<tr class="separator:ga0c4deb53f1857a9abfed9d35ad2013f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga008267a3c66fd0beaef277ddd22fbd21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga008267a3c66fd0beaef277ddd22fbd21">DMAMGR_Deinit</a> (void)</td></tr>
<tr class="memdesc:ga008267a3c66fd0beaef277ddd22fbd21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitializes the DMA manager. <a href="#ga008267a3c66fd0beaef277ddd22fbd21">More...</a><br/></td></tr>
<tr class="separator:ga008267a3c66fd0beaef277ddd22fbd21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
DMAMGR Operation</h2></td></tr>
<tr class="memitem:ga459bfef3fee6f8a70345c3f43aaefc7a"><td class="memItemLeft" align="right" valign="top">status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga459bfef3fee6f8a70345c3f43aaefc7a">DMAMGR_RequestChannel</a> (dma_request_source_t requestSource, uint8_t virtualChannel, void *handle)</td></tr>
<tr class="memdesc:ga459bfef3fee6f8a70345c3f43aaefc7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests a DMA channel. <a href="#ga459bfef3fee6f8a70345c3f43aaefc7a">More...</a><br/></td></tr>
<tr class="separator:ga459bfef3fee6f8a70345c3f43aaefc7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a24fb306fb217b5b38ea29e6d3a3f56"><td class="memItemLeft" align="right" valign="top">status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dmamgr.html#ga6a24fb306fb217b5b38ea29e6d3a3f56">DMAMGR_ReleaseChannel</a> (void *handle)</td></tr>
<tr class="memdesc:ga6a24fb306fb217b5b38ea29e6d3a3f56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a DMA channel. <a href="#ga6a24fb306fb217b5b38ea29e6d3a3f56">More...</a><br/></td></tr>
<tr class="separator:ga6a24fb306fb217b5b38ea29e6d3a3f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga390892af660b787eb16998f5170870d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMAMGR_DYNAMIC_ALLOCATE&#160;&#160;&#160;0xFFU</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga7d34995d8cecdd16c6959a909ae4aab0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__dmamgr.html#ga7d34995d8cecdd16c6959a909ae4aab0">_dma_manager_status</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga7d34995d8cecdd16c6959a909ae4aab0a00c5d9b573b538fb7c609f9002994d10"></a>kStatus_DMAMGR_ChannelOccupied</em>&nbsp;</td><td class="fielddoc">
<p>Channel has been occupied. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga7d34995d8cecdd16c6959a909ae4aab0a4c9904a84af833e605db372c035ab677"></a>kStatus_DMAMGR_ChannelNotUsed</em>&nbsp;</td><td class="fielddoc">
<p>Channel has not been used. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga7d34995d8cecdd16c6959a909ae4aab0a91dcc0b4f5c4fcb00d3ebb8394c54279"></a>kStatus_DMAMGR_NoFreeChannel</em>&nbsp;</td><td class="fielddoc">
<p>All channel has been occupied. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga7d34995d8cecdd16c6959a909ae4aab0a4d55f7ec29d2103b766b88991a5c1b76"></a>kStatus_DMAMGR_ChannelNotMatchSource</em>&nbsp;</td><td class="fielddoc">
<p>Channel do not match the request source. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0c4deb53f1857a9abfed9d35ad2013f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DMAMGR_Init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function initializes the DMA manager, ungates all DMAMUX clocks, and initializes the eDMA or DMA peripheral. </p>
</div>
</div>
<a class="anchor" id="ga008267a3c66fd0beaef277ddd22fbd21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DMAMGR_Deinit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function deinitializes the DMA manager, disables all DMAMUX channel, gates all DMAMUX clock, and deinitializes the eDMA or DMA peripheral. </p>
</div>
</div>
<a class="anchor" id="ga459bfef3fee6f8a70345c3f43aaefc7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">status_t DMAMGR_RequestChannel </td>
<td>(</td>
<td class="paramtype">dma_request_source_t&#160;</td>
<td class="paramname"><em>requestSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>virtualChannel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>handle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function request a DMA channel which is not occupied. There are two channels to allocate the mechanism dynamic and static. For the dynamic allocation mechanism (virtualChannel = DMAMGR_DYNAMIC_ALLOCATE), DMAMGR allocates a DMA channel according to the given request source and then configure it. For static allocation mechanism, DMAMGR configures the given channel according to the given request source and channel number.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">requestSource</td><td>DMA channel request source number. See the soc.h. </td></tr>
<tr><td class="paramname">virtualChannel</td><td>The channel number user wants to occupy. If using the dynamic channel allocate mechanism, set the virtualChannel equal to DMAMGR_DYNAMIC_ALLOCATE. </td></tr>
<tr><td class="paramname">handle</td><td>DMA or eDMA handle pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">kStatus_Success</td><td>In dynamic/static channel allocate mechanism, allocate DMAMUX channel successfully. </td></tr>
<tr><td class="paramname">kStatus_DMAMGR_NoFreeChannel</td><td>In dynamic channel allocate mechanism, all DMAMUX channels has been occupied. </td></tr>
<tr><td class="paramname">kStatus_DMAMGR_ChannelNotMatchSource</td><td>In static channel allocate mechanism, the given channel do not match the given request. </td></tr>
<tr><td class="paramname">kStatus_DMAMGR_ChannelOccupied</td><td>In static channel allocate mechanism, the given channel has been occupied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6a24fb306fb217b5b38ea29e6d3a3f56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">status_t DMAMGR_ReleaseChannel </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function releases an occupied DMA channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>DMA or eDMA handle pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">kStatus_Success</td><td>Release the given channel successfully. </td></tr>
<tr><td class="paramname">kStatus_DMAMGR_ChannelNotUsed</td><td>The given channel which to be released is not been used before. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">&copy; 2016 Freescale Semiconductor, Inc. All rights reserved.
</li>
</ul>
</div>
</body>
</html>