2022-08-23 15:00:33 +00:00
<!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" / >
2024-03-15 14:23:36 +00:00
< title > MCUXpresso SDK API Reference Manual: LPSPI FreeRTOS Driver< / title >
2022-08-23 15:00:33 +00:00
< 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
2024-03-15 14:23:36 +00:00
  < span id = "projectnumber" > Rev 2.15.000< / span >
2022-08-23 15:00:33 +00:00
< / 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('a00272.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 = "headertitle" >
2024-03-15 14:23:36 +00:00
< div class = "title" > LPSPI FreeRTOS Driver< div class = "ingroups" > < a class = "el" href = "a00271.html" > LPSPI: Low Power Serial Peripheral Interface< / a > < / div > < / div > < / div >
2022-08-23 15:00:33 +00:00
< / div > <!-- header -->
< div class = "contents" >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Overview< / h2 >
< table class = "memberdecls" >
2024-03-15 14:23:36 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "member-group" > < / a >
Driver version< / h2 > < / td > < / tr >
< tr class = "memitem:gaf5602bf29f89af865ebea200ff535f98" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00272.html#gaf5602bf29f89af865ebea200ff535f98" > FSL_LPSPI_FREERTOS_DRIVER_VERSION< / a >       (< a class = "el" href = "a00260.html#ga812138aa3315b0c6953c1a26130bcc37" > MAKE_VERSION< / a > (2, 3, 1))< / td > < / tr >
< tr class = "memdesc:gaf5602bf29f89af865ebea200ff535f98" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > LPSPI FreeRTOS driver version 2.3.1. < a href = "#gaf5602bf29f89af865ebea200ff535f98" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaf5602bf29f89af865ebea200ff535f98" > < 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 >
LPSPI RTOS Operation< / h2 > < / td > < / tr >
< tr class = "memitem:ga17e5f827d714b4bba86af6ce5b9e8119" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00272.html#ga17e5f827d714b4bba86af6ce5b9e8119" > LPSPI_RTOS_Init< / a > (lpspi_rtos_handle_t *handle, LPSPI_Type *base, const < a class = "el" href = "a00048.html#ga98987647d5b36df9919bbbccbd7ef341" > lpspi_master_config_t< / a > *masterConfig, uint32_t srcClock_Hz)< / td > < / tr >
< tr class = "memdesc:ga17e5f827d714b4bba86af6ce5b9e8119" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initializes LPSPI. < a href = "#ga17e5f827d714b4bba86af6ce5b9e8119" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga17e5f827d714b4bba86af6ce5b9e8119" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gadac220234f10116e78dd6ce341c4377c" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00272.html#gadac220234f10116e78dd6ce341c4377c" > LPSPI_RTOS_Deinit< / a > (lpspi_rtos_handle_t *handle)< / td > < / tr >
< tr class = "memdesc:gadac220234f10116e78dd6ce341c4377c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Deinitializes the LPSPI. < a href = "#gadac220234f10116e78dd6ce341c4377c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gadac220234f10116e78dd6ce341c4377c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gad1bc18b3a105852cfcea1f5fc97ef0d8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00272.html#gad1bc18b3a105852cfcea1f5fc97ef0d8" > LPSPI_RTOS_Transfer< / a > (lpspi_rtos_handle_t *handle, < a class = "el" href = "a00048.html#ga9e5674e4c10c43e897588cb02b92e0fe" > lpspi_transfer_t< / a > *transfer)< / td > < / tr >
< tr class = "memdesc:gad1bc18b3a105852cfcea1f5fc97ef0d8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Performs SPI transfer. < a href = "#gad1bc18b3a105852cfcea1f5fc97ef0d8" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad1bc18b3a105852cfcea1f5fc97ef0d8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
2024-03-15 14:23:36 +00:00
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
< a class = "anchor" id = "gaf5602bf29f89af865ebea200ff535f98" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define FSL_LPSPI_FREERTOS_DRIVER_VERSION      (< a class = "el" href = "a00260.html#ga812138aa3315b0c6953c1a26130bcc37" > MAKE_VERSION< / a > (2, 3, 1))< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga17e5f827d714b4bba86af6ce5b9e8119" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > LPSPI_RTOS_Init < / td >
< td > (< / td >
< td class = "paramtype" > lpspi_rtos_handle_t *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > LPSPI_Type *  < / td >
< td class = "paramname" > < em > base< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "a00048.html#ga98987647d5b36df9919bbbccbd7ef341" > lpspi_master_config_t< / a > *  < / td >
< td class = "paramname" > < em > masterConfig< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > srcClock_Hz< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > This function initializes the LPSPI module and related RTOS context.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > The RTOS LPSPI handle, the pointer to an allocated space for RTOS context. < / td > < / tr >
< tr > < td class = "paramname" > base< / td > < td > The pointer base address of the LPSPI instance to initialize. < / td > < / tr >
< tr > < td class = "paramname" > masterConfig< / td > < td > Configuration structure to set-up LPSPI in master mode. < / td > < / tr >
< tr > < td class = "paramname" > srcClock_Hz< / td > < td > Frequency of input clock of the LPSPI module. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > status of the operation. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gadac220234f10116e78dd6ce341c4377c" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > LPSPI_RTOS_Deinit < / td >
< td > (< / td >
< td class = "paramtype" > lpspi_rtos_handle_t *  < / td >
< td class = "paramname" > < em > handle< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > This function deinitializes the LPSPI module and related RTOS context.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > The RTOS LPSPI handle. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a class = "anchor" id = "gad1bc18b3a105852cfcea1f5fc97ef0d8" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > LPSPI_RTOS_Transfer < / td >
< td > (< / td >
< td class = "paramtype" > lpspi_rtos_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 = "a00048.html#ga9e5674e4c10c43e897588cb02b92e0fe" > lpspi_transfer_t< / a > *  < / td >
< td class = "paramname" > < em > transfer< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > This function performs an SPI transfer according to data given in the transfer structure.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > The RTOS LPSPI handle. < / td > < / tr >
< tr > < td class = "paramname" > transfer< / td > < td > Structure specifying the transfer parameters. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > status of the operation. < / dd > < / dl >
< / div >
< / div >
2022-08-23 15:00:33 +00:00
< / 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 >