<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: macros.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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">macros.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="macros_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> <span class="comment">/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">This program is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">the Free Software Foundation; either version 2 of the License, or</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">(at your option) any later version.</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">This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">along with this program; if not, write to the Free Software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">Contact information</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">-------------------</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">Circuits At Home, LTD</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">Web : http://www.circuitsathome.com</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">e-mail : support@circuitsathome.com</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#if !defined(_usb_h_) || defined(MACROS_H)</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#error "Never include macros.h directly; include Usb.h instead"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define MACROS_H</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// HANDY MACROS</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="macros_8h.html#a18de126009ef53f46469341d2e223799"> 34</a></span> <span class="preprocessor">#define VALUE_BETWEEN(v,l,h) (((v)>(l)) && ((v)<(h)))</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="macros_8h.html#ad1bf62861b3f4199c42a93bf6b2181d0"> 35</a></span> <span class="preprocessor">#define VALUE_WITHIN(v,l,h) (((v)>=(l)) && ((v)<=(h)))</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="macros_8h.html#a46567b5bfb259802552c01782015876a"> 36</a></span> <span class="preprocessor">#define output_pgm_message(wa,fp,mp,el) wa = &mp, fp((char *)pgm_read_pointer(wa), el)</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="macros_8h.html#a9053301ae1e76cbf079c9d589dfcaba2"> 37</a></span> <span class="preprocessor">#define output_if_between(v,l,h,wa,fp,mp,el) if(VALUE_BETWEEN(v,l,h)) output_pgm_message(wa,fp,mp[v-(l+1)],el);</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="macros_8h.html#aac9153aee4bdb92701df902e06a74eb3"> 39</a></span> <span class="preprocessor">#define SWAP(a, b) (((a) ^= (b)), ((b) ^= (a)), ((a) ^= (b)))</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef __BYTE_GRABBING_DEFINED__</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="macros_8h.html#aba6aea5f92a8f3b12d93735556b195a0"> 41</a></span> <span class="preprocessor">#define __BYTE_GRABBING_DEFINED__ 1</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifdef BROKEN_OPTIMIZER_LITTLE_ENDIAN</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Note: Use this if your compiler generates horrible assembler!</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define BGRAB0(__usi__) (((uint8_t *)&(__usi__))[0])</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define BGRAB1(__usi__) (((uint8_t *)&(__usi__))[1])</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define BGRAB2(__usi__) (((uint8_t *)&(__usi__))[2])</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#define BGRAB3(__usi__) (((uint8_t *)&(__usi__))[3])</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define BGRAB4(__usi__) (((uint8_t *)&(__usi__))[4])</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#define BGRAB5(__usi__) (((uint8_t *)&(__usi__))[5])</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define BGRAB6(__usi__) (((uint8_t *)&(__usi__))[6])</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define BGRAB7(__usi__) (((uint8_t *)&(__usi__))[7])</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Note: The cast alone to uint8_t is actually enough.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// GCC throws out the "& 0xff", and the size is no different.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Some compilers need it.</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="macros_8h.html#a773ca2920fd4808c94e6645a7a8d63d1"> 56</a></span> <span class="preprocessor">#define BGRAB0(__usi__) ((uint8_t)((__usi__) & 0xff ))</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="macros_8h.html#a483a8ceb644d44744abff34f61cc5442"> 57</a></span> <span class="preprocessor">#define BGRAB1(__usi__) ((uint8_t)(((__usi__) >> 8) & 0xff))</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="macros_8h.html#a49c9ebd69fbb93bd97f9051f592390c6"> 58</a></span> <span class="preprocessor">#define BGRAB2(__usi__) ((uint8_t)(((__usi__) >> 16) & 0xff))</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="macros_8h.html#a9860e9931085c9e299185903eeb0e728"> 59</a></span> <span class="preprocessor">#define BGRAB3(__usi__) ((uint8_t)(((__usi__) >> 24) & 0xff))</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="macros_8h.html#a2e09ee6521484d766b749fa78424e6de"> 60</a></span> <span class="preprocessor">#define BGRAB4(__usi__) ((uint8_t)(((__usi__) >> 32) & 0xff))</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="macros_8h.html#af7841a592674a3da24f7f93c51efc802"> 61</a></span> <span class="preprocessor">#define BGRAB5(__usi__) ((uint8_t)(((__usi__) >> 40) & 0xff))</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="macros_8h.html#abe11d76b3c0fd5c7eb99028da5c143fd"> 62</a></span> <span class="preprocessor">#define BGRAB6(__usi__) ((uint8_t)(((__usi__) >> 48) & 0xff))</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="macros_8h.html#ae6f83d8945d4b4aaeb0b6bcd241f4d41"> 63</a></span> <span class="preprocessor">#define BGRAB7(__usi__) ((uint8_t)(((__usi__) >> 56) & 0xff))</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="macros_8h.html#a80bfc8ae315212bceee673fda15cd0a1"> 65</a></span> <span class="preprocessor">#define BOVER1(__usi__) ((uint16_t)(__usi__) << 8)</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="macros_8h.html#a747255a7db85e714c2db0cfc773869b4"> 66</a></span> <span class="preprocessor">#define BOVER2(__usi__) ((uint32_t)(__usi__) << 16)</span></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="macros_8h.html#a433de90ebc655ae064dd06daea3c08cd"> 67</a></span> <span class="preprocessor">#define BOVER3(__usi__) ((uint32_t)(__usi__) << 24)</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="macros_8h.html#a564606798f96352a6d4b4ae7272780ce"> 68</a></span> <span class="preprocessor">#define BOVER4(__usi__) ((uint64_t)(__usi__) << 32)</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="macros_8h.html#af4736df29b4fa3d907c7b07dfdfe051d"> 69</a></span> <span class="preprocessor">#define BOVER5(__usi__) ((uint64_t)(__usi__) << 40)</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="macros_8h.html#a5b251ec4a21985e21aafc8cac05f6f8e"> 70</a></span> <span class="preprocessor">#define BOVER6(__usi__) ((uint64_t)(__usi__) << 48)</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="macros_8h.html#a23a06fa3ad02cb923e4f1dc695a554ac"> 71</a></span> <span class="preprocessor">#define BOVER7(__usi__) ((uint64_t)(__usi__) << 56)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// These are the smallest and fastest ways I have found so far in pure C/C++.</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="macros_8h.html#adc0425264a0eef8366ed880a449a7ba6"> 74</a></span> <span class="preprocessor">#define BMAKE16(__usc1__,__usc0__) ((uint16_t)((uint16_t)(__usc0__) | (uint16_t)BOVER1(__usc1__)))</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="macros_8h.html#aa66c08000503b210a294df0200b7b6ba"> 75</a></span> <span class="preprocessor">#define BMAKE32(__usc3__,__usc2__,__usc1__,__usc0__) ((uint32_t)((uint32_t)(__usc0__) | (uint32_t)BOVER1(__usc1__) | (uint32_t)BOVER2(__usc2__) | (uint32_t)BOVER3(__usc3__)))</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="macros_8h.html#a7a02f6ea8bf592d102017f7ddaf4ed36"> 76</a></span> <span class="preprocessor">#define BMAKE64(__usc7__,__usc6__,__usc5__,__usc4__,__usc3__,__usc2__,__usc1__,__usc0__) ((uint64_t)((uint64_t)__usc0__ | (uint64_t)BOVER1(__usc1__) | (uint64_t)BOVER2(__usc2__) | (uint64_t)BOVER3(__usc3__) | (uint64_t)BOVER4(__usc4__) | (uint64_t)BOVER5(__usc5__) | (uint64_t)BOVER6(__usc6__) | (uint64_t)BOVER1(__usc7__)))</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/*</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Debug macros: Strings are stored in progmem (flash) instead of RAM.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="macros_8h.html#afc6fe7f947af35317a49a4dcfc8189fd"> 82</a></span> <span class="preprocessor">#define USBTRACE(s) (Notify(PSTR(s), 0x80))</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="macros_8h.html#a50c48abaa034bcce833c6061b9f8e5cf"> 83</a></span> <span class="preprocessor">#define USBTRACE1(s,l) (Notify(PSTR(s), l))</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="macros_8h.html#adbe3f00986df48a9254f8bf0992041d3"> 84</a></span> <span class="preprocessor">#define USBTRACE2(s,r) (Notify(PSTR(s), 0x80), D_PrintHex((r), 0x80), Notify(PSTR("\r\n"), 0x80))</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="macros_8h.html#a3b6ba9344d4ae0847095896841587862"> 85</a></span> <span class="preprocessor">#define USBTRACE3(s,r,l) (Notify(PSTR(s), l), D_PrintHex((r), l), Notify(PSTR("\r\n"), l))</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif </span><span class="comment">/* MACROS_H */</span><span class="preprocessor"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>