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/register_io_spi.h Source File</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="headertitle"> 48<div class="title">register_io_spi.h</div> </div> 49</div><!--header--> 50<div class="contents"> 51<a href="a00176.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2016-2017 NXP</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/**</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * @file register_io_spi.h</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * @brief The register_io_spi.h file declares low-level interface functions for reading</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and writing sensor registers using CMSIS APIs.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef __REGISTER_IO_SPI_H__</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define __REGISTER_IO_SPI_H__</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "Driver_SPI.h"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="a00179.html">sensor_drv.h</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="a00176.html#a67a2045f4f16d45f92fd22075416a7d6"> 21</a></span> <span class="preprocessor">#define SPI_SS_ACTIVE_LOW (ARM_SPI_SS_INACTIVE)</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="a00176.html#a8bfc94771e6451d3c1eaeb0c4fa5838b"> 22</a></span> <span class="preprocessor">#define SPI_SS_ACTIVE_HIGH (ARM_SPI_SS_ACTIVE)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/*! Function pointer for the slave read information*/</span></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="a00176.html#a0b1ee48e1042835580b5795f11086af8"> 25</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="a00176.html#a0b1ee48e1042835580b5795f11086af8">fpSpiReadPreprocessFn_t</a>)(<span class="keywordtype">void</span> *pCmdOut, uint32_t offset, uint32_t <a class="code" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>);<span class="comment"></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/*! Function pointer for the slave write information*/</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="a00176.html#a3b83d5ebbf3132b2c1077a907f9b9c41"> 27</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="a00176.html#a3b83d5ebbf3132b2c1077a907f9b9c41">fpSpiWritePreprocessFn_t</a>)(<span class="keywordtype">void</span> *pCmdOut, uint32_t offset, uint32_t <a class="code" href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a>, <span class="keywordtype">void</span> *pWritebuffer);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/*! @brief The SPI Slave Control Command Params SDK2.0 Driver. */</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="a03795.html"> 30</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="a03795.html#aa1f5d2f72e51fd01079605106392e2eb"> 32</a></span>  <span class="keywordtype">void</span> *<a class="code" href="a03795.html#aa1f5d2f72e51fd01079605106392e2eb">pTargetSlavePinID</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="a03795.html#a334f714d9d8bf2c14b5a5e88296c5ea5"> 33</a></span>  uint8_t <a class="code" href="a03795.html#a334f714d9d8bf2c14b5a5e88296c5ea5">activeValue</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a03795.html#a1fde2961f1b288f46bdf803fbf19a169"> 34</a></span>  uint8_t <a class="code" href="a03795.html#a1fde2961f1b288f46bdf803fbf19a169">cmdCode</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> } <a class="code" href="a03795.html">spiControlParams_t</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/*! @brief The SPI Slave Transfer Command Params SDK2.0 Driver. */</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a03799.html"> 38</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a03799.html">spi_mater_SlaveCmd</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="a03799.html#ab2c6b258f02add8fdf4cfc7c371dd772"> 40</a></span>  uint32_t <a class="code" href="a03799.html#ab2c6b258f02add8fdf4cfc7c371dd772">size</a>; <span class="comment">/*!< The tranfer size.*/</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="a03799.html#a10f5aa82cde5c3db8000a0e7cc885a60"> 41</a></span>  uint8_t *<a class="code" href="a03799.html#a10f5aa82cde5c3db8000a0e7cc885a60">pReadBuffer</a>; <span class="comment">/*!< The handle the readbuffer.*/</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a03799.html#a7b4f7b0bd6850027bc5cf068ed22f608"> 42</a></span>  uint8_t *<a class="code" href="a03799.html#a7b4f7b0bd6850027bc5cf068ed22f608">pWriteBuffer</a>; <span class="comment">/*!< The handle the writecommand.*/</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> } <a class="code" href="a00176.html#abe4caa1b99c1fca53637ce87ffea7003">spiCmdParams_t</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/*! @brief This structure defines the spi slave command format. */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="a03803.html"> 46</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="a03803.html#ab4d08944f72286fde118fc7fa4667723"> 48</a></span>  <a class="code" href="a00176.html#a0b1ee48e1042835580b5795f11086af8">fpSpiReadPreprocessFn_t</a> <a class="code" href="a03803.html#ab4d08944f72286fde118fc7fa4667723">pReadPreprocessFN</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a03803.html#ab4281402074641230f56f227d0b796e5"> 49</a></span>  <a class="code" href="a00176.html#a3b83d5ebbf3132b2c1077a907f9b9c41">fpSpiWritePreprocessFn_t</a> <a class="code" href="a03803.html#ab4281402074641230f56f227d0b796e5">pWritePreprocessFN</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="a03803.html#aa1f5d2f72e51fd01079605106392e2eb"> 50</a></span>  <span class="keywordtype">void</span> *<a class="code" href="a03803.html#aa1f5d2f72e51fd01079605106392e2eb">pTargetSlavePinID</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="a03803.html#ad27d09756d625d132207782d1792e4df"> 51</a></span>  uint8_t <a class="code" href="a03803.html#ad27d09756d625d132207782d1792e4df">spiCmdLen</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="a03803.html#a45751b25ae9b3056830d3e425bd7a1b5"> 52</a></span>  uint8_t <a class="code" href="a03803.html#a45751b25ae9b3056830d3e425bd7a1b5">ssActiveValue</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <a class="code" href="a03803.html">spiSlaveSpecificParams_t</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#if defined(SPI0)</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/*! @brief The SPI0 device index. */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define SPI0_INDEX 0</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">void</span> SPI0_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#if defined(SPI1)</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/*! @brief The SPI1 device index. */</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#define SPI1_INDEX 1</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">void</span> SPI1_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#if defined(SPI2)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/*! @brief The SPI2 device index. */</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#define SPI2_INDEX 2</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">void</span> SPI2_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#if defined(SPI3)</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/*! @brief The SPI3 device index. */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#define SPI3_INDEX 3</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> */</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">void</span> SPI3_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#if defined(SPI4)</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/*! @brief The SPI4 device index. */</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#define SPI4_INDEX 4</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">void</span> SPI4_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#if defined(SPI5)</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">/*! @brief The SPI5 device index. */</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#define SPI5_INDEX 5</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">void</span> SPI5_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#if defined(SPI6)</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/*! @brief The SPI6 device index. */</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#define SPI6_INDEX 6</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="keywordtype">void</span> SPI6_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#if defined(SPI7)</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/*! @brief The SPI7 device index. */</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#define SPI7_INDEX 7</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"></span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> */</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keywordtype">void</span> SPI7_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#if defined(SPI8)</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/*! @brief The SPI8 device index. */</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#define SPI8_INDEX 8</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">/*! @brief Defines the SPI signal event handler.</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @param[in] event The SPI event that occured.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keywordtype">void</span> SPI8_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">/*!</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @brief The interface function to block write to a sensor register.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> *</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @param void *pWriteParams - the sensor's SPI slave select params.</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @param uint8_t offset - The register/offset to write to</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param uint8_t *pBuffer - The buffer containing bytes to write.</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param uint8_t bytesToWrite - A number of bytes to write.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> */</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00176.html#a0662e3575811a227d02c1cfe802744c5">Register_SPI_BlockWrite</a>(ARM_DRIVER_SPI *pCommDrv,</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordtype">void</span> *pWriteParams,</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  uint8_t offset,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">const</span> uint8_t *pBuffer,</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  uint8_t bytesToWrite);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/*!</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @brief The interface function to write a sensor register.</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> *</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * @param void *pWriteParams - the sensor's SPI slave select params.</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @param uint8_t offset - The register/offset to write to</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param uint8_t value - The value to write to the register</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @param uint8_t mask - A mask value to use when writing.</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * A non-zero mask indicates that a read-modify-write operation should be used.</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * where only the bits set in the mask will be updated according to the value param.</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> */</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00176.html#ac4eb16e5a939fce81270bab7f6707754">Register_SPI_Write</a>(ARM_DRIVER_SPI *pCommDrv,</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">void</span> *pWriteParams,</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  uint8_t offset,</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  uint8_t value,</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  uint8_t mask);</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"></span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">/*!</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @brief The interface function to read a sensor register.</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> *</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * @param void *pReadParams - the sensor's SPI slave select params.</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * @param uint8_t offset - The register/offset to read from</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * @param uint8_t length - The number of bytes to read</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @param uint8_t *pOutBuffer - The pointer to the buffer to store the register value read.</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> *</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> */</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00176.html#a76a3aee498397854509b81ae2da2f85e">Register_SPI_Read</a>(ARM_DRIVER_SPI *pCommDrv,</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordtype">void</span> *pReadParams,</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  uint8_t offset,</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  uint8_t length,</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  uint8_t *pOutBuffer);</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#endif // __REGISTER_IO_SPI_H__</span></div><div class="ttc" id="a00521_html_a18e09d6eabccd6dfc2d5066542020e59"><div class="ttname"><a href="a00521.html#a18e09d6eabccd6dfc2d5066542020e59">size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> <a href="a00521_source.html#l00043">data_format_service.h:43</a></div></div> 52<div class="ttc" id="a03803_html_a45751b25ae9b3056830d3e425bd7a1b5"><div class="ttname"><a href="a03803.html#a45751b25ae9b3056830d3e425bd7a1b5">spiSlaveSpecificParams_t::ssActiveValue</a></div><div class="ttdeci">uint8_t ssActiveValue</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00052">register_io_spi.h:52</a></div></div> 53<div class="ttc" id="a03803_html_aa1f5d2f72e51fd01079605106392e2eb"><div class="ttname"><a href="a03803.html#aa1f5d2f72e51fd01079605106392e2eb">spiSlaveSpecificParams_t::pTargetSlavePinID</a></div><div class="ttdeci">void * pTargetSlavePinID</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00050">register_io_spi.h:50</a></div></div> 54<div class="ttc" id="a03819_html"><div class="ttname"><a href="a03819.html">registerDeviceInfo_t</a></div><div class="ttdoc">This structure defines the device specific info required by register I/O. </div><div class="ttdef"><b>Definition:</b> <a href="a00179_source.html#l00102">sensor_drv.h:102</a></div></div> 55<div class="ttc" id="a00176_html_a0662e3575811a227d02c1cfe802744c5"><div class="ttname"><a href="a00176.html#a0662e3575811a227d02c1cfe802744c5">Register_SPI_BlockWrite</a></div><div class="ttdeci">int32_t Register_SPI_BlockWrite(ARM_DRIVER_SPI *pCommDrv, registerDeviceInfo_t *devInfo, void *pWriteParams, uint8_t offset, const uint8_t *pBuffer, uint8_t bytesToWrite)</div><div class="ttdoc">The interface function to block write to a sensor register. </div><div class="ttdef"><b>Definition:</b> <a href="a00173_source.html#l00162">register_io_spi.c:162</a></div></div> 56<div class="ttc" id="a00176_html_a3b83d5ebbf3132b2c1077a907f9b9c41"><div class="ttname"><a href="a00176.html#a3b83d5ebbf3132b2c1077a907f9b9c41">fpSpiWritePreprocessFn_t</a></div><div class="ttdeci">void(* fpSpiWritePreprocessFn_t)(void *pCmdOut, uint32_t offset, uint32_t size, void *pWritebuffer)</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00027">register_io_spi.h:27</a></div></div> 57<div class="ttc" id="a03803_html_ad27d09756d625d132207782d1792e4df"><div class="ttname"><a href="a03803.html#ad27d09756d625d132207782d1792e4df">spiSlaveSpecificParams_t::spiCmdLen</a></div><div class="ttdeci">uint8_t spiCmdLen</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00051">register_io_spi.h:51</a></div></div> 58<div class="ttc" id="a03803_html"><div class="ttname"><a href="a03803.html">spiSlaveSpecificParams_t</a></div><div class="ttdoc">This structure defines the spi slave command format. </div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00046">register_io_spi.h:46</a></div></div> 59<div class="ttc" id="a03799_html_ab2c6b258f02add8fdf4cfc7c371dd772"><div class="ttname"><a href="a03799.html#ab2c6b258f02add8fdf4cfc7c371dd772">spi_mater_SlaveCmd::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00040">register_io_spi.h:40</a></div></div> 60<div class="ttc" id="a00179_html"><div class="ttname"><a href="a00179.html">sensor_drv.h</a></div><div class="ttdoc">The sensor_drv.h file contains sensor state and error definitions. </div></div> 61<div class="ttc" id="a00521_html_a5d7069350a7d7e65686c77a8038f462f"><div class="ttname"><a href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a></div><div class="ttdeci">typedef int32_t(DATA_FORMAT_Append_t))(void *pData</div><div class="ttdoc">The interface function to append the data on the formated stream. </div></div> 62<div class="ttc" id="a03795_html_aa1f5d2f72e51fd01079605106392e2eb"><div class="ttname"><a href="a03795.html#aa1f5d2f72e51fd01079605106392e2eb">spiControlParams_t::pTargetSlavePinID</a></div><div class="ttdeci">void * pTargetSlavePinID</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00032">register_io_spi.h:32</a></div></div> 63<div class="ttc" id="a03803_html_ab4d08944f72286fde118fc7fa4667723"><div class="ttname"><a href="a03803.html#ab4d08944f72286fde118fc7fa4667723">spiSlaveSpecificParams_t::pReadPreprocessFN</a></div><div class="ttdeci">fpSpiReadPreprocessFn_t pReadPreprocessFN</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00048">register_io_spi.h:48</a></div></div> 64<div class="ttc" id="a03799_html"><div class="ttname"><a href="a03799.html">spi_mater_SlaveCmd</a></div><div class="ttdoc">The SPI Slave Transfer Command Params SDK2.0 Driver. </div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00038">register_io_spi.h:38</a></div></div> 65<div class="ttc" id="a00176_html_a76a3aee498397854509b81ae2da2f85e"><div class="ttname"><a href="a00176.html#a76a3aee498397854509b81ae2da2f85e">Register_SPI_Read</a></div><div class="ttdeci">int32_t Register_SPI_Read(ARM_DRIVER_SPI *pCommDrv, registerDeviceInfo_t *devInfo, void *pReadParams, uint8_t offset, uint8_t length, uint8_t *pOutBuffer)</div><div class="ttdoc">The interface function to read a sensor register. </div><div class="ttdef"><b>Definition:</b> <a href="a00173_source.html#l00313">register_io_spi.c:313</a></div></div> 66<div class="ttc" id="a03799_html_a7b4f7b0bd6850027bc5cf068ed22f608"><div class="ttname"><a href="a03799.html#a7b4f7b0bd6850027bc5cf068ed22f608">spi_mater_SlaveCmd::pWriteBuffer</a></div><div class="ttdeci">uint8_t * pWriteBuffer</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00042">register_io_spi.h:42</a></div></div> 67<div class="ttc" id="a00176_html_abe4caa1b99c1fca53637ce87ffea7003"><div class="ttname"><a href="a00176.html#abe4caa1b99c1fca53637ce87ffea7003">spiCmdParams_t</a></div><div class="ttdeci">struct spi_mater_SlaveCmd spiCmdParams_t</div><div class="ttdoc">The SPI Slave Transfer Command Params SDK2.0 Driver. </div></div> 68<div class="ttc" id="a03795_html"><div class="ttname"><a href="a03795.html">spiControlParams_t</a></div><div class="ttdoc">The SPI Slave Control Command Params SDK2.0 Driver. </div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00030">register_io_spi.h:30</a></div></div> 69<div class="ttc" id="a03799_html_a10f5aa82cde5c3db8000a0e7cc885a60"><div class="ttname"><a href="a03799.html#a10f5aa82cde5c3db8000a0e7cc885a60">spi_mater_SlaveCmd::pReadBuffer</a></div><div class="ttdeci">uint8_t * pReadBuffer</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00041">register_io_spi.h:41</a></div></div> 70<div class="ttc" id="a03795_html_a1fde2961f1b288f46bdf803fbf19a169"><div class="ttname"><a href="a03795.html#a1fde2961f1b288f46bdf803fbf19a169">spiControlParams_t::cmdCode</a></div><div class="ttdeci">uint8_t cmdCode</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00034">register_io_spi.h:34</a></div></div> 71<div class="ttc" id="a00176_html_a0b1ee48e1042835580b5795f11086af8"><div class="ttname"><a href="a00176.html#a0b1ee48e1042835580b5795f11086af8">fpSpiReadPreprocessFn_t</a></div><div class="ttdeci">void(* fpSpiReadPreprocessFn_t)(void *pCmdOut, uint32_t offset, uint32_t size)</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00025">register_io_spi.h:25</a></div></div> 72<div class="ttc" id="a03803_html_ab4281402074641230f56f227d0b796e5"><div class="ttname"><a href="a03803.html#ab4281402074641230f56f227d0b796e5">spiSlaveSpecificParams_t::pWritePreprocessFN</a></div><div class="ttdeci">fpSpiWritePreprocessFn_t pWritePreprocessFN</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00049">register_io_spi.h:49</a></div></div> 73<div class="ttc" id="a03795_html_a334f714d9d8bf2c14b5a5e88296c5ea5"><div class="ttname"><a href="a03795.html#a334f714d9d8bf2c14b5a5e88296c5ea5">spiControlParams_t::activeValue</a></div><div class="ttdeci">uint8_t activeValue</div><div class="ttdef"><b>Definition:</b> <a href="a00176_source.html#l00033">register_io_spi.h:33</a></div></div> 74<div class="ttc" id="a00176_html_ac4eb16e5a939fce81270bab7f6707754"><div class="ttname"><a href="a00176.html#ac4eb16e5a939fce81270bab7f6707754">Register_SPI_Write</a></div><div class="ttdeci">int32_t Register_SPI_Write(ARM_DRIVER_SPI *pCommDrv, registerDeviceInfo_t *devInfo, void *pWriteParams, uint8_t offset, uint8_t value, uint8_t mask)</div><div class="ttdoc">The interface function to write a sensor register. </div><div class="ttdef"><b>Definition:</b> <a href="a00173_source.html#l00216">register_io_spi.c:216</a></div></div> 75</div><!-- fragment --></div><!-- contents --> 76 77<hr class="footer"/><address class="footer"><small> 78© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause 79</small></address> 80</body> 81</html> 82
