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_i2c.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_i2c.h</div> </div> 49</div><!--header--> 50<div class="contents"> 51<a href="a00170.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_i2c.h</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * @brief The register_io_i2c.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.</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_I2C_H__</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define __REGISTER_IO_I2C_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 "<a class="code" href="a00179.html">sensor_drv.h</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "Driver_I2C.h"</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"> 21</span> <span class="preprocessor">#if defined(I2C0)</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/*! @brief The I2C0 device index. */</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define I2C0_INDEX 0</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> I2C0_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#if defined(I2C1)</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/*! @brief The I2C1 device index. */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define I2C1_INDEX 1</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span> I2C1_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#if defined(I2C2)</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/*! @brief The I2C2 device index. */</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define I2C2_INDEX 2</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">void</span> I2C2_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#if defined(I2C3)</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/*! @brief The I2C3 device index. */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define I2C3_INDEX 3</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">void</span> I2C3_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#if defined(I2C4)</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/*! @brief The I2C4 device index. */</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#define I2C4_INDEX 4</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> I2C4_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#if defined(I2C5)</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/*! @brief The I2C5 device index. */</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define I2C5_INDEX 5</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span> I2C5_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#if defined(I2C6)</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/*! @brief The I2C6 device index. */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#define I2C6_INDEX 6</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">void</span> I2C6_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#if defined(I2C7)</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">/*! @brief The I2C7 device index. */</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#define I2C7_INDEX 7</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> */</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">void</span> I2C7_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#ifdef MIMXRT500_AGM01</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#if defined(I2C11)</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/*! @brief The I2C11 device index. */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#define I2C11_INDEX 11</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"></span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/*! @brief Defines the I2C signal event handler.</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @details The Signal Event Handler function required by register_io_i2c.c.</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * @param[in] event The I2C event that occured.</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @Constraints None</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @Reentrant Yes</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @return void</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">void</span> I2C11_SignalEvent_t(uint32_t event);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"></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="comment"> * @brief The interface function to write a sensor register.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> *</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @param ARM_DRIVER_I2C *pCommDrv - The I2C driver to use.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The I2C device number and idle function.</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @param uint16_t slaveAddress - the sensor's I2C slave address.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @param uint8_t offset - The register/offset to write to.</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param uint8_t *pBuffer - The buffer containing bytes to write.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param uint8_t bytesToWrite - A number of bytes to write.</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> *</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00170.html#ac5a66aa1b8d95d267c9d68cb475c9e01">Register_I2C_BlockWrite</a>(ARM_DRIVER_I2C *pCommDrv,</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  uint16_t slaveAddress,</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  uint8_t offset,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">const</span> uint8_t *pBuffer,</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  uint8_t bytesToWrite);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/*!</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @brief The interface function to write a sensor register.</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"> * @param ARM_DRIVER_I2C *pCommDrv - The I2C driver to use.</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The I2C device number and idle function.</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @param uint16_t slaveAddress - the sensor's I2C slave address.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param uint8_t offset - The register/offset to write to</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param uint8_t value - The value to write to the register</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @param uint8_t mask - A mask value to use when writing.</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</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="l00178"></a><span class="lineno"> 178</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="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * @param bool repeatedStart - Indicates whether to send STOP or REPEATED_START bit after the write</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"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00170.html#ad08d2c7880bc5f09fd27eee247311448">Register_I2C_Write</a>(ARM_DRIVER_I2C *pCommDrv,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  uint16_t slaveAddress,</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  uint8_t offset,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  uint8_t value,</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  uint8_t mask,</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordtype">bool</span> repeatedStart);</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">/*!</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * @brief The interface function to read a sensor register.</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> *</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * @param ARM_DRIVER_I2C *pCommDrv - The I2C driver to use.</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @param registerDeviceInfo_t *devInfo - The I2C device number and idle function.</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @param uint16_t slaveAddress - the sensor's I2C slave address.</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @param uint8_t offset - The register/offset to read from</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @param uint8_t length - The number of bytes to read</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</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="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"> * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.</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> <a class="code" href="a00521.html#a5d7069350a7d7e65686c77a8038f462f">int32_t</a> <a class="code" href="a00170.html#ac8a60c799d9dbc84531b4680762eb8dc">Register_I2C_Read</a>(ARM_DRIVER_I2C *pCommDrv,</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <a class="code" href="a03819.html">registerDeviceInfo_t</a> *devInfo,</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  uint16_t slaveAddress,</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  uint8_t offset,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  uint8_t length,</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  uint8_t *pOutBuffer);</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#endif // __REGISTER_IO_I2C_H__</span></div><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> 52<div class="ttc" id="a00170_html_ac8a60c799d9dbc84531b4680762eb8dc"><div class="ttname"><a href="a00170.html#ac8a60c799d9dbc84531b4680762eb8dc">Register_I2C_Read</a></div><div class="ttdeci">int32_t Register_I2C_Read(ARM_DRIVER_I2C *pCommDrv, registerDeviceInfo_t *devInfo, uint16_t slaveAddress, 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="a00167_source.html#l00310">register_io_i2c.c:310</a></div></div> 53<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> 54<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> 55<div class="ttc" id="a00170_html_ad08d2c7880bc5f09fd27eee247311448"><div class="ttname"><a href="a00170.html#ad08d2c7880bc5f09fd27eee247311448">Register_I2C_Write</a></div><div class="ttdeci">int32_t Register_I2C_Write(ARM_DRIVER_I2C *pCommDrv, registerDeviceInfo_t *devInfo, uint16_t slaveAddress, uint8_t offset, uint8_t value, uint8_t mask, bool repeatedStart)</div><div class="ttdoc">The interface function to write a sensor register. </div><div class="ttdef"><b>Definition:</b> <a href="a00167_source.html#l00193">register_io_i2c.c:193</a></div></div> 56<div class="ttc" id="a00170_html_ac5a66aa1b8d95d267c9d68cb475c9e01"><div class="ttname"><a href="a00170.html#ac5a66aa1b8d95d267c9d68cb475c9e01">Register_I2C_BlockWrite</a></div><div class="ttdeci">int32_t Register_I2C_BlockWrite(ARM_DRIVER_I2C *pCommDrv, registerDeviceInfo_t *devInfo, uint16_t slaveAddress, uint8_t offset, const uint8_t *pBuffer, uint8_t bytesToWrite)</div><div class="ttdoc">The interface function to write a sensor register. </div><div class="ttdef"><b>Definition:</b> <a href="a00167_source.html#l00149">register_io_i2c.c:149</a></div></div> 57</div><!-- fragment --></div><!-- contents --> 58 59<hr class="footer"/><address class="footer"><small> 60© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause 61</small></address> 62</body> 63</html> 64
