begriffs open source - cmsis/blob - main/Driver/html/group__vioDefines__gr.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: Defines and Structs</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-Driver");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__vioDefines__gr.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#groups">Content</a> &#124;
 129 <a href="#func-members">Functions</a>  </div>
 130   <div class="headertitle"><div class="title">Defines and Structs<div class="ingroups"><a class="el" href="group__vio__interface__gr.html">VIO</a></div></div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133
 134 <p>Documents the defines and structs of the VIO API.
 135 <a href="#details">More...</a></p>
 136 <table class="memberdecls">
 137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 138 Content</h2></td></tr>
 139 <tr class="memitem:group__vioSignals__gr"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioSignals__gr.html">Signals</a></td></tr>
 140 <tr class="memdesc:group__vioSignals__gr"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal related defines. <br /></td></tr>
 141 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:group__vioValues__gr"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioValues__gr.html">Values</a></td></tr>
 143 <tr class="memdesc:group__vioValues__gr"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value related defines. <br /></td></tr>
 144 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 </table><table class="memberdecls">
 146 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 147 Functions</h2></td></tr>
 148 <tr class="memitem:ga84e05ae351226f41d461dbe982b2372f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a> (void)</td></tr>
 149 <tr class="memdesc:ga84e05ae351226f41d461dbe982b2372f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize test input, output.  <br /></td></tr>
 150 <tr class="separator:ga84e05ae351226f41d461dbe982b2372f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:ga1dcabb62642917a4911d26175132a339"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a> (uint32_t level, const char *format,...)</td></tr>
 152 <tr class="memdesc:ga1dcabb62642917a4911d26175132a339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print formated string to test terminal.  <br /></td></tr>
 153 <tr class="separator:ga1dcabb62642917a4911d26175132a339"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:ga1ded6ad7451e43d94f00e9efaddfe621"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga1ded6ad7451e43d94f00e9efaddfe621">vioSetSignal</a> (uint32_t mask, uint32_t signal)</td></tr>
 155 <tr class="memdesc:ga1ded6ad7451e43d94f00e9efaddfe621"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set signal output.  <br /></td></tr>
 156 <tr class="separator:ga1ded6ad7451e43d94f00e9efaddfe621"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga852f94060d9bef92b193e9992a1c2016"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga852f94060d9bef92b193e9992a1c2016">vioGetSignal</a> (uint32_t mask)</td></tr>
 158 <tr class="memdesc:ga852f94060d9bef92b193e9992a1c2016"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get signal input.  <br /></td></tr>
 159 <tr class="separator:ga852f94060d9bef92b193e9992a1c2016"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga5d2572868a34ccfdb10d32adce8f6102"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga5d2572868a34ccfdb10d32adce8f6102">vioSetValue</a> (uint32_t id, int32_t value)</td></tr>
 161 <tr class="memdesc:ga5d2572868a34ccfdb10d32adce8f6102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set value output.  <br /></td></tr>
 162 <tr class="separator:ga5d2572868a34ccfdb10d32adce8f6102"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:ga637e596f4309323b1e4e1da6200d4717"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga637e596f4309323b1e4e1da6200d4717">vioGetValue</a> (uint32_t id)</td></tr>
 164 <tr class="memdesc:ga637e596f4309323b1e4e1da6200d4717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get value input.  <br /></td></tr>
 165 <tr class="separator:ga637e596f4309323b1e4e1da6200d4717"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:ga440aca5e2a9fb89a56ce727329b23b54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga440aca5e2a9fb89a56ce727329b23b54">vioSetXYZ</a> (uint32_t id, <a class="el" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a> valueXYZ)</td></tr>
 167 <tr class="memdesc:ga440aca5e2a9fb89a56ce727329b23b54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set XYZ value output.  <br /></td></tr>
 168 <tr class="separator:ga440aca5e2a9fb89a56ce727329b23b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:ga3e1e45b6a85ae9a3a7f30ef9918c34b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga3e1e45b6a85ae9a3a7f30ef9918c34b1">vioGetXYZ</a> (uint32_t id)</td></tr>
 170 <tr class="memdesc:ga3e1e45b6a85ae9a3a7f30ef9918c34b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get XYZ value input.  <br /></td></tr>
 171 <tr class="separator:ga3e1e45b6a85ae9a3a7f30ef9918c34b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:gafec1413f0d3624bb8922a3973636b587"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#gafec1413f0d3624bb8922a3973636b587">vioSetIPv4</a> (uint32_t id, <a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a> addrIPv4)</td></tr>
 173 <tr class="memdesc:gafec1413f0d3624bb8922a3973636b587"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set IPv4 address output.  <br /></td></tr>
 174 <tr class="separator:gafec1413f0d3624bb8922a3973636b587"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:ga22b8711d1858eedde919053d269aa073"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga22b8711d1858eedde919053d269aa073">vioGetIPv4</a> (uint32_t id)</td></tr>
 176 <tr class="memdesc:ga22b8711d1858eedde919053d269aa073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get IPv4 address input.  <br /></td></tr>
 177 <tr class="separator:ga22b8711d1858eedde919053d269aa073"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:ga3592d2a14aca73d219022712279b8fa5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#ga3592d2a14aca73d219022712279b8fa5">vioSetIPv6</a> (uint32_t id, <a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a> addrIPv6)</td></tr>
 179 <tr class="memdesc:ga3592d2a14aca73d219022712279b8fa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set IPv6 address output.  <br /></td></tr>
 180 <tr class="separator:ga3592d2a14aca73d219022712279b8fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:gabde8fededde24fc47b1b80fdee4466f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vioDefines__gr.html#gabde8fededde24fc47b1b80fdee4466f0">vioGetIPv6</a> (uint32_t id)</td></tr>
 182 <tr class="memdesc:gabde8fededde24fc47b1b80fdee4466f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get IPv6 address from peripheral.  <br /></td></tr>
 183 <tr class="separator:gabde8fededde24fc47b1b80fdee4466f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 </table>
 185 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 186 <p>Documents the defines and structs of the VIO API. </p>
 187 <p>Test. </p>
 188 <h2 class="groupheader">Function Documentation</h2>
 189 <a id="ga84e05ae351226f41d461dbe982b2372f" name="ga84e05ae351226f41d461dbe982b2372f"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#ga84e05ae351226f41d461dbe982b2372f">&#9670;&#160;</a></span>vioInit()</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">void vioInit </td>
 197           <td>(</td>
 198           <td class="paramtype">void&#160;</td>
 199           <td class="paramname"></td><td>)</td>
 200           <td></td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204
 205 <p>Initialize test input, output. </p>
 206 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 207 <p>The function <b>vioInit</b> initializes the VIO interface. Use it to initialize any connected hardware that is used to map VIO signals.</p>
 208 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 209 <div class="line"> </div>
 210 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 211 <div class="line"> </div>
 212 <div class="line">  <span class="comment">// System Initialization</span></div>
 213 <div class="line">  SystemCoreClockUpdate();</div>
 214 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 215 <div class="line">  <span class="comment">// ...</span></div>
 216 <div class="line"> </div>
 217 <div class="line">}</div>
 218 <div class="ttc" id="acmsis__vio_8h_html"><div class="ttname"><a href="cmsis__vio_8h.html">cmsis_vio.h</a></div></div>
 219 <div class="ttc" id="agroup__vioDefines__gr_html_ga84e05ae351226f41d461dbe982b2372f"><div class="ttname"><a href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a></div><div class="ttdeci">void vioInit(void)</div><div class="ttdoc">Initialize test input, output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:221</div></div>
 220 </div><!-- fragment -->
 221 </div>
 222 </div>
 223 <a id="ga1dcabb62642917a4911d26175132a339" name="ga1dcabb62642917a4911d26175132a339"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#ga1dcabb62642917a4911d26175132a339">&#9670;&#160;</a></span>vioPrint()</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">int32_t vioPrint </td>
 231           <td>(</td>
 232           <td class="paramtype">uint32_t&#160;</td>
 233           <td class="paramname"><em>level</em>, </td>
 234         </tr>
 235         <tr>
 236           <td class="paramkey"></td>
 237           <td></td>
 238           <td class="paramtype">const char *&#160;</td>
 239           <td class="paramname"><em>format</em>, </td>
 240         </tr>
 241         <tr>
 242           <td class="paramkey"></td>
 243           <td></td>
 244           <td class="paramtype">&#160;</td>
 245           <td class="paramname"><em>...</em>&#160;</td>
 246         </tr>
 247         <tr>
 248           <td></td>
 249           <td>)</td>
 250           <td></td><td></td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254
 255 <p>Print formated string to test terminal. </p>
 256 <dl class="params"><dt>Parameters</dt><dd>
 257   <table class="params">
 258     <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>level (vioLevel...). </td></tr>
 259     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>formated string to print. </td></tr>
 260     <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>optional arguments (depending on format string). </td></tr>
 261   </table>
 262   </dd>
 263 </dl>
 264 <dl class="section return"><dt>Returns</dt><dd>number of characters written or -1 in case of error.</dd></dl>
 265 <p>The function <b>vioPrint</b> prints a formatted string to a test terminal. Formatting of the output follows the rules of standard C language printf().</p>
 266 <p>Refer to <a class="el" href="group__vioPrintLevels__gr.html">Print Levels</a> for information about the possible <em>levels</em>.</p>
 267 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 268 <div class="line"> </div>
 269 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 270 <div class="line">  <span class="keywordtype">int</span> x = 3;</div>
 271 <div class="line"> </div>
 272 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 273 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a>(<a class="code hl_define" href="cmsis__vio_8h.html#a4a2f40db5d209268b9e0669e919c7436">vioLevelNone</a>,    <span class="stringliteral">&quot;Test [None]&quot;</span>); </div>
 274 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a>(<a class="code hl_define" href="group__vioPrintLevels__gr.html#ga2d12345777fbb057da8a847f2c74332d">vioLevelHeading</a>, <span class="stringliteral">&quot;Test [Heading] = Network Connector Message&quot;</span>); </div>
 275 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a>(<a class="code hl_define" href="group__vioPrintLevels__gr.html#gadc4de0163245bf69476bab577c88f972">vioLevelMessage</a>, <span class="stringliteral">&quot;Test [Message] = Connection failed&quot;</span>); </div>
 276 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a>(<a class="code hl_define" href="group__vioPrintLevels__gr.html#gae2d092fb498aa5ef8fe01bb9287edd17">vioLevelError</a>,   <span class="stringliteral">&quot;Test [Error]   = %d&quot;</span>, x); </div>
 277 <div class="line">}</div>
 278 <div class="ttc" id="acmsis__vio_8h_html_a4a2f40db5d209268b9e0669e919c7436"><div class="ttname"><a href="cmsis__vio_8h.html#a4a2f40db5d209268b9e0669e919c7436">vioLevelNone</a></div><div class="ttdeci">#define vioLevelNone</div><div class="ttdoc">vioPrint level parameter: None</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:78</div></div>
 279 <div class="ttc" id="agroup__vioDefines__gr_html_ga1dcabb62642917a4911d26175132a339"><div class="ttname"><a href="group__vioDefines__gr.html#ga1dcabb62642917a4911d26175132a339">vioPrint</a></div><div class="ttdeci">int32_t vioPrint(uint32_t level, const char *format,...)</div><div class="ttdoc">Print formated string to test terminal.</div><div class="ttdef"><b>Definition:</b> VIO.txt:243</div></div>
 280 <div class="ttc" id="agroup__vioPrintLevels__gr_html_ga2d12345777fbb057da8a847f2c74332d"><div class="ttname"><a href="group__vioPrintLevels__gr.html#ga2d12345777fbb057da8a847f2c74332d">vioLevelHeading</a></div><div class="ttdeci">#define vioLevelHeading</div><div class="ttdoc">vioPrint level parameter: Heading</div></div>
 281 <div class="ttc" id="agroup__vioPrintLevels__gr_html_gadc4de0163245bf69476bab577c88f972"><div class="ttname"><a href="group__vioPrintLevels__gr.html#gadc4de0163245bf69476bab577c88f972">vioLevelMessage</a></div><div class="ttdeci">#define vioLevelMessage</div><div class="ttdoc">vioPrint level parameter: Message</div></div>
 282 <div class="ttc" id="agroup__vioPrintLevels__gr_html_gae2d092fb498aa5ef8fe01bb9287edd17"><div class="ttname"><a href="group__vioPrintLevels__gr.html#gae2d092fb498aa5ef8fe01bb9287edd17">vioLevelError</a></div><div class="ttdeci">#define vioLevelError</div><div class="ttdoc">vioPrint level parameter: Error</div></div>
 283 </div><!-- fragment -->
 284 </div>
 285 </div>
 286 <a id="ga1ded6ad7451e43d94f00e9efaddfe621" name="ga1ded6ad7451e43d94f00e9efaddfe621"></a>
 287 <h2 class="memtitle"><span class="permalink"><a href="#ga1ded6ad7451e43d94f00e9efaddfe621">&#9670;&#160;</a></span>vioSetSignal()</h2>
 288
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname">void vioSetSignal </td>
 294           <td>(</td>
 295           <td class="paramtype">uint32_t&#160;</td>
 296           <td class="paramname"><em>mask</em>, </td>
 297         </tr>
 298         <tr>
 299           <td class="paramkey"></td>
 300           <td></td>
 301           <td class="paramtype">uint32_t&#160;</td>
 302           <td class="paramname"><em>signal</em>&#160;</td>
 303         </tr>
 304         <tr>
 305           <td></td>
 306           <td>)</td>
 307           <td></td><td></td>
 308         </tr>
 309       </table>
 310 </div><div class="memdoc">
 311
 312 <p>Set signal output. </p>
 313 <dl class="params"><dt>Parameters</dt><dd>
 314   <table class="params">
 315     <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>bit mask of signals to set. </td></tr>
 316     <tr><td class="paramdir">[in]</td><td class="paramname">signal</td><td>signal value to set. </td></tr>
 317   </table>
 318   </dd>
 319 </dl>
 320 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 321 <p>The function <b>vioSetSignal</b> set a <em>signal</em> to an output specified by <em>mask</em>. Use this function to map VIOs to actual hardware for displaying signals on a target board.</p>
 322 <p>Refer to <a class="el" href="group__vioSignals__gr.html">Signals</a> for information about the possible <em>mask</em> and <em>signal</em> values.</p>
 323 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 324 <div class="line"> </div>
 325 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 326 <div class="line"> </div>
 327 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 328 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1ded6ad7451e43d94f00e9efaddfe621">vioSetSignal</a>(<a class="code hl_define" href="group__vioSignals__gr.html#ga026dee2deae0bea0ff4891d5f5f11c90">vioLED0</a>, <a class="code hl_define" href="group__vioSignals__gr.html#gae909aa203834183f9f10f267b1dc7dc8">vioLEDon</a>);</div>
 329 <div class="line">  <span class="comment">// ...</span></div>
 330 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga1ded6ad7451e43d94f00e9efaddfe621">vioSetSignal</a>(<a class="code hl_define" href="group__vioSignals__gr.html#ga026dee2deae0bea0ff4891d5f5f11c90">vioLED0</a>, <a class="code hl_define" href="group__vioSignals__gr.html#gac47779d89b1e40ea5254bef26accf0ee">vioLEDoff</a>);</div>
 331 <div class="line">}</div>
 332 <div class="ttc" id="agroup__vioDefines__gr_html_ga1ded6ad7451e43d94f00e9efaddfe621"><div class="ttname"><a href="group__vioDefines__gr.html#ga1ded6ad7451e43d94f00e9efaddfe621">vioSetSignal</a></div><div class="ttdeci">void vioSetSignal(uint32_t mask, uint32_t signal)</div><div class="ttdoc">Set signal output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:270</div></div>
 333 <div class="ttc" id="agroup__vioSignals__gr_html_ga026dee2deae0bea0ff4891d5f5f11c90"><div class="ttname"><a href="group__vioSignals__gr.html#ga026dee2deae0bea0ff4891d5f5f11c90">vioLED0</a></div><div class="ttdeci">#define vioLED0</div><div class="ttdoc">vioSetSignal mask parameter: LED 0 (for 3-color: red)</div></div>
 334 <div class="ttc" id="agroup__vioSignals__gr_html_gac47779d89b1e40ea5254bef26accf0ee"><div class="ttname"><a href="group__vioSignals__gr.html#gac47779d89b1e40ea5254bef26accf0ee">vioLEDoff</a></div><div class="ttdeci">#define vioLEDoff</div><div class="ttdoc">vioSetSignal signal parameter: pattern to turn any LED off</div></div>
 335 <div class="ttc" id="agroup__vioSignals__gr_html_gae909aa203834183f9f10f267b1dc7dc8"><div class="ttname"><a href="group__vioSignals__gr.html#gae909aa203834183f9f10f267b1dc7dc8">vioLEDon</a></div><div class="ttdeci">#define vioLEDon</div><div class="ttdoc">vioSetSignal signal parameter: pattern to turn any LED on</div></div>
 336 </div><!-- fragment -->
 337 </div>
 338 </div>
 339 <a id="ga852f94060d9bef92b193e9992a1c2016" name="ga852f94060d9bef92b193e9992a1c2016"></a>
 340 <h2 class="memtitle"><span class="permalink"><a href="#ga852f94060d9bef92b193e9992a1c2016">&#9670;&#160;</a></span>vioGetSignal()</h2>
 341
 342 <div class="memitem">
 343 <div class="memproto">
 344       <table class="memname">
 345         <tr>
 346           <td class="memname">uint32_t vioGetSignal </td>
 347           <td>(</td>
 348           <td class="paramtype">uint32_t&#160;</td>
 349           <td class="paramname"><em>mask</em></td><td>)</td>
 350           <td></td>
 351         </tr>
 352       </table>
 353 </div><div class="memdoc">
 354
 355 <p>Get signal input. </p>
 356 <dl class="params"><dt>Parameters</dt><dd>
 357   <table class="params">
 358     <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>bit mask of signals to read. </td></tr>
 359   </table>
 360   </dd>
 361 </dl>
 362 <dl class="section return"><dt>Returns</dt><dd>signal value.</dd></dl>
 363 <p>The function <b>vioGetSignal</b> retrieves a signal from an input identified by <em>mask</em>. Use this function to read data from any input that is provided.</p>
 364 <p>Refer to <a class="el" href="group__vioSignals__gr.html">Signals</a> for information about the possible <em>mask</em> values.</p>
 365 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 366 <div class="line"> </div>
 367 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 368 <div class="line">  uint32_t state;</div>
 369 <div class="line">  uint32_t last = 0U;</div>
 370 <div class="line"> </div>
 371 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 372 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 373 <div class="line">    state = (<a class="code hl_function" href="group__vioDefines__gr.html#ga852f94060d9bef92b193e9992a1c2016">vioGetSignal</a> (<a class="code hl_define" href="cmsis__vio_8h.html#a642440766bc00069da04379bc1f1598d">vioBUTTON0</a>)); <span class="comment">// Get pressed button state</span></div>
 374 <div class="line">    <span class="keywordflow">if</span> (state != last){</div>
 375 <div class="line">      <span class="keywordflow">if</span> (state == <a class="code hl_define" href="cmsis__vio_8h.html#a642440766bc00069da04379bc1f1598d">vioBUTTON0</a>){</div>
 376 <div class="line">        <span class="comment">// do something</span></div>
 377 <div class="line">      }</div>
 378 <div class="line">    }</div>
 379 <div class="line">    last = state;</div>
 380 <div class="line">  }</div>
 381 <div class="line">}</div>
 382 <div class="ttc" id="acmsis__vio_8h_html_a642440766bc00069da04379bc1f1598d"><div class="ttname"><a href="cmsis__vio_8h.html#a642440766bc00069da04379bc1f1598d">vioBUTTON0</a></div><div class="ttdeci">#define vioBUTTON0</div><div class="ttdoc">vioGetSignal mask parameter: Push button 0</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:50</div></div>
 383 <div class="ttc" id="agroup__vioDefines__gr_html_ga852f94060d9bef92b193e9992a1c2016"><div class="ttname"><a href="group__vioDefines__gr.html#ga852f94060d9bef92b193e9992a1c2016">vioGetSignal</a></div><div class="ttdeci">uint32_t vioGetSignal(uint32_t mask)</div><div class="ttdoc">Get signal input.</div><div class="ttdef"><b>Definition:</b> VIO.txt:293</div></div>
 384 </div><!-- fragment -->
 385 </div>
 386 </div>
 387 <a id="ga5d2572868a34ccfdb10d32adce8f6102" name="ga5d2572868a34ccfdb10d32adce8f6102"></a>
 388 <h2 class="memtitle"><span class="permalink"><a href="#ga5d2572868a34ccfdb10d32adce8f6102">&#9670;&#160;</a></span>vioSetValue()</h2>
 389
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">void vioSetValue </td>
 395           <td>(</td>
 396           <td class="paramtype">uint32_t&#160;</td>
 397           <td class="paramname"><em>id</em>, </td>
 398         </tr>
 399         <tr>
 400           <td class="paramkey"></td>
 401           <td></td>
 402           <td class="paramtype">int32_t&#160;</td>
 403           <td class="paramname"><em>value</em>&#160;</td>
 404         </tr>
 405         <tr>
 406           <td></td>
 407           <td>)</td>
 408           <td></td><td></td>
 409         </tr>
 410       </table>
 411 </div><div class="memdoc">
 412
 413 <p>Set value output. </p>
 414 <dl class="params"><dt>Parameters</dt><dd>
 415   <table class="params">
 416     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>output identifier. </td></tr>
 417     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>value to set. </td></tr>
 418   </table>
 419   </dd>
 420 </dl>
 421 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 422 <p>The function <b>vioSetValue</b> set the <em>value</em> to the output identified by <em>id</em>. Use this function to set states of I/Os for example.</p>
 423 <p>Refer to <a class="el" href="group__vioValues__gr.html">Values</a> for information about <em>value</em> and <a class="el" href="group__vioIDs__gr.html">IDs</a> for <em>id</em>.</p>
 424 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 425 <div class="line"> </div>
 426 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 427 <div class="line"> </div>
 428 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 429 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga5d2572868a34ccfdb10d32adce8f6102">vioSetValue</a>(<a class="code hl_define" href="group__vioValues__gr.html#ga2eb17d856c43efcb7ba816822581b291">vioAOUT0</a>, 1024);</div>
 430 <div class="line">}</div>
 431 <div class="ttc" id="agroup__vioDefines__gr_html_ga5d2572868a34ccfdb10d32adce8f6102"><div class="ttname"><a href="group__vioDefines__gr.html#ga5d2572868a34ccfdb10d32adce8f6102">vioSetValue</a></div><div class="ttdeci">void vioSetValue(uint32_t id, int32_t value)</div><div class="ttdoc">Set value output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:326</div></div>
 432 <div class="ttc" id="agroup__vioValues__gr_html_ga2eb17d856c43efcb7ba816822581b291"><div class="ttname"><a href="group__vioValues__gr.html#ga2eb17d856c43efcb7ba816822581b291">vioAOUT0</a></div><div class="ttdeci">#define vioAOUT0</div><div class="ttdoc">vioSetValue / vioGetValue id parameter: Analog output value 0</div></div>
 433 </div><!-- fragment -->
 434 </div>
 435 </div>
 436 <a id="ga637e596f4309323b1e4e1da6200d4717" name="ga637e596f4309323b1e4e1da6200d4717"></a>
 437 <h2 class="memtitle"><span class="permalink"><a href="#ga637e596f4309323b1e4e1da6200d4717">&#9670;&#160;</a></span>vioGetValue()</h2>
 438
 439 <div class="memitem">
 440 <div class="memproto">
 441       <table class="memname">
 442         <tr>
 443           <td class="memname">int32_t vioGetValue </td>
 444           <td>(</td>
 445           <td class="paramtype">uint32_t&#160;</td>
 446           <td class="paramname"><em>id</em></td><td>)</td>
 447           <td></td>
 448         </tr>
 449       </table>
 450 </div><div class="memdoc">
 451
 452 <p>Get value input. </p>
 453 <dl class="params"><dt>Parameters</dt><dd>
 454   <table class="params">
 455     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>input identifier. </td></tr>
 456   </table>
 457   </dd>
 458 </dl>
 459 <dl class="section return"><dt>Returns</dt><dd>value retrieved from input.</dd></dl>
 460 <p>The function <b>vioGetValue</b> retrieves a value from the input identified by <em>id</em>. Use this function to read data from inputs.</p>
 461 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em>.</p>
 462 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 463 <div class="line"> </div>
 464 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 465 <div class="line">  uint32_t button;</div>
 466 <div class="line"> </div>
 467 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 468 <div class="line">  button = <a class="code hl_function" href="group__vioDefines__gr.html#ga637e596f4309323b1e4e1da6200d4717">vioGetValue</a>(<a class="code hl_define" href="cmsis__vio_8h.html#a642440766bc00069da04379bc1f1598d">vioBUTTON0</a>);</div>
 469 <div class="line">}</div>
 470 <div class="ttc" id="agroup__vioDefines__gr_html_ga637e596f4309323b1e4e1da6200d4717"><div class="ttname"><a href="group__vioDefines__gr.html#ga637e596f4309323b1e4e1da6200d4717">vioGetValue</a></div><div class="ttdeci">int32_t vioGetValue(uint32_t id)</div><div class="ttdoc">Get value input.</div><div class="ttdef"><b>Definition:</b> VIO.txt:347</div></div>
 471 </div><!-- fragment -->
 472 </div>
 473 </div>
 474 <a id="ga440aca5e2a9fb89a56ce727329b23b54" name="ga440aca5e2a9fb89a56ce727329b23b54"></a>
 475 <h2 class="memtitle"><span class="permalink"><a href="#ga440aca5e2a9fb89a56ce727329b23b54">&#9670;&#160;</a></span>vioSetXYZ()</h2>
 476
 477 <div class="memitem">
 478 <div class="memproto">
 479       <table class="memname">
 480         <tr>
 481           <td class="memname">void vioSetXYZ </td>
 482           <td>(</td>
 483           <td class="paramtype">uint32_t&#160;</td>
 484           <td class="paramname"><em>id</em>, </td>
 485         </tr>
 486         <tr>
 487           <td class="paramkey"></td>
 488           <td></td>
 489           <td class="paramtype"><a class="el" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a>&#160;</td>
 490           <td class="paramname"><em>valueXYZ</em>&#160;</td>
 491         </tr>
 492         <tr>
 493           <td></td>
 494           <td>)</td>
 495           <td></td><td></td>
 496         </tr>
 497       </table>
 498 </div><div class="memdoc">
 499
 500 <p>Set XYZ value output. </p>
 501 <dl class="params"><dt>Parameters</dt><dd>
 502   <table class="params">
 503     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>output identifier. </td></tr>
 504     <tr><td class="paramdir">[in]</td><td class="paramname">valueXYZ</td><td>XYZ data to set. </td></tr>
 505   </table>
 506   </dd>
 507 </dl>
 508 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 509 <p>The function <b>vioSetXYZ</b> sets a three-dimensional value <em>valueXYZ</em> to the output identified by <em>id</em>. Use this function to apply a 3d value to an output.</p>
 510 <p>Refer to <a class="el" href="group__vioValues__gr.html">Values</a> for information about the <em>valueXYZ</em> and <a class="el" href="group__vioIDs__gr.html">IDs</a> for <em>id</em>.</p>
 511 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 512 <div class="line"> </div>
 513 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 514 <div class="line">  <a class="code hl_struct" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a> xyz = {123, 456, 789};</div>
 515 <div class="line"> </div>
 516 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 517 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga440aca5e2a9fb89a56ce727329b23b54">vioSetXYZ</a>(0, xyz);</div>
 518 <div class="line">}</div>
 519 <div class="ttc" id="agroup__vioDefines__gr_html_ga440aca5e2a9fb89a56ce727329b23b54"><div class="ttname"><a href="group__vioDefines__gr.html#ga440aca5e2a9fb89a56ce727329b23b54">vioSetXYZ</a></div><div class="ttdeci">void vioSetXYZ(uint32_t id, vioValueXYZ_t valueXYZ)</div><div class="ttdoc">Set XYZ value output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:370</div></div>
 520 <div class="ttc" id="agroup__vioValues__gr_html_structvioValueXYZ__t"><div class="ttname"><a href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a></div><div class="ttdoc">3-D vector value</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:84</div></div>
 521 </div><!-- fragment -->
 522 </div>
 523 </div>
 524 <a id="ga3e1e45b6a85ae9a3a7f30ef9918c34b1" name="ga3e1e45b6a85ae9a3a7f30ef9918c34b1"></a>
 525 <h2 class="memtitle"><span class="permalink"><a href="#ga3e1e45b6a85ae9a3a7f30ef9918c34b1">&#9670;&#160;</a></span>vioGetXYZ()</h2>
 526
 527 <div class="memitem">
 528 <div class="memproto">
 529       <table class="memname">
 530         <tr>
 531           <td class="memname"><a class="el" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a> vioGetXYZ </td>
 532           <td>(</td>
 533           <td class="paramtype">uint32_t&#160;</td>
 534           <td class="paramname"><em>id</em></td><td>)</td>
 535           <td></td>
 536         </tr>
 537       </table>
 538 </div><div class="memdoc">
 539
 540 <p>Get XYZ value input. </p>
 541 <dl class="params"><dt>Parameters</dt><dd>
 542   <table class="params">
 543     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>input identifier. </td></tr>
 544   </table>
 545   </dd>
 546 </dl>
 547 <dl class="section return"><dt>Returns</dt><dd>XYZ data retrieved from XYZ peripheral.</dd></dl>
 548 <p>The function <b>vioGetXYZ</b> retrieves a three-dimensional value from the input identified by <em>id</em>. Use this function to get a 3d value.</p>
 549 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em>.</p>
 550 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 551 <div class="line"> </div>
 552 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 553 <div class="line">  <span class="keyword">volatile</span> <a class="code hl_struct" href="group__vioValues__gr.html#structvioValueXYZ__t">vioValueXYZ_t</a> xyz;</div>
 554 <div class="line"> </div>
 555 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 556 <div class="line">  xyz = <a class="code hl_function" href="group__vioDefines__gr.html#ga3e1e45b6a85ae9a3a7f30ef9918c34b1">vioGetXYZ</a>(<a class="code hl_define" href="cmsis__vio_8h.html#a39e8b7d134a1834ad7cd1b3dd94bdaf5">vioMotionGyro</a>);</div>
 557 <div class="line">}</div>
 558 <div class="ttc" id="acmsis__vio_8h_html_a39e8b7d134a1834ad7cd1b3dd94bdaf5"><div class="ttname"><a href="cmsis__vio_8h.html#a39e8b7d134a1834ad7cd1b3dd94bdaf5">vioMotionGyro</a></div><div class="ttdeci">#define vioMotionGyro</div><div class="ttdoc">vioSetXYZ / vioGetXYZ id parameter: for Gyroscope</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:73</div></div>
 559 <div class="ttc" id="agroup__vioDefines__gr_html_ga3e1e45b6a85ae9a3a7f30ef9918c34b1"><div class="ttname"><a href="group__vioDefines__gr.html#ga3e1e45b6a85ae9a3a7f30ef9918c34b1">vioGetXYZ</a></div><div class="ttdeci">vioValueXYZ_t vioGetXYZ(uint32_t id)</div><div class="ttdoc">Get XYZ value input.</div><div class="ttdef"><b>Definition:</b> VIO.txt:394</div></div>
 560 </div><!-- fragment -->
 561 </div>
 562 </div>
 563 <a id="gafec1413f0d3624bb8922a3973636b587" name="gafec1413f0d3624bb8922a3973636b587"></a>
 564 <h2 class="memtitle"><span class="permalink"><a href="#gafec1413f0d3624bb8922a3973636b587">&#9670;&#160;</a></span>vioSetIPv4()</h2>
 565
 566 <div class="memitem">
 567 <div class="memproto">
 568       <table class="memname">
 569         <tr>
 570           <td class="memname">void vioSetIPv4 </td>
 571           <td>(</td>
 572           <td class="paramtype">uint32_t&#160;</td>
 573           <td class="paramname"><em>id</em>, </td>
 574         </tr>
 575         <tr>
 576           <td class="paramkey"></td>
 577           <td></td>
 578           <td class="paramtype"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a>&#160;</td>
 579           <td class="paramname"><em>addrIPv4</em>&#160;</td>
 580         </tr>
 581         <tr>
 582           <td></td>
 583           <td>)</td>
 584           <td></td><td></td>
 585         </tr>
 586       </table>
 587 </div><div class="memdoc">
 588
 589 <p>Set IPv4 address output. </p>
 590 <dl class="params"><dt>Parameters</dt><dd>
 591   <table class="params">
 592     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>output identifier. </td></tr>
 593     <tr><td class="paramdir">[in]</td><td class="paramname">addrIPv4</td><td>pointer to IPv4 address. </td></tr>
 594   </table>
 595   </dd>
 596 </dl>
 597 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 598 <p>The function <b>vioSetIPv4</b> sets an IPv4 address specified by <em>addrIPv4</em> to an interface identified by <em>id</em>. Use this function to assign an IPv4 address to an interface.</p>
 599 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em> and <a class="el" href="group__vioIPAddr__gr.html">IP Addresses</a> for <em>addrIPv4</em>.</p>
 600 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 601 <div class="line"> </div>
 602 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 603 <div class="line">  <a class="code hl_struct" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a> addrIPv4 = {192U, 168U, 111U, 123U};</div>
 604 <div class="line"> </div>
 605 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 606 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#gafec1413f0d3624bb8922a3973636b587">vioSetIPv4</a> (0, addrIPv4);</div>
 607 <div class="line">}</div>
 608 <div class="ttc" id="agroup__vioDefines__gr_html_gafec1413f0d3624bb8922a3973636b587"><div class="ttname"><a href="group__vioDefines__gr.html#gafec1413f0d3624bb8922a3973636b587">vioSetIPv4</a></div><div class="ttdeci">void vioSetIPv4(uint32_t id, vioAddrIPv4_t addrIPv4)</div><div class="ttdoc">Set IPv4 address output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:418</div></div>
 609 <div class="ttc" id="agroup__vioIPAddr__gr_html_structvioAddrIPv4__t"><div class="ttname"><a href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a></div><div class="ttdoc">IPv4 Internet Address.</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:91</div></div>
 610 </div><!-- fragment -->
 611 </div>
 612 </div>
 613 <a id="ga22b8711d1858eedde919053d269aa073" name="ga22b8711d1858eedde919053d269aa073"></a>
 614 <h2 class="memtitle"><span class="permalink"><a href="#ga22b8711d1858eedde919053d269aa073">&#9670;&#160;</a></span>vioGetIPv4()</h2>
 615
 616 <div class="memitem">
 617 <div class="memproto">
 618       <table class="memname">
 619         <tr>
 620           <td class="memname"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a> vioGetIPv4 </td>
 621           <td>(</td>
 622           <td class="paramtype">uint32_t&#160;</td>
 623           <td class="paramname"><em>id</em></td><td>)</td>
 624           <td></td>
 625         </tr>
 626       </table>
 627 </div><div class="memdoc">
 628
 629 <p>Get IPv4 address input. </p>
 630 <dl class="params"><dt>Parameters</dt><dd>
 631   <table class="params">
 632     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>input identifier. </td></tr>
 633   </table>
 634   </dd>
 635 </dl>
 636 <dl class="section return"><dt>Returns</dt><dd>IPv4 address retrieved from peripheral.</dd></dl>
 637 <p>The function <b>vioGetIPv4</b> retrieves the IPv4 addrIPv4 from an interface identified by <em>id</em>. Use this function to read an IPv4 address.</p>
 638 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em>.</p>
 639 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 640 <div class="line"> </div>
 641 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 642 <div class="line">  <a class="code hl_struct" href="group__vioIPAddr__gr.html#structvioAddrIPv4__t">vioAddrIPv4_t</a> addrIPv4;</div>
 643 <div class="line"> </div>
 644 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 645 <div class="line">  addrIPv4 = <a class="code hl_function" href="group__vioDefines__gr.html#ga22b8711d1858eedde919053d269aa073">vioGetIPv4</a>(0);</div>
 646 <div class="line">}</div>
 647 <div class="ttc" id="agroup__vioDefines__gr_html_ga22b8711d1858eedde919053d269aa073"><div class="ttname"><a href="group__vioDefines__gr.html#ga22b8711d1858eedde919053d269aa073">vioGetIPv4</a></div><div class="ttdeci">vioAddrIPv4_t vioGetIPv4(uint32_t id)</div><div class="ttdoc">Get IPv4 address input.</div><div class="ttdef"><b>Definition:</b> VIO.txt:440</div></div>
 648 </div><!-- fragment -->
 649 </div>
 650 </div>
 651 <a id="ga3592d2a14aca73d219022712279b8fa5" name="ga3592d2a14aca73d219022712279b8fa5"></a>
 652 <h2 class="memtitle"><span class="permalink"><a href="#ga3592d2a14aca73d219022712279b8fa5">&#9670;&#160;</a></span>vioSetIPv6()</h2>
 653
 654 <div class="memitem">
 655 <div class="memproto">
 656       <table class="memname">
 657         <tr>
 658           <td class="memname">void vioSetIPv6 </td>
 659           <td>(</td>
 660           <td class="paramtype">uint32_t&#160;</td>
 661           <td class="paramname"><em>id</em>, </td>
 662         </tr>
 663         <tr>
 664           <td class="paramkey"></td>
 665           <td></td>
 666           <td class="paramtype"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a>&#160;</td>
 667           <td class="paramname"><em>addrIPv6</em>&#160;</td>
 668         </tr>
 669         <tr>
 670           <td></td>
 671           <td>)</td>
 672           <td></td><td></td>
 673         </tr>
 674       </table>
 675 </div><div class="memdoc">
 676
 677 <p>Set IPv6 address output. </p>
 678 <dl class="params"><dt>Parameters</dt><dd>
 679   <table class="params">
 680     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>output identifier. </td></tr>
 681     <tr><td class="paramdir">[in]</td><td class="paramname">addrIPv6</td><td>pointer to IPv6 address. </td></tr>
 682   </table>
 683   </dd>
 684 </dl>
 685 <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 686 <p>The function <b>vioSetIPv6</b> sets an IPv6 address specified by <em>addrIPv6</em> to an interface identified by <em>id</em>. Use this function to assign an IPv6 address to an interface.</p>
 687 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em> and <a class="el" href="group__vioIPAddr__gr.html">IP Addresses</a> for <em>addrIPv6</em>.</p>
 688 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 689 <div class="line"> </div>
 690 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 691 <div class="line">  <a class="code hl_struct" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a> addrIPv6 = {1U, 2U, 3U, 4U, 5U, 6U, 7U, 8U,</div>
 692 <div class="line">                           9U, 10U, 11U, 12U, 13U, 14U, 15U, 16U};</div>
 693 <div class="line"> </div>
 694 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 695 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga3592d2a14aca73d219022712279b8fa5">vioSetIPv6</a> (0, addrIPv6);</div>
 696 <div class="line">}</div>
 697 <div class="ttc" id="agroup__vioDefines__gr_html_ga3592d2a14aca73d219022712279b8fa5"><div class="ttname"><a href="group__vioDefines__gr.html#ga3592d2a14aca73d219022712279b8fa5">vioSetIPv6</a></div><div class="ttdeci">void vioSetIPv6(uint32_t id, vioAddrIPv6_t addrIPv6)</div><div class="ttdoc">Set IPv6 address output.</div><div class="ttdef"><b>Definition:</b> VIO.txt:464</div></div>
 698 <div class="ttc" id="agroup__vioIPAddr__gr_html_structvioAddrIPv6__t"><div class="ttname"><a href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a></div><div class="ttdoc">IPv6 Internet Address.</div><div class="ttdef"><b>Definition:</b> cmsis_vio.h:96</div></div>
 699 </div><!-- fragment -->
 700 </div>
 701 </div>
 702 <a id="gabde8fededde24fc47b1b80fdee4466f0" name="gabde8fededde24fc47b1b80fdee4466f0"></a>
 703 <h2 class="memtitle"><span class="permalink"><a href="#gabde8fededde24fc47b1b80fdee4466f0">&#9670;&#160;</a></span>vioGetIPv6()</h2>
 704
 705 <div class="memitem">
 706 <div class="memproto">
 707       <table class="memname">
 708         <tr>
 709           <td class="memname"><a class="el" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a> vioGetIPv6 </td>
 710           <td>(</td>
 711           <td class="paramtype">uint32_t&#160;</td>
 712           <td class="paramname"><em>id</em></td><td>)</td>
 713           <td></td>
 714         </tr>
 715       </table>
 716 </div><div class="memdoc">
 717
 718 <p>Get IPv6 address from peripheral. </p>
 719 <dl class="params"><dt>Parameters</dt><dd>
 720   <table class="params">
 721     <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>input identifier. </td></tr>
 722   </table>
 723   </dd>
 724 </dl>
 725 <dl class="section return"><dt>Returns</dt><dd>IPv6 address retrieved from peripheral.</dd></dl>
 726 <p>The function <b>vioGetIPv6</b> retrieves the IPv6 addrIPv6 from an interface identified by <em>id</em>. Use this function to read an IPv6 address.</p>
 727 <p>Refer to <a class="el" href="group__vioIDs__gr.html">IDs</a> for information about <em>id</em>.</p>
 728 <p><b>Code</b> <b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__vio_8h.html">cmsis_vio.h</a>&quot;</span>                  <span class="comment">// ::CMSIS Driver:VIO</span></div>
 729 <div class="line"> </div>
 730 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 731 <div class="line">  <a class="code hl_struct" href="group__vioIPAddr__gr.html#structvioAddrIPv6__t">vioAddrIPv6_t</a> addrIPv6;</div>
 732 <div class="line"> </div>
 733 <div class="line">  <a class="code hl_function" href="group__vioDefines__gr.html#ga84e05ae351226f41d461dbe982b2372f">vioInit</a>();</div>
 734 <div class="line">  addrIPv6 = <a class="code hl_function" href="group__vioDefines__gr.html#gabde8fededde24fc47b1b80fdee4466f0">vioGetIPv6</a>(0);</div>
 735 <div class="line">}</div>
 736 <div class="ttc" id="agroup__vioDefines__gr_html_gabde8fededde24fc47b1b80fdee4466f0"><div class="ttname"><a href="group__vioDefines__gr.html#gabde8fededde24fc47b1b80fdee4466f0">vioGetIPv6</a></div><div class="ttdeci">vioAddrIPv6_t vioGetIPv6(uint32_t id)</div><div class="ttdoc">Get IPv6 address from peripheral.</div><div class="ttdef"><b>Definition:</b> VIO.txt:487</div></div>
 737 </div><!-- fragment -->
 738 </div>
 739 </div>
 740 </div><!-- contents -->
 741 </div><!-- doc-content -->
 742 <!-- start footer part -->
 743 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 744   <ul>
 745     <li class="footer">
 746       <script type="text/javascript">
 747         <!--
 748         writeFooter.call(this);
 749         //-->
 750       </script>
 751     </li>
 752   </ul>
 753 </div>
 754 </body>
 755 </html>