USB_Host_Shield_2.0/hexdump_8h_source.html

168 lines
17 KiB
HTML
Raw Normal View History

2013-01-30 22:00:18 +01:00
<!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"/>
2013-10-21 21:15:43 +02:00
<meta name="generator" content="Doxygen 1.8.5"/>
<title>USB Host Shield 2.0: hexdump.h Source File</title>
2013-01-30 22:00:18 +01:00
<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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
2013-01-30 22:00:18 +01:00
</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 style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
2013-01-30 22:00:18 +01:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2013-10-21 21:15:43 +02:00
<!-- Generated by Doxygen 1.8.5 -->
2013-01-30 22:00:18 +01:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_e5fbe6d2783ccd4c93c7856d92d7be6e.html">GitHub</a></li><li class="navelem"><a class="el" href="dir_397a095372f04465e811d0ee219bbf8f.html">USB_Host_Shield_2.0</a></li> </ul>
2013-01-30 22:00:18 +01:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hexdump.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="hexdump_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) 2011 Circuits At Home, LTD. 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">Circuits At Home, LTD</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">Web : http://www.circuitsathome.com</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">e-mail : support@circuitsathome.com</span></div>
2013-04-01 22:52:24 +02:00
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
2013-10-21 21:15:43 +02:00
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#if !defined(_usb_h_) || defined(__HEXDUMP_H__)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#error &quot;Never include hexdump.h directly; include Usb.h instead&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __HEXDUMP_H__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="hexdump_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> BASE_CLASS, <span class="keyword">class</span> LEN_TYPE, <span class="keyword">class</span> OFFSET_TYPE&gt;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_hex_dumper.html"> 25</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_hex_dumper.html">HexDumper</a> : <span class="keyword">public</span> BASE_CLASS {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint8_t byteCount;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; OFFSET_TYPE byteTotal;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_hex_dumper.html#a94f38f5aff5066f0e1a82fcb896f5337"> 31</a></span>&#160; <a class="code" href="class_hex_dumper.html#a94f38f5aff5066f0e1a82fcb896f5337">HexDumper</a>() : byteCount(0), byteTotal(0) {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; };</div>
2013-06-17 20:33:24 +02:00
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
2013-10-21 21:15:43 +02:00
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_hex_dumper.html#accd2712258f54a8072eae3d2ad8cceba"> 34</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_hex_dumper.html#accd2712258f54a8072eae3d2ad8cceba">Initialize</a>() {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; byteCount = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; byteTotal = 0;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; };</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_hex_dumper.html#acaff9c9e5b97bbfe3596c7b7a2e2a78d">Parse</a>(<span class="keyword">const</span> LEN_TYPE len, <span class="keyword">const</span> uint8_t *pbuf, <span class="keyword">const</span> OFFSET_TYPE &amp;offset);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;};</div>
2013-06-17 20:33:24 +02:00
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
2013-10-21 21:15:43 +02:00
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> BASE_CLASS, <span class="keyword">class</span> LEN_TYPE, <span class="keyword">class</span> OFFSET_TYPE&gt;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_hex_dumper.html#acaff9c9e5b97bbfe3596c7b7a2e2a78d"> 43</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_hex_dumper.html#acaff9c9e5b97bbfe3596c7b7a2e2a78d">HexDumper&lt;BASE_CLASS, LEN_TYPE, OFFSET_TYPE&gt;::Parse</a>(<span class="keyword">const</span> LEN_TYPE len, <span class="keyword">const</span> uint8_t *pbuf, <span class="keyword">const</span> OFFSET_TYPE &amp;offset) {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span>(<a class="code" href="hexdump_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a> &gt;= 0x80) { <span class="comment">// Fully bypass this block of code if we do not debug.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">for</span>(LEN_TYPE j = 0; j &lt; len; j++, byteCount++, byteTotal++) {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">if</span>(!byteCount) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; PrintHex&lt;OFFSET_TYPE &gt; (byteTotal, 0x80);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="message_8cpp.html#a9453192fd38607a494776eb3fb483630">E_Notify</a>(PSTR(<span class="stringliteral">&quot;: &quot;</span>), 0x80);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; PrintHex&lt;uint8_t &gt; (pbuf[j], 0x80);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="message_8cpp.html#a9453192fd38607a494776eb3fb483630">E_Notify</a>(PSTR(<span class="stringliteral">&quot; &quot;</span>), 0x80);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">if</span>(byteCount == 15) {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="message_8cpp.html#a9453192fd38607a494776eb3fb483630">E_Notify</a>(PSTR(<span class="stringliteral">&quot;\r\n&quot;</span>), 0x80);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; byteCount = 0xFF;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</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;<span class="preprocessor">#endif // __HEXDUMP_H__</span></div>
<div class="ttc" id="class_hex_dumper_html"><div class="ttname"><a href="class_hex_dumper.html">HexDumper</a></div><div class="ttdef"><b>Definition:</b> <a href="hexdump_8h_source.html#l00025">hexdump.h:25</a></div></div>
<div class="ttc" id="hexdump_8h_html_a25b114fa75a1d5c09bde2dadc5a27f78"><div class="ttname"><a href="hexdump_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a></div><div class="ttdeci">int UsbDEBUGlvl</div><div class="ttdef"><b>Definition:</b> <a href="message_8cpp_source.html#l00022">message.cpp:22</a></div></div>
<div class="ttc" id="class_hex_dumper_html_accd2712258f54a8072eae3d2ad8cceba"><div class="ttname"><a href="class_hex_dumper.html#accd2712258f54a8072eae3d2ad8cceba">HexDumper::Initialize</a></div><div class="ttdeci">void Initialize()</div><div class="ttdef"><b>Definition:</b> <a href="hexdump_8h_source.html#l00034">hexdump.h:34</a></div></div>
<div class="ttc" id="message_8cpp_html_a9453192fd38607a494776eb3fb483630"><div class="ttname"><a href="message_8cpp.html#a9453192fd38607a494776eb3fb483630">E_Notify</a></div><div class="ttdeci">void E_Notify(char const *msg, int lvl)</div><div class="ttdef"><b>Definition:</b> <a href="message_8cpp_source.html#l00034">message.cpp:34</a></div></div>
<div class="ttc" id="class_hex_dumper_html_a94f38f5aff5066f0e1a82fcb896f5337"><div class="ttname"><a href="class_hex_dumper.html#a94f38f5aff5066f0e1a82fcb896f5337">HexDumper::HexDumper</a></div><div class="ttdeci">HexDumper()</div><div class="ttdef"><b>Definition:</b> <a href="hexdump_8h_source.html#l00031">hexdump.h:31</a></div></div>
<div class="ttc" id="class_hex_dumper_html_acaff9c9e5b97bbfe3596c7b7a2e2a78d"><div class="ttname"><a href="class_hex_dumper.html#acaff9c9e5b97bbfe3596c7b7a2e2a78d">HexDumper::Parse</a></div><div class="ttdeci">virtual void Parse(const LEN_TYPE len, const uint8_t *pbuf, const OFFSET_TYPE &amp;offset)</div><div class="ttdef"><b>Definition:</b> <a href="hexdump_8h_source.html#l00043">hexdump.h:43</a></div></div>
2013-01-30 22:00:18 +01:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
2013-01-30 22:00:18 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
2013-10-21 21:15:43 +02:00
</a> 1.8.5
2013-01-30 22:00:18 +01:00
</small></address>
</body>
</html>