485 lines
28 KiB
HTML
485 lines
28 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>MCUXpresso SDK API Reference Manual: FlexIO eDMA Camera 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">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</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 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('a00029.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="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FlexIO eDMA Camera Driver<div class="ingroups"><a class="el" href="a00028.html">FlexIO Camera 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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00384"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a00384">_flexio_camera_edma_handle</a></td></tr>
|
|
<tr class="memdesc:a00384"><td class="mdescLeft"> </td><td class="mdescRight">Camera eDMA handle. <a href="a00029.html#a00384">More...</a><br/></td></tr>
|
|
<tr class="separator:a00384"><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:ga4a99ca6dc45194b18fcc8439baa48bac"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
|
|
<a class="el" href="a00029.html#a00384">_flexio_camera_edma_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a></td></tr>
|
|
<tr class="memdesc:ga4a99ca6dc45194b18fcc8439baa48bac"><td class="mdescLeft"> </td><td class="mdescRight">Forward declaration of the handle typedef. <a href="#ga4a99ca6dc45194b18fcc8439baa48bac">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4a99ca6dc45194b18fcc8439baa48bac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabb60fe8b364fd7236b89905639ea4b0c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#gabb60fe8b364fd7236b89905639ea4b0c">flexio_camera_edma_transfer_callback_t</a> )(<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td></tr>
|
|
<tr class="memdesc:gabb60fe8b364fd7236b89905639ea4b0c"><td class="mdescLeft"> </td><td class="mdescRight">Camera transfer callback function. <a href="#gabb60fe8b364fd7236b89905639ea4b0c">More...</a><br/></td></tr>
|
|
<tr class="separator:gabb60fe8b364fd7236b89905639ea4b0c"><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>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:ga52394c208ce319682c96e0f1516e57fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ga52394c208ce319682c96e0f1516e57fb">FSL_FLEXIO_CAMERA_EDMA_DRIVER_VERSION</a>   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 3))</td></tr>
|
|
<tr class="memdesc:ga52394c208ce319682c96e0f1516e57fb"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO Camera EDMA driver version 2.1.3. <a href="#ga52394c208ce319682c96e0f1516e57fb">More...</a><br/></td></tr>
|
|
<tr class="separator:ga52394c208ce319682c96e0f1516e57fb"><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:gafcfbdd57ed04df3dc16ef839c1b94b36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#gafcfbdd57ed04df3dc16ef839c1b94b36">FLEXIO_CAMERA_TransferCreateHandleEDMA</a> (<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle, <a class="el" href="a00029.html#gabb60fe8b364fd7236b89905639ea4b0c">flexio_camera_edma_transfer_callback_t</a> callback, void *userData, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *rxEdmaHandle)</td></tr>
|
|
<tr class="memdesc:gafcfbdd57ed04df3dc16ef839c1b94b36"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the Camera handle, which is used in transactional functions. <a href="#gafcfbdd57ed04df3dc16ef839c1b94b36">More...</a><br/></td></tr>
|
|
<tr class="separator:gafcfbdd57ed04df3dc16ef839c1b94b36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0d33545dd2a68785b201ab14903cd93f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ga0d33545dd2a68785b201ab14903cd93f">FLEXIO_CAMERA_TransferReceiveEDMA</a> (<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle, <a class="el" href="a00028.html#ga9f8f31be1073c6d3a85e11d9b23dd93a">flexio_camera_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga0d33545dd2a68785b201ab14903cd93f"><td class="mdescLeft"> </td><td class="mdescRight">Receives data using eDMA. <a href="#ga0d33545dd2a68785b201ab14903cd93f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0d33545dd2a68785b201ab14903cd93f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga91a874d217607acf9d91cc6a63b65b83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ga91a874d217607acf9d91cc6a63b65b83">FLEXIO_CAMERA_TransferAbortReceiveEDMA</a> (<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga91a874d217607acf9d91cc6a63b65b83"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the receive data which used the eDMA. <a href="#ga91a874d217607acf9d91cc6a63b65b83">More...</a><br/></td></tr>
|
|
<tr class="separator:ga91a874d217607acf9d91cc6a63b65b83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga746d3fa2b5f984e00b35bf1cc338e053"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ga746d3fa2b5f984e00b35bf1cc338e053">FLEXIO_CAMERA_TransferGetReceiveCountEDMA</a> (<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga746d3fa2b5f984e00b35bf1cc338e053"><td class="mdescLeft"> </td><td class="mdescRight">Gets the remaining bytes to be received. <a href="#ga746d3fa2b5f984e00b35bf1cc338e053">More...</a><br/></td></tr>
|
|
<tr class="separator:ga746d3fa2b5f984e00b35bf1cc338e053"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00384" id="a00384"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_camera_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:a84f7c9c43050bfdbddd870fec5d5e5c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00029.html#gabb60fe8b364fd7236b89905639ea4b0c">flexio_camera_edma_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a84f7c9c43050bfdbddd870fec5d5e5c0">callback</a></td></tr>
|
|
<tr class="memdesc:a84f7c9c43050bfdbddd870fec5d5e5c0"><td class="mdescLeft"> </td><td class="mdescRight">Callback function. <a href="#a84f7c9c43050bfdbddd870fec5d5e5c0">More...</a><br/></td></tr>
|
|
<tr class="separator:a84f7c9c43050bfdbddd870fec5d5e5c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89f9d809ee822b651deb2db2df1344fa"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a89f9d809ee822b651deb2db2df1344fa">userData</a></td></tr>
|
|
<tr class="memdesc:a89f9d809ee822b651deb2db2df1344fa"><td class="mdescLeft"> </td><td class="mdescRight">Camera callback function parameter. <a href="#a89f9d809ee822b651deb2db2df1344fa">More...</a><br/></td></tr>
|
|
<tr class="separator:a89f9d809ee822b651deb2db2df1344fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7222f238b52f4bf7230616b8c5158a65"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a7222f238b52f4bf7230616b8c5158a65">rxSize</a></td></tr>
|
|
<tr class="memdesc:a7222f238b52f4bf7230616b8c5158a65"><td class="mdescLeft"> </td><td class="mdescRight">Total bytes to be received. <a href="#a7222f238b52f4bf7230616b8c5158a65">More...</a><br/></td></tr>
|
|
<tr class="separator:a7222f238b52f4bf7230616b8c5158a65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7e4007809195607deb3e6754186fc32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#aa7e4007809195607deb3e6754186fc32">rxEdmaHandle</a></td></tr>
|
|
<tr class="memdesc:aa7e4007809195607deb3e6754186fc32"><td class="mdescLeft"> </td><td class="mdescRight">The eDMA RX channel used. <a href="#aa7e4007809195607deb3e6754186fc32">More...</a><br/></td></tr>
|
|
<tr class="separator:aa7e4007809195607deb3e6754186fc32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a310ccb52e90227a84cbb06104dde79d5"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a310ccb52e90227a84cbb06104dde79d5">nbytes</a></td></tr>
|
|
<tr class="memdesc:a310ccb52e90227a84cbb06104dde79d5"><td class="mdescLeft"> </td><td class="mdescRight">eDMA minor byte transfer count initially configured. <a href="#a310ccb52e90227a84cbb06104dde79d5">More...</a><br/></td></tr>
|
|
<tr class="separator:a310ccb52e90227a84cbb06104dde79d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad669ec4bf3022d35787b390d518f0d10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad669ec4bf3022d35787b390d518f0d10"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ad669ec4bf3022d35787b390d518f0d10">rxState</a></td></tr>
|
|
<tr class="memdesc:ad669ec4bf3022d35787b390d518f0d10"><td class="mdescLeft"> </td><td class="mdescRight">RX transfer state. <br/></td></tr>
|
|
<tr class="separator:ad669ec4bf3022d35787b390d518f0d10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a84f7c9c43050bfdbddd870fec5d5e5c0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00029.html#gabb60fe8b364fd7236b89905639ea4b0c">flexio_camera_edma_transfer_callback_t</a> _flexio_camera_edma_handle::callback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a89f9d809ee822b651deb2db2df1344fa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* _flexio_camera_edma_handle::userData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7222f238b52f4bf7230616b8c5158a65"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_camera_edma_handle::rxSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa7e4007809195607deb3e6754186fc32"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a>* _flexio_camera_edma_handle::rxEdmaHandle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a310ccb52e90227a84cbb06104dde79d5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_camera_edma_handle::nbytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga52394c208ce319682c96e0f1516e57fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_FLEXIO_CAMERA_EDMA_DRIVER_VERSION   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 3))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga4a99ca6dc45194b18fcc8439baa48bac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00029.html#a00384">_flexio_camera_edma_handle</a> <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabb60fe8b364fd7236b89905639ea4b0c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* flexio_camera_edma_transfer_callback_t)(<a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> *base, <a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gafcfbdd57ed04df3dc16ef839c1b94b36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_CAMERA_TransferCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00029.html#gabb60fe8b364fd7236b89905639ea4b0c">flexio_camera_edma_transfer_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="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>rxEdmaHandle</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 the FLEXIO_CAMERA_Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_camera_edma_handle_t structure. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>The callback function. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>The parameter of the callback function. </td></tr>
|
|
<tr><td class="paramname">rxEdmaHandle</td><td>User requested DMA handle for RX DMA transfer. </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 create the handle. </td></tr>
|
|
<tr><td class="paramname">kStatus_OutOfRange</td><td>The FlexIO Camera eDMA type/handle table out of range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0d33545dd2a68785b201ab14903cd93f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_CAMERA_TransferReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00028.html#ga9f8f31be1073c6d3a85e11d9b23dd93a">flexio_camera_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 receives data using eDMA. This is a non-blocking function, which returns right away. When all data is received, the receive callback function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_CAMERA_Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_camera_edma_handle_t structure. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>Camera eDMA transfer structure, see <a class="el" href="a00028.html#ga9f8f31be1073c6d3a85e11d9b23dd93a" title="Define FlexIO Camera transfer structure. ">flexio_camera_transfer_t</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>if succeeded, others failed. </td></tr>
|
|
<tr><td class="paramname">kStatus_CAMERA_RxBusy</td><td>Previous transfer on going. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga91a874d217607acf9d91cc6a63b65b83"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_CAMERA_TransferAbortReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> * </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 receive data which used the eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_CAMERA_Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_camera_edma_handle_t structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga746d3fa2b5f984e00b35bf1cc338e053"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_CAMERA_TransferGetReceiveCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00028.html#ga8469ec2f5177b9aa71fd65032efc6bf7">FLEXIO_CAMERA_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00029.html#ga4a99ca6dc45194b18fcc8439baa48bac">flexio_camera_edma_handle_t</a> * </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">
|
|
<p>This function gets the number of bytes still not received.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_CAMERA_Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_camera_edma_handle_t structure. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number of bytes sent so far by the non-blocking transaction. </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_InvalidArgument</td><td>The count parameter is invalid. </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>
|