USB_Host_Shield_2.0/xbox_enums_8h_source.html

157 lines
17 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: xboxEnums.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">xboxEnums.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="xbox_enums_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (C) 2012 Kristian Lauszus, TKJ Electronics. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This software may be distributed and modified under the terms of the GNU</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> General Public License version 2 (GPL2) as published by the Free Software</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> Foundation and appearing in the file GPL2.TXT included in the packaging of</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> this file. Please note that GPL2 Section 2[b] requires that all works based</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> on this software must also be made publicly available under the terms of</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> the GPL2 (&quot;Copyleft&quot;).</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> Contact information</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> -------------------</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> Kristian Lauszus, TKJ Electronics</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> Web : http://www.tkjelectronics.com</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> e-mail : kristianl@tkjelectronics.com</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#ifndef _xboxenums_h</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define _xboxenums_h</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="controller_enums_8h.html">controllerEnums.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f"> 24</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b"> 25</a></span>&#160; <a class="code" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b">ROTATING</a> = 0x0A,</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a"> 26</a></span>&#160; <a class="code" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a">FASTBLINK</a> = 0x0B,</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454"> 27</a></span>&#160; <a class="code" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454">SLOWBLINK</a> = 0x0C,</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37"> 28</a></span>&#160; <a class="code" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37">ALTERNATING</a> = 0x0D,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;};</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#a0aa7965573ba74b8eecaa43f0543026e"> 32</a></span>&#160;<span class="keyword">const</span> uint8_t <a class="code" href="xbox_enums_8h.html#a0aa7965573ba74b8eecaa43f0543026e">XBOX_LEDS</a>[] PROGMEM = {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; 0x00, <span class="comment">// OFF</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; 0x02, <span class="comment">// LED1</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; 0x03, <span class="comment">// LED2</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; 0x04, <span class="comment">// LED3</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; 0x05, <span class="comment">// LED4</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; 0x01, <span class="comment">// ALL - Used to blink all LEDs</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd"> 41</a></span>&#160;<span class="keyword">const</span> uint16_t <a class="code" href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd">XBOX_BUTTONS</a>[] PROGMEM = {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; 0x0100, <span class="comment">// UP</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; 0x0800, <span class="comment">// RIGHT</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; 0x0200, <span class="comment">// DOWN</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; 0x0400, <span class="comment">// LEFT</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; 0x2000, <span class="comment">// BACK</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; 0x1000, <span class="comment">// START</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; 0x4000, <span class="comment">// L3</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; 0x8000, <span class="comment">// R3</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; 0, 0, <span class="comment">// Skip L2 and R2 as these are analog buttons</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; 0x0001, <span class="comment">// L1</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; 0x0002, <span class="comment">// R1</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; 0x0020, <span class="comment">// B</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; 0x0010, <span class="comment">// A</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; 0x0040, <span class="comment">// X</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; 0x0080, <span class="comment">// Y</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; 0x0004, <span class="comment">// XBOX</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; 0x0008, <span class="comment">// SYNC</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="xbox_enums_8h.html#a5061e79d5902f70fba9807427c870e93"> 65</a></span>&#160;<span class="keyword">inline</span> int8_t <a class="code" href="xbox_enums_8h.html#a5061e79d5902f70fba9807427c870e93">getButtonIndexXbox</a>(<a class="code" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b) {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> int8_t index = <a class="code" href="controller_enums_8h.html#a114f266591a03b0eff0f1e6b67d94f85">ButtonIndex</a>(b);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">if</span> ((uint8_t) index &gt;= (<span class="keyword">sizeof</span>(<a class="code" href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd">XBOX_BUTTONS</a>) / <span class="keyword">sizeof</span>(<a class="code" href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd">XBOX_BUTTONS</a>[0]))) <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">return</span> index;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;}</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="axbox_enums_8h_html_a35901eab017bd1df5d2361634309adbd"><div class="ttname"><a href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd">XBOX_BUTTONS</a></div><div class="ttdeci">const uint16_t XBOX_BUTTONS[]</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00041">xboxEnums.h:41</a></div></div>
<div class="ttc" id="acontroller_enums_8h_html_a114f266591a03b0eff0f1e6b67d94f85"><div class="ttname"><a href="controller_enums_8h.html#a114f266591a03b0eff0f1e6b67d94f85">ButtonIndex</a></div><div class="ttdeci">constexpr int8_t ButtonIndex(ButtonEnum key)</div><div class="ttdef"><b>Definition:</b> <a href="controller_enums_8h_source.html#l00191">controllerEnums.h:191</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b"><div class="ttname"><a href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b">ROTATING</a></div><div class="ttdeci">@ ROTATING</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00025">xboxEnums.h:25</a></div></div>
<div class="ttc" id="acontroller_enums_8h_html"><div class="ttname"><a href="controller_enums_8h.html">controllerEnums.h</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37"><div class="ttname"><a href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37">ALTERNATING</a></div><div class="ttdeci">@ ALTERNATING</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00028">xboxEnums.h:28</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454"><div class="ttname"><a href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454">SLOWBLINK</a></div><div class="ttdeci">@ SLOWBLINK</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00027">xboxEnums.h:27</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_a5061e79d5902f70fba9807427c870e93"><div class="ttname"><a href="xbox_enums_8h.html#a5061e79d5902f70fba9807427c870e93">getButtonIndexXbox</a></div><div class="ttdeci">int8_t getButtonIndexXbox(ButtonEnum b)</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00065">xboxEnums.h:65</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_abb8a1831f62ea139a2255c67bb24330f"><div class="ttname"><a href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a></div><div class="ttdeci">LEDModeEnum</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00024">xboxEnums.h:24</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a"><div class="ttname"><a href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a">FASTBLINK</a></div><div class="ttdeci">@ FASTBLINK</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00026">xboxEnums.h:26</a></div></div>
<div class="ttc" id="axbox_enums_8h_html_a0aa7965573ba74b8eecaa43f0543026e"><div class="ttname"><a href="xbox_enums_8h.html#a0aa7965573ba74b8eecaa43f0543026e">XBOX_LEDS</a></div><div class="ttdeci">const uint8_t XBOX_LEDS[]</div><div class="ttdef"><b>Definition:</b> <a href="xbox_enums_8h_source.html#l00032">xboxEnums.h:32</a></div></div>
<div class="ttc" id="acontroller_enums_8h_html_a94f7389d205c78830a5441370d7870fd"><div class="ttname"><a href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a></div><div class="ttdeci">ButtonEnum</div><div class="ttdef"><b>Definition:</b> <a href="controller_enums_8h_source.html#l00078">controllerEnums.h:78</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>