648 lines
36 KiB
HTML
648 lines
36 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: SPI DMA 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__spi__dma__driver.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">SPI DMA Driver<div class="ingroups"><a class="el" href="group__spi__driver.html">SPI Driver</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>This section describes the programming interface of the SPI DMA driver. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:fsl__spi__dma_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="fsl__spi__dma_8h.html">fsl_spi_dma.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__spi__dma__handle"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#struct__spi__dma__handle">spi_dma_handle_t</a></td></tr>
|
|
<tr class="memdesc:struct__spi__dma__handle"><td class="mdescLeft"> </td><td class="mdescRight">SPI DMA transfer handle, users should not touch the content of the handle. <a href="group__spi__dma__driver.html#struct__spi__dma__handle">More...</a><br/></td></tr>
|
|
<tr class="separator:struct__spi__dma__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:ga72ce9db8c2a57d66c7b508ca7891f4b3"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_callback_t</a> )(SPI_Type *base, spi_dma_handle_t *handle, status_t status, void *userData)</td></tr>
|
|
<tr class="memdesc:ga72ce9db8c2a57d66c7b508ca7891f4b3"><td class="mdescLeft"> </td><td class="mdescRight">SPI DMA callback called at the end of transfer. <a href="#ga72ce9db8c2a57d66c7b508ca7891f4b3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga72ce9db8c2a57d66c7b508ca7891f4b3"><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>
|
|
DMA Transactional</h2></td></tr>
|
|
<tr class="memitem:ga5e1c842943c46c7daf3d6ecd99fe8681"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga5e1c842943c46c7daf3d6ecd99fe8681">SPI_MasterTransferCreateHandleDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, <a class="el" href="group__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_callback_t</a> callback, void *userData, <a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> *txHandle, <a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> *rxHandle)</td></tr>
|
|
<tr class="memdesc:ga5e1c842943c46c7daf3d6ecd99fe8681"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the SPI master DMA handle. <a href="#ga5e1c842943c46c7daf3d6ecd99fe8681">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5e1c842943c46c7daf3d6ecd99fe8681"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2bcf43f1d6908810b6b41d2d87bda3a9"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga2bcf43f1d6908810b6b41d2d87bda3a9">SPI_MasterTransferDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, <a class="el" href="group__spi__driver.html#structspi__transfer__t">spi_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga2bcf43f1d6908810b6b41d2d87bda3a9"><td class="mdescLeft"> </td><td class="mdescRight">Perform a non-blocking SPI transfer using DMA. <a href="#ga2bcf43f1d6908810b6b41d2d87bda3a9">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2bcf43f1d6908810b6b41d2d87bda3a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac5f2aabca472a57709db2ef153e031c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#gac5f2aabca472a57709db2ef153e031c8">SPI_MasterTransferAbortDMA</a> (SPI_Type *base, spi_dma_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:gac5f2aabca472a57709db2ef153e031c8"><td class="mdescLeft"> </td><td class="mdescRight">Abort a SPI transfer using DMA. <a href="#gac5f2aabca472a57709db2ef153e031c8">More...</a><br/></td></tr>
|
|
<tr class="separator:gac5f2aabca472a57709db2ef153e031c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga642d1fe963b7f1c28e5d8f4dd5b92861"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga642d1fe963b7f1c28e5d8f4dd5b92861">SPI_MasterTransferGetCountDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga642d1fe963b7f1c28e5d8f4dd5b92861"><td class="mdescLeft"> </td><td class="mdescRight">Get the transferred bytes for SPI slave DMA. <a href="#ga642d1fe963b7f1c28e5d8f4dd5b92861">More...</a><br/></td></tr>
|
|
<tr class="separator:ga642d1fe963b7f1c28e5d8f4dd5b92861"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga859b87538b652542635f5406d823b9ef"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga859b87538b652542635f5406d823b9ef">SPI_SlaveTransferCreateHandleDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, <a class="el" href="group__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_callback_t</a> callback, void *userData, <a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> *txHandle, <a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> *rxHandle)</td></tr>
|
|
<tr class="memdesc:ga859b87538b652542635f5406d823b9ef"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the SPI slave DMA handle. <a href="#ga859b87538b652542635f5406d823b9ef">More...</a><br/></td></tr>
|
|
<tr class="separator:ga859b87538b652542635f5406d823b9ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6848a2579e3e84d48123407448df60ed"><td class="memItemLeft" align="right" valign="top">static status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga6848a2579e3e84d48123407448df60ed">SPI_SlaveTransferDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, <a class="el" href="group__spi__driver.html#structspi__transfer__t">spi_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga6848a2579e3e84d48123407448df60ed"><td class="mdescLeft"> </td><td class="mdescRight">Perform a non-blocking SPI transfer using DMA. <a href="#ga6848a2579e3e84d48123407448df60ed">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6848a2579e3e84d48123407448df60ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga03ab24789dc4c2438a5daff733ce2cfe"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ga03ab24789dc4c2438a5daff733ce2cfe">SPI_SlaveTransferAbortDMA</a> (SPI_Type *base, spi_dma_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:ga03ab24789dc4c2438a5daff733ce2cfe"><td class="mdescLeft"> </td><td class="mdescRight">Abort a SPI transfer using DMA. <a href="#ga03ab24789dc4c2438a5daff733ce2cfe">More...</a><br/></td></tr>
|
|
<tr class="separator:ga03ab24789dc4c2438a5daff733ce2cfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafa44608920f3653a4692f87f4d4220cc"><td class="memItemLeft" align="right" valign="top">static status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#gafa44608920f3653a4692f87f4d4220cc">SPI_SlaveTransferGetCountDMA</a> (SPI_Type *base, spi_dma_handle_t *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:gafa44608920f3653a4692f87f4d4220cc"><td class="mdescLeft"> </td><td class="mdescRight">Get the transferred bytes for SPI slave DMA. <a href="#gafa44608920f3653a4692f87f4d4220cc">More...</a><br/></td></tr>
|
|
<tr class="separator:gafa44608920f3653a4692f87f4d4220cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="struct__spi__dma__handle" id="struct__spi__dma__handle"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _spi_dma_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:a0579868b8e152a03bc87fa3e16b44f2a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0579868b8e152a03bc87fa3e16b44f2a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#a0579868b8e152a03bc87fa3e16b44f2a">txInProgress</a></td></tr>
|
|
<tr class="memdesc:a0579868b8e152a03bc87fa3e16b44f2a"><td class="mdescLeft"> </td><td class="mdescRight">Send transfer finished. <br/></td></tr>
|
|
<tr class="separator:a0579868b8e152a03bc87fa3e16b44f2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef218c9906ca9a889bec00e8c3aeeab4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef218c9906ca9a889bec00e8c3aeeab4"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#aef218c9906ca9a889bec00e8c3aeeab4">rxInProgress</a></td></tr>
|
|
<tr class="memdesc:aef218c9906ca9a889bec00e8c3aeeab4"><td class="mdescLeft"> </td><td class="mdescRight">Receive transfer finished. <br/></td></tr>
|
|
<tr class="separator:aef218c9906ca9a889bec00e8c3aeeab4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1c68e2b431fe999805c73a98e147a2f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1c68e2b431fe999805c73a98e147a2f"></a>
|
|
<a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ac1c68e2b431fe999805c73a98e147a2f">txHandle</a></td></tr>
|
|
<tr class="memdesc:ac1c68e2b431fe999805c73a98e147a2f"><td class="mdescLeft"> </td><td class="mdescRight">DMA handler for SPI send. <br/></td></tr>
|
|
<tr class="separator:ac1c68e2b431fe999805c73a98e147a2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8324f0ace75610fa4cba54f669b58f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8324f0ace75610fa4cba54f669b58f6"></a>
|
|
<a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#af8324f0ace75610fa4cba54f669b58f6">rxHandle</a></td></tr>
|
|
<tr class="memdesc:af8324f0ace75610fa4cba54f669b58f6"><td class="mdescLeft"> </td><td class="mdescRight">DMA handler for SPI receive. <br/></td></tr>
|
|
<tr class="separator:af8324f0ace75610fa4cba54f669b58f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab83d82c084cba678e9ddb1135f89c29c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab83d82c084cba678e9ddb1135f89c29c"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ab83d82c084cba678e9ddb1135f89c29c">bytesPerFrame</a></td></tr>
|
|
<tr class="memdesc:ab83d82c084cba678e9ddb1135f89c29c"><td class="mdescLeft"> </td><td class="mdescRight">Bytes in a frame for SPI tranfer. <br/></td></tr>
|
|
<tr class="separator:ab83d82c084cba678e9ddb1135f89c29c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dfc927b068cc0548da543dacfa34c3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dfc927b068cc0548da543dacfa34c3f"></a>
|
|
<a class="el" href="group__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#a7dfc927b068cc0548da543dacfa34c3f">callback</a></td></tr>
|
|
<tr class="memdesc:a7dfc927b068cc0548da543dacfa34c3f"><td class="mdescLeft"> </td><td class="mdescRight">Callback for SPI DMA transfer. <br/></td></tr>
|
|
<tr class="separator:a7dfc927b068cc0548da543dacfa34c3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad12378e2c097e3b73171f1935e8b68c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad12378e2c097e3b73171f1935e8b68c7"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ad12378e2c097e3b73171f1935e8b68c7">userData</a></td></tr>
|
|
<tr class="memdesc:ad12378e2c097e3b73171f1935e8b68c7"><td class="mdescLeft"> </td><td class="mdescRight">User Data for SPI DMA callback. <br/></td></tr>
|
|
<tr class="separator:ad12378e2c097e3b73171f1935e8b68c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae11863ad60c9260044f4d07475612497"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae11863ad60c9260044f4d07475612497"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#ae11863ad60c9260044f4d07475612497">state</a></td></tr>
|
|
<tr class="memdesc:ae11863ad60c9260044f4d07475612497"><td class="mdescLeft"> </td><td class="mdescRight">Internal state of SPI DMA transfer. <br/></td></tr>
|
|
<tr class="separator:ae11863ad60c9260044f4d07475612497"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15d678e91bfd1af80576ca0a6b107c74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15d678e91bfd1af80576ca0a6b107c74"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__dma__driver.html#a15d678e91bfd1af80576ca0a6b107c74">transferSize</a></td></tr>
|
|
<tr class="memdesc:a15d678e91bfd1af80576ca0a6b107c74"><td class="mdescLeft"> </td><td class="mdescRight">Bytes need to be transfer. <br/></td></tr>
|
|
<tr class="separator:a15d678e91bfd1af80576ca0a6b107c74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga72ce9db8c2a57d66c7b508ca7891f4b3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* spi_dma_callback_t)(SPI_Type *base, spi_dma_handle_t *handle, status_t status, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga5e1c842943c46c7daf3d6ecd99fe8681"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPI_MasterTransferCreateHandleDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_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__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td>
|
|
<td class="paramname"><em>txHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td>
|
|
<td class="paramname"><em>rxHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the SPI master DMA handle which can be used for other SPI master transactional APIs. Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI handle pointer. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>User callback function called at the end of a transfer. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User data for callback. </td></tr>
|
|
<tr><td class="paramname">txHandle</td><td>DMA handle pointer for SPI Tx, the handle shall be static allocated by users. </td></tr>
|
|
<tr><td class="paramname">rxHandle</td><td>DMA handle pointer for SPI Rx, the handle shall be static allocated by users. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2bcf43f1d6908810b6b41d2d87bda3a9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SPI_MasterTransferDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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__spi__driver.html#structspi__transfer__t">spi_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">
|
|
<dl class="section note"><dt>Note</dt><dd>This interface returned immediately after transfer initiates, users should call SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>Pointer to dma transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully start a transfer. </td></tr>
|
|
<tr><td class="paramname">kStatus_InvalidArgument</td><td>Input argument is invalid. </td></tr>
|
|
<tr><td class="paramname">kStatus_SPI_Busy</td><td>SPI is not idle, is running another transfer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac5f2aabca472a57709db2ef153e031c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPI_MasterTransferAbortDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga642d1fe963b7f1c28e5d8f4dd5b92861"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t SPI_MasterTransferGetCountDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Transferred bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_SPI_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="ga859b87538b652542635f5406d823b9ef"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void SPI_SlaveTransferCreateHandleDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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__spi__dma__driver.html#ga72ce9db8c2a57d66c7b508ca7891f4b3">spi_dma_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__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td>
|
|
<td class="paramname"><em>txHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__dma__driver.html#structdma__handle__t">dma_handle_t</a> * </td>
|
|
<td class="paramname"><em>rxHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the SPI slave DMA handle which can be used for other SPI master transactional APIs. Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI handle pointer. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>User callback function called at the end of a transfer. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User data for callback. </td></tr>
|
|
<tr><td class="paramname">txHandle</td><td>DMA handle pointer for SPI Tx, the handle shall be static allocated by users. </td></tr>
|
|
<tr><td class="paramname">rxHandle</td><td>DMA handle pointer for SPI Rx, the handle shall be static allocated by users. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6848a2579e3e84d48123407448df60ed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static status_t SPI_SlaveTransferDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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__spi__driver.html#structspi__transfer__t">spi_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This interface returned immediately after transfer initiates, users should call SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>Pointer to dma transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully start a transfer. </td></tr>
|
|
<tr><td class="paramname">kStatus_InvalidArgument</td><td>Input argument is invalid. </td></tr>
|
|
<tr><td class="paramname">kStatus_SPI_Busy</td><td>SPI is not idle, is running another transfer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga03ab24789dc4c2438a5daff733ce2cfe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void SPI_SlaveTransferAbortDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_handle_t * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafa44608920f3653a4692f87f4d4220cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static status_t SPI_SlaveTransferGetCountDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPI_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">spi_dma_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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPI peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPI DMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Transferred bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_SPI_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>
|