USB_Host_Shield_2.0/sink__parser_8h_source.html
2021-03-23 11:43:48 +00:00

132 lines
12 KiB
HTML

<!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: sink_parser.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">sink_parser.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="sink__parser_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 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>&#160;<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>&#160;<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>&#160;<span class="comment">(at your option) any later version.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">GNU General Public License for more details.</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">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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">Contact information</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">-------------------</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">Circuits At Home, LTD</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">Web : http://www.circuitsathome.com</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">e-mail : support@circuitsathome.com</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#if !defined(_usb_h_) || defined(__SINK_PARSER_H__)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#error &quot;Never include hexdump.h directly; include Usb.h instead&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define __SINK_PARSER_H__</span></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;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="sink__parser_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// This parser does absolutely nothing with the data, just swallows it.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</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="l00035"></a><span class="lineno"><a class="line" href="class_sink_parser.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_sink_parser.html">SinkParser</a> : <span class="keyword">public</span> BASE_CLASS {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">public</span>:</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"><a class="line" href="class_sink_parser.html#a68caa440ba95a184eb104535f3fffd17"> 38</a></span>&#160; <a class="code" href="class_sink_parser.html#a68caa440ba95a184eb104535f3fffd17">SinkParser</a>() {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; };</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_sink_parser.html#a3c2ac73b459e326e955c26d658733f9f"> 41</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_sink_parser.html#a3c2ac73b459e326e955c26d658733f9f">Initialize</a>() {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; };</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_sink_parser.html#ac6cf61bb48d61cb7db178c62c5f86fd0"> 44</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_sink_parser.html#ac6cf61bb48d61cb7db178c62c5f86fd0">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="l00045"></a><span class="lineno"> 45</span>&#160; };</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; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif // __HEXDUMP_H__</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_sink_parser_html_a3c2ac73b459e326e955c26d658733f9f"><div class="ttname"><a href="class_sink_parser.html#a3c2ac73b459e326e955c26d658733f9f">SinkParser::Initialize</a></div><div class="ttdeci">void Initialize()</div><div class="ttdef"><b>Definition:</b> <a href="sink__parser_8h_source.html#l00041">sink_parser.h:41</a></div></div>
<div class="ttc" id="aclass_sink_parser_html_ac6cf61bb48d61cb7db178c62c5f86fd0"><div class="ttname"><a href="class_sink_parser.html#ac6cf61bb48d61cb7db178c62c5f86fd0">SinkParser::Parse</a></div><div class="ttdeci">void Parse(const LEN_TYPE len, const uint8_t *pbuf, const OFFSET_TYPE &amp;offset)</div><div class="ttdef"><b>Definition:</b> <a href="sink__parser_8h_source.html#l00044">sink_parser.h:44</a></div></div>
<div class="ttc" id="asink__parser_8h_html_a25b114fa75a1d5c09bde2dadc5a27f78"><div class="ttname"><a href="sink__parser_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a></div><div class="ttdeci">int UsbDEBUGlvl</div><div class="ttdef"><b>Definition:</b> <a href="message_8cpp_source.html#l00029">message.cpp:29</a></div></div>
<div class="ttc" id="aclass_sink_parser_html_a68caa440ba95a184eb104535f3fffd17"><div class="ttname"><a href="class_sink_parser.html#a68caa440ba95a184eb104535f3fffd17">SinkParser::SinkParser</a></div><div class="ttdeci">SinkParser()</div><div class="ttdef"><b>Definition:</b> <a href="sink__parser_8h_source.html#l00038">sink_parser.h:38</a></div></div>
<div class="ttc" id="aclass_sink_parser_html"><div class="ttname"><a href="class_sink_parser.html">SinkParser</a></div><div class="ttdef"><b>Definition:</b> <a href="sink__parser_8h_source.html#l00035">sink_parser.h:35</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>