1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.13"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>ISSDK: sensors/fxls8471q_drv.h File Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="issdk_stylesheet.css" rel="stylesheet" type="text/css" /> 13</head> 14<body> 15<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 16<div id="titlearea"> 17<table cellspacing="0" cellpadding="0"> 18 <tbody> 19 <tr style="height: 56px;"> 20 <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td> 21 <td id="projectalign" style="padding-left: 0.5em;"> 22 <div id="projectname">ISSDK 23  <span id="projectnumber">1.8</span> 24 </div> 25 <div id="projectbrief">IoT Sensing Software Development Kit</div> 26 </td> 27 </tr> 28 </tbody> 29</table> 30</div> 31<!-- end header part --> 32<!-- Generated by Doxygen 1.8.13 --> 33<script type="text/javascript" src="menudata.js"></script> 34<script type="text/javascript" src="menu.js"></script> 35<script type="text/javascript"> 36$(function() { 37 initMenu('',false,false,'search.php','Search'); 38}); 39</script> 40<div id="main-nav"></div> 41<div id="nav-path" class="navpath"> 42 <ul> 43<li class="navelem"><a class="el" href="dir_c77a8e2546a9c75bbba96be2ef542c8e.html">sensors</a></li> </ul> 44</div> 45</div><!-- top --> 46<div class="header"> 47 <div class="summary"> 48<a href="#nested-classes">Data Structures</a> | 49<a href="#define-members">Macros</a> | 50<a href="#func-members">Functions</a> </div> 51 <div class="headertitle"> 52<div class="title">fxls8471q_drv.h File Reference</div> </div> 53</div><!--header--> 54<div class="contents"> 55 56<p>The <a class="el" href="a00050.html" title="The fxls8471q_drv.h file describes the fxls8471q driver interface and structures. ...">fxls8471q_drv.h</a> file describes the fxls8471q driver interface and structures. 57<a href="#details">More...</a></p> 58<div class="textblock"><code>#include <stdint.h></code><br /> 59<code>#include "<a class="el" href="a00044_source.html">fxls8471q.h</a>"</code><br /> 60<code>#include "<a class="el" href="a00191_source.html">sensor_io_spi.h</a>"</code><br /> 61<code>#include "<a class="el" href="a00176_source.html">register_io_spi.h</a>"</code><br /> 62</div><div class="textblock"><div class="dynheader"> 63Include dependency graph for fxls8471q_drv.h:</div> 64<div class="dyncontent"> 65<div class="center"><img src="a00051.png" border="0" usemap="#sensors_2fxls8471q__drv_8h" alt=""/></div> 66<map name="sensors_2fxls8471q__drv_8h" id="sensors_2fxls8471q__drv_8h"> 67<area shape="rect" id="node3" href="a00044.html" title="The fxls8471q.h file contains the register definitions for fxls8471q sensor driver. " alt="" coords="30,80,118,107"/> 68<area shape="rect" id="node4" href="a00191.html" title="The sensor_io_spi.h file declares low-level interface functions for reading and writing sensor regist..." alt="" coords="143,80,256,107"/> 69<area shape="rect" id="node5" href="a00176.html" title="The register_io_spi.h file declares low-level interface functions for reading and writing sensor regi..." alt="" coords="187,155,305,181"/> 70</map> 71</div> 72</div><div class="textblock"><div class="dynheader"> 73This graph shows which files directly or indirectly include this file:</div> 74<div class="dyncontent"> 75<div class="center"><img src="a00052.png" border="0" usemap="#sensors_2fxls8471q__drv_8hdep" alt=""/></div> 76<map name="sensors_2fxls8471q__drv_8hdep" id="sensors_2fxls8471q__drv_8hdep"> 77<area shape="rect" id="node2" href="a00047.html" title="The fxls8471q_drv.c file implements the FXLS8471Q sensor driver interfaces. " alt="" coords="5,87,167,114"/> 78<area shape="rect" id="node3" href="a00212.html" title="The fxls8471q_fifo.c file implements the ISSDK FXLS8471Q sensor driver example demonstration for SPI ..." alt="" coords="191,80,357,121"/> 79<area shape="rect" id="node4" href="a00215.html" title="The fxls8471q_interrupt.c file implements the ISSDK FXLS8471Q sensor driver example demonstration wit..." alt="" coords="382,80,553,121"/> 80<area shape="rect" id="node5" href="a00218.html" title="The fxls8471q_poll_spi.c file implements the ISSDK FXLS8471Q sensor driver example demonstration for ..." alt="" coords="577,80,744,121"/> 81<area shape="rect" id="node6" href="a00422.html" title="The fxls8471_demo.c file implements the ISSDK FXLS8471 sensor demo example demonstration with interru..." alt="" coords="768,80,919,121"/> 82<area shape="rect" id="node7" href="a00425.html" title="driverexamples/demos\l/fxls8471_demo_kl25z.c" alt="" coords="943,80,1106,121"/> 83<area shape="rect" id="node8" href="a00803.html" title="Provides init() and read() functions for the FXLS8471Q 3-axis accel. " alt="" coords="1131,80,1324,121"/> 84</map> 85</div> 86</div> 87<p><a href="a00050_source.html">Go to the source code of this file.</a></p> 88<table class="memberdecls"> 89<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 90Data Structures</h2></td></tr> 91<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a></td></tr> 92<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This defines the sensor specific information for SPI. <a href="a01651.html#details">More...</a><br /></td></tr> 93<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 94<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01655.html">fxls8471q_acceldata_t</a></td></tr> 95<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure defines the fxls8471q raw data buffer. <a href="a01655.html#details">More...</a><br /></td></tr> 96<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 97</table><table class="memberdecls"> 98<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> 99Macros</h2></td></tr> 100<tr class="memitem:afaecbb455aae019ec8cada022709897e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#afaecbb455aae019ec8cada022709897e">FXLS8471Q_ACCEL_DATA_SIZE</a>   (0x06) /* Size of the accel data*/</td></tr> 101<tr class="memdesc:afaecbb455aae019ec8cada022709897e"><td class="mdescLeft"> </td><td class="mdescRight">The size of the FXLS8471Q accel data. <a href="#afaecbb455aae019ec8cada022709897e">More...</a><br /></td></tr> 102<tr class="separator:afaecbb455aae019ec8cada022709897e"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:ad596a7980ffae824cba0059eb8dcf985"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ad596a7980ffae824cba0059eb8dcf985">FXLS8471Q_SPI_MAX_MSG_SIZE</a>   (64)</td></tr> 104<tr class="memdesc:ad596a7980ffae824cba0059eb8dcf985"><td class="mdescLeft"> </td><td class="mdescRight">The MAX size of SPI message. <a href="#ad596a7980ffae824cba0059eb8dcf985">More...</a><br /></td></tr> 105<tr class="separator:ad596a7980ffae824cba0059eb8dcf985"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:a085e68fd2341901a3901ef721f8784d2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a085e68fd2341901a3901ef721f8784d2">FXLS8471Q_SPI_CMD_LEN</a>   (2)</td></tr> 107<tr class="memdesc:a085e68fd2341901a3901ef721f8784d2"><td class="mdescLeft"> </td><td class="mdescRight">The size of the Sensor specific SPI Header. <a href="#a085e68fd2341901a3901ef721f8784d2">More...</a><br /></td></tr> 108<tr class="separator:a085e68fd2341901a3901ef721f8784d2"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:af77b5405aba8f06230f838e4d50d0b8c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#af77b5405aba8f06230f838e4d50d0b8c">FXLS8471Q_SS_ACTIVE_VALUE</a>   <a class="el" href="a00176.html#a67a2045f4f16d45f92fd22075416a7d6">SPI_SS_ACTIVE_LOW</a></td></tr> 110<tr class="memdesc:af77b5405aba8f06230f838e4d50d0b8c"><td class="mdescLeft"> </td><td class="mdescRight">Is the Slave Select Pin Active Low or High. <a href="#af77b5405aba8f06230f838e4d50d0b8c">More...</a><br /></td></tr> 111<tr class="separator:af77b5405aba8f06230f838e4d50d0b8c"><td class="memSeparator" colspan="2"> </td></tr> 112</table><table class="memberdecls"> 113<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 114Functions</h2></td></tr> 115<tr class="memitem:abaaef883aa8d1d70ac1e5d9b4efb5e26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26">FXLS8471Q_SPI_Initialize</a> (<a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t whoAmi)</td></tr> 116<tr class="memdesc:abaaef883aa8d1d70ac1e5d9b4efb5e26"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to initialize the sensor for I2C. <a href="#abaaef883aa8d1d70ac1e5d9b4efb5e26">More...</a><br /></td></tr> 117<tr class="separator:abaaef883aa8d1d70ac1e5d9b4efb5e26"><td class="memSeparator" colspan="2"> </td></tr> 118<tr class="memitem:a114a400580705a963d24be3b401db679"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a114a400580705a963d24be3b401db679">FXLS8471Q_SPI_SetIdleTask</a> (<a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle, <a class="el" href="a00179.html#a5deff6bd688b60b97b84fc7e78d3ea63">registeridlefunction_t</a> idleTask, void *userParam)</td></tr> 119<tr class="memdesc:a114a400580705a963d24be3b401db679"><td class="mdescLeft"> </td><td class="mdescRight">: The interface function to set the SPI Idle Task. <a href="#a114a400580705a963d24be3b401db679">More...</a><br /></td></tr> 120<tr class="separator:a114a400580705a963d24be3b401db679"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:a1a82c26ff39b7d12bb85cf62f32f25b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a1a82c26ff39b7d12bb85cf62f32f25b7">FXLS8471Q_SPI_Configure</a> (<a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle, const <a class="el" href="a03807.html">registerwritelist_t</a> *pRegWriteList)</td></tr> 122<tr class="memdesc:a1a82c26ff39b7d12bb85cf62f32f25b7"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to configure he sensor. <a href="#a1a82c26ff39b7d12bb85cf62f32f25b7">More...</a><br /></td></tr> 123<tr class="separator:a1a82c26ff39b7d12bb85cf62f32f25b7"><td class="memSeparator" colspan="2"> </td></tr> 124<tr class="memitem:ad16c8372e2c0bcbcd12af93a2f223814"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ad16c8372e2c0bcbcd12af93a2f223814">FXLS8471Q_SPI_ReadData</a> (<a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle, const <a class="el" href="a03811.html">registerreadlist_t</a> *pReadList, uint8_t *pBuffer)</td></tr> 125<tr class="memdesc:ad16c8372e2c0bcbcd12af93a2f223814"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to read the sensor data. <a href="#ad16c8372e2c0bcbcd12af93a2f223814">More...</a><br /></td></tr> 126<tr class="separator:ad16c8372e2c0bcbcd12af93a2f223814"><td class="memSeparator" colspan="2"> </td></tr> 127<tr class="memitem:a0a6e3db1388e072a899ef4065b35c9b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a0a6e3db1388e072a899ef4065b35c9b6">FXLS8471Q_SPI_Deinit</a> (<a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle)</td></tr> 128<tr class="memdesc:a0a6e3db1388e072a899ef4065b35c9b6"><td class="mdescLeft"> </td><td class="mdescRight">The interface function to De Initialize sensor.. <a href="#a0a6e3db1388e072a899ef4065b35c9b6">More...</a><br /></td></tr> 129<tr class="separator:a0a6e3db1388e072a899ef4065b35c9b6"><td class="memSeparator" colspan="2"> </td></tr> 130<tr class="memitem:af5467d1a6cf1e480e9bba282f8e5e01d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#af5467d1a6cf1e480e9bba282f8e5e01d">FXLS8471Q_SPI_ReadPreprocess</a> (void *pCmdOut, uint32_t offset, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>)</td></tr> 131<tr class="memdesc:af5467d1a6cf1e480e9bba282f8e5e01d"><td class="mdescLeft"> </td><td class="mdescRight">The SPI Read Pre-Process function to generate Sensor specific SPI Message Header. <a href="#af5467d1a6cf1e480e9bba282f8e5e01d">More...</a><br /></td></tr> 132<tr class="separator:af5467d1a6cf1e480e9bba282f8e5e01d"><td class="memSeparator" colspan="2"> </td></tr> 133<tr class="memitem:adf2e7ee5af2707bd751372a9b4586595"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#adf2e7ee5af2707bd751372a9b4586595">FXLS8471Q_SPI_WritePreprocess</a> (void *pCmdOut, uint32_t offset, uint32_t <a class="el" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>, void *pWritebuffer)</td></tr> 134<tr class="memdesc:adf2e7ee5af2707bd751372a9b4586595"><td class="mdescLeft"> </td><td class="mdescRight">The SPI Write Pre-Process function to generate Sensor specific SPI Message Header. <a href="#adf2e7ee5af2707bd751372a9b4586595">More...</a><br /></td></tr> 135<tr class="separator:adf2e7ee5af2707bd751372a9b4586595"><td class="memSeparator" colspan="2"> </td></tr> 136</table> 137<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 138<div class="textblock"><p>The <a class="el" href="a00050.html" title="The fxls8471q_drv.h file describes the fxls8471q driver interface and structures. ...">fxls8471q_drv.h</a> file describes the fxls8471q driver interface and structures. </p> 139 140<p class="definition">Definition in file <a class="el" href="a00050_source.html">fxls8471q_drv.h</a>.</p> 141</div><h2 class="groupheader">Macro Definition Documentation</h2> 142<a id="afaecbb455aae019ec8cada022709897e"></a> 143<h2 class="memtitle"><span class="permalink"><a href="#afaecbb455aae019ec8cada022709897e">◆ </a></span>FXLS8471Q_ACCEL_DATA_SIZE</h2> 144 145<div class="memitem"> 146<div class="memproto"> 147 <table class="memname"> 148 <tr> 149 <td class="memname">#define FXLS8471Q_ACCEL_DATA_SIZE   (0x06) /* Size of the accel data*/</td> 150 </tr> 151 </table> 152</div><div class="memdoc"> 153 154<p>The size of the FXLS8471Q accel data. </p> 155 156<p class="definition">Definition at line <a class="el" href="a00050_source.html#l00048">48</a> of file <a class="el" href="a00050_source.html">fxls8471q_drv.h</a>.</p> 157 158<p class="reference">Referenced by <a class="el" href="a00422_source.html#l00227">main()</a>.</p> 159 160</div> 161</div> 162<a id="a085e68fd2341901a3901ef721f8784d2"></a> 163<h2 class="memtitle"><span class="permalink"><a href="#a085e68fd2341901a3901ef721f8784d2">◆ </a></span>FXLS8471Q_SPI_CMD_LEN</h2> 164 165<div class="memitem"> 166<div class="memproto"> 167 <table class="memname"> 168 <tr> 169 <td class="memname">#define FXLS8471Q_SPI_CMD_LEN   (2)</td> 170 </tr> 171 </table> 172</div><div class="memdoc"> 173 174<p>The size of the Sensor specific SPI Header. </p> 175 176<p class="definition">Definition at line <a class="el" href="a00050_source.html#l00056">56</a> of file <a class="el" href="a00050_source.html">fxls8471q_drv.h</a>.</p> 177 178<p class="reference">Referenced by <a class="el" href="a00803_source.html#l00114">FXLS8471Q_Init()</a>, <a class="el" href="a00047_source.html#l00067">FXLS8471Q_SPI_Initialize()</a>, <a class="el" href="a00047_source.html#l00030">FXLS8471Q_SPI_ReadPreprocess()</a>, and <a class="el" href="a00047_source.html#l00047">FXLS8471Q_SPI_WritePreprocess()</a>.</p> 179 180</div> 181</div> 182<a id="ad596a7980ffae824cba0059eb8dcf985"></a> 183<h2 class="memtitle"><span class="permalink"><a href="#ad596a7980ffae824cba0059eb8dcf985">◆ </a></span>FXLS8471Q_SPI_MAX_MSG_SIZE</h2> 184 185<div class="memitem"> 186<div class="memproto"> 187 <table class="memname"> 188 <tr> 189 <td class="memname">#define FXLS8471Q_SPI_MAX_MSG_SIZE   (64)</td> 190 </tr> 191 </table> 192</div><div class="memdoc"> 193 194<p>The MAX size of SPI message. </p> 195 196<p class="definition">Definition at line <a class="el" href="a00050_source.html#l00052">52</a> of file <a class="el" href="a00050_source.html">fxls8471q_drv.h</a>.</p> 197 198</div> 199</div> 200<a id="af77b5405aba8f06230f838e4d50d0b8c"></a> 201<h2 class="memtitle"><span class="permalink"><a href="#af77b5405aba8f06230f838e4d50d0b8c">◆ </a></span>FXLS8471Q_SS_ACTIVE_VALUE</h2> 202 203<div class="memitem"> 204<div class="memproto"> 205 <table class="memname"> 206 <tr> 207 <td class="memname">#define FXLS8471Q_SS_ACTIVE_VALUE   <a class="el" href="a00176.html#a67a2045f4f16d45f92fd22075416a7d6">SPI_SS_ACTIVE_LOW</a></td> 208 </tr> 209 </table> 210</div><div class="memdoc"> 211 212<p>Is the Slave Select Pin Active Low or High. </p> 213 214<p class="definition">Definition at line <a class="el" href="a00050_source.html#l00060">60</a> of file <a class="el" href="a00050_source.html">fxls8471q_drv.h</a>.</p> 215 216<p class="reference">Referenced by <a class="el" href="a00803_source.html#l00114">FXLS8471Q_Init()</a>, and <a class="el" href="a00047_source.html#l00067">FXLS8471Q_SPI_Initialize()</a>.</p> 217 218</div> 219</div> 220<h2 class="groupheader">Function Documentation</h2> 221<a id="a1a82c26ff39b7d12bb85cf62f32f25b7"></a> 222<h2 class="memtitle"><span class="permalink"><a href="#a1a82c26ff39b7d12bb85cf62f32f25b7">◆ </a></span>FXLS8471Q_SPI_Configure()</h2> 223 224<div class="memitem"> 225<div class="memproto"> 226 <table class="memname"> 227 <tr> 228 <td class="memname"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> FXLS8471Q_SPI_Configure </td> 229 <td>(</td> 230 <td class="paramtype"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> * </td> 231 <td class="paramname"><em>pSensorHandle</em>, </td> 232 </tr> 233 <tr> 234 <td class="paramkey"></td> 235 <td></td> 236 <td class="paramtype">const <a class="el" href="a03807.html">registerwritelist_t</a> * </td> 237 <td class="paramname"><em>pRegWriteList</em> </td> 238 </tr> 239 <tr> 240 <td></td> 241 <td>)</td> 242 <td></td><td></td> 243 </tr> 244 </table> 245</div><div class="memdoc"> 246 247<p>The interface function to configure he sensor. </p> 248<p>This function configure the sensor with requested ODR, Range and registers in the regsiter pair array. </p><dl class="params"><dt>Parameters</dt><dd> 249 <table class="params"> 250 <tr><td class="paramdir">[in]</td><td class="paramname">pSensorHandle</td><td>handle to the sensor. </td></tr> 251 <tr><td class="paramdir">[in]</td><td class="paramname">pRegWriteList</td><td>pointer to the register list. </td></tr> 252 </table> 253 </dd> 254</dl> 255<dl class="section user"><dt>Constraints:</dt><dd>This can be called any number of times only after <a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. ">FXLS8471Q_SPI_Initialize()</a>. Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 256<dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00050.html#a1a82c26ff39b7d12bb85cf62f32f25b7" title="The interface function to configure he sensor. ">FXLS8471Q_SPI_Configure()</a> returns the status . </dd></dl> 257<p>Validate for the correct handle and register write list.</p> 258<p>Check whether sensor handle is initialized before applying configuration.</p> 259<p>Put the device into standby mode so that configuration can be applied.</p> 260<p>Apply the Sensor Configuration based on the Register Write List</p> 261<p>Put the device into active mode and ready for reading data. </p> 262 263<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00127">127</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 264 265<p class="reference">References <a class="el" href="a00050_source.html#l00033">fxls8471q_spi_sensorhandle_t::deviceInfo</a>, <a class="el" href="a00044_source.html#l00067">FXLS8471Q_CTRL_REG1</a>, <a class="el" href="a00044_source.html#l01659">FXLS8471Q_CTRL_REG1_MODE_ACTIVE</a>, <a class="el" href="a00044_source.html#l01639">FXLS8471Q_CTRL_REG1_MODE_MASK</a>, <a class="el" href="a00044_source.html#l01658">FXLS8471Q_CTRL_REG1_MODE_STANDBY</a>, <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t()</a>, <a class="el" href="a00050_source.html#l00035">fxls8471q_spi_sensorhandle_t::isInitialized</a>, <a class="el" href="a00050_source.html#l00034">fxls8471q_spi_sensorhandle_t::pCommDrv</a>, <a class="el" href="a00173_source.html#l00216">Register_SPI_Write()</a>, <a class="el" href="a00179_source.html#l00036">SENSOR_ERROR_INIT</a>, <a class="el" href="a00179_source.html#l00034">SENSOR_ERROR_INVALID_PARAM</a>, <a class="el" href="a00179_source.html#l00033">SENSOR_ERROR_NONE</a>, <a class="el" href="a00179_source.html#l00037">SENSOR_ERROR_WRITE</a>, <a class="el" href="a00188_source.html#l00071">Sensor_SPI_Write()</a>, <a class="el" href="a00050_source.html#l00036">fxls8471q_spi_sensorhandle_t::slaveParams</a>, and <a class="el" href="a00359_source.html#l00248">status</a>.</p> 266 267<p class="reference">Referenced by <a class="el" href="a00422_source.html#l00227">main()</a>.</p> 268<div class="dynheader"> 269Here is the call graph for this function:</div> 270<div class="dyncontent"> 271<div class="center"><img src="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_cgraph.png" border="0" usemap="#a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_cgraph" alt=""/></div> 272<map name="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_cgraph" id="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_cgraph"> 273<area shape="rect" id="node2" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f" title="The interface function to append the data on the formated stream. " alt="" coords="595,29,656,55"/> 274<area shape="rect" id="node3" href="a00173.html#ac4eb16e5a939fce81270bab7f6707754" title="The interface function to write a sensor register. " alt="" coords="411,29,547,55"/> 275<area shape="rect" id="node4" href="a00188.html#aaadd5fc1d790e7922e5303b4d61b67b4" title="Write register data to a sensor. " alt="" coords="233,79,363,106"/> 276</map> 277</div> 278<div class="dynheader"> 279Here is the caller graph for this function:</div> 280<div class="dyncontent"> 281<div class="center"><img src="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_icgraph.png" border="0" usemap="#a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_icgraph" alt=""/></div> 282<map name="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_icgraph" id="a00050_a1a82c26ff39b7d12bb85cf62f32f25b7_icgraph"> 283<area shape="rect" id="node2" href="a00422.html#a840291bc02cba5474a4cb46a9b9566fe" title="Main function. " alt="" coords="233,5,284,32"/> 284</map> 285</div> 286 287</div> 288</div> 289<a id="a0a6e3db1388e072a899ef4065b35c9b6"></a> 290<h2 class="memtitle"><span class="permalink"><a href="#a0a6e3db1388e072a899ef4065b35c9b6">◆ </a></span>FXLS8471Q_SPI_Deinit()</h2> 291 292<div class="memitem"> 293<div class="memproto"> 294 <table class="memname"> 295 <tr> 296 <td class="memname"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> FXLS8471Q_SPI_Deinit </td> 297 <td>(</td> 298 <td class="paramtype"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> * </td> 299 <td class="paramname"><em>pSensorHandle</em></td><td>)</td> 300 <td></td> 301 </tr> 302 </table> 303</div><div class="memdoc"> 304 305<p>The interface function to De Initialize sensor.. </p> 306<p>This function made sensor in a power safe state and de initialize its handle. </p><dl class="params"><dt>Parameters</dt><dd> 307 <table class="params"> 308 <tr><td class="paramdir">[in]</td><td class="paramname">pSensorHandle</td><td>handle to the sensor. </td></tr> 309 </table> 310 </dd> 311</dl> 312<dl class="section user"><dt>Constraints:</dt><dd>This can be called only after after <a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. ">FXLS8471Q_SPI_Initialize()</a>. Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 313<dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00050.html#a0a6e3db1388e072a899ef4065b35c9b6" title="The interface function to De Initialize sensor.. ">FXLS8471Q_SPI_Deinit()</a> returns the status . </dd></dl> 314<p>Check whether sensor handle is initialized before triggering sensor reset.</p> 315<p>De-initialize sensor handle. </p> 316 317<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00199">199</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 318 319<p class="reference">References <a class="el" href="a00050_source.html#l00035">fxls8471q_spi_sensorhandle_t::isInitialized</a>, <a class="el" href="a00179_source.html#l00036">SENSOR_ERROR_INIT</a>, <a class="el" href="a00179_source.html#l00034">SENSOR_ERROR_INVALID_PARAM</a>, and <a class="el" href="a00179_source.html#l00033">SENSOR_ERROR_NONE</a>.</p> 320 321</div> 322</div> 323<a id="abaaef883aa8d1d70ac1e5d9b4efb5e26"></a> 324<h2 class="memtitle"><span class="permalink"><a href="#abaaef883aa8d1d70ac1e5d9b4efb5e26">◆ </a></span>FXLS8471Q_SPI_Initialize()</h2> 325 326<div class="memitem"> 327<div class="memproto"> 328 <table class="memname"> 329 <tr> 330 <td class="memname"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> FXLS8471Q_SPI_Initialize </td> 331 <td>(</td> 332 <td class="paramtype"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> * </td> 333 <td class="paramname"><em>pSensorHandle</em>, </td> 334 </tr> 335 <tr> 336 <td class="paramkey"></td> 337 <td></td> 338 <td class="paramtype">ARM_DRIVER_SPI * </td> 339 <td class="paramname"><em>pBus</em>, </td> 340 </tr> 341 <tr> 342 <td class="paramkey"></td> 343 <td></td> 344 <td class="paramtype">uint8_t </td> 345 <td class="paramname"><em>index</em>, </td> 346 </tr> 347 <tr> 348 <td class="paramkey"></td> 349 <td></td> 350 <td class="paramtype">void * </td> 351 <td class="paramname"><em>pSlaveSelect</em>, </td> 352 </tr> 353 <tr> 354 <td class="paramkey"></td> 355 <td></td> 356 <td class="paramtype">uint8_t </td> 357 <td class="paramname"><em>whoAmi</em> </td> 358 </tr> 359 <tr> 360 <td></td> 361 <td>)</td> 362 <td></td><td></td> 363 </tr> 364 </table> 365</div><div class="memdoc"> 366 367<p>The interface function to initialize the sensor for I2C. </p> 368<p>This function initializes the sensor and sensor handle. </p><dl class="params"><dt>Parameters</dt><dd> 369 <table class="params"> 370 <tr><td class="paramdir">[in]</td><td class="paramname">pSensorHandle</td><td>handle to the sensor. </td></tr> 371 <tr><td class="paramdir">[in]</td><td class="paramname">pBus</td><td>pointer to the CMSIS API compatible SPI bus object. </td></tr> 372 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>the I2C device number. </td></tr> 373 <tr><td class="paramdir">[in]</td><td class="paramname">pSlaveSelect</td><td>slave select hndle of the device on the bus. </td></tr> 374 <tr><td class="paramdir">[in]</td><td class="paramname">whoami</td><td>WHO_AM_I value of the device. </td></tr> 375 </table> 376 </dd> 377</dl> 378<dl class="section user"><dt>Constraints:</dt><dd>This should be the first API to be called. Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 379<dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. ">FXLS8471Q_SPI_Initialize()</a> returns the status . </dd></dl> 380<p>Check the input parameters.</p> 381<p>Initialize the sensor handle.</p> 382<p>Read and store the device's WHO_AM_I. </p> 383 384<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00067">67</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 385 386<p class="reference">References <a class="el" href="a00482_source.html#l00047">GENERIC_DRIVER_GPIO::clr_pin</a>, <a class="el" href="a00050_source.html#l00033">fxls8471q_spi_sensorhandle_t::deviceInfo</a>, <a class="el" href="a00179_source.html#l00106">registerDeviceInfo_t::deviceInstance</a>, <a class="el" href="a04841_source.html#l00177">Driver_GPIO_KSDK</a>, <a class="el" href="a00179_source.html#l00105">registerDeviceInfo_t::functionParam</a>, <a class="el" href="a00050_source.html#l00056">FXLS8471Q_SPI_CMD_LEN</a>, <a class="el" href="a00047_source.html#l00030">FXLS8471Q_SPI_ReadPreprocess()</a>, <a class="el" href="a00047_source.html#l00047">FXLS8471Q_SPI_WritePreprocess()</a>, <a class="el" href="a00050_source.html#l00060">FXLS8471Q_SS_ACTIVE_VALUE</a>, <a class="el" href="a00044_source.html#l00042">FXLS8471Q_WHO_AM_I</a>, <a class="el" href="a00482_source.html#l00024">GPIO_DIRECTION_OUT</a>, <a class="el" href="a00179_source.html#l00104">registerDeviceInfo_t::idleFunction</a>, <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t()</a>, <a class="el" href="a00050_source.html#l00035">fxls8471q_spi_sensorhandle_t::isInitialized</a>, <a class="el" href="a00050_source.html#l00034">fxls8471q_spi_sensorhandle_t::pCommDrv</a>, <a class="el" href="a04823_source.html#l00302">pGPIODriver</a>, <a class="el" href="a00482_source.html#l00041">GENERIC_DRIVER_GPIO::pin_init</a>, <a class="el" href="a00176_source.html#l00048">spiSlaveSpecificParams_t::pReadPreprocessFN</a>, <a class="el" href="a00176_source.html#l00050">spiSlaveSpecificParams_t::pTargetSlavePinID</a>, <a class="el" href="a00176_source.html#l00049">spiSlaveSpecificParams_t::pWritePreprocessFN</a>, <a class="el" href="a00173_source.html#l00313">Register_SPI_Read()</a>, <a class="el" href="a00179_source.html#l00036">SENSOR_ERROR_INIT</a>, <a class="el" href="a00179_source.html#l00034">SENSOR_ERROR_INVALID_PARAM</a>, <a class="el" href="a00179_source.html#l00033">SENSOR_ERROR_NONE</a>, <a class="el" href="a00482_source.html#l00046">GENERIC_DRIVER_GPIO::set_pin</a>, <a class="el" href="a00050_source.html#l00036">fxls8471q_spi_sensorhandle_t::slaveParams</a>, <a class="el" href="a00176_source.html#l00021">SPI_SS_ACTIVE_LOW</a>, <a class="el" href="a00176_source.html#l00051">spiSlaveSpecificParams_t::spiCmdLen</a>, <a class="el" href="a00176_source.html#l00052">spiSlaveSpecificParams_t::ssActiveValue</a>, and <a class="el" href="a00359_source.html#l00248">status</a>.</p> 387 388<p class="reference">Referenced by <a class="el" href="a00422_source.html#l00227">main()</a>.</p> 389<div class="dynheader"> 390Here is the call graph for this function:</div> 391<div class="dyncontent"> 392<div class="center"><img src="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_cgraph.png" border="0" usemap="#a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_cgraph" alt=""/></div> 393<map name="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_cgraph" id="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_cgraph"> 394<area shape="rect" id="node2" href="a00047.html#af5467d1a6cf1e480e9bba282f8e5e01d" title="The SPI Read Pre-Process function to generate Sensor specific SPI Message Header. ..." alt="" coords="227,5,449,32"/> 395<area shape="rect" id="node3" href="a00047.html#adf2e7ee5af2707bd751372a9b4586595" title="The SPI Write Pre-Process function to generate Sensor specific SPI Message Header. " alt="" coords="227,56,449,83"/> 396<area shape="rect" id="node4" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f" title="The interface function to append the data on the formated stream. " alt="" coords="497,132,559,159"/> 397<area shape="rect" id="node5" href="a00173.html#a76a3aee498397854509b81ae2da2f85e" title="The interface function to read a sensor register. " alt="" coords="271,157,405,184"/> 398</map> 399</div> 400<div class="dynheader"> 401Here is the caller graph for this function:</div> 402<div class="dyncontent"> 403<div class="center"><img src="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_icgraph.png" border="0" usemap="#a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_icgraph" alt=""/></div> 404<map name="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_icgraph" id="a00050_abaaef883aa8d1d70ac1e5d9b4efb5e26_icgraph"> 405<area shape="rect" id="node2" href="a00422.html#a840291bc02cba5474a4cb46a9b9566fe" title="Main function. " alt="" coords="227,5,277,32"/> 406</map> 407</div> 408 409</div> 410</div> 411<a id="ad16c8372e2c0bcbcd12af93a2f223814"></a> 412<h2 class="memtitle"><span class="permalink"><a href="#ad16c8372e2c0bcbcd12af93a2f223814">◆ </a></span>FXLS8471Q_SPI_ReadData()</h2> 413 414<div class="memitem"> 415<div class="memproto"> 416 <table class="memname"> 417 <tr> 418 <td class="memname"><a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> FXLS8471Q_SPI_ReadData </td> 419 <td>(</td> 420 <td class="paramtype"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> * </td> 421 <td class="paramname"><em>pSensorHandle</em>, </td> 422 </tr> 423 <tr> 424 <td class="paramkey"></td> 425 <td></td> 426 <td class="paramtype">const <a class="el" href="a03811.html">registerreadlist_t</a> * </td> 427 <td class="paramname"><em>pReadList</em>, </td> 428 </tr> 429 <tr> 430 <td class="paramkey"></td> 431 <td></td> 432 <td class="paramtype">uint8_t * </td> 433 <td class="paramname"><em>pBuffer</em> </td> 434 </tr> 435 <tr> 436 <td></td> 437 <td>)</td> 438 <td></td><td></td> 439 </tr> 440 </table> 441</div><div class="memdoc"> 442 443<p>The interface function to read the sensor data. </p> 444<p>This function read the sensor data out from the device and returns raw data in a byte stream. </p><dl class="params"><dt>Parameters</dt><dd> 445 <table class="params"> 446 <tr><td class="paramdir">[in]</td><td class="paramname">pSensorHandle</td><td>handle to the sensor. </td></tr> 447 <tr><td class="paramdir">[in]</td><td class="paramname">pReadList</td><td>pointer to the list of device registers and values to read. </td></tr> 448 <tr><td class="paramdir">[out]</td><td class="paramname">pBuffer</td><td>buffer which holds raw sensor data.This buffer may be back to back databuffer based command read in the list. </td></tr> 449 </table> 450 </dd> 451</dl> 452<dl class="section user"><dt>Constraints:</dt><dd>This can be called any number of times only after <a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. ">FXLS8471Q_SPI_Initialize()</a>. Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 453<dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00050.html#ad16c8372e2c0bcbcd12af93a2f223814" title="The interface function to read the sensor data. ">FXLS8471Q_SPI_ReadData()</a> returns the status . </dd></dl> 454<p>Validate for the correct handle and register read list.</p> 455<p>Check whether sensor handle is initialized before reading sensor data.</p> 456<p>Parse through the read list and read the data one by one. </p> 457 458<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00170">170</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 459 460<p class="reference">References <a class="el" href="a00050_source.html#l00033">fxls8471q_spi_sensorhandle_t::deviceInfo</a>, <a class="el" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t()</a>, <a class="el" href="a00050_source.html#l00035">fxls8471q_spi_sensorhandle_t::isInitialized</a>, <a class="el" href="a00050_source.html#l00034">fxls8471q_spi_sensorhandle_t::pCommDrv</a>, <a class="el" href="a00179_source.html#l00036">SENSOR_ERROR_INIT</a>, <a class="el" href="a00179_source.html#l00034">SENSOR_ERROR_INVALID_PARAM</a>, <a class="el" href="a00179_source.html#l00033">SENSOR_ERROR_NONE</a>, <a class="el" href="a00179_source.html#l00038">SENSOR_ERROR_READ</a>, <a class="el" href="a00188_source.html#l00104">Sensor_SPI_Read()</a>, <a class="el" href="a00050_source.html#l00036">fxls8471q_spi_sensorhandle_t::slaveParams</a>, and <a class="el" href="a00359_source.html#l00248">status</a>.</p> 461 462<p class="reference">Referenced by <a class="el" href="a00422_source.html#l00227">main()</a>.</p> 463<div class="dynheader"> 464Here is the call graph for this function:</div> 465<div class="dyncontent"> 466<div class="center"><img src="a00050_ad16c8372e2c0bcbcd12af93a2f223814_cgraph.png" border="0" usemap="#a00050_ad16c8372e2c0bcbcd12af93a2f223814_cgraph" alt=""/></div> 467<map name="a00050_ad16c8372e2c0bcbcd12af93a2f223814_cgraph" id="a00050_ad16c8372e2c0bcbcd12af93a2f223814_cgraph"> 468<area shape="rect" id="node2" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f" title="The interface function to append the data on the formated stream. " alt="" coords="412,5,473,32"/> 469<area shape="rect" id="node3" href="a00188.html#a77509913bc008bceacf1e5f500e7499d" title="Read register data from a sensor. " alt="" coords="236,31,364,57"/> 470</map> 471</div> 472<div class="dynheader"> 473Here is the caller graph for this function:</div> 474<div class="dyncontent"> 475<div class="center"><img src="a00050_ad16c8372e2c0bcbcd12af93a2f223814_icgraph.png" border="0" usemap="#a00050_ad16c8372e2c0bcbcd12af93a2f223814_icgraph" alt=""/></div> 476<map name="a00050_ad16c8372e2c0bcbcd12af93a2f223814_icgraph" id="a00050_ad16c8372e2c0bcbcd12af93a2f223814_icgraph"> 477<area shape="rect" id="node2" href="a00422.html#a840291bc02cba5474a4cb46a9b9566fe" title="Main function. " alt="" coords="236,5,287,32"/> 478</map> 479</div> 480 481</div> 482</div> 483<a id="af5467d1a6cf1e480e9bba282f8e5e01d"></a> 484<h2 class="memtitle"><span class="permalink"><a href="#af5467d1a6cf1e480e9bba282f8e5e01d">◆ </a></span>FXLS8471Q_SPI_ReadPreprocess()</h2> 485 486<div class="memitem"> 487<div class="memproto"> 488 <table class="memname"> 489 <tr> 490 <td class="memname">void FXLS8471Q_SPI_ReadPreprocess </td> 491 <td>(</td> 492 <td class="paramtype">void * </td> 493 <td class="paramname"><em>pCmdOut</em>, </td> 494 </tr> 495 <tr> 496 <td class="paramkey"></td> 497 <td></td> 498 <td class="paramtype">uint32_t </td> 499 <td class="paramname"><em>offset</em>, </td> 500 </tr> 501 <tr> 502 <td class="paramkey"></td> 503 <td></td> 504 <td class="paramtype">uint32_t </td> 505 <td class="paramname"><em>size</em> </td> 506 </tr> 507 <tr> 508 <td></td> 509 <td>)</td> 510 <td></td><td></td> 511 </tr> 512 </table> 513</div><div class="memdoc"> 514 515<p>The SPI Read Pre-Process function to generate Sensor specific SPI Message Header. </p> 516<p>This function prepares the SPI Read Command Header with register address and R/W bit encoded as the Sensor. </p><dl class="params"><dt>Parameters</dt><dd> 517 <table class="params"> 518 <tr><td class="paramdir">[out]</td><td class="paramname">pCmdOut</td><td>handle to the output buffer. </td></tr> 519 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the address of the register to start reading from. </td></tr> 520 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of bytes to read. </td></tr> 521 </table> 522 </dd> 523</dl> 524<dl class="section user"><dt>Constraints:</dt><dd>None Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 525<dl class="section return"><dt>Returns</dt><dd>:: None. </dd></dl> 526 527<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00030">30</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 528 529<p class="reference">References <a class="el" href="a00050_source.html#l00056">FXLS8471Q_SPI_CMD_LEN</a>, <a class="el" href="a00047_source.html#l00023">fxls8471q_spiRead_CmdBuffer</a>, <a class="el" href="a00047_source.html#l00024">fxls8471q_spiRead_DataBuffer</a>, <a class="el" href="a00176_source.html#l00041">spi_mater_SlaveCmd::pReadBuffer</a>, <a class="el" href="a00176_source.html#l00042">spi_mater_SlaveCmd::pWriteBuffer</a>, and <a class="el" href="a00176_source.html#l00040">spi_mater_SlaveCmd::size</a>.</p> 530 531<p class="reference">Referenced by <a class="el" href="a00803_source.html#l00114">FXLS8471Q_Init()</a>, and <a class="el" href="a00047_source.html#l00067">FXLS8471Q_SPI_Initialize()</a>.</p> 532<div class="dynheader"> 533Here is the caller graph for this function:</div> 534<div class="dyncontent"> 535<div class="center"><img src="a00050_af5467d1a6cf1e480e9bba282f8e5e01d_icgraph.png" border="0" usemap="#a00050_af5467d1a6cf1e480e9bba282f8e5e01d_icgraph" alt=""/></div> 536<map name="a00050_af5467d1a6cf1e480e9bba282f8e5e01d_icgraph" id="a00050_af5467d1a6cf1e480e9bba282f8e5e01d_icgraph"> 537<area shape="rect" id="node2" href="a00842.html#a7c8424e014e2bdbb1dd61fcb4731857b" title="FXLS8471Q_Init" alt="" coords="305,5,420,32"/> 538<area shape="rect" id="node3" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. " alt="" coords="276,56,449,83"/> 539</map> 540</div> 541 542</div> 543</div> 544<a id="a114a400580705a963d24be3b401db679"></a> 545<h2 class="memtitle"><span class="permalink"><a href="#a114a400580705a963d24be3b401db679">◆ </a></span>FXLS8471Q_SPI_SetIdleTask()</h2> 546 547<div class="memitem"> 548<div class="memproto"> 549 <table class="memname"> 550 <tr> 551 <td class="memname">void FXLS8471Q_SPI_SetIdleTask </td> 552 <td>(</td> 553 <td class="paramtype"><a class="el" href="a01651.html">fxls8471q_spi_sensorhandle_t</a> * </td> 554 <td class="paramname"><em>pSensorHandle</em>, </td> 555 </tr> 556 <tr> 557 <td class="paramkey"></td> 558 <td></td> 559 <td class="paramtype"><a class="el" href="a00179.html#a5deff6bd688b60b97b84fc7e78d3ea63">registeridlefunction_t</a> </td> 560 <td class="paramname"><em>idleTask</em>, </td> 561 </tr> 562 <tr> 563 <td class="paramkey"></td> 564 <td></td> 565 <td class="paramtype">void * </td> 566 <td class="paramname"><em>userParam</em> </td> 567 </tr> 568 <tr> 569 <td></td> 570 <td>)</td> 571 <td></td><td></td> 572 </tr> 573 </table> 574</div><div class="memdoc"> 575 576<p>: The interface function to set the SPI Idle Task. </p> 577<dl class="params"><dt>Parameters</dt><dd> 578 <table class="params"> 579 <tr><td class="paramdir">[in]</td><td class="paramname"></td><td><a class="el" href="a01651.html" title="This defines the sensor specific information for SPI. ">fxls8471q_spi_sensorhandle_t</a> *pSensorHandle, handle to the sensor handle. </td></tr> 580 <tr><td class="paramdir">[in]</td><td class="paramname"></td><td>registeridlefunction_t idleTask, function pointer to the function to execute on SPI Idle Time. </td></tr> 581 <tr><td class="paramdir">[in]</td><td class="paramname"></td><td>void *userParam, the pointer to the user idle ftask parameters. </td></tr> 582 </table> 583 </dd> 584</dl> 585<dl class="section return"><dt>Returns</dt><dd>void. </dd></dl> 586<dl class="section user"><dt>Constraints:</dt><dd>This can be called any number of times only after <a class="el" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. ">FXLS8471Q_SPI_Initialize()</a>. Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 587 588<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00119">119</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 589 590<p class="reference">References <a class="el" href="a00050_source.html#l00033">fxls8471q_spi_sensorhandle_t::deviceInfo</a>, <a class="el" href="a00179_source.html#l00105">registerDeviceInfo_t::functionParam</a>, and <a class="el" href="a00179_source.html#l00104">registerDeviceInfo_t::idleFunction</a>.</p> 591 592<p class="reference">Referenced by <a class="el" href="a00422_source.html#l00227">main()</a>.</p> 593<div class="dynheader"> 594Here is the caller graph for this function:</div> 595<div class="dyncontent"> 596<div class="center"><img src="a00050_a114a400580705a963d24be3b401db679_icgraph.png" border="0" usemap="#a00050_a114a400580705a963d24be3b401db679_icgraph" alt=""/></div> 597<map name="a00050_a114a400580705a963d24be3b401db679_icgraph" id="a00050_a114a400580705a963d24be3b401db679_icgraph"> 598<area shape="rect" id="node2" href="a00422.html#a840291bc02cba5474a4cb46a9b9566fe" title="Main function. " alt="" coords="248,5,299,32"/> 599</map> 600</div> 601 602</div> 603</div> 604<a id="adf2e7ee5af2707bd751372a9b4586595"></a> 605<h2 class="memtitle"><span class="permalink"><a href="#adf2e7ee5af2707bd751372a9b4586595">◆ </a></span>FXLS8471Q_SPI_WritePreprocess()</h2> 606 607<div class="memitem"> 608<div class="memproto"> 609 <table class="memname"> 610 <tr> 611 <td class="memname">void FXLS8471Q_SPI_WritePreprocess </td> 612 <td>(</td> 613 <td class="paramtype">void * </td> 614 <td class="paramname"><em>pCmdOut</em>, </td> 615 </tr> 616 <tr> 617 <td class="paramkey"></td> 618 <td></td> 619 <td class="paramtype">uint32_t </td> 620 <td class="paramname"><em>offset</em>, </td> 621 </tr> 622 <tr> 623 <td class="paramkey"></td> 624 <td></td> 625 <td class="paramtype">uint32_t </td> 626 <td class="paramname"><em>size</em>, </td> 627 </tr> 628 <tr> 629 <td class="paramkey"></td> 630 <td></td> 631 <td class="paramtype">void * </td> 632 <td class="paramname"><em>pWritebuffer</em> </td> 633 </tr> 634 <tr> 635 <td></td> 636 <td>)</td> 637 <td></td><td></td> 638 </tr> 639 </table> 640</div><div class="memdoc"> 641 642<p>The SPI Write Pre-Process function to generate Sensor specific SPI Message Header. </p> 643<p>This function prepares the SPI Write Command Header with register address and R/W bit encoded as the Sensor. </p><dl class="params"><dt>Parameters</dt><dd> 644 <table class="params"> 645 <tr><td class="paramdir">[out]</td><td class="paramname">pCmdOut</td><td>handle to the output buffer. </td></tr> 646 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the address of the register to start writing from. </td></tr> 647 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>number of bytes to write. </td></tr> 648 </table> 649 </dd> 650</dl> 651<dl class="section user"><dt>Constraints:</dt><dd>None Application has to ensure that previous instances of these APIs have exited before invocation. No </dd></dl> 652<dl class="section return"><dt>Returns</dt><dd>:: None. </dd></dl> 653 654<p class="definition">Definition at line <a class="el" href="a00047_source.html#l00047">47</a> of file <a class="el" href="a00047_source.html">fxls8471q_drv.c</a>.</p> 655 656<p class="reference">References <a class="el" href="a00050_source.html#l00056">FXLS8471Q_SPI_CMD_LEN</a>, <a class="el" href="a00047_source.html#l00025">fxls8471q_spiWrite_CmdDataBuffer</a>, <a class="el" href="a00176_source.html#l00041">spi_mater_SlaveCmd::pReadBuffer</a>, <a class="el" href="a00176_source.html#l00042">spi_mater_SlaveCmd::pWriteBuffer</a>, and <a class="el" href="a00176_source.html#l00040">spi_mater_SlaveCmd::size</a>.</p> 657 658<p class="reference">Referenced by <a class="el" href="a00803_source.html#l00114">FXLS8471Q_Init()</a>, and <a class="el" href="a00047_source.html#l00067">FXLS8471Q_SPI_Initialize()</a>.</p> 659<div class="dynheader"> 660Here is the caller graph for this function:</div> 661<div class="dyncontent"> 662<div class="center"><img src="a00050_adf2e7ee5af2707bd751372a9b4586595_icgraph.png" border="0" usemap="#a00050_adf2e7ee5af2707bd751372a9b4586595_icgraph" alt=""/></div> 663<map name="a00050_adf2e7ee5af2707bd751372a9b4586595_icgraph" id="a00050_adf2e7ee5af2707bd751372a9b4586595_icgraph"> 664<area shape="rect" id="node2" href="a00842.html#a7c8424e014e2bdbb1dd61fcb4731857b" title="FXLS8471Q_Init" alt="" coords="305,5,420,32"/> 665<area shape="rect" id="node3" href="a00050.html#abaaef883aa8d1d70ac1e5d9b4efb5e26" title="The interface function to initialize the sensor for I2C. " alt="" coords="276,56,449,83"/> 666</map> 667</div> 668 669</div> 670</div> 671</div><!-- contents --> 672 673<hr class="footer"/><address class="footer"><small> 674© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause 675</small></address> 676</body> 677</html> 678
