573 lines
31 KiB
HTML
573 lines
31 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.6"/>
|
|
<title>Kinetis SDK v.2.0 API Reference Manual: QSPI eDMA Driver</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="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis SDK v.2.0 API Reference Manual
|
|
 <span id="projectnumber">Rev. 0</span>
|
|
</div>
|
|
<div id="projectbrief">Freescale Semiconductor, Inc.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API 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__qspi__edma.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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="#files">Files</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">QSPI eDMA Driver<div class="ingroups"><a class="el" href="group__qspi.html">QSPI: Quad Serial Peripheral Interface Driver</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:fsl__qspi__edma_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="fsl__qspi__edma_8h.html">fsl_qspi_edma.h</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 name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:struct__qspi__edma__handle"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#struct__qspi__edma__handle">qspi_edma_handle_t</a></td></tr>
|
|
<tr class="memdesc:struct__qspi__edma__handle"><td class="mdescLeft"> </td><td class="mdescRight">QSPI DMA transfer handle, users should not touch the content of the handle. <a href="group__qspi__edma.html#struct__qspi__edma__handle">More...</a><br/></td></tr>
|
|
<tr class="separator:struct__qspi__edma__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga7fcc2c0f3515d1071a7d839f87751975"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7fcc2c0f3515d1071a7d839f87751975"></a>
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</a> )(QuadSPI_Type *base, qspi_edma_handle_t *handle, status_t status, void *userData)</td></tr>
|
|
<tr class="memdesc:ga7fcc2c0f3515d1071a7d839f87751975"><td class="mdescLeft"> </td><td class="mdescRight">QSPI eDMA transfer callback function for finish and error. <br/></td></tr>
|
|
<tr class="separator:ga7fcc2c0f3515d1071a7d839f87751975"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
eDMA Transactional</h2></td></tr>
|
|
<tr class="memitem:gaa967a5d19c9866ad6af406ed5b1b0726"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#gaa967a5d19c9866ad6af406ed5b1b0726">QSPI_TransferTxCreateHandleEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, <a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</a> callback, void *userData, <a class="el" href="group__edma__driver.html#structedma__handle__t">edma_handle_t</a> *dmaHandle)</td></tr>
|
|
<tr class="memdesc:gaa967a5d19c9866ad6af406ed5b1b0726"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the QSPI handle for send which is used in transactional functions and set the callback. <a href="#gaa967a5d19c9866ad6af406ed5b1b0726">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa967a5d19c9866ad6af406ed5b1b0726"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga01676dd06256f21171ec5b797f7f5023"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga01676dd06256f21171ec5b797f7f5023">QSPI_TransferRxCreateHandleEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, <a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</a> callback, void *userData, <a class="el" href="group__edma__driver.html#structedma__handle__t">edma_handle_t</a> *dmaHandle)</td></tr>
|
|
<tr class="memdesc:ga01676dd06256f21171ec5b797f7f5023"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the QSPI handle for receive which is used in transactional functions and set the callback. <a href="#ga01676dd06256f21171ec5b797f7f5023">More...</a><br/></td></tr>
|
|
<tr class="separator:ga01676dd06256f21171ec5b797f7f5023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2afdd78aff220a2432ca52aa6c23e42b"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga2afdd78aff220a2432ca52aa6c23e42b">QSPI_TransferSendEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, <a class="el" href="group__qspi.html#structqspi__transfer__t">qspi_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga2afdd78aff220a2432ca52aa6c23e42b"><td class="mdescLeft"> </td><td class="mdescRight">Transfers QSPI data using an eDMA non-blocking method. <a href="#ga2afdd78aff220a2432ca52aa6c23e42b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2afdd78aff220a2432ca52aa6c23e42b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2aedd369f612547837dd83dd88027cfc"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga2aedd369f612547837dd83dd88027cfc">QSPI_TransferReceiveEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, <a class="el" href="group__qspi.html#structqspi__transfer__t">qspi_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga2aedd369f612547837dd83dd88027cfc"><td class="mdescLeft"> </td><td class="mdescRight">Receives data using an eDMA non-blocking method. <a href="#ga2aedd369f612547837dd83dd88027cfc">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2aedd369f612547837dd83dd88027cfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad6c8e9e5f9e30293a5f3d75b849813f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#gad6c8e9e5f9e30293a5f3d75b849813f2">QSPI_TransferAbortSendEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:gad6c8e9e5f9e30293a5f3d75b849813f2"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the sent data using eDMA. <a href="#gad6c8e9e5f9e30293a5f3d75b849813f2">More...</a><br/></td></tr>
|
|
<tr class="separator:gad6c8e9e5f9e30293a5f3d75b849813f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac96efa0fed4c3ba72b2eaef373171215"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#gac96efa0fed4c3ba72b2eaef373171215">QSPI_TransferAbortReceiveEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:gac96efa0fed4c3ba72b2eaef373171215"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the receive data using eDMA. <a href="#gac96efa0fed4c3ba72b2eaef373171215">More...</a><br/></td></tr>
|
|
<tr class="separator:gac96efa0fed4c3ba72b2eaef373171215"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2a2211dae725b1186a8c78c34c4e7bb3"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga2a2211dae725b1186a8c78c34c4e7bb3">QSPI_TransferGetSendCountEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga2a2211dae725b1186a8c78c34c4e7bb3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the transferred counts of send. <a href="#ga2a2211dae725b1186a8c78c34c4e7bb3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2a2211dae725b1186a8c78c34c4e7bb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0c3c50d1dede5137428f6937ba7d414b"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ga0c3c50d1dede5137428f6937ba7d414b">QSPI_TransferGetReceiveCountEDMA</a> (QuadSPI_Type *base, qspi_edma_handle_t *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga0c3c50d1dede5137428f6937ba7d414b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the status of the receive transfer. <a href="#ga0c3c50d1dede5137428f6937ba7d414b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0c3c50d1dede5137428f6937ba7d414b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="struct__qspi__edma__handle" id="struct__qspi__edma__handle"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _qspi_edma_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a28cfb73a0f215ad025725d818c8236b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28cfb73a0f215ad025725d818c8236b2"></a>
|
|
<a class="el" href="group__edma__driver.html#structedma__handle__t">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#a28cfb73a0f215ad025725d818c8236b2">dmaHandle</a></td></tr>
|
|
<tr class="memdesc:a28cfb73a0f215ad025725d818c8236b2"><td class="mdescLeft"> </td><td class="mdescRight">eDMA handler for QSPI send <br/></td></tr>
|
|
<tr class="separator:a28cfb73a0f215ad025725d818c8236b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a567e3b6c85e6ad5813c8b23912e36528"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#a567e3b6c85e6ad5813c8b23912e36528">transferSize</a></td></tr>
|
|
<tr class="memdesc:a567e3b6c85e6ad5813c8b23912e36528"><td class="mdescLeft"> </td><td class="mdescRight">Bytes need to transfer. <a href="#a567e3b6c85e6ad5813c8b23912e36528">More...</a><br/></td></tr>
|
|
<tr class="separator:a567e3b6c85e6ad5813c8b23912e36528"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c535a628d17a28cc6641c80c69b6f69"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c535a628d17a28cc6641c80c69b6f69"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#a5c535a628d17a28cc6641c80c69b6f69">count</a></td></tr>
|
|
<tr class="memdesc:a5c535a628d17a28cc6641c80c69b6f69"><td class="mdescLeft"> </td><td class="mdescRight">The transfer data count in a DMA request. <br/></td></tr>
|
|
<tr class="separator:a5c535a628d17a28cc6641c80c69b6f69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac775477d71adb51e684528b289cd8bb8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac775477d71adb51e684528b289cd8bb8"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#ac775477d71adb51e684528b289cd8bb8">state</a></td></tr>
|
|
<tr class="memdesc:ac775477d71adb51e684528b289cd8bb8"><td class="mdescLeft"> </td><td class="mdescRight">Internal state for QSPI eDMA transfer. <br/></td></tr>
|
|
<tr class="separator:ac775477d71adb51e684528b289cd8bb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdf4fe169e76cb95c1c6f158c7c5b74c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdf4fe169e76cb95c1c6f158c7c5b74c"></a>
|
|
<a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#afdf4fe169e76cb95c1c6f158c7c5b74c">callback</a></td></tr>
|
|
<tr class="memdesc:afdf4fe169e76cb95c1c6f158c7c5b74c"><td class="mdescLeft"> </td><td class="mdescRight">Callback for users while transfer finish or error occurred. <br/></td></tr>
|
|
<tr class="separator:afdf4fe169e76cb95c1c6f158c7c5b74c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48be2909145f618dd2a8443107f275d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48be2909145f618dd2a8443107f275d0"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__qspi__edma.html#a48be2909145f618dd2a8443107f275d0">userData</a></td></tr>
|
|
<tr class="memdesc:a48be2909145f618dd2a8443107f275d0"><td class="mdescLeft"> </td><td class="mdescRight">User callback parameter. <br/></td></tr>
|
|
<tr class="separator:a48be2909145f618dd2a8443107f275d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a567e3b6c85e6ad5813c8b23912e36528"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t qspi_edma_handle_t::transferSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaa967a5d19c9866ad6af406ed5b1b0726"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void QSPI_TransferTxCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</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>userData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__edma__driver.html#structedma__handle__t">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>QSPI peripheral base address </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">callback</td><td>QSPI callback, NULL means no callback. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User callback function data. </td></tr>
|
|
<tr><td class="paramname">rxDmaHandle</td><td>User requested eDMA handle for eDMA transfer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga01676dd06256f21171ec5b797f7f5023"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void QSPI_TransferRxCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__qspi__edma.html#ga7fcc2c0f3515d1071a7d839f87751975">qspi_edma_callback_t</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>userData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__edma__driver.html#structedma__handle__t">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>QSPI peripheral base address </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">callback</td><td>QSPI callback, NULL means no callback. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User callback function data. </td></tr>
|
|
<tr><td class="paramname">rxDmaHandle</td><td>User requested eDMA handle for eDMA transfer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2afdd78aff220a2432ca52aa6c23e42b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t QSPI_TransferSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__qspi.html#structqspi__transfer__t">qspi_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function writes data to the QSPI transmit FIFO. This function is non-blocking. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to QuadSPI Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>QSPI transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2aedd369f612547837dd83dd88027cfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t QSPI_TransferReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__qspi.html#structqspi__transfer__t">qspi_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function receive data from the QSPI receive buffer/FIFO. This function is non-blocking. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to QuadSPI Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>QSPI transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad6c8e9e5f9e30293a5f3d75b849813f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void QSPI_TransferAbortSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function aborts the sent data using eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>QSPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac96efa0fed4c3ba72b2eaef373171215"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void QSPI_TransferAbortReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function abort receive data which using eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>QSPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2a2211dae725b1186a8c78c34c4e7bb3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t QSPI_TransferGetSendCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to QuadSPI Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Bytes sent. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Succeed get the transfer count. </td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>There is not a non-blocking transaction currently in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0c3c50d1dede5137428f6937ba7d414b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t QSPI_TransferGetReceiveCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QuadSPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qspi_edma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to QuadSPI Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to qspi_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">count</td><td>Bytes received. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Succeed get the transfer count. </td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>There is not a non-blocking transaction currently in progress. </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">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|